jscruggs-metric_fu 0.7.6 → 0.8.0

data/History.txt

@@ -1,3 +1,11 @@
+=== MetricFu 0.8.0 / 2008-10-06
+
+* Source Control Churn now supports git (thanks to Erik St Martin)
+* Flog Results are sorted by Highest Flog Score
+* Fix for a bunch of 'already initialized constant' warnings that metric_fu caused
+* Fixing bug so the flog reporter can handle methods with digits in the name (thanks to Andy Gregorowicz)
+* Internal Rake task now allows metric_fu to flog/churn itself
+
 === MetricFu 0.7.6 / 2008-09-15
 
 * CHURN_OPTIONS has become MetricFu::CHURN_OPTIONS

data/README

@@ -57,11 +57,11 @@ When creating a coverage report, metric_fu runs all the tests in the test folder
 
 Saikuro is bundled with metric_fu so you don't have to install it.  Look at the SAIKURO_README (or the internet) for more documentation on Saikuro.  If you wish to change the options Saikuro is run with, then set this constant in your Rakefile:
                   
-SAIKURO_OPTIONS = { "--warn_cyclo" => "3", "--error_cyclo" => "4" }
+MetricFu::SAIKURO_OPTIONS = { "--warn_cyclo" => "3", "--error_cyclo" => "4" }
 
-Like RCOV_OPTIONS, SAIKURO_OPTIONS is a hash that gets merged with the default options hash.  The above example will set the warn_cyclo to 3 and the error_cyclo to 4 (which is way too low -- it's just an example) instructing Saikuro to flag methods with a higher cyclomatic complexity in it's report.
+MetricFu::SAIKURO_OPTIONS is a hash that gets merged with the default options hash.  The above example will set the warn_cyclo to 3 and the error_cyclo to 4 (which is way too low -- it's just an example) instructing Saikuro to flag methods with a higher cyclomatic complexity in it's report.
 
-If you want to have Saikuro look at multiple folders you can put something like this in you rakefile:
+If you want to have Saikuro look at multiple folders you can put something like this in your rakefile:
 MetricFu::SAIKURO_OPTIONS = {"--input_directory" => '"cms/app | cms/lib"'}
 
 

data/TODO.txt

@@ -1,7 +1,6 @@
 == TODO list
 
-* Sort Flog scores from worst to best
-* Get churn to work with git
+* Color code flog results with scale from: http://jakescruggs.blogspot.com/2008/08/whats-good-flog-score.html
 * Extract functionality from rake files and put under test
 * Change churn start_date to not rely on Rails 1.day.ago functionality (so metric_fu can be used in non-Rails apps)
 * Make integration with RSpec better (use SpecTask?)

data/lib/metric_fu/flog_reporter/base.rb

@@ -1,6 +1,5 @@
 module MetricFu::FlogReporter
   
-  THRESHOLD = (ENV['FLOG_THRESHOLD'] || 120)
   SCORE_FORMAT = "%0.2f"
   
   class InvalidFlog < RuntimeError
@@ -8,7 +7,7 @@ module MetricFu::FlogReporter
   
   class Base
     MODULE_NAME = "([A-Z][a-z]+)+"
-    METHOD_NAME = "#([a-z]+_?)+"
+    METHOD_NAME = "#([a-z0-9]+_?)+\\??\\!?"
     SCORE = "\\d+\\.\\d+"
 
     METHOD_NAME_RE = Regexp.new("#{MODULE_NAME}#{METHOD_NAME}")

data/lib/metric_fu/flog_reporter/generator.rb

@@ -48,7 +48,7 @@ module MetricFu::FlogReporter
         html << "<table class='report'>\n"
         html << "<tr><th>File</th><th>Total score</th><th>Methods</th><th>Average score</th><th>Highest score</th></tr>"
         count = 0
-        flog_hashes.each do |flog_hash|
+        flog_hashes.sort {|x,y| y[:page].highest_score <=> x[:page].highest_score }.each do |flog_hash|
           html << <<-EOF
                     <tr class='#{Base.cycle("light", "dark", count)}'>
                       <td><a href='#{flog_hash[:path]}'>#{flog_hash[:path].sub('.html', '.rb')}</a></td>

data/lib/tasks/churn.rake

@@ -3,13 +3,23 @@ namespace :metrics do
   
   desc "Which files change the most"
   task :churn do
-    date_range, minimum_churn_count = churn_options()
-    svn_logs = `svn log #{date_range} --verbose`.split(/\n/).select {|line| line.strip =~ /^[A,M]/}    
-  
+    date_range, minimum_churn_count, scm = churn_options()
+
     changes = {}
-    svn_logs.each do |line|
-      line.strip =~ /^[A,M] (.*)/
-      changes[$1] ? changes[$1] += 1 : changes[$1] = 1 
+    if scm == :git
+      git_logs = `git log #{date_range} --name-only --pretty=format:`.split(/\n/) 
+      git_logs.reject!{|line| line == ""}
+
+      git_logs.each do |line|
+        changes[line] ? changes[line] += 1 : changes[line] = 1 
+      end
+    else
+      svn_logs = `svn log #{date_range} --verbose`.split(/\n/).select {|line| line.strip =~ /^[A,M]/}
+  
+      svn_logs.each do |line|
+        line.strip =~ /^[A,M] (.*)/
+        changes[$1] ? changes[$1] += 1 : changes[$1] = 1
+      end
     end
     write_churn_file(changes.reject {|file, change_count| change_count < minimum_churn_count})
     system("open #{CHURN_DIR}/index.html") if PLATFORM['darwin']
@@ -20,12 +30,17 @@ namespace :metrics do
     options = defined?(MetricFu::CHURN_OPTIONS) ? MetricFu::CHURN_OPTIONS : {} 
     if options[:start_date]
       require RAILS_ROOT + '/config/environment'
-      date_range = "--revision {#{options[:start_date].call.strftime('%Y-%m-%d')}}:{#{Time.now.strftime('%Y-%m-%d')}}"
+      if options[:scm] == :git
+        date_range = "--after=#{options[:start_date].call.strftime('%Y-%m-%d')}"
+      else
+        date_range = "--revision {#{options[:start_date].call.strftime('%Y-%m-%d')}}:{#{Time.now.strftime('%Y-%m-%d')}}"
+      end
     else
       date_range = ""
     end
     minimum_churn_count = options[:minimum_churn_count] ? options[:minimum_churn_count] : 5
-    return date_range, minimum_churn_count
+    scm = options[:scm] == :git ? :git : :svn
+    return date_range, minimum_churn_count, scm
   end
 
   def write_churn_file changes
@@ -93,4 +108,4 @@ namespace :metrics do
   </body>
   </html>
   EOS
-end
+end

data/lib/tasks/flog.rake

@@ -1,6 +1,3 @@
-require File.join(File.dirname(__FILE__), '..', 'metric_fu', 'md5_tracker')
-require File.join(File.dirname(__FILE__), '..', 'metric_fu', 'flog_reporter')
-
 begin
   FLOG_DIR = File.join(MetricFu::BASE_DIRECTORY, 'flog')
 

data/metric_fu.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "metric_fu"
-  s.version = "0.7.6"
+  s.version = "0.8.0"
   s.summary = "Generates project metrics using Flog, RCov, Saikuro and more"
   s.email = "jake.scruggs@gmail.com"
   s.homepage = "http://metric-fu.rubyforge.org/"

data/test/test_helper.rb

@@ -2,5 +2,3 @@ require 'test/unit'
 require 'fileutils'
 
 ENV['CC_BUILD_ARTIFACTS'] = File.join(File.dirname(__FILE__), 'tmp')
-
-require File.join(File.dirname(__FILE__), '..', 'lib', 'metric_fu')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jscruggs-metric_fu
 version: !ruby/object:Gem::Version 
-  version: 0.7.6
+  version: 0.8.0
 platform: ruby
 authors: 
 - Jake Scruggs