brew/Library/Homebrew/cask/dsl/depends_on.rb

94 lines
2.8 KiB
Ruby
Raw Normal View History

rubocop: Use `Sorbet/StrictSigil` as it's better than comments - 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 ```
2024-08-12 10:30:59 +01:00
# typed: true # rubocop:todo Sorbet/StrictSigil
# frozen_string_literal: true
require "delegate"
require "requirements/macos_requirement"
2018-09-06 08:29:14 +02:00
module Cask
2016-09-24 13:52:43 +02:00
class DSL
2020-08-24 23:09:43 +02:00
# Class corresponding to the `depends_on` stanza.
class DependsOn < SimpleDelegator
2019-04-19 21:46:20 +09:00
VALID_KEYS = Set.new([
:formula,
:cask,
:macos,
:arch,
]).freeze
2016-08-18 22:11:42 +03:00
2016-09-24 13:52:43 +02:00
VALID_ARCHES = {
2018-11-02 17:18:07 +00:00
intel: { type: :intel, bits: 64 },
2016-10-14 20:33:16 +02:00
# specific
2018-11-02 17:18:07 +00:00
x86_64: { type: :intel, bits: 64 },
arm64: { type: :arm, bits: 64 },
2016-10-14 20:33:16 +02:00
}.freeze
2016-08-18 22:11:42 +03:00
attr_reader :arch, :cask, :formula, :macos
2016-08-18 22:11:42 +03:00
2016-09-24 13:52:43 +02:00
def initialize
super({})
2017-06-28 17:53:59 +02:00
@cask ||= []
@formula ||= []
2016-09-24 13:52:43 +02:00
end
2016-08-18 22:11:42 +03:00
def load(**pairs)
2016-09-24 13:52:43 +02:00
pairs.each do |key, value|
raise "invalid depends_on key: '#{key.inspect}'" unless VALID_KEYS.include?(key)
2018-09-17 02:45:00 +02:00
2023-03-18 16:03:10 -07:00
__getobj__[key] = send(:"#{key}=", *value)
2016-09-24 13:52:43 +02:00
end
end
2016-08-18 22:11:42 +03:00
2016-10-23 19:04:17 +02:00
def formula=(*args)
@formula.concat(args)
2016-09-24 13:52:43 +02:00
end
2016-08-18 22:11:42 +03:00
2016-10-23 19:04:17 +02:00
def cask=(*args)
@cask.concat(args)
2016-09-24 13:52:43 +02:00
end
2016-08-18 22:11:42 +03:00
sig { params(args: T.any(String, Symbol)).returns(T.nilable(MacOSRequirement)) }
2016-10-23 19:04:17 +02:00
def macos=(*args)
2021-01-26 15:21:24 -05:00
raise "Only a single 'depends_on macos' is allowed." if defined?(@macos)
2018-09-17 02:45:00 +02:00
2023-03-18 16:03:10 -07:00
# workaround for https://github.com/sorbet/sorbet/issues/6860
first_arg = args.first&.to_s
2019-08-15 10:14:10 +02:00
begin
@macos = if args.count > 1
MacOSRequirement.new([args], comparator: "==")
elsif MacOSVersion::SYMBOLS.key?(args.first)
2019-08-15 10:14:10 +02:00
MacOSRequirement.new([args.first], comparator: "==")
2023-03-18 16:03:10 -07:00
elsif (md = /^\s*(?<comparator><|>|[=<>]=)\s*:(?<version>\S+)\s*$/.match(first_arg))
MacOSRequirement.new([T.must(md[:version]).to_sym], comparator: md[:comparator])
elsif (md = /^\s*(?<comparator><|>|[=<>]=)\s*(?<version>\S+)\s*$/.match(first_arg))
MacOSRequirement.new([md[:version]], comparator: md[:comparator])
# This is not duplicate of the first case: see `args.first` and a different comparator.
else # rubocop:disable Lint/DuplicateBranch
2019-08-15 10:14:10 +02:00
MacOSRequirement.new([args.first], comparator: "==")
end
rescue MacOSVersion::Error, TypeError => e
2020-10-05 14:46:43 +02:00
raise "invalid 'depends_on macos' value: #{e}"
end
2016-09-24 13:52:43 +02:00
end
2016-08-18 22:11:42 +03:00
2016-10-23 19:04:17 +02:00
def arch=(*args)
2016-09-24 13:52:43 +02:00
@arch ||= []
2016-10-23 19:04:17 +02:00
arches = args.map do |elt|
elt.to_s.downcase.sub(/^:/, "").tr("-", "_").to_sym
2016-10-23 14:44:14 +02:00
end
2016-09-24 13:52:43 +02:00
invalid_arches = arches - VALID_ARCHES.keys
raise "invalid 'depends_on arch' values: #{invalid_arches.inspect}" unless invalid_arches.empty?
2018-09-17 02:45:00 +02:00
2016-09-24 13:52:43 +02:00
@arch.concat(arches.map { |arch| VALID_ARCHES[arch] })
end
sig { returns(T::Boolean) }
def empty? = T.let(__getobj__, T::Hash[Symbol, T.untyped]).empty?
sig { returns(T::Boolean) }
def present? = !empty?
2016-09-24 13:52:43 +02:00
end
2016-08-18 22:11:42 +03:00
end
end