attractor 2.0.5 → 2.4.0

data/lib/attractor/reporters/html_reporter.rb

@@ -6,18 +6,18 @@ 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|
@@ -25,9 +25,9 @@ module Attractor
           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
@@ -35,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

data/lib/attractor/reporters/sinatra_reporter.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'rack/livereload'
-require 'rack'
-require 'sinatra/base'
+require "rack/livereload"
+require "rack"
+require "sinatra/base"
 
 module Attractor
   # skeleton sinatra app
@@ -13,31 +13,31 @@ module Attractor
     end
 
     enable :static
-    set :public_folder, File.expand_path('../../../app/assets', __dir__)
+    set :public_folder, File.expand_path("../../../app/assets", __dir__)
     set :show_exceptions, :after_handler
 
-    get '/' do
+    get "/" do
       @types = @reporter.types
-      erb File.read(File.expand_path('../../../app/views/index.html.erb', __dir__))
+      erb File.read(File.expand_path("../../../app/views/index.html.erb", __dir__))
     end
 
-    get '/file_prefix' do
-      { file_prefix: @reporter.file_prefix }.to_json
+    get "/file_prefix" do
+      {file_prefix: @reporter.file_prefix}.to_json
     end
 
-    get '/values' do
-      type = params[:type] || 'rb'
+    get "/values" do
+      type = params[:type] || "rb"
       @reporter.values(type: type).to_json
     end
 
-    get '/suggestions' do
+    get "/suggestions" do
       threshold = params[:t] || 95
-      type = params[:type] || 'rb'
+      type = params[:type] || "rb"
       @reporter.suggestions(quantile: threshold, type: type).to_json
     end
 
     error NoMethodError do
-      { error: env['sinatra.error'].message }.to_json
+      {error: env["sinatra.error"].message}.to_json
     end
   end
 
@@ -48,10 +48,10 @@ module Attractor
 
       app = AttractorApp.new(self)
 
-      puts 'Serving attractor at http://localhost:7890'
+      puts "Serving attractor at http://localhost:7890"
 
       if @open_browser
-        Launchy.open('http://localhost:7890') if @open_browser
+        Launchy.open("http://localhost:7890") if @open_browser
         puts "Opening browser window..."
       end
 
@@ -63,9 +63,9 @@ module Attractor
 
       app = AttractorApp.new(self)
 
-      puts 'Serving attractor at http://localhost:7890'
+      puts "Serving attractor at http://localhost:7890"
       if @open_browser
-        Launchy.open('http://localhost:7890')
+        Launchy.open("http://localhost:7890")
         puts "Opening browser window..."
       end
 

data/lib/attractor/suggester.rb

@@ -4,18 +4,18 @@ module Attractor
   # makes suggestions for refactorings
   class Suggester
     attr_accessor :values
-    
+
     def initialize(values)
       @values = values || []
     end
 
     def suggest(threshold = 95)
-      products = @values.map { |val| val.churn * val.complexity }
+      products = @values.map(&:score)
       products.extend(DescriptiveStatistics)
       quantile = products.percentile(threshold.to_i)
 
-      @values.select { |val| val.churn * val.complexity > quantile }
-             .sort_by { |val| val.churn * val.complexity }.reverse
+      @values.select { |val| val.score > quantile }
+        .sort_by { |val| val.score }.reverse
     end
   end
 end

data/lib/attractor/value.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
 module Attractor
   # holds a churn/complexity value
   class Value
     attr_reader :file_path, :churn, :complexity, :details, :history
 
-    def initialize(file_path: '', churn: 1, complexity: 0, details: [], history: [])
+    def initialize(file_path: "", churn: 1, complexity: 0, details: [], history: [])
       @file_path = file_path
       @churn = churn
       @complexity = complexity
@@ -15,12 +15,20 @@ module Attractor
       @history = history
     end
 
+    def current_commit
+      history&.first&.first
+    end
+
+    def score
+      @complexity * @churn
+    end
+
     def to_s
-      format('%-64s%8.1f%8i', @file_path, @complexity, @churn)
+      format("%-64s%8.1f%8i", @file_path, @complexity, @churn)
     end
 
     def to_h
-      { file_path: file_path, x: churn, y: complexity, details: details, history: history }
+      {file_path: file_path, x: churn, y: complexity, details: details, history: history}
     end
 
     def to_json(_opt)

data/lib/attractor/version.rb

@@ -1,3 +1,3 @@
 module Attractor
-  VERSION = "2.0.5"
+  VERSION = "2.4.0"
 end

data/lib/attractor/version.rb~

@@ -0,0 +1,7 @@
+module Attractor
+<<<<<<< HEAD
+  VERSION = "2.4.0"
+=======
+  VERSION = "2.3.0"
+>>>>>>> 1b4d274a6c7f6634ac4b6c2627f5de500788cef4
+end

data/lib/attractor/watcher.rb

@@ -5,17 +5,19 @@ require "listen"
 module Attractor
   # functionality for watching file system changes
   class Watcher
-    def initialize(file_prefix, callback)
+    def initialize(file_prefix, ignores, callback)
       @file_prefix = file_prefix
       @callback = callback
+      @ignores = ignores.split(",").map(&:strip)
     end
 
     def watch
       @callback.call
+      ignore = @ignores + [/^attractor_output/]
 
-      listener = Listen.to(File.absolute_path(@file_prefix), ignore: /^attractor_output/) do |modified, _added, _removed|
+      listener = Listen.to(File.absolute_path(@file_prefix), ignore: ignore) do |modified, _added, _removed|
         if modified
-          puts "#{modified.map(&:to_s).join(', ')} modified, recalculating..."
+          puts "#{modified.map(&:to_s).join(", ")} modified, recalculating..."
           @callback.call
         end
       end

data/lib/attractor.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
-require 'attractor/version'
-require 'attractor/gem_names'
-require 'attractor/duration_parser'
-require 'attractor/calculators/base_calculator'
-require 'attractor/detectors/base_detector'
-require 'attractor/reporters/base_reporter'
-require 'attractor/suggester'
-require 'attractor/watcher'
-
-Dir[File.join(__dir__, 'attractor', 'reporters', '*.rb')].each do |file|
-  next if file.start_with?('base')
+require "attractor/version"
+require "attractor/gem_names"
+require "attractor/duration_parser"
+require "attractor/calculators/base_calculator"
+require "attractor/detectors/base_detector"
+require "attractor/reporters/base_reporter"
+require "attractor/suggester"
+require "attractor/watcher"
+require "attractor/cache"
+
+Dir[File.join(__dir__, "attractor", "reporters", "*.rb")].sort.each do |file|
+  next if file.start_with?("base")
 
   require file
 end
@@ -20,6 +21,15 @@ module Attractor
 
   @registry_entries = {}
 
+  def init(calculators)
+    calculators ||= all_registered_calculators
+    calculators.to_a.map(&:last).each(&:calculate)
+  end
+
+  def clear
+    Cache.clear
+  end
+
   def register(registry_entry)
     @registry_entries[registry_entry.type] = registry_entry
   end
@@ -27,16 +37,22 @@ module Attractor
   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
+    return {type => registry_entry_for_type.calculator_class.new(**options)} if type
+
+    all_registered_calculators(**options)
+  end
 
-    
-    Hash[@registry_entries.map do |type, entry|
+  def all_registered_calculators(options = {})
+    @registry_entries.map do |type, entry|
       [type, entry.calculator_class.new(**options)] if entry.detector_class.new.detect
-    end.compact]
+    end.compact.to_h
   end
 
   module_function :calculators_for_type
+  module_function :all_registered_calculators
   module_function :register
+  module_function :init
+  module_function :clear
 end
 
 Attractor::GemNames.new.to_a.each do |gem_name|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attractor
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.4.0
 platform: ruby
 authors:
 - Julian Rubisch
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: churn
@@ -154,30 +154,30 @@ dependencies:
   name: attractor-javascript
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: attractor-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: autoprefixer-rails
   requirement: !ruby/object:Gem::Requirement
@@ -371,32 +371,22 @@ files:
 - app/views/index.html.erb
 - exe/attractor
 - lib/attractor.rb
-- lib/attractor.rb~
-- lib/attractor/#duration_parser.rb#
+- lib/attractor/cache.rb
 - lib/attractor/calculators/base_calculator.rb
-- lib/attractor/calculators/base_calculator.rb~
 - lib/attractor/cli.rb
 - lib/attractor/detectors/base_detector.rb
-- lib/attractor/detectors/base_detector.rb~
 - lib/attractor/duration_parser.rb
-- lib/attractor/duration_parser.rb~
 - lib/attractor/gem_names.rb
-- lib/attractor/gem_names.rb~
 - lib/attractor/registry_entry.rb
-- lib/attractor/registry_entry.rb~
 - lib/attractor/reporters/base_reporter.rb
-- lib/attractor/reporters/base_reporter.rb~
 - lib/attractor/reporters/console_reporter.rb
-- lib/attractor/reporters/console_reporter.rb~
 - lib/attractor/reporters/html_reporter.rb
-- lib/attractor/reporters/html_reporter.rb~
 - lib/attractor/reporters/sinatra_reporter.rb
 - lib/attractor/suggester.rb
-- lib/attractor/tmp/churn/9f86bc9b7ec6bf59cbf7a111ce8b1159ae128347.json
 - lib/attractor/value.rb
 - lib/attractor/version.rb
+- lib/attractor/version.rb~
 - lib/attractor/watcher.rb
-- lib/attractor/watcher.rb~
 homepage: https://github.com/julianrubisch/attractor
 licenses:
 - MIT
@@ -405,7 +395,7 @@ metadata:
   source_code_uri: https://github.com/julianrubisch/attractor
   bug_tracker_uri: https://github.com/julianrubisch/attractor/issues
   changelog_uri: https://github.com/julianrubisch/attractor/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -421,7 +411,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Churn vs Complexity Chart Generator
 test_files: []

data/lib/attractor/#duration_parser.rb#

@@ -1,24 +0,0 @@
-module Attractor
-  class DurationParser
-    TOKENS = {
-      'd" => 1,
-      w" => 7,
-      m" => 30,
-      y" => 365
-    }
-
-    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/calculators/base_calculator.rb~

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require 'churn/calculator'
-require 'csv'
-require 'date'
-require 'flog'
-require 'listen'
-
-require 'attractor/value'
-
-module Attractor
-  # calculates churn and complexity
-  class BaseCalculator
-    def initialize(file_prefix: '', file_extension: 'rb', minimum_churn_count: 3)
-      @file_prefix = file_prefix
-      @file_extension = file_extension
-      @minimum_churn_count = minimum_churn_count
-    end
-
-    def calculate
-      churn = ::Churn::ChurnCalculator.new(
-        file_extension: @file_extension,
-        file_prefix: @file_prefix,
-        minimum_churn_count: @minimum_churn_count,
-        start_date: Date.today - 365 * 5
-      ).report(false)
-
-      churn[:churn][:changes].map do |change|
-        complexity, details = yield(change)
-        # flogger = Flog.new(all: true)
-        # flogger.flog(change[:file_path])
-        # complexity = flogger.total_score
-        # details = flogger.totals
-        Value.new(file_path: change[:file_path],
-                  churn: change[:times_changed],
-                  complexity: complexity,
-                  details: details,
-                  history: git_history_for_file(file_path: change[:file_path]))
-      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/detectors/base_detector.rb~

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

data/lib/attractor/duration_parser.rb~

@@ -1,23 +0,0 @@
-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~

@@ -1,23 +0,0 @@
-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~

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

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

@@ -1,54 +0,0 @@
-# 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(file_prefix: '', calculators:, 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
-        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~

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