bundler-alive 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf64468693c247f87a2ffbce58960dd82d1313614d1433d0d032210f080e8fd4
-  data.tar.gz: a3d9f48ce1e8a932ae954897448acf7ab5cc82123992bd82b72ab33b7a8902b0
+  metadata.gz: c3e48b8f0f5a030f9b537e4150f6b10e5bdf3ed709cde30162d2030b3292cbc6
+  data.tar.gz: dff1d8579c996eeb24c599e2a40ba48b778d2939af8e80f3da94ed133a4ac0b5
 SHA512:
-  metadata.gz: 0c4d5747e3b1a133bcc8e1d757fb0ca790b280c667b7f2aa865c95363db66a878f2b0383d436a3b83cb43c19b28d06815c226d7fde09411d626ecdbc0508836f
-  data.tar.gz: e4ad9d70fb50258517e8cfbde02aea45435575e0e41435a26e9c5e35141b6df5e71bbebd85f11837afc6fdaa2b76c89508191234417214471f64c18b43d5f8d9
+  metadata.gz: 94d793718656beddd079aaa083fe501b2775a8b658d361b19d5c56906abba39551dd6f84628904c98235db7bc381028fb3ce261bb09178d00154ea3f682e2757
+  data.tar.gz: 4e4977e62794f2f9cd403187c4d60063788f8589ddef358beb2ba49827b65b7b3be6c64d563489b0c90938fe94f02b98af88fdf6bc93f29ea12bdc29ffc399a5

data/.bundler-alive.default.yml

@@ -0,0 +1,56 @@
+---
+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
+  declarative_policy:
+    url: https://gitlab.com/gitlab-org/ruby/gems/declarative-policy
+  spamcheck:
+    url: https://gitlab.com/gitlab-com/gl-security/engineering-and-research/automation-team/spam/spamcheck
+  tanuki_emoji:
+    url: https://gitlab.com/gitlab-org/ruby/gems/tanuki_emoji
+  cbor:
+    url: https://github.com/cabo/cbor-ruby
+  expression_parser:
+    url: https://github.com/nricciar/expression_parser
+  extended-markdown-filter:
+    url: https://github.com/gjtorikian/extended-markdown-filter
+  gettext:
+    url: https://github.com/ruby-gettext/gettext
+  png_quantizator:
+    url: https://github.com/rogercampos/png_quantizator
+  redis-actionpack:
+    url: https://github.com/redis-store/redis-actionpack
+  redis-rack:
+    url: https://github.com/redis-store/redis-rack
+  sixarm_ruby_unaccent:
+    url: https://github.com/SixArm/sixarm_ruby_unaccent
+  thrift:
+    url: https://github.com/szechyjs/thrift-gem
+  vmstat:
+    url: https://github.com/threez/ruby-vmstat

data/.yardopts

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

data/Gemfile

@@ -4,14 +4,6 @@ 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

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 GitHub.com and GitLab.com are 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,13 @@ 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.
+## GitLab Access Token
+
+When gems are in GitLab.com repository, you MUST set environment variable `BUNDLER_ALIVE_GITLAB_TOKEN`. See the document [Personal access tokens](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html).
+
+## Exceeding rate limit
+
+In some cases, the following error may be output.
 
 ```
 Too many requested! Retry later.
@@ -47,7 +55,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,36 @@
+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:
+  gitlab:
+
+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

@@ -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
@@ -39,13 +38,20 @@ module Bundler
       private
 
       def check_by_doctor
-        doctor = begin
-          Doctor.new(options[:gemfile_lock], options[:result])
-        rescue Bundler::GemfileLockNotFound
+        doctor = initialize_doctor
+
+        begin
+          doctor.diagnose
+        rescue Bundler::Alive::Client::GitlabApi::AccessTokenNotFoundError => e
+          say "\n#{e.message}", :yellow
           exit 1
         end
+      end
 
-        doctor.diagnose
+      def initialize_doctor
+        Doctor.new(options[:gemfile_lock], options[:config], options[:ignore])
+      rescue Bundler::GemfileLockNotFound
+        exit 1
       end
     end
   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,29 +88,49 @@ 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)
+          return url_via_redirect(url) if SourceCodeRepositoryUrl.support_url?(url)
 
           url = body["homepage_uri"]
-          return url if SourceCodeRepositoryUrl.support_url?(url)
+          return url_via_redirect(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 url_via_redirect(url)
+          response = connection.head(url)
+          return response.headers["location"] if response.status == 301
 
-          raise NotFound, "[#{gem_name}] source code repository is not found in RubyGems.org."
+          url
         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 → github_api.rb}

@@ -11,7 +11,7 @@ module Bundler
       #
       # @see https://docs.github.com/en/rest/search#search-repositories
       #
-      module GitHubApi
+      module GithubApi
         # Environment variable name of GitHub Access Token
         ACCESS_TOKEN_ENV_NAME = "BUNDLER_ALIVE_GITHUB_TOKEN"
 
@@ -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
 
         #
@@ -36,6 +44,7 @@ module Bundler
           base.instance_eval do
             @rate_limit_exceeded = false
             @retries_on_too_many_requests = 0
+            @name_with_archived = {}
           end
         end
 
@@ -55,15 +64,12 @@ module Bundler
         #
         # @return [StatusResult]
         #
-        # rubocop:disable Metrics/MethodLength
         def query(urls:)
           collection = StatusCollection.new
-          name_with_archived = get_name_with_statuses(urls)
+          @name_with_archived = get_name_with_statuses(urls)
           urls.each do |url|
-            yield if block_given?
-
             gem_name = url.gem_name
-            alive = !name_with_archived[gem_name]
+            alive = alive?(gem_name)
             status = Status.new(name: gem_name, repository_url: url, alive: alive, checked_at: Time.now)
             collection = collection.add(gem_name, status)
           end
@@ -71,10 +77,16 @@ module Bundler
           StatusResult.new(collection: collection, error_messages: @error_messages,
                            rate_limit_exceeded: @rate_limit_exceeded)
         end
-        # rubocop:enable Metrics/MethodLength
 
         private
 
+        def alive?(gem_name)
+          return false unless @name_with_archived.key?(gem_name)
+
+          value = @name_with_archived[gem_name]
+          value == Status::ALIVE_UNKNOWN ? Status::ALIVE_UNKNOWN : !value
+        end
+
         #
         # Search status of repositories
         #
@@ -85,23 +97,39 @@ module Bundler
         #
         # 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|
+            $stdout.print "." * sliced_urls.size
+
             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"]
+            sliced_urls.each do |url|
+              repository = find_repository_from_repositories(url: url,
+                                                             repositories: repositories)
+              alive_status = if repository.nil?
+                               Status::ALIVE_UNKNOWN
+                             else
+                               repository["archived"]
+                             end
+              name_with_status[url.gem_name] = alive_status
             end
           end
           name_with_status
         end
         # rubocop:enable Metrics/MethodLength
 
+        # @param [SourceCodeRepositoryUrl] :url
+        # @param [Array<Sawyer::Resource>] :repositories
+        #
+        # @return [Sawyer::Resource|nil]
+        def find_repository_from_repositories(url:, repositories:)
+          repositories.find do |repository|
+            slug(url.url) == repository["full_name"]
+          end
+        end
+
         #
         # Search query of repositories
         #
@@ -151,7 +179,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
@@ -164,7 +192,7 @@ module Bundler
         # @return [String]
         #
         def slug(repository_url)
-          Octokit::Repository.from_url(repository_url).slug
+          Octokit::Repository.from_url(repository_url).slug.gsub(/\.git/, "")
         end
       end
     end

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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "gitlab"
+require "json"
+
+module Bundler
+  module Alive
+    module Client
+      #
+      # API Client for GitLab API
+      #
+      # @see https://docs.gitlab.com/ee/api/projects.html#get-single-project
+      #
+      module GitlabApi
+        #
+        # Access token isn't set error
+        #
+        # @see https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
+        #
+        class AccessTokenNotFoundError < StandardError
+          def initialize(_message = nil)
+            message = "Environment variable #{ACCESS_TOKEN_ENV_NAME} is not set."\
+                      " Need to set GitLab Personal Access Token to be authenticated at gitlab.com API."\
+                      " See: https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html"
+            super(message)
+          end
+        end
+
+        # Environment variable name of GitLab Access Token
+        #
+        # @see https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
+        #
+        ACCESS_TOKEN_ENV_NAME = "BUNDLER_ALIVE_GITLAB_TOKEN"
+
+        # Endpoint of GitLab API
+        ENDPOINT = "https://gitlab.com/api/v4"
+
+        def self.extended(base)
+          base.instance_eval do
+            @rate_limit_exceeded = false
+            @retries_on_too_many_requests = 0
+          end
+        end
+
+        #
+        # Creates a GitLab client
+        #
+        # @return [Octokit::Client]
+        #
+        def create_client
+          access_token = ENV.fetch(ACCESS_TOKEN_ENV_NAME, nil)
+          raise AccessTokenNotFoundError if access_token.nil?
+
+          Gitlab.client(
+            endpoint: ENDPOINT,
+            private_token: access_token
+          )
+        end
+
+        #
+        # Query repository statuses
+        #
+        # @param [Array<RepositoryUrl>] :urls
+        #
+        # @return [StatusResult]
+        #
+        def query(urls:)
+          collection = StatusCollection.new
+          name_with_archived = get_name_with_statuses(urls)
+          urls.each do |url|
+            gem_name = url.gem_name
+            alive = name_with_archived.key?(gem_name) && !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
+
+        private
+
+        #
+        # Search status of repositories
+        #
+        # @param [Array<RepositoryUrl>] urls
+        #
+        # @return [Hash<String, Boolean>]
+        #   gem name with archived or not
+        #
+        def get_name_with_statuses(urls)
+          name_with_status = {}
+          urls.each do |url|
+            $stdout.write "."
+            project = search_repositories_with_retry(url)
+            next if project.nil? || project.empty?
+
+            name = url.gem_name
+            name_with_status[name] = project["archived"]
+          end
+          name_with_status
+        end
+
+        def project_path_from_url(url)
+          uri = URI.parse(url.url)
+          uri.path.split("/")[1..].join("/")
+        end
+
+        def search_repositories_with_retry(url)
+          project_path = project_path_from_url(url)
+
+          # Must be converted to hash due to warnings
+          @client.project(project_path).to_h
+        rescue StandardError => e
+          @error_messages << e.message
+          []
+        end
+      end
+    end
+  end
+end

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

@@ -16,7 +16,8 @@ module Bundler
         end
 
         SERVICE_WITH_STRATEGIES = {
-          SourceCodeRepository::Service::GITHUB => GitHubApi
+          SourceCodeRepository::Service::GITHUB => GithubApi,
+          SourceCodeRepository::Service::GITLAB => GitlabApi
         }.freeze
 
         private_constant :SERVICE_WITH_STRATEGIES

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,11 @@ 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
+          unknown_gems = result.unknown_gems
+          print_archived_gems(unknown_gems, header: "Unknown gems:") if unknown_gems.size.positive?
+
+          archived_gems = result.archived_gems
+          print_archived_gems(archived_gems, header: "Archived gems:") if archived_gems.size.positive?
 
           print_summary(result)
           print_message(result, report.rate_limit_exceeded)
@@ -33,18 +33,33 @@ module Bundler
 
         private
 
+        # soo messy
+        def print_archived_gems(gems, header:)
+          $stdout.puts
+          $stdout.puts header
+          gems_to_report = 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 gems_to_report.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}, Unknown: #{result.unknown_size}, Alive: #{result.alive_size})
           RESULT
         end
 
@@ -55,7 +70,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

@@ -6,6 +6,7 @@ module Bundler
     class SourceCodeRepository
       module Service
         GITHUB = :github
+        GITLAB = :gitlab
       end
 
       #
@@ -17,6 +18,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

@@ -7,7 +7,8 @@ module Bundler
       # service domain with service
       DOMAIN_WITH_SERVICES = {
         "github.com" => SourceCodeRepository::Service::GITHUB,
-        "www.github.com" => SourceCodeRepository::Service::GITHUB
+        "www.github.com" => SourceCodeRepository::Service::GITHUB,
+        "gitlab.com" => SourceCodeRepository::Service::GITLAB
       }.freeze
 
       private_constant :DOMAIN_WITH_SERVICES
@@ -44,6 +45,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,10 +85,14 @@ module Bundler
         collection.transform_values(&:to_h)
       end
 
-      def need_to_report_gems
+      def archived_gems
         collection.find_all { |_name, gem| !!!gem.alive }
       end
 
+      def unknown_gems
+        collection.find_all { |_name, gem| gem.unknown? }
+      end
+
       #
       # All of statuses are alive nor not
       #
@@ -137,7 +119,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

@@ -17,10 +17,12 @@ module Bundler
       #
       # @return [StatusResult]
       #
-      def initialize(collection: nil, error_messages: nil, rate_limit_exceeded: nil)
+      def initialize(collection: StatusCollection.new, error_messages: [], rate_limit_exceeded: false)
         @collection = collection
         @error_messages = error_messages
         @rate_limit_exceeded = rate_limit_exceeded
+
+        freeze
       end
 
       #
@@ -31,9 +33,12 @@ module Bundler
       # @return [StatusResult]
       #
       def merge(result)
-        self.class.new(collection: result.collection,
-                       error_messages: result.error_messages,
-                       rate_limit_exceeded: result.rate_limit_exceeded)
+        merged_collection = collection.merge(result.collection)
+        merged_error_messages = error_messages + result.error_messages
+        merged_rate_limit_exceeded = rate_limit_exceeded || result.rate_limit_exceeded
+        self.class.new(collection: merged_collection,
+                       error_messages: merged_error_messages,
+                       rate_limit_exceeded: merged_rate_limit_exceeded)
       end
     end
   end

data/lib/bundler/alive/version.rb

@@ -2,6 +2,6 @@
 
 module Bundler
   module Alive
-    VERSION = "0.1.3"
+    VERSION = "0.1.6"
   end
 end

data/lib/bundler/alive.rb

@@ -7,10 +7,10 @@ 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"
-require_relative "alive/client/git_hub_api"
+require_relative "alive/client/github_api"
+require_relative "alive/client/gitlab_api"
 require_relative "alive/client/source_code_client"
 require_relative "alive/reportable"

metadata

@@ -1,26 +1,201 @@
 --- !ruby/object:Gem::Specification
 name: bundler-alive
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
 - Katsuhiko YOSHIDA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-15 00:00:00.000000000 Z
-dependencies: []
+date: 2022-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: octokit
+  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: rake
+  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: thor
+  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: gitlab
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: bundler-alive reports gems are archived or not.
-email:
-- claddvd@gmail.com
+email: claddvd@gmail.com
 executables:
 - bundle-alive
 - bundler-alive
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundler-alive.default.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
@@ -28,12 +203,13 @@ files:
 - bin/bundle-alive
 - bin/bundler-alive
 - 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
-- lib/bundler/alive/client/git_hub_api.rb
+- lib/bundler/alive/client/github_api.rb
+- lib/bundler/alive/client/gitlab_api.rb
 - lib/bundler/alive/client/source_code_client.rb
 - lib/bundler/alive/doctor.rb
 - lib/bundler/alive/report.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