attractor 2.0.3 → 2.3.0

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

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

@@ -0,0 +1,48 @@
+module Attractor
+  # HTML reporter
+  class HtmlReporter < BaseReporter
+    def report
+      super
+
+      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'
+
+      File.open('./attractor_output/images/attractor_logo.svg', 'w') { |file| file.write(logo) }
+      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'}"
+
+      Launchy.open(File.expand_path('./attractor_output/index.html'))
+    end
+
+    def logo
+      File.read(File.expand_path('../../../app/assets/images/attractor_logo.svg', __dir__))
+    end
+
+    def css
+      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__))
+    end
+
+    def javascript
+      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.render self
+    end
+  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,30 +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
-      @reporter.suggestions(threshold).to_json
+      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
 
@@ -47,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
 
@@ -62,20 +63,13 @@ 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
 
       Rack::Handler::WEBrick.run Rack::LiveReload.new(app), Port: 7890
     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/suggester.rb

@@ -3,6 +3,8 @@
 module Attractor
   # makes suggestions for refactorings
   class Suggester
+    attr_accessor :values
+
     def initialize(values)
       @values = values || []
     end
@@ -13,7 +15,7 @@ module Attractor
       quantile = products.percentile(threshold.to_i)
 
       @values.select { |val| val.churn * val.complexity > quantile }
-             .sort_by { |val| val.churn * val.complexity }.reverse
+        .sort_by { |val| val.churn * val.complexity }.reverse
     end
   end
 end

data/lib/attractor/tmp/churn/9f86bc9b7ec6bf59cbf7a111ce8b1159ae128347.json

@@ -0,0 +1 @@
+{"churn":{"changes":[{"file_path":"app/assets/javascripts/index.pack.js","times_changed":21},{"file_path":"src/javascript/functions.js","times_changed":16},{"file_path":"src/javascript/index.js","times_changed":4}],"class_churn":[],"method_churn":[],"changed_files":[".gitignore","Rakefile","attractor.gemspec","lib/attractor.rb","lib/attractor/calculators/js_calculator.rb","lib/attractor/cli.rb","src/javascript/calculator/index.js","src/javascript/calculator/package-lock.json","src/javascript/calculator/package.json","src/javascript/calculator/webpack.config.js"],"changed_classes":[],"changed_methods":[]}}

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,16 @@ module Attractor
       @history = history
     end
 
+    def current_commit
+      history&.first&.first
+    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/value.rb~

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+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: [])
+      @file_path = file_path
+      @churn = churn
+      @complexity = complexity
+      @details = details
+      @history = history
+    end
+
+    def to_s
+      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}
+    end
+
+    def to_json(_opt)
+      to_h.to_json
+    end
+  end
+end

data/lib/attractor/version.rb

@@ -1,3 +1,3 @@
 module Attractor
-  VERSION = "2.0.3"
+  VERSION = "2.3.0"
 end

data/lib/attractor/watcher.rb

@@ -1,19 +1,23 @@
 # frozen_string_literal: true
 
+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_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