DRAFT: Adds web command

Manifest.txt

@@ -305,6 +305,7 @@ lib/rubygems/commands/stale_command.rb
 lib/rubygems/commands/uninstall_command.rb
 lib/rubygems/commands/unpack_command.rb
 lib/rubygems/commands/update_command.rb
+lib/rubygems/commands/web_command.rb
 lib/rubygems/commands/which_command.rb
 lib/rubygems/commands/yank_command.rb
 lib/rubygems/compatibility.rb
@@ -320,6 +321,7 @@ lib/rubygems/deprecate.rb
 lib/rubygems/doctor.rb
 lib/rubygems/errors.rb
 lib/rubygems/exceptions.rb
+lib/rubygems/executor.rb
 lib/rubygems/ext.rb
 lib/rubygems/ext/build_error.rb
 lib/rubygems/ext/builder.rb
@@ -544,6 +546,7 @@ test/rubygems/test_gem_commands_stale_command.rb
 test/rubygems/test_gem_commands_uninstall_command.rb
 test/rubygems/test_gem_commands_unpack_command.rb
 test/rubygems/test_gem_commands_update_command.rb
+test/rubygems/test_gem_commands_web_command.rb
 test/rubygems/test_gem_commands_which_command.rb
 test/rubygems/test_gem_commands_yank_command.rb
 test/rubygems/test_gem_config_file.rb

lib/rubygems/command_manager.rb

@@ -69,6 +69,7 @@ class Gem::CommandManager
     :uninstall,
     :unpack,
     :update,
+    :web,
     :which,
     :yank,
   ].freeze

lib/rubygems/commands/web_command.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'rubygems/command'
+require 'rubygems/executor'
+
+class Gem::Commands::WebCommand < Gem::Command
+
+  def initialize
+    super "web", "Open the gem's homepage",
+      :command => nil,
+      :version => Gem::Requirement.default,
+      :latest => false
+
+    add_option("-c", "--sourcecode", "Open source code for the gem") do |v|
+      options[:sourcecode] = v
+    end
+    add_option("-d", "--doc", "Open documentation for the gem") do |v|
+      options[:doc] = v
+    end
+    add_option("-r", "--rubygems", "Open the rubygems.org page for the gem") do |v|
+      options[:rubygems] = v
+    end
+
+    @executor = Gem::Web::Executor.new
+  end
+
+  def arguments
+    "GEMNAME       gem to open the webpage for"
+  end
+
+  def usage
+    "#{program_name} GEMNAME"
+  end
+
+  def execute
+    @executor.open_page(get_one_optional_argument, options)
+  end
+
+end

lib/rubygems/executor.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+require 'open-uri'
+require 'json'
+
+module Gem
+  module Web
+    class Executor
+
+      def open_page(gem, options)
+        begin
+          spec = Gem::Specification.find_by_name(gem)
+        rescue Gem::MissingSpecError => e
+          spec = fetch_remote_spec(gem)
+
+          if spec.nil?
+            puts "Could not find '#{gem}' in rubygems.org."
+            return
+          end
+        end
+
+        if options[:sourcecode]
+          get_info_from_metadata(spec, "source_code_uri")
+        elsif options[:doc]
+          get_info_from_metadata(spec, "documentation_uri")
+        elsif options[:rubygems]
+          open_rubygems(gem)
+        else
+          open_browser(spec.homepage)
+        end
+      end
+
+      def fetch_remote_spec(gem)
+        dep = Gem::Dependency.new(gem)
+        found, _ = Gem::SpecFetcher.fetcher.spec_for_dependency(dep)
+        spec_tuple = found.first
+
+        spec_tuple.first unless spec_tuple.nil? || spec_tuple.empty?
+      end
+
+      def get_info_from_metadata(spec, info)
+        uri = spec.metadata[info]&.strip
+
+        if uri.nil? || uri.empty?
+          puts "Gem '#{spec.name}' does not specify #{info}."
+        else
+          open_browser(uri)
+        end
+      end
+
+      def open_rubygems(gem)
+        open_browser("https://rubygems.org/gems/#{gem}")
+      end
+
+      def open_browser(uri)
+        browser = ENV["BROWSER"]
+        if browser.nil? || browser.empty?
+          puts uri
+        else
+          system(browser, uri)
+        end
+      end
+
+    end
+  end
+end

test/rubygems/test_gem_commands_web_command.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+require 'rubygems/test_case'
+require 'rubygems/executor'
+require 'rubygems/commands/web_command'
+
+class TestGemCommandsWebCommand < Gem::TestCase
+
+  def setup
+    super
+    @cmd = Gem::Commands::WebCommand.new
+    @mock = MiniTest::Mock.new
+    ENV['BROWSER'] = nil
+    @gem = "bestgemever"
+  end
+
+  def test_default_option_should_be_homepage
+    @mock.expect(:homepage, "https://bestgemever.example.io")
+    Gem::Specification.stub :find_by_name, @mock do
+      assert_output("https://bestgemever.example.io\n") do
+        @cmd.handle_options [@gem]
+        @cmd.execute
+      end
+    end
+    @mock.verify
+  end
+
+  def test_open_the_documentation
+    metadata = {
+      "documentation_uri" => "https://www.example.info/gems/bestgemever/0.0.1",
+    }
+    @mock.expect(:metadata, metadata)
+
+    Gem::Specification.stub :find_by_name, @mock do
+      assert_output("https://www.example.info/gems/bestgemever/0.0.1\n") do
+        @cmd.handle_options ["-d", @gem]
+        @cmd.execute
+      end
+    end
+    @mock.verify
+  end
+
+  def test_open_the_source_code
+    metadata = {
+      "source_code_uri" => "https://example.com/user/bestgemever"
+    }
+    @mock.expect(:metadata, metadata)
+
+    Gem::Specification.stub :find_by_name, @mock do
+      assert_output("https://example.com/user/bestgemever\n") do
+        @cmd.handle_options ["-c", @gem]
+        @cmd.execute
+      end
+    end
+    @mock.verify
+  end
+
+  def test_open_when_info_is_missing
+    [["-c", "source_code_uri"], ["-d", "documentation_uri"]].each do |test_case|
+      option = test_case[0]
+      info = test_case[1]
+      @mock.expect(:metadata, {})
+      @mock.expect(:name, @gem)
+
+      Gem::Specification.stub :find_by_name, @mock do
+        assert_output("Gem '#{@gem}' does not specify #{info}.\n") do
+          @cmd.handle_options [option, @gem]
+          @cmd.execute
+        end
+      end
+      @mock.verify
+    end
+  end
+
+  def test_open_rubygems
+    Gem::Specification.stub :find_by_name, @mock do
+      assert_output("https://rubygems.org/gems/#{@gem}\n") do
+        @cmd.handle_options ["-r", @gem]
+        @cmd.execute
+      end
+    end
+    @mock.verify
+  end
+
+  def test_search_unexisting_gem
+    gem = "this-is-an-unexisting-gem"
+    assert_output(/Could not find '#{gem}'/) do
+      @cmd.handle_options [gem]
+      @cmd.execute
+    end
+  end
+
+  def test_search_online_if_gem_is_not_installed
+    gem = "this-is-an-unexisting-gem"
+    exception = proc { raise Gem::MissingSpecError.new("error", nil) }
+
+    Gem::Specification.stub :find_by_name, exception do
+      spec = util_spec(@gem)
+      found_spec = [[[spec, "sources"]], []]
+
+      Gem::SpecFetcher.fetcher.stub :spec_for_dependency, found_spec do
+        assert_output(/#{spec.homepage}/) do
+          @cmd.handle_options [gem]
+          @cmd.execute
+        end
+      end
+    end
+  end
+
+  def test_search_online_for_inexisting_gem
+    gem = "this-is-an-unexisting-gem"
+    exception = proc { raise Gem::MissingSpecError.new("error", nil) }
+
+    Gem::Specification.stub :find_by_name, exception, [gem] do
+      not_found = [[], []]
+      Gem::SpecFetcher.fetcher.stub :spec_for_dependency, not_found do
+        assert_output(/Could not find '#{gem}' in rubygems.org/) do
+          @cmd.handle_options [gem]
+          @cmd.execute
+        end
+      end
+    end
+  end
+
+  def test_fetch_remote_spec
+    found_spec = [[[util_spec(@gem), "sources"]], []]
+
+    Gem::SpecFetcher.fetcher.stub :spec_for_dependency, found_spec do
+      spec = Gem::Web::Executor.new.fetch_remote_spec @gem
+      assert_equal @gem, spec.name
+    end
+  end
+
+  def test_fetch_unexisting_remote_spec
+    gem = "this-is-an-unexisting-gem"
+    not_found = [[], []]
+
+    Gem::SpecFetcher.fetcher.stub :spec_for_dependency, not_found do
+      assert_nil Gem::Web::Executor.new.fetch_remote_spec gem
+    end
+  end
+
+  def test_open_browser_if_env_variable_is_set
+    open_browser_cmd = "open"
+    uri = "http://github.com/rails"
+
+    env_mock = MiniTest::Mock.new
+    env_mock.expect(:call, open_browser_cmd, ['BROWSER'])
+
+    browser_mock = MiniTest::Mock.new
+    browser_mock.expect(:call, true, [open_browser_cmd, uri])
+
+    executor = Gem::Web::Executor.new
+    ENV.stub :[], env_mock do
+      executor.stub :system, browser_mock do
+        executor.open_browser(uri)
+      end
+    end
+
+    browser_mock.verify
+    env_mock.verify
+  end
+
+end