attractor 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a0acbe6a12975ea7a7aef0aceb983b61b45b3ec6bb7f3da95f2aaa992761011
-  data.tar.gz: 9541fe95c00fd300b2ce44bb9c19eb5c0819bb5eb69959bbe8270d56dd031fb3
+  metadata.gz: d67da9392099763d432b8bb74551259f5b6105cbbc4d7b370c41c1fe851102bf
+  data.tar.gz: 4fdd7358b4c073b52f517bd6933b2fcfc134549685dc42320ff055358971df86
 SHA512:
-  metadata.gz: d25be5b596d5af43eee4ba6827d483f3c9daa6a4be37c9dcb740906b81ea30c9dd8c4a5f7610ff994f38385ce1346f1cccb3c4892fd68214f99057e71b11b057
-  data.tar.gz: ee49bd39b824ce6918514ecbb9ef913a7bed6d7fdb2dd79982cd097755121ba1af49e94764aafbd2511ed827b085a202f222c187d52162a003c6ae15eb4f4002
+  metadata.gz: cd928f5288a2330156ef222277b34a3cfa9554529a8fcdd3fbf85e00ef38c140b6e3eaee990e8d9923a92da922546d0daaf7c139567ba7227245f9fb04d399c6
+  data.tar.gz: 341c7ba41ef4ac89021594d534f1c27f30d16e0f381a8e9106d09b68fdbec66c0ac8b738d916ff35323987d898a8a63043f4e74f19c186685c9d548ae58ff6c3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## RELEASE 1.1.1
+
+* ENHANCEMENT: `--minimum_churn` and `--start_ago` CLI options
+
 ## RELEASE 1.1.0
 
 * FEATURE: Auto-detect ruby and js projects

data/README.md

@@ -7,12 +7,15 @@
 
 Many authors ([Michael Feathers](https://www.agileconnection.com/article/getting-empirical-about-refactoring), [Sandi Metz](https://www.sandimetz.com/blog/2017/9/13/breaking-up-the-behemoth)) have shown that an evaluation of churn vs complexity of files in software projects provide a valuable metric towards code quality. This is another take on the matter, for ruby code, using the `churn` and `flog` projects.
 
+Here's an [article on medium](https://medium.com/better-programming/why-i-made-my-own-code-quality-tool-c44b40ceaafd) explaining the approach in greater detail.
+
 ## Table of Contents
 
   * [Installation](#installation)
   * [Usage](#usage)
     + [Live Reloading](#live-reloading)
   * [CI Usage](#ci-usage)
+    + [Github Action](#github-action)
     + [Gitlab Example](#gitlab-example)
   * [CLI Commands and Options](#cli-commands-and-options)
   * [Development](#development)
@@ -74,6 +77,10 @@ If you have `guard-livereload` (or a similar service) running on your project, y
 
 To use this CLI in a CI environment, use the `--ci` option, which will suppress automatic opening of a browser window.
 
+### Github Action
+
+There is a dedicated [Github Action](https://github.com/julianrubisch/attractor-action) that will compile Attractor's output. Here's the action on the [Marketplace](https://github.com/marketplace/actions/attractor-action).
+
 ### Gitlab Example
 
 The simplest use case is to store the `attractor_output` directory as an artifact.
@@ -101,6 +108,8 @@ Print a simple output to console:
     $   --file_prefix|-p app/models
     $   --type|-t rb|js
     $   --watch|-w
+    $   --start_ago|-s  (e.g. 5y, 3m, 7w)
+    $   --minimum_churn|-c (minimum times a file must have changed to be processed)
 
 Generate a full report
 
@@ -109,6 +118,8 @@ Generate a full report
     $   --type|-t rb|js
     $   --watch|-w
     $   --no-open-browser|--ci
+    $   --start_ago|-s  (e.g. 5y, 3m, 7w)
+    $   --minimum_churn|-c (minimum times a file must have changed to be processed)
 
 Serve the output on http://localhost:7890
 
@@ -116,6 +127,8 @@ Serve the output on http://localhost:7890
     $   --file_prefix|-p app/models
     $   --watch|-w
     $   --no-open-browser|--ci
+    $   --start_ago|-s  (e.g. 5y, 3m, 7w)
+    $   --minimum_churn|-c (minimum times a file must have changed to be processed)
 
 ## Development
 
@@ -153,4 +166,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- 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!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

data/attractor.gemspec

@@ -28,7 +28,10 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(src|tmp|test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(src|tmp|test|spec|features|\.github)/}) ||
+        %w[.all-contributorsrc .rspec .rspec_status .travis.yml].include?(f)
+    end
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -55,5 +58,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'sassc'
+  spec.add_development_dependency 'standard'
   spec.add_development_dependency 'structured_changelog'
 end

data/lib/attractor.rb

@@ -1,32 +1,44 @@
 # frozen_string_literal: true
 
 require 'attractor/version'
+require 'attractor/duration_parser'
 require 'attractor/calculators/base_calculator'
-require 'attractor/calculators/ruby_calculator'
-require 'attractor/calculators/js_calculator'
 require 'attractor/detectors/base_detector'
-require 'attractor/detectors/ruby_detector'
-require 'attractor/detectors/js_detector'
 require 'attractor/reporters/base_reporter'
-require 'attractor/reporters/console_reporter'
-require 'attractor/reporters/html_reporter'
-require 'attractor/reporters/sinatra_reporter'
 require 'attractor/suggester'
 require 'attractor/watcher'
 
+Dir[File.join(__dir__, 'attractor', 'calculators', '*.rb')].each do |file|
+  next if file.start_with?('base')
+
+  require file
+end
+
+Dir[File.join(__dir__, 'attractor', 'detectors', '*.rb')].each do |file|
+  next if file.start_with?('base')
+
+  require file
+end
+
+Dir[File.join(__dir__, 'attractor', 'reporters', '*.rb')].each do |file|
+  next if file.start_with?('base')
+
+  require file
+end
+
 module Attractor
   class Error < StandardError; end
 
-  def calculators_for_type(type, file_prefix)
+  def calculators_for_type(type, **options)
     case type
     when 'js'
-      { 'js' => JsCalculator.new(file_prefix: file_prefix) }
+      { 'js' => JsCalculator.new(**options) }
     when 'rb'
-      { 'rb' => RubyCalculator.new(file_prefix: file_prefix) }
+      { 'rb' => RubyCalculator.new(**options) }
     else
       {}.tap do |hash|
-        hash['rb'] = RubyCalculator.new(file_prefix: file_prefix) if RubyDetector.new.detect
-        hash['js'] = JsCalculator.new(file_prefix: file_prefix) if JsDetector.new.detect
+        hash['rb'] = RubyCalculator.new(**options) if RubyDetector.new.detect
+        hash['js'] = JsCalculator.new(**options) if JsDetector.new.detect
       end
     end
   end

data/lib/attractor/calculators/base_calculator.rb

@@ -9,10 +9,11 @@ module Attractor
   class BaseCalculator
     attr_reader :type
 
-    def initialize(file_prefix: '', file_extension: 'rb', minimum_churn_count: 3)
+    def initialize(file_prefix: '', 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
     end
 
     def calculate
@@ -20,7 +21,7 @@ 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
       ).report(false)
 
       churn[:churn][:changes].map do |change|

data/lib/attractor/calculators/js_calculator.rb

@@ -2,8 +2,8 @@
 
 module Attractor
   class JsCalculator < BaseCalculator
-    def initialize(file_prefix: '', minimum_churn_count: 3)
-      super(file_prefix: file_prefix, file_extension: '(js|jsx)', minimum_churn_count: minimum_churn_count)
+    def initialize(file_prefix: '', minimum_churn_count: 3, start_ago: 365 * 5)
+      super(file_prefix: file_prefix, file_extension: '(js|jsx)', minimum_churn_count: minimum_churn_count, start_ago: start_ago)
       @type = "JavaScript"
     end
 

data/lib/attractor/calculators/ruby_calculator.rb

@@ -4,8 +4,8 @@ require 'flog'
 
 module Attractor
   class RubyCalculator < BaseCalculator
-    def initialize(file_prefix: '', minimum_churn_count: 3)
-      super(file_prefix: file_prefix, file_extension: 'rb', minimum_churn_count: minimum_churn_count)
+    def initialize(file_prefix: '', minimum_churn_count: 3, start_ago: 365 * 5)
+      super(file_prefix: file_prefix, file_extension: 'rb', minimum_churn_count: minimum_churn_count, start_ago: start_ago)
       @type = "Ruby"
     end
 

data/lib/attractor/cli.rb

@@ -7,43 +7,48 @@ require 'attractor'
 module Attractor
   # contains methods implementing the CLI
   class CLI < Thor
+    shared_options = [[:file_prefix, aliases: :p],
+                      [: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 'calc', 'Calculates churn and complexity for all ruby files in current directory'
-    option :file_prefix, aliases: :p
-    option :watch, aliases: :w, type: :boolean
-    option :type, aliases: :t
+    shared_options.each do |shared_option|
+      option(*shared_option)
+    end
     def calc
       file_prefix = options[:file_prefix]
-      calculators = Attractor.calculators_for_type(options[:type], file_prefix)
       if options[:watch]
         puts 'Listening for file changes...'
-        Attractor::ConsoleReporter.new(file_prefix: file_prefix, calculators: calculators).watch
+        Attractor::ConsoleReporter.new(file_prefix: file_prefix, calculators: calculators(options)).watch
       else
-        Attractor::ConsoleReporter.new(file_prefix: file_prefix, calculators: calculators).report
+        Attractor::ConsoleReporter.new(file_prefix: file_prefix, calculators: calculators(options)).report
       end
     rescue RuntimeError => e
       puts "Runtime error: #{e.message}"
     end
 
     desc 'report', 'Generates an HTML report'
-    option :format, aliases: :f, default: 'html'
-    option :file_prefix, aliases: :p
-    option :watch, aliases: :w, type: :boolean
-    option :type, aliases: :t
-    option :no_open_browser, type: :boolean
-    option :ci, type: :boolean
+    (shared_options + advanced_options).each do |option|
+      option(*option)
+    end
     def report
       file_prefix = options[:file_prefix]
-      calculators = Attractor.calculators_for_type(options[:type], file_prefix)
-      open_browser = !(options[:no_open_browser] || options[:ci]) 
+      open_browser = !(options[:no_open_browser] || options[:ci])
       if options[:watch]
         puts 'Listening for file changes...'
-        Attractor::HtmlReporter.new(file_prefix: file_prefix, calculators: calculators, open_browser: open_browser).watch
+        Attractor::HtmlReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).watch
       else
         case options[:format]
         when 'html'
-          Attractor::HtmlReporter.new(file_prefix: file_prefix, calculators: calculators, open_browser: open_browser).report
+          Attractor::HtmlReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).report
         else
-          Attractor::HtmlReporter.new(file_prefix: file_prefix, calculators: calculators, open_browser: open_browser).report
+          Attractor::HtmlReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).report
         end
       end
     rescue RuntimeError => e
@@ -51,27 +56,32 @@ module Attractor
     end
 
     desc 'serve', 'Serves the report on localhost'
-    option :format, aliases: :f, default: 'html'
-    option :file_prefix, aliases: :p
-    option :watch, aliases: :w, type: :boolean
-    option :type, aliases: :t
-    option :no_open_browser, type: :boolean
-    option :ci, type: :boolean
+    (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]) 
-      calculators = Attractor.calculators_for_type(options[:type], file_prefix)
+      open_browser = !(options[:no_open_browser] || options[:ci])
       if options[:watch]
         puts 'Listening for file changes...'
-        Attractor::SinatraReporter.new(file_prefix: file_prefix, calculators: calculators, open_browser: open_browser).watch
+        Attractor::SinatraReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).watch
       else
         case options[:format]
         when 'html'
-          Attractor::SinatraReporter.new(file_prefix: file_prefix, calculators: calculators, open_browser: open_browser).report
+          Attractor::SinatraReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).report
         else
-          Attractor::SinatraReporter.new(file_prefix: file_prefix, calculators: calculators, open_browser: open_browser).report
+          Attractor::SinatraReporter.new(file_prefix: file_prefix, calculators: calculators(options), open_browser: open_browser).report
         end
       end
     end
+
+    private
+
+    def calculators(options)
+      Attractor.calculators_for_type(options[:type],
+                                     file_prefix: options[:file_prefix],
+                                     minimum_churn_count: options[:minimum_churn],
+                                     start_ago: options[:start_ago])
+    end
   end
 end

data/lib/attractor/duration_parser.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Attractor
+  # converts a duration string into an amount of days
+  class DurationParser
+    TOKENS = {
+      'd' => 1,
+      'w' => 7,
+      'm' => 30,
+      'y' => 365
+    }.freeze
+
+    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/reporters/sinatra_reporter.rb

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

@@ -4,7 +4,7 @@ module Attractor
   # makes suggestions for refactorings
   class Suggester
     def initialize(values)
-      @values = values
+      @values = values || []
     end
 
     def suggest(threshold = 95)

data/lib/attractor/version.rb

@@ -1,3 +1,3 @@
 module Attractor
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attractor
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-23 00:00:00.000000000 Z
+date: 2019-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: churn
@@ -290,6 +290,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: structured_changelog
   requirement: !ruby/object:Gem::Requirement
@@ -316,14 +330,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".all-contributorsrc"
 - ".babelrc"
 - ".eslintrc.json"
-- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -350,6 +360,7 @@ files:
 - lib/attractor/detectors/base_detector.rb
 - lib/attractor/detectors/js_detector.rb
 - lib/attractor/detectors/ruby_detector.rb
+- lib/attractor/duration_parser.rb
 - lib/attractor/reporters/.keep
 - lib/attractor/reporters/base_reporter.rb
 - lib/attractor/reporters/console_reporter.rb

data/.all-contributorsrc

@@ -1,25 +0,0 @@
-{
-  "files": [
-    "README.md"
-  ],
-  "imageSize": 100,
-  "commit": false,
-  "contributors": [
-    {
-      "login": "julianrubisch",
-      "name": "Julian Rubisch",
-      "avatar_url": "https://avatars0.githubusercontent.com/u/4352208?v=4",
-      "profile": "http://www.julianrubisch.at",
-      "contributions": [
-        "code",
-        "doc"
-      ]
-    }
-  ],
-  "contributorsPerLine": 7,
-  "projectName": "attractor",
-  "projectOwner": "julianrubisch",
-  "repoType": "github",
-  "repoHost": "https://github.com",
-  "skipCi": true
-}

data/.github/workflows/ruby.yml

@@ -1,25 +0,0 @@
-name: Ruby
-
-on: [push]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        ruby-version: [2.4.x, 2.5.x, 2.6.x]
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby ${{ matrix.ruby-version }}
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rspec spec
-        bundle exec cucumber features

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,10 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.0.2
-script:
-  - bundle exec cucumber features
-  - bundle exec rspec spec