bundler-alive 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29049e60565e16c7e828304b8bd98f6a3b16b7f0afdcc5d9043349896f31acf9
-  data.tar.gz: 969ce8eb67b823d8dad051addc685d86db571c4ac8fdbba926f54505e8f6b61a
+  metadata.gz: dd88b794101cf7f456811a805f287ec314d9ecf202294f5ec13e5e339db5834d
+  data.tar.gz: e0db2f2731c7dd50324900a5564365ff14abf82bc7169d30d9ad7444504dffec
 SHA512:
-  metadata.gz: 3fad0ab06a408d151591063307eb460f09995086c5f63d7b4f5f5fbcc94aef889b5495940837b1f46b0719c235a3fa4e1de5a994aac38f489ff27a033c0d0f4e
-  data.tar.gz: d3442abf4e2e0f454a0a9fa6980e299c04963f09b76df7f17912fddc12a50ed06ad53a8962ba45b2e3c00f8165fc53fccbde5181a4c6fb4cee5f7b0719cfdcac
+  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/.yardopts

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

data/README.md

@@ -7,7 +7,7 @@
 
 `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
 
@@ -23,13 +23,15 @@ $ bundle-alive
 ..W....
 Get all source code repository URLs of gems are done!
 .....
-Name: journey
-URL: http://github.com/rails/journey
-Status: false
 
-Gem: bundle-alive is not found in RubyGems.org.
+Errors:
+    [bundle-alive] Not found in RubyGems.org.
 
-Total: 6 (Dead: 1, Alive: 4, Unknown: 1)
+Archived gems:
+    Name: journey
+    URL: http://github.com/rails/journey
+
+Total: 6 (Archived: 1, Alive: 4, Unknown: 1)
 Not alive gems are found!
 ```
 
@@ -39,7 +41,9 @@ Default `Gemfile.lock` location is in your current directory. You can specify it
 $ bundle-alive -G /path/to/Gemfile.lock
 ```
 
-In some cases, the following error is output.
+## Exceeding rate limit
+
+In some cases, the following error may be output.
 
 ```
 Too many requested! Retry later.
@@ -47,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/gemspec.yml

@@ -19,7 +19,6 @@ dependencies:
   octokit:
   rake:
   thor:
-  toml-rb:
 
 development_dependencies:
   rspec:

data/lib/bundler/alive/cli.rb

@@ -16,15 +16,14 @@ 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 :result, type: :string, aliases: "-r",
-                             default: "result.toml"
+      method_option :config, type: :string, aliases: "-c", default: ".bundler-alive.yml"
 
       def check(_dir = Dir.pwd)
         extend Reportable
         report = check_by_doctor
-        report.save_as_file(options[:result])
         print_report(report)
 
         exit_status = report.result.all_alive? ? 0 : 1
@@ -40,7 +39,7 @@ module Bundler
 
       def check_by_doctor
         doctor = begin
-          Doctor.new(options[:gemfile_lock], options[:result])
+          Doctor.new(options[:gemfile_lock], options[:config], options[:ignore])
         rescue Bundler::GemfileLockNotFound
           exit 1
         end

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

@@ -18,8 +18,18 @@ module Bundler
         class NotFound < StandardError
         end
 
-        def initialize
+        #
+        # 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
 
         #
@@ -29,8 +39,8 @@ module Bundler
         #
         # @return [Client::GemsApiResponse]
         #
-        def gems_api_response(gem_names, &block)
-          urls = service_with_urls(gem_names, &block)
+        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!
@@ -43,7 +53,7 @@ module Bundler
 
         private
 
-        attr_accessor :error_messages
+        attr_accessor :error_messages, :config_gems
 
         def api_url(gem_name)
           "https://rubygems.org/api/v1/gems/#{gem_name}.json"
@@ -55,8 +65,15 @@ module Bundler
           end
         end
 
-        def service_with_urls(gem_names, &block)
-          urls = get_repository_urls(gem_names, &block)
+        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
@@ -71,16 +88,27 @@ module Bundler
         # @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: #{gem_name} is not found in RubyGems.org." unless response.success?
+          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)
@@ -88,12 +116,14 @@ module Bundler
           url = body["homepage_uri"]
           return url if SourceCodeRepositoryUrl.support_url?(url)
 
-          raise NotFound, "[#{gem_name}] source code repository is not found in RubyGems.org."
+          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|
-            yield if block_given?
+            $stdout.write "."
             get_repository_url(gem_name)
           rescue StandardError => e
             $stdout.write "W"

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

@@ -21,7 +21,15 @@ module Bundler
         # 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
 
         #
@@ -60,7 +68,7 @@ module Bundler
           collection = StatusCollection.new
           name_with_archived = get_name_with_statuses(urls)
           urls.each do |url|
-            yield if block_given?
+            $stdout.write "."
 
             gem_name = url.gem_name
             alive = !name_with_archived[gem_name]
@@ -151,7 +159,7 @@ module Bundler
         end
 
         def sleep_with_message
-          puts "Too many requested. Sleep #{RETRY_INTERVAL_SEC_ON_TOO_MANY_REQUESTS} sec."
+          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

data/lib/bundler/alive/doctor.rb

@@ -2,32 +2,31 @@
 
 require "bundler"
 require "octokit"
-require "toml-rb"
 
 module Bundler
   module Alive
     #
-    # Diagnoses a `Gemfile.lock` with a TOML file
+    # Diagnoses a `Gemfile.lock`
     #
     class Doctor
       #
       # A new instance of Doctor
       #
       # @param [String] lock_file lock file of gem
-      # @param [String] result_file file of result
+      # @param [String] config_file config file
+      # @param [Array<String>] ignore_gems ignore gems
       #
-      def initialize(lock_file, result_file)
+      def initialize(lock_file, config_file, ignore_gems)
         @lock_file = lock_file
-        @result_file = result_file
-        @gem_client = Client::GemsApiClient.new
+        @gem_client = Client::GemsApiClient.new(config_file)
+        @ignore_gems = ignore_gems
         @result = nil
         @rate_limit_exceeded = false
-        @announcer = Announcer.new
         @error_messages = []
       end
 
       #
-      # Diagnoses gems in lock file of gem
+      # Diagnoses gems in Gemfile.lock
       #
       # @raise [Client::SourceCodeClient::RateLimitExceededError]
       #   When exceeded access rate limit
@@ -38,41 +37,27 @@ module Bundler
       # @return [Report]
       #
       def diagnose
-        $stdout.puts "#{collection_from_gemfile.total_size} gems are in Gemfile.lock"
+        message = "#{collection_from_gemfile.total_size + ignore_gems.size} gems are in Gemfile.lock"
+        message = "#{message} (#{ignore_gems.size} gems are ignored)" if ignore_gems.size.positive?
+        $stdout.puts message
+
         result = _diagnose
         Report.new(result)
       end
 
       private
 
-      attr_reader :lock_file, :result_file, :gem_client, :announcer,
+      attr_reader :lock_file, :gem_client, :ignore_gems,
                   :result, :error_messages, :rate_limit_exceeded
 
-      #
-      # @return [Array<String>]
-      #
-      def no_need_to_get_gems
-        return [] unless File.exist?(result_file)
-
-        toml_hash = TomlRB.load_file(result_file)
-        toml_hash.each_with_object([]) do |(gem_name, v), array|
-          alive = v["alive"]
-          array << gem_name unless alive
-        end
-      end
-
       def diagnose_by_service(service, urls)
         client = Client::SourceCodeClient.new(service_name: service)
-        client.query(urls: urls) do
-          announcer.announce
-        end
+        client.query(urls: urls)
       end
 
+      # @return [StatusResult]
       def result_by_search(collection)
-        gems_api_response = gem_client.gems_api_response(collection.names) do
-          announcer.announce
-        end
-
+        gems_api_response = gem_client.gems_api_response(collection.names)
         service_with_urls = gems_api_response.service_with_urls
         error_messages.concat(gems_api_response.error_messages)
 
@@ -83,19 +68,12 @@ module Bundler
         result
       end
 
-      def fetch_target_collection(base_collection, gem_names)
-        collection = StatusCollection.new
-        base_collection.each do |name, status|
-          next if gem_names.include?(name)
-
-          collection = collection.add(name, status)
-        end
-        collection
-      end
-
+      # @return [StatusCollection]
       def collection_from_gemfile
         gems_from_lockfile.each_with_object(StatusCollection.new) do |gem, collection|
           gem_name = gem.name
+          next if ignore_gems.include?(gem_name)
+
           status = Status.new(name: gem_name,
                               repository_url: nil,
                               alive: nil,
@@ -104,14 +82,13 @@ module Bundler
         end
       end
 
+      # @return [StatusResult]
       def _diagnose
-        collection = fetch_target_collection(collection_from_gemfile, no_need_to_get_gems)
+        collection = collection_from_gemfile
         result = result_by_search(collection)
-        collection_from_toml_file = StatusCollection.new_from_toml_file(result_file)
-        new_collection = collection_from_gemfile.merge(collection_from_toml_file)
-                                                .merge(result.collection)
-
+        new_collection = collection.merge(result.collection)
         messages = error_messages.concat(result.error_messages)
+
         StatusResult.new(collection: new_collection,
                          error_messages: messages,
                          rate_limit_exceeded: result.rate_limit_exceeded)

data/lib/bundler/alive/report.rb

@@ -20,16 +20,6 @@ module Bundler
 
         freeze
       end
-
-      #
-      # Save result to file
-      #
-      # @param [String] file_path
-      #
-      def save_as_file(file_path)
-        body = TomlRB.dump(result.to_h)
-        File.write(file_path, body)
-      end
     end
   end
 end

data/lib/bundler/alive/reportable.rb

@@ -21,11 +21,8 @@ module Bundler
           error_messages = report.error_messages
           print_error(error_messages)
 
-          gems = result.need_to_report_gems
-          $stdout.puts if gems.size.positive?
-          gems.each do |_name, gem|
-            $stdout.puts gem.report
-          end
+          gems = result.archived_gems
+          print_archived_gems(gems) if gems.size.positive?
 
           print_summary(result)
           print_message(result, report.rate_limit_exceeded)
@@ -33,18 +30,33 @@ module Bundler
 
         private
 
+        # soo messy
+        def print_archived_gems(gems)
+          $stdout.puts
+          $stdout.puts "Archived gems:"
+          archived_gems = gems.map do |_name, gem|
+            gem.report.split("\n").each_with_object([]) do |line, gem_str|
+              gem_str << "    #{line}"
+            end.join("\n")
+          end
+          $stdout.puts archived_gems.join("\n\n")
+        end
+
         def print_error(error_messages)
-          return if error_messages.nil?
+          return if error_messages.empty?
 
           $stdout.puts <<~ERROR
 
-            #{error_messages.join("\n")}
+
+            Errors:
+                #{error_messages.join("\n    ")}
           ERROR
         end
 
         def print_summary(result)
           $stdout.puts <<~RESULT
-            Total: #{result.total_size} (Dead: #{result.dead_size}, Alive: #{result.alive_size}, Unknown: #{result.unknown_size})
+
+            Total: #{result.total_size} (Archived: #{result.archived_size}, Alive: #{result.alive_size}, Unknown: #{result.unknown_size})
           RESULT
         end
 
@@ -55,7 +67,7 @@ module Bundler
           end
 
           say "Too many requested! Retry later.", :yellow if rate_limit_exceeded
-          if result.dead_size.positive?
+          if result.archived_size.positive?
             say "Not alive gems are found!", :red
             return
           end

data/lib/bundler/alive/source_code_repository.rb

@@ -17,6 +17,8 @@ module Bundler
         raise ArgumentError, "Unknown url: #{url}" unless url.instance_of?(SourceCodeRepositoryUrl)
 
         @url = url
+
+        freeze
       end
 
       private

data/lib/bundler/alive/source_code_repository_url.rb

@@ -44,6 +44,8 @@ module Bundler
                           end
           message = "[#{name}] is not support URL: #{decorated_url}"
           super(message)
+
+          freeze
         end
       end
 

data/lib/bundler/alive/status.rb

@@ -20,7 +20,7 @@ module Bundler
       # @param [String] :name
       # @param [SourceCodeRepositoryUrl] :repository_url
       # @param [Boolean] :alive
-      # @param [] :checked_at
+      # @param [Time] :checked_at
       #
       # @return [Status]
       #
@@ -67,7 +67,6 @@ module Bundler
         <<~REPORT
           Name: #{name}
           URL: #{decorated_repository_url}
-          Status: #{decorated_alive}
 
         REPORT
       end

data/lib/bundler/alive/status_collection.rb

@@ -10,30 +10,7 @@ module Bundler
       delegate each: :collection
       delegate values: :collection
 
-      attr_reader :alive_size, :dead_size, :unknown_size
-
-      #
-      # Creates `StatusCollection` from TOML file
-      #
-      # @param [String] path
-      #
-      # @return [StatusCollection]
-      #
-      def self.new_from_toml_file(path)
-        return new unless File.exist?(path)
-
-        collection = new
-        TomlRB.load_file(path).each do |name, v|
-          next if v["alive"] == Status::ALIVE_UNKNOWN
-
-          url = SourceCodeRepositoryUrl.new(v["repository_url"], name)
-          status = Status.new(name: name, repository_url: url,
-                              alive: v["alive"], checked_at: v["checked_at"])
-          collection = collection.add(name, status)
-        end
-
-        collection
-      end
+      attr_reader :alive_size, :archived_size, :unknown_size
 
       #
       # Generates instance of `StatusCollection`
@@ -48,7 +25,8 @@ module Bundler
 
         @alive_size = _alive_size
         @unknown_size = _unknown_size
-        @dead_size = _dead_size
+        @archived_size = _archived_size
+
         freeze
       end
 
@@ -107,7 +85,7 @@ module Bundler
         collection.transform_values(&:to_h)
       end
 
-      def need_to_report_gems
+      def archived_gems
         collection.find_all { |_name, gem| !!!gem.alive }
       end
 
@@ -137,7 +115,7 @@ module Bundler
         statuses_values.count { |gem| !!gem.alive && !gem.unknown? }
       end
 
-      def _dead_size
+      def _archived_size
         statuses_values.count { |gem| !gem.alive && !gem.unknown? }
       end
 

data/lib/bundler/alive/status_result.rb

@@ -21,6 +21,8 @@ module Bundler
         @collection = collection
         @error_messages = error_messages
         @rate_limit_exceeded = rate_limit_exceeded
+
+        freeze
       end
 
       #

data/lib/bundler/alive/version.rb

@@ -2,6 +2,6 @@
 
 module Bundler
   module Alive
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

data/lib/bundler/alive.rb

@@ -7,7 +7,6 @@ require_relative "alive/source_code_repository_url"
 require_relative "alive/status"
 require_relative "alive/status_result"
 require_relative "alive/status_collection"
-require_relative "alive/announcer"
 require_relative "alive/report"
 require_relative "alive/client/gems_api_client"
 require_relative "alive/client/gems_api_response"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundler-alive
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Katsuhiko YOSHIDA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-16 00:00:00.000000000 Z
+date: 2022-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: toml-rb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -192,8 +178,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundler-alive.default.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
@@ -203,7 +191,6 @@ files:
 - bundler-alive.gemspec
 - gemspec.yml
 - lib/bundler/alive.rb
-- lib/bundler/alive/announcer.rb
 - lib/bundler/alive/cli.rb
 - lib/bundler/alive/client/gems_api_client.rb
 - lib/bundler/alive/client/gems_api_response.rb

data/lib/bundler/alive/announcer.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler"
-
-module Bundler
-  module Alive
-    #
-    # Announces check progress
-    #
-    class Announcer
-      DOT = "."
-
-      private_constant :DOT
-
-      #
-      # A new instance of Reporter
-      #
-      def initialize
-        @output = $stdout
-      end
-
-      def announce
-        output.write DOT
-      end
-
-      private
-
-      attr_reader :output
-    end
-  end
-end