attractor 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be5d6855eaab1440883504f3814c62f5cfae2dad252cdd567624ad8faaeed15e
-  data.tar.gz: 68a7a71d2ef7736c780b906765748ff3fd8e0ca8733ef5c8ffa033f97ff10214
+  metadata.gz: 907c4dcfeef010d2233dec58fd6a619ee0b6f4dcca2a69149180c8511e177aa6
+  data.tar.gz: 3ed065a23ee2b46ed6028f6e226d9ce75c04f0b7d4e3b46e12b7ac50db9fa538
 SHA512:
-  metadata.gz: f0d7d82657c9a6f82c28ccb5f413875d3a82b9d7d36bd52a5c5cf5df2f831e5022bf5ae465c2214c84013115c85ca85c956680fb3ccb2739260bad1a7da60347
-  data.tar.gz: b026b51c657207e7ce95c350c0ab98488ad211f3ed22a64a3be038316643def27dbdd1ff3731decc0690c32d8b4e8603c55055239c3a94df1d0d01588175dbd8
+  metadata.gz: 2d37d2106a2c6675fc1132b04265376533230a34e4fc6a43e923f92b161451374d3b0db548a46c2a6fca62f721b1fa9d8bcb9a8f52833307a7d4734a240d1cac
+  data.tar.gz: 51e134b833023b6087516d75abed90eff25f47471f2635f27c3be0cdb2c3e6f130e199a5b9509f78db8ece25ccc1b5f7013403ba11add8510d9c7b0078beb275

data/.gitignore

@@ -13,3 +13,4 @@
 .rspec_status
 
 *.swp
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## RELEASE 0.2.0
+
+* FEATURE: add file watching functionality

data/Guardfile

@@ -0,0 +1,20 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard 'rake', :task => 'install' do
+  watch(%r{^lib/.+\.rb})
+end

data/README.md

@@ -2,9 +2,7 @@
 
 ![image](https://user-images.githubusercontent.com/4352208/64156443-1573a600-ce35-11e9-9422-265012e93a91.png)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/attractor`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+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.
 
 ## Installation
 
@@ -36,17 +34,23 @@ Or shorter:
 
     $ attractor report -p app/models
 
+Watch for file changes:
+
+    $ attractor report -p app/models --watch
+
 ## CLI Commands and Options
 
 Print a simple output to console:
 
     $ attractor calc
     $   --file_prefix|-p app/models
+    $   --watch|-w
 
 Generate a full report
 
     $ attractor report 
     $   --file_prefix|-p app/models
+    $   --watch|-w
 
 ## Development
 

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'structured_changelog/tasks'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/attractor.gemspec

@@ -36,13 +36,17 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'churn', '>= 1.0.4'
   spec.add_dependency 'descriptive_statistics'
   spec.add_dependency 'flog', '~> 4.0'
+  spec.add_dependency 'listen', '~> 3.0'
   spec.add_dependency 'thor'
   spec.add_dependency 'tilt'
 
   spec.add_development_dependency 'aruba'
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rake'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'structured_changelog'
 end

data/lib/attractor.rb

@@ -2,7 +2,9 @@
 
 require 'attractor/version'
 require 'attractor/calculator'
-# require_relative 'attractor/calculator.rb'
+require 'attractor/reporter'
+require 'attractor/suggester'
+require 'attractor/watcher'
 
 module Attractor
   class Error < StandardError; end

data/lib/attractor/calculator.rb

@@ -3,21 +3,25 @@
 require 'churn/calculator'
 require 'csv'
 require 'date'
-require 'descriptive_statistics/safe'
 require 'flog'
-require 'fileutils'
-require 'tilt'
+require 'listen'
 
 require 'attractor/value'
 
 module Attractor
   # calculates churn and complexity
   class Calculator
-    def self.calculate(file_extension: 'rb', minimum_churn_count: 3, file_prefix: '')
+    def initialize(file_prefix: '')
+      @file_prefix = file_prefix
+      @file_extension = 'rb'
+      @minimum_churn_count = 3
+    end
+
+    def calculate
       churn = ::Churn::ChurnCalculator.new(
-        file_extension: file_extension,
-        file_prefix: file_prefix,
-        minimum_churn_count: minimum_churn_count,
+        file_extension: @file_extension,
+        file_prefix: @file_prefix,
+        minimum_churn_count: @minimum_churn_count,
         start_date: Date.today - 365 * 5
       ).report(false)
 
@@ -28,34 +32,5 @@ module Attractor
         Value.new(file_path: change[:file_path], churn: change[:times_changed], complexity: complexity)
       end
     end
-
-    def self.output_console(file_prefix: '')
-      values = calculate(file_prefix: file_prefix)
-      puts values.map(&:to_s)
-    end
-
-    def self.report(format: 'html', file_prefix: '')
-      @values = calculate(file_prefix: file_prefix)
-
-      @suggestions = get_suggestions(@values)
-
-      template = Tilt.new(File.expand_path('../templates/index.html.erb', __dir__))
-      output = template.render self
-
-      FileUtils.mkdir_p './attractor_output'
-
-      case format
-      when 'html'
-        File.open('./attractor_output/index.html', 'w') { |file| file.write(output) }
-      end
-    end
-
-    def self.get_suggestions(values)
-      products = values.map { |val| val.churn * val.complexity }
-      products.extend(DescriptiveStatistics)
-      top_95_quantile = products.percentile(95)
-
-      values.select { |val| val.churn * val.complexity > top_95_quantile }
-    end
   end
 end

data/lib/attractor/cli.rb

@@ -9,21 +9,32 @@ module Attractor
   class CLI < Thor
     desc 'calc', 'Calculates churn and complexity for all ruby files in current directory'
     option :file_prefix, aliases: :p
+    option :watch, aliases: :w, type: :boolean
     def calc
-      puts 'Calculated churn and complexity'
-      puts
-      puts "file_path#{' ' * 53}complexity   churn"
-      puts '-' * 80
-      Attractor::Calculator.output_console(file_prefix: options[:file_prefix])
+      if options[:watch]
+        puts 'Listening for file changes...'
+        Attractor::ConsoleReporter.new(file_prefix: options[:file_prefix]).watch
+      else
+        Attractor::ConsoleReporter.new(file_prefix: options[:file_prefix]).report
+      end
     end
 
     desc 'report', 'Generates an HTML report'
     option :format, aliases: :f, default: 'html'
     option :file_prefix, aliases: :p
+    option :watch, aliases: :w, type: :boolean
     def report
-      puts 'Generating an HTML report'
-      Attractor::Calculator.report(format: options[:format], file_prefix: options[:file_prefix])
-      puts "Generated HTML report at #{File.expand_path './attractor_output/index.html'}"
+      if options[:watch]
+        puts 'Listening for file changes...'
+        Attractor::HtmlReporter.new(file_prefix: options[:file_prefix]).watch
+      else
+        case options[:format]
+        when 'html'
+          Attractor::HtmlReporter.new(file_prefix: options[:file_prefix]).report
+        else
+          Attractor::HtmlReporter.new(file_prefix: options[:file_prefix]).report
+        end
+      end
     end
   end
 end

data/lib/attractor/reporter.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'descriptive_statistics/safe'
+require 'fileutils'
+require 'tilt'
+
+module Attractor
+  # base reporter
+  class Reporter
+    extend Forwardable
+    attr_accessor :values
+    def_delegator :@watcher, :watch
+
+    def initialize(file_prefix: '')
+      @calculator = Calculator.new(file_prefix: file_prefix)
+      @values = @calculator.calculate
+      @suggester = Suggester.new(values)
+
+      @watcher = Watcher.new(file_prefix, lambda do
+        report
+      end)
+    end
+
+    def report
+      @suggestions = @suggester.suggest
+    end
+  end
+
+  # console reporter
+  class ConsoleReporter < Reporter
+    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
+
+  # HTML reporter
+  class HtmlReporter < Reporter
+    def report
+      super
+
+      puts 'Generating an HTML report'
+      template = Tilt.new(File.expand_path('../templates/index.html.erb', __dir__))
+      output = template.render self
+
+      FileUtils.mkdir_p './attractor_output'
+
+      File.open('./attractor_output/index.html', 'w') { |file| file.write(output) }
+      puts "Generated HTML report at #{File.expand_path './attractor_output/index.html'}"
+    end
+  end
+end

data/lib/attractor/suggester.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Attractor
+  # makes suggestions for refactorings
+  class Suggester
+    def initialize(values)
+      @values = values
+    end
+
+    def suggest
+      products = @values.map { |val| val.churn * val.complexity }
+      products.extend(DescriptiveStatistics)
+      top_95_quantile = products.percentile(95)
+
+      @values.select { |val| val.churn * val.complexity > top_95_quantile }
+    end
+  end
+end

data/lib/attractor/version.rb

@@ -1,3 +1,3 @@
 module Attractor
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/attractor/watcher.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Attractor
+  # functionality for watching file system changes
+  class Watcher
+    def initialize(file_prefix, callback)
+      @file_prefix = file_prefix
+      @callback = callback
+    end
+
+    def watch
+      @callback.call
+
+      listener = Listen.to(@file_prefix, ignore: /^attractor_output/) do |modified, _added, _removed|
+        if modified
+          puts "#{modified.map(&:to_s).join(', ')} modified, recalculating..."
+          @callback.call
+        end
+      end
+      listener.start
+      sleep
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attractor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2019-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: churn
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rake
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: structured_changelog
+  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'
 description: |2
       Many authors (Michael Feathers, Sandi Metz) have shown that an evaluation of
       churn vs complexity of files in software projects provide a valuable metric
@@ -180,7 +236,9 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -191,8 +249,11 @@ files:
 - lib/attractor.rb
 - lib/attractor/calculator.rb
 - lib/attractor/cli.rb
+- lib/attractor/reporter.rb
+- lib/attractor/suggester.rb
 - lib/attractor/value.rb
 - lib/attractor/version.rb
+- lib/attractor/watcher.rb
 - lib/templates/index.html.erb
 homepage: https://github.com/julianrubisch/attractor
 licenses: []