gem-search 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f59b9866583c10a920326889b8a6b81e9f87d5a0
-  data.tar.gz: 8cf2b2a2de452c660297409afd505fef339b15f7
+  metadata.gz: 7e18e85e48c445d971dddeca013aa98f5f7ec0b9
+  data.tar.gz: fb23bd1dbe81f483ddceebae35af484d92ff0052
 SHA512:
-  metadata.gz: 7e9b33d495af55046bc9473b49f7e91efc7faeda3f22b16c009cb05807e7b917fcfd6296e5c071f9dc4c2576433a300cb9e9a1b4c47a15296feacc616fb97eb9
-  data.tar.gz: 4dcdacf41d66b29f6f05f36e8dc737ce5fc1ab6af7d1e57ffc657505ff13ab5340bf982c74e72324736d68a48b4588299a429ff3de1f837964815bbe4d4ec457
+  metadata.gz: d9ed2f1eaa162fa053322886f9efdb9eed66eb8352347158cbb1f6373d658e28b349cce3507668e5f4932af47fde793d5f9709022ac059341d93af765deaed1f
+  data.tar.gz: b55f56810fff31b4f613c566f5e0350f5247685e620776507781d72653651b8fc6e8d4d5982d94e1df65e6b25b3aa2f2e363e2d46351497a0a35eaef5027d706

data/.rubocop.yml

@@ -0,0 +1,17 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/FileName:
+  Exclude: ['bin/gem-search']
+
+Style/FormatString:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v0.2.0
+
+- Add a Interrupt handling [a93beb1]  
+When it detect Interrupt(Ctrl-C), it display results of searching part way through.
+
 ## v0.1.9
 
 - Show homepage url as default option [ddae051]  
@@ -11,7 +16,7 @@ variations: a/all/, n/name, v/ver/version
 
 ## v0.1.7
 
-- Remove reduncancy dots [17ae8cd]  
+- Remove redundancy dots [54c34af]  
 The request was one extra.
 
 ## v0.1.6
@@ -30,7 +35,7 @@ unsupported Ruby 1.9.0
 
 ## v0.1.3
 
-- Implement a feature that is shown a homepage url when detail ooption is selected [f89d9c2]
+- Implement a feature that is shown a homepage url when detail option is selected [f89d9c2]
 
 ## v0.1.2
 

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'rake',  :require => false
-gem 'rspec', :require => false
+gem 'rake',  require: false
+gem 'rspec', require: false

data/README.md

@@ -5,9 +5,8 @@
 
 # gem-search
 
-Now gem-search is not published as a rubygem.  
-gem-search is a command line utitlity like rubygems('gem search').  
-You can see a download total gem and sort columns.
+`gem-search` is a command line utility like 'gem search'.  
+You can see downloads total and sort columns.  
 
 ## Requirements
 

data/Rakefile

@@ -3,4 +3,4 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => [:spec]
+task default: [:spec]

data/lib/gem_search.rb

@@ -2,10 +2,10 @@ module GemSearch
   require 'mem'
   require 'slop'
 
-  class LibraryNotFound < StandardError; end
+  RUBYGEMS_URL = 'https://rubygems.org'
 
   require 'gem_search/command_builder'
   require 'gem_search/commands'
-  require 'gem_search/executor'
+  require 'gem_search/request'
   require 'gem_search/version'
 end

data/lib/gem_search/command_builder.rb

@@ -31,7 +31,7 @@ module GemSearch
           'default [a]ll',
           '[a]ll  :DL(all)  e.g.: gem-search webkit -s a',
           '[v]er  :DL(ver)  e.g.: gem-search webkit -s v',
-          '[n]ame :         e.g.: gem-search webkit -s n',
+          '[n]ame :         e.g.: gem-search webkit -s n'
         ])
         opts.string('-s', '--sort', sort_msg)
         opts.string('-b', '--browse', "Open rubygem's homepage in the system's default web browser.")

data/lib/gem_search/commands/base.rb

@@ -6,6 +6,20 @@ module GemSearch
       def initialize(options)
         @options = options
       end
+
+      private
+
+      def puts_abort(args)
+        puts args
+        abort
+      end
+
+      def unexpected_error(e)
+        puts "\nAn unexpected #{e.class} has occurred."
+        puts e.message
+        puts e.backtrace if ENV['DEBUG']
+        abort
+      end
     end
   end
 end

data/lib/gem_search/commands/browse.rb

@@ -1,16 +1,32 @@
+require 'gem_search/utils/system_util'
+
 module GemSearch
   module Commands
     class Browse < Base
+      include Utils::SystemUtil
+
+      GEM_URL = "#{RUBYGEMS_URL}/gems/%s"
+
       def call
-        executor = Executor.new
-        executor.browse(options[:browse])
+        gem_name = options[:browse]
+        result = Request.new.search_for_browse(gem_name)
+        url = extract_uri(result['homepage_uri'], gem_name)
+        puts "Opening #{url}"
+        browser_open(url)
       rescue OpenURI::HTTPError
-        puts 'No such gem.'
-        abort
+        puts_abort('No such a gem.')
       rescue => e
-        puts e.message
-        puts e.stacktrace if ENV['DEBUG']
-        abort
+        unexpected_error(e)
+      end
+
+      private
+
+      def extract_uri(homepage_uri, gem_name)
+        if homepage_uri.nil? || homepage_uri.empty?
+          GEM_URL % gem_name
+        else
+          homepage_uri
+        end
       end
     end
   end

data/lib/gem_search/commands/run.rb

@@ -1,43 +1,55 @@
+require 'gem_search/rendering'
 module GemSearch
   module Commands
     class Run < Base
+      include Mem
+      include Rendering
+
       ENABLE_SORT_OPTS = {
         'a' => 'downloads',
         'n' => 'name',
-        'v' => 'version_downloads',
+        'v' => 'version_downloads'
       }
 
       def call
-        unless valid?(options.arguments)
-          puts options
-          abort
-        end
-        executor = Executor.new
-        gem = options.arguments[0]
-        executor.search(gem, setup_opts)
-      rescue GemSearch::LibraryNotFound => e
-        puts e.message
-        abort
+        puts_abort(options) unless valid?(options.arguments)
+        gems = search_gems
+        puts_abort('We did not find results.') if gems.size.zero?
+        gems_sort!(gems)
+        render(gems, !options['no-homepage'])
       rescue => e
-        puts "An unexpected #{e.class} has occurred."
-        puts e.message
-        puts e.backtrace if ENV['DEBUG']
-        abort
+        unexpected_error(e)
       end
 
       private
 
-      def setup_opts
-        sort = options['sort'] ? ENABLE_SORT_OPTS[options['sort'][0].downcase] : nil
-        {
-          sort: sort || 'downloads',
-          has_homepage: !options['no-homepage']
-        }
-      end
-
       def valid?(arguments)
         arguments.size > 0 && arguments.none? { |arg| arg.match(/\A-/) }
       end
+
+      def search_gems
+        print 'Searching '
+        gems = Request.new.search(options.arguments[0]) do
+          print '.'
+        end
+        puts
+        gems
+      end
+
+      def gems_sort!(gems)
+        if sort_opt == 'name'
+          gems.sort! { |x, y| x[sort_opt] <=> y[sort_opt] }
+        else
+          gems.sort! { |x, y| y[sort_opt] <=> x[sort_opt] }
+        end
+      end
+
+      def sort_opt
+        sort_opt = options['sort'] ? ENABLE_SORT_OPTS[options['sort'][0].downcase] : nil
+        sort_opt = 'downloads' unless sort_opt
+        sort_opt
+      end
+      memoize :sort_opt
     end
   end
 end

data/lib/gem_search/rendering.rb

@@ -3,10 +3,6 @@ module GemSearch
     # NAME', 'DL(ver)', 'DL(all)', 'HOMEPAGE'
     DEFAULT_RULED_LINE_SIZE = [50, 8, 9, 60]
 
-    def self.included(base)
-      base.extend(self)
-    end
-
     def render(gems, has_homepage)
       @has_homepage = has_homepage
       ruled_line_size(gems)

data/lib/gem_search/request.rb

@@ -0,0 +1,50 @@
+require 'json'
+require 'open-uri'
+
+module GemSearch
+  class Request
+    SEARCH_API = "#{RUBYGEMS_URL}/api/v1/search.json?query=%s&page=%d"
+    GEM_API    = "#{RUBYGEMS_URL}/api/v1/gems/%s.json"
+
+    MAX_REQUEST_COUNT = 20
+    MAX_GEMS_PER_PAGE = 30 # It has been determined by Rubygems API
+
+    def search(query, &post_hook)
+      gems = []
+      (1..MAX_REQUEST_COUNT).each do |n|
+        post_hook.call if post_hook
+        url = SEARCH_API % [query, n]
+        results = request_ruby_gems_api(url)
+        gems += results
+        break if search_ended?(results.size)
+      end
+      gems
+    rescue Interrupt
+      gems
+    end
+
+    def search_for_browse(gem)
+      api_url = GEM_API % gem
+      request_ruby_gems_api(api_url)
+    end
+
+    private
+
+    def search_ended?(size)
+      size < MAX_GEMS_PER_PAGE || size.zero?
+    end
+
+    def request_ruby_gems_api(url)
+      option = {}
+      proxy = URI.parse(url).find_proxy
+      if proxy
+        if proxy.user && proxy.password
+          option[:proxy_http_basic_authentication] = [proxy, proxy.user, proxy.password]
+        else
+          option[:proxy] = proxy
+        end
+      end
+      JSON.parse(open(url, option).read)
+    end
+  end
+end

data/lib/gem_search/utils/system_util.rb

@@ -2,7 +2,7 @@ module GemSearch::Utils
   module SystemUtil
     # https://github.com/github/hub/blob/9c589396ae38f7b9f98319065ad491149954c152/lib/hub/context.rb#L517
     def browser_open(url)
-      cmd = osx? ? 'open' : %w[xdg-open cygstart x-www-browser firefox opera mozilla netscape].find { |comm| which comm }
+      cmd = osx? ? 'open' : %w(xdg-open cygstart x-www-browser firefox opera mozilla netscape).find { |com| which com }
       system(cmd, url)
     end
 

data/lib/gem_search/version.rb

@@ -1,3 +1,3 @@
 module GemSearch
-  VERSION = '0.1.9'
+  VERSION = '0.2.0'
 end

data/spec/commands/browse_spec.rb

@@ -5,9 +5,44 @@ RSpec.describe Commands::Browse do
     let(:query) { 'factory_girl' }
     let(:options) { { browse: query } }
 
-    context 'with browse option' do
-      it 'called Executor#browse with browse option' do
-        expect_any_instance_of(Executor).to receive(:browse).with(query).once
+    context 'when a network error occurred' do
+      before do
+        stub_request(:get, build_gems_uri(query))
+          .to_return(status: 500, body: '[]')
+      end
+      let(:query) { 'network_error_orccurred' }
+      it { expect { Commands::Browse.new(options).call }.to raise_error(Exception) }
+    end
+
+    context 'when no matching gem' do
+      before { stub_request_gems_no_result(query) }
+      let(:query) { 'no_match_gem_name' }
+      it { expect { Commands::Browse.new(options).call }.to raise_error(SystemExit) }
+    end
+
+    context 'when no homepage_uri' do
+      before do
+        http_stub = load_http_stubs("gems/#{query}.json")
+        stub_request_gems(query, http_stub)
+      end
+      let(:query) { 'git-trend_no_homepage' }
+      let(:uri) { Commands::Browse::GEM_URL % query }
+      it 'open a rubygems uri' do
+        expect_any_instance_of(Kernel).to receive(:system).with(anything, uri)
+        Commands::Browse.new(options).call
+      end
+    end
+
+    context 'when homepage_uri is existed' do
+      before do
+        http_stub = load_http_stubs("gems/#{query}.json")
+        @uri = JSON.parse(http_stub)['homepage_uri']
+        stub_request_gems(query, http_stub)
+      end
+      let(:query) { 'git-trend' }
+      let(:uri) { @uri }
+      it 'open a homepage uri' do
+        expect_any_instance_of(Kernel).to receive(:system).with(anything, uri)
         Commands::Browse.new(options).call
       end
     end

data/spec/commands/run_spec.rb

@@ -1,11 +1,24 @@
 include GemSearch
 
 RSpec.describe Commands::Run do
-  shared_examples 'sort example' do |expected_option, actual_option|
-    before { allow(options).to receive(:[]).with('sort').and_return(actual_option) }
-    it 'called Executor#search with sort option' do
-      expect_any_instance_of(Executor).to receive(:search).with(query, default_opts(sort: expected_option)).once
-      Commands::Run.new(options).call
+  shared_examples 'sort example by all' do |sort_option|
+    before { allow(options).to receive(:[]).with('sort').and_return(sort_option) }
+    it 'display rubygems sorted by DL(all)' do
+      expect { Commands::Run.new(options).call }.to output(dummy_search_result_sorted_by_all).to_stdout
+    end
+  end
+
+  shared_examples 'sort example by ver' do |sort_option|
+    before { allow(options).to receive(:[]).with('sort').and_return(sort_option) }
+    it 'display rubygems sorted by DL(ver)' do
+      expect { Commands::Run.new(options).call }.to output(dummy_search_result_sorted_by_ver).to_stdout
+    end
+  end
+
+  shared_examples 'sort example by name' do |sort_option|
+    before { allow(options).to receive(:[]).with('sort').and_return(sort_option) }
+    it 'display rubygems sorted by NAME' do
+      expect { Commands::Run.new(options).call }.to output(dummy_search_result_sorted_by_name).to_stdout
     end
   end
 
@@ -14,56 +27,156 @@ RSpec.describe Commands::Run do
       allow(options).to receive(:arguments).and_return([query])
       allow(options).to receive(:[]).with('no-homepage')
       allow(options).to receive(:[]).with('sort')
-      stub_request_search(query, 1, dummy_search_result)
-      stub_request_search_no_result_with_page(query, 2)
     end
-    let(:query) { 'factory_girl' }
     let(:options) { double('options') }
 
-    describe 'sort option' do
+    context 'when a network error occurred' do
+      before do
+        stub_request(:get, build_search_uri(query, 1))
+          .to_return(status: 500, body: '[]')
+      end
+      let(:query) { 'network_error_orccurred' }
+      it { expect { Commands::Run.new(options).call }.to raise_error(SystemExit) }
+    end
+
+    context 'when no matching gem' do
+      before { stub_request_search_no_result_with_page(query, 1) }
+      let(:query) { 'no_matching_gem_name' }
+      it { expect { Commands::Run.new(options).call }.to raise_error(SystemExit) }
+    end
+
+    describe 'with no-homepage option' do
+      before do
+        allow(options).to receive(:[]).with('no-homepage').and_return(true)
+        stub_request_search(query, 1, dummy_search_result)
+        stub_request_search_no_result_with_page(query, 2)
+      end
+      let(:query) { 'factory_girl' }
+
+      context 'with no sort option' do
+        it 'display rubygems ordering by DL(all)' do
+          res = <<-'EOS'.unindent
+            |Searching .
+            |NAME                                                DL(ver)   DL(all)
+            |-------------------------------------------------- -------- ---------
+            |factory_girl (3.6.0)                                    541   2042859
+            |factory_girl_rails (3.5.0)                            39724   1238780
+            |factory_girl_generator (0.0.3)                         8015     15547
+          EOS
+          expect { Commands::Run.new(options).call }.to output(res).to_stdout
+        end
+      end
+    end
+
+    describe 'sorting' do
+      before do
+        stub_request_search(query, 1, dummy_search_result)
+        stub_request_search_no_result_with_page(query, 2)
+      end
+      let(:query) { 'factory_girl' }
+
       describe 'sort by all' do
-        context 'without sort option' do
-          include_examples 'sort example', 'downloads', nil
+        context 'with no sort option' do
+          include_examples 'sort example by all', nil
         end
-        context 'with disalbe sort option' do
-          include_examples 'sort example', 'downloads', 'xyz'
+
+        context 'with disallowed sort option' do
+          include_examples 'sort example by all', 'xyz'
         end
+
         context 'with a' do
-          include_examples 'sort example', 'downloads', 'a'
+          include_examples 'sort example by all', 'a'
         end
+
         context 'with all' do
-          include_examples 'sort example', 'downloads', 'all'
+          include_examples 'sort example by all', 'all'
         end
+
         context 'with ALL' do
-          include_examples 'sort example', 'downloads', 'ALL'
+          include_examples 'sort example by all', 'ALL'
         end
       end
-    end
 
-    describe 'sort by name' do
-      context 'with n' do
-        include_examples 'sort example', 'name', 'n'
-      end
-      context 'with name' do
-        include_examples 'sort example', 'name', 'name'
+      describe 'sort by ver' do
+        context 'with v' do
+          include_examples 'sort example by ver', 'v'
+        end
+
+        context 'with ver' do
+          include_examples 'sort example by ver', 'ver'
+        end
+
+        context 'with VER' do
+          include_examples 'sort example by ver', 'VER'
+        end
       end
-      context 'with NAME' do
-        include_examples 'sort example', 'name', 'NAME'
+
+      describe 'sort by name' do
+        context 'with n' do
+          include_examples 'sort example by name', 'n'
+        end
+
+        context 'with name' do
+          include_examples 'sort example by name', 'name'
+        end
+
+        context 'with NAME' do
+          include_examples 'sort example by name', 'NAME'
+        end
       end
     end
 
-    describe 'sort by ver' do
-      context 'with v' do
-        include_examples 'sort example', 'version_downloads', 'v'
+    describe 'multiple page' do
+      before do
+        allow(options).to receive(:[]).with('sort').and_return('name')
+        stub_request_search(query, 1, load_http_stubs('search/cucumber-_1.json'))
+        stub_request_search(query, 2, load_http_stubs('search/cucumber-_2.json'))
+        stub_request_search(query, 3, load_http_stubs('search/cucumber-_3.json'))
+        stub_request_search_no_result_with_page(query, 4)
       end
-      context 'with ver' do
-        include_examples 'sort example', 'version_downloads', 'ver'
+      let(:query) { 'cucumber-' }
+      it 'display rubygems ordering by name' do
+        expect { Commands::Run.new(options).call }.to output(dummy_search_results_multiple_pages).to_stdout
+      end
+    end
+
+    describe 'ruled NAME line' do
+      context 'NAME size is 42' do
+        before do
+          stub_request_search(query, 1, dummy_search_result_name_size_is_42)
+          stub_request_search_no_result_with_page(query, 2)
+        end
+        let(:query) { 'size_is_42_2345678901234567890123456789012' }
+        it 'is 50 characters' do
+          # rubocop:disable Metrics/LineLength, Style/TrailingWhitespace
+          res = <<-'EOS'.unindent
+            |Searching .
+            |NAME                                                DL(ver)   DL(all) HOMEPAGE                                                    
+            |-------------------------------------------------- -------- --------- ------------------------------------------------------------
+            |size_is_42_2345678901234567890123456789012 (0.0.1)      100      1000                                                             
+          EOS
+          # rubocop:enable Metrics/LineLength, Style/TrailingWhitespace
+          expect { Commands::Run.new(options).call }.to output(res).to_stdout
+        end
       end
-      context 'with version' do
-        include_examples 'sort example', 'version_downloads', 'version'
+    end
+
+    context 'NAME size is 43' do
+      before do
+        stub_request_search(query, 1, dummy_search_result_name_size_is_43)
+        stub_request_search_no_result_with_page(query, 2)
       end
-      context 'with VER' do
-        include_examples 'sort example', 'version_downloads', 'VER'
+      let(:query) { 'size_is_43_23456789012345678901234567890123' }
+      it 'is 51 characters' do
+        # rubocop:disable Metrics/LineLength, Style/TrailingWhitespace
+        res = <<-'EOS'.unindent
+          |Searching .
+          |NAME                                                 DL(ver)   DL(all) HOMEPAGE                                                    
+          |--------------------------------------------------- -------- --------- ------------------------------------------------------------
+          |size_is_43_23456789012345678901234567890123 (0.0.2)      200      2000                                                             
+        EOS
+        # rubocop:enable Metrics/LineLength, Style/TrailingWhitespace
+        expect { Commands::Run.new(options).call }.to output(res).to_stdout
       end
     end
   end