bundler-alive 0.1.2 → 0.1.5

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

@@ -7,9 +7,11 @@ module Bundler
       # Represents a source code client
       #
       class SourceCodeClient
+        # Error of searching repository
         class SearchRepositoryError < StandardError
         end
 
+        # Error of rate limit exceeded
         class RateLimitExceededError < StandardError
         end
 
@@ -31,10 +33,11 @@ module Bundler
         def initialize(service_name:)
           raise ArgumentError, "Unknown service: #{service_name}" unless SERVICE_WITH_STRATEGIES.key?(service_name)
 
-          service = SERVICE_WITH_STRATEGIES[service_name]
-          extend service
+          strategy = SERVICE_WITH_STRATEGIES[service_name]
+          extend strategy
 
           @client = create_client
+          @error_messages = []
 
           super()
         end

data/lib/bundler/alive/doctor.rb

@@ -2,121 +2,103 @@
 
 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
-      attr_reader :all_alive, :rate_limit_exceeded_error
-
       #
       # 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 = "result.toml")
+      def initialize(lock_file, config_file, ignore_gems)
         @lock_file = lock_file
-        @result_file = result_file
-        @gem_client = Client::GemsApi.new
+        @gem_client = Client::GemsApiClient.new(config_file)
+        @ignore_gems = ignore_gems
         @result = nil
-        @all_alive = nil
-        @rate_limit_exceeded_error = false
+        @rate_limit_exceeded = false
+        @error_messages = []
       end
 
       #
-      # Diagnoses gems in lock file of gem
+      # Diagnoses gems in Gemfile.lock
       #
-      def diagnose
-        @result = gems.each_with_object(GemStatusCollection.new) do |spec, collection|
-          gem_name = spec.name
-          gem_status = diagnose_gem(gem_name)
-
-          collection.add(gem_name, gem_status)
-        end
-      end
-
+      # @raise [Client::SourceCodeClient::RateLimitExceededError]
+      #   When exceeded access rate limit
       #
-      # Reports the result
+      # @raise [StandardError]
+      #   When raised unexpected error
       #
-      def report
-        need_to_report_gems = result.need_to_report_gems
-        @all_alive = need_to_report_gems.size.zero?
-        need_to_report_gems.each do |_name, gem_status|
-          print gem_status.report
-        end
-      end
-
+      # @return [Report]
       #
-      # Saves result to file
-      #
-      def save_as_file
-        body = TomlRB.dump(result.to_h)
-        File.write(result_file, body)
+      def diagnose
+        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, :result
+      attr_reader :lock_file, :gem_client, :ignore_gems,
+                  :result, :error_messages, :rate_limit_exceeded
 
-      def diagnosed_gem?(gem_status)
-        !gem_status.nil? && !gem_status.unknown?
+      def diagnose_by_service(service, urls)
+        client = Client::SourceCodeClient.new(service_name: service)
+        client.query(urls: urls)
       end
 
-      def collection_from_file
-        return @collection_from_file if instance_variable_defined?(:@collection_from_file)
+      # @return [StatusResult]
+      def result_by_search(collection)
+        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)
 
-        return GemStatusCollection.new unless File.exist?(result_file)
+        result = StatusResult.new
+        service_with_urls.each do |service, urls|
+          result = result.merge(diagnose_by_service(service, urls))
+        end
+        result
+      end
 
-        toml_hash = TomlRB.load_file(result_file)
-        @collection_from_file = collection_from_hash(toml_hash)
+      # @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,
+                              checked_at: nil)
+          collection.add(gem_name, status)
+        end
       end
 
-      def collection_from_hash(hash)
-        hash.each_with_object(GemStatusCollection.new) do |(gem_name, v), collection|
-          url = v["repository_url"]
-          next if url.to_sym == GemStatus::REPOSITORY_URL_UNKNOWN
+      # @return [StatusResult]
+      def _diagnose
+        collection = collection_from_gemfile
+        result = result_by_search(collection)
+        new_collection = collection.merge(result.collection)
+        messages = error_messages.concat(result.error_messages)
 
-          gem_status = GemStatus.new(name: gem_name,
-                                     repository_url: SourceCodeRepositoryUrl.new(url),
-                                     alive: v["alive"],
-                                     checked_at: v["checked_at"])
-          collection.add(gem_name, gem_status)
-        end
+        StatusResult.new(collection: new_collection,
+                         error_messages: messages,
+                         rate_limit_exceeded: result.rate_limit_exceeded)
       end
 
-      def gems
+      def gems_from_lockfile
         lock_file_body = File.read(@lock_file)
         lock_file = Bundler::LockfileParser.new(lock_file_body)
-        lock_file.specs.each
-      end
-
-      # rubocop:disable Metrics/MethodLength
-      def diagnose_gem(gem_name)
-        gem_status = collection_from_file.get_unchecked(gem_name)
-        return gem_status if diagnosed_gem?(gem_status)
-
-        unless @rate_limit_exceeded_error
-          begin
-            source_code_url = gem_client.get_repository_url(gem_name)
-            is_alive = SourceCodeRepository.new(url: source_code_url).alive?
-          rescue Client::SourceCodeClient::RateLimitExceededError => e
-            @rate_limit_exceeded_error = true
-            puts e.message
-          rescue StandardError => e
-            puts e.message
-          end
-        end
-
-        GemStatus.new(name: gem_name,
-                      repository_url: source_code_url,
-                      alive: is_alive,
-                      checked_at: Time.now)
+        lock_file.specs
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/bundler/alive/report.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Bundler
+  module Alive
+    #
+    # Represents Report
+    #
+    class Report
+      attr_reader :result, :error_messages, :rate_limit_exceeded
+
+      #
+      # A result of report
+      #
+      # @param [StatusResult] result
+      #
+      def initialize(result)
+        @result = result.collection
+        @error_messages = result.error_messages
+        @rate_limit_exceeded = result.rate_limit_exceeded
+
+        freeze
+      end
+    end
+  end
+end

data/lib/bundler/alive/reportable.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "bundler"
+
+require "thor"
+
+module Bundler
+  module Alive
+    class CLI < ::Thor
+      #
+      # Reports
+      #
+      module Reportable
+        #
+        # Reports result
+        #
+        # @param [Report] report
+        #
+        def print_report(report)
+          result = report.result
+          error_messages = report.error_messages
+          print_error(error_messages)
+
+          gems = result.archived_gems
+          print_archived_gems(gems) if gems.size.positive?
+
+          print_summary(result)
+          print_message(result, report.rate_limit_exceeded)
+        end
+
+        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.empty?
+
+          $stdout.puts <<~ERROR
+
+
+            Errors:
+                #{error_messages.join("\n    ")}
+          ERROR
+        end
+
+        def print_summary(result)
+          $stdout.puts <<~RESULT
+
+            Total: #{result.total_size} (Archived: #{result.archived_size}, Alive: #{result.alive_size}, Unknown: #{result.unknown_size})
+          RESULT
+        end
+
+        def print_message(result, rate_limit_exceeded)
+          if result.all_alive?
+            say "All gems are alive!", :green
+            return
+          end
+
+          say "Too many requested! Retry later.", :yellow if rate_limit_exceeded
+          if result.archived_size.positive?
+            say "Not alive gems are found!", :red
+            return
+          end
+          say "Unknown gems are found!", :yellow if result.unknown_size.positive?
+        end
+      end
+    end
+  end
+end

data/lib/bundler/alive/source_code_repository.rb

@@ -17,21 +17,13 @@ module Bundler
         raise ArgumentError, "Unknown url: #{url}" unless url.instance_of?(SourceCodeRepositoryUrl)
 
         @url = url
-        @client = Client::SourceCodeClient.new(service_name: url.service_name)
-      end
 
-      #
-      # Returns alive or not
-      #
-      # @return [Boolean]
-      #
-      def alive?
-        !client.archived?(url)
+        freeze
       end
 
       private
 
-      attr_reader :url, :client
+      attr_reader :url
     end
   end
 end

data/lib/bundler/alive/source_code_repository_url.rb

@@ -4,41 +4,76 @@ module Bundler
   module Alive
     # Represents a source code repository
     class SourceCodeRepositoryUrl
+      # service domain with service
       DOMAIN_WITH_SERVICES = {
-        "github.com" => SourceCodeRepository::Service::GITHUB
+        "github.com" => SourceCodeRepository::Service::GITHUB,
+        "www.github.com" => SourceCodeRepository::Service::GITHUB
       }.freeze
 
       private_constant :DOMAIN_WITH_SERVICES
 
+      #
+      # Judge supported url or not
+      #
+      # @param [String] url
+      #
+      # @return [Boolean]
+      #
+      def self.support_url?(url)
+        return false if url.nil?
+
+        uri = URI.parse(url)
+        host = uri.host
+
+        DOMAIN_WITH_SERVICES.key?(host)
+      end
+
       # No supported URL Error
       class UnSupportedUrl < StandardError
-        def initialize(url)
-          message = "UnSupported URL: #{url}"
+        #
+        # @param [String] :url
+        # @param [String] :name
+        #
+        # @return [UnSupportedUrl]
+        #
+        def initialize(url:, name:)
+          decorated_url = if url.nil? || url == ""
+                            "(blank)"
+                          else
+                            url
+                          end
+          message = "[#{name}] is not support URL: #{decorated_url}"
           super(message)
+
+          freeze
         end
       end
 
-      attr_reader :url, :service_name
+      attr_reader :url, :service_name, :gem_name
 
       #
       # Creates a `SourceCodeRepositoryUrl`
       #
       # @param [String] url
+      # @param [String] name
       #
       # @raise [UnSupportedUrl]
       #
-      def initialize(url)
+      def initialize(url, name)
+        raise UnSupportedUrl.new(url: url, name: name) if url.nil?
+
         @url = url
-        @service_name = service(url)
+        @service_name = service(url: url, name: name)
+        @gem_name = name
       end
 
       private
 
-      def service(url)
+      def service(url:, name:)
         uri = URI.parse(url)
         host = uri.host
 
-        raise UnSupportedUrl, url unless DOMAIN_WITH_SERVICES.key?(host)
+        raise UnSupportedUrl.new(url: url, name: name) unless DOMAIN_WITH_SERVICES.key?(host)
 
         DOMAIN_WITH_SERVICES[host]
       end

data/lib/bundler/alive/{gem_status.rb → status.rb}

@@ -3,15 +3,30 @@
 module Bundler
   module Alive
     #
-    # Result of gem status
+    # Represents Status
     #
-    class GemStatus
-      REPOSITORY_URL_UNKNOWN = :unknown
-      ALIVE_UNKNOWN = :unknown
+    class Status
+      # Value of repository URL unknown
+      REPOSITORY_URL_UNKNOWN = "unknown"
+
+      # Value off alive unknown
+      ALIVE_UNKNOWN = "unknown"
 
       attr_reader :name, :repository_url, :alive, :checked_at
 
+      #
+      # Creates instance of `Status`
+      #
+      # @param [String] :name
+      # @param [SourceCodeRepositoryUrl] :repository_url
+      # @param [Boolean] :alive
+      # @param [Time] :checked_at
+      #
+      # @return [Status]
+      #
       def initialize(name:, repository_url:, alive:, checked_at:)
+        raise ArgumentError if !repository_url.nil? && !repository_url.instance_of?(SourceCodeRepositoryUrl)
+
         repository_url = REPOSITORY_URL_UNKNOWN if repository_url.nil?
         alive = ALIVE_UNKNOWN if alive.nil?
 
@@ -24,7 +39,7 @@ module Bundler
       end
 
       #
-      # Alive?
+      # Is status of alive unknown?
       #
       # @return [Boolean]
       #
@@ -39,7 +54,7 @@ module Bundler
         {
           repository_url: decorated_repository_url,
           alive: decorated_alive,
-          checked_at: checked_at
+          checked_at: checked_at || ""
         }
       end
 
@@ -52,7 +67,6 @@ module Bundler
         <<~REPORT
           Name: #{name}
           URL: #{decorated_repository_url}
-          Status: #{decorated_alive}
 
         REPORT
       end
@@ -61,7 +75,7 @@ module Bundler
 
       def decorated_repository_url
         if repository_url == REPOSITORY_URL_UNKNOWN
-          REPOSITORY_URL_UNKNOWN.to_s
+          REPOSITORY_URL_UNKNOWN
         else
           repository_url.url
         end
@@ -69,7 +83,7 @@ module Bundler
 
       def decorated_alive
         if alive == ALIVE_UNKNOWN
-          ALIVE_UNKNOWN.to_s
+          ALIVE_UNKNOWN
         else
           alive
         end

data/lib/bundler/alive/status_collection.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Bundler
+  module Alive
+    # Collection of `Status`
+    class StatusCollection
+      extend Forwardable
+      delegate each: :collection
+      delegate values: :collection
+
+      attr_reader :alive_size, :archived_size, :unknown_size
+
+      #
+      # Generates instance of `StatusCollection`
+      #
+      # @param [StatusCollection|nil] collection
+      #
+      # @return [StatusCollection]
+      #
+      def initialize(collection = {})
+        @collection = collection
+        @statuses_values = collection.values || []
+
+        @alive_size = _alive_size
+        @unknown_size = _unknown_size
+        @archived_size = _archived_size
+
+        freeze
+      end
+
+      #
+      # Fetch `Status` of `name`
+      #
+      # @param [String] name
+      #
+      # @return [Status]
+      #
+      def [](name)
+        collection[name]
+      end
+
+      #
+      # Names of gems
+      #
+      # @return [Array<String>]
+      #
+      def names
+        values.map(&:name)
+      end
+
+      #
+      # Add status
+      #
+      # @param [String] name
+      # @param [Status] status
+      #
+      # @return [StatusCollection]
+      #
+      def add(name, status)
+        collection[name] = status
+
+        self.class.new(collection)
+      end
+
+      #
+      # Merge collection
+      #
+      # @param [StatusCollection] collection
+      #
+      # @return [StatusCollection]
+      #
+      def merge(collection)
+        return self.class.new(self.collection) if collection.nil?
+
+        collection.each do |k, v|
+          self.collection[k] = v
+        end
+
+        self.class.new(self.collection)
+      end
+
+      def to_h
+        collection.transform_values(&:to_h)
+      end
+
+      def archived_gems
+        collection.find_all { |_name, gem| !!!gem.alive }
+      end
+
+      #
+      # All of statuses are alive nor not
+      #
+      # @return [Boolean]
+      #
+      def all_alive?
+        collection.find { |_name, status| !!!status.alive || status.unknown? }.nil?
+      end
+
+      #
+      # Total size of collection
+      #
+      # @return [Integer]
+      #
+      def total_size
+        collection.size
+      end
+
+      private
+
+      attr_reader :collection, :statuses_values
+
+      def _alive_size
+        statuses_values.count { |gem| !!gem.alive && !gem.unknown? }
+      end
+
+      def _archived_size
+        statuses_values.count { |gem| !gem.alive && !gem.unknown? }
+      end
+
+      def _unknown_size
+        statuses_values.count { |gem| gem.alive == Status::ALIVE_UNKNOWN }
+      end
+    end
+  end
+end

data/lib/bundler/alive/status_result.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Bundler
+  module Alive
+    #
+    # Represents Result of Status
+    #
+    class StatusResult
+      attr_reader :collection, :error_messages, :rate_limit_exceeded
+
+      #
+      # Creates a new StatusResult instance
+      #
+      # @param [StatusCollection|nil] :collection
+      # @param [Array|nil] :error_messages
+      # @param [Boolean|nil] :rate_limit_exceeded
+      #
+      # @return [StatusResult]
+      #
+      def initialize(collection: nil, error_messages: nil, rate_limit_exceeded: nil)
+        @collection = collection
+        @error_messages = error_messages
+        @rate_limit_exceeded = rate_limit_exceeded
+
+        freeze
+      end
+
+      #
+      # Merge `StatusResult`, then returns new one
+      #
+      # @param [StatusResult] result
+      #
+      # @return [StatusResult]
+      #
+      def merge(result)
+        self.class.new(collection: result.collection,
+                       error_messages: result.error_messages,
+                       rate_limit_exceeded: result.rate_limit_exceeded)
+      end
+    end
+  end
+end

data/lib/bundler/alive/version.rb

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

data/lib/bundler/alive.rb

@@ -4,8 +4,12 @@ require_relative "alive/version"
 require_relative "alive/doctor"
 require_relative "alive/source_code_repository"
 require_relative "alive/source_code_repository_url"
-require_relative "alive/gem_status"
-require_relative "alive/gem_status_collection"
-require_relative "alive/client/gems_api"
+require_relative "alive/status"
+require_relative "alive/status_result"
+require_relative "alive/status_collection"
+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/source_code_client"
+require_relative "alive/reportable"