Merge pull request #3267 from reitermarkus/refactoring

Refactor DSL and Artifact classes.

12 files changed, 71 insertions, 81 deletions

diff --git a/Library/Homebrew/cask/lib/hbc/artifact.rb b/Library/Homebrew/cask/lib/hbc/artifact.rb
index cb15ec051..1cbe49cf2 100644
--- a/Library/Homebrew/cask/lib/hbc/artifact.rb
+++ b/Library/Homebrew/cask/lib/hbc/artifact.rb
@@ -25,44 +25,5 @@ require "hbc/artifact/zap"
 
 module Hbc
   module Artifact
-    # NOTE: Order is important here!
-    #
-    # The `uninstall` stanza should be run first, as it may
-    # depend on other artifacts still being installed.
-    #
-    # We want to extract nested containers before we
-    # handle any other artifacts.
-    #
-    CLASSES = [
-      PreflightBlock,
-      Uninstall,
-      NestedContainer,
-      Installer,
-      App,
-      Suite,
-      Artifact, # generic 'artifact' stanza
-      Colorpicker,
-      Pkg,
-      Prefpane,
-      Qlplugin,
-      Dictionary,
-      Font,
-      Service,
-      StageOnly,
-      Binary,
-      InputMethod,
-      InternetPlugin,
-      AudioUnitPlugin,
-      VstPlugin,
-      Vst3Plugin,
-      ScreenSaver,
-      PostflightBlock,
-      Zap,
-    ].freeze
-
-    def self.for_cask(cask)
-      odebug "Determining which artifacts are present in Cask #{cask}"
-      CLASSES.flat_map { |klass| klass.for_cask(cask) }
-    end
   end
 end
diff --git a/Library/Homebrew/cask/lib/hbc/artifact/abstract_artifact.rb b/Library/Homebrew/cask/lib/hbc/artifact/abstract_artifact.rb
index 1b18cc6e7..17a778f66 100644
--- a/Library/Homebrew/cask/lib/hbc/artifact/abstract_artifact.rb
+++ b/Library/Homebrew/cask/lib/hbc/artifact/abstract_artifact.rb
@@ -1,6 +1,7 @@
 module Hbc
   module Artifact
     class AbstractArtifact
+      include Comparable
       extend Predicable
 
       def self.english_name
@@ -19,8 +20,43 @@ module Hbc
         @dirmethod ||= "#{dsl_key}dir".to_sym
       end
 
-      def self.for_cask(cask)
-        cask.artifacts[dsl_key].to_a
+      def <=>(other)
+        return unless other.class < AbstractArtifact
+        return 0 if self.class == other.class
+
+        @@sort_order ||= [ # rubocop:disable Style/ClassVars
+          PreflightBlock,
+          # The `uninstall` stanza should be run first, as it may
+          # depend on other artifacts still being installed.
+          Uninstall,
+          # We want to extract nested containers before we
+          # handle any other artifacts.
+          NestedContainer,
+          Installer,
+          [
+            App,
+            Suite,
+            Artifact,
+            Colorpicker,
+            Prefpane,
+            Qlplugin,
+            Dictionary,
+            Font,
+            Service,
+            InputMethod,
+            InternetPlugin,
+            AudioUnitPlugin,
+            VstPlugin,
+            Vst3Plugin,
+            ScreenSaver,
+          ],
+          Binary,
+          Pkg,
+          PostflightBlock,
+          Zap,
+        ].each_with_index.flat_map { |classes, i| [*classes].map { |c| [c, i] } }.to_h
+
+        (@@sort_order[self.class] <=> @@sort_order[other.class]).to_i
       end
 
       # TODO: this sort of logic would make more sense in dsl.rb, or a
diff --git a/Library/Homebrew/cask/lib/hbc/artifact/abstract_flight_block.rb b/Library/Homebrew/cask/lib/hbc/artifact/abstract_flight_block.rb
index 4e8edbc11..a3075ff40 100644
--- a/Library/Homebrew/cask/lib/hbc/artifact/abstract_flight_block.rb
+++ b/Library/Homebrew/cask/lib/hbc/artifact/abstract_flight_block.rb
@@ -11,12 +11,6 @@ module Hbc
         dsl_key.to_s.prepend("uninstall_").to_sym
       end
 
-      def self.for_cask(cask)
-        [dsl_key, uninstall_dsl_key].flat_map do |key|
-          [*cask.artifacts[key]].map { |block| new(cask, key => block) }
-        end
-      end
-
       attr_reader :directives
 
       def initialize(cask, **directives)
diff --git a/Library/Homebrew/cask/lib/hbc/audit.rb b/Library/Homebrew/cask/lib/hbc/audit.rb
index 9ab93a67f..5b5a7b63d 100644
--- a/Library/Homebrew/cask/lib/hbc/audit.rb
+++ b/Library/Homebrew/cask/lib/hbc/audit.rb
@@ -218,7 +218,7 @@ module Hbc
     end
 
     def check_generic_artifacts
-      cask.artifacts[:artifact].each do |artifact|
+      cask.artifacts.select { |a| a.is_a?(Hbc::Artifact::Artifact) }.each do |artifact|
         unless artifact.target.absolute?
           add_error "target must be absolute path for #{artifact.class.english_name} #{artifact.source}"
         end
diff --git a/Library/Homebrew/cask/lib/hbc/cli/info.rb b/Library/Homebrew/cask/lib/hbc/cli/info.rb
index 2b4db9530..f12fe5564 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/info.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/info.rb
@@ -77,11 +77,11 @@ module Hbc
 
       def self.artifact_info(cask)
         ohai "Artifacts"
-        DSL::ORDINARY_ARTIFACT_CLASSES.flat_map { |klass| klass.for_cask(cask) }
-                                      .select { |artifact| artifact.respond_to?(:install_phase) }
-                                      .each do |artifact|
-                                        puts artifact.to_s
-                                      end
+        cask.artifacts.each do |artifact|
+          next unless artifact.respond_to?(:install_phase)
+          next unless DSL::ORDINARY_ARTIFACT_CLASSES.include?(artifact.class)
+          puts artifact.to_s
+        end
       end
     end
   end
diff --git a/Library/Homebrew/cask/lib/hbc/cli/list.rb b/Library/Homebrew/cask/lib/hbc/cli/list.rb
index 32415af8a..4b6a25d01 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/list.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/list.rb
@@ -30,7 +30,7 @@ module Hbc
       end
 
       def self.list_artifacts(cask)
-        Artifact.for_cask(cask).group_by(&:class).each do |klass, artifacts|
+        cask.artifacts.group_by(&:class).each do |klass, artifacts|
           next unless klass.respond_to?(:english_description)
           ohai klass.english_description, artifacts.map(&:summarize_installed)
         end
diff --git a/Library/Homebrew/cask/lib/hbc/container/base.rb b/Library/Homebrew/cask/lib/hbc/container/base.rb
index 52eb5aab1..78610a1ab 100644
--- a/Library/Homebrew/cask/lib/hbc/container/base.rb
+++ b/Library/Homebrew/cask/lib/hbc/container/base.rb
@@ -20,7 +20,7 @@ module Hbc
 
         unless children.count == 1 &&
                !nested_container.directory? &&
-               @cask.artifacts[:nested_container].empty? &&
+               @cask.artifacts.none? { |a| a.is_a?(Artifact::NestedContainer) } &&
                extract_nested_container(nested_container)
 
           children.each do |src|
diff --git a/Library/Homebrew/cask/lib/hbc/dsl.rb b/Library/Homebrew/cask/lib/hbc/dsl.rb
index 8d5b6c9a9..2db2c66a9 100644
--- a/Library/Homebrew/cask/lib/hbc/dsl.rb
+++ b/Library/Homebrew/cask/lib/hbc/dsl.rb
@@ -43,7 +43,7 @@ module Hbc
       Artifact::Zap,
     ].freeze
 
-    ACTIVATABLE_ARTIFACT_TYPES = (ORDINARY_ARTIFACT_CLASSES.map(&:dsl_key) - [:stage_only]).freeze
+    ACTIVATABLE_ARTIFACT_CLASSES = ORDINARY_ARTIFACT_CLASSES - [Artifact::StageOnly]
 
     ARTIFACT_BLOCK_CLASSES = [
       Artifact::PreflightBlock,
@@ -71,11 +71,12 @@ module Hbc
       :version,
       :appdir,
       *ORDINARY_ARTIFACT_CLASSES.map(&:dsl_key),
-      *ACTIVATABLE_ARTIFACT_TYPES,
+      *ACTIVATABLE_ARTIFACT_CLASSES.map(&:dsl_key),
       *ARTIFACT_BLOCK_CLASSES.flat_map { |klass| [klass.dsl_key, klass.uninstall_dsl_key] },
     ].freeze
 
-    attr_reader :token, :cask
+    attr_reader :cask, :token
+
     def initialize(cask)
       @cask = cask
       @token = cask.token
@@ -175,7 +176,7 @@ module Hbc
           DSL::Container.new(*args).tap do |container|
             # TODO: remove this backward-compatibility section after removing nested_container
             if container&.nested
-              artifacts[:nested_container] << Artifact::NestedContainer.new(cask, container.nested)
+              artifacts.add(Artifact::NestedContainer.new(cask, container.nested))
             end
           end
         end
@@ -218,7 +219,7 @@ module Hbc
     end
 
     def artifacts
-      @artifacts ||= Hash.new { |hash, key| hash[key] = Set.new }
+      @artifacts ||= SortedSet.new
     end
 
     def caskroom_path
@@ -250,15 +251,13 @@ module Hbc
     end
 
     ORDINARY_ARTIFACT_CLASSES.each do |klass|
-      type = klass.dsl_key
-
-      define_method(type) do |*args|
+      define_method(klass.dsl_key) do |*args|
         begin
-          if [*artifacts.keys, type].include?(:stage_only) && (artifacts.keys & ACTIVATABLE_ARTIFACT_TYPES).any?
+          if [*artifacts.map(&:class), klass].include?(Artifact::StageOnly) && (artifacts.map(&:class) & ACTIVATABLE_ARTIFACT_CLASSES).any?
             raise CaskInvalidError.new(cask, "'stage_only' must be the only activatable artifact.")
           end
 
-          artifacts[type].add(klass.from_args(cask, *args))
+          artifacts.add(klass.from_args(cask, *args))
         rescue CaskInvalidError
           raise
         rescue StandardError => e
@@ -270,7 +269,7 @@ module Hbc
     ARTIFACT_BLOCK_CLASSES.each do |klass|
       [klass.dsl_key, klass.uninstall_dsl_key].each do |dsl_key|
         define_method(dsl_key) do |&block|
-          artifacts[dsl_key] << block
+          artifacts.add(klass.new(cask, dsl_key => block))
         end
       end
     end
diff --git a/Library/Homebrew/cask/lib/hbc/dsl/appcast.rb b/Library/Homebrew/cask/lib/hbc/dsl/appcast.rb
index f984ac088..f3994b81f 100644
--- a/Library/Homebrew/cask/lib/hbc/dsl/appcast.rb
+++ b/Library/Homebrew/cask/lib/hbc/dsl/appcast.rb
@@ -3,17 +3,17 @@ require "hbc/system_command"
 module Hbc
   class DSL
     class Appcast
-      attr_reader :parameters, :checkpoint
+      attr_reader :uri, :checkpoint, :parameters
 
-      def initialize(uri, parameters = {})
-        @parameters     = parameters
-        @uri            = URI(uri)
-        @checkpoint     = @parameters[:checkpoint]
+      def initialize(uri, **parameters)
+        @uri        = URI(uri)
+        @parameters = parameters
+        @checkpoint = parameters[:checkpoint]
       end
 
       def calculate_checkpoint
         curl_executable, *args = curl_args(
-          "--compressed", "--location", "--fail", @uri,
+          "--compressed", "--location", "--fail", uri,
           user_agent: :fake
         )
         result = SystemCommand.run(curl_executable, args: args, print_stderr: false)
@@ -30,11 +30,11 @@ module Hbc
       end
 
       def to_yaml
-        [@uri, @parameters].to_yaml
+        [uri, parameters].to_yaml
       end
 
       def to_s
-        @uri.to_s
+        uri.to_s
       end
     end
   end
diff --git a/Library/Homebrew/cask/lib/hbc/dsl/base.rb b/Library/Homebrew/cask/lib/hbc/dsl/base.rb
index 63df847e9..b97c4e104 100644
--- a/Library/Homebrew/cask/lib/hbc/dsl/base.rb
+++ b/Library/Homebrew/cask/lib/hbc/dsl/base.rb
@@ -10,14 +10,14 @@ module Hbc
 
       def_delegators :@cask, :token, :version, :caskroom_path, :staged_path, :appdir, :language
 
-      def system_command(executable, options = {})
-        @command.run!(executable, options)
+      def system_command(executable, **options)
+        @command.run!(executable, **options)
       end
 
       def method_missing(method, *)
         if method
           underscored_class = self.class.name.gsub(/([[:lower:]])([[:upper:]][[:lower:]])/, '\1_\2').downcase
-          section = underscored_class.downcase.split("::").last
+          section = underscored_class.split("::").last
           Utils.method_missing_message(method, @cask.to_s, section)
           nil
         else
diff --git a/Library/Homebrew/cask/lib/hbc/installer.rb b/Library/Homebrew/cask/lib/hbc/installer.rb
index 01aae935d..ffbbac181 100644
--- a/Library/Homebrew/cask/lib/hbc/installer.rb
+++ b/Library/Homebrew/cask/lib/hbc/installer.rb
@@ -177,7 +177,7 @@ module Hbc
       already_installed_artifacts = []
 
       odebug "Installing artifacts"
-      artifacts = Artifact.for_cask(@cask)
+      artifacts = @cask.artifacts
       odebug "#{artifacts.length} artifact/s defined", artifacts
 
       artifacts.each do |artifact|
@@ -374,7 +374,7 @@ module Hbc
 
     def uninstall_artifacts
       odebug "Un-installing artifacts"
-      artifacts = Artifact.for_cask(@cask)
+      artifacts = @cask.artifacts
 
       odebug "#{artifacts.length} artifact/s defined", artifacts
 
@@ -388,7 +388,7 @@ module Hbc
     def zap
       ohai %Q(Implied "brew cask uninstall #{@cask}")
       uninstall_artifacts
-      if (zap_stanzas = Artifact::Zap.for_cask(@cask)).empty?
+      if (zap_stanzas = @cask.artifacts.select { |a| a.is_a?(Artifact::Zap) }).empty?
         opoo "No zap stanza present for Cask '#{@cask}'"
       else
         ohai "Dispatching zap stanza"
diff --git a/Library/Homebrew/cask/lib/hbc/staged.rb b/Library/Homebrew/cask/lib/hbc/staged.rb
index dc21279de..da097e0cf 100644
--- a/Library/Homebrew/cask/lib/hbc/staged.rb
+++ b/Library/Homebrew/cask/lib/hbc/staged.rb
@@ -4,7 +4,7 @@ module Hbc
       index =  0 if index == :first
       index =  1 if index == :second
       index = -1 if index == :last
-      @cask.artifacts[:app].to_a.at(index).target.join("Contents", "Info.plist")
+      @cask.artifacts.select { |a| a.is_a?(Artifact::App) }.at(index).target.join("Contents", "Info.plist")
     end
 
     def plist_exec(cmd)