turbulence 0.0.3 → 0.0.4

data/Gemfile

@@ -6,3 +6,7 @@ gemspec
 gem 'flog'
 gem 'json'
 gem 'launchy', '~> 0.4.0'
+
+group :development, :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    turbulence (0.0.2)
+    turbulence (0.0.3)
       flog (= 2.5.0)
       json (= 1.4.6)
       launchy (~> 0.4.0)
@@ -10,6 +10,7 @@ GEM
   remote: http://rubygems.org/
   specs:
     configuration (1.2.0)
+    diff-lcs (1.1.2)
     flog (2.5.0)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
@@ -18,6 +19,14 @@ GEM
       configuration (>= 0.0.5)
       rake (>= 0.8.1)
     rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
     ruby_parser (2.0.6)
       sexp_processor (~> 3.0)
     sexp_processor (3.0.5)
@@ -29,4 +38,5 @@ DEPENDENCIES
   flog
   json
   launchy (~> 0.4.0)
+  rspec
   turbulence!

data/bin/bule

@@ -1,32 +1,6 @@
 #!/usr/bin/env ruby
 require 'turbulence'
-require 'turbulence/scatter_plot_generator'
-require 'fileutils'
-require 'launchy'
-TURBULENCE_PATH = File.join(File.absolute_path(File.dirname(__FILE__)), "..")
 
-def path_to_template(filename)
-  File.join(TURBULENCE_PATH, "template", filename)
-end
-
-def copy_templates_into(directory)
-  FileUtils.cp path_to_template('turbulence.html'), directory
-  FileUtils.cp path_to_template('highcharts.js'), directory
-  FileUtils.cp path_to_template('jquery.min.js'), directory
-end
-
-def generate_bundle_for(git_repo)
-  FileUtils.mkdir_p("turbulence")
-  Dir.chdir("turbulence") do
-    copy_templates_into(Dir.pwd)  
-    File.open("cc.js", "w") do |f| 
-      f.write Turbulence::ScatterPlotGenerator.from(Turbulence.new(git_repo).metrics)
-    end
-  end
-end
-
-def open_bundle(directory)
-  Launchy.open("file://#{directory}/turbulence/turbulence.html")
-end
-generate_bundle_for Dir.pwd
-open_bundle Dir.pwd
+cli = Turbulence::CommandLineInterface.new(Dir.pwd)
+cli.generate_bundle
+cli.open_bundle

data/lib/turbulence.rb

@@ -1,13 +1,9 @@
-require 'flog'
-require 'stringio'
+require 'turbulence/scatter_plot_generator'
+require 'turbulence/command_line_interface'
+require 'turbulence/calculators/churn'
+require 'turbulence/calculators/complexity'
 
 class Turbulence
-  class Reporter < StringIO
-    def average
-      Float(string.scan(/^\s+([^:]+).*total$/).flatten.first)
-    end
-  end
-
   attr_reader :dir
   attr_reader :metrics
   def initialize(dir)
@@ -19,52 +15,34 @@ class Turbulence
     end
   end
 
-  def ruby_files
+  def files_of_interest
     files = ["app/models", "app/controllers", "app/helpers", "lib"].map{|base_dir| "#{base_dir}/**/*\.rb"}
     @ruby_files ||= Dir[*files]
   end
 
-  def churn
-    files = changes_by_ruby_file.select { |_, filename| ruby_files.include?(filename) }
-    files.each do |count, filename|
-      print "."
-      metrics_for(filename)[:churn] = Integer(count)
-    end
+  def complexity
+    calculate_metrics Turbulence::Calculators::Complexity
   end
 
-  def complexity
-    flogger = Flog.new
-    ruby_files.each do |filename|
-      print "."
+  def churn
+    calculate_metrics Turbulence::Calculators::Churn
+  end
 
-      begin
-        flogger.flog filename
-        reporter = Reporter.new
-        flogger.report(reporter)
-        metrics_for(filename)[:complexity] = reporter.average
-      rescue SyntaxError, Racc::ParseError => e
-        puts "\nError flogging: #{filename}\n"
-      end
+  def calculate_metrics(calculator)
+    puts "calculating metric: #{calculator}"
+    calculator.for_these_files(files_of_interest) do |filename, score|
+      set_file_metric(filename, calculator, score)
     end
+    puts "\n"
+  end
+
+  def set_file_metric(filename, metric, value)
+    print "."
+    metrics_for(filename)[metric] = value
   end
 
   def metrics_for(filename)
     @metrics[filename] ||= {}
   end
 
-  private
-    def changes_by_ruby_file
-      line_changes_by_file.select do |count, filename|
-        filename =~ /\.rb$/ && File.exist?(filename)
-      end
-    end
-
-    def line_changes_by_file
-      `git log --all -M -C --numstat --format="%n"`.each_line.reject{|line| line =~ /^\n$/}.map do |line|
-        adds, deletes, filename = line.chomp.split(/\t/)
-        [filename, adds.to_i + deletes.to_i]
-      end.group_by(&:first).map do |filename, stats|
-        [stats.map(&:last).tap{|list| list.pop}.inject(0){|n, i| n + i}, filename]
-      end
-    end
 end

data/lib/turbulence/calculators/churn.rb

@@ -0,0 +1,40 @@
+class Turbulence
+  module Calculators
+    class Churn
+      class << self
+        def for_these_files(files)
+          changes_by_ruby_file.select do |count, filename|
+            yield filename, count if files.include?(filename)
+          end
+        end
+
+        def changes_by_ruby_file
+          ruby_files_changed_in_git.group_by(&:first).map do |filename, stats|
+            [stats.map(&:last).tap{|list| list.pop}.inject(0){|n, i| n + i}, filename]
+          end
+        end
+
+        def counted_line_changes_by_file_by_commit
+          git_log_file_lines.map do |line|
+            adds, deletes, filename = line.split(/\t/)
+            [filename, adds.to_i + deletes.to_i]
+          end
+        end
+
+        def ruby_files_changed_in_git
+          counted_line_changes_by_file_by_commit.select do |filename, count|
+            filename =~ /\.rb$/ && File.exist?(filename)
+          end
+        end
+
+        def git_log_file_lines
+          git_log_command.each_line.reject{|line| line =~ /^\n$/}.map(&:chomp)
+        end
+
+        def git_log_command
+          `git log --all -M -C --numstat --format="%n"`
+        end
+      end
+    end
+  end
+end

data/lib/turbulence/calculators/complexity.rb

@@ -0,0 +1,33 @@
+require 'stringio'
+require 'flog'
+class Turbulence
+  module Calculators
+    class Complexity
+      class << self
+        def flogger
+          @flogger ||= Flog.new
+        end
+        def for_these_files(files)
+          files.each do |filename|
+            yield filename, score_for_file(filename)
+          end
+        end
+
+        def score_for_file(filename)
+          flogger.flog filename
+          reporter = Reporter.new
+          flogger.report(reporter)
+          reporter.score
+        rescue SyntaxError, Racc::ParseError
+          STDERR.puts "\nError flogging: #{filename}\n"
+        end
+      end
+
+      class Reporter < ::StringIO
+        def score
+          Float(string.scan(/^\s+([^:]+).*total$/).flatten.first)
+        end
+      end
+    end
+  end
+end

data/lib/turbulence/command_line_interface.rb

@@ -0,0 +1,37 @@
+require 'fileutils'
+require 'launchy'
+
+class Turbulence
+  class CommandLineInterface
+    TURBULENCE_PATH = File.join(File.absolute_path(File.dirname(__FILE__)), "..", "..")
+
+    attr_reader :directory
+    def initialize(directory)
+      @directory = directory
+    end
+
+    def path_to_template(filename)
+      File.join(TURBULENCE_PATH, "template", filename)
+    end
+
+    def copy_templates_into(directory)
+      ['turbulence.html', 'highcharts.js', 'jquery.min.js'].each do |filename|
+        FileUtils.cp path_to_template(filename), directory
+      end
+    end
+
+    def generate_bundle
+      FileUtils.mkdir_p("turbulence")
+      Dir.chdir("turbulence") do
+        copy_templates_into(Dir.pwd)
+        File.open("cc.js", "w") do |f|
+          f.write Turbulence::ScatterPlotGenerator.from(Turbulence.new(directory).metrics).to_js
+        end
+      end
+    end
+
+    def open_bundle
+      Launchy.open("file://#{directory}/turbulence/turbulence.html")
+    end
+  end
+end

data/lib/turbulence/scatter_plot_generator.rb

@@ -2,14 +2,14 @@ require 'json'
 class Turbulence
   class ScatterPlotGenerator
     def self.from(metrics_hash)
+      new(metrics_hash)
+    end
+    attr_reader :metrics_hash
+    def initialize(metrics_hash)
+      @metrics_hash = metrics_hash
+    end
 
-      data_in_json_format = metrics_hash.map do |filename, metrics|
-        {:filename => filename, :x => metrics[:churn], :y => metrics[:complexity]}
-      end.reject do |metrics|
-          metrics[:x].nil? || metrics[:y].nil?
-      end.to_json
-      series = ["var turbulenceGraphData = #{data_in_json_format};"]
-
+    def to_js
       grouped_by_directory = metrics_hash.group_by do |filename, _|
         directories = File.dirname(filename).split("/")
         directories[0..1].join("/")
@@ -18,16 +18,14 @@ class Turbulence
       directory_series = {}
       grouped_by_directory.each_pair do |directory, metrics_hash|
         data_in_json_format = metrics_hash.map do |filename, metrics|
-          {:filename => filename, :x => metrics[:churn], :y => metrics[:complexity]}
+          {:filename => filename, :x => metrics[Turbulence::Calculators::Churn], :y => metrics[Turbulence::Calculators::Complexity]}
         end.reject do |metrics|
-            metrics[:x].nil? || metrics[:y].nil?
+          metrics[:x].nil? || metrics[:y].nil?
         end
         directory_series[directory] = data_in_json_format
       end
 
-      series << "var directorySeries = #{directory_series.to_json};"
-
-      series.join("\n")
+      "var directorySeries = #{directory_series.to_json};"
     end
   end
 end

data/lib/turbulence/version.rb

@@ -1,3 +1,3 @@
 class Turbulence
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/turbulence/calculators/churn_spec.rb

@@ -0,0 +1,103 @@
+require 'turbulence/calculators/churn'
+
+describe Turbulence::Calculators::Churn do
+  let(:calculator) { Turbulence::Calculators::Churn }
+  before do
+    calculator.stub(:git_log_command) { "" }
+  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) {
+        [
+          [5, "lib/corey.rb"],
+          [10, "lib/chad.rb"]
+      ]
+      }
+      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]]
+    end
+
+    it "filters the results by the passed-in files" do
+      files = ["lib/corey.rb"]
+      calculator.stub(:changes_by_ruby_file) {
+        [
+          [5, "lib/corey.rb"],
+          [10, "lib/chad.rb"]
+      ]
+      }
+      yielded_files = []
+      calculator.for_these_files(files) do |filename, score|
+        yielded_files << [filename, score]
+      end
+      yielded_files.should =~ [["lib/corey.rb", 5]]
+    end
+  end
+
+  describe "::git_log_file_lines" do
+    it "returns just the file lines" do
+      calculator.stub(:git_log_command) do
+      "\n\n\n\n10\t6\tlib/turbulence.rb\n\n\n\n17\t2\tlib/eddies.rb\n"
+      end
+
+      calculator.git_log_file_lines.should =~ [
+        "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(:git_log_file_lines) {
+        [
+          "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]]
+    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(:git_log_command) do
+            "\n\n\n\n10\t6\tlib/turbulence.rb\n" +
+              "\n\n\n\n11\t7\tlib/turbulence.rb\n"
+          end
+        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]]
+        end
+        context "with only one log entry for file" do
+          before do
+            calculator.stub(:git_log_command) do
+              "\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]]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/turbulence/calculators/complexity_spec.rb

@@ -0,0 +1,37 @@
+require 'turbulence/calculators/complexity'
+
+describe Turbulence::Calculators::Complexity do
+  let(:calculator) { Turbulence::Calculators::Complexity }
+  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
+      }
+      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]]
+    end
+  end
+end
+
+describe Turbulence::Calculators::Complexity::Reporter do
+  subject { Turbulence::Calculators::Complexity::Reporter.new }
+  it "uses the total value from flog" do
+    flog_output = <<-FLOG_OUTPUT
+     38.7: flog total
+     5.5: flog/method average
+
+     9.3: Turbulence#initialize            lib/turbulence.rb:9
+     8.7: Turbulence#churn                 lib/turbulence.rb:41
+     6.1: Turbulence#complexity            lib/turbulence.rb:26
+FLOG_OUTPUT
+
+    subject.stub(:string) { flog_output }
+
+    subject.score.should == 38.7
+  end
+end

data/template/turbulence.html

@@ -22,18 +22,19 @@ $(document).ready(function() {
             enabled: true,
             text: 'Churn'
          },
-         startOnTick: true,
-         endOnTick: true,
-         showLastLabel: true,
-         min: 0
+         startOnTick: false,
+         endOnTick: false,
+         labels: {enabled:false},
+         lineWidth: 0,
+         tickWidth: 0
       },
       yAxis: {
          title: {
             text: 'Complexity'
           },
-          min: 0,
-          max: 50
-
+         startOnTick: false,
+         endOnTick: false,
+         labels: {enabled:false}
       },
       tooltip: {
         formatter: function() {

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Chad Fowler
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-27 00:00:00 -07:00
+date: 2011-02-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,8 +84,13 @@ files:
 - Rakefile
 - bin/bule
 - lib/turbulence.rb
+- lib/turbulence/calculators/churn.rb
+- lib/turbulence/calculators/complexity.rb
+- lib/turbulence/command_line_interface.rb
 - lib/turbulence/scatter_plot_generator.rb
 - lib/turbulence/version.rb
+- spec/turbulence/calculators/churn_spec.rb
+- spec/turbulence/calculators/complexity_spec.rb
 - template/highchart_template.js.erb
 - template/highcharts.js
 - template/jquery.min.js
@@ -123,5 +128,6 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Automates churn + flog scoring on a git repo for a Ruby project
-test_files: []
-
+test_files: 
+- spec/turbulence/calculators/churn_spec.rb
+- spec/turbulence/calculators/complexity_spec.rb