bundler-alive 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2a89085af5b9f1ee492cdbbe0e51fc27026c90760f77ebe0e7aa219b038d423
-  data.tar.gz: 619562e866a25a255516cbaaedf1a0ccc08c741d3f00bd6c5bd86455793d9db5
+  metadata.gz: dd88b794101cf7f456811a805f287ec314d9ecf202294f5ec13e5e339db5834d
+  data.tar.gz: e0db2f2731c7dd50324900a5564365ff14abf82bc7169d30d9ad7444504dffec
 SHA512:
-  metadata.gz: 5929a845890c5b50b6bd629296f4bd3f1c457791c6938f53203f464f99ac86634122500cd2e0dc5fc4276e42ef04ba30898ad91ede8546eb2c2cdf8fc9f6ac18
-  data.tar.gz: 4845907f1e0eedab0c1746a186dc613d31f2e680b8b0f24c08aa660dbd9467840c42a240cb22ab97e9ba46594be185158ae8c8f69752f4f7150585b849e239da
+  metadata.gz: 89fec08047da08d6178bae7e2760f22139005dc33cd38201a6c7782a589ab173a7b5b72ee934bb301216fe4a5e1e5814dd69b773a9c937ab7ca2f7c7b61f0d3a
+  data.tar.gz: 0f1930be94cf0401d807ec1e63714dea3243c5bedbe226ff7cd4ff957e9d6d5f043d731f4903ca3dac35aa0403d1269cbc85e153a304894fad63848401ddec07

data/.bundler-alive.default.yml

@@ -0,0 +1,30 @@
+---
+gems:
+  coffee-script-source:
+    url: https://github.com/jashkenas/coffeescript/
+  erubis:
+    url: https://github.com/kwatch/erubis
+  ffi-compiler:
+    url: https://github.com/ffi/ffi
+  foundation-rails:
+    url: https://github.com/foundation/foundation-rails
+  guard-compat:
+    url: https://github.com/guard/guard-compat
+  spoon:
+    url: https://github.com/headius/spoon
+  shellany:
+    url: https://github.com/guard/shellany
+  vegas:
+    url: https://github.com/quirkey/vegas
+  zipruby:
+    url: https://github.com/fjg/zipruby
+  gli:
+    url: https://github.com/davetron5000/gli
+  zen_to_i:
+    url: https://github.com/yoshitsugu/zen_to_i
+  trailblazer-option:
+    url: https://github.com/trailblazer/trailblazer-option
+  fog-sakuracloud:
+    url: https://github.com/fog/fog-sakuracloud
+  ovirt-engine-sdk:
+    url: https://github.com/oVirt/ovirt-engine-sdk-ruby

data/.rspec

@@ -2,3 +2,4 @@
 --color
 --warnings
 --require spec_helper
+--backtrace

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "bundler-alive Documentation" --protected

data/Gemfile

@@ -4,20 +4,16 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "faraday"
-gem "octokit"
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.21"
-gem "thor"
-gem "toml-rb"
-
 group :development do
   gem "yard"
 end
 
 group :test do
-  gem "simplecov"
+  # Workaround for cc-test-reporter with SimpleCov 0.18.
+  # Stop upgrading SimpleCov until the following issue will be resolved.
+  # https://github.com/codeclimate/test-reporter/issues/418
+  gem "factory_bot"
+  gem "simplecov", "~> 0.10", "< 0.18"
   gem "vcr"
   gem "webmock"
 end

data/README.md

@@ -1,11 +1,13 @@
 # bundler-alive
 
-![bundler-alive](https://github.com/kyoshidajp/bundler-alive/actions/workflows/ci.yml/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/bundler-alive.svg)](https://badge.fury.io/rb/bundler-alive)
+![bundler-alive](https://github.com/kyoshidajp/bundler-alive/actions/workflows/ci.yml/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a79d53257bc5e93842f6/maintainability)](https://codeclimate.com/github/kyoshidajp/bundler-alive/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a79d53257bc5e93842f6/test_coverage)](https://codeclimate.com/github/kyoshidajp/bundler-alive/test_coverage)
 
 `bunder-alive` checks if gems in a RubyGem's `Gemfile.lock` are active.
 
-Currently only github.com is supported as a source code repository. If the source code repository is archived, then reports as not alive.
+Currently only GitHub is supported as a source code repository. If the source code repository is archived, then reports as not alive.
 
 ## Installation
 
@@ -17,10 +19,19 @@ $ gem install bunlder-alive
 
 ```
 $ bundle-alive
-Name: journey
-URL: http://github.com/rails/journey
-Status: false
+6 gems are in Gemfile.lock
+..W....
+Get all source code repository URLs of gems are done!
+.....
+
+Errors:
+    [bundle-alive] Not found in RubyGems.org.
 
+Archived gems:
+    Name: journey
+    URL: http://github.com/rails/journey
+
+Total: 6 (Archived: 1, Alive: 4, Unknown: 1)
 Not alive gems are found!
 ```
 
@@ -30,7 +41,9 @@ Default `Gemfile.lock` location is in your current directory. You can specify it
 $ bundle-alive -G /path/to/Gemfile.lock
 ```
 
-In most cases, the following error is output.
+## Exceeding rate limit
+
+In some cases, the following error may be output.
 
 ```
 Too many requested! Retry later.
@@ -38,7 +51,34 @@ Too many requested! Retry later.
 
 In this case, setting [GitHub Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) as `BUNDLER_ALIVE_GITHUB_TOKEN` environment variable may alleviate the error.
 
-If you run again, it will resume.
+## Ignore gems
+
+You can ignore certain gems.
+
+```
+$ bundle-alive -i journey rubocop-junit-formatter
+```
+
+## Specifying repository URL
+
+In some cases, some gems cannot find the URL of their source code repositories. For this case, you can specify a mapping between the gem and its URL.
+
+Put `.bundler-alive.yml` in your current directory. The following code is the sample.
+
+```yaml
+---
+gems:
+  coffee-script-source:
+    url: https://github.com/jashkenas/coffeescript/
+```
+
+You can also specify the file path.
+
+```
+$ bundle-alive -c /path/to/.bundler-alive.yml
+```
+
+[.bundler-alive.default.yml](https://github.com/kyoshidajp/bundler-alive/blob/main/.bundler-alive.default.yml) may also be helpful. Considering that having these mappings obtained automatically in the future.
 
 ## Contributing
 

data/bundler-alive.gemspec

@@ -1,29 +1,54 @@
 # frozen_string_literal: true
 
 require_relative "lib/bundler/alive/version"
+require "yaml"
 
-Gem::Specification.new do |spec|
-  spec.name = "bundler-alive"
-  spec.version = Bundler::Alive::VERSION
-  spec.authors = ["Katsuhiko YOSHIDA"]
-  spec.email = ["claddvd@gmail.com"]
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file("gemspec.yml")
+  gem.name = gemspec.fetch("name")
+  gem.version = Bundler::Alive::VERSION
+  gem.authors = gemspec.fetch("authors")
+  gem.email = gemspec.fetch("email")
 
-  spec.summary = "Are your gems alive?"
-  spec.description = "bundler-alive reports gems are archived or not."
-  spec.homepage = "https://github.com/kyoshidajp/bundler-alive"
-  spec.required_ruby_version = ">= 2.6.0"
+  gem.summary = gemspec.fetch("summary")
+  gem.description = gemspec.fetch("description")
+  gem.homepage = gemspec.fetch("homepage")
+  gem.required_ruby_version = gemspec.fetch("required_ruby_version")
 
-  spec.metadata["homepage_uri"] = "https://github.com/kyoshidajp/bundler-alive"
-  spec.metadata["source_code_uri"] = "https://github.com/kyoshidajp/bundler-alive"
-  spec.metadata["changelog_uri"] = "https://github.com/kyoshidajp/bundler-alive"
+  metadata = gemspec.fetch("metadata")
+  gem.metadata["homepage_uri"] = metadata["homepage_uri"]
+  gem.metadata["source_code_uri"] = metadata["source_code_uri"]
+  gem.metadata["changelog_uri"] = metadata["changelog_uri"]
+  gem.metadata["rubygems_mfa_required"] = "true"
 
-  spec.files = Dir.chdir(__dir__) do
+  gem.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
       (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir = "bin"
-  spec.executables = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.metadata["rubygems_mfa_required"] = "true"
+  gem.bindir = gemspec.fetch("bindir")
+  gem.executables = gem.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  gem.require_paths = gemspec.fetch("require_paths")
+
+  split = lambda do |string|
+    string.nil? ? "" : string.split(/,\s*/)
+  end
+
+  gemspec["dependencies"].each do |name, versions|
+    if versions.nil?
+      gem.add_dependency(name)
+    else
+      gem.add_dependency(name, split[versions])
+    end
+  end
+
+  gemspec["development_dependencies"].each do |name, versions|
+    if versions.nil?
+      gem.add_development_dependency(name)
+    else
+      gem.add_development_dependency(name, split[versions])
+    end
+  end
 end
+# rubocop:enable Metrics/BlockLength

data/gemspec.yml

@@ -0,0 +1,35 @@
+name: bundler-alive
+summary: Are your gems alive?
+description: bundler-alive reports gems are archived or not.
+authors: Katsuhiko YOSHIDA
+email: claddvd@gmail.com
+homepage: https://github.com/kyoshidajp/bundler-alive
+
+metadata:
+  homepage_uri: https://github.com/kyoshidajp/bundler-alive
+  source_code_uri: https://github.com/kyoshidajp/bundler-alive
+  changelog_uri: https://github.com/kyoshidajp/bundler-alive
+
+required_ruby_version: ">= 2.6.0"
+bindir: bin
+require_paths: lib
+
+dependencies:
+  faraday:
+  octokit:
+  rake:
+  thor:
+
+development_dependencies:
+  rspec:
+  rubocop:
+  yard:
+
+  # Workaround for cc-test-reporter with SimpleCov 0.18.
+  # Stop upgrading SimpleCov until the following issue will be resolved.
+  # https://github.com/codeclimate/test-reporter/issues/418
+  simplecov: "~> 0.10, < 0.18"
+
+  factory_bot:
+  vcr:
+  webmock:

data/lib/bundler/alive/cli.rb

@@ -2,6 +2,7 @@
 
 require "bundler/alive"
 require "bundler/alive/doctor"
+require "bundler/alive/reportable"
 
 require "thor"
 
@@ -15,21 +16,18 @@ module Bundler
       map "--version" => :version
 
       desc "check [DIR]", "Checks the Gemfile.lock"
+      method_option :ignore, type: :array, aliases: "-i", default: []
       method_option :gemfile_lock, type: :string, aliases: "-G",
                                    default: "Gemfile.lock"
+      method_option :config, type: :string, aliases: "-c", default: ".bundler-alive.yml"
 
       def check(_dir = Dir.pwd)
-        doctor = check_by_doctor
+        extend Reportable
+        report = check_by_doctor
+        print_report(report)
 
-        if doctor.rate_limit_exceeded_error
-          puts "Too many requested! Retry later."
-          exit 1
-        end
-
-        exit 0 if doctor.all_alive
-
-        puts "Not alive gems are found!"
-        exit 1
+        exit_status = report.result.all_alive? ? 0 : 1
+        exit exit_status
       end
 
       desc "version", "Prints the bundler-alive version"
@@ -41,15 +39,12 @@ module Bundler
 
       def check_by_doctor
         doctor = begin
-          Doctor.new(options[:gemfile_lock])
+          Doctor.new(options[:gemfile_lock], options[:config], options[:ignore])
         rescue Bundler::GemfileLockNotFound
           exit 1
         end
 
         doctor.diagnose
-        doctor.report
-        doctor.save_as_file
-        doctor
       end
     end
   end

data/lib/bundler/alive/client/gems_api_client.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+module Bundler
+  module Alive
+    module Client
+      #
+      # RubyGems.org API Client
+      #
+      # @see https://guides.rubygems.org/rubygems-org-api/
+      #
+      class GemsApiClient
+        #
+        # Not found in rubygems.org error
+        #
+        class NotFound < StandardError
+        end
+
+        #
+        # A new instance of `GemApiClient`
+        #
+        # @param [String] config_path
+        #
+        # @return [GemApiClient]
+        #
+        def initialize(config_path = nil)
+          @error_messages = []
+          @config_gems = get_config_gems(config_path)
+
+          freeze
+        end
+
+        #
+        # Gets gems from RubyGems.org
+        #
+        # @param [Array<String>] gem_names
+        #
+        # @return [Client::GemsApiResponse]
+        #
+        def gems_api_response(gem_names)
+          urls = service_with_urls(gem_names)
+          $stdout.puts <<~MESSAGE
+
+            Get all source code repository URLs of gems are done!
+          MESSAGE
+          Client::GemsApiResponse.new(
+            service_with_urls: urls,
+            error_messages: error_messages
+          )
+        end
+
+        private
+
+        attr_accessor :error_messages, :config_gems
+
+        def api_url(gem_name)
+          "https://rubygems.org/api/v1/gems/#{gem_name}.json"
+        end
+
+        def connection
+          Faraday.new do |connection|
+            connection.adapter :net_http
+          end
+        end
+
+        def get_config_gems(path)
+          return {} if path.nil? || !File.exist?(path)
+
+          config = YAML.load_file(path)
+          config["gems"]
+        end
+
+        def service_with_urls(gem_names)
+          urls = get_repository_urls(gem_names)
+          urls.each_with_object({}) do |url, hash|
+            service_name = url.service_name
+            hash[service_name] = Array(hash[service_name]) << url
+          end
+        end
+
+        #
+        # Returns repository url
+        #
+        # @param [String] gem_name
+        #
+        # @return [SourceCodeRepositoryUrl]
+        #
+        def get_repository_url(gem_name)
+          url_from_config = get_repository_url_from_config(gem_name)
+          return url_from_config unless url_from_config.nil?
+
+          url = api_url(gem_name)
+          response = connection.get(url)
+
+          raise NotFound, "[#{gem_name}] Not found in RubyGems.org." unless response.success?
+
+          body = JSON.parse(response.body)
+          raw_url = source_code_url(body: body, gem_name: gem_name)
+          SourceCodeRepositoryUrl.new(raw_url, gem_name)
+        end
+
+        def get_repository_url_from_config(gem_name)
+          return nil if config_gems.nil?
+          return nil unless config_gems.key?(gem_name)
+
+          gem = config_gems[gem_name]
+          SourceCodeRepositoryUrl.new(gem["url"], gem_name)
+        end
+
+        def source_code_url(body:, gem_name:)
+          url = body["source_code_uri"]
+          return url if SourceCodeRepositoryUrl.support_url?(url)
+
+          url = body["homepage_uri"]
+          return url if SourceCodeRepositoryUrl.support_url?(url)
+
+          message = "[#{gem_name}] Source code repository is not found in RubyGems.org,"\
+                    " or not supported. URL: https://rubygems.org/gems/#{gem_name}"
+          raise NotFound, message
+        end
+
+        def get_repository_urls(gem_names)
+          result = gem_names.map do |gem_name|
+            $stdout.write "."
+            get_repository_url(gem_name)
+          rescue StandardError => e
+            $stdout.write "W"
+            error_messages << e.message
+          end
+
+          result.find_all { |obj| obj.instance_of?(Alive::SourceCodeRepositoryUrl) }
+        end
+      end
+    end
+  end
+end

data/lib/bundler/alive/client/gems_api_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Bundler
+  module Alive
+    module Client
+      #
+      # Represents API Response of RubyGems.org
+      #
+      class GemsApiResponse
+        attr_reader :service_with_urls, :error_messages
+
+        #
+        # Creates a new StatusResult instance
+        #
+        # @param [StatusCollection|nil] :collection
+        # @param [Array] :error_messages
+        #
+        # @return [GemsApiResponse]
+        #
+        def initialize(service_with_urls:, error_messages:)
+          @service_with_urls = service_with_urls
+          @error_messages = error_messages
+
+          freeze
+        end
+      end
+    end
+  end
+end

data/lib/bundler/alive/client/git_hub_api.rb

@@ -9,9 +9,44 @@ module Bundler
       #
       # API Client for GitHub API
       #
+      # @see https://docs.github.com/en/rest/search#search-repositories
+      #
       module GitHubApi
+        # Environment variable name of GitHub Access Token
         ACCESS_TOKEN_ENV_NAME = "BUNDLER_ALIVE_GITHUB_TOKEN"
 
+        # Separator of query condition
+        QUERY_CONDITION_SEPARATOR = " "
+
+        # Number of attempts to request after too many requests
+        RETRIES_ON_TOO_MANY_REQUESTS = 3
+
+        #
+        # Interval second when retrying request
+        #
+        # @note
+        #   This is an empirical value and should
+        #   refer to response of Rate Limit API
+        #
+        # @see
+        #   https://docs.github.com/en/rest/overview/resources-in-the-rest-api#checking-your-rate-limit-status
+        RETRY_INTERVAL_SEC_ON_TOO_MANY_REQUESTS = 120
+
+        #
+        # Max number of conditional operator at once
+        #
+        # @see https://docs.github.com/en/rest/search#limitations-on-query-length
+        QUERY_MAX_OPERATORS_AT_ONCE = 6
+
+        private_constant :QUERY_MAX_OPERATORS_AT_ONCE
+
+        def self.extended(base)
+          base.instance_eval do
+            @rate_limit_exceeded = false
+            @retries_on_too_many_requests = 0
+          end
+        end
+
         #
         # Creates a GitHub client
         #
@@ -22,39 +57,112 @@ module Bundler
         end
 
         #
-        # Returns repository URL is archived?
+        # Query repository statuses
+        #
+        # @param [Array<RepositoryUrl>] :urls
+        #
+        # @return [StatusResult]
+        #
+        # rubocop:disable Metrics/MethodLength
+        def query(urls:)
+          collection = StatusCollection.new
+          name_with_archived = get_name_with_statuses(urls)
+          urls.each do |url|
+            $stdout.write "."
+
+            gem_name = url.gem_name
+            alive = !name_with_archived[gem_name]
+            status = Status.new(name: gem_name, repository_url: url, alive: alive, checked_at: Time.now)
+            collection = collection.add(gem_name, status)
+          end
+
+          StatusResult.new(collection: collection, error_messages: @error_messages,
+                           rate_limit_exceeded: @rate_limit_exceeded)
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        private
+
+        #
+        # Search status of repositories
+        #
+        # @param [Array<RepositoryUrl>] urls
+        #
+        # @return [Hash<String, Boolean>]
+        #   gem name with archived or not
+        #
+        # rubocop:disable Metrics/MethodLength
+        def get_name_with_statuses(urls)
+          raise ArgumentError unless urls.instance_of?(Array)
+
+          name_with_status = {}
+          urls.each_slice(QUERY_MAX_OPERATORS_AT_ONCE) do |sliced_urls|
+            q = search_query(sliced_urls)
+            repositories = search_repositories_with_retry(q)
+            next if repositories.nil?
+
+            repositories.each do |repository|
+              name = repository["name"]
+              name_with_status[name] = repository["archived"]
+            end
+          end
+          name_with_status
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        #
+        # Search query of repositories
         #
-        # @param [SourceCodeRepositoryUrl] repository_url
+        # @param [Array<RepositoryUrl>] urls
         #
-        # @raise [ArgumentError]
-        #   when repository_uri is not `SourceCodeRepositoryUrl`
+        # @return [String]
+        #
+        def search_query(urls)
+          urls.map do |url|
+            "repo:#{slug(url.url)}"
+          end.join(QUERY_CONDITION_SEPARATOR)
+        end
+
+        #
+        # Search repositories
+        #
+        # @param [String] query
         #
         # @raise [Octokit::TooManyRequests]
         #   when too many requested to GitHub.com
-        #
         # @raise [SourceCodeClient::SearchRepositoryError]
         #   when Error without `Octokit::TooManyRequests`
         #
-        # @return [Boolean]
+        # @return [Array<Sawyer::Resource>|nil]
         #
-        # rubocop:disable Metrics/MethodLength
-        def archived?(repository_url)
-          unless repository_url.instance_of?(SourceCodeRepositoryUrl)
-            raise ArgumentError, "UnSupported url: #{repository_url}"
+        def search_repositories(query)
+          result = @client.search_repositories(query)
+          result[:items]
+        rescue Octokit::TooManyRequests => e
+          raise e
+        rescue StandardError => e
+          @error_messages << e.message
+          []
+        end
+
+        def search_repositories_with_retry(query)
+          search_repositories(query)
+        rescue Octokit::TooManyRequests
+          if @retries_on_too_many_requests < RETRIES_ON_TOO_MANY_REQUESTS
+            @retries_on_too_many_requests += 1
+            sleep_with_message
+            retry
           end
 
-          query = "repo:#{slug(repository_url.url)}"
+          @rate_limit_exceeded = true
+          []
+        end
 
-          begin
-            result = @client.search_repositories(query)
-            result[:items][0][:archived]
-          rescue Octokit::TooManyRequests => e
-            raise SourceCodeClient::RateLimitExceededError, e.message
-          rescue StandardError => e
-            raise SourceCodeClient::SearchRepositoryError, e.message
-          end
+        def sleep_with_message
+          puts "Too many requested to GitHub. Sleep #{RETRY_INTERVAL_SEC_ON_TOO_MANY_REQUESTS} sec."
+          sleep RETRY_INTERVAL_SEC_ON_TOO_MANY_REQUESTS
+          puts "Retry request (#{@retries_on_too_many_requests}/#{RETRIES_ON_TOO_MANY_REQUESTS})"
         end
-        # rubocop:enable Metrics/MethodLength
 
         #
         # Returns slug of repository URL