turbulence 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ddbf7b10c94cfd01747886dd397fa075fcc7dff
-  data.tar.gz: b93662fd01158ed29fcc2b9d308a8224582a91d1
+  metadata.gz: 1491a1041aa988c3e1b1ba0a9c285b85f61dd2fe
+  data.tar.gz: 52fc99ed010da6d2b62aaf794cb8ccfe42bf9079
 SHA512:
-  metadata.gz: 1a3a2ba43cfb5fec98e4f99bea0408ad764d23bb00c77bda2684f58e0dcb5566cedaaab7154a433da560ba8613bdcb80210e4a6472376cd47d465da0f1e07022
-  data.tar.gz: f822adff77f5400bbbb9a7d86c8fe8319afd2d0d632b081f842addc18f42a8123d3cf87f5ab1fd8974056a755a16713be35d28a777d4087ad59cc270d8c856c8
+  metadata.gz: da0688c4eac40019c589daa4df804aa29f71906b7706b92cf1b0237930ebb5324c547fd631a93cc28918c323a20ca5f8feae055bd4b6a5c552cce6f7088610fb
+  data.tar.gz: df3db44e2fad25424ee559ff82648a41f625bfdb90acbad83835af9f9d814d76757457183f199f014b248957c050bda4318104fb4c252b2b622b5a66856b6830

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    turbulence (1.2.3)
+    turbulence (1.2.4)
       flog (~> 4.1)
       json (>= 1.4.6)
       launchy (>= 2.0.0)
@@ -9,11 +9,11 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.5)
+    addressable (2.3.6)
     diff-lcs (1.2.5)
-    flog (4.1.2)
+    flog (4.2.1)
       ruby_parser (~> 3.1, > 3.1.0)
-      sexp_processor (~> 4.0)
+      sexp_processor (~> 4.4)
     json (1.8.1)
     launchy (2.4.2)
       addressable (~> 2.3)
@@ -26,9 +26,9 @@ GEM
     rspec-expectations (2.14.4)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.4)
-    ruby_parser (3.2.2)
+    ruby_parser (3.6.1)
       sexp_processor (~> 4.1)
-    sexp_processor (4.4.0)
+    sexp_processor (4.4.3)
 
 PLATFORMS
   ruby

data/lib/turbulence.rb

@@ -1,32 +1,47 @@
+require 'turbulence/configuration'
 require 'turbulence/file_name_mangler'
 require 'turbulence/command_line_interface'
-require 'turbulence/checks_environment'
 require 'turbulence/calculators/churn'
 require 'turbulence/calculators/complexity'
 require 'turbulence/generators/treemap'
 require 'turbulence/generators/scatterplot'
 
 class Turbulence
-  CODE_DIRECTORIES = ["app/models",
-                      "app/controllers",
-                      "app/helpers",
-                      "app/jobs",
-                      "app/mailers",
-                      "app/validators",
-                      "lib"]
-  CALCULATORS = [Turbulence::Calculators::Complexity,
-                 Turbulence::Calculators::Churn]
+  CODE_DIRECTORIES = [
+    "app/models",
+    "app/controllers",
+    "app/helpers",
+    "app/jobs",
+    "app/mailers",
+    "app/validators",
+    "lib",
+  ]
+  CALCULATORS = [
+    Turbulence::Calculators::Complexity,
+    Turbulence::Calculators::Churn,
+  ]
 
-  attr_reader :exclusion_pattern
+  # Make a config instance available to anyone who wants one
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  attr_reader :config
   attr_reader :metrics
 
-  def initialize(directory, output = nil, exclusion_pattern = nil)
-    @output            = output
-    @metrics           = {}
-    @exclusion_pattern = exclusion_pattern
+  extend Forwardable
+  def_delegators :config, *[
+    :directory,
+    :exclusion_pattern,
+    :output,
+  ]
+
+  def initialize(config = nil)
+    @config  = config || Turbulence.config
+    @metrics = {}
 
     Dir.chdir(directory) do
-      CALCULATORS.each(&method(:calculate_metrics_with))
+      calculators.each(&method(:calculate_metrics_with))
     end
   end
 
@@ -40,14 +55,14 @@ class Turbulence
 
     calculator.for_these_files(files_of_interest) do |filename, score|
       report "."
-      set_file_metric(filename, calculator, score)
+      set_file_metric(filename, calculator.class, score)
     end
 
     report "\n"
   end
 
   def report(this)
-    @output.print this unless @output.nil?
+    output.print this unless output.nil?
   end
 
   def set_file_metric(filename, metric, value)
@@ -60,9 +75,13 @@ class Turbulence
 
   private
   def exclude_files(files)
-    if not @exclusion_pattern.nil?
-      files = files.reject { |f| f =~ Regexp.new(@exclusion_pattern) }
+    if not exclusion_pattern.nil?
+      files = files.reject { |f| f =~ Regexp.new(exclusion_pattern) }
     end
     files
   end
+
+  def calculators
+    CALCULATORS.map { |calc_class| calc_class.new(config) }
+  end
 end

data/lib/turbulence/calculators/churn.rb

@@ -1,54 +1,64 @@
+require 'forwardable'
+
 class Turbulence
   module Calculators
     class Churn
       RUBY_FILE_EXTENSION = ".rb"
 
-      class << self
-        attr_accessor :scm, :compute_mean, :commit_range
+      attr_reader :config
+      def initialize(config = nil)
+        @config = config || Turbulence.config
+      end
 
-        def for_these_files(files)
-          changes_by_ruby_file.each do |filename, count|
-            yield filename, count if files.include?(filename)
-          end
-        end
+      extend Forwardable
+      def_delegators :config, *[
+        :scm,          :scm=,
+        :commit_range, :commit_range=,
+        :compute_mean, :compute_mean=,
+      ]
 
-        def changes_by_ruby_file
-          ruby_files_changed_in_scm.group_by(&:first).map do |filename, stats|
-            churn_for_file(filename,stats)
-          end
+      def for_these_files(files)
+        changes_by_ruby_file.each do |filename, count|
+          yield filename, count if files.include?(filename)
         end
+      end
 
-        def churn_for_file(filename,stats)
-          churn = stats[0..-2].map(&:last).inject(0){|running_total, changes| running_total + changes}
-          churn = calculate_mean_of_churn(churn, stats.size - 1) if compute_mean
-          [filename, churn]
+      def changes_by_ruby_file
+        ruby_files_changed_in_scm.group_by(&:first).map do |filename, stats|
+          churn_for_file(filename,stats)
         end
+      end
 
-        def calculate_mean_of_churn(churn, sample_size) 
-          return churn if sample_size < 1
-          churn /= sample_size
-        end
+      def churn_for_file(filename,stats)
+        churn = stats[0..-2].map(&:last).inject(0){|running_total, changes| running_total + changes}
+        churn = calculate_mean_of_churn(churn, stats.size - 1) if compute_mean
+        [filename, churn]
+      end
 
-        def ruby_files_changed_in_scm
-          counted_line_changes_by_file_by_commit.select do |filename, _|
-            filename.end_with?(RUBY_FILE_EXTENSION) && File.exist?(filename)
-          end
-        end
+      def calculate_mean_of_churn(churn, sample_size)
+        return churn if sample_size < 1
+        churn /= sample_size
+      end
 
-        def counted_line_changes_by_file_by_commit
-          scm_log_file_lines.map do |line|
-            adds, deletes, filename = line.split(/\t/)
-            [filename, adds.to_i + deletes.to_i]
-          end
+      def ruby_files_changed_in_scm
+        counted_line_changes_by_file_by_commit.select do |filename, _|
+          filename.end_with?(RUBY_FILE_EXTENSION) && File.exist?(filename)
         end
+      end
 
-        def scm_log_file_lines
-          scm_log_command.each_line.reject{|line| line == "\n"}.map(&:chomp)
+      def counted_line_changes_by_file_by_commit
+        scm_log_file_lines.map do |line|
+          adds, deletes, filename = line.split(/\t/)
+          [filename, adds.to_i + deletes.to_i]
         end
+      end
 
-        def scm_log_command
-          scm.log_command(commit_range)
-        end
+      def scm_log_file_lines
+        scm_log_command.each_line.reject{|line| line == "\n"}.map(&:chomp)
+      end
+
+      def scm_log_command
+        scm.log_command(commit_range)
       end
     end
   end

data/lib/turbulence/calculators/complexity.rb

@@ -18,22 +18,26 @@ end
 class Turbulence
   module Calculators
     class Complexity
-      class << self
-        def flogger
-          @flogger ||= Flog19.new(:continue => true)
-        end
-        def for_these_files(files)
-          files.each do |filename|
-            yield filename, score_for_file(filename)
-          end
-        end
+      attr_reader :config
+      def initialize(config = nil)
+        @config = config || Turbulence.config
+      end
 
-        def score_for_file(filename)
-          flogger.reset
-          flogger.flog filename
-          flogger.total_score
+      def flogger
+        @flogger ||= Flog19.new(:continue => true)
+      end
+
+      def for_these_files(files)
+        files.each do |filename|
+          yield filename, score_for_file(filename)
         end
       end
+
+      def score_for_file(filename)
+        flogger.reset
+        flogger.flog filename
+        flogger.total_score
+      end
     end
   end
 end

data/lib/turbulence/checks_environment.rb

@@ -2,7 +2,8 @@ class Turbulence
   class ChecksEnvironment
     class << self
       def scm_repo?(directory)
-        Turbulence::Calculators::Churn.scm.is_repo?(directory)
+        churn_calculator = Turbulence::Calculators::Churn.new
+        churn_calculator.scm.is_repo?(directory)
       end
     end
   end

data/lib/turbulence/cli_parser.rb

@@ -0,0 +1,46 @@
+class Turbulence
+  class CommandLineInterface
+    # I Update a Turbulence::Configuration instance to match the user's
+    # expectations (as expressed in ARGV)
+    module ConfigParser
+      def self.parse_argv_into_config(argv, config)
+        option_parser = OptionParser.new do |opts|
+          opts.banner = "Usage: bule [options] [dir]"
+
+          opts.on('--scm p4|git', String, 'scm to use (default: git)') do |s|
+            case s
+            when "git", "", nil
+            when "p4"
+              config.scm_name = 'Perforce'
+            end
+          end
+
+          opts.on('--churn-range since..until', String, 'commit range to compute file churn') do |s|
+            config.commit_range = s
+          end
+
+          opts.on('--churn-mean', 'calculate mean churn instead of cummulative') do
+            config.compute_mean = true
+          end
+
+          opts.on('--exclude pattern', String, 'exclude files matching pattern') do |pattern|
+            config.exclusion_pattern = pattern
+          end
+
+          opts.on('--treemap', String, 'output treemap graph instead of scatterplot') do |s|
+            config.graph_type = "treemap"
+          end
+
+
+          opts.on_tail("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+        end
+        option_parser.parse!(argv)
+
+        config.directory = argv.first unless argv.empty?
+      end
+    end
+  end
+end

data/lib/turbulence/command_line_interface.rb

@@ -1,62 +1,38 @@
 require 'fileutils'
 require 'launchy'
 require 'optparse'
+require 'forwardable'
+
+require 'turbulence/configuration'
+require 'turbulence/cli_parser'
 require 'turbulence/scm/git'
 require 'turbulence/scm/perforce'
 
 class Turbulence
   class CommandLineInterface
     TURBULENCE_TEMPLATE_PATH = File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "template")
-    TEMPLATE_FILES = ['turbulence.html',
-                      'highcharts.js',
-                      'jquery.min.js',
-                      'treemap.html'].map do |filename|
+    TEMPLATE_FILES = [
+      'turbulence.html',
+      'highcharts.js',
+      'jquery.min.js',
+      'treemap.html',
+    ].map do |filename|
       File.join(TURBULENCE_TEMPLATE_PATH, filename)
     end
 
-    attr_reader :exclusion_pattern
-    attr_reader :directory
     def initialize(argv, additional_options = {})
-      Turbulence::Calculators::Churn.scm = Scm::Git
-      @graph_type = "turbulence"
-      OptionParser.new do |opts|
-        opts.banner = "Usage: bule [options] [dir]"
-
-        opts.on('--scm p4|git', String, 'scm to use (default: git)') do |s|
-          case s
-          when "git", "", nil
-          when "p4"
-            Turbulence::Calculators::Churn.scm = Scm::Perforce
-          end
-        end
-
-        opts.on('--churn-range since..until', String, 'commit range to compute file churn') do |s|
-          Turbulence::Calculators::Churn.commit_range = s
-        end
-
-        opts.on('--churn-mean', 'calculate mean churn instead of cummulative') do
-          Turbulence::Calculators::Churn.compute_mean = true
-        end
-
-        opts.on('--exclude pattern', String, 'exclude files matching pattern') do |pattern|
-          @exclusion_pattern = pattern
-        end
-
-        opts.on('--treemap', String, 'output treemap graph instead of scatterplot') do |s|
-          @graph_type = "treemap"
-        end
-
-
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
-          exit
-        end
-      end.parse!(argv)
-
-      @directory = argv.first || Dir.pwd
-      @output = additional_options.fetch(:output, STDOUT)
+      ConfigParser.parse_argv_into_config argv, config
+      config.output = additional_options.fetch(:output, STDOUT)
     end
 
+    extend Forwardable
+    def_delegators :Turbulence, :config
+    def_delegators :config, *[
+      :directory,
+      :graph_type,
+      :exclusion_pattern,
+    ]
+
     def copy_templates_into(directory)
       FileUtils.cp TEMPLATE_FILES, directory
     end
@@ -65,9 +41,9 @@ class Turbulence
       FileUtils.mkdir_p("turbulence")
 
       Dir.chdir("turbulence") do
-        turb = Turbulence.new(directory, @output, @exclusion_pattern)
+        turb = Turbulence.new(config)
 
-        generator = case @graph_type
+        generator = case graph_type
         when "treemap"
           Turbulence::Generators::TreeMap.new({})
         else
@@ -79,7 +55,7 @@ class Turbulence
     end
 
     def open_bundle
-      Launchy.open("file:///#{directory}/turbulence/#{@graph_type}.html")
+      Launchy.open("file:///#{directory}/turbulence/#{graph_type}.html")
     end
   end
 end

data/lib/turbulence/configuration.rb

@@ -0,0 +1,28 @@
+require 'ostruct'
+
+class Turbulence
+  class Configuration
+    attr_accessor *[
+      :directory,
+      :scm,
+      :scm_name,
+      :commit_range,
+      :compute_mean,
+      :exclusion_pattern,
+      :graph_type,
+      :output,
+    ]
+
+    def initialize
+      @directory  = Dir.pwd
+      @graph_type = 'turbulence'
+      @scm_name   = 'Git'
+      @output     = STDOUT
+    end
+
+    # TODO: drop attr accessor and ivar once it stops getting set via Churn
+    def scm
+      @scm || Turbulence::Scm.const_get(scm_name)
+    end
+  end
+end

data/lib/turbulence/version.rb

@@ -1,3 +1,3 @@
 class Turbulence
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

data/spec/turbulence/calculators/churn_spec.rb

@@ -1,7 +1,9 @@
 require 'turbulence/calculators/churn'
 
 describe Turbulence::Calculators::Churn do
-  let(:calculator) { Turbulence::Calculators::Churn }
+  let(:calculator) { Turbulence::Calculators::Churn.new(config) }
+  let(:config) { Turbulence::Configuration.new }
+
   before do
     calculator.stub(:scm_log_command) { "" }
   end

data/spec/turbulence/calculators/complexity_spec.rb

@@ -1,7 +1,9 @@
 require 'turbulence/calculators/complexity'
 
 describe Turbulence::Calculators::Complexity do
-  let(:calculator) { Turbulence::Calculators::Complexity }
+  let(:calculator) { Turbulence::Calculators::Complexity.new(config) }
+  let(:config) { Turbulence::Configuration.new }
+
   describe "::for_these_files" do
     it "yields up the filename and score for each file" do
       files = ["lib/corey.rb", "lib/chad.rb"]

data/spec/turbulence/cli_parser_spec.rb

@@ -0,0 +1,40 @@
+require 'rspec'
+require 'turbulence'
+
+describe Turbulence::CommandLineInterface::ConfigParser do
+  let(:config) { Turbulence::Configuration.new }
+
+  def parse(argv)
+    described_class.parse_argv_into_config(argv, config)
+  end
+
+  it "sets directory" do
+    parse %w( path/to/compute )
+    config.directory.should == 'path/to/compute'
+  end
+
+  it "sets SCM name to 'Perforce'" do
+    parse %w( --scm p4 )
+    config.scm_name.should == 'Perforce'
+  end
+
+  it "sets commit range" do
+    parse %w( --churn-range f3e1d7a6..830b9d3d9f )
+    config.commit_range.should eq('f3e1d7a6..830b9d3d9f')
+  end
+
+  it "sets compute mean" do
+    parse %w( --churn-mean )
+    config.compute_mean.should be_true
+  end
+
+  it "sets the exclusion pattern" do
+    parse %w( --exclude turbulence )
+    config.exclusion_pattern.should == 'turbulence'
+  end
+
+  it "sets the graph type" do
+    parse %w( --treemap )
+    config.graph_type.should == 'treemap'
+  end
+end

data/spec/turbulence/command_line_interface_spec.rb

@@ -3,11 +3,13 @@ require 'turbulence'
 
 describe Turbulence::CommandLineInterface do
   let(:cli) { Turbulence::CommandLineInterface.new(%w(.), :output => nil) }
+
   describe "::TEMPLATE_FILES" do
     Turbulence::CommandLineInterface::TEMPLATE_FILES.each do |template_file|
       File.dirname(template_file).should == Turbulence::CommandLineInterface::TURBULENCE_TEMPLATE_PATH
     end
   end
+
   describe "#generate_bundle" do
     before do
       FileUtils.remove_dir("turbulence", true)
@@ -28,23 +30,4 @@ describe Turbulence::CommandLineInterface do
       lines.any? { |l| l =~ /turbulence\.rb/ }.should be_false
     end
   end
-  describe "command line options" do
-    let(:cli_churn_range) { Turbulence::CommandLineInterface.new(%w(--churn-range f3e1d7a6..830b9d3d9f path/to/compute)) }
-    let(:cli_churn_mean) { Turbulence::CommandLineInterface.new(%w(--churn-mean .)) }
-    let(:cli_exclusion_pattern) { Turbulence::CommandLineInterface.new(%w(--exclude turbulence)) }
-
-    it "sets churn range" do
-      cli_churn_range.directory.should == 'path/to/compute'
-      Turbulence::Calculators::Churn.commit_range.should == 'f3e1d7a6..830b9d3d9f'
-    end
-
-    it "sets churn mean" do
-      cli_churn_mean.directory.should == '.'
-      Turbulence::Calculators::Churn.compute_mean.should be_true
-    end
-
-    it "sets the exclusion pattern" do
-      cli_exclusion_pattern.exclusion_pattern.should == 'turbulence'
-    end
-  end
 end

data/spec/turbulence/configuration_spec.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require 'turbulence'
+
+describe Turbulence::Configuration do
+  describe "defaults" do
+    its(:output)     { should eq(STDOUT) }
+    its(:directory)  { should eq(Dir.pwd) }
+    its(:graph_type) { should eq('turbulence') }
+    its(:scm_name)   { should eq('Git') }
+    its(:scm)        { should eq(Turbulence::Scm::Git) }
+  end
+end
+

data/spec/turbulence/turbulence_spec.rb

@@ -2,14 +2,22 @@ require 'rspec'
 require 'turbulence'
 
 describe Turbulence do
+  subject(:turb) { Turbulence.new(config) }
+
+  let(:config) {
+    Turbulence::Configuration.new.tap do |config|
+      config.directory         = '.'
+      config.exclusion_pattern = nil
+      config.output            = nil
+    end
+  }
+
   it "finds files of interest" do
-    turb = Turbulence.new(".")
-    turb.exclusion_pattern.should be_nil
     turb.files_of_interest.should include "lib/turbulence.rb"
   end
   
   it "filters out exluded files" do
-    turb = Turbulence.new(".", nil, 'turbulence')
+    config.exclusion_pattern = 'turbulence'
     turb.files_of_interest.should_not include "lib/turbulence.rb"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbulence
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Chad Fowler
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-04 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flog
@@ -103,7 +103,9 @@ files:
 - lib/turbulence/calculators/churn.rb
 - lib/turbulence/calculators/complexity.rb
 - lib/turbulence/checks_environment.rb
+- lib/turbulence/cli_parser.rb
 - lib/turbulence/command_line_interface.rb
+- lib/turbulence/configuration.rb
 - lib/turbulence/file_name_mangler.rb
 - lib/turbulence/generators/scatterplot.rb
 - lib/turbulence/generators/treemap.rb
@@ -112,8 +114,9 @@ files:
 - lib/turbulence/version.rb
 - spec/turbulence/calculators/churn_spec.rb
 - spec/turbulence/calculators/complexity_spec.rb
-- spec/turbulence/checks_environoment_spec.rb
+- spec/turbulence/cli_parser_spec.rb
 - spec/turbulence/command_line_interface_spec.rb
+- spec/turbulence/configuration_spec.rb
 - spec/turbulence/generators/scatter_plot_spec.rb
 - spec/turbulence/generators/treemap_spec.rb
 - spec/turbulence/scm/git_spec.rb
@@ -152,11 +155,11 @@ summary: Automates churn + flog scoring on a git repo for a Ruby project
 test_files:
 - spec/turbulence/calculators/churn_spec.rb
 - spec/turbulence/calculators/complexity_spec.rb
-- spec/turbulence/checks_environoment_spec.rb
+- spec/turbulence/cli_parser_spec.rb
 - spec/turbulence/command_line_interface_spec.rb
+- spec/turbulence/configuration_spec.rb
 - spec/turbulence/generators/scatter_plot_spec.rb
 - spec/turbulence/generators/treemap_spec.rb
 - spec/turbulence/scm/git_spec.rb
 - spec/turbulence/scm/perforce_spec.rb
 - spec/turbulence/turbulence_spec.rb
-has_rdoc: 

data/spec/turbulence/checks_environoment_spec.rb

@@ -1,11 +0,0 @@
-require 'rspec'
-require 'turbulence/scm/git'
-require 'turbulence'
-
-describe Turbulence::ChecksEnvironment do
-
-  it "should determine if the current directory is a git repository" do
-    Turbulence::Calculators::Churn.scm = Turbulence::Scm::Git
-    Turbulence::ChecksEnvironment.scm_repo?(Dir.pwd).should be_true
-  end    
-end