attractor 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1b66250e293edf3d4298ee78c92a928b92128d0f8525a012ba4c99b8e16a77e
-  data.tar.gz: 354068cdc6c91978e80e3860ac65255811daf364d64c15dcd7221db2bac79f22
+  metadata.gz: 31bd7aa261b4e29b98a2a0af93e653d6dac08d0187505b57ff6df1dc60ad37c4
+  data.tar.gz: 602324b18e247c6410f9d6206b089c0ae11cfe2d6a99feb5d0a0cf3d9a77f88e
 SHA512:
-  metadata.gz: 456416f564b3e7e5efa7874f901fea6a0c26c23e59bf157dd5c78cb58014f4bcee58f0172cebdc83061d94195d94631e1818eba905835799e1664527fc26caa9
-  data.tar.gz: 472072d37700e794de8ee98d48f2252186598f709094c9046acc97deb91ef34dfbc089a4c7b70f0965ce8fc4621877c63d41a167f4d2968f2b734b9f5e4e18de
+  metadata.gz: 04a0fb63d5f198b8a5f412615e0fcc48ccb3cf6ee89edc1448ce0213cd9bc5f224bd4d435bf1c114c19789461cc6d4ccea13f55dc7cd39a6132bc0fe3d388342
+  data.tar.gz: bb2aa36a13ca5a1615853e6eb29bc13e2f5b49e46e18242fc10ef78ea4d57cd5dbbd5ed2c9bd01e5139c191a36d61ff5d7ca5f1645bcdce98783c194740425a1

data/README.md

@@ -10,7 +10,6 @@
 [license-url]: https://github.com/julianrubisch/attractor/blob/master/LICENSE
 [twitter-url]: https://twitter.com/AttractorGem
 [twitter-shield]: https://img.shields.io/twitter/follow/AttractorGem?style=social
-[build-status]: https://travis-ci.org/julianrubisch/attractor.svg?branch=master
 [twitter-shield]: https://img.shields.io/twitter/follow/AttractorGem?style=social
 [ruby-tests-action-shield]: https://github.com/julianrubisch/attractor/workflows/Ruby%20Tests/badge.svg
 <!-- Media -->
@@ -39,7 +38,6 @@
 ---
 
 <!-- PROJECT SHIELDS -->
-![Build Status][build-status]
 ![Ruby Tests Action Status][ruby-tests-action-shield]
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]

data/Rakefile

@@ -25,7 +25,7 @@ task :assets do
   sass = File.read(File.expand_path("./src/stylesheets/main.scss"))
   css = SassC::Engine.new(sass, style: :compressed).render
   prefixed = AutoprefixerRails.process(css)
-  File.open(File.expand_path("./app/assets/stylesheets/main.css"), "w") { |file| file.write(prefixed) }
+  File.write(File.expand_path("./app/assets/stylesheets/main.css"), prefixed)
 
   npm_output = `npm run build`
   puts npm_output

data/lib/attractor/calculators/base_calculator.rb

@@ -9,12 +9,13 @@ module Attractor
   class BaseCalculator
     attr_reader :type
 
-    def initialize(file_prefix: "", ignores: "", file_extension: "rb", minimum_churn_count: 3, start_ago: "5y")
+    def initialize(file_prefix: "", ignores: "", file_extension: "rb", minimum_churn_count: 3, start_ago: "5y", verbose: false)
       @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
+      @verbose = verbose
     end
 
     def calculate
@@ -26,7 +27,7 @@ module Attractor
         ignores: @ignores
       ).report(false)
 
-      puts "Calculating churn and complexity values for #{churn[:churn][:changes].size} #{type} files"
+      puts "Calculating churn and complexity values for #{churn[:churn][:changes].size} #{type} files" if @verbose
 
       values = churn[:churn][:changes].map do |change|
         history = git_history_for_file(file_path: change[:file_path])
@@ -47,13 +48,13 @@ module Attractor
           Cache.write(file_path: change[:file_path], value: value)
         end
 
-        print "."
+        print "." if @verbose
         value
       end
 
       Cache.persist!
 
-      print "\n\n"
+      print "\n\n" if @verbose
 
       values
     end

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

@@ -0,0 +1,73 @@
+# 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)
+
+      puts "Calculating churn and complexity values for #{churn[:churn][:changes].size} #{type} files"
+
+      values = 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
+
+        print "."
+        value
+      end
+
+      Cache.persist!
+
+      print "\n\n"
+
+      values
+    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

@@ -8,6 +8,7 @@ module Attractor
   # contains methods implementing the CLI
   class CLI < Thor
     shared_options = [[:file_prefix, aliases: :p],
+      [:verbose, aliases: :v, type: :boolean],
       [:ignore, aliases: :i, default: ""],
       [:watch, aliases: :w, type: :boolean],
       [:minimum_churn, aliases: :c, type: :numeric, default: 3],
@@ -86,7 +87,8 @@ module Attractor
         file_prefix: options[:file_prefix],
         minimum_churn_count: options[:minimum_churn],
         ignores: options[:ignore],
-        start_ago: options[:start_ago])
+        start_ago: options[:start_ago],
+        verbose: options[:verbose])
     end
 
     def report!(reporter)

data/lib/attractor/cli.rb~

@@ -0,0 +1,101 @@
+# 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 "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
+    option(:format, aliases: :f, default: :table)
+    def calc
+      file_prefix = options[:file_prefix]
+      output_format = options[:format]
+
+      report! Attractor::ConsoleReporter.new(file_prefix: file_prefix, ignores: options[:ignore], calculators: calculators(options), format: output_format)
+    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/reporters/base_reporter.rb

@@ -19,7 +19,7 @@ module Attractor
       @file_prefix = file_prefix || ""
       @calculators = calculators
       @open_browser = open_browser
-      @suggester = Suggester.new(values)
+      @suggester = Suggester.new
 
       @watcher = Watcher.new(@file_prefix, ignores, lambda do
         report

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

@@ -0,0 +1,53 @@
+# 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
+      @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 = @calculators.map { |calc| [calc.first, calc.last.type] }.to_h
+    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

@@ -49,13 +49,42 @@ module Attractor
       end
     end
 
+    class JSONFormatter
+      def call(calculators)
+        result = calculators.map do |calc|
+          type = calc.last.type
+          values = calc.last.calculate
+          suggester = Suggester.new(values)
+          to_be_refactored = suggester.suggest.map(&:file_path)
+
+          [
+            type, values.map do |value|
+              {
+                file_path: value.file_path,
+                score: value.score,
+                complexity: value.complexity,
+                churn: value.churn,
+                refactor: to_be_refactored.include?(value.file_path),
+                details: value.details,
+                history: value.history
+              }
+            end
+          ]
+        end
+
+        puts result.to_h.to_json
+      end
+    end
+
     def initialize(format:, **other)
       super(**other)
       @formatter = case format.to_sym
-                   when :csv
-                     CSVFormatter.new
-                   else
-                     TableFormatter.new
+      when :csv
+        CSVFormatter.new
+      when :json
+        JSONFormatter.new
+      else
+        TableFormatter.new
       end
     end
 

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Attractor
+  # console reporter
+  class ConsoleReporter < BaseReporter
+    class TableFormatter
+      def call(calculators)
+        puts "Calculated churn and complexity"
+        puts
+        puts "file_path#{" " * 53}complexity   churn"
+        puts "-" * 80
+
+        calculators.each do |calc|
+          # e.g. ['js', JsCalculator']
+          puts calc.last.type
+
+          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
+
+    class CSVFormatter
+      def call(calculators)
+        require "csv"
+
+        result = CSV.generate do |csv|
+          csv << %w[file_path score complexity churn type refactor]
+
+          calculators.each do |calc|
+            type = calc.last.type
+            values = calc.last.calculate
+            suggester = Suggester.new(values)
+            to_be_refactored = suggester.suggest.map(&:file_path)
+
+            values.each do |value|
+              csv << [value.file_path, value.score, value.complexity, value.churn, type, to_be_refactored.include?(value.file_path)]
+            end
+          end
+        end
+
+        puts result
+      end
+    end
+
+    class JSONFormatter
+      def call(calculators)
+        result = calculators.map do |calc|
+          type = calc.last.type
+          values = calc.last.calculate
+          suggester = Suggester.new(values)
+          to_be_refactored = suggester.suggest.map(&:file_path)
+
+          [
+            type, values.map do |value|
+              {
+                file_path: value.file_path,
+                score: value.score,
+                complexity: value.complexity,
+                churn: value.churn,
+                refactor: to_be_refactored.include?(value.file_path)
+              }
+            end
+          ]
+        end
+
+        puts result.to_h.to_json
+      end
+    end
+
+    def initialize(format:, **other)
+      super(**other)
+      @formatter = case format.to_sym
+      when :csv
+        CSVFormatter.new
+      when :json
+        JSONFormatter.new
+      else
+        TableFormatter.new
+      end
+    end
+
+    def report
+      super
+      @formatter.call(@calculators)
+    end
+  end
+end

data/lib/attractor/reporters/html_reporter.rb

@@ -14,10 +14,10 @@ module Attractor
       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.write("./attractor_output/images/attractor_logo.svg", logo)
+      File.write("./attractor_output/images/attractor_favicon.png", favicon)
+      File.write("./attractor_output/stylesheets/main.css", css)
+      File.write("./attractor_output/javascripts/index.pack.js", javascript_pack)
 
       if @calculators.size > 1
         @calculators.each do |calc|
@@ -25,8 +25,8 @@ 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) }
+          File.write("./attractor_output/javascripts/index.#{@short_type}.js", javascript)
+          File.write("./attractor_output/index.#{@short_type}.html", render)
           puts "Generated HTML report at #{File.expand_path "./attractor_output/"}/index.#{@short_type}.html"
         end
 
@@ -35,8 +35,8 @@ 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) }
+        File.write("./attractor_output/javascripts/index.js", javascript)
+        File.write("./attractor_output/index.html", render)
         puts "Generated HTML report at #{File.expand_path "./attractor_output/index.html"}"
 
         if @open_browser

data/lib/attractor/suggester.rb

@@ -5,8 +5,8 @@ module Attractor
   class Suggester
     attr_accessor :values
 
-    def initialize(values)
-      @values = values || []
+    def initialize(values = [])
+      @values = values
     end
 
     def suggest(threshold = 95)

data/lib/attractor/suggester.rb~

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

data/lib/attractor/version.rb

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

data/lib/attractor/version.rb~

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attractor
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Julian Rubisch
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-31 00:00:00.000000000 Z
+date: 2023-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: churn
@@ -156,28 +156,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: attractor-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: autoprefixer-rails
   requirement: !ruby/object:Gem::Requirement
@@ -373,16 +373,21 @@ files:
 - lib/attractor.rb
 - lib/attractor/cache.rb
 - lib/attractor/calculators/base_calculator.rb
+- lib/attractor/calculators/base_calculator.rb~
 - lib/attractor/cli.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/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/sinatra_reporter.rb
 - lib/attractor/suggester.rb
+- lib/attractor/suggester.rb~
 - lib/attractor/value.rb
 - lib/attractor/version.rb
 - lib/attractor/version.rb~
@@ -395,7 +400,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
@@ -410,8 +415,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Churn vs Complexity Chart Generator
 test_files: []