bundler-alive 0.1.2 → 0.1.3

data/lib/bundler/alive/report.rb

@@ -0,0 +1,35 @@
+# 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
+
+      #
+      # 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

@@ -0,0 +1,67 @@
+# 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.need_to_report_gems
+          $stdout.puts if gems.size.positive?
+          gems.each do |_name, gem|
+            $stdout.puts gem.report
+          end
+
+          print_summary(result)
+          print_message(result, report.rate_limit_exceeded)
+        end
+
+        private
+
+        def print_error(error_messages)
+          return if error_messages.nil?
+
+          $stdout.puts <<~ERROR
+
+            #{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})
+          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.dead_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,11 @@ 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)
       end
 
       private
 
-      attr_reader :url, :client
+      attr_reader :url
     end
   end
 end

data/lib/bundler/alive/source_code_repository_url.rb

@@ -4,41 +4,74 @@ 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)
         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 [] :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
 
@@ -61,7 +76,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 +84,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,149 @@
+# 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, :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
+
+      #
+      # 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
+        @dead_size = _dead_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 need_to_report_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 _dead_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,40 @@
+# 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
+      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.3"
   end
 end

data/lib/bundler/alive.rb

@@ -4,8 +4,13 @@ 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/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/source_code_client"
+require_relative "alive/reportable"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundler-alive
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Katsuhiko YOSHIDA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-08 00:00:00.000000000 Z
+date: 2022-05-15 00:00:00.000000000 Z
 dependencies: []
 description: bundler-alive reports gems are archived or not.
 email:
@@ -22,7 +22,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -30,15 +29,20 @@ files:
 - bin/bundler-alive
 - bundler-alive.gemspec
 - lib/bundler/alive.rb
+- lib/bundler/alive/announcer.rb
 - lib/bundler/alive/cli.rb
-- lib/bundler/alive/client/gems_api.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/source_code_client.rb
 - lib/bundler/alive/doctor.rb
-- lib/bundler/alive/gem_status.rb
-- lib/bundler/alive/gem_status_collection.rb
+- lib/bundler/alive/report.rb
+- lib/bundler/alive/reportable.rb
 - lib/bundler/alive/source_code_repository.rb
 - lib/bundler/alive/source_code_repository_url.rb
+- lib/bundler/alive/status.rb
+- lib/bundler/alive/status_collection.rb
+- lib/bundler/alive/status_result.rb
 - lib/bundler/alive/version.rb
 homepage: https://github.com/kyoshidajp/bundler-alive
 licenses: []

data/Gemfile.lock

@@ -1,119 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bundler-alive (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    citrus (3.0.2)
-    crack (0.4.5)
-      rexml
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    faraday (1.10.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    hashdiff (1.0.1)
-    multipart-post (2.1.1)
-    octokit (4.22.0)
-      faraday (>= 0.9)
-      sawyer (~> 0.8.0, >= 0.5.3)
-    parallel (1.22.1)
-    parser (3.1.2.0)
-      ast (~> 2.4.1)
-    public_suffix (4.0.7)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.3.1)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.29.0)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    sawyer (0.8.2)
-      addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    thor (1.2.1)
-    toml-rb (2.1.2)
-      citrus (~> 3.0, > 3.0)
-    unicode-display_width (2.1.0)
-    vcr (6.1.0)
-    webmock (3.14.0)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.20)
-
-PLATFORMS
-  arm64-darwin-20
-  ruby
-  x86_64-darwin-20
-
-DEPENDENCIES
-  bundler-alive!
-  faraday
-  octokit
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
-  simplecov
-  thor
-  toml-rb
-  vcr
-  webmock
-  yard
-
-BUNDLED WITH
-   2.3.13