livecheck: clarify livecheckable language

Formulae, casks, and resources have a `#livecheckable?` method that
indicates whether they contain a `livecheck` block. This is intended
to be read as "has a livecheckable?", not "is livecheckable?" (as
livecheck can find versions for some packages/resources without a
`livecheck` block). Unfortunately, correct understanding of this
method's behavior [outside of documentation] relies on historical
knowledge that few people possess, so this is often confusing to
anyone who hasn't been working on livecheck since 2020.

In the olden days, a "livecheckable" was a Ruby file containing a
`livecheck` block (originally a hash) with a filename that
corresponded to a related formula. The `livecheck` blocks in
livecheckable files were integrated into their respective formulae in
August 2020, so [first-party] livecheckables ceased to exist at that
time. From that point forward, we simply referred to these as
`livecheck` blocks.

With that in mind, this clarifies the situation by replacing
"livecheckable" language. This includes renaming `#livecheckable?` to
`#livecheck_defined?`, replacing usage of "livecheckable" as a noun
with "`livecheck` block", replacing "livecheckable" as a boolean with
"livecheck_defined", and replacing incorrect usage of "livecheckable"
as an adjective with "checkable".

Library/Homebrew/cask/audit.rb

@@ -277,7 +277,7 @@ def audit_sha256_invalid
     sig { void }
     def audit_latest_with_livecheck
       return unless cask.version&.latest?
-      return unless cask.livecheckable?
+      return unless cask.livecheck_defined?
       return if cask.livecheck.skip?
 
       add_error "Casks with a `livecheck` should not use `version :latest`."
@@ -299,7 +299,7 @@ def audit_hosting_with_livecheck(livecheck_result: audit_livecheck_version)
       return if cask.version&.latest?
       return if (url = cask.url).nil?
       return if block_url_offline?
-      return if cask.livecheckable?
+      return if cask.livecheck_defined?
       return if livecheck_result == :auto_detected
 
       add_livecheck = "please add a livecheck. See #{Formatter.url(LIVECHECK_REFERENCE_URL)}"
@@ -693,7 +693,7 @@ def audit_min_os
     sig { returns(T.nilable(MacOSVersion)) }
     def livecheck_min_os
       return unless online?
-      return unless cask.livecheckable?
+      return unless cask.livecheck_defined?
       return if cask.livecheck.strategy != :sparkle
 
       # `Sparkle` strategy blocks that use the `items` argument (instead of
@@ -924,7 +924,7 @@ def audit_url_https_availability
     sig { void }
     def audit_livecheck_https_availability
       return unless online?
-      return unless cask.livecheckable?
+      return unless cask.livecheck_defined?
       return unless (url = cask.livecheck.url)
       return if url.is_a?(Symbol)
 

Library/Homebrew/cask/cask.rbi

@@ -44,6 +44,8 @@ module Cask
 
     def livecheck; end
 
+    def livecheck_defined?; end
+
     def livecheckable?; end
 
     def name; end

Library/Homebrew/cask/dsl.rb

@@ -95,7 +95,8 @@ class DSL
       :disable_replacement,
       :discontinued?, # TODO: remove once discontinued? is removed (4.5.0)
       :livecheck,
-      :livecheckable?,
+      :livecheck_defined?,
+      :livecheckable?, # TODO: remove once `#livecheckable?` is removed
       :on_system_blocks_exist?,
       :on_system_block_min_os,
       :depends_on_set_in_block?,
@@ -110,7 +111,7 @@ class DSL
     attr_reader :cask, :token, :deprecation_date, :deprecation_reason, :deprecation_replacement, :disable_date,
                 :disable_reason, :disable_replacement, :on_system_block_min_os
 
-    attr_predicate :deprecated?, :disabled?, :livecheckable?, :on_system_blocks_exist?, :depends_on_set_in_block?
+    attr_predicate :deprecated?, :disabled?, :livecheck_defined?, :on_system_blocks_exist?, :depends_on_set_in_block?
 
     def initialize(cask)
       @cask = cask
@@ -431,14 +432,22 @@ def livecheck(&block)
       @livecheck ||= Livecheck.new(cask)
       return @livecheck unless block
 
-      if !@cask.allow_reassignment && @livecheckable
+      if !@cask.allow_reassignment && @livecheck_defined
         raise CaskInvalidError.new(cask, "'livecheck' stanza may only appear once.")
       end
 
-      @livecheckable = true
+      @livecheck_defined = true
       @livecheck.instance_eval(&block)
     end
 
+    # Whether the cask contains a `livecheck` block. This is a legacy alias
+    # for `#livecheck_defined?`.
+    sig { returns(T::Boolean) }
+    def livecheckable?
+      # odeprecated "`livecheckable?`", "`livecheck_defined?`"
+      @livecheck_defined == true
+    end
+
     # Declare that a cask is no longer functional or supported.
     #
     # NOTE: A warning will be shown when trying to install this cask.

Library/Homebrew/dev-cmd/bump-unversioned-casks.rb

@@ -44,7 +44,7 @@ def run
         casks = args.named.to_paths(only: :cask, recurse_tap: true).map { |path| Cask::CaskLoader.load(path) }
 
         unversioned_casks = casks.select do |cask|
-          cask.url&.unversioned? && !cask.livecheckable?
+          cask.url&.unversioned? && !cask.livecheck_defined?
         end
 
         ohai "Unversioned Casks: #{unversioned_casks.count} (#{state.size} cached)"

Library/Homebrew/dev-cmd/bump.rb

@@ -137,7 +137,7 @@ def run
       def skip_repology?(formula_or_cask)
         return true unless args.repology?
 
-        (ENV["CI"].present? && args.open_pr? && formula_or_cask.livecheckable?) ||
+        (ENV["CI"].present? && args.open_pr? && formula_or_cask.livecheck_defined?) ||
           (formula_or_cask.is_a?(Formula) && formula_or_cask.versioned_formula?)
       end
 
@@ -329,7 +329,7 @@ def retrieve_versions_by_arch(formula_or_cask:, repositories:, name:)
               "skipped"
             elsif repology_latest.is_a?(Version) &&
                   repology_latest > current_version_value &&
-                  !loaded_formula_or_cask.livecheckable? &&
+                  !loaded_formula_or_cask.livecheck_defined? &&
                   current_version_value != "latest"
               repology_latest
             end.presence
@@ -490,8 +490,8 @@ def retrieve_and_display_info_and_open_pr(formula_or_cask, name, repositories, a
         if repology_latest.is_a?(Version) &&
            repology_latest > current_version.general &&
            repology_latest > new_version.general &&
-           formula_or_cask.livecheckable?
-          puts "#{title_name} was not bumped to the Repology version because it's livecheckable."
+           formula_or_cask.livecheck_defined?
+          puts "#{title_name} was not bumped to the Repology version because it has a `livecheck` block."
         end
         if new_version.blank? || versions_equal ||
            (!new_version.general.is_a?(Version) && !version_info.multiple_versions)

Library/Homebrew/dev-cmd/irb.rb

@@ -64,7 +64,7 @@ def run
             :mpd.f.recursive_dependencies.reject(&:installed?)
 
             'vlc'.c # => instance of the vlc cask
-            :tsh.c.livecheckable?
+            :tsh.c.livecheck_defined?
           EOS
           return
         end

Library/Homebrew/formula.rb

@@ -454,6 +454,11 @@ def bottle_for_tag(tag = nil)
   # @see .livecheck=
   delegate livecheck: :"self.class"
 
+  # Is a livecheck specification defined for the software?
+  # @!method livecheck_defined?
+  # @see .livecheck_defined?
+  delegate livecheck_defined?: :"self.class"
+
   # Is a livecheck specification defined for the software?
   # @!method livecheckable?
   # @see .livecheckable?
@@ -3537,8 +3542,19 @@ def network_access_allowed?(phase)
     # It returns `true` when a `livecheck` block is present in the {Formula}
     # and `false` otherwise.
     sig { returns(T::Boolean) }
+    def livecheck_defined?
+      @livecheck_defined == true
+    end
+
+    # Checks whether a `livecheck` specification is defined or not. This is a
+    # legacy alias for `#livecheck_defined?`.
+    #
+    # It returns `true` when a `livecheck` block is present in the {Formula}
+    # and `false` otherwise.
+    sig { returns(T::Boolean) }
     def livecheckable?
-      @livecheckable == true
+      # odeprecated "`livecheckable?`", "`livecheck_defined?`"
+      @livecheck_defined == true
     end
 
     # Checks whether a service specification is defined or not.
@@ -4183,7 +4199,7 @@ def test(&block)
     def livecheck(&block)
       return @livecheck unless block
 
-      @livecheckable = true
+      @livecheck_defined = true
       @livecheck.instance_eval(&block)
     end
 

Library/Homebrew/livecheck/livecheck.rb

@@ -347,7 +347,7 @@ def self.run_checks(
           newer_than_upstream: is_newer_than_upstream,
         }.compact
         info[:meta] = {
-          livecheckable: formula_or_cask.livecheckable?,
+          livecheck_defined: formula_or_cask.livecheck_defined?,
         }
         info[:meta][:head_only] = true if formula&.head_only?
         info[:meta].merge!(version_info[:meta]) if version_info.present? && version_info.key?(:meta)
@@ -465,7 +465,7 @@ def self.status_hash(package_or_resource, status_str, messages = nil, full_name:
       status_hash[:messages] = messages if messages.is_a?(Array)
 
       status_hash[:meta] = {
-        livecheckable: package_or_resource.livecheckable?,
+        livecheck_defined: package_or_resource.livecheck_defined?,
       }
       status_hash[:meta][:head_only] = true if formula&.head_only?
 
@@ -478,7 +478,7 @@ def self.status_hash(package_or_resource, status_str, messages = nil, full_name:
       package_or_resource_s = info[:resource].present? ? "  " : ""
       package_or_resource_s += "#{Tty.blue}#{info[:formula] || info[:cask] || info[:resource]}#{Tty.reset}"
       package_or_resource_s += " (cask)" if ambiguous_cask
-      package_or_resource_s += " (guessed)" if verbose && !info[:meta][:livecheckable]
+      package_or_resource_s += " (guessed)" if verbose && !info[:meta][:livecheck_defined]
 
       current_s = if info[:version][:newer_than_upstream]
         "#{Tty.red}#{info[:version][:current]}#{Tty.reset}"
@@ -608,7 +608,7 @@ def self.latest_version(
       formula = formula_or_cask if formula_or_cask.is_a?(Formula)
       cask = formula_or_cask if formula_or_cask.is_a?(Cask::Cask)
 
-      has_livecheckable = formula_or_cask.livecheckable?
+      livecheck_defined = formula_or_cask.livecheck_defined?
       livecheck = formula_or_cask.livecheck
       referenced_livecheck = referenced_formula_or_cask&.livecheck
 
@@ -632,7 +632,7 @@ def self.latest_version(
         elsif cask
           puts "Cask:             #{cask_name(formula_or_cask, full_name:)}"
         end
-        puts "Livecheckable?:   #{has_livecheckable ? "Yes" : "No"}"
+        puts "livecheck block?: #{livecheck_defined ? "Yes" : "No"}"
         puts "Throttle:         #{livecheck_throttle}" if livecheck_throttle
 
         livecheck_references.each do |ref_formula_or_cask|
@@ -736,7 +736,7 @@ def self.latest_version(
 
         match_version_map.delete_if do |_match, version|
           next true if version.blank?
-          next false if has_livecheckable
+          next false if livecheck_defined
 
           UNSTABLE_VERSION_KEYWORDS.any? do |rejection|
             version.to_s.include?(rejection)
@@ -839,12 +839,12 @@ def self.resource_version(
       quiet: false,
       verbose: false
     )
-      has_livecheckable = resource.livecheckable?
+      livecheck_defined = resource.livecheck_defined?
 
       if debug
         puts "\n\n"
         puts "Resource:         #{resource.name}"
-        puts "Livecheckable?:   #{has_livecheckable ? "Yes" : "No"}"
+        puts "livecheck block?: #{livecheck_defined ? "Yes" : "No"}"
       end
 
       resource_version_info = {}
@@ -939,7 +939,7 @@ def self.resource_version(
 
         match_version_map.delete_if do |_match, version|
           next true if version.blank?
-          next false if has_livecheckable
+          next false if livecheck_defined
 
           UNSTABLE_VERSION_KEYWORDS.any? do |rejection|
             version.to_s.include?(rejection)
@@ -978,7 +978,10 @@ def self.resource_version(
           },
         }
 
-        resource_version_info[:meta] = { livecheckable: has_livecheckable, url: {} }
+        resource_version_info[:meta] = {
+          livecheck_defined: livecheck_defined,
+          url:               {},
+        }
         if livecheck_url.is_a?(Symbol) && livecheck_url_string
           resource_version_info[:meta][:url][:symbol] = livecheck_url
         end