attractor 1.0.2 → 2.0.1

data/attractor.gemspec

@@ -28,7 +28,10 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(src|tmp|test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(src|tmp|test|spec|features|\.github)/}) ||
+        %w[.all-contributorsrc .rspec .rspec_status .travis.yml].include?(f)
+    end
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -45,6 +48,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'tilt'
 
   spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'attractor-javascript'
+  spec.add_development_dependency 'attractor-ruby'
   spec.add_development_dependency 'autoprefixer-rails'
   spec.add_development_dependency 'bootstrap', '~> 4.3.1'
   spec.add_development_dependency 'bundler', '~> 2.0'
@@ -55,5 +60,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'sassc'
+  spec.add_development_dependency 'standard'
   spec.add_development_dependency 'structured_changelog'
 end

data/bin/test

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+echo "== Running Specs =="
+bundle exec rspec
+echo "== Running Cucumber Features =="
+bundle exec cucumber

data/lib/attractor.rb

@@ -1,29 +1,44 @@
 # frozen_string_literal: true
 
 require 'attractor/version'
+require 'attractor/gem_names'
+require 'attractor/duration_parser'
 require 'attractor/calculators/base_calculator'
-require 'attractor/calculators/ruby_calculator'
-require 'attractor/calculators/js_calculator'
+require 'attractor/detectors/base_detector'
 require 'attractor/reporters/base_reporter'
-require 'attractor/reporters/console_reporter'
-require 'attractor/reporters/html_reporter'
-require 'attractor/reporters/sinatra_reporter'
 require 'attractor/suggester'
 require 'attractor/watcher'
 
+Dir[File.join(__dir__, 'attractor', 'reporters', '*.rb')].each do |file|
+  next if file.start_with?('base')
+
+  require file
+end
+
 module Attractor
   class Error < StandardError; end
 
-  def calculators_for_type(type, file_prefix)
-    case type
-    when 'js'
-      { 'js' => JsCalculator.new(file_prefix: file_prefix) }
-    when 'rb'
-      { 'rb' => RubyCalculator.new(file_prefix: file_prefix) }
-    else
-      { 'rb' => RubyCalculator.new(file_prefix: file_prefix), 'js' => JsCalculator.new(file_prefix: file_prefix)}
-    end
+  @registry_entries = {}
+
+  def register(registry_entry)
+    @registry_entries[registry_entry.type] = registry_entry
+  end
+
+  def calculators_for_type(type, **options)
+    registry_entry_for_type = @registry_entries[type]
+
+    return { type => registry_entry_for_type.calculator_class.new(**options) } if type
+
+    
+    Hash[@registry_entries.map do |type, entry|
+      [type, entry.calculator_class.new(**options)] if entry.detector_class.new.detect
+    end]
   end
 
   module_function :calculators_for_type
+  module_function :register
+end
+
+Attractor::GemNames.new.to_a.each do |gem_name|
+  require "attractor/#{gem_name}"
 end

data/lib/attractor/calculators/base_calculator.rb

@@ -7,10 +7,13 @@ require 'attractor/value'
 module Attractor
   # calculates churn and complexity
   class BaseCalculator
-    def initialize(file_prefix: '', file_extension: 'rb', minimum_churn_count: 3)
+    attr_reader :type
+
+    def initialize(file_prefix: '', 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
     end
 
     def calculate
@@ -18,7 +21,7 @@ module Attractor
         file_extension: @file_extension,
         file_prefix: @file_prefix,
         minimum_churn_count: @minimum_churn_count,
-        start_date: Date.today - 365 * 5
+        start_date: @start_date
       ).report(false)
 
       churn[:churn][:changes].map do |change|

data/lib/attractor/cli.rb

@@ -7,43 +7,56 @@ 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]]
+
+    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'
-    option :file_prefix, aliases: :p
-    option :watch, aliases: :w, type: :boolean
-    option :type, aliases: :t
+    shared_options.each do |shared_option|
+      option(*shared_option)
+    end
     def calc
       file_prefix = options[:file_prefix]
-      calculators = Attractor.calculators_for_type(options[:type], file_prefix)
       if options[:watch]
         puts 'Listening for file changes...'
-        Attractor::ConsoleReporter.new(file_prefix: file_prefix, calculators: calculators).watch
+        Attractor::ConsoleReporter.new(file_prefix: file_prefix, calculators: calculators(options)).watch
       else
-        Attractor::ConsoleReporter.new(file_prefix: file_prefix, calculators: calculators).report
+        Attractor::ConsoleReporter.new(file_prefix: file_prefix, calculators: calculators(options)).report
       end
     rescue RuntimeError => e
       puts "Runtime error: #{e.message}"
     end
 
     desc 'report', 'Generates an HTML report'
-    option :format, aliases: :f, default: 'html'
-    option :file_prefix, aliases: :p
-    option :watch, aliases: :w, type: :boolean
-    option :type, aliases: :t
-    option :no_open_browser, type: :boolean
-    option :ci, type: :boolean
+    (shared_options + advanced_options).each do |option|
+      option(*option)
+    end
     def report
       file_prefix = options[:file_prefix]
-      calculators = Attractor.calculators_for_type(options[:type], file_prefix)
-      open_browser = !(options[:no_open_browser] || options[:ci]) 
+      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, open_browser: open_browser).watch
+        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, open_browser: open_browser).report
+          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, open_browser: open_browser).report
+          Attractor::HtmlReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).report
         end
       end
     rescue RuntimeError => e
@@ -51,27 +64,32 @@ module Attractor
     end
 
     desc 'serve', 'Serves the report on localhost'
-    option :format, aliases: :f, default: 'html'
-    option :file_prefix, aliases: :p
-    option :watch, aliases: :w, type: :boolean
-    option :type, aliases: :t
-    option :no_open_browser, type: :boolean
-    option :ci, type: :boolean
+    (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]) 
-      calculators = Attractor.calculators_for_type(options[:type], 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, open_browser: open_browser).watch
+        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, open_browser: open_browser).report
+          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, open_browser: open_browser).report
+          Attractor::SinatraReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).report
         end
       end
     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])
+    end
   end
 end

data/lib/attractor/detectors/base_detector.rb

@@ -0,0 +1,7 @@
+module Attractor
+  class BaseDetector
+    def detect
+      raise NotImplementedError
+    end
+  end
+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

@@ -0,0 +1,16 @@
+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
+    end
+
+    private
+
+    def gems
+      Gem::Specification.find_all.select do |gem|
+        gem.name =~ /^attractor-/
+      end
+    end
+  end
+end

data/lib/attractor/registry_entry.rb

@@ -0,0 +1,12 @@
+module Attractor
+  class RegistryEntry
+    attr_reader :type, :detector_class, :calculator_class
+
+    def initialize(type:, detector_class:, calculator_class:)
+      @type = type
+      @detector_class = detector_class
+      @calculator_class = calculator_class
+    end
+  end
+end
+

data/lib/attractor/reporters/base_reporter.rb

@@ -10,6 +10,7 @@ module Attractor
   class BaseReporter
     extend Forwardable
     attr_accessor :values, :file_prefix
+    attr_reader :types
     def_delegator :@watcher, :watch
 
     def initialize(file_prefix: '', calculators:, open_browser: true)
@@ -33,6 +34,7 @@ module Attractor
 
     def report
       @suggestions = @suggester.suggest
+      @types = Hash[@calculators.map { |calc| [calc.first, calc.last.type] }]
     end
 
     def render

data/lib/attractor/reporters/console_reporter.rb

@@ -10,12 +10,19 @@ module Attractor
       puts "file_path#{' ' * 53}complexity   churn"
       puts '-' * 80
 
-      puts @values&.map(&:to_s)
+      @calculators.each do |calc|
+        # e.g. ['js', JsCalculator']
+        puts calc.last.type
 
-      puts
-      puts 'Suggestions for refactorings:'
-      @suggestions&.each { |sug| puts sug.file_path }
-      puts
+        values = calc.last.calculate
+        suggester = Suggester.new(values)
+
+        puts values&.map(&:to_s)
+        puts
+        puts 'Suggestions for refactorings:'
+        suggester.suggest&.each { |sug| puts sug.file_path }
+        puts
+      end
     end
   end
 end

data/lib/attractor/reporters/html_reporter.rb

@@ -15,23 +15,47 @@ module Attractor
       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.js', 'w') { |file| file.write(javascript) }
       File.open('./attractor_output/javascripts/index.pack.js', 'w') { |file| file.write(javascript_pack) }
 
-      File.open('./attractor_output/index.html', 'w') { |file| file.write(render) }
-      puts "Generated HTML report at #{File.expand_path './attractor_output/index.html'}"
+      if @calculators.size > 1
+        @calculators.each do |calc|
+          @short_type = calc.first
+          @values = calc.last.calculate
+          suggester = Suggester.new(values)
+          @suggestions = suggester.suggest
 
-      if @open_browser
-        Launchy.open(File.expand_path('./attractor_output/index.html'))
-        puts "Opening browser window..."
+          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
+          Launchy.open(File.expand_path("./attractor_output/index.#{@calculators.first.first}.html"))
+          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'}"
+
+        if @open_browser
+          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__))
     end
 
+    def favicon
+      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__))
     end

data/lib/attractor/reporters/sinatra_reporter.rb

@@ -17,6 +17,7 @@ module Attractor
     set :show_exceptions, :after_handler
 
     get '/' do
+      @types = @reporter.types
       erb File.read(File.expand_path('../../../app/views/index.html.erb', __dir__))
     end
 
@@ -73,6 +74,8 @@ module Attractor
     def values(type: 'rb')
       @values = @calculators[type].calculate
       @values
+    rescue NoMethodError => e
+      puts "No calculator for type #{type}"
     end
   end
 end

data/lib/attractor/suggester.rb

@@ -4,7 +4,7 @@ module Attractor
   # makes suggestions for refactorings
   class Suggester
     def initialize(values)
-      @values = values
+      @values = values || []
     end
 
     def suggest(threshold = 95)

data/lib/attractor/version.rb

@@ -1,3 +1,3 @@
 module Attractor
-  VERSION = "1.0.2"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attractor
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.1
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-14 00:00:00.000000000 Z
+date: 2020-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: churn
@@ -150,6 +150,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: attractor-javascript
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: attractor-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: autoprefixer-rails
   requirement: !ruby/object:Gem::Requirement
@@ -290,6 +318,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: structured_changelog
   requirement: !ruby/object:Gem::Requirement
@@ -318,17 +360,15 @@ extra_rdoc_files: []
 files:
 - ".babelrc"
 - ".eslintrc.json"
-- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- app/assets/images/attractor_favicon.png
 - app/assets/images/attractor_logo.png
 - app/assets/images/attractor_logo.svg
 - app/assets/images/attractor_logo@2x.png
@@ -339,13 +379,16 @@ files:
 - attractor.gemspec
 - bin/console
 - bin/setup
+- bin/test
 - dist/calculator.bundle.js
 - exe/attractor
 - lib/attractor.rb
 - lib/attractor/calculators/base_calculator.rb
-- lib/attractor/calculators/js_calculator.rb
-- lib/attractor/calculators/ruby_calculator.rb
 - lib/attractor/cli.rb
+- lib/attractor/detectors/base_detector.rb
+- lib/attractor/duration_parser.rb
+- lib/attractor/gem_names.rb
+- lib/attractor/registry_entry.rb
 - lib/attractor/reporters/.keep
 - lib/attractor/reporters/base_reporter.rb
 - lib/attractor/reporters/console_reporter.rb