turbulence 1.2.3 → 1.3.0

data/lib/turbulence/calculators/complexity.rb

@@ -1,39 +1,31 @@
 require 'stringio'
 require 'flog'
 
-class Ruby19Parser < RubyParser
-  def process(ruby, file)
-    ruby.gsub!(/(\w+):\s+/, '"\1" =>')
-    super(ruby, file)
-  end
-end unless defined?(:Ruby19Parser)
-
-class Flog19 < Flog
-  def initialize option = {}
-    super(option)
-    @parser = Ruby19Parser.new
-  end
-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, :type
 
-        def score_for_file(filename)
-          flogger.reset
-          flogger.flog filename
-          flogger.total_score
+      def initialize(config = nil)
+        @config = config || Turbulence.config
+        @type = :complexity
+      end
+
+      def flogger
+        @flogger ||= Flog.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,53 @@
+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 cumulative') 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('--no-open', 'skip opening the report in a browser') do
+            config.no_open = true
+          end
+
+          opts.on('--output DIR', String, 'output directory for reports (default: ./turbulence)') do |dir|
+            config.output_dir = dir
+          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,60 +1,42 @@
 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)
+      ConfigParser.parse_argv_into_config argv, config
+      config.output = additional_options.fetch(:output, STDOUT)
+    end
 
-      @directory = argv.first || Dir.pwd
-      @output = additional_options.fetch(:output, STDOUT)
+    extend Forwardable
+    def_delegators :Turbulence, :config
+    def_delegators :config, *[
+      :directory,
+      :graph_type,
+      :exclusion_pattern,
+      :no_open,
+      :output_dir,
+    ]
+
+    def output_path
+      output_dir || File.join(Dir.pwd, "turbulence")
     end
 
     def copy_templates_into(directory)
@@ -62,12 +44,12 @@ class Turbulence
     end
 
     def generate_bundle
-      FileUtils.mkdir_p("turbulence")
+      FileUtils.mkdir_p(output_path)
 
-      Dir.chdir("turbulence") do
-        turb = Turbulence.new(directory, @output, @exclusion_pattern)
+      Dir.chdir(output_path) do
+        turb = Turbulence.new(config)
 
-        generator = case @graph_type
+        generator = case graph_type
         when "treemap"
           Turbulence::Generators::TreeMap.new({})
         else
@@ -79,7 +61,7 @@ class Turbulence
     end
 
     def open_bundle
-      Launchy.open("file:///#{directory}/turbulence/#{@graph_type}.html")
+      Launchy.open("file:///#{output_path}/#{graph_type}.html")
     end
   end
 end

data/lib/turbulence/configuration.rb

@@ -0,0 +1,30 @@
+class Turbulence
+  class Configuration
+    attr_accessor *[
+      :directory,
+      :scm,
+      :scm_name,
+      :commit_range,
+      :compute_mean,
+      :exclusion_pattern,
+      :graph_type,
+      :output,
+      :output_dir,
+      :no_open,
+    ]
+
+    def initialize
+      @directory  = Dir.pwd
+      @graph_type = 'turbulence'
+      @scm_name   = 'Git'
+      @output     = STDOUT
+      @output_dir = nil
+      @no_open    = false
+    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/generators/scatterplot.rb

@@ -4,8 +4,8 @@ class Turbulence
       attr_reader :metrics_hash, :x_metric, :y_metric
 
       def initialize(metrics_hash,
-                     x_metric = Turbulence::Calculators::Churn,
-                     y_metric = Turbulence::Calculators::Complexity)
+                     x_metric = :churn,
+                     y_metric = :complexity)
         @x_metric     = x_metric
         @y_metric     = y_metric
         @metrics_hash = metrics_hash

data/lib/turbulence/generators/treemap.rb

@@ -4,8 +4,8 @@ class Turbulence
       attr_reader :metrics_hash, :x_metric, :y_metric
 
       def initialize(metrics_hash,
-                     x_metric = Turbulence::Calculators::Churn,
-                     y_metric = Turbulence::Calculators::Complexity)
+                     x_metric = :churn,
+                     y_metric = :complexity)
         @x_metric     = x_metric
         @y_metric     = y_metric
         @metrics_hash = metrics_hash

data/lib/turbulence/scm/git.rb

@@ -8,7 +8,7 @@ class Turbulence
 
         def is_repo?(directory)
           FileUtils.cd(directory) {
-            return !(`git status 2>&1` =~ /Not a git repository/)
+            return !(`git status 2>&1` =~ /not a git repository/i)
           }
         end
       end

data/lib/turbulence/version.rb

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

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.type, 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/spec/turbulence/calculators/churn_spec.rb

@@ -1,152 +1,142 @@
 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) { "" }
+    allow(calculator).to receive(:scm_log_command).and_return("")
   end
 
   describe "::for_these_files" do
     it "yields up the filename and score for each file" do
       files = ["lib/corey.rb", "lib/chad.rb"]
-      calculator.stub(:changes_by_ruby_file) {
-        [
-          ["lib/corey.rb", 5],
-          ["lib/chad.rb", 10]
-      ]
-      }
+      allow(calculator).to receive(:changes_by_ruby_file).and_return([
+        ["lib/corey.rb", 5],
+        ["lib/chad.rb", 10]
+      ])
       yielded_files = []
       calculator.for_these_files(files) do |filename, score|
         yielded_files << [filename, score]
       end
-      yielded_files.should =~ [["lib/corey.rb", 5],
-        ["lib/chad.rb",10]]
+      expect(yielded_files).to match_array([["lib/corey.rb", 5], ["lib/chad.rb", 10]])
     end
 
     it "filters the results by the passed-in files" do
       files = ["lib/corey.rb"]
-      calculator.stub(:changes_by_ruby_file) {
-        [
-          ["lib/corey.rb", 5],
-          ["lib/chad.rb", 10]
-      ]
-      }
+      allow(calculator).to receive(:changes_by_ruby_file).and_return([
+        ["lib/corey.rb", 5],
+        ["lib/chad.rb", 10]
+      ])
       yielded_files = []
       calculator.for_these_files(files) do |filename, score|
         yielded_files << [filename, score]
       end
-      yielded_files.should =~ [["lib/corey.rb", 5]]
+      expect(yielded_files).to match_array([["lib/corey.rb", 5]])
     end
   end
 
   describe "::scm_log_file_lines" do
     it "returns just the file lines" do
-      calculator.stub(:scm_log_command) do
-      "\n\n\n\n10\t6\tlib/turbulence.rb\n\n\n\n17\t2\tlib/eddies.rb\n"
-      end
+      allow(calculator).to receive(:scm_log_command).and_return(
+        "\n\n\n\n10\t6\tlib/turbulence.rb\n\n\n\n17\t2\tlib/eddies.rb\n"
+      )
 
-      calculator.scm_log_file_lines.should =~ [
+      expect(calculator.scm_log_file_lines).to match_array([
         "10\t6\tlib/turbulence.rb",
         "17\t2\tlib/eddies.rb"
-      ]
+      ])
     end
   end
 
   describe "::counted_line_changes_by_file_by_commit" do
     before do
-      calculator.stub(:scm_log_file_lines) {
-        [
-          "10\t6\tlib/turbulence.rb",
-          "17\t2\tlib/eddies.rb"
-        ]
-      }
+      allow(calculator).to receive(:scm_log_file_lines).and_return([
+        "10\t6\tlib/turbulence.rb",
+        "17\t2\tlib/eddies.rb"
+      ])
     end
 
     it "sums up the line changes" do
-      calculator.counted_line_changes_by_file_by_commit.should =~ [["lib/turbulence.rb", 16], ["lib/eddies.rb", 19]]
+      expect(calculator.counted_line_changes_by_file_by_commit).to match_array([["lib/turbulence.rb", 16], ["lib/eddies.rb", 19]])
     end
   end
-  
+
   describe "::changes_by_ruby_file" do
     before do
-      calculator.stub(:ruby_files_changed_in_scm) {
-        [
-          ['lib/eddies.rb', 4],
-          ['lib/turbulence.rb', 5],
-          ['lib/turbulence.rb', 16],
-          ['lib/eddies.rb', 2],
-          ['lib/turbulence.rb', 7],
-          ['lib/eddies.rb', 19],
-          ['lib/eddies.rb', 28]
-        ]
-      }
+      allow(calculator).to receive(:ruby_files_changed_in_scm).and_return([
+        ['lib/eddies.rb', 4],
+        ['lib/turbulence.rb', 5],
+        ['lib/turbulence.rb', 16],
+        ['lib/eddies.rb', 2],
+        ['lib/turbulence.rb', 7],
+        ['lib/eddies.rb', 19],
+        ['lib/eddies.rb', 28]
+      ])
     end
-    
+
     it "groups and sums churns, excluding the last" do
       calculator.compute_mean = false
-      calculator.changes_by_ruby_file.should =~ [ ['lib/eddies.rb', 25], ['lib/turbulence.rb', 21]]
+      expect(calculator.changes_by_ruby_file).to match_array([['lib/eddies.rb', 25], ['lib/turbulence.rb', 21]])
     end
 
     it "interprets a single entry as zero churn" do
-      calculator.stub(:ruby_files_changed_in_scm) {
-        [
-          ['lib/eddies.rb', 4],
-        ]
-      }
+      allow(calculator).to receive(:ruby_files_changed_in_scm).and_return([
+        ['lib/eddies.rb', 4],
+      ])
       calculator.compute_mean = false
-      calculator.changes_by_ruby_file.should =~ [ ['lib/eddies.rb', 0] ]
+      expect(calculator.changes_by_ruby_file).to match_array([['lib/eddies.rb', 0]])
     end
-    
+
     it "groups and takes the mean of churns, excluding the last" do
       calculator.compute_mean = true
-      calculator.changes_by_ruby_file.should =~ [ ['lib/eddies.rb', 8], ['lib/turbulence.rb', 10]]
+      expect(calculator.changes_by_ruby_file).to match_array([['lib/eddies.rb', 8], ['lib/turbulence.rb', 10]])
       calculator.compute_mean = false
     end
   end
 
   describe "::calculate_mean_of_churn" do
     it "handles zero sample size" do
-      calculator.calculate_mean_of_churn(8,0).should == 8
+      expect(calculator.calculate_mean_of_churn(8, 0)).to eq 8
     end
 
-    it "returns original churn for sample size = 1"  do
-      calculator.calculate_mean_of_churn(8,1).should == 8
+    it "returns original churn for sample size = 1" do
+      expect(calculator.calculate_mean_of_churn(8, 1)).to eq 8
     end
 
     it "returns churn divided by sample size" do
-      calculator.calculate_mean_of_churn(25,3).should == 8
+      expect(calculator.calculate_mean_of_churn(25, 3)).to eq 8
     end
-
   end
 
   context "Full stack tests" do
     context "when one ruby file is given" do
       context "with two log entries for file" do
         before do
-          calculator.stub(:scm_log_command) do
+          allow(calculator).to receive(:scm_log_command).and_return(
             "\n\n\n\n10\t6\tlib/turbulence.rb\n" +
-              "\n\n\n\n11\t7\tlib/turbulence.rb\n"
-          end
+            "\n\n\n\n11\t7\tlib/turbulence.rb\n"
+          )
         end
         it "gives the line change count for the file" do
           yielded_files = []
           calculator.for_these_files(["lib/turbulence.rb"]) do |filename, score|
             yielded_files << [filename, score]
           end
-          yielded_files.should =~ [["lib/turbulence.rb", 16]]
+          expect(yielded_files).to match_array([["lib/turbulence.rb", 16]])
         end
         context "with only one log entry for file" do
           before do
-            calculator.stub(:scm_log_command) do
+            allow(calculator).to receive(:scm_log_command).and_return(
               "\n\n\n\n10\t6\tlib/turbulence.rb\n"
-            end
+            )
           end
           it "shows zero churn for the file" do
             yielded_files = []
             calculator.for_these_files(["lib/turbulence.rb"]) do |filename, score|
               yielded_files << [filename, score]
             end
-            yielded_files.should =~ [["lib/turbulence.rb", 0]]
+            expect(yielded_files).to match_array([["lib/turbulence.rb", 0]])
           end
         end
       end

data/spec/turbulence/calculators/complexity_spec.rb

@@ -1,19 +1,18 @@
 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"]
-      calculator.stub(:score_for_file) { |filename|
-        filename.size
-      }
+      allow(calculator).to receive(:score_for_file) { |filename| filename.size }
       yielded_files = []
       calculator.for_these_files(files) do |filename, score|
         yielded_files << [filename, score]
       end
-      yielded_files.should =~ [["lib/corey.rb", 12],
-        ["lib/chad.rb",11]]
+      expect(yielded_files).to match_array([["lib/corey.rb", 12], ["lib/chad.rb", 11]])
     end
   end
 end