attractor 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38e9529df9d6404034cde6792aab2f1dec600e1d13269b819f71074003a4162b
-  data.tar.gz: 319ad98e23caed681ec07278c7d27402f080618810dab2532aa79ac9c0778c4c
+  metadata.gz: b116bbaa914ca032391378e04b8e41f27b28fa4feaca3fc50c93053d1954a15a
+  data.tar.gz: 3e5620d661d19d3d2308457921389ce78b4ba3b844a6a4d3dd33c1ef9d093a56
 SHA512:
-  metadata.gz: aae211d1f8f4519a5470b43a6ceefdf3ea40580bfbb524e14e13c79ab8f99dc95269e28c089a114c60628ac58eb43ff299c87cc021ce72273a855ef0de21b4ef
-  data.tar.gz: 304a7d902b3fdb6440068ba2501dbe1b9b7cd1b7fea3b1a3590533ab6654a7575ecedd1109fe94e6afb62be0d734f3ae1292f56231a8a157eec79d8ecebbaa07
+  metadata.gz: '092ff47f81f9d6f0e7fa025d21a89501413e1dc8c7044d5420d4db8ea04f72fc6554840a9656b0ac002c2f0c25ef3f0fa9c1204214d4b29a284eabb565428f82'
+  data.tar.gz: 83ad8a7dafa969e68c4db77629663738513137a3f91ad058451d9a37c1ed39aff1cfea785c34042d543b7caac8ec625207cf3701c7003d63a23f631cbba109b5

data/README.md

@@ -186,6 +186,17 @@ attractor:
 
 ## CLI Commands and Options
 
+Initialize the local cache:
+
+```sh
+attractor init
+  --file_prefix|-p app/models
+  --type|-t rb|js
+  --start_ago|-s  (e.g. 5y, 3m, 7w)
+  --minimum_churn|-c (minimum times a file must have changed to be processed)
+  --ignore|-i 'spec/*_spec.rb,db/schema.rb,tmp'
+``` 
+
 Print a simple output to console:
 
 ```sh
@@ -223,6 +234,13 @@ attractor serve
   --ignore|-i 'spec/*_spec.rb,db/schema.rb,tmp'
 ```
 
+Clear the local cache:
+
+```sh
+attractor clean
+``` 
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/attractor.rb

@@ -21,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
@@ -30,13 +39,20 @@ module Attractor
 
     return {type => registry_entry_for_type.calculator_class.new(**options)} if type
 
+    all_registered_calculators(**options)
+  end
+
+  def all_registered_calculators(options = {})
     Hash[@registry_entries.map do |type, entry|
       [type, entry.calculator_class.new(**options)] if entry.detector_class.new.detect
     end.compact]
   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|

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/cache.rb

@@ -14,6 +14,14 @@ module Attractor
         adapter.write(file_path: file_path, value: value)
       end
 
+      def persist!
+        adapter.persist!
+      end
+
+      def clear
+        adapter.clear
+      end
+
       private
 
       def adapter
@@ -56,9 +64,16 @@ module Attractor
 
         transformed_value = value.to_h.transform_keys { |k| mappings[k] || k }
         @store[file_path] = {value.current_commit => transformed_value}
+      end
+
+      def persist!
         File.write(filename, ::JSON.dump(@store))
       end
 
+      def clear
+        FileUtils.rm filename
+      end
+
       def filename
         "#{@data_directory}/attractor-cache.json"
       end

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

@@ -26,7 +26,9 @@ module Attractor
         ignores: @ignores
       ).report(false)
 
-      churn[:churn][:changes].map do |change|
+      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
 
@@ -45,8 +47,15 @@ module Attractor
           Cache.write(file_path: change[:file_path], value: value)
         end
 
+        print "."
         value
       end
+
+      Cache.persist!
+
+      print "\n\n"
+
+      values
     end
 
     private

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

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

@@ -26,6 +26,21 @@ module Attractor
       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)

data/lib/attractor/cli.rb~

@@ -0,0 +1,84 @@
+# 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 "calc", "Calculates churn and complexity for all ruby files in current directory"
+    shared_options.each do |shared_option|
+      option(*shared_option)
+    end
+    def calc
+      file_prefix = options[:file_prefix]
+
+      report! Attractor::ConsoleReporter.new(file_prefix: file_prefix, ignores: options[:ignore], calculators: calculators(options))
+    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/duration_parser.rb

@@ -14,7 +14,9 @@ module Attractor
 
     def initialize(input)
       @input = input
-      @duration = 0
+      @duration = @input.is_a?(Numeric) ? @input : 0
+      return if @duration > 0
+
       parse
     end
 

data/lib/attractor/duration_parser.rb~

@@ -1,23 +1,27 @@
+# frozen_string_literal: true
+
 module Attractor
-class DurationParser
-  TOKENS = {
-    "m" => (60),
-    "h" => (60 * 60),
-    "d" => (60 * 60 * 24)
-  }
+  # converts a duration string into an amount of days
+  class DurationParser
+    TOKENS = {
+      "d" => 1,
+      "w" => 7,
+      "m" => 30,
+      "y" => 365
+    }.freeze
 
-  attr_reader :time
+    attr_reader :duration
 
-  def initialize(input)
-    @input = input
-    @time = 0
-    parse
-  end
+    def initialize(input)
+      @input = input
+      @duration = 0
+      parse
+    end
 
-  def parse
-    @input.scan(/(\d+)(\w)/).each do |amount, measure|
-      @time += amount.to_i * TOKENS[measure]
+    def parse
+      @input.scan(/(\d+)(\w)/).each do |amount, measure|
+        @duration += amount.to_i * TOKENS[measure]
+      end
     end
   end
 end
-end

data/lib/attractor/reporters/base_reporter.rb

@@ -19,7 +19,6 @@ module Attractor
       @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

data/lib/attractor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attractor
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-09 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: churn
@@ -372,12 +372,12 @@ files:
 - exe/attractor
 - 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
+- lib/attractor/cli.rb~
 - lib/attractor/detectors/base_detector.rb
 - lib/attractor/detectors/base_detector.rb~
 - lib/attractor/duration_parser.rb

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