MacOSRequirement: add more type signatures

This adds more type signatures to `MacOSRequirement` to move it closer
to `typed: strict`. There are a few areas that aren't quite clear to
me based on the code and existing tests, so I've done what I can at
the moment.

Author: samford

Library/Homebrew/cask/dsl/depends_on.rb

@@ -60,9 +60,9 @@ def macos=(*args)
           elsif MacOSVersion::SYMBOLS.key?(args.first)
             MacOSRequirement.new([args.first], comparator: "==")
           elsif (md = /^\s*(?<comparator><|>|[=<>]=)\s*:(?<version>\S+)\s*$/.match(first_arg))
-            MacOSRequirement.new([T.must(md[:version]).to_sym], comparator: md[:comparator])
+            MacOSRequirement.new([T.must(md[:version]).to_sym], comparator: T.must(md[:comparator]))
           elsif (md = /^\s*(?<comparator><|>|[=<>]=)\s*(?<version>\S+)\s*$/.match(first_arg))
-            MacOSRequirement.new([md[:version]], comparator: md[:comparator])
+            MacOSRequirement.new([md[:version]], comparator: T.must(md[:comparator]))
           # This is not duplicate of the first case: see `args.first` and a different comparator.
           else # rubocop:disable Lint/DuplicateBranch
             MacOSRequirement.new([args.first], comparator: "==")

Library/Homebrew/requirements/macos_requirement.rb

@@ -7,14 +7,17 @@
 class MacOSRequirement < Requirement
   fatal true
 
-  attr_reader :comparator, :version
+  sig { returns(String) }
+  attr_reader :comparator
+
+  attr_reader :version
 
   # TODO: when Yosemite is removed here, keep these around as empty arrays so we
   # can keep the deprecation/disabling code the same.
-  DISABLED_MACOS_VERSIONS = [
+  DISABLED_MACOS_VERSIONS = T.let([
     :yosemite,
-  ].freeze
-  DEPRECATED_MACOS_VERSIONS = [].freeze
+  ].freeze, T::Array[Symbol])
+  DEPRECATED_MACOS_VERSIONS = T.let([].freeze, T::Array[Symbol])
 
   def initialize(tags = [], comparator: ">=")
     @version = begin
@@ -44,10 +47,11 @@ def initialize(tags = [], comparator: ">=")
       MacOSVersion.new(HOMEBREW_MACOS_OLDEST_ALLOWED) if comparator == ">="
     end
 
-    @comparator = comparator
+    @comparator = T.let(comparator, String)
     super(tags.drop(1))
   end
 
+  sig { returns(T::Boolean) }
   def version_specified?
     @version.present?
   end
@@ -61,20 +65,23 @@ def version_specified?
     false
   end
 
+  sig { returns(MacOSVersion) }
   def minimum_version
     return MacOSVersion.new(HOMEBREW_MACOS_OLDEST_ALLOWED) if @comparator == "<=" || !version_specified?
     return @version.min if @version.respond_to?(:to_ary)
 
     @version
   end
 
+  sig { returns(MacOSVersion) }
   def maximum_version
     return MacOSVersion.new(HOMEBREW_MACOS_NEWEST_UNSUPPORTED) if @comparator == ">=" || !version_specified?
     return @version.max if @version.respond_to?(:to_ary)
 
     @version
   end
 
+  sig { params(other: MacOSVersion).returns(T::Boolean) }
   def allows?(other)
     return true unless version_specified?
 
@@ -98,6 +105,7 @@ def highest_allowed
     end
   end
 
+  sig { params(type: Symbol).returns(String) }
   def message(type: :formula)
     return "macOS is required for this software." unless version_specified?
 
@@ -113,6 +121,8 @@ def message(type: :formula)
         EOS
       when :cask
         "This cask does not run on macOS versions newer than #{@version.pretty_name}."
+      else
+        "This does not run on macOS versions newer than #{@version.pretty_name}."
       end
     else
       if @version.respond_to?(:to_ary)
@@ -129,6 +139,7 @@ def ==(other)
   end
   alias eql? ==
 
+  sig { returns(Integer) }
   def hash
     [super, comparator, version].hash
   end
@@ -151,6 +162,7 @@ def display_s
     end
   end
 
+  sig { params(options: T.untyped).returns(String) }
   def to_json(options)
     comp = @comparator.to_s
     return { comp => @version.map(&:to_s) }.to_json(options) if @version.is_a?(Array)