attractor 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a044632a13376f395112a65b938be9c3173a16499f4eab725e97afffc1e83925
-  data.tar.gz: 20aafed307f3cf4f047130aa6aafc2395838ba50ecf48dedc0bd205fe5e6c391
+  metadata.gz: 38e9529df9d6404034cde6792aab2f1dec600e1d13269b819f71074003a4162b
+  data.tar.gz: 319ad98e23caed681ec07278c7d27402f080618810dab2532aa79ac9c0778c4c
 SHA512:
-  metadata.gz: 12a4dd82ff8d50a7d5e7c3663b6b013e93d6575a706581c7b64a5bbb75714d9d8126c3f24344f57e2c5c79905ea549e82370def04fb6643ff25fbc38f365c846
-  data.tar.gz: f27f15c33b573ab2cccb9be34d59f89c12575e19fe18454d5380c4fd500f98e63e2b0e8be2bd4e7a86c18512124fb6792e5f625101ef4e8333b54bf59a03a165
+  metadata.gz: aae211d1f8f4519a5470b43a6ceefdf3ea40580bfbb524e14e13c79ab8f99dc95269e28c089a114c60628ac58eb43ff299c87cc021ce72273a855ef0de21b4ef
+  data.tar.gz: 304a7d902b3fdb6440068ba2501dbe1b9b7cd1b7fea3b1a3590533ab6654a7575ecedd1109fe94e6afb62be0d734f3ae1292f56231a8a157eec79d8ecebbaa07

data/README.md

@@ -47,7 +47,7 @@
 [![MIT License][license-shield]][license-url]
 [![Twitter follow][twitter-shield]][twitter-url]
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
   <a href="https://www.patreon.com/user?u=24747270"><img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" alt="Become a Patron!" width="160" /></a>
@@ -248,15 +248,17 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="http://www.julianrubisch.at"><img src="https://avatars0.githubusercontent.com/u/4352208?v=4" width="100px;" alt=""/><br /><sub><b>Julian Rubisch</b></sub></a><br /><a href="https://github.com/julianrubisch/attractor/commits?author=julianrubisch" title="Code">💻</a> <a href="https://github.com/julianrubisch/attractor/commits?author=julianrubisch" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/olimart"><img src="https://avatars3.githubusercontent.com/u/547754?v=4" width="100px;" alt=""/><br /><sub><b>Olivier</b></sub></a><br /><a href="#maintenance-olimart" title="Maintenance">🚧</a></td>
-    <td align="center"><a href="https://www.andrewmason.me/"><img src="https://avatars1.githubusercontent.com/u/18423853?v=4" width="100px;" alt=""/><br /><sub><b>Andrew Mason</b></sub></a><br /><a href="https://github.com/julianrubisch/attractor/commits?author=andrewmcodes" title="Code">💻</a> <a href="https://github.com/julianrubisch/attractor/pulls?q=is%3Apr+reviewed-by%3Aandrewmcodes" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/julianrubisch/attractor/commits?author=andrewmcodes" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://www.ombulabs.com"><img src="https://avatars2.githubusercontent.com/u/17584?v=4" width="100px;" alt=""/><br /><sub><b>Ernesto Tagwerker</b></sub></a><br /><a href="https://github.com/julianrubisch/attractor/commits?author=etagwerker" title="Code">💻</a></td>
+    <td align="center"><a href="http://www.julianrubisch.at"><img src="https://avatars0.githubusercontent.com/u/4352208?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Julian Rubisch</b></sub></a><br /><a href="https://github.com/julianrubisch/attractor/commits?author=julianrubisch" title="Code">💻</a> <a href="https://github.com/julianrubisch/attractor/commits?author=julianrubisch" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/olimart"><img src="https://avatars3.githubusercontent.com/u/547754?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Olivier</b></sub></a><br /><a href="#maintenance-olimart" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://www.andrewmason.me/"><img src="https://avatars1.githubusercontent.com/u/18423853?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Andrew Mason</b></sub></a><br /><a href="https://github.com/julianrubisch/attractor/commits?author=andrewmcodes" title="Code">💻</a> <a href="https://github.com/julianrubisch/attractor/pulls?q=is%3Apr+reviewed-by%3Aandrewmcodes" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/julianrubisch/attractor/commits?author=andrewmcodes" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://www.ombulabs.com"><img src="https://avatars2.githubusercontent.com/u/17584?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ernesto Tagwerker</b></sub></a><br /><a href="https://github.com/julianrubisch/attractor/commits?author=etagwerker" title="Code">💻</a></td>
+    <td align="center"><a href="https://experimentslabs.com"><img src="https://avatars.githubusercontent.com/u/1732268?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Manuel Tancoigne</b></sub></a><br /><a href="https://github.com/julianrubisch/attractor/commits?author=mtancoigne" title="Code">💻</a></td>
   </tr>
 </table>
 
-<!-- markdownlint-enable -->
+<!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
+
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

data/lib/attractor.rb

@@ -8,6 +8,7 @@ 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")

data/lib/attractor.rb~

@@ -1,16 +1,16 @@
 # 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"
+
+Dir[File.join(__dir__, "attractor", "reporters", "*.rb")].sort.each do |file|
+  next if file.start_with?("base")
 
   require file
 end
@@ -27,9 +27,8 @@ 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
 
-    
     Hash[@registry_entries.map do |type, entry|
       [type, entry.calculator_class.new(**options)] if entry.detector_class.new.detect
     end.compact]

data/lib/attractor/cache.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "psych"
+
+module Attractor
+  class Cache
+    class << self
+      def read(file_path:)
+        adapter.read(file_path: file_path)
+      end
+
+      def write(file_path:, value:)
+        adapter.write(file_path: file_path, value: value)
+      end
+
+      private
+
+      def adapter
+        @@adapter ||= CacheAdapter::JSON.instance
+      end
+    end
+  end
+
+  module CacheAdapter
+    class Base
+      include Singleton
+    end
+
+    class JSON < Base
+      def initialize
+        super
+
+        @data_directory = "tmp"
+        FileUtils.mkdir_p @data_directory
+        FileUtils.touch filename
+
+        begin
+          @store = ::JSON.parse(File.read(filename))
+        rescue ::JSON::ParserError
+          @store = {}
+        end
+      end
+
+      def read(file_path:)
+        value_hash = @store[file_path]
+
+        Value.new(**value_hash.values.first.transform_keys(&:to_sym)) unless value_hash.nil?
+      rescue ArgumentError => e
+        puts "Couldn't rehydrate value from cache: #{e.message}"
+        nil
+      end
+
+      def write(file_path:, value:)
+        mappings = {x: :churn, y: :complexity}
+
+        transformed_value = value.to_h.transform_keys { |k| mappings[k] || k }
+        @store[file_path] = {value.current_commit => transformed_value}
+        File.write(filename, ::JSON.dump(@store))
+      end
+
+      def filename
+        "#{@data_directory}/attractor-cache.json"
+      end
+    end
+  end
+end

data/lib/attractor/calculators/base_calculator.rb

@@ -27,12 +27,25 @@ module Attractor
       ).report(false)
 
       churn[:churn][:changes].map do |change|
-        complexity, details = yield(change)
-        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]))
+        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
+
+        value
       end
     end
 

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

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-require 'churn/calculator'
-require 'csv'
-require 'date'
-require 'flog'
-require 'listen'
+require "churn/calculator"
 
-require 'attractor/value'
+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: "", 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
@@ -22,20 +22,18 @@ 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,
+        ignores: @ignores
       ).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]))
+        value = 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]))
+        value
       end
     end
 
@@ -44,10 +42,10 @@ module Attractor
     def git_history_for_file(file_path:, limit: 10)
       history = `git log --oneline -n #{limit} -- #{file_path}`
       history.split("\n")
-             .map do |log_entry|
+        .map do |log_entry|
         log_entry.partition(/\A(\S+)\s/)
-                 .map(&:strip)
-                 .reject(&:empty?)
+          .map(&:strip)
+          .reject(&:empty?)
       end
     end
   end

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

@@ -1,10 +1,10 @@
 # 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
@@ -15,21 +15,21 @@ module Attractor
     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:, type: 'rb')
+    def suggestions(quantile:, type: "rb")
       @suggester.values = values(type: type)
       @suggestions = @suggester.suggest(quantile)
       @suggestions
@@ -41,13 +41,13 @@ module Attractor
     end
 
     def render
-      'Attractor'
+      "Attractor"
     end
 
-    def values(type: 'rb')
+    def values(type: "rb")
       @values = @calculators[type].calculate
       @values
-    rescue NoMethodError => e
+    rescue NoMethodError => _e
       puts "No calculator for type #{type}"
     end
   end

data/lib/attractor/value.rb

@@ -15,6 +15,10 @@ module Attractor
       @history = history
     end
 
+    def current_commit
+      history&.first&.first
+    end
+
     def to_s
       format("%-64s%8.1f%8i", @file_path, @complexity, @churn)
     end

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.1.0"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attractor
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: churn
@@ -373,6 +373,8 @@ files:
 - lib/attractor.rb
 - lib/attractor.rb~
 - lib/attractor/#duration_parser.rb#
+- lib/attractor/cache.rb
+- lib/attractor/cache.rb~
 - lib/attractor/calculators/base_calculator.rb
 - lib/attractor/calculators/base_calculator.rb~
 - lib/attractor/cli.rb
@@ -394,6 +396,7 @@ files:
 - lib/attractor/suggester.rb
 - lib/attractor/tmp/churn/9f86bc9b7ec6bf59cbf7a111ce8b1159ae128347.json
 - lib/attractor/value.rb
+- lib/attractor/value.rb~
 - lib/attractor/version.rb
 - lib/attractor/watcher.rb
 - lib/attractor/watcher.rb~
@@ -420,7 +423,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Churn vs Complexity Chart Generator