README in p8-metric_fu-0.8.9.1 vs README in p8-metric_fu-0.9.0
- old
+ new
@@ -1,6 +1,6 @@
-Version 0.8.9
+Version 0.9.0
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.
@@ -10,11 +10,11 @@
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 'vendor/gems/jscruggs-metric_fu-0.8.9/lib/metric_fu'
+require 'vendor/gems/jscruggs-metric_fu-0.9.0/lib/metric_fu'
then you don't have to install it on every box you run it on.
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.
@@ -72,9 +72,16 @@
When creating a coverage report, metric_fu runs all the tests in the test folder and specs in spec folder using Rcov.
You can configure the coverage test files pattern:
config.coverage[:test_files] = ['test/**/test_*.rb']
The default value is ['test/**/*_test.rb', 'spec/**/*_spec.rb']
+
+You may also configure Rcov options:
+ config.coverage = { :test_files => ['test/**/*_test.rb'],
+ :rcov_opts => ["--exclude /gems/,/Library/"] }
+
+The default value is { :test_files => ['test/**/*_test.rb', 'spec/**/*_spec.rb'],
+ :rcov_opts => ["--sort coverage", "--html", "--rails", "--exclude /gems/,/Library/,spec"] }
****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 configuration: