indirect-metric_fu 0.8.1

data/lib/metric_fu.rb

@@ -0,0 +1,14 @@
+module MetricFu
+  TEMPLATE_DIR = File.join(File.dirname(__FILE__), "templates")
+  BASE_DIRECTORY = ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu'
+  RAILS = File.exist?("config/environment.rb")
+  
+  if RAILS
+    CODE_DIRS = ['app', 'lib']
+  else
+    CODE_DIRS = ['lib']
+  end
+end
+
+require File.join(File.dirname(__FILE__), 'tasks', 'metric_fu')
+Dir[File.join(File.dirname(__FILE__), 'metric_fu/*.rb')].each{|l| require l }

data/lib/tasks/churn.rake

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '../metric_fu/churn')
+
+namespace :metrics do
+  
+  desc "Which files change the most"
+  task :churn do
+    churn_dir = File.join(MetricFu::BASE_DIRECTORY, 'churn')
+    MetricFu::Churn.generate_report(churn_dir, defined?(MetricFu::CHURN_OPTIONS) ? MetricFu::CHURN_OPTIONS : {} )
+    system("open #{churn_dir}/index.html") if PLATFORM['darwin']
+  end
+end

data/lib/tasks/coverage.rake

@@ -0,0 +1,42 @@
+require 'fileutils'
+
+begin
+  require 'rcov'
+  require 'rcov/rcovtask'
+  require 'spec/rake/spectask'
+
+  namespace :metrics do
+
+    COVERAGE_DIR = File.join(MetricFu::BASE_DIRECTORY, 'coverage')
+    COVERAGE_DATA_FILE = File.join(MetricFu::BASE_DIRECTORY, 'coverage.data')
+    SPEC_HTML_FILE = File.join(MetricFu::BASE_DIRECTORY, 'specs.html')
+
+    namespace :coverage do
+      rcov_output = COVERAGE_DIR
+      
+      desc "Delete aggregate coverage data."
+      task(:clean) { rm_f("rcov_tmp", :verbose => false) }
+        
+      Spec::Rake::SpecTask.new(:do => :clean) do |t|
+        FileUtils.mkdir_p(MetricFu::BASE_DIRECTORY) unless File.directory?(MetricFu::BASE_DIRECTORY)
+        t.ruby_opts = ['-rtest/unit']
+        t.spec_files = FileList['test/**/*_test.rb', 'spec/**/*spec.rb']
+        t.spec_opts = ["--format", "html:#{SPEC_HTML_FILE}", "--diff"]
+        t.rcov = true
+        t.rcov_opts = ["--sort coverage", "--html", "--rails", "--exclude /gems/,/Library/"]
+        t.rcov_dir = COVERAGE_DIR
+      end
+    end
+    
+    desc "Generate RCov report"
+    task :coverage => ['coverage:do'] do
+      system("open #{SPEC_HTML_FILE}") if PLATFORM['darwin']
+    end
+  end
+rescue LoadError
+  if RUBY_PLATFORM =~ /java/
+    puts 'running in jruby - rcov tasks not available'
+  else
+    puts 'sudo gem install rcov # if you want the rcov tasks'
+  end
+end

data/lib/tasks/flog.rake

@@ -0,0 +1,69 @@
+begin
+  FLOG_DIR = File.join(MetricFu::BASE_DIRECTORY, 'flog')
+
+  def flog(output, directory)
+    Dir.glob("#{directory}/**/*.rb").each do |filename|
+      output_dir = "#{FLOG_DIR}/#{filename.split("/")[0..-2].join("/")}"
+      mkdir_p(output_dir, :verbose => false) unless File.directory?(output_dir)
+      `flog #{filename} > #{FLOG_DIR}/#{filename.split('.')[0]}.txt` if MetricFu::MD5Tracker.file_changed?(filename, FLOG_DIR)
+    end
+  end
+
+  namespace :metrics do
+  
+    task :flog => ['flog:all'] do
+    end
+    
+    namespace :flog do
+      desc "Delete aggregate flog data."
+      task(:clean) { rm_rf(FLOG_DIR, :verbose => false) }
+  
+      desc "Flog code in app/models"
+      task :models do
+        flog "models", "app/models"
+      end
+
+      desc "Flog code in app/controllers"  
+      task :controllers do
+        flog "controllers", "app/controllers"
+      end
+
+      desc "Flog code in app/helpers"  
+      task :helpers do
+        flog "helpers", "app/helpers"
+      end
+
+      desc "Flog code in lib"  
+      task :lib do
+        flog "lib", "lib"
+      end  
+
+      desc "Generate a flog report from specified directories"
+      task :custom do
+        MetricFu::CODE_DIRS.each { |directory| flog(directory, directory) }
+        MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
+      end      
+      
+      desc "Generate and open flog report"
+      if MetricFu::RAILS
+        task :all => [:models, :controllers, :helpers, :lib] do
+          MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
+          system("open #{FLOG_DIR}/index.html") if PLATFORM['darwin']
+        end
+      else
+        task :all => [:custom] do
+          MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
+          system("open #{FLOG_DIR}/index.html") if PLATFORM['darwin']
+        end
+      end
+      
+    end
+
+  end
+rescue LoadError
+  if RUBY_PLATFORM =~ /java/
+    puts 'running in jruby - flog tasks not available'
+  else
+    puts 'sudo gem install flog # if you want the flog tasks'
+  end
+end

data/lib/tasks/metric_fu.rake

@@ -0,0 +1,16 @@
+namespace :metrics do
+  task :prepare do
+    RAILS_ENV = 'test'
+  end
+  
+  desc "Useful for continuous integration"
+  task :all_with_migrate => [:prepare, "db:migrate", :all]
+  
+  if MetricFu::RAILS
+    desc "Generate coverage, cyclomatic complexity, flog, stats, and churn reports"
+    task :all => [:coverage, :saikuro, :flog, :churn, :stats]
+  else
+    desc "Generate coverage, cyclomatic complexity, flog, and churn reports"
+    task :all => [:coverage, :saikuro, :flog, :churn]
+  end
+end

data/lib/tasks/metric_fu.rb

@@ -0,0 +1,6 @@
+require 'fileutils'
+require 'rubygems'
+require 'rake'
+
+# Load rake files
+Dir["#{File.dirname(__FILE__)}/*.rake"].each { |ext| load ext }

data/lib/tasks/saikuro.rake

@@ -0,0 +1,35 @@
+require 'fileutils'
+
+namespace :metrics do
+
+  desc "A cyclomatic complexity report using Saikuro"
+  task :saikuro do
+    SAIKURO_DIR = File.join(MetricFu::BASE_DIRECTORY, 'saikuro')
+    SAIKURO = File.expand_path(File.join(File.dirname(__FILE__), '..', 'metric_fu', 'saikuro', 'saikuro.rb'))
+
+    raise "SAIKURO_OPTIONS is now MetricFu::SAIKURO_OPTIONS" if defined?(SAIKURO_OPTIONS)
+    options = { :output_directory => SAIKURO_DIR,
+                        :input_directory => MetricFu::CODE_DIRS,
+                        :cyclo => "",
+                        :filter_cyclo => "0",
+                        :warn_cyclo => "5",
+                        :error_cyclo => "7"}
+  
+    options.merge!(MetricFu::SAIKURO_OPTIONS) if defined?(MetricFu::SAIKURO_OPTIONS)
+    options_string = options.inject(""){ |o, h| o + "--#{h.join(' ')} " }  
+     
+    sh %{ruby "#{SAIKURO}" #{options_string}} do |ok, response|
+      unless ok
+        puts "Saikuro failed with exit status: #{response.exitstatus}"
+        exit 1
+      end
+    end
+
+    if File.exist? "#{SAIKURO_DIR}/index_cyclo.html"
+      mv "#{SAIKURO_DIR}/index_cyclo.html", 
+         "#{SAIKURO_DIR}/index.html"
+    end
+    
+    system("open #{SAIKURO_DIR}/index.html") if PLATFORM['darwin']
+  end
+end

data/lib/tasks/stats.rake

@@ -0,0 +1,14 @@
+namespace :metrics do
+  
+  STATS_DIR = File.join(MetricFu::BASE_DIRECTORY, 'stats')
+  STATS_FILE = File.join(STATS_DIR, 'index.html')
+  
+  desc "A stats report"
+  task :stats do
+    mkdir_p(STATS_DIR) unless File.directory?(STATS_DIR)
+    `echo '<pre>' > #{STATS_FILE}`
+    `rake stats >> #{STATS_FILE}`
+    `echo '</pre>' >> #{STATS_FILE}`
+    system("open #{STATS_FILE}") if PLATFORM['darwin']
+  end
+end

data/spec/churn_spec.rb

@@ -0,0 +1,63 @@
+require 'spec'
+require File.dirname(__FILE__) + '/../lib/metric_fu/churn'
+include MetricFu
+
+describe MetricFu::Churn do
+  describe "generate_report" do
+    after do
+      load File.dirname(__FILE__) + '/../lib/metric_fu/churn.rb' #need to reload file to wipe out mock of private static
+    end
+    
+    it "should strip out files that have less than the min count" do
+      Churn.should_receive(:churn_options).and_return(["", 5, :git])
+      Churn.should_receive(:parse_log_for_changes).with(:git, "").and_return({"reject" => 4, "accept" => 5})
+      Churn.should_receive(:write_churn_file).with({"accept" => 5}, "output_dir")
+      Churn.generate_report("output_dir", {})
+    end
+  end
+  
+  describe "parse_log_for_changes" do
+    it "should count the changes with git" do
+      logs = ["home_page/index.html", "README", "History.txt", "README", "History.txt", "README"]
+      Churn.should_receive(:get_logs).with(:git, "").and_return(logs)
+      changes = Churn.send(:parse_log_for_changes, :git, "")
+      
+      changes["home_page/index.html"].should == 1
+      changes["History.txt"].should == 2
+      changes["README"].should == 3
+    end
+    
+    it "should count the changes with svn" do
+      logs = ["home_page/index.html", "README", "History.txt", "README", "History.txt", "README"]
+      Churn.should_receive(:get_logs).with(:svn, "").and_return(logs)
+      changes = Churn.send(:parse_log_for_changes, :svn, "")
+      
+      changes["home_page/index.html"].should == 1
+      changes["History.txt"].should == 2
+      changes["README"].should == 3
+    end    
+  end
+  
+  describe "clean_up_svn_line" do
+    it "should return nil for non matches" do
+      Churn.send(:clean_up_svn_line, "Adding Google analytics").should be_nil
+      Churn.send(:clean_up_svn_line, "A bunch of new files").should be_nil
+    end
+      
+    it "should strip out all but the full path" do
+      Churn.send(:clean_up_svn_line, "   A /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
+      Churn.send(:clean_up_svn_line, "A   /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
+      Churn.send(:clean_up_svn_line, "   A   /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
+      Churn.send(:clean_up_svn_line, "   A /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
+      Churn.send(:clean_up_svn_line, "A /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
+      Churn.send(:clean_up_svn_line, "A   /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
+      
+      Churn.send(:clean_up_svn_line, "   M /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
+      Churn.send(:clean_up_svn_line, "M   /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
+      Churn.send(:clean_up_svn_line, "   M   /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
+      Churn.send(:clean_up_svn_line, "   M /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
+      Churn.send(:clean_up_svn_line, "M /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
+      Churn.send(:clean_up_svn_line, "M   /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
+    end
+  end
+end

data/spec/flog_reporter/base_spec.rb

@@ -0,0 +1,69 @@
+require 'spec'
+require File.dirname(__FILE__) + '/../../lib/metric_fu'
+include MetricFu::FlogReporter
+
+describe "FlogReporter::Base" do
+  before do
+    @alpha_only_method = <<-AOM
+    Total flog = 13.6283678106927
+
+    ErrorMailer#errormail: (12.5)
+        12.0: assignment
+         1.2: []
+         1.2: now
+         1.2: content_type
+AOM
+
+    @method_that_has_digits = <<-MTHD
+    Total flog = 7.08378429936994
+
+    NoImmunizationReason#to_c32: (7.1)
+         3.0: code
+         2.3: branch
+         1.4: templateId
+         1.2: act
+         1.1: entryRelationship
+MTHD
+
+    @bang_method = <<-BM
+    Total flog = 7.08378429936994
+
+    NoImmunizationReason#to_c32!: (7.1)
+         3.0: code
+         2.3: branch
+         1.4: templateId
+         1.2: act
+         1.1: entryRelationship
+BM
+  end
+  
+  it "should be able to parse an alpha only method" do
+    page = Base.parse(@alpha_only_method)
+    page.should_not be_nil
+    page.score.should == 13.6283678106927
+    page.scanned_methods.size.should == 1 
+    sm = page.scanned_methods.first
+    sm.name.should == 'ErrorMailer#errormail'
+    sm.score.should == 12.5 
+  end
+  
+  it "should be able to parse method that has digits" do
+    page = Base.parse(@method_that_has_digits)
+    page.should_not be_nil
+    page.score.should == 7.08378429936994
+    page.scanned_methods.size.should == 1 
+    sm = page.scanned_methods.first
+    sm.name.should == 'NoImmunizationReason#to_c32'
+    sm.score.should == 7.1
+  end
+  
+  it "should be able to parse bang method" do
+    page = Base.parse(@bang_method)
+    page.should_not be_nil
+    page.score.should == 7.08378429936994
+    page.scanned_methods.size.should == 1
+    sm = page.scanned_methods.first
+    sm.name.should == 'NoImmunizationReason#to_c32!'
+    sm.score.should == 7.1
+  end
+end

data/spec/md5_tracker_spec.rb

@@ -0,0 +1,59 @@
+require 'spec'
+require File.join(File.dirname(__FILE__), '../lib/metric_fu/md5_tracker')
+include MetricFu
+
+describe MetricFu::MD5Tracker do
+  before do
+    @tmp_dir = File.join(File.dirname(__FILE__), 'tmp')
+    FileUtils.mkdir_p(@tmp_dir, :verbose => false) unless File.directory?(@tmp_dir)
+    @file1 = File.new(File.join(@tmp_dir, 'file1.txt'), 'w')
+    @file2 = File.new(File.join(@tmp_dir, 'file2.txt'), 'w')
+  end
+  
+  after do
+    FileUtils.rm_rf(@tmp_dir, :verbose => false)
+  end
+  
+  it "identical files should match" do
+    @file1.puts("Hello World")
+    @file1.close
+    file1_md5 = MD5Tracker.track(@file1.path, @tmp_dir)
+
+    @file2.puts("Hello World")
+    @file2.close
+    file2_md5 = MD5Tracker.track(@file2.path, @tmp_dir)
+
+    file2_md5.should == file1_md5
+  end
+  
+  it "different files should not match" do
+    @file1.puts("Hello World")
+    @file1.close
+    file1_md5 = MD5Tracker.track(@file1.path, @tmp_dir)
+
+    @file2.puts("Goodbye World")
+    @file2.close
+    file2_md5 = MD5Tracker.track(@file2.path, @tmp_dir)
+
+    file2_md5.should_not == file1_md5
+  end
+  
+  it "file_changed? should detect a change" do
+      @file2.close
+      
+      @file1.puts("Hello World")
+      @file1.close
+      file1_md5 = MD5Tracker.track(@file1.path, @tmp_dir)
+    
+      @file1 = File.new(File.join(@tmp_dir, 'file1.txt'), 'w')
+      @file1.puts("Goodbye World")
+      @file1.close
+      MD5Tracker.file_changed?(@file1.path, @tmp_dir).should be_true
+  end
+  
+  it "should detect a new file" do
+    @file2.close
+    MD5Tracker.file_changed?(@file1.path, @tmp_dir).should be_true
+    File.exist?(MD5Tracker.md5_file(@file1.path, @tmp_dir)).should be_true
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: indirect-metric_fu
+version: !ruby/object:Gem::Version 
+  version: 0.8.1
+platform: ruby
+authors: 
+- Jake Scruggs
+- Sean Soper
+- Andre Arko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: flog
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: flay
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: Code metrics from Flog, RCov, Saikuro, Churn, and Rails' stats task
+email: jake.scruggs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- HISTORY
+- README
+files: 
+- README
+- HISTORY
+- TODO
+- MIT-LICENSE
+- Rakefile
+- lib/metric_fu/churn.rb
+- lib/metric_fu/flay.rb
+- lib/metric_fu/flog_reporter/base.rb
+- lib/metric_fu/flog_reporter/generator.rb
+- lib/metric_fu/flog_reporter/operator.rb
+- lib/metric_fu/flog_reporter/page.rb
+- lib/metric_fu/flog_reporter/scanned_method.rb
+- lib/metric_fu/flog_reporter.rb
+- lib/metric_fu/md5_tracker.rb
+- lib/metric_fu/saikuro/saikuro.rb
+- lib/metric_fu.rb
+- lib/tasks/metric_fu.rb
+- lib/tasks/churn.rake
+- lib/tasks/coverage.rake
+- lib/tasks/flog.rake
+- lib/tasks/metric_fu.rake
+- lib/tasks/saikuro.rake
+- lib/tasks/stats.rake
+has_rdoc: true
+homepage: http://metric-fu.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A fistful of code metrics
+test_files: 
+- spec/churn_spec.rb
+- spec/flog_reporter/base_spec.rb
+- spec/md5_tracker_spec.rb