Skip to content
Browse files

Updating docs for 2.1.0 release

  • Loading branch information...
1 parent 9b57847 commit 3e260917db3bc99c077d89000c3a2e704f29f6a6 @jscruggs committed
Showing with 12 additions and 12 deletions.
  1. +3 −2 HISTORY
  2. +1 −1 MIT-LICENSE
  3. +8 −9 home_page/index.html
View
5 HISTORY
@@ -1,13 +1,14 @@
-=== MetricFu 2.0.2 / ???
+=== MetricFu 2.1.0 / 2011-03-1
* Flog gemspec version was >= 2.2.0, which was too early and didn't work. Changed to >= 2.3.0 - Chris Griego
* RCov generator now uses a regex with begin and end line anchor to avoid splitting on comments with equal signs in source files - Andrew Selder
* RCov generator now always strips the 3 leading characters from the lines when reconstruction source files so that heredocs and block comments parse successfully - Andrew Selder
* Dan Mayer ported some specs for the Hotspots code into MetricFu from Caliper's code.
* Stefan Huber fixed some problems with churn pretending not to support Svn.
-* Kakutani Shintaro added the ability to opt out of opening files with TextMate.
+* Kakutani Shintaro added the ability to opt out of opening files with TextMate (config.darwin_txmt_protocol_no_thanks = true).
* Joel Nimety and Andrew Selder fixed a problem where Saikuro was parsing a dir twice.
* Dan Sinclair added some awesome 'annotate' functionality to the Hotspots page. Click on it so see the file with problems in-line.
+* Dan Sinclair added a verbose mode (config.verbose = true).
=== MetricFu 2.0.1 / 2010-11-13
View
2 MIT-LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2008,2009,2010 Jake Scruggs
+Copyright (c) 2008,2009,2010,2011 Jake Scruggs
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
View
17 home_page/index.html
@@ -50,7 +50,7 @@
<!-- end #sidebar -->
</div>
<div id="left">
- <h1>About metric_fu 2.0.1</h1>
+ <h1>About metric_fu 2.1.0</h1>
<div>
<p><br/>
Metric_fu is a set of rake tasks that make it easy to generate metrics reports. It uses
@@ -71,6 +71,10 @@
</p>
<br/>
<p>
+ In 2.1.0 there are a lot of bug fixes, Check the <a href="http://github.com/jscruggs/metric_fu/blob/master/HISTORY">HISTORY</a> file for complete details. There's a verbose mode (config.verbose = true) that's helpful for debugging (from Dan Sinclair), the ability to opt out of TextMate (from Kakutani Shintaro) opening your files (config.darwin_txmt_protocol_no_thanks = true), and super cool annotations on the Hotspots page so you can see your code problems in-line with the file contents (also from Dan Sinclair).
+</p>
+<br/>
+<p>
In 2.0.0 the big new feature is Hotspots. The Hotspots report combines Flog, Flay, Rcov, Reek, Roodi, and Churn numbers into one report so you see parts of your code that have multiple problems like so:
</p>
<img src="hotspot.gif" width="359">
@@ -81,13 +85,8 @@
<br/>
<p>
- In 1.5.0 I re-wrote the Flog parsing engine to use Flog programmatically instead of parsing the command line output. This will hopefully stop minor changes in Flog's output from breaking metric_fu. Check the <a href="http://github.com/jscruggs/metric_fu/blob/master/HISTORY">HISTORY</a> file for complete details.
+ In 1.5.0 I re-wrote the Flog parsing engine to use Flog programmatically instead of parsing the command line output. This will hopefully stop minor changes in Flog's output from breaking metric_fu.
</p>
-<br/>
-<p>
- New in metric_fu 1.4.0 is integration with the rails_best_practices gem (Richard Huang), Rails stats now have graphing (Josh Cronemeyer), parameterized filetypes for flay so it can look at other file types (bfabry), along with many bug fixes.
-</p>
-<br/>
<h2>Installation:</h2>
<pre>gem install metric_fu</pre>
@@ -157,14 +156,14 @@
require 'metric_fu'
MetricFu::Configuration.run do |config|
config.rcov[:test_files] = ['spec/**/*_spec.rb']
- config.rcov[:rcov_opts] << "-Ispec" # Needed to find spec_helper
+ config.rcov[:rcov_opts] &lt;&lt; "-Ispec" # Needed to find spec_helper
end
</pre>
If you're using default Rails testing, then you can do this:
<pre>
require 'metric_fu'
MetricFu::Configuration.run do |config|
- config.rcov[:rcov_opts] << "-Itest" # Needed to find test_helper
+ config.rcov[:rcov_opts] &lt;&lt; "-Itest" # Needed to find test_helper
end
</pre>
<br/>

0 comments on commit 3e26091

Please sign in to comment.
Something went wrong with that request. Please try again.