attractor 2.0.2 → 2.2.0

data/lib/attractor/cli.rb

@@ -1,95 +1,84 @@
 # 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 "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/detectors/base_detector.rb~

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

data/lib/attractor/duration_parser.rb

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

data/lib/attractor/duration_parser.rb~

@@ -0,0 +1,23 @@
+module Attractor
+class DurationParser
+  TOKENS = {
+    "m" => (60),
+    "h" => (60 * 60),
+    "d" => (60 * 60 * 24)
+  }
+
+  attr_reader :time
+
+  def initialize(input)
+    @input = input
+    @time = 0
+    parse
+  end
+
+  def parse
+    @input.scan(/(\d+)(\w)/).each do |amount, measure|
+      @time += 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,36 @@
 # 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 +41,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

data/lib/attractor/reporters/base_reporter.rb~

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "descriptive_statistics/safe"
+require "fileutils"
+require "forwardable"
+require "launchy"
+require "tilt"
+
+module Attractor
+  # base reporter
+  class BaseReporter
+    extend Forwardable
+    attr_accessor :file_prefix
+    attr_reader :types
+    attr_writer :values
+    def_delegator :@watcher, :watch
+
+    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, ignores, lambda do
+        report
+      end)
+    rescue NoMethodError => _e
+      raise "There was a problem gathering churn changes"
+    end
+
+    def suggestions(quantile:, type: "rb")
+      @suggester.values = values(type: type)
+      @suggestions = @suggester.suggest(quantile)
+      @suggestions
+    end
+
+    def report
+      @suggestions = @suggester.suggest
+      @types = Hash[@calculators.map { |calc| [calc.first, calc.last.type] }]
+    end
+
+    def render
+      "Attractor"
+    end
+
+    def values(type: "rb")
+      @values = @calculators[type].calculate
+      @values
+    rescue NoMethodError => _e
+      puts "No calculator for type #{type}"
+    end
+  end
+end

data/lib/attractor/reporters/console_reporter.rb

@@ -5,10 +5,10 @@ module Attractor
   class ConsoleReporter < BaseReporter
     def report
       super
-      puts 'Calculated churn and complexity'
+      puts "Calculated churn and complexity"
       puts
-      puts "file_path#{' ' * 53}complexity   churn"
-      puts '-' * 80
+      puts "file_path#{" " * 53}complexity   churn"
+      puts "-" * 80
 
       @calculators.each do |calc|
         # e.g. ['js', JsCalculator']
@@ -19,7 +19,7 @@ module Attractor
 
         puts values&.map(&:to_s)
         puts
-        puts 'Suggestions for refactorings:'
+        puts "Suggestions for refactorings:"
         suggester.suggest&.each { |sug| puts sug.file_path }
         puts
       end

data/lib/attractor/reporters/console_reporter.rb~

@@ -0,0 +1,21 @@
+require 'base_reporter'
+
+module Attractor
+  # console reporter
+  class ConsoleReporter < BaseReporter
+    def report
+      super
+      puts 'Calculated churn and complexity'
+      puts
+      puts "file_path#{' ' * 53}complexity   churn"
+      puts '-' * 80
+
+      puts @values.map(&:to_s)
+
+      puts
+      puts 'Suggestions for refactorings:'
+      @suggestions.each { |sug| puts sug.file_path }
+      puts
+    end
+  end
+end

data/lib/attractor/reporters/html_reporter.rb

@@ -6,29 +6,28 @@ module Attractor
     def report
       super
 
-      puts 'Generating an HTML report'
+      puts "Generating an HTML report"
       @serve_static = true
 
-      FileUtils.mkdir_p './attractor_output'
-      FileUtils.mkdir_p './attractor_output/stylesheets'
-      FileUtils.mkdir_p './attractor_output/images'
-      FileUtils.mkdir_p './attractor_output/javascripts'
+      FileUtils.mkdir_p "./attractor_output"
+      FileUtils.mkdir_p "./attractor_output/stylesheets"
+      FileUtils.mkdir_p "./attractor_output/images"
+      FileUtils.mkdir_p "./attractor_output/javascripts"
 
-      File.open('./attractor_output/images/attractor_logo.svg', 'w') { |file| file.write(logo) }
-      File.open('./attractor_output/images/attractor_favicon.png', 'w') { |file| file.write(favicon) }
-      File.open('./attractor_output/stylesheets/main.css', 'w') { |file| file.write(css) }
-      File.open('./attractor_output/javascripts/index.pack.js', 'w') { |file| file.write(javascript_pack) }
+      File.open("./attractor_output/images/attractor_logo.svg", "w") { |file| file.write(logo) }
+      File.open("./attractor_output/images/attractor_favicon.png", "w") { |file| file.write(favicon) }
+      File.open("./attractor_output/stylesheets/main.css", "w") { |file| file.write(css) }
+      File.open("./attractor_output/javascripts/index.pack.js", "w") { |file| file.write(javascript_pack) }
 
       if @calculators.size > 1
         @calculators.each do |calc|
           @short_type = calc.first
-          @values = calc.last.calculate
-          suggester = Suggester.new(values)
+          suggester = Suggester.new(values(type: @short_type))
           @suggestions = suggester.suggest
 
-          File.open("./attractor_output/javascripts/index.#{@short_type}.js", 'w') { |file| file.write(javascript) }
-          File.open("./attractor_output/index.#{@short_type}.html", 'w') { |file| file.write(render) }
-          puts "Generated HTML report at #{File.expand_path './attractor_output/'}/index.#{@short_type}.html"
+          File.open("./attractor_output/javascripts/index.#{@short_type}.js", "w") { |file| file.write(javascript) }
+          File.open("./attractor_output/index.#{@short_type}.html", "w") { |file| file.write(render) }
+          puts "Generated HTML report at #{File.expand_path "./attractor_output/"}/index.#{@short_type}.html"
         end
 
         if @open_browser
@@ -36,41 +35,40 @@ module Attractor
           puts "Opening browser window..."
         end
       else
-        File.open('./attractor_output/javascripts/index.js', 'w') { |file| file.write(javascript) }
-        File.open('./attractor_output/index.html', 'w') { |file| file.write(render) }
-        puts "Generated HTML report at #{File.expand_path './attractor_output/index.html'}"
+        File.open("./attractor_output/javascripts/index.js", "w") { |file| file.write(javascript) }
+        File.open("./attractor_output/index.html", "w") { |file| file.write(render) }
+        puts "Generated HTML report at #{File.expand_path "./attractor_output/index.html"}"
 
         if @open_browser
-          Launchy.open(File.expand_path('./attractor_output/index.html'))
+          Launchy.open(File.expand_path("./attractor_output/index.html"))
           puts "Opening browser window..."
         end
       end
-
     end
 
     def logo
-      File.read(File.expand_path('../../../app/assets/images/attractor_logo.svg', __dir__))
+      File.read(File.expand_path("../../../app/assets/images/attractor_logo.svg", __dir__))
     end
 
     def favicon
-      File.read(File.expand_path('../../../app/assets/images/attractor_favicon.png', __dir__))
+      File.read(File.expand_path("../../../app/assets/images/attractor_favicon.png", __dir__))
     end
 
     def css
-      File.read(File.expand_path('../../../app/assets/stylesheets/main.css', __dir__))
+      File.read(File.expand_path("../../../app/assets/stylesheets/main.css", __dir__))
     end
 
     def javascript_pack
-      File.read(File.expand_path('../../../app/assets/javascripts/index.pack.js', __dir__))
+      File.read(File.expand_path("../../../app/assets/javascripts/index.pack.js", __dir__))
     end
 
     def javascript
-      template = Tilt.new(File.expand_path('../../../app/assets/javascripts/index.js.erb', __dir__))
+      template = Tilt.new(File.expand_path("../../../app/assets/javascripts/index.js.erb", __dir__))
       template.render self
     end
 
     def render
-      template = Tilt.new(File.expand_path('../../../app/views/index.html.erb', __dir__))
+      template = Tilt.new(File.expand_path("../../../app/views/index.html.erb", __dir__))
       template.render self
     end
   end