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 ```
97 lines
2.4 KiB
Ruby
97 lines
2.4 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "forwardable"
|
|
|
|
# Representation of a `*PATH` environment variable.
|
|
class PATH
|
|
include Enumerable
|
|
extend Forwardable
|
|
|
|
delegate each: :@paths
|
|
|
|
# FIXME: Enable cop again when https://github.com/sorbet/sorbet/issues/3532 is fixed.
|
|
# rubocop:disable Style/MutableConstant
|
|
Element = T.type_alias { T.nilable(T.any(Pathname, String, PATH)) }
|
|
private_constant :Element
|
|
Elements = T.type_alias { T.any(Element, T::Array[Element]) }
|
|
private_constant :Elements
|
|
# rubocop:enable Style/MutableConstant
|
|
|
|
sig { params(paths: Elements).void }
|
|
def initialize(*paths)
|
|
@paths = parse(paths)
|
|
end
|
|
|
|
sig { params(paths: Elements).returns(T.self_type) }
|
|
def prepend(*paths)
|
|
@paths = parse(paths + @paths)
|
|
self
|
|
end
|
|
|
|
sig { params(paths: Elements).returns(T.self_type) }
|
|
def append(*paths)
|
|
@paths = parse(@paths + paths)
|
|
self
|
|
end
|
|
|
|
sig { params(index: Integer, paths: Elements).returns(T.self_type) }
|
|
def insert(index, *paths)
|
|
@paths = parse(@paths.insert(index, *paths))
|
|
self
|
|
end
|
|
|
|
sig { params(block: T.proc.params(arg0: String).returns(T::Boolean)).returns(T.self_type) }
|
|
def select(&block)
|
|
self.class.new(@paths.select(&block))
|
|
end
|
|
|
|
sig { params(block: T.proc.params(arg0: String).returns(T::Boolean)).returns(T.self_type) }
|
|
def reject(&block)
|
|
self.class.new(@paths.reject(&block))
|
|
end
|
|
|
|
sig { returns(T::Array[String]) }
|
|
def to_ary
|
|
@paths.dup.to_ary
|
|
end
|
|
alias to_a to_ary
|
|
|
|
sig { returns(String) }
|
|
def to_str
|
|
@paths.join(File::PATH_SEPARATOR)
|
|
end
|
|
|
|
sig { returns(String) }
|
|
def to_s = to_str
|
|
|
|
sig { params(other: T.untyped).returns(T::Boolean) }
|
|
def ==(other)
|
|
(other.respond_to?(:to_ary) && to_ary == other.to_ary) ||
|
|
(other.respond_to?(:to_str) && to_str == other.to_str) ||
|
|
false
|
|
end
|
|
|
|
sig { returns(T::Boolean) }
|
|
def empty?
|
|
@paths.empty?
|
|
end
|
|
|
|
sig { returns(T.nilable(T.self_type)) }
|
|
def existing
|
|
existing_path = select { File.directory?(_1) }
|
|
# return nil instead of empty PATH, to unset environment variables
|
|
existing_path unless existing_path.empty?
|
|
end
|
|
|
|
private
|
|
|
|
sig { params(paths: T::Array[Elements]).returns(T::Array[String]) }
|
|
def parse(paths)
|
|
paths.flatten
|
|
.compact
|
|
.flat_map { |p| Pathname(p).to_path.split(File::PATH_SEPARATOR) }
|
|
.uniq
|
|
end
|
|
end
|