attractor 2.0.3 → 2.3.0

data/lib/attractor/calculators/base_calculator.rb~

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "churn/calculator"
+
+require "attractor/value"
+
+module Attractor
+  # calculates churn and complexity
+  class BaseCalculator
+    attr_reader :type
+
+    def initialize(file_prefix: "", ignores: "", file_extension: "rb", minimum_churn_count: 3, start_ago: "5y")
+      @file_prefix = file_prefix
+      @file_extension = file_extension
+      @minimum_churn_count = minimum_churn_count
+      @start_date = Date.today - Attractor::DurationParser.new(start_ago).duration
+      @ignores = ignores
+    end
+
+    def calculate
+      churn = ::Churn::ChurnCalculator.new(
+        file_extension: @file_extension,
+        file_prefix: @file_prefix,
+        minimum_churn_count: @minimum_churn_count,
+        start_date: @start_date,
+        ignores: @ignores
+      ).report(false)
+
+      churn[:churn][:changes].map do |change|
+        history = git_history_for_file(file_path: change[:file_path])
+        commit = history&.first&.first
+
+        cached_value = Cache.read(file_path: change[:file_path])
+
+        if !cached_value.nil? && !cached_value.current_commit.nil? && cached_value.current_commit == commit
+          value = cached_value
+        else
+          complexity, details = yield(change)
+
+          value = Value.new(file_path: change[:file_path],
+                            churn: change[:times_changed],
+                            complexity: complexity,
+                            details: details,
+                            history: history)
+          Cache.write(file_path: change[:file_path], value: value)
+        end
+
+        value
+      end
+    end
+
+    private
+
+    def git_history_for_file(file_path:, limit: 10)
+      history = `git log --oneline -n #{limit} -- #{file_path}`
+      history.split("\n")
+        .map do |log_entry|
+        log_entry.partition(/\A(\S+)\s/)
+          .map(&:strip)
+          .reject(&:empty?)
+      end
+    end
+  end
+end

data/lib/attractor/cli.rb

@@ -1,95 +1,99 @@
 # frozen_string_literal: true
 
-require 'thor'
+require "thor"
 
-require 'attractor'
+require "attractor"
 
 module Attractor
   # contains methods implementing the CLI
   class CLI < Thor
     shared_options = [[:file_prefix, aliases: :p],
-                      [:watch, aliases: :w, type: :boolean],
-                      [:minimum_churn, aliases: :c, type: :numeric, default: 3],
-                      [:start_ago, aliases: :s, type: :string, default: '5y'],
-                      [:type, aliases: :t]]
+      [:ignore, aliases: :i, default: ""],
+      [:watch, aliases: :w, type: :boolean],
+      [:minimum_churn, aliases: :c, type: :numeric, default: 3],
+      [:start_ago, aliases: :s, type: :string, default: "5y"],
+      [:type, aliases: :t]]
 
-    advanced_options = [[:format, aliases: :f, default: 'html'],
-                        [:no_open_browser, type: :boolean],
-                        [:ci, type: :boolean]]
+    advanced_options = [[:format, aliases: :f, default: "html"],
+      [:no_open_browser, type: :boolean],
+      [:ci, type: :boolean]]
 
     desc "version", "Prints Attractor's version information"
-    map %w(-v --version) => :version
+    map %w[-v --version] => :version
     def version
       puts "Attractor version #{Attractor::VERSION}"
     rescue RuntimeError => e
       puts "Runtime error: #{e.message}"
     end
 
-    desc 'calc', 'Calculates churn and complexity for all ruby files in current directory'
+    desc "clean", "Clears attractor's cache"
+    def clean
+      puts "Clearing attractor cache"
+      Attractor.clear
+    end
+
+    desc "init", "Initializes attractor's cache"
+    shared_options.each do |shared_option|
+      option(*shared_option)
+    end
+    def init
+      puts "Warming attractor cache"
+      Attractor.init(calculators(options))
+    end
+
+    desc "calc", "Calculates churn and complexity for all ruby files in current directory"
     shared_options.each do |shared_option|
       option(*shared_option)
     end
     def calc
       file_prefix = options[:file_prefix]
-      if options[:watch]
-        puts 'Listening for file changes...'
-        Attractor::ConsoleReporter.new(file_prefix: file_prefix, calculators: calculators(options)).watch
-      else
-        Attractor::ConsoleReporter.new(file_prefix: file_prefix, calculators: calculators(options)).report
-      end
+
+      report! Attractor::ConsoleReporter.new(file_prefix: file_prefix, ignores: options[:ignore], calculators: calculators(options))
     rescue RuntimeError => e
       puts "Runtime error: #{e.message}"
     end
 
-    desc 'report', 'Generates an HTML report'
+    desc "report", "Generates an HTML report"
     (shared_options + advanced_options).each do |option|
       option(*option)
     end
     def report
       file_prefix = options[:file_prefix]
       open_browser = !(options[:no_open_browser] || options[:ci])
-      if options[:watch]
-        puts 'Listening for file changes...'
-        Attractor::HtmlReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).watch
-      else
-        case options[:format]
-        when 'html'
-          Attractor::HtmlReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).report
-        else
-          Attractor::HtmlReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).report
-        end
-      end
+
+      report! Attractor::HtmlReporter.new(file_prefix: file_prefix, ignores: options[:ignore], calculators: calculators(options), open_browser: open_browser)
     rescue RuntimeError => e
       puts "Runtime error: #{e.message}"
     end
 
-    desc 'serve', 'Serves the report on localhost'
+    desc "serve", "Serves the report on localhost"
     (shared_options + advanced_options).each do |option|
       option(*option)
     end
     def serve
       file_prefix = options[:file_prefix]
       open_browser = !(options[:no_open_browser] || options[:ci])
-      if options[:watch]
-        puts 'Listening for file changes...'
-        Attractor::SinatraReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).watch
-      else
-        case options[:format]
-        when 'html'
-          Attractor::SinatraReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).report
-        else
-          Attractor::SinatraReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).report
-        end
-      end
+
+      report! Attractor::SinatraReporter.new(file_prefix: file_prefix, ignores: options[:ignore], calculators: calculators(options), open_browser: open_browser)
     end
 
     private
 
     def calculators(options)
       Attractor.calculators_for_type(options[:type],
-                                     file_prefix: options[:file_prefix],
-                                     minimum_churn_count: options[:minimum_churn],
-                                     start_ago: options[:start_ago])
+        file_prefix: options[:file_prefix],
+        minimum_churn_count: options[:minimum_churn],
+        ignores: options[:ignore],
+        start_ago: options[:start_ago])
+    end
+
+    def report!(reporter)
+      if options[:watch]
+        puts "Listening for file changes..."
+        reporter.watch
+      else
+        reporter.report
+      end
     end
   end
 end

data/lib/attractor/cli.rb~

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "thor"
+
+require "attractor"
+
+module Attractor
+  # contains methods implementing the CLI
+  class CLI < Thor
+    shared_options = [[:file_prefix, aliases: :p],
+      [:ignore, aliases: :i, default: ""],
+      [:watch, aliases: :w, type: :boolean],
+      [:minimum_churn, aliases: :c, type: :numeric, default: 3],
+      [:start_ago, aliases: :s, type: :string, default: "5y"],
+      [:type, aliases: :t]]
+
+    advanced_options = [[:format, aliases: :f, default: "html"],
+      [:no_open_browser, type: :boolean],
+      [:ci, type: :boolean]]
+
+    desc "version", "Prints Attractor's version information"
+    map %w[-v --version] => :version
+    def version
+      puts "Attractor version #{Attractor::VERSION}"
+    rescue RuntimeError => e
+      puts "Runtime error: #{e.message}"
+    end
+
+    desc "calc", "Calculates churn and complexity for all ruby files in current directory"
+    shared_options.each do |shared_option|
+      option(*shared_option)
+    end
+    def calc
+      file_prefix = options[:file_prefix]
+
+      report! Attractor::ConsoleReporter.new(file_prefix: file_prefix, ignores: options[:ignore], calculators: calculators(options))
+    rescue RuntimeError => e
+      puts "Runtime error: #{e.message}"
+    end
+
+    desc "report", "Generates an HTML report"
+    (shared_options + advanced_options).each do |option|
+      option(*option)
+    end
+    def report
+      file_prefix = options[:file_prefix]
+      open_browser = !(options[:no_open_browser] || options[:ci])
+
+      report! Attractor::HtmlReporter.new(file_prefix: file_prefix, ignores: options[:ignore], calculators: calculators(options), open_browser: open_browser)
+    rescue RuntimeError => e
+      puts "Runtime error: #{e.message}"
+    end
+
+    desc "serve", "Serves the report on localhost"
+    (shared_options + advanced_options).each do |option|
+      option(*option)
+    end
+    def serve
+      file_prefix = options[:file_prefix]
+      open_browser = !(options[:no_open_browser] || options[:ci])
+
+      report! Attractor::SinatraReporter.new(file_prefix: file_prefix, ignores: options[:ignore], calculators: calculators(options), open_browser: open_browser)
+    end
+
+    private
+
+    def calculators(options)
+      Attractor.calculators_for_type(options[:type],
+        file_prefix: options[:file_prefix],
+        minimum_churn_count: options[:minimum_churn],
+        ignores: options[:ignore],
+        start_ago: options[:start_ago])
+    end
+
+    def report!(reporter)
+      if options[:watch]
+        puts "Listening for file changes..."
+        reporter.watch
+      else
+        reporter.report
+      end
+    end
+  end
+end

data/lib/attractor/detectors/base_detector.rb~

@@ -0,0 +1,4 @@
+module Attractor
+  class BaseDetector
+  end
+end

data/lib/attractor/duration_parser.rb

@@ -4,17 +4,19 @@ module Attractor
   # converts a duration string into an amount of days
   class DurationParser
     TOKENS = {
-      'd' => 1,
-      'w' => 7,
-      'm' => 30,
-      'y' => 365
+      "d" => 1,
+      "w" => 7,
+      "m" => 30,
+      "y" => 365
     }.freeze
 
     attr_reader :duration
 
     def initialize(input)
       @input = input
-      @duration = 0
+      @duration = @input.is_a?(Numeric) ? @input : 0
+      return if @duration > 0
+
       parse
     end
 

data/lib/attractor/duration_parser.rb~

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Attractor
+  # converts a duration string into an amount of days
+  class DurationParser
+    TOKENS = {
+      "d" => 1,
+      "w" => 7,
+      "m" => 30,
+      "y" => 365
+    }.freeze
+
+    attr_reader :duration
+
+    def initialize(input)
+      @input = input
+      @duration = 0
+      parse
+    end
+
+    def parse
+      @input.scan(/(\d+)(\w)/).each do |amount, measure|
+        @duration += amount.to_i * TOKENS[measure]
+      end
+    end
+  end
+end

data/lib/attractor/gem_names.rb

@@ -2,7 +2,7 @@ module Attractor
   # from https://github.com/prontolabs/pronto/blob/master/lib/pronto/gem_names.rb
   class GemNames
     def to_a
-      gems.map { |gem| gem.name.sub(/^attractor-/, '') }.uniq.sort
+      gems.map { |gem| gem.name.sub(/^attractor-/, "") }.uniq.sort
     end
 
     private
@@ -10,6 +10,8 @@ module Attractor
     def gems
       Gem::Specification.find_all.select do |gem|
         gem.name =~ /^attractor-/
+      end.reject do |gem|
+        gem.name =~ /attractor-rails/
       end
     end
   end

data/lib/attractor/gem_names.rb~

@@ -0,0 +1,23 @@
+module Attractor
+
+  # from https://github.com/prontolabs/pronto/blob/master/lib/pronto/gem_names.rb
+  class GemNames
+    def to_a
+      gems.map { |gem| gem.name.sub(/^pronto-/, '') }.uniq.sort
+    end
+
+    private
+
+    def gems
+      Gem::Specification.find_all.select do |gem|
+        if gem.name =~ /^pronto-/
+          true
+        elsif gem.name != 'pronto'
+          runner_path = File.join(gem.full_gem_path,
+                                  "lib/pronto/#{gem.name}.rb")
+          File.exist?(runner_path)
+        end
+      end
+    end
+  end
+end

data/lib/attractor/registry_entry.rb

@@ -9,4 +9,3 @@ module Attractor
     end
   end
 end
-

data/lib/attractor/registry_entry.rb~

@@ -0,0 +1,2 @@
+RegistryEntry = Struct.new :type, :detector, :calculator
+

data/lib/attractor/reporters/base_reporter.rb

@@ -1,34 +1,35 @@
 # frozen_string_literal: true
 
-require 'descriptive_statistics/safe'
-require 'fileutils'
-require 'forwardable'
-require 'launchy'
-require 'tilt'
+require "descriptive_statistics/safe"
+require "fileutils"
+require "forwardable"
+require "launchy"
+require "tilt"
 
 module Attractor
   # base reporter
   class BaseReporter
     extend Forwardable
-    attr_accessor :values, :file_prefix
+    attr_accessor :file_prefix
     attr_reader :types
+    attr_writer :values
     def_delegator :@watcher, :watch
 
-    def initialize(file_prefix: '', calculators:, open_browser: true)
-      @file_prefix = file_prefix
+    def initialize(calculators:, file_prefix: "", ignores: "", open_browser: true)
+      @file_prefix = file_prefix || ""
       @calculators = calculators
       @open_browser = open_browser
-      @values = @calculators.first.last.calculate
       @suggester = Suggester.new(values)
 
-      @watcher = Watcher.new(file_prefix, lambda do
+      @watcher = Watcher.new(@file_prefix, ignores, lambda do
         report
       end)
-    rescue NoMethodError => e
-      raise 'There was a problem gathering churn changes'
+    rescue NoMethodError => _e
+      raise "There was a problem gathering churn changes"
     end
 
-    def suggestions(quantile)
+    def suggestions(quantile:, type: "rb")
+      @suggester.values = values(type: type)
       @suggestions = @suggester.suggest(quantile)
       @suggestions
     end
@@ -39,7 +40,14 @@ module Attractor
     end
 
     def render
-      'Attractor'
+      "Attractor"
+    end
+
+    def values(type: "rb")
+      @values = @calculators[type].calculate
+      @values
+    rescue NoMethodError => _e
+      puts "No calculator for type #{type}"
     end
   end
 end