metric_fu 4.0.0 → 4.1.0

data/.metrics

@@ -8,7 +8,7 @@ mf_debug "Metrics config loaded"
 #   config.add_metric(:rcov)
 #   config.add_graph(:rcov)
 #   config.configure_metric(:rcov, {:external => coverage_file})
-#   config.cane = {:abc_max => 15, :line_length => 80, :no_doc => 'y'}
+#   config.cane = {:abc_max => 15, :line_length => 80, :no_doc => 'y', :no_readme => 'y'}
 # end
 # or
 # MetricFu::Configuration.run do |config|

data/HISTORY.md

@@ -1,17 +1,24 @@
-=== master ===
+### Master
 
-== MetricFu 3.0.2 / 2013-03-02
+### MetricFu 4.1.0 / 2013-03-06
+
+* Fix crash in cane when missing readme (Sathish, pull request #51)
+* Prevent future cane failures on unexpected violations (Sathish, pull request #51)
+
+### MetricFu 4.0.0 / 2013-03-05
 
 * Adding cane metrics (Sathish, pull request #49)
   * Not yet included in hotspots
+  * *Removed ruby 1.9 support*
 
-== MetricFu 3.0.1 / 2013-03-01
+### MetricFu 3.0.1 / 2013-03-01
 
 * Fixed typo in Flay generator (Sathish, pull request #47)
 
-=== MetricFu 3.0.0 / 2013-02-07
+### MetricFu 3.0.0 / 2013-02-07
+
+#### Features
 
-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.
@@ -22,13 +29,15 @@ Features
 * Installation and running it have less dependency issues.
 * Can either load external coverage metrics (rcov or simplecov) or run rcov directly.
 
-Notes:
+#### 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
+#### Other work
+
 * Re-organized test files - Michael Stark
 * Rspec2 - Michael Stark
 * Unify verbose logging with the MF_DEBUG=true commandline flag
@@ -37,16 +46,16 @@ Other work
 * 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
+### MetricFu 2.1.3.7.18.1 / 2013-01-09
 
 * Same as 2.1.3.7.18.1 but gem packaged using ruby 1.8 dependencies, including ripper
 
-=== MetricFu 2.1.3.7.19 / 2013-01-08
+### MetricFu 2.1.3.7.19 / 2013-01-08
 
 * Bug fix, ensure Configuration is loaded before Run, https://github.com/metricfu/metric_fu/issues/36
 * Gem packaged using ruby 1.9 dependencies.  Learned that we cannot dynamically change dependencies for a packaged gem.
 
-=== MetricFu 2.1.3.6 / 2013-01-02
+### MetricFu 2.1.3.6 / 2013-01-02
 
 * Fixed bug that wasn't show stats or rails_best_practices graphs
 * Updated churn and rails_best_practices gems
@@ -54,7 +63,7 @@ Other work
 * Remove executable metric_fu dependency on rake
 * TODO: some unclear dependency issues may make metrics in 1.9 crash, esp Flog, Flay, Stats
 
-=== MetricFu 2.1.3.5 / 2013-01-01
+### MetricFu 2.1.3.5 / 2013-01-01
 
 * Issue #35, Namespace MetricFu::Table. -Benjamin Fleischer
 * Additionally namespace
@@ -64,18 +73,18 @@ Other work
   * MetricFu::HotspotScoringStrategies
 * Rename MetricAnalyzer to HotspotAnalyzer, and rename all <metric>Analzyer classes to <metric>Hotspot to signify that they are part of the Hotspot code -Benjamin Fleischer
 
-=== MetricFu 2.1.3.4 / 2012-12-28
+### MetricFu 2.1.3.4 / 2012-12-28
 
 * Restructuring of the project layout
 * Project is now at https://github.com/metricfu/metric_fu and gem is again metric_fu
 * Can run tasks as `metric_fu` command
 
-=== MetricFu 2.1.3.2 / 2012-11-14
+### MetricFu 2.1.3.2 / 2012-11-14
 
 * Don't raise an exception in the LineNumbers rescue block. Issue https://github.com/bf4/metric_fu/issues/6 by joonty -Benjamin Fleischer
  tmp/metric_fu/output/flog.js
 
-=== MetricFu 2.1.3 / 2012-10-25
+### MetricFu 2.1.3 / 2012-10-25
 
 * Added to rubygems.org as bf-metric_fu -Benjamin Fleischer
 * Added to travis-ci -Benjamin Fleischer
@@ -84,17 +93,17 @@ Other work
 * Looked at moving to simplecov-rcov, but was unsuccessful -Benjamin Fleischer
 * Fixed breaking tests, deprecation warnings -Benjamin Fleischer
 
-=== MetricFu 2.1.2 / 2012-09-05
+### MetricFu 2.1.2 / 2012-09-05
 
 * Getting it working on Rails 3, partly by going through the pull requests and setting gem dependencies to older, working versions - Benjamin Fleischer
 * It mostly works on Ruby 1.9, though there is an unresolved sexp_parser issue  - Benjamin Fleischer
 * Added link_prefix to configuration to allow URIs specified in config instead of file or txmt - dan sinclair
 
-=== MetricFu 2.1.1 / 2011-03-2
+### MetricFu 2.1.1 / 2011-03-2
 
 * Making syntax highlighting optional (config.syntax_highlighting = false) so Ruby 1.9.2 users don't get "invalid byte sequence in UTF-8" errors.
 
-=== MetricFu 2.1.0 / 2011-03-1
+### 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).
 
@@ -108,7 +117,7 @@ Other work
 * 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
+### MetricFu 2.0.1 / 2010-11-13
 
 * Delete trailing whitespaces - Delwyn de Villiers
 * Stop Ubuntu choking on invalid multibyte char (US-ASCII) - Delwyn de Villiers
@@ -116,7 +125,7 @@ Other work
 * Don't load Saikuro for Ruby 1.9.2 - Delwyn de Villiers
 * Fixed a bug reported by Andrew Davis on the mailing list where configuring the data directory causes dates to be 0/0 - Joshua Cronemeyer
 
-=== MetricFu 2.0.0 / 2010-11-10
+### 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:
 
@@ -127,13 +136,13 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
 * Hotspots - Dan Mayer, Ben Brinckerhoff, Jake Scruggs
 * Rcov integration with Hotspots - Jake Scruggs, Tony Castiglione, Rob Meyer
 
-=== MetricFu 1.5.1 / 2010-7-28
+### MetricFu 1.5.1 / 2010-7-28
 
 * Patch that allows graphers to skip dates that didn't generate metrics for that graph (GitHub Issue #20). - Chris Griego
 * Fixed bug where if you try and use the gchart grapher with the rails_best_practices metric, it blows up (GitHub Issue #23). - Chris Griego
 * Fixed 'If coverage is 0% metric_fu will explode' bug (GitHub Issue #6). - Stew Welbourne
 
-=== MetricFu 1.5.0 / 2010-7-27
+### MetricFu 1.5.0 / 2010-7-27
 
 * Fixed bug where Flay results were not being reported.  Had to remove the ability to remove selected files from flay processing (undocumented feature that may go away soon if it keeps causing problems).
 * Rewrote Flog parsing/processing to use Flog programmatically. Note: the yaml output for Flog has changed significantly - Pages have now become MethodContainers.  This probably doesn't matter to you if you are not consuming the metric_fu yaml output.
@@ -141,7 +150,7 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
 * Removed verify_dependencies! as it caused too much confusion to justify the limited set of problems it solved. In the post Bundler world it just didn't seem necessary to limit metric_fu dependencies.
 * Deal with Rails 3 activesupport vs active_support problems. -  jinzhu
 
-=== MetricFu 1.4.0 / 2010-06-19
+### MetricFu 1.4.0 / 2010-06-19
 
 * Added support for rails_best_practices gem - Richard Huang
 * Added rails stats graphing -- Josh Cronemeyer
@@ -153,7 +162,7 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
 * Fix some problems with the google charts - Chris Griego
 * Stop showing the googlecharts warning if you are not using google charts.
 
-=== MetricFu 1.3.0 / 2010-01-26
+### MetricFu 1.3.0 / 2010-01-26
 
 * Flay can be configured to ignore scores below a threshold (by default it ignores scores less than 100)
 * When running Rcov you can configure the RAILS_ENV (defaults to 'test') so running metric_fu doesn't interfere with other environments
@@ -165,33 +174,33 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
 * Declared development dependencies
 * Cleaned and sped up specs
 
-=== MetricFu 1.2.0 / 2010-01-09
+### MetricFu 1.2.0 / 2010-01-09
 
 * ftools isn't supported by 1.9 so moved to fileutils.
 * Overhauled the graphing to use Gruff or Google Charts so we no longer depend on ImageMagick/rmagick -- thanks to Carl Youngblood.
 * Stopped relying on Github gems as they will be going away.
 
-=== MetricFu 1.1.6 / 2009-12-14
+### MetricFu 1.1.6 / 2009-12-14
 
 * Now compatible with Reek 1.2x thanks to Kevin Rutherford
 * Fixed problem with deleted files still showing up in Flog reports thanks to Dan Mayer
 
-=== MetricFu 1.1.5 / 2009-8-13
+### MetricFu 1.1.5 / 2009-8-13
 
 * Previous Ruby 1.9 fix was not quite fix-y enough
 
-=== MetricFu 1.1.4 / 2009-7-13
+### MetricFu 1.1.4 / 2009-7-13
 
 * Fixed another Ruby 1.9x bug
 
-=== MetricFu 1.1.3 / 2009-7-10
+### MetricFu 1.1.3 / 2009-7-10
 
 * MetricFu is now Ruby 1.9x compatible
 * Removed the check for deprecated ways of configuring metric_fu as the tests were causing Ruby 1.9x problems and it's been forever since they were supported.
 * Removed total flog score from graph (which will always go up and so doesn't mean much) and replacing it with top_five_percent_average which is an average of the worst 5 percent of your methods.
 * Sort Flog by highest score in the class which I feel is more important than the total flog flog score.
 
-=== MetricFu 1.1.2 / 2009-7-09
+### MetricFu 1.1.2 / 2009-7-09
 
 * Removed dependency on gruff and rmagick (unless the user wants graphs, of course).
 * New look for styling -- Edouard Brière
@@ -199,11 +208,11 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
 * Preventing rake task from being run multiple times when other rake tasks switch the environment -- Matthew Van Horn
 * Typo in Rcov dependency verification and fixing parsing Saikuro nested information -- Mark Wilden
 
-=== MetricFu 1.1.1 / 2009-6-29
+### MetricFu 1.1.1 / 2009-6-29
 
 * Fix for empty flog files
 
-=== MetricFu 1.1.0 / 2009-6-22
+### MetricFu 1.1.0 / 2009-6-22
 
 * Flog, flay, reek, roodi, and rcov reports now graph progress over time.  Well done Nick Quaranto and Edouard Brière.
 * 'Awesome' template has been brought in so that reports look 90% less 'ghetto.'  Also done by Nick Quaranto and Edouard Brière.
@@ -216,18 +225,18 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
 * Changing churn so that it still works deeper than the git root directory -- Andrew Timberlake
 * Andrew Timberlake also made some nice changes to the base template which kinda of got overshadowed by the 'awesome' template.  Sorry about that Andrew.
 
-=== MetricFu 1.0.2 / 2009-5-11
+### MetricFu 1.0.2 / 2009-5-11
 
 * Fixing problems with Reek new line character (thanks to all who pointed this out)
 * Flog now recognizes namespaces in method names thanks to Daniel Guettler
 * Saikuro now looks at multiple directories, again.
 
-=== MetricFu 1.0.1 / 2009-5-3
+### MetricFu 1.0.1 / 2009-5-3
 
 * metrics:all task no longer requires a MetricFu::Configuration.run {} if you want to accept the defaults
 * rcov task now reports total coverage percent
 
-=== MetricFu 1.0.0 / 2009-4-30
+### MetricFu 1.0.0 / 2009-4-30
 
 * Merged in Grant McInnes' work on creating yaml output for all metrics to aid harvesting by other tools
 * Supporting Flog 2.1.0
@@ -237,14 +246,14 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
 * Metrics inherit from a refactored Generator now.  New metrics generators just have to implement "emit", "analyze", "to_h" and inherit from Generator.  They also must have a template.  See the flay generator and template for a simple implementation.
 * You now define the metrics you wish to run in the configuration and then run "metrics:all".  No other metrics task is exposed by default.
 
-=== MetricFu 0.9.0 / 2009-1-25
+### MetricFu 0.9.0 / 2009-1-25
 
 * Adding line numbers to the views so that people viewing it on cc.rb can figure out where the problems are
 * Merging in changes from Jay Zeschin having to do with the railroad task -- I still have no idea how to use it (lemme know if you figure it out)
 * Added totals to Flog results
 * Moved rcov options to configuration
 
-=== MetricFu 0.8.9 / 2009-1-20
+### MetricFu 0.8.9 / 2009-1-20
 
 * Thanks to Andre Arko and Petrik de Heus for adding the following features:
 * The source control type is auto-detected for Churn
@@ -256,7 +265,7 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
 * Metrics can be generated using one command
 * Adding new metrics reports has been standardized
 
-=== MetricFu 0.8.0 / 2008-10-06
+### 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
@@ -264,7 +273,7 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
 * 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
+### MetricFu 0.7.6 / 2008-09-15
 
 * CHURN_OPTIONS has become MetricFu::CHURN_OPTIONS
 * SAIKURO_OPTIONS has become MetricFu::SAIKURO_OPTIONS
@@ -272,16 +281,16 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
 * Exclude gems and Library ruby code from rcov
 * Fixed bug with churn start_date functionality (bad path)
 
-=== MetricFu 0.7.5 / 2008-09-12
+### MetricFu 0.7.5 / 2008-09-12
 
 * Flog can now flog any set of directories you like (see README).
 * Saikuro can now look at any set of directories you like (see README).
 
-=== MetricFu 0.7.1 / 2008-09-12
+### MetricFu 0.7.1 / 2008-09-12
 
 * Fixed filename bugs pointed out by Bastien
 
-=== MetricFu 0.7.0 / 2008-09-11
+### MetricFu 0.7.0 / 2008-09-11
 
 * Merged in Sean Soper's changes to metric_fu.
 * Metric_fu is now a gem.
@@ -289,46 +298,46 @@ Big thanks to Dan Mayer and Ben Brinckerhoff for the Hotspots code and for helpi
 * 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
+    ### 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
+    ### 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
+    ### Metricks 0.3.0 / 2008-06-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
 
-    === Metricks 0.2.0 / 2008-06-11
+    ### Metricks 0.2.0 / 2008-06-11
 
     * 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.1.0 / 2008-06-10
+    ### Metricks 0.1.0 / 2008-06-10
 
     * Initial integration of metric_fu and my enhancements to flog
     * Metrics are generated but are all over the place
 
-=== MetricFu 0.6.0 / 2008-05-11
+### MetricFu 0.6.0 / 2008-05-11
 
 * Add source control churn report
 
-=== MetricFu 0.5.1 / 2008-04-25
+### MetricFu 0.5.1 / 2008-04-25
 
 * Fixed bug with Saikuro report generation - thanks Toby Tripp
 
-=== MetricFu 0.5.0 / 2008-04-25
+### MetricFu 0.5.0 / 2008-04-25
 
 * create MetricFu as a Rails Plugin
 * Add Flog Report

data/lib/metric_fu/data_structures/line_numbers.rb

@@ -16,6 +16,10 @@ module MetricFu
           process_module(file_sexp)
         when :block
           file_sexp.each_of_type(:class) { |sexp| process_class(sexp) }
+        when :iter
+          mf_debug "SEXP: Not parsing line number for #{file_sexp.inspect}"
+        when :cdecl
+          mf_debug "SEXP: Not parsing line number for #{file_sexp.inspect}"
         else
           puts "Unexpected sexp_type #{file_sexp[0].inspect}"
         end

data/lib/metric_fu/metrics/cane/cane.rb

@@ -5,7 +5,7 @@ module MetricFu
     attr_reader :violations, :total_violations
 
     def emit
-      command = %Q{mf-cane#{abc_max_param}#{style_measure_param}#{no_doc_param}}
+      command = %Q{mf-cane#{abc_max_param}#{style_measure_param}#{no_doc_param}#{no_readme_param}}
       mf_debug = "** #{command}"
       @output = `#{command}`
     end
@@ -32,11 +32,16 @@ module MetricFu
       MetricFu.cane[:no_doc] == 'y' ? " --no-doc" : ""
     end
 
+    def no_readme_param
+      MetricFu.cane[:no_readme] == 'y' ? " --no-readme" : ""
+    end
+
     def violations_by_category
       violations_output = @output.scan(/(.*?)\n\n(.*?)\n\n/m)
       violations_output.each_with_object({}) do |(category_desc, violation_list), violations|
-        category = category_from(category_desc)
-        violations[category] = violations_for(category, violation_list)
+        category = category_from(category_desc) || :others
+        violations[category] ||= []
+        violations[category] += violations_for(category, violation_list)
       end
     end
 
@@ -44,9 +49,11 @@ module MetricFu
       category_descriptions = {
         :abc_complexity => /ABC complexity/,
         :line_style => /style requirements/,
-        :comment => /comment/
+        :comment => /comment/,
+        :documentation => /documentation/
       }
-      category_descriptions.find {|k,v| description =~ v}[0]
+      category, desc_matcher = category_descriptions.find {|k,v| description =~ v}
+      category
     end
 
     def violations_for(category, violation_list)
@@ -61,6 +68,10 @@ module MetricFu
         CaneViolations::LineStyle
       when :comment
         CaneViolations::Comment
+      when :documentation
+        CaneViolations::Documentation
+      else
+        CaneViolations::Others
       end
     end
 

data/lib/metric_fu/metrics/cane/init.rb

@@ -6,6 +6,7 @@ MetricFu::Configuration.run do |config|
     :abc_max => 15,
     :line_length => 80,
     :no_doc => 'n',
+    :no_readme => 'n',
     :filetypes => ['rb']
   })
 end

data/lib/metric_fu/metrics/cane/template_awesome/cane.html.erb

@@ -56,6 +56,19 @@
 		<% end %>
 	</table>
   <% end %>
+  <% if @cane[:violations][:documentation] && @cane[:violations][:documentation].size > 0 %>
+  <h3>Missing documentation (<%= @cane[:violations][:documentation].size %>)</h3>
+  <table>
+    <tr>
+      <th>Description</th>
+    </tr>
+    <% @cane[:violations][:documentation].each do |violation| %>
+      <tr>
+        <td><%=violation[:description]%></td>
+      </tr>
+    <% end %>
+  </table>
+  <% end %>
   <% if @cane[:violations][:comment] && @cane[:violations][:comment].size > 0 %>
 	<h3>Class definitions requiring comments (<%= @cane[:violations][:comment].size %>)</h3>
 	<table>
@@ -72,6 +85,19 @@
       <% count += 1 %>
 		<% end %>
 	</table>
+  <% end %>
+  <% if @cane[:violations][:others] && @cane[:violations][:others].size > 0 %>
+  <h3>Others (<%= @cane[:violations][:others].size %>)</h3>
+  <table>
+    <tr>
+      <th>Description</th>
+    </tr>
+    <% @cane[:violations][:others].each do |violation| %>
+      <tr>
+        <td><%=violation[:description]%></td>
+      </tr>
+    <% end %>
+  </table>
   <% end %>
 	<p>Generated on <%= Time.now.localtime %></p>
 </body>

data/lib/metric_fu/metrics/cane/template_standard/cane.html.erb

@@ -47,6 +47,19 @@
 		<% end %>
 	</table>
   <% end %>
+  <% if @cane[:violations][:documentation] && @cane[:violations][:documentation].size > 0 %>
+  <h3>Missing documentation (<%= @cane[:violations][:documentation].size %>)</h3>
+  <table>
+    <tr>
+      <th>Description</th>
+    </tr>
+    <% @cane[:violations][:documentation].each do |violation| %>
+      <tr>
+        <td><%=violation[:description]%></td>
+      </tr>
+    <% end %>
+  </table>
+  <% end %>
   <% if @cane[:violations][:comment] && @cane[:violations][:comment].size > 0 %>
 	<h3>Class definitions requiring comments (<%= @cane[:violations][:comment].size %>)</h3>
 	<table>
@@ -63,6 +76,19 @@
       <% count += 1 %>
 		<% end %>
 	</table>
+  <% end %>
+  <% if @cane[:violations][:others] && @cane[:violations][:others].size > 0 %>
+  <h3>Others (<%= @cane[:violations][:others].size %>)</h3>
+  <table>
+    <tr>
+      <th>Description</th>
+    </tr>
+    <% @cane[:violations][:others].each do |violation| %>
+      <tr>
+        <td><%=violation[:description]%></td>
+      </tr>
+    <% end %>
+  </table>
   <% end %>
 	<p>Generated on <%= Time.now.localtime %></p>
 </body>

data/lib/metric_fu/metrics/cane/violations.rb

@@ -26,5 +26,21 @@ module MetricFu
         end
       end
     end
+
+    class Documentation
+      def self.parse(violation_list)
+        violation_list.split(/\n/).map do |violation|
+          {:description => violation.strip}
+        end
+      end
+    end
+
+    class Others
+      def self.parse(violation_list)
+        violation_list.split(/\n/).map do |violation|
+          {:description => violation.strip}
+        end
+      end
+    end
   end
 end

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = "4.0.0"
+  VERSION = "4.1.0"
 end

data/spec/metric_fu/configuration_spec.rb

@@ -127,7 +127,7 @@ describe MetricFu::Configuration do
       end
 
       it 'should set @cane to ' +
-                          %q(:dirs_to_cane => @code_dirs, :abc_max => 15, :line_length => 80, :no_doc => 'n') do
+                          %q(:dirs_to_cane => @code_dirs, :abc_max => 15, :line_length => 80, :no_doc => 'n', :no_readme => 'y') do
         load_metric 'cane'
         @config.send(:cane).
           should == {
@@ -135,7 +135,8 @@ describe MetricFu::Configuration do
             :filetypes => ["rb"],
             :abc_max => 15,
             :line_length => 80,
-            :no_doc => "n"}
+            :no_doc => "n",
+            :no_readme => "n"}
       end
 
       it 'should set @rcov to ' +

data/spec/metric_fu/metrics/cane/cane_spec.rb

@@ -43,6 +43,20 @@ describe Cane do
       @cane.should_receive(:`).with("mf-cane")
       output = @cane.emit
     end
+
+    it "should use no-readme if specified" do
+      configure_cane_with({no_readme: 'y'})
+      @cane = MetricFu::Cane.new('base_dir')
+      @cane.should_receive(:`).with("mf-cane --no-readme")
+      output = @cane.emit
+    end
+
+    it "should include README violations if no_readme != 'y'" do
+      configure_cane_with({no_readme: 'n'})
+      @cane = MetricFu::Cane.new('base_dir')
+      @cane.should_receive(:`).with("mf-cane")
+      output = @cane.emit
+    end
   end
 
   describe "parse cane output" do
@@ -84,6 +98,21 @@ describe Cane do
           {line: 'lib/comments/bar.rb:2', class_name: 'Bar'}
         ]
       end
+
+      it "should extract no readme violations if present" do
+        @cane.analyze
+        @cane.violations[:documentation].should == [
+          {description: 'No README found'},
+        ]
+      end
+
+      it "should extract unknown violations in others category" do
+        @cane.analyze
+        @cane.violations[:others].should == [
+          {description: 'Misc issue 1'},
+          {description: 'Misc issue 2'}
+        ]
+      end
     end
 
     describe "to_h method" do
@@ -122,11 +151,23 @@ Lines violated style requirements (340):
   lib/line/foo.rb:1       Line is >80 characters (135)
   lib/line/bar.rb:2       Line contains trailing whitespace
 
+Missing documentation (1):
+
+  No README found
+
 Class definitions require explanatory comments on preceding line (2):
 
   lib/comments/foo.rb:1       Foo
   lib/comments/bar.rb:2       Bar
 
+Unknown violation (1):
+
+  Misc issue 1
+
+Another Unknown violation (1):
+
+  Misc issue 2
+
 Total Violations: 6
     OUTPUT
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metric_fu
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -19,7 +19,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails_best_practices