turbulence 0.0.9 → 1.0.0

data/.gitignore

@@ -1,5 +1,9 @@
+*.swp
+.DS_Store
 pkg/*
 *.gem
+*.swp
 .bundle
 .rvmrc
 turbulence/*
+tmp/*

data/Gemfile

@@ -2,11 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in turbulence.gemspec
 gemspec
-
-gem 'flog', "= 2.5.0"
-gem 'json', "= 1.4.6"
-gem 'launchy', '~> 0.4.0'
-
-group :development, :test do
-  gem 'rspec'
-end

data/Gemfile.lock

@@ -1,42 +1,45 @@
 PATH
   remote: .
   specs:
-    turbulence (0.0.5)
+    turbulence (0.0.9)
+      ParseTree (~> 3.0.7)
       flog (= 2.5.0)
-      json (= 1.4.6)
-      launchy (~> 0.4.0)
+      json (>= 1.4.6)
+      launchy (~> 2.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    configuration (1.2.0)
-    diff-lcs (1.1.2)
+    ParseTree (3.0.8)
+      RubyInline (>= 3.7.0)
+      sexp_processor (>= 3.0.0)
+    RubyInline (3.11.0)
+      ZenTest (~> 4.3)
+    ZenTest (4.6.2)
+    addressable (2.2.6)
+    diff-lcs (1.1.3)
     flog (2.5.0)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
-    json (1.4.6)
-    launchy (0.4.0)
-      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)
+    json (1.6.1)
+    launchy (2.0.5)
+      addressable (~> 2.2.6)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-    ruby_parser (2.0.6)
+    rspec-mocks (2.6.0)
+    ruby_parser (2.3.1)
       sexp_processor (~> 3.0)
-    sexp_processor (3.0.5)
+    sexp_processor (3.0.7)
 
 PLATFORMS
   ruby
+  x86-mingw32
 
 DEPENDENCIES
-  flog (= 2.5.0)
-  json (= 1.4.6)
-  launchy (~> 0.4.0)
-  rspec
+  rspec (~> 2.6.0)
   turbulence!

data/README.md

@@ -1,17 +1,28 @@
 Hopefully-meaningful Metrics
 ============================
 
-A quick hack based on Michael Feathers' recent work in project churn and complexity:
-http://www.stickyminds.com/sitewide.asp?Function=edetail&ObjectType=COL&ObjectId=16679&tth=DYN&tt=siteemail&iDyn=2
+Based on Michael Feathers' [recent work](http://www.stickyminds.com/sitewide.asp?Function=edetail&ObjectType=COL&ObjectId=16679&tth=DYN&tt=siteemail&iDyn=2) in project churn and complexity.
 
+Installation
+------------
+
+    $ gem install turbulence
 
 Usage
 -----
+In your project directory, run:
+
+    $ bule
+
+and it will generate (and open) turbulence/turbulence.html 
 
-$ bule
+Supported SCM systems
+---------------------
+Currently, bule defaults to using git. If you are using Perforce, call it like so:
 
-For now it just dumps out a hash of churn + flog metrics
+    $ bule --scm p4
 
+You need to have an environment variable P4CLIENT set to the name of your client workspace.
 
 WARNING
 -------

data/Rakefile

@@ -1,4 +1,5 @@
 require 'bundler'
+require File.join(File.dirname(__FILE__), 'win_rakefile_location_fix')
 Bundler::GemHelper.install_tasks
 require 'rake'
 require 'rspec/core/rake_task'

data/bin/bule

@@ -2,12 +2,13 @@
 require 'turbulence'
 require 'turbulence/checks_environment'
 
-unless Turbulence::ChecksEnvironment.git_repo?(Dir.pwd)
-  STDERR.puts "Turbulence could not calculate metrics, as we could not find a git repository in the current directory."
-  STDERR.puts "Please run bule from inside a git repository."
+cli = Turbulence::CommandLineInterface.new(ARGV)
+
+unless Turbulence::ChecksEnvironment.scm_repo?(Dir.pwd)
+  STDERR.puts "Turbulence could not calculate metrics, as we could not find a repository in the current directory."
+  STDERR.puts "Please run bule from inside a repository."
   exit
 end
 
-cli = Turbulence::CommandLineInterface.new(Dir.pwd)
 cli.generate_bundle
 cli.open_bundle

data/lib/turbulence/calculators/churn.rb

@@ -1,38 +1,53 @@
 class Turbulence
   module Calculators
     class Churn
+      RUBY_FILE_EXTENSION = ".rb"
+
       class << self
+        attr_accessor :scm, :compute_mean, :commit_range
+
         def for_these_files(files)
-          changes_by_ruby_file.select do |count, filename|
+          changes_by_ruby_file.each do |filename, count|
             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]
+          ruby_files_changed_in_scm.group_by(&:first).map do |filename, stats|
+            churn_for_file(filename,stats)
           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]
+        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 calculate_mean_of_churn(churn, sample_size) 
+          return churn if sample_size < 1
+          churn /= sample_size
+        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 ruby_files_changed_in_git
-          counted_line_changes_by_file_by_commit.select do |filename, count|
-            filename =~ /\.rb$/ && File.exist?(filename)
+        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 git_log_file_lines
-          git_log_command.each_line.reject{|line| line =~ /^\n$/}.map(&:chomp)
+        def scm_log_file_lines
+          scm_log_command.each_line.reject{|line| line == "\n"}.map(&:chomp)
         end
 
-        def git_log_command
-          `git log --all -M -C --numstat --format="%n"`
+        def scm_log_command
+          scm.log_command(commit_range)
         end
       end
     end

data/lib/turbulence/calculators/complexity.rb

@@ -5,7 +5,7 @@ class Turbulence
     class Complexity
       class << self
         def flogger
-          @flogger ||= Flog.new
+          @flogger ||= Flog.new(:continue => true)
         end
         def for_these_files(files)
           files.each do |filename|
@@ -18,14 +18,13 @@ class Turbulence
           reporter = Reporter.new
           flogger.report(reporter)
           reporter.score
-        rescue SyntaxError, Racc::ParseError
-          STDERR.puts "\nError flogging: #{filename}\n"
         end
       end
 
       class Reporter < ::StringIO
+        SCORE_LINE_DETECTOR = /^\s+([^:]+).*flog total$/
         def score
-          Float(string.scan(/^\s+([^:]+).*total$/).flatten.first)
+          Float(string.scan(SCORE_LINE_DETECTOR).flatten.first)
         end
       end
     end

data/lib/turbulence/checks_environment.rb

@@ -1,11 +1,8 @@
-require 'open3'
 class Turbulence
   class ChecksEnvironment
     class << self
-      def git_repo?(directory)
-        Open3.popen3("git status") do |_, _, err, _|
-          return !(err.read =~ /Not a git repository/)  
-        end
+      def scm_repo?(directory)
+        Turbulence::Calculators::Churn.scm.is_repo?(directory)
       end
     end
   end

data/lib/turbulence/command_line_interface.rb

@@ -1,23 +1,51 @@
 require 'fileutils'
 require 'launchy'
+require 'optparse'
+require 'turbulence/scm/git'
+require 'turbulence/scm/perforce'
 
 class Turbulence
   class CommandLineInterface
-    TURBULENCE_PATH = File.join(File.expand_path(File.dirname(__FILE__)), "..", "..")
-
+    TURBULENCE_TEMPLATE_PATH = File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "template")
+    TEMPLATE_FILES = ['turbulence.html', 'highcharts.js', 'jquery.min.js'].map { |filename|
+      File.join(TURBULENCE_TEMPLATE_PATH, filename)
+    }
+    
+    attr_reader :exclusion_pattern
     attr_reader :directory
-    def initialize(directory)
-      @directory = directory
-    end
+    def initialize(argv)
+      Turbulence::Calculators::Churn.scm = Scm::Git
+      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
 
-    def path_to_template(filename)
-      File.join(TURBULENCE_PATH, "template", filename)
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+      end.parse!(argv)
+
+      @directory = argv.first || Dir.pwd
     end
 
     def copy_templates_into(directory)
-      ['turbulence.html', 'highcharts.js', 'jquery.min.js'].each do |filename|
-        FileUtils.cp path_to_template(filename), directory
-      end
+      FileUtils.cp TEMPLATE_FILES, directory
     end
     private :copy_templates_into
 
@@ -26,7 +54,8 @@ class 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
+          turb = Turbulence.new(directory,STDOUT, @exclusion_pattern)
+          f.write Turbulence::ScatterPlotGenerator.from(turb.metrics).to_js
         end
       end
     end

data/lib/turbulence/scatter_plot_generator.rb

@@ -1,31 +1,65 @@
 require 'json'
+
 class Turbulence
+  class FileNameMangler
+    def initialize
+      @current_id = 0
+      @segment_map = { "" => "", "app" => "app", "controllers" => "controllers", "helpers" => "helpers", "lib" => "lib" }
+    end
+
+    def transform(segment)
+      @segment_map[segment] ||= (@current_id += 1)
+    end
+
+    def mangle_name(filename)
+      filename.split('/').map {|seg|transform(seg)}.join('/') + ".rb"
+    end
+  end
+
   class ScatterPlotGenerator
     def self.from(metrics_hash)
       new(metrics_hash)
     end
-    attr_reader :metrics_hash
-    def initialize(metrics_hash)
+    attr_reader :metrics_hash, :x_metric, :y_metric
+    def initialize(metrics_hash, x_metric = Turbulence::Calculators::Churn, y_metric = Turbulence::Calculators::Complexity)
+      @x_metric = x_metric
+      @y_metric = y_metric
       @metrics_hash = metrics_hash
     end
 
+    def mangle
+      mangler = FileNameMangler.new
+      mangled = {}
+      metrics_hash.each_pair { |filename, metrics| mangled[mangler.mangle_name(filename)] = metrics}
+      @metrics_hash = mangled
+    end
+
     def to_js
-      grouped_by_directory = metrics_hash.group_by do |filename, _|
+      clean_metrics_from_missing_data
+      directory_series = {}
+      grouped_by_directory.each_pair do |directory, metrics_hash|
+        directory_series[directory] = file_metrics_for_directory(metrics_hash)      end
+
+      "var directorySeries = #{directory_series.to_json};"
+    end
+
+    def clean_metrics_from_missing_data
+      metrics_hash.reject! do |filename, metrics|
+        metrics[x_metric].nil? || metrics[y_metric].nil?
+      end
+    end
+
+    def grouped_by_directory
+      metrics_hash.group_by do |filename, _|
         directories = File.dirname(filename).split("/")
         directories[0..1].join("/")
       end
+    end
 
-      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[Turbulence::Calculators::Churn], :y => metrics[Turbulence::Calculators::Complexity]}
-        end.reject do |metrics|
-          metrics[:x].nil? || metrics[:y].nil?
-        end
-        directory_series[directory] = data_in_json_format
+    def file_metrics_for_directory(metrics_hash)
+      metrics_hash.map do |filename, metrics|
+        {:filename => filename, :x => metrics[x_metric], :y => metrics[y_metric]}
       end
-
-      "var directorySeries = #{directory_series.to_json};"
     end
   end
 end

data/lib/turbulence/scm/git.rb

@@ -0,0 +1,17 @@
+class Turbulence
+  module Scm
+    class Git
+      class << self
+        def log_command(commit_range = "")
+          `git log --all -M -C --numstat --format="%n" #{commit_range}`
+        end
+
+        def is_repo?(directory)
+          FileUtils.cd(directory) {
+            return !(`git status 2>&1` =~ /Not a git repository/)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/turbulence/scm/perforce.rb

@@ -0,0 +1,90 @@
+require 'fileutils'
+require 'pathname'
+
+class Turbulence
+  module Scm
+    class Perforce 
+      class << self
+        def log_command(commit_range = "")
+          full_log = ""
+          changes.each do |cn|
+            files_per_change(cn).each do |file|
+              full_log << transform_for_output(file)
+            end
+          end
+          return full_log
+        end
+
+        def is_repo?(directory)
+          p4client = ENV['P4CLIENT']
+          return !((p4client.nil? or p4client.empty?) and not self.has_p4?)
+        end
+
+        def has_p4?
+          ENV['PATH'].split(File::PATH_SEPARATOR).any? do |directory|
+            File.executable?(File.join(directory, 'p4'))
+          end
+        end
+
+        def changes(commit_range = "")
+          p4_list_changes.each_line.map do |change|
+            change.match(/Change (\d+)/)[1]
+          end
+        end
+
+        def depot_to_local(depot_file)
+          abs_path = extract_clientfile_from_fstat_of(depot_file) 
+          Pathname.new(abs_path).relative_path_from(Pathname.new(FileUtils.pwd)).to_s
+        end
+
+        def extract_clientfile_from_fstat_of(depot_file)
+          p4_fstat(depot_file).each_line.select {
+            |line| line =~ /clientFile/
+          }[0].split(" ")[2].tr("\\","/")
+        end
+
+        def files_per_change(change)
+          describe_output = p4_describe_change(change).split("\n")
+          map = []
+          describe_output.each_index do |index|
+            if describe_output[index].start_with?("====")
+              fn = filename_from_describe(describe_output, index)
+              churn = sum_of_changes(describe_output[index .. index + 4].join("\n"))
+              map << [churn,fn]
+            end
+          end
+          return map
+        end
+
+        def filename_from_describe(output,index)
+          depot_to_local(output[index].match(/==== (\/\/.*)#\d+/)[1])
+        end
+
+        def transform_for_output(arr)
+          "#{arr[0]}\t0\t#{arr[1]}\n"
+        end
+
+        def sum_of_changes(p4_describe_output) 
+          churn = 0
+          p4_describe_output.each_line do |line|
+            next unless line =~ /(add|deleted|changed) .* (\d+) lines/
+            churn += line.match(/(\d+) lines/)[1].to_i
+          end
+          return churn
+        end
+
+        def p4_list_changes(commit_range = "")
+          `p4 changes -s submitted ...#{commit_range}`
+        end
+
+        def p4_fstat(depot_file)
+          `p4 fstat #{depot_file}`
+        end
+
+        def p4_describe_change(change)
+          `p4 describe -ds #{change}`
+        end
+      end
+    end
+  end
+end

data/lib/turbulence/version.rb

@@ -1,3 +1,3 @@
 class Turbulence
-  VERSION = "0.0.9"
+  VERSION = "1.0.0"
 end

data/lib/turbulence.rb

@@ -1,43 +1,43 @@
 require 'turbulence/scatter_plot_generator'
 require 'turbulence/command_line_interface'
+require 'turbulence/checks_environment'
 require 'turbulence/calculators/churn'
 require 'turbulence/calculators/complexity'
 
 class Turbulence
-  attr_reader :dir
+  CODE_DIRECTORIES = ["app/models", "app/controllers", "app/helpers", "lib"]
+  CALCULATORS = [Turbulence::Calculators::Complexity, Turbulence::Calculators::Churn]
+
+  attr_reader :exclusion_pattern
   attr_reader :metrics
-  def initialize(dir)
-    @dir = dir
+  def initialize(directory, output = nil, exclusion_pattern = nil)
+    @output = output
     @metrics = {}
-    Dir.chdir(dir) do
-      churn
-      complexity
+    @exclusion_pattern = exclusion_pattern
+    Dir.chdir(directory) do
+      CALCULATORS.each(&method(:calculate_metrics_with))
     end
   end
 
   def files_of_interest
-    files = ["app/models", "app/controllers", "app/helpers", "lib"].map{|base_dir| "#{base_dir}/**/*\.rb"}
-    @ruby_files ||= Dir[*files]
-  end
-
-  def complexity
-    calculate_metrics Turbulence::Calculators::Complexity
-  end
-
-  def churn
-    calculate_metrics Turbulence::Calculators::Churn
+    file_list = CODE_DIRECTORIES.map{|base_dir| "#{base_dir}/**/*\.rb"}
+    @ruby_files ||= exclude_files(Dir[*file_list])
   end
 
-  def calculate_metrics(calculator)
-    puts "calculating metric: #{calculator}"
+  def calculate_metrics_with(calculator)
+    report "calculating metric: #{calculator}\n"
     calculator.for_these_files(files_of_interest) do |filename, score|
+      report "."
       set_file_metric(filename, calculator, score)
     end
-    puts "\n"
+    report "\n"
+  end
+
+  def report(this)
+    @output.print this unless @output.nil?
   end
 
   def set_file_metric(filename, metric, value)
-    print "."
     metrics_for(filename)[metric] = value
   end
 
@@ -45,4 +45,11 @@ class Turbulence
     @metrics[filename] ||= {}
   end
 
+  private
+  def exclude_files(files)
+    if not @exclusion_pattern.nil?
+      files = files.reject { |f| f =~ Regexp.new(@exclusion_pattern) }
+    end
+    files
+  end
 end