gems_bond 1.0.4 → 1.1.0

data/lib/gems_bond/spy/one.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "gems_bond/gem"
+require "gems_bond/printers/stdout"
+
+module GemsBond
+  module Spy
+    # Inspects gem and outputs the result in terminal
+    class One
+      PRELOAD_KEYS = %i[
+        contributors_count
+        days_since_last_commit
+        days_since_last_version
+        downloads_count
+        forks_count
+        source_code_uri
+        stars_count
+        versions
+      ].freeze
+
+      # Initializes an instance
+      # @param name [String]
+      # @return [GemsBond::Spy::One]
+      def initialize(name)
+        @name = name
+      end
+
+      # Fetches gem then prints information
+      # @return [void]
+      def call
+        if gem.exist?
+          gem.prepare_data(keys: PRELOAD_KEYS, concurrency: false)
+          GemsBond::Printers::Stdout.new(gem).call
+        else
+          puts "Sorry, this gem could not be found!"
+        end
+      end
+
+      private
+
+      # Finds dependency corresponding to the name
+      # @return [Bundler::Dependency, nil]
+      def dependency
+        @dependency ||= Bundler.load.gems.find { |dep| dep.name == @name }
+      end
+
+      # Generates a gem instance
+      # @return [GemsBond::Gem]
+      def gem
+        if dependency
+          GemsBond::Gem.new(dependency)
+        else
+          unknown_dependency = Bundler::Dependency.new(@name, nil)
+          GemsBond::Gem.new(unknown_dependency, unknown: true)
+        end
+      end
+    end
+  end
+end

data/lib/gems_bond/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GemsBond
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

data/lib/tasks/gems_bond/spy/all.rake

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "gems_bond/spy/all"
+
+begin
+  require "#{Rails.root}/config/initializers/gems_bond" if defined?(Rails)
+rescue LoadError
+  nil
+end
+
+namespace :gems_bond do
+  namespace :spy do
+    desc "Investigates all gems and prints information"
+    task :all do
+      puts "Welcome, my name is Bond, Gems Bond."\
+          " I will do some spying on your gems for you…"
+
+      GemsBond.configure do |config|
+        # set github_token from ENV if given
+        config.github_token = ENV["GITHUB_TOKEN"] if ENV["GITHUB_TOKEN"]
+      end
+
+      unless GemsBond.configuration.github_token
+        puts "It seems that you didn’t provide any GitHub token."\
+            " This is necessary to fetch more data from GitHub,"\
+            " like the last commit date, the forks count, the size of the repository…"
+
+        puts "Please provide a GitHub token by adding it to the configuration"\
+            " or passing GITHUB_TOKEN=<token> when running the task."
+        exit
+      end
+
+      GemsBond::Spy::All.new.call
+    end
+  end
+end

data/lib/tasks/gems_bond/spy/one.rake

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "gems_bond/spy/one"
+
+begin
+  require "#{Rails.root}/config/initializers/gems_bond" if defined?(Rails)
+rescue LoadError
+  nil
+end
+
+namespace :gems_bond do
+  namespace :spy do
+    desc "Display information for the given gem"
+    task :one do
+      GemsBond.configure do |config|
+        # set github_token from ENV if given
+        config.github_token = ENV["GITHUB_TOKEN"] if ENV["GITHUB_TOKEN"]
+      end
+
+      ARGV.each { |a| task(a) }
+      name = ARGV[1]
+      if name
+        GemsBond::Spy::One.new(name).call
+      else
+        puts "Please provide the gem name, for example: `rake gems_bond:spy:one devise`"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gems_bond
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Edouard Piron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-29 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gems
@@ -47,17 +47,24 @@ extra_rdoc_files: []
 files:
 - lib/gems_bond.rb
 - lib/gems_bond/configuration.rb
-- lib/gems_bond/examination_helper.rb
-- lib/gems_bond/fetch_helper.rb
-- lib/gems_bond/fetcher/github.rb
-- lib/gems_bond/fetcher/ruby_gems.rb
+- lib/gems_bond/examination.rb
+- lib/gems_bond/fetchers/fetcher.rb
+- lib/gems_bond/fetchers/github.rb
+- lib/gems_bond/fetchers/ruby_gems.rb
 - lib/gems_bond/gem.rb
-- lib/gems_bond/printer.rb
+- lib/gems_bond/helpers/concurrency_helper.rb
+- lib/gems_bond/helpers/formatting_helper.rb
+- lib/gems_bond/printers/csv.rb
+- lib/gems_bond/printers/html.rb
+- lib/gems_bond/printers/printer.rb
+- lib/gems_bond/printers/stdout.rb
 - lib/gems_bond/railtie.rb
 - lib/gems_bond/scores.yml
-- lib/gems_bond/spy.rb
+- lib/gems_bond/spy/all.rb
+- lib/gems_bond/spy/one.rb
 - lib/gems_bond/version.rb
-- lib/tasks/gems_bond/spy.rake
+- lib/tasks/gems_bond/spy/all.rake
+- lib/tasks/gems_bond/spy/one.rake
 - views/diagnosis.erb
 homepage: https://github.com/BigBigDoudou/gems_bond
 licenses:
@@ -80,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.11
 signing_key: 
 specification_version: 4
 summary: Inspect gems

data/lib/gems_bond/fetch_helper.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require "gems_bond/fetcher/ruby_gems"
-require "gems_bond/fetcher/github"
-
-module GemsBond
-  # Handles gem data
-  module FetchHelper
-    RUBY_GEM_KEYS = %i[
-      last_version_date
-      downloads_count
-      source_code_uri
-      versions
-      last_version
-      last_version_date
-      days_since_last_version
-    ].freeze
-
-    GITHUB_KEYS = %i[
-      contributors_count
-      stars_count
-      forks_count
-      last_commit_date
-      open_issues_count
-      days_since_last_commit
-    ].freeze
-
-    KEYS = RUBY_GEM_KEYS + GITHUB_KEYS
-
-    RUBY_GEM_KEYS.each do |key|
-      define_method(key) do
-        memoize(key) do
-          fetch(ruby_gems_fetcher, key)
-        end
-      end
-    end
-
-    GITHUB_KEYS.each do |key|
-      define_method(key) do
-        memoize(key) do
-          fetch(github_fetcher, key)
-        end
-      end
-    end
-
-    def fetch_all(verbose: false)
-      KEYS.each do |key|
-        __send__(key)
-      end
-      verbose && puts(name)
-    end
-
-    private
-
-    def fetch(fetcher, key)
-      fetcher&.public_send(key)
-    end
-
-    def ruby_gems_fetcher
-      return @ruby_gems_fetcher if defined?(@ruby_gems_fetcher)
-
-      @ruby_gems_fetcher = GemsBond::Fetcher::RubyGems.new(name).start
-    end
-
-    def github_fetcher
-      return @github_fetcher if defined?(@github_fetcher)
-
-      @github_fetcher = github_url && GemsBond::Fetcher::Github.new(github_url).start
-    end
-  end
-end

data/lib/gems_bond/fetcher/ruby_gems.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require "gems"
-require "rubygems"
-
-module GemsBond
-  module Fetcher
-    # Fetches data from RubyGems
-    class RubyGems
-      def initialize(name)
-        @name = name
-      end
-
-      def source
-        "ruby gems"
-      end
-
-      def start
-        @info = Gems.info(@name)
-        self
-      rescue Gems::NotFound
-        nil
-      end
-
-      def downloads_count
-        Gems.total_downloads(@name)[:total_downloads]
-      end
-
-      def source_code_uri
-        @info["metadata"]["source_code_uri"]
-      end
-
-      def versions
-        Gems.versions(@name).map do |version|
-          {
-            number: version["number"],
-            created_at: Date.parse(version["created_at"]),
-            prerelease: version["prerelease"]
-          }
-        end
-      end
-
-      def last_version
-        versions&.first&.dig(:number)
-      end
-
-      def last_version_date
-        versions&.first&.dig(:created_at)
-      end
-
-      def days_since_last_version
-        return unless last_version_date
-
-        Date.today - last_version_date
-      end
-    end
-  end
-end

data/lib/gems_bond/printer.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-require "erb"
-require "fileutils"
-
-module GemsBond
-  # Prints gems table
-  class Printer
-    MISSING = "-"
-
-    def initialize(gems)
-      @gems = gems
-    end
-
-    def call
-      puts "\nPreparing data for printing results..."
-      create_directory
-      File.open("gems_bond/spy.html", "w") do |file|
-        file.puts content
-      end
-      puts "Open file gems_bond/spy.html to display the results."
-    end
-
-    private
-
-    def create_directory
-      return if File.directory?("gems_bond")
-
-      FileUtils.mkdir_p("gems_bond")
-    end
-
-    def template
-      File.read(File.join(File.dirname(__FILE__), "../../views/", "diagnosis.erb"))
-    end
-
-    def content
-      ERB.new(template).result(binding)
-    end
-
-    def sorted_gems
-      # sort with putting gems without average_score at the end
-      @gems.sort do |a, b|
-        if a.average_score && b.average_score
-          a.average_score <=> b.average_score
-        else
-          a.average_score ? -1 : 1
-        end
-      end
-    end
-
-    def version_color(gap)
-      return "secondary" if gap.nil?
-      return "success" if gap.zero?
-
-      gap < 3 ? "warning" : "danger"
-    end
-
-    def color(score)
-      return "secondary" if score.nil?
-
-      if score < 0.33
-        "danger"
-      elsif score < 0.66
-        "warning"
-      else
-        "success"
-      end
-    end
-
-    def human_date(date)
-      return MISSING if date.nil?
-
-      date.strftime("%F")
-    end
-
-    def human_number(number)
-      return MISSING if number.nil?
-
-      number.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1 ")
-    end
-
-    def human_score(score)
-      return MISSING if score.nil?
-
-      (score * 100).round
-    end
-  end
-end

data/lib/gems_bond/spy.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "gems_bond/gem"
-require "gems_bond/printer"
-
-module GemsBond
-  # Inspects gems and outputs the result
-  class Spy
-    RETRIES = 2
-
-    def call
-      chrono do
-        fetch_gems
-        GemsBond::Printer.new(gems).call
-      end
-    end
-
-    def gems_count
-      @gems_count ||= gems.count
-    end
-
-    private
-
-    def chrono
-      start_at = Time.now
-      yield
-      seconds = Time.now - start_at
-      time_per_gem_text = "#{(seconds / Float(gems_count)).round(2)} second(s) per gem"
-      puts "\nIt took #{seconds} second(s) to spy #{gems_count} gem(s) (#{time_per_gem_text})."
-    end
-
-    def gems
-      @gems ||=
-        Bundler.load.current_dependencies.map do |dependency|
-          GemsBond::Gem.new(dependency)
-        end
-    end
-
-    def fetch_gems
-      puts "Fetching data for..."
-      gems.each_slice(100) do |batch|
-        threads = []
-        batch.each do |gem|
-          threads << gem_thread(gem)
-        end
-        threads.each(&:join)
-      end
-    end
-
-    def gem_thread(gem)
-      Thread.new do
-        begin
-          retries ||= 0
-          gem.fetch_all(verbose: true)
-        # rescue SocketError, Faraday::ConnectionFailed...
-        rescue StandardError
-          (retries += 1) <= RETRIES ? retry : nil
-        end
-      end
-    end
-  end
-end