Merge branch 'master' into audit_line_rubocop_part_4_rebase_attempt_1

15 files changed, 106 insertions, 146 deletions

diff --git a/Library/Homebrew/cask/lib/hbc/cli/abstract_command.rb b/Library/Homebrew/cask/lib/hbc/cli/abstract_command.rb
index 77f85301e..001a9623b 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/abstract_command.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/abstract_command.rb
@@ -42,41 +42,32 @@ module Hbc
         @args = process_arguments(*args)
       end
 
-      def self.warn_unavailable_with_suggestion(cask_token, e)
-        exact_match, partial_matches = Search.search(cask_token)
-        error_message = e.message
-        if exact_match
-          error_message.concat(" Did you mean:\n#{exact_match}")
-        elsif !partial_matches.empty?
-          error_message.concat(" Did you mean one of:\n")
-                       .concat(Formatter.columns(partial_matches.take(20)))
-        end
-        onoe error_message
-      end
-
       private
 
       def casks(alternative: -> { [] })
-        return to_enum(:casks, alternative: alternative) unless block_given?
-
-        count = 0
-
+        return @casks if defined?(@casks)
         casks = args.empty? ? alternative.call : args
+        @casks = casks.map { |cask| CaskLoader.load(cask) }
+      rescue CaskUnavailableError => e
+        reason = [e.reason, suggestion_message(e.token)].join(" ")
+        raise e.class.new(e.token, reason)
+      end
+
+      def suggestion_message(cask_token)
+        exact_match, partial_matches = Search.search(cask_token)
 
-        casks.each do |cask_or_token|
-          begin
-            yield cask_or_token.respond_to?(:token) ? cask_or_token : CaskLoader.load(cask_or_token)
-            count += 1
-          rescue CaskUnavailableError => e
-            cask_token = cask_or_token
-            self.class.warn_unavailable_with_suggestion cask_token, e
-          rescue CaskError => e
-            onoe e.message
-          end
+        if exact_match.nil? && partial_matches.count == 1
+          exact_match = partial_matches.first
         end
 
-        return :empty if casks.length.zero?
-        (count == casks.length) ? :complete : :incomplete
+        if exact_match
+          "Did you mean “#{exact_match}”?"
+        elsif !partial_matches.empty?
+          "Did you mean one of these?\n"
+            .concat(Formatter.columns(partial_matches.take(20)))
+        else
+          ""
+        end
       end
     end
   end
diff --git a/Library/Homebrew/cask/lib/hbc/cli/cat.rb b/Library/Homebrew/cask/lib/hbc/cli/cat.rb
index d08c87bea..043080556 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/cat.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/cat.rb
@@ -7,10 +7,6 @@ module Hbc
       end
 
       def run
-        raise CaskError, "Cat incomplete." if cat_casks == :incomplete
-      end
-
-      def cat_casks
         casks.each do |cask|
           puts File.open(cask.sourcefile_path, &:read)
         end
diff --git a/Library/Homebrew/cask/lib/hbc/cli/edit.rb b/Library/Homebrew/cask/lib/hbc/cli/edit.rb
index b9485886c..8bce81c52 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/edit.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/edit.rb
@@ -4,21 +4,18 @@ module Hbc
       def initialize(*)
         super
         raise CaskUnspecifiedError if args.empty?
-        raise ArgumentError, "Only one Cask can be created at a time." if args.count > 1
+        raise ArgumentError, "Only one Cask can be edited at a time." if args.count > 1
       end
 
       def run
-        cask_token = args.first
-        cask_path = begin
-          CaskLoader.load(cask_token).sourcefile_path
-        rescue CaskUnavailableError => e
-          reason = e.reason.empty? ? "" : "#{e.reason} "
-          reason.concat("Run #{Formatter.identifier("brew cask create #{e.token}")} to create a new Cask.")
-          raise e.class.new(e.token, reason)
-        end
-
-        odebug "Opening editor for Cask #{cask_token}"
+        cask = casks.first
+        cask_path = cask.sourcefile_path
+        odebug "Opening editor for Cask #{cask.token}"
         exec_editor cask_path
+      rescue CaskUnavailableError => e
+        reason = e.reason.empty? ? "" : "#{e.reason} "
+        reason.concat("Run #{Formatter.identifier("brew cask create #{e.token}")} to create a new Cask.")
+        raise e.class.new(e.token, reason)
       end
 
       def self.help
diff --git a/Library/Homebrew/cask/lib/hbc/cli/fetch.rb b/Library/Homebrew/cask/lib/hbc/cli/fetch.rb
index e31b1a17c..12c794f5f 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/fetch.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/fetch.rb
@@ -9,10 +9,6 @@ module Hbc
       end
 
       def run
-        raise CaskError, "Fetch incomplete." if fetch_casks == :incomplete
-      end
-
-      def fetch_casks
         casks.each do |cask|
           ohai "Downloading external files for Cask #{cask}"
           downloaded_path = Download.new(cask, force: force?).perform
diff --git a/Library/Homebrew/cask/lib/hbc/cli/info.rb b/Library/Homebrew/cask/lib/hbc/cli/info.rb
index d26747e17..f12fe5564 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/info.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/info.rb
@@ -23,6 +23,7 @@ module Hbc
         installation_info(cask)
         repo_info(cask)
         name_info(cask)
+        language_info(cask)
         artifact_info(cask)
         Installer.print_caveats(cask)
       end
@@ -51,6 +52,13 @@ module Hbc
         puts cask.name.empty? ? Formatter.error("None") : cask.name
       end
 
+      def self.language_info(cask)
+        return if cask.languages.empty?
+
+        ohai "Languages"
+        puts cask.languages.join(", ")
+      end
+
       def self.repo_info(cask)
         user, repo, token = QualifiedToken.parse(Hbc.all_tokens.detect { |t| t.split("/").last == cask.token })
 
@@ -69,12 +77,10 @@ module Hbc
 
       def self.artifact_info(cask)
         ohai "Artifacts"
-        DSL::ORDINARY_ARTIFACT_TYPES.each do |type|
-          next if cask.artifacts[type].empty?
-          cask.artifacts[type].each do |artifact|
-            activatable_item = (type == :stage_only) ? "<none>" : artifact.first
-            puts "#{activatable_item} (#{type})"
-          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
diff --git a/Library/Homebrew/cask/lib/hbc/cli/install.rb b/Library/Homebrew/cask/lib/hbc/cli/install.rb
index 0f1a5dd34..9a2116e6a 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/install.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/install.rb
@@ -10,10 +10,6 @@ module Hbc
       end
 
       def run
-        raise CaskError, "Install incomplete." if install_casks == :incomplete
-      end
-
-      def install_casks
         casks.each do |cask|
           begin
             Installer.new(cask, binaries:       binaries?,
diff --git a/Library/Homebrew/cask/lib/hbc/cli/internal_appcast_checkpoint.rb b/Library/Homebrew/cask/lib/hbc/cli/internal_appcast_checkpoint.rb
index cd2679782..a538ffd8c 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/internal_appcast_checkpoint.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/internal_appcast_checkpoint.rb
@@ -12,7 +12,7 @@ module Hbc
         if args.all? { |t| t =~ %r{^https?://} && t !~ /\.rb$/ }
           self.class.appcask_checkpoint_for_url(args)
         else
-          self.class.appcask_checkpoint(args, calculate?)
+          self.class.appcask_checkpoint(casks, calculate?)
         end
       end
 
@@ -23,33 +23,27 @@ module Hbc
         end
       end
 
-      def self.appcask_checkpoint(cask_tokens, calculate)
-        count = 0
-
-        cask_tokens.each do |cask_token|
-          cask = CaskLoader.load(cask_token)
-
+      def self.appcask_checkpoint(casks, calculate)
+        casks.each do |cask|
           if cask.appcast.nil?
             opoo "Cask '#{cask}' is missing an `appcast` stanza."
           else
-            if calculate
+            checkpoint = if calculate
               result = cask.appcast.calculate_checkpoint
-
-              checkpoint = result[:checkpoint]
+              result[:checkpoint]
             else
-              checkpoint = cask.appcast.checkpoint
+              cask.appcast.checkpoint
             end
 
-            if checkpoint.nil?
+            if calculate && checkpoint.nil?
               onoe "Could not retrieve `appcast` checkpoint for cask '#{cask}': #{result[:command_result].stderr}"
+            elsif casks.count > 1
+              puts "#{checkpoint}  #{cask}"
             else
-              puts((cask_tokens.count > 1) ? "#{checkpoint}  #{cask}" : checkpoint)
-              count += 1
+              puts checkpoint
             end
           end
         end
-
-        count == cask_tokens.count
       end
 
       def self.help
diff --git a/Library/Homebrew/cask/lib/hbc/cli/internal_audit_modified_casks.rb b/Library/Homebrew/cask/lib/hbc/cli/internal_audit_modified_casks.rb
index 3673a5391..b83224fb1 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/internal_audit_modified_casks.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/internal_audit_modified_casks.rb
@@ -59,7 +59,7 @@ module Hbc
       end
 
       def modified_cask_files
-        @modified_cask_files ||= git_filter_cask_files("AM")
+        @modified_cask_files ||= git_filter_cask_files("AMR")
       end
 
       def added_cask_files
diff --git a/Library/Homebrew/cask/lib/hbc/cli/internal_dump.rb b/Library/Homebrew/cask/lib/hbc/cli/internal_dump.rb
index e21ce86b6..8a38ce1be 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/internal_dump.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/internal_dump.rb
@@ -7,10 +7,6 @@ module Hbc
       end
 
       def run
-        raise CaskError, "Dump incomplete." if dump_casks == :incomplet
-      end
-
-      def dump_casks
         casks.each(&:dumpcask)
       end
 
diff --git a/Library/Homebrew/cask/lib/hbc/cli/internal_stanza.rb b/Library/Homebrew/cask/lib/hbc/cli/internal_stanza.rb
index 4515fe931..c04619798 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/internal_stanza.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/internal_stanza.rb
@@ -3,7 +3,7 @@ module Hbc
     class InternalStanza < AbstractInternalCommand
       # Syntax
       #
-      #     brew cask _stanza <stanza_name> [ --table | --yaml | --inspect | --quiet ] [ <cask_token> ... ]
+      #     brew cask _stanza <stanza_name> [ --quiet ] [ --table | --yaml ] [ <cask_token> ... ]
       #
       # If no tokens are given, then data for all Casks is returned.
       #
@@ -14,41 +14,16 @@ module Hbc
       # Examples
       #
       #     brew cask _stanza appcast   --table
-      #     brew cask _stanza app       --table alfred google-chrome adium voicemac logisim vagrant
-      #     brew cask _stanza url       --table alfred google-chrome adium voicemac logisim vagrant
-      #     brew cask _stanza version   --table alfred google-chrome adium voicemac logisim vagrant
-      #     brew cask _stanza artifacts --table --inspect alfred google-chrome adium voicemac logisim vagrant
-      #     brew cask _stanza artifacts --table --yaml    alfred google-chrome adium voicemac logisim vagrant
+      #     brew cask _stanza app       --table           alfred google-chrome adium vagrant
+      #     brew cask _stanza url       --table           alfred google-chrome adium vagrant
+      #     brew cask _stanza version   --table           alfred google-chrome adium vagrant
+      #     brew cask _stanza artifacts --table           alfred google-chrome adium vagrant
+      #     brew cask _stanza artifacts --table --yaml    alfred google-chrome adium vagrant
       #
 
-      # TODO: this should be retrievable from Hbc::DSL
-      ARTIFACTS = Set.new [
-        :app,
-        :suite,
-        :artifact,
-        :prefpane,
-        :qlplugin,
-        :dictionary,
-        :font,
-        :service,
-        :colorpicker,
-        :binary,
-        :input_method,
-        :internet_plugin,
-        :audio_unit_plugin,
-        :vst_plugin,
-        :vst3_plugin,
-        :screen_saver,
-        :pkg,
-        :installer,
-        :stage_only,
-        :nested_container,
-        :uninstall,
-        :preflight,
-        :postflight,
-        :uninstall_preflight,
-        :uninstall_postflight,
-      ]
+      ARTIFACTS =
+        DSL::ORDINARY_ARTIFACT_CLASSES.map(&:dsl_key) +
+        DSL::ARTIFACT_BLOCK_CLASSES.map(&:dsl_key)
 
       option "--table",   :table,   false
       option "--quiet",   :quiet,   false
@@ -68,16 +43,9 @@ module Hbc
         @stanza = args.shift.to_sym
 
         @format = :to_yaml if yaml?
-        @format = :inspect if inspect?
       end
 
       def run
-        return unless print_stanzas == :incomplete
-        exit 1 if quiet?
-        raise CaskError, "Print incomplete."
-      end
-
-      def print_stanzas
         if ARTIFACTS.include?(stanza)
           artifact_name = stanza
           @stanza = :artifacts
@@ -93,7 +61,7 @@ module Hbc
           end
 
           begin
-            value = cask.send(@stanza)
+            value = cask.send(stanza)
           rescue StandardError
             opoo "failure calling '#{stanza}' on Cask '#{cask}'" unless quiet?
             puts ""
@@ -106,11 +74,25 @@ module Hbc
             next
           end
 
-          value = value.fetch(artifact_name).to_a.flatten if artifact_name
+          if stanza == :artifacts
+            value = Hash[
+              value.map do |k, v|
+                v = v.map do |a|
+                  next a.to_a if a.respond_to?(:to_a)
+                  next a.to_h if a.respond_to?(:to_h)
+                  a
+                end
+
+                [k, v]
+              end
+            ]
+
+            value = value.fetch(artifact_name) if artifact_name
+          end
 
-          if @format
-            puts value.send(@format)
-          elsif artifact_name || value.is_a?(Symbol)
+          if format
+            puts value.send(format)
+          elsif value.is_a?(Symbol)
             puts value.inspect
           else
             puts value.to_s
diff --git a/Library/Homebrew/cask/lib/hbc/cli/list.rb b/Library/Homebrew/cask/lib/hbc/cli/list.rb
index 9d978360e..4a50ae74a 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/list.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/list.rb
@@ -3,6 +3,7 @@ module Hbc
     class List < AbstractCommand
       option "-1", :one, false
       option "--versions", :versions, false
+      option "--full-name", :full_name, false
 
       option "-l", (lambda do |*|
         one = true # rubocop:disable Lint/UselessAssignment
@@ -10,8 +11,7 @@ module Hbc
       end)
 
       def run
-        retval = args.any? ? list : list_installed
-        raise CaskError, "Listing incomplete." if retval == :incomplete
+        args.any? ? list : list_installed
       end
 
       def list
@@ -23,16 +23,16 @@ module Hbc
           elsif versions?
             puts self.class.format_versioned(cask)
           else
-            cask = CaskLoader.load_from_file(cask.installed_caskfile)
+            cask = CaskLoader.load(cask.installed_caskfile)
             self.class.list_artifacts(cask)
           end
         end
       end
 
       def self.list_artifacts(cask)
-        Artifact.for_cask(cask).each do |artifact|
-          summary = artifact.summary
-          ohai summary[:english_description], summary[:contents] unless summary.empty?
+        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
       end
 
@@ -43,11 +43,11 @@ module Hbc
           puts installed_casks.map(&:to_s)
         elsif versions?
           puts installed_casks.map(&self.class.method(:format_versioned))
+        elsif full_name?
+          puts installed_casks.map(&:full_name).sort &tap_and_name_comparison
         elsif !installed_casks.empty?
           puts Formatter.columns(installed_casks.map(&:to_s))
         end
-
-        installed_casks.empty? ? :empty : :complete
       end
 
       def self.format_versioned(cask)
diff --git a/Library/Homebrew/cask/lib/hbc/cli/reinstall.rb b/Library/Homebrew/cask/lib/hbc/cli/reinstall.rb
index 337a2eb9d..408be134d 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/reinstall.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/reinstall.rb
@@ -1,7 +1,7 @@
 module Hbc
   class CLI
     class Reinstall < Install
-      def install_casks
+      def run
         casks.each do |cask|
           Installer.new(cask, binaries:       binaries?,
                               verbose:        verbose?,
diff --git a/Library/Homebrew/cask/lib/hbc/cli/search.rb b/Library/Homebrew/cask/lib/hbc/cli/search.rb
index 643d18d55..d56d0c81f 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/search.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/search.rb
@@ -2,8 +2,12 @@ module Hbc
   class CLI
     class Search < AbstractCommand
       def run
-        results = self.class.search(*args)
-        self.class.render_results(*results)
+        if args.empty?
+          puts Formatter.columns(CLI.nice_listing(Hbc.all_tokens))
+        else
+          results = self.class.search(*args)
+          self.class.render_results(*results)
+        end
       end
 
       def self.extract_regexp(string)
@@ -15,8 +19,18 @@ module Hbc
       end
 
       def self.search_remote(query)
-        matches = GitHub.search_code("user:caskroom", "path:Casks", "filename:#{query}", "extension:rb")
-        [*matches].map do |match|
+        matches = begin
+          GitHub.search_code(
+            user: "caskroom",
+            path: "Casks",
+            filename: query,
+            extension: "rb",
+          )
+        rescue GitHub::Error => error
+          opoo "Error searching on GitHub: #{error}\n"
+          []
+        end
+        matches.map do |match|
           tap = Tap.fetch(match["repository"]["full_name"])
           next if tap.installed?
           "#{tap.name}/#{File.basename(match["path"], ".rb")}"
diff --git a/Library/Homebrew/cask/lib/hbc/cli/uninstall.rb b/Library/Homebrew/cask/lib/hbc/cli/uninstall.rb
index c0697c808..f2059605c 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/uninstall.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/uninstall.rb
@@ -9,10 +9,6 @@ module Hbc
       end
 
       def run
-        raise CaskError, "Uninstall incomplete." if uninstall_casks == :incomplete
-      end
-
-      def uninstall_casks
         casks.each do |cask|
           odebug "Uninstalling Cask #{cask}"
 
@@ -20,7 +16,7 @@ module Hbc
 
           if cask.installed? && !cask.installed_caskfile.nil?
             # use the same cask file that was used for installation, if possible
-            cask = CaskLoader.load_from_file(cask.installed_caskfile) if cask.installed_caskfile.exist?
+            cask = CaskLoader.load(cask.installed_caskfile) if cask.installed_caskfile.exist?
           end
 
           Installer.new(cask, binaries: binaries?, verbose: verbose?, force: force?).uninstall
diff --git a/Library/Homebrew/cask/lib/hbc/cli/zap.rb b/Library/Homebrew/cask/lib/hbc/cli/zap.rb
index e709f4191..7f5e6785d 100644
--- a/Library/Homebrew/cask/lib/hbc/cli/zap.rb
+++ b/Library/Homebrew/cask/lib/hbc/cli/zap.rb
@@ -9,10 +9,6 @@ module Hbc
       end
 
       def run
-        raise CaskError, "Zap incomplete." if zap_casks == :incomplete
-      end
-
-      def zap_casks
         casks.each do |cask|
           odebug "Zapping Cask #{cask}"
           Installer.new(cask, verbose: verbose?, force: force?).zap