jscruggs-metric_fu 0.7.5 → 0.7.6

data/History.txt

@@ -1,3 +1,11 @@
+=== MetricFu 0.7.6 / 2008-09-15
+
+* CHURN_OPTIONS has become MetricFu::CHURN_OPTIONS
+* SAIKURO_OPTIONS has become MetricFu::SAIKURO_OPTIONS
+* Rcov now looks at test and specs
+* Exclude gems and Library ruby code from rcov
+* Fixed bug with churn start_date functionality (bad path)
+
 === MetricFu 0.7.5 / 2008-09-12
 
 * Flog can now flog any set of directories you like (see README).
@@ -12,36 +20,52 @@
 * Merged in Sean Soper's changes to metric_fu.  
 * Metric_fu is now a gem.
 * Flogging now uses a MD5 hash to figure out if it should re-flog a file (if it's changed)
-* Floggin also has a cool new output screen
+* Flogging also has a cool new output screen(s)
 * Thanks Sean!
 
-=== Metricks 0.4.2 / 2008-07-01
+    === Metricks 0.4.2 / 2008-07-01
+
+    * Changed rcov output directory so that it is no longer 'coverage/unit' but just 'coverage' for better integration with CC.rb
+
+    === Metricks 0.4.1 / 2008-06-13
+
+    * Rcov tests now extend beyond one level depth directory by using RcovTask instead of the shell
+
+    === Metricks 0.4.0 / 2008-06-13
+
+    * Implementing functionality for use as a gem
+    * Added Rakefile to facilitate testing
+
+    === Metricks 0.3.0 / 2008-06-11
 
-* Changed rcov output directory so that it is no longer 'coverage/unit' but just 'coverage' for better integration with CC.rb
+    * Generated reports now open on darwin automatically
+    * Generated reports reside under tmp/metricks unless otherwise specified by ENV['CC_BUILD_ARTIFACTS']
+    * MD5Tracker works with Flog reports for speed optimization
 
-=== Metricks 0.4.1 / 2008-06-13
+    === Metricks 0.2.0 / 2008-06-11
 
-* Rcov tests now extend beyond one level depth directory by using RcovTask instead of the shell
+    * Integrated use of base directory constant
+    * Have all reports automatically open in a browser if platform is darwin
+    * Namespaced under Metricks
+    * Dropped use of shell md5 command in favor of Ruby's Digest::MD5 libraries
 
-=== Metricks 0.4.0 / 2008-06-13
+    === Metricks 0.1.0 / 2008-06-10
 
-* Implementing functionality for use as a gem
-* Added Rakefile to facilitate testing
+    * Initial integration of metric_fu and my enhancements to flog
+    * Metrics are generated but are all over the place  
 
-=== Metricks 0.3.0 / 2008-06-11
+=== MetricFu 0.6.0 / 2008-05-11
 
-* Generated reports now open on darwin automatically
-* Generated reports reside under tmp/metricks unless otherwise specified by ENV['CC_BUILD_ARTIFACTS']
-* MD5Tracker works with Flog reports for speed optimization
+* Add source control churn report
 
-=== Metricks 0.2.0 / 2008-06-11
+=== MetricFu 0.5.1 / 2008-04-25
 
-* Integrated use of base directory constant
-* Have all reports automatically open in a browser if platform is darwin
-* Namespaced under Metricks
-* Dropped use of shell md5 command in favor of Ruby's Digest::MD5 libraries
+* Fixed bug with Saikuro report generation
 
-=== Metricks 0.1.0 / 2008-06-10
+=== MetricFu 0.5.0 / 2008-04-25
 
-* Initial integration of metric_fu and my enhancements to flog
-* Metrics are generated but are all over the place  
+* create MetricFu as a Rails Plugin
+* Add Flog Report
+* Add Coverage Report
+* Add Saikuro Report
+* Add Stats Report

data/README

@@ -1,27 +1,26 @@
-Version 0.7.5
+Version 0.7.6
 http://github.com/jscruggs/metric_fu
 
 Metric_fu began its life as a plugin for Rails that generated code metrics reports.  As of version 0.7.0, metric_fu is a gem owing to the excellent work done by Sean Soper.  
 
 Metric_fu is a set of rake tasks that make it easy to generate metrics reports.  It uses Saikuro, Flog, Rcov, and Rails' built-in stats task to create a series of reports.  It's designed to integrate easily with CruiseControl.rb by placing files in the Custom Build Artifacts folder.
 
-*Installation
+****Installation****
 sudo gem install jscruggs-metric_fu -s http://gems.github.com
 
 Then in your Rakefile:
 require 'metric_fu'
 
 If you like to vendor gems, you can unpack metric_fu into vendor/gems and require it like so:
-require 'my_app/vendor/gems/jscruggs-metric_fu-0.7.1/lib/metric_fu'
+require 'vendor/gems/jscruggs-metric_fu-0.7.6/lib/metric_fu'
 
 then you don't have to install it on every box you run it on.
 
-
-*Important note:
+Important note:
 You must have Rcov and Flog installed to get coverage and flog reports.  Metric_fu requires both of these gems so they will be installed when you install the metric_fu gem.
 
 
-*Usage
+****Usage****
 
 Out of the box metrics provides these tasks:
 rake metrics:all                  
@@ -49,54 +48,50 @@ project.scheduler.polling_interval = 24.hours
 Which will check for updates every 24 hours and run all the metrics rake tasks (migrating your test db first).  The output will be visible from an individual build's detail page.
 
 
-*Notes on metrics:coverage
+****Notes on metrics:coverage****
 
-When creating a coverage report, metric_fu runs all the tests in the test folder using Rcov.  This task used to support RSpec, but currently that doesn't work.  This will be fixed in the near future (claims Jake on 9/12/2008).
+When creating a coverage report, metric_fu runs all the tests in the test folder and specs in spec folder using Rcov.
 
 
-*Notes on metrics:saikuro
+****Notes on metrics:saikuro****
 
 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:
-
-namespace :metrics do                   
-  SAIKURO_OPTIONS = { "--warn_cyclo" => "3", "--error_cyclo" => "4" }
-end
+                  
+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.
 
 If you want to have Saikuro look at multiple folders you can put something like this in you rakefile:
-SAIKURO_OPTIONS = {"--input_directory" => '"cms/app | cms/lib"'}
+MetricFu::SAIKURO_OPTIONS = {"--input_directory" => '"cms/app | cms/lib"'}
 
 
-*Notes on metrics:flog
+****Notes on metrics:flog****
 
 Flog is another way of measuring complexity (or tortured code as the Flog authors like to put it).  You should check out the awesome, and a little scary, Flog website for more info.
 
 'rake metrics:flog:custom' allows you to specify a custom set of directories to Flog (in your rakefile) like so:
+
 MetricFu::DIRECTORIES_TO_FLOG = ['cms/app', 'cms/lib']
 
-*Notes on metrics:stats
+
+****Notes on metrics:stats****
 
 This is just 'rake stats' for Rails put into a file.  On my projects I like to be able to look at CruiseControl and get stats about the app at different points in time.
 
 
-*Notes on metrics:churn
+****Notes on metrics:churn****
 
 Files that change a lot in your project may be bad a sign.  This task uses "svn log" to identify those files and put them in a report.  The default is to start counting changes from the beginning of your project, which might be too far back so you can change like so:
 
-namespace :metrics do 
-  CHURN_OPTIONS = { :start_date => lambda{3.months.ago} }
-end
+MetricFu::CHURN_OPTIONS = { :start_date => lambda{3.months.ago} }
 
 The Proc is there because '3.months.ago' only works when after the Rails Environment is loaded (and Rails extends Fixnum) which I didn't want to do every time you run a rake task.
 
 You can also change the minimum churn count like so:
 
-namespace :metrics do
-  CHURN_OPTIONS = { :minimum_churn_count => 3 }
-end
+MetricFu::CHURN_OPTIONS = { :minimum_churn_count => 3 }
 
 
-*Thanks
+****Thanks****
 
 I'd like to thank the authors of Saikuro, Flog, Rcov, CruiseControl.rb, and Rails for creating such excellent open source products.  Also Sean Soper, Michael Schubert, Kurtis Seebaldt, Toby Tripp, Paul Gross, and Chirdeep Shetty for their help and advice.

data/TODO.txt

@@ -1,4 +1,10 @@
 == TODO list
 
+* Sort Flog scores from worst to best
+* Get churn to work with git
+* 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?)
+* Integrate Flog, Saikuro, and Coverage into one report so you can see methods that have high complexity and low coverage (this is a big one)
 * Integrate MD5 hashing with remainder of reports
-* Update README to more accurately reflect current development
+

data/lib/tasks/churn.rake

@@ -16,9 +16,10 @@ namespace :metrics do
   end
 
   def churn_options
-    options = defined?(CHURN_OPTIONS) ? CHURN_OPTIONS : {} 
+    raise "CHURN_OPTIONS is now MetricFu::CHURN_OPTIONS" if defined?(CHURN_OPTIONS)
+    options = defined?(MetricFu::CHURN_OPTIONS) ? MetricFu::CHURN_OPTIONS : {} 
     if options[:start_date]
-      require File.dirname(__FILE__) + '/../../../../config/environment'
+      require RAILS_ROOT + '/config/environment'
       date_range = "--revision {#{options[:start_date].call.strftime('%Y-%m-%d')}}:{#{Time.now.strftime('%Y-%m-%d')}}"
     else
       date_range = ""

data/lib/tasks/coverage.rake

@@ -18,8 +18,8 @@ begin
       desc "RCov task to generate report"
       Rcov::RcovTask.new(:do => :clean) do |t|
         FileUtils.mkdir_p(MetricFu::BASE_DIRECTORY) unless File.directory?(MetricFu::BASE_DIRECTORY)
-        t.test_files = FileList['test/**/*_test.rb']
-        t.rcov_opts = ["--sort coverage", "--aggregate '#{COVERAGE_DATA_FILE}'", "--html", "--rails"]
+        t.test_files = FileList['test/**/*_test.rb', 'spec/**/*_spec.rb']
+        t.rcov_opts = ["--sort coverage", "--html", "--rails", "--exclude /gems/,/Library/"]
         t.output_dir = COVERAGE_DIR
       end
     end

data/lib/tasks/saikuro.rake

@@ -4,6 +4,7 @@ namespace :metrics do
   
   desc "A cyclomatic complexity report using Saikuro"
   task :saikuro do
+    raise "SAIKURO_OPTIONS is now MetricFu::SAIKURO_OPTIONS" if defined?(SAIKURO_OPTIONS)
     default_options = {"--output_directory" => SAIKURO_DIR,
                         "--input_directory" => "app",
                         "--cyclo" => "",
@@ -11,7 +12,7 @@ namespace :metrics do
                         "--warn_cyclo" => "5",
                         "--error_cyclo" => "7"}
   
-    default_options.merge!(SAIKURO_OPTIONS) if defined?(SAIKURO_OPTIONS)
+    default_options.merge!(MetricFu::SAIKURO_OPTIONS) if defined?(MetricFu::SAIKURO_OPTIONS)
     options = ""
     default_options.each_pair { |key, value| options << "#{key} #{value} " }  
      

data/metric_fu.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jscruggs-metric_fu
 version: !ruby/object:Gem::Version 
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors: 
 - Jake Scruggs
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-12 00:00:00 -07:00
+date: 2008-08-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency