45978435e7
- Previously I thought that comments were fine to discourage people from wasting their time trying to bump things that used `undef` that Sorbet didn't support. But RuboCop is better at this since it'll complain if the comments are unnecessary. - Suggested in https://github.com/Homebrew/brew/pull/18018#issuecomment-2283369501. - I've gone for a mixture of `rubocop:disable` for the files that can't be `typed: strict` (use of undef, required before everything else, etc) and `rubocop:todo` for everything else that should be tried to make strictly typed. There's no functional difference between the two as `rubocop:todo` is `rubocop:disable` with a different name. - And I entirely disabled the cop for the docs/ directory since `typed: strict` isn't going to gain us anything for some Markdown linting config files. - This means that now it's easier to track what needs to be done rather than relying on checklists of files in our big Sorbet issue: ```shell $ git grep 'typed: true # rubocop:todo Sorbet/StrictSigil' | wc -l 268 ``` - And this is confirmed working for new files: ```shell $ git status On branch use-rubocop-for-sorbet-strict-sigils Untracked files: (use "git add <file>..." to include in what will be committed) Library/Homebrew/bad.rb Library/Homebrew/good.rb nothing added to commit but untracked files present (use "git add" to track) $ brew style Offenses: bad.rb:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true. ^^^^^^^^^^^^^ 1340 files inspected, 1 offense detected ```
83 lines
1.5 KiB
Ruby
83 lines
1.5 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "monitor"
|
|
|
|
# Module for querying the current execution context.
|
|
module Context
|
|
extend MonitorMixin
|
|
|
|
def self.current=(context)
|
|
synchronize do
|
|
@current = context
|
|
end
|
|
end
|
|
|
|
def self.current
|
|
if (current_context = Thread.current[:context])
|
|
return current_context
|
|
end
|
|
|
|
synchronize do
|
|
@current ||= ContextStruct.new
|
|
end
|
|
end
|
|
|
|
# Struct describing the current execution context.
|
|
class ContextStruct
|
|
def initialize(debug: nil, quiet: nil, verbose: nil)
|
|
@debug = debug
|
|
@quiet = quiet
|
|
@verbose = verbose
|
|
end
|
|
|
|
sig { returns(T::Boolean) }
|
|
def debug?
|
|
@debug == true
|
|
end
|
|
|
|
sig { returns(T::Boolean) }
|
|
def quiet?
|
|
@quiet == true
|
|
end
|
|
|
|
sig { returns(T::Boolean) }
|
|
def verbose?
|
|
@verbose == true
|
|
end
|
|
end
|
|
|
|
sig { returns(T::Boolean) }
|
|
def debug?
|
|
Context.current.debug?
|
|
end
|
|
|
|
sig { returns(T::Boolean) }
|
|
def quiet?
|
|
Context.current.quiet?
|
|
end
|
|
|
|
sig { returns(T::Boolean) }
|
|
def verbose?
|
|
Context.current.verbose?
|
|
end
|
|
|
|
def with_context(**options)
|
|
old_context = Context.current
|
|
|
|
new_context = ContextStruct.new(
|
|
debug: options.fetch(:debug, old_context&.debug?),
|
|
quiet: options.fetch(:quiet, old_context&.quiet?),
|
|
verbose: options.fetch(:verbose, old_context&.verbose?),
|
|
)
|
|
|
|
Thread.current[:context] = new_context
|
|
|
|
begin
|
|
yield
|
|
ensure
|
|
Thread.current[:context] = old_context
|
|
end
|
|
end
|
|
end
|