metric_fu 3.0.0 → 3.0.1

data/HISTORY.md

@@ -1,11 +1,36 @@
 === master ===
 
-* Add commandline behavior to `metric_fu`. Now there are options -v, -r, and -h
-* Clean up global ivars a bit in Configuration
+== MetricFu 3.0.1 / 2013-03-01
+    
+* Fixed typo in Flay generator (Sathish, pull request #47)
+
+=== MetricFu 3.0.0 / 2013-02-07
+
+Features
+* Included metrics: churn, flay, flog, roodi, saikuro, reek, 'coverage', rails stats, rails_best_practices, hotspots.
+* Works with ruby 1.9 syntax.
+* Can be configured just like metrical, with a .metrics file.
+* Add commandline behavior to `metric_fu`. Try `metric_fu --help`.
+* Does not require rake to run. Can be run directly from the commandline.
+* Is tested to run on rbx-19 and jruby-19 in addition to cruby-19 and cruby-18.
+* churn options include :minimum-churn-count and :start-date, see https://github.com/metricfu/metric_fu/blob/master/lib/metric_fu/metrics/churn/init.rb
+* Installation and running it have less dependency issues.
+* Can either load external coverage metrics (rcov or simplecov) or run rcov directly.
+
+Notes:
+* Rcov is not included in the gem, and is off by default.
+* Rails best practices is not available in ruby 1.8.
+* Version 2.1.3.7.18.1 is currently the last version fully compatible with 1.8.
+* Metrical is no longer necessary. Its functionality has been merged into metric_fu.
+
+Other work
 * Re-organized test files - Michael Stark
 * Rspec2 - Michael Stark
-* Unify verbose logging
-* Modularize
+* Unify verbose logging with the MF_DEBUG=true commandline flag
+* Begin to isolate each metric code. Each metric configures itself
+* Clean up global ivars a bit in Configuration
+* Thanks to Dan Mayer for helping with churn compatibility
+* Thanks to Timo Rößner and Matijs van Zuijlen for their work on maintaining reek
 
 === MetricFu 2.1.3.7.18.1 / 2013-01-09
 
@@ -66,6 +91,8 @@
 
 === MetricFu 2.1.0 / 2011-03-1
 
+  In 2.1.0 there are a lot of bug fixes. 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).
+
 * 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
@@ -86,6 +113,12 @@
 
 === MetricFu 2.0.0 / 2010-11-10
 
+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:
+
+![Hotspots](http://metric-fu.rubyforge.org/hotspot.gif "That is one terrible method")
+
+Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helping me integrate it with RCov.
+
 * Hotspots - Dan Mayer, Ben Brinckerhoff, Jake Scruggs
 * Rcov integration with Hotspots - Jake Scruggs, Tony Castiglione, Rob Meyer
 

data/home_page/index.html

@@ -11,12 +11,12 @@
 <div id="main">
 <!-- header begins -->
 <div id="header">
-    
+
     <div id="logo"><a href="#">metric_fu</a></div>
     <div id="buttons">
         <ul><li>A Ruby Gem for Easy Metric Report Generation</li></ul>
     </div>
-    
+
 </div>
 <!-- header ends -->
 <!-- content begins -->
@@ -31,16 +31,21 @@
                         Google Group
                         </a>
                     </li>
-                    <li><a href="http://github.com/jscruggs/metric_fu">
+                    <li><a href="http://github.com/metricfu/metric_fu">
                         SCM
                         </a>
                     </li>
-                    <li><a href="http://github.com/jscruggs/metric_fu/issues">
+                    <li><a href="http://github.com/metricfu/metric_fu/issues">
                         Issue Tracker
                         </a>
                     </li>
+                    </li>
+                    <li><a href="http://benjaminfleischer.com">
+                        Benjamin Fleischer's page (lead developer)
+                        </a>
+                    </li>
                     <li><a href="http://jakescruggs.blogspot.com/">
-                        Jake Scruggs' Blog (lead developer)
+                        Jake Scruggs' Blog (original lead developer)
                         </a>
                     </li>
                 </ul>
@@ -50,53 +55,23 @@
     <!-- end #sidebar -->
     </div>
 <div id="left">
-            <h1>About metric_fu 2.1.1</h1>
+            <h1>About metric_fu</h1>
             <div>
 <p><br/>
-    Metric_fu is a set of rake tasks that make it easy to generate metrics reports.  It uses 
-    <a href="http://saikuro.rubyforge.org/">Saikuro</a>, 
-    <a href="http://ruby.sadi.st/Flog.html">Flog</a>, 
-    <a href="http://ruby.sadi.st/Flay.html">Flay</a>, 
-    <a href="http://eigenclass.org/hiki.rb?rcov">Rcov</a>, 
-    <a href="http://github.com/kevinrutherford/reek">Reek</a>, 
-    <a href="http://github.com/martinjandrews/roodi">Roodi</a>, 
-    <a href="http://github.com/danmayer/churn">Churn</a>, 
-    <a href="http://rubygems.org/gems/rails_best_practices">RailsBestPractices</a>, 
-    <a href="http://subversion.tigris.org/">Subversion</a>, 
-    <a href="http://git.or.cz/">Git</a>, and 
-    <a href="http://www.rubyonrails.org/">Rails</a> 
-    built-in stats task to create a series of reports.  It's designed to integrate easily with 
-    <a href="http://cruisecontrolrb.thoughtworks.com/">CruiseControl.rb</a> 
+Metric_fu is a set of metric tools that make it easy to generate metrics reports.  See <a href="https://github.com/metricfu/metric_fu/tree/master/lib/metric_fu/metrics">the list of metrics the gem includes</a>
+    It's designed to integrate easily with
+    <a href="http://cruisecontrolrb.thoughtworks.com/">CruiseControl.rb</a>
     by placing files in the Custom Build Artifacts folder.
 </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">
-<p>
-That is one terrible method.<br/>
-Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helping me integrate it with RCov.
-</p>
-<br/>
+<h2>For up to date information</h2>
+For the most frequently updated project information see the <a href="https://github.com/metricfu/metric_fu">github project page</a> or follow the gem on <a href="https://rubygems.org/gems/metric_fu">rubygems.org</a>. This page is no longer up to date.
 
-<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.
+See the <a href="https://github.com/metricfu/metric_fu/blob/master/HISTORY.md">Change log</a>
 </p>
-
-<h2>Installation:</h2>
-<pre>gem install metric_fu</pre>
-<br/>
-<p>Then in your Rakefile:</p>
-<br/>
-<pre>require 'metric_fu'</pre>
-<br/>
-
-<h2>Output:</h2>
+<br>
+<h2>Example Output:</h2>
 <table>
 <tr>
   <td><a href="flog.gif"><img src="flog.gif" width="250"></a></td>
@@ -114,175 +89,33 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
   <td><a href="stats.gif"><img src="stats.gif" width="250"></a></td>
 </tr>
 </table>
-<p><br/>
-    <h2>Usage:</h2>
-    Out of the box metric_fu provides this tasks:
-    <ul>
-      <li>rake metrics:all # Generate coverage, cyclomatic complexity, flog, flay, reek, roodi, stats... </li>
-    </ul>                
-    <br/>
-    I recommend using CruiseControl.rb to set up a metrics build.  See the CruiseControl.rb online docs for more info on how to set up cc.rb and, once you've got that figured out, change the cruise_config.rb file inside your project to have these lines:
-<br/><br/>
-    <pre>project.rake_task = 'metrics:all'</pre>
-    <pre>project.scheduler.polling_interval = 24.hours</pre>
-<br/>
-    Which will check for updates every 24 hours and run all the metric_fu rake tasks (migrating your test db first).  The output will be visible from an individual build's detail page.
-</p>
-<br/>
-
-    <h2>Configuration:</h2>
-    <p>The definitive source for configuration is, of course, the source: <a href="http://github.com/jscruggs/metric_fu/blob/master/lib/base/configuration.rb#L99">lib/base/configuration.rb</a>
-    <p>Metric_fu can be customized to your liking by altering the defaults in your Rakefile:</p>
-    <pre>
-      MetricFu::Configuration.run do |config|
-        #define which metrics you want to use
-        config.metrics  = [:churn, :saikuro, :stats, :flog, :flay]
-        config.graphs   = [:flog, :flay, :stats]
-        # ...
-    end
-    </pre>
-    Note: if you don't want one of the metrics to run (like rcov), make sure you don't try to graph it (which will explode).  Set config.graphs to exactly the graphs you want.  Set config.graphs to an empty array (config.graphs = []) if you want no graphing at all.
-</p>
 
-<p><br/>
-    <h2>Graphing</h2>
-    MetricFu uses Bluff for graphing (a Javascript library) by default.  If you'd rather use Google Charts you can set 'config.graph_engine = :gchart' in the config.  You'll have to install the googlecharts gem, of course.
-</p>
-
-<p><br/>
-    <h2>Notes on Rails 3</h2>
-    If you use RSpec, you'll need to add this to one of your rake files:
-    <pre>
-      require 'metric_fu'
-      MetricFu::Configuration.run do |config|
-        config.rcov[:test_files] = ['spec/**/*_spec.rb']  
-        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] &lt;&lt; "-Itest" # Needed to find test_helper
-      end
-    </pre>
 <br/>
-
-<p><br/>
-    <h2>Notes on metrics:coverage</h2>
-    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 what files it should run and the RAILS_ENV (by setting 'environment') it runs under. Default config for rcov:
-    <pre>
-      config.rcov = { :environment => 'test',
-                      :test_files => ['test/**/*_test.rb', 
-                                      'spec/**/*_spec.rb'],
-                      :rcov_opts => ["--sort coverage", 
-                                     "--no-html", 
-                                     "--text-coverage",
-                                     "--no-color",
-                                     "--profile",
-                                     "--rails",
-                                     "--exclude /gems/,/Library/,/usr/,spec"],
-                      :external => nil
-                    }
-    </pre>
-    By far, Rcov is the most troublesome report in metric_fu.  This is not because of Rcov itself, but because the Rcov report has to actually execute your tests and test suites can be very tricky things.  MetricFu naively shells out to the command line, runs rcov on your tests/specs, and captures the output.  This does not always work well.  If you are having problems with metric_fu, try turning off Rcov (see the above Configuration section).
-</p>
-<p><br/>
-    <h2>Notes on metrics:saikuro</h2>
-    Saikuro measures cyclomatic complexity for Ruby.  Default config for Saikuro:
-    <pre>
-      config.saikuro  = { :output_directory => 'tmp/metirc_fu/saikuro', 
-                          :input_directory => ['app', 'lib'],
-                          :cyclo => "",
-                          :filter_cyclo => "0",
-                          :warn_cyclo => "5",
-                          :error_cyclo => "7",
-                          :formater => "text"}
-    </pre>
-<br/><br/>
-</p>
-<p><br/>
-    <h2>Notes on metrics:flay</h2>
-    Flay analyzes ruby code for structural similarities. 
-    You can configure which directories need to be flayed.
-    The defaults are 'lib' for non Rails projects and ['app', 'lib'] for Rails projects.
-    By default, metric_fu ignores scores under 100.  You can configure the minimum_score. Default config for Flay:
-    <pre>
-      config.flay ={:dirs_to_flay => ['app', 'lib'],
-                    :minimum_score => 100,
-                    :filetypes => ['rb'] }
-    </pre>
-</p>
-
-<p><br/>
-    <h2>Notes on metrics:flog</h2>
-    <br/>
-    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, <a href="http://ruby.sadi.st/Flog.html">Flog website</a> for more info. Default config for Flog:
-    <pre>
-      config.flog = { :dirs_to_flog => ['app', 'lib'] }
-    </pre>
-</p>
-<p><br/>
-    <h2>Notes on metrics:reek</h2>
-    Reek detects common code smells in ruby code.
-    You can configure which directories need to be checked.
-    The defaults are 'lib' for non Rails projects and ['app', 'lib'] for Rails projects. Default config for Reek:
-    <pre>
-      config.reek = { :dirs_to_reek => ['app', 'lib'] }
-    </pre>
-</p>
-
+<p>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) and is hosted on GitHub at <a href="http://github.com/metricfu/metric_fu">http://github.com/metricfu/metric_fu</a>. </p>
 <p><br/>
-    <h2>Notes on metrics:roodi</h2>
-    Roodi parses your Ruby code and warns you about design issues you have based on the checks that is has configured.
-    You can configure which directories need to be checked.
-    The defaults are 'lib' for non Rails projects and ['app', 'lib'] for Rails projects.  Default config for Roodi:
-    <pre>
-      config.roodi = { :dirs_to_roodi => ['app', 'lib'] }
-    </pre>
-</p>
-<p><br/>
-    <h2>Notes on metrics:rails_best_practices</h2>
-    Rails Best Practices checks your rails files for violations of... Well the name says it all. The gem was inspired by ihower's presentation <a href="http://www.slideshare.net/ihower/rails-best-practices">Rails Best Practices</a>
-</p>
-<p><br/>
-    <h2>Notes on metrics:stats</h2>
-    This is just 'rake stats' 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.
-</p>
-<p><br/>
-    <h2>Notes on metrics:churn</h2>
-    Files that change a lot in your project may be bad a sign.  This task uses svn or git's log to identify those files and put them in a report.
-<br/>
-<br/>
-</p>
-
-
-<br/>
-<p>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) and is hosted on GitHub at <a href="http://github.com/jscruggs/metric_fu">http://github.com/jscruggs/metric_fu</a>. </p>
-<p><br/>   
     <h2>Questions?</h2>
     <p>Use the Google Group: <a href="http://groups.google.com/group/metric_fu">http://groups.google.com/group/metric_fu</a></p>
     <br/>
     <h2>Thanks</h2>
-    I'd like to thank the authors of Saikuro, Subversion, Flog, Rcov, CruiseControl.rb, and Rails for creating such excellent open source products.  Also many thanks go to 
-    <a href="http://arko.net/">Andre Arko</a>, 
-    <a href="http://deheus.net/petrik">Petrik de Heus</a>, 
-    <a href="http://seansoper.com/">Sean Soper</a>, 
-    <a href="http://www.perilled.com/">Erik St Martin</a>, 
-    <a href="http://gregorowicz.blogspot.com/">Andy Gregorowicz</a>, 
-    <a href="http://github.com/bastien/">Bastien</a>, 
-    <a href="http://schubert.cx/">Michael Schubert</a>, 
-    <a href="http://kseebaldt.blogspot.com/">Kurtis Seebaldt</a>, 
-    <a href="http://www.workingwithrails.com/person/11263-toby-tripp">Toby Tripp</a>, 
-    <a href="http://www.aliaghareza.com">Ali Aghareza</a>, 
-    <a href="http://www.pgrs.net/">Paul Gross</a>, and 
-    <a href="http://chirdeepshetty.net/">Chirdeep Shetty</a> 
+    I'd like to thank the authors of Saikuro, Subversion, Flog, Rcov, CruiseControl.rb, and Rails for creating such excellent open source products.  Also many thanks go to
+    <a href="http://arko.net/">Andre Arko</a>,
+    <a href="http://deheus.net/petrik">Petrik de Heus</a>,
+    <a href="http://seansoper.com/">Sean Soper</a>,
+    <a href="http://www.perilled.com/">Erik St Martin</a>,
+    <a href="http://gregorowicz.blogspot.com/">Andy Gregorowicz</a>,
+    <a href="http://github.com/bastien/">Bastien</a>,
+    <a href="http://schubert.cx/">Michael Schubert</a>,
+    <a href="http://kseebaldt.blogspot.com/">Kurtis Seebaldt</a>,
+    <a href="http://www.workingwithrails.com/person/11263-toby-tripp">Toby Tripp</a>,
+    <a href="http://www.aliaghareza.com">Ali Aghareza</a>,
+    <a href="http://www.pgrs.net/">Paul Gross</a>, and
+    <a href="http://chirdeepshetty.net/">Chirdeep Shetty</a>
     for their contributions to metric_fu.
 </p>
             </div>
 
-    </div>  
-    
+    </div>
+
 </div>
 </div>
 <!-- content ends -->

data/home_page/robots.txt

@@ -0,0 +1,5 @@
+User-agent: *
+Disallow: /softwaremap/ # This is an infinite virtual URL space
+Disallow: /statcvs/ # This is an infinite virtual URL space
+Disallow: /usage/ # This is an infinite virtual URL space
+Disallow: /wiki/ # This is an infinite virtual URL space

data/lib/metric_fu/metrics/flay/flay.rb

@@ -5,9 +5,9 @@ module MetricFu
   class Flay < Generator
 
     def emit
-      mimimum_score_parameter = MetricFu.flay[:minimum_score] ? "--mass #{MetricFu.flay[:minimum_score]} " : ""
+      minimum_score_parameter = MetricFu.flay[:minimum_score] ? "--mass #{MetricFu.flay[:minimum_score]} " : ""
 
-      command = %Q(mf-flay #{mimimum_score_parameter} #{MetricFu.flay[:dirs_to_flay].join(" ")})
+      command = %Q(mf-flay #{minimum_score_parameter} #{MetricFu.flay[:dirs_to_flay].join(" ")})
       mf_debug "** #{command}"
       @output = `#{command}`
     end

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metric_fu
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -19,7 +19,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-07 00:00:00.000000000 Z
+date: 2013-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails_best_practices
@@ -334,9 +334,13 @@ files:
 - bin/mf-stats
 - config/roodi_config.yml
 - home_page/back_all.jpg
+- home_page/cc.rb.gif
 - home_page/churn.gif
+- home_page/cruise_control_1.gif
+- home_page/cyclomatic.gif
 - home_page/flay.gif
 - home_page/flog.gif
+- home_page/flog2.gif
 - home_page/footer.gif
 - home_page/header.jpg
 - home_page/hotspot.gif
@@ -344,6 +348,7 @@ files:
 - home_page/index.html
 - home_page/rcov.gif
 - home_page/reek.gif
+- home_page/robots.txt
 - home_page/roodi.gif
 - home_page/saikuro.gif
 - home_page/stats.gif
@@ -516,7 +521,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: metric_fu
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A fistful of code metrics, with awesome templates and graphs