Merge pull request #8893 from whoiswillma/william/integrate-brew-info

cmd/info: Add support for casks in brew info
2020-10-26 11:59:53 +00:00 · 2020-10-26 11:59:53 +00:00 · 60046ac41c
commit 60046ac41c
parent a5241e868c a463348631
3 changed files with 126 additions and 48 deletions
--- a/Library/Homebrew/cli/named_args.rb
+++ b/Library/Homebrew/cli/named_args.rb
@ -39,6 +39,22 @@ module Homebrew
        end
      end

+      def to_formulae_to_casks(method: nil, only: nil)
+        @to_formulae_to_casks ||= {}
+        @to_formulae_to_casks[[method, only]] = to_formulae_and_casks(method: method, only: only)
+                                                .partition { |o| o.is_a?(Formula) }
+                                                .map(&:freeze).freeze
+      end
+
+      def to_formulae_and_casks_and_unavailable(method: nil)
+        @to_formulae_casks_unknowns ||= {}
+        @to_formulae_casks_unknowns[method] = downcased_unique_named.map do |name|
+          load_formula_or_cask(name, method: method)
+        rescue FormulaOrCaskUnavailableError => e
+          e
+        end.uniq.freeze
+      end
+
      def load_formula_or_cask(name, only: nil, method: nil)
        if only != :cask
          begin
@ -81,9 +97,7 @@ module Homebrew
      end

      def to_resolved_formulae_to_casks(only: nil)
-        @to_resolved_formulae_to_casks ||= to_formulae_and_casks(method: :resolve, only: only)
-                                           .partition { |o| o.is_a?(Formula) }
-                                           .map(&:freeze).freeze
+        to_formulae_to_casks(method: :resolve, only: only)
      end

      # Convert named arguments to `Tap`, `Formula` or `Cask` objects.
--- a/Library/Homebrew/cmd/info.rb
+++ b/Library/Homebrew/cmd/info.rb
@ -65,27 +65,26 @@ module Homebrew
  def info
    args = info_args.parse

-    if args.days.present? && !VALID_DAYS.include?(args.days)
-      raise UsageError, "--days must be one of #{VALID_DAYS.join(", ")}"
-    end
-
-    if args.category.present?
-      if args.named.present? && !VALID_FORMULA_CATEGORIES.include?(args.category)
-        raise UsageError, "--category must be one of #{VALID_FORMULA_CATEGORIES.join(", ")} when querying formulae"
+    if args.analytics?
+      if args.days.present? && !VALID_DAYS.include?(args.days)
+        raise UsageError, "--days must be one of #{VALID_DAYS.join(", ")}"
      end

-      unless VALID_CATEGORIES.include?(args.category)
-        raise UsageError, "--category must be one of #{VALID_CATEGORIES.join(", ")}"
+      if args.category.present?
+        if args.named.present? && !VALID_FORMULA_CATEGORIES.include?(args.category)
+          raise UsageError, "--category must be one of #{VALID_FORMULA_CATEGORIES.join(", ")} when querying formulae"
+        end
+
+        unless VALID_CATEGORIES.include?(args.category)
+          raise UsageError, "--category must be one of #{VALID_CATEGORIES.join(", ")}"
+        end
      end
-    end
-
-    if args.json
-      raise UsageError, "invalid JSON version: #{args.json}" unless ["v1", true].include? args.json
-      raise FormulaUnspecifiedError if !(args.all? || args.installed?) && args.no_named?

+      print_analytics(args: args)
+    elsif args.json
      print_json(args: args)
    elsif args.github?
-      raise FormulaUnspecifiedError if args.no_named?
+      raise FormulaOrCaskUnspecifiedError if args.no_named?

      exec_browser(*args.named.to_formulae_and_casks.map { |f| github_info(f) })
    else
@ -93,7 +92,7 @@ module Homebrew
    end
  end

-  def print_info(args:)
+  def print_analytics(args:)
    if args.no_named?
      if args.analytics?
        Utils::Analytics.output(args: args)
@ -101,40 +100,90 @@ module Homebrew
        count = Formula.racks.length
        puts "#{count} #{"keg".pluralize(count)}, #{HOMEBREW_CELLAR.dup.abv}"
      end
-    else
-      args.named.each_with_index do |f, i|
-        puts unless i.zero?
-        begin
-          formula = Formulary.factory(f)
-          if args.analytics?
-            Utils::Analytics.formula_output(formula, args: args)
-          else
-            info_formula(formula, args: args)
-          end
-        rescue FormulaUnavailableError => e
-          if args.analytics?
-            Utils::Analytics.output(filter: f, args: args)
-            next
-          end
-          ofail e.message
-          # No formula with this name, try a missing formula lookup
-          if (reason = MissingFormula.reason(f, show_info: true))
-            $stderr.puts reason
-          end
-        end
+
+      return
+    end
+
+    args.named.to_formulae_and_casks_and_unavailable.each_with_index do |obj, i|
+      puts unless i.zero?
+
+      case obj
+      when Formula
+        Utils::Analytics.formula_output(obj, args: args)
+      when Cask::Cask
+        Utils::Analytics.cask_output(obj, args: args)
+      when FormulaOrCaskUnavailableError
+        Utils::Analytics.output(filter: obj.name, args: args)
+      else
+        raise
      end
    end
  end

-  def print_json(args:)
-    ff = if args.all?
-      Formula.sort
-    elsif args.installed?
-      Formula.installed.sort
-    else
-      args.named.to_formulae
+  def print_info(args:)
+    args.named.to_formulae_and_casks_and_unavailable.each_with_index do |obj, i|
+      puts unless i.zero?
+
+      case obj
+      when Formula
+        info_formula(obj, args: args)
+      when Cask::Cask
+        info_cask(obj, args: args)
+      when FormulaOrCaskUnavailableError
+        ofail obj.message
+        # No formula with this name, try a missing formula lookup
+        if (reason = MissingFormula.reason(obj.name, show_info: true))
+          $stderr.puts reason
+        end
+      else
+        raise
+      end
    end
-    json = ff.map(&:to_hash)
+  end
+
+  def json_version(version)
+    version_hash = {
+      true => :default,
+      "v1" => :v1,
+      "v2" => :v2,
+    }
+
+    raise UsageError, "invalid JSON version: #{version}" unless version_hash.include?(version)
+
+    version_hash[version]
+  end
+
+  def print_json(args:)
+    raise FormulaOrCaskUnspecifiedError if !(args.all? || args.installed?) && args.no_named?
+
+    json = case json_version(args.json)
+    when :v1, :default
+      formulae = if args.all?
+        Formula.sort
+      elsif args.installed?
+        Formula.installed.sort
+      else
+        args.named.to_formulae
+      end
+
+      formulae.map(&:to_hash)
+    when :v2
+      formulae, casks = if args.all?
+        [Formula.sort, Cask::Cask.to_a.sort_by(&:full_name)]
+      elsif args.installed?
+        [Formula.installed.sort, Cask::Caskroom.casks.sort_by(&:full_name)]
+      else
+        args.named.to_formulae_to_casks
+      end
+
+      {
+        "formulae" => formulae.map(&:to_hash),
+        "casks"    => casks.map(&:to_h),
+      }
+    else
+      raise
+    end
+
    puts JSON.generate(json)
  end

@ -275,4 +324,10 @@ module Homebrew

    "#{dep.name} #{dep.option_tags.map { |o| "--#{o}" }.join(" ")}"
  end
+
+  def info_cask(cask, args:)
+    require "cask/cmd/info"
+
+    Cask::Cmd::Info.info(cask)
+  end
 end
--- a/Library/Homebrew/test/cmd/info_spec.rb
+++ b/Library/Homebrew/test/cmd/info_spec.rb
@ -18,6 +18,15 @@ describe "brew info", :integration_test do
      .and not_to_output.to_stderr
      .and be_a_success
  end
+
+  it "prints as json with the --json=v2 flag" do
+    setup_test_formula "testball"
+
+    expect { brew "info", "testball", "--json=v2" }
+      .to output(a_json_string).to_stdout
+      .and not_to_output.to_stderr
+      .and be_a_success
+  end
 end

 describe Homebrew do