metric_fu 4.1.0 → 4.1.1

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem 'rake'
 group :development, :test do

data/HISTORY.md

@@ -1,5 +1,16 @@
 ### Master
 
+### MetricFu 4.1.1 / 2013-04-16
+
+* Fixes
+  * Fix Syck warning in Ruby > 1.9 (Todd A. Jacobs #58, Benjamin Fleischer)
+  * Cane parser doesn't blow up when no output returned (Guilherme Souza #55)
+  * Fix typo in readme (Paul Elliott #52)
+  * Disable Flog and Cane in non-MRI rubies, as they require ripper (Benjamin Fleischer)
+* Refactor hotspots and graph code to live in its own metric (Benjamin Fleischer #54, #60)
+* Use RedCard gem to determine ruby version and ruby engine
+* Fix Gemfile ssl source warning
+
 ### MetricFu 4.1.0 / 2013-03-06
 
 * Fix crash in cane when missing readme (Sathish, pull request #51)
@@ -9,7 +20,7 @@
 
 * Adding cane metrics (Sathish, pull request #49)
   * Not yet included in hotspots
-  * *Removed ruby 1.9 support*
+  * *Removed ruby 1.8 support*
 
 ### MetricFu 3.0.1 / 2013-03-01
 

data/README.md

@@ -21,8 +21,11 @@ See `metric_fu --help` for more options
 * For 1.8.7 support, see version 3.0.0 for partial support, or 2.1.3.7.18.1 (where [Semantic Versioning](http://semver.org/) goes to die)
 
 * The `japgolly-Saikuro` fork and `metric_fu-roodi` fork are a part of an attempt to get metric_fu working in a modern Ruby environment, specifically compatibility with Ruby 1.9 and Bundler.
+
 * metric_fu no longer runs rcov itself. You may still use rcov metrics as documented below
 
+* The Cane and Flog metrics are disabled in non-MRI rubies as they depend on ripper
+
 ## Documentation
 
 * Cane code quality threshold checking is not included in the hotspots report

data/TODO.md

@@ -6,9 +6,6 @@
 
 * Move code that references rcov out of
 
-    lib/metrics/hotspots/hotspot_analyzer.rb
-    lib/reporting/graphs/engines/bluff.rb
-    lib/reporting/graphs/engines/gchart.rb
     lib/reporting/templates/awesome/css/default.css
     lib/reporting/templates/awesome/index.html.erb
     lib/reporting/templates/standard/default.css
@@ -18,10 +15,6 @@
 
     lib/configuration.rb
     lib/metrics/hotspots/analysis/code_issue.rb
-    lib/metrics/hotspots/analysis/scoring_strategies.rb
-    lib/metrics/hotspots/hotspot_analyzer.rb
-    lib/reporting/graphs/engines/bluff.rb
-    lib/reporting/graphs/engines/gchart.rb
     lib/reporting/templates/awesome/index.html.erb
     lib/reporting/templates/standard/index.html.erb
 
@@ -29,16 +22,12 @@
 
     lib/metrics/generator.rb
     lib/metrics/hotspots/analysis/code_issue.rb
-    lib/metrics/hotspots/hotspot_analyzer.rb
-    lib/reporting/graphs/engines/bluff.rb
-    lib/reporting/graphs/engines/gchart.rb
     lib/reporting/templates/awesome/index.html.erb
     lib/reporting/templates/standard/index.html.erb
 
 * Move code that references churn out of
 
     lib/metrics/hotspots/analysis/code_issue.rb
-    lib/metrics/hotspots/hotspot_analyzer.rb
     lib/metrics/hotspots/init.rb
     lib/reporting/templates/awesome/index.html.erb
     lib/reporting/templates/standard/index.html.erb
@@ -46,21 +35,13 @@
 * Move code that references rails_best_practices out of
 
     lib/metrics/hotspots/analysis/code_issue.rb
-    lib/metrics/hotspots/hotspot_analyzer.rb
-    lib/reporting/graphs/engines/bluff.rb
-    lib/reporting/graphs/engines/gchart.rb
     lib/reporting/templates/awesome/index.html.erb
     lib/reporting/templates/standard/index.html.erb
 
 
 * Move code that references reek out of
 
-    lib/data_structures/location.rb
     lib/metrics/hotspots/analysis/code_issue.rb
-    lib/metrics/hotspots/analysis/scoring_strategies.rb
-    lib/metrics/hotspots/hotspot_analyzer.rb
-    lib/reporting/graphs/engines/bluff.rb
-    lib/reporting/graphs/engines/gchart.rb
     lib/reporting/templates/awesome/index.html.erb
     lib/reporting/templates/standard/index.html.erb
 
@@ -68,23 +49,17 @@
 * Move code that references roodi out of
 
     lib/metrics/hotspots/analysis/code_issue.rb
-    lib/metrics/hotspots/hotspot_analyzer.rb
-    lib/reporting/graphs/engines/bluff.rb
-    lib/reporting/graphs/engines/gchart.rb
     lib/reporting/templates/awesome/index.html.erb
     lib/reporting/templates/standard/index.html.erb
 
 * Move code that references saikuro out of
 
     lib/metrics/hotspots/analysis/code_issue.rb
-    lib/metrics/hotspots/hotspot_analyzer.rb
     lib/reporting/templates/awesome/index.html.erb
     lib/reporting/templates/standard/index.html.erb
 
 * Move code that references stats out of
 
-lib/reporting/graphs/engines/bluff.rb
-lib/reporting/graphs/engines/gchart.rb
 lib/reporting/templates/awesome/index.html.erb
 lib/reporting/templates/standard/index.html.erb
 
@@ -98,16 +73,11 @@ lib/reporting/templates/standard/index.html.erb
 
 ## Features
 
-* Remove rcov by default
-* Either allow user to define a command to run a coverage task or supply a directory with coverage results.   We can't predict every test setup to run coverage correctly, but we can analyze results.
-* Look into getting everything to run on RubyParser ~> 3
 * Look into adding
   * https://github.com/metricfu/code_statistics
   * brakeman https://github.com/metricfu/brakeman
-  * cane https://github.com/square/cane
   * laser https://github.com/metricfu/laser
 * Add configurable logger to all output streams
-* Allow command-line metric_fu to accept parameters, and especially output its version
 * Color code flog results with scale from: http://jakescruggs.blogspot.com/2008/08/whats-good-flog-score.html
 * Make running metric_fu on metric_fu less embarrassing
 * Load all gems at config time so you fail fast if one is missing
@@ -118,21 +88,10 @@ lib/reporting/templates/standard/index.html.erb
 
 * Determine how to test metric_fu against codebases that are not metric_fu, to ensure it works on most applications
   * This is especially true for rails applications
-* <strike>Re-organize test files structure to align with changed structure of library files</strike>
 * Remove / Modify Devver code from the generators/hotspots_spec and base/hotspot_analzyer_spec
-* <strike>Don't leave around test artifacts such as the folders './foo' and './is set'</strike>
 
 ## Bugs / Fixes
 
-* Fix occasional gem install metric_fu failures such as with ripper in Ruby 1.9
-* <strike>Fork roodi and correct the yaml</strike>
-* See https://github.com/metricfu/metric_fu/issues/2 about updating gems
-
-## Ruby 1.9 compatibility
-
-* Consider `RUBYOPT='-rpsych'` e.g. from https://github.com/jscruggs/metric_fu/pull/77
-* Look into using the sexp_processor for ruby parsing in brakeman https://github.com/presidentbeef/brakeman/blob/cdc85962d589fb37e37ed53333bb0b7bd913e028/lib/ruby_parser/bm_sexp_processor.rb
-
 ## Misc
 
 * Determine if CodeIssue is used, else remove it

data/lib/metric_fu.rb

@@ -43,9 +43,17 @@ module MetricFu
   def self.configure
     MetricFu.lib_require { 'configuration' }
     init_files = Dir.glob(File.join(MetricFu.metrics_dir, '**/init.rb')).reject do |file|
-      if file =~ /rcov/
+      if file =~ /rcov/o
         MetricFu.configuration.mf_debug("rcov is not available. See README")
         true
+      elsif MetricFu.configuration.mri?
+        false
+      elsif file =~ /cane/o
+        MetricFu.configuration.mf_debug("Cane is only available in MRI. It requires ripper")
+        true
+      elsif file =~ /flog/o
+        MetricFu.configuration.mf_debug("Flog is only available in MRI. It requires ripper")
+        true
       else
         false
       end

data/lib/metric_fu/configuration.rb

@@ -118,6 +118,14 @@ module MetricFu
       !!ENV['CC_BUILD_ARTIFACTS']
     end
 
+    def jruby?
+      @jruby ||= RedCard.check(:jruby)
+    end
+
+    def mri?
+      @mri ||= RedCard.check(:ruby)
+    end
+
     def platform #:nodoc:
       # TODO, change
       # RbConfig::CONFIG['ruby_install_name'].dup
@@ -125,7 +133,7 @@ module MetricFu
     end
 
     def self.ruby_strangely_makes_accessors_private?
-      !!(RUBY_VERSION =~ /1.9.2/) || defined?(JRUBY_VERSION)
+      RedCard.check('1.9.2') || jruby?
     end
     protected unless ruby_strangely_makes_accessors_private?
 

data/lib/metric_fu/initial_requires.rb

@@ -1,17 +1,17 @@
 require 'rake'
+
 require 'yaml'
-begin
-  require 'psych'
-  YAML::ENGINE.yamler = 'syck'
-rescue LoadError
-  #nothing to report
+require 'redcard'
+
+# Psych is not defined in Ruby < 1.9
+if defined?(Psych)
+  # Syck is not available in Ruby > 1.9 or JRuby 1.9
+  if defined?(Syck) && !RedCard.check(:jruby)
+    YAML::ENGINE.yamler = 'syck'
+  end
 end
-# def with_syck(&block)
-#   current_engine = YAML::ENGINE.yamler
-#   YAML::ENGINE.yamler = 'syck'
-#   block.call
-#   YAML::ENGINE.yamler = current_engine
-# end
+
+
 begin
   require 'active_support'
   require 'active_support/core_ext/object/to_json'

data/lib/metric_fu/load_files.rb

@@ -1,5 +1,6 @@
 # require these first because others depend on them
 MetricFu.reporting_require { 'report' }
+MetricFu.metrics_require   { 'hotspots/hotspot' }
 MetricFu.metrics_require   { 'generator' }
 MetricFu.metrics_require   { 'graph' }
 MetricFu.reporting_require { 'graphs/grapher' }

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

@@ -1,5 +1,3 @@
-require 'cane'
-
 module MetricFu
   class Cane < Generator
     attr_reader :violations, :total_violations
@@ -76,8 +74,11 @@ module MetricFu
     end
 
     def extract_total_violations
-      total = @output.match(/Total Violations: (\d+)/)[1]
-      @total_violations = total.to_i if total
+      if @output =~ /Total Violations: (\d+)/
+        @total_violations = $1.to_i
+      else
+        @total_violations = 0
+      end
     end
   end
 end

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

@@ -0,0 +1,15 @@
+MetricFu.metrics_require   { 'cane/cane_grapher' }
+module MetricFu
+  class CaneBluffGrapher < CaneGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Cane: code quality threshold violations';
+        g.data('cane', [#{@cane_violations.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'cane.js'), 'w') {|f| f << content }
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+MetricFu.reporting_require { 'graphs/grapher' }
 module MetricFu
   class CaneGrapher < Grapher
     attr_accessor :cane_violations, :labels

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

@@ -1,4 +1,5 @@
 MetricFu::Configuration.run do |config|
+  require 'cane'
   config.add_metric(:cane)
   config.add_graph(:cane)
   config.configure_metric(:cane, {

data/lib/metric_fu/metrics/churn/churn_hotspot.rb

@@ -1,4 +1,4 @@
-class ChurnHotspot
+class ChurnHotspot < MetricFu::Hotspot
   include MetricFu::HotspotScoringStrategies
 
   COLUMNS = %w{times_changed}
@@ -35,4 +35,12 @@ class ChurnHotspot
     end
   end
 
+  def present_group(group)
+    "detected high level of churn (changed #{group[0].times_changed} times)"
+  end
+
+  def present_group_details(group)
+    "detected high level of churn (changed #{group[0].times_changed} times)"
+  end
+
 end

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

@@ -1,5 +1,3 @@
-require 'flay'
-
 module MetricFu
 
   class Flay < Generator

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

@@ -0,0 +1,15 @@
+MetricFu.metrics_require   { 'flay/flay_grapher' }
+module MetricFu
+  class FlayBluffGrapher < FlayGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Flay: duplication';
+        g.data('flay', [#{@flay_score.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'flay.js'), 'w') {|f| f << content }
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+MetricFu.metrics_require   { 'flay/flay_grapher' }
+module MetricFu
+  class FlayGchartGrapher < FlayGrapher
+    def graph!
+      determine_y_axis_scale(@flay_score)
+      url = Gchart.line(
+        :size => GCHART_GRAPH_SIZE,
+        :title => URI.escape("Flay: duplication"),
+        :data => @flay_score,
+        :max_value => @max_value,
+        :axis_with_labels => 'x,y',
+        :axis_labels => [@labels.values, @yaxis],
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'flay.png'))
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+MetricFu.reporting_require { 'graphs/grapher' }
 module MetricFu
   class FlayGrapher < Grapher
     attr_accessor :flay_score, :labels

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

@@ -1,4 +1,4 @@
-class FlayHotspot
+class FlayHotspot < MetricFu::Hotspot
   include MetricFu::HotspotScoringStrategies
 
   COLUMNS = %w{flay_reason flay_matching_reason}
@@ -47,4 +47,21 @@ class FlayHotspot
     end
   end
 
+  def present_group(group)
+    occurences = group.size
+    "found #{occurences} code duplications"
+  end
+
+  def present_group_details(group)
+    occurences = group.size
+    message = "found #{occurences} code duplications<br/>"
+    group.each do |item|
+      problem    = item.data["flay_reason"]
+      problem    = problem.gsub(/^[0-9]*\)/,'')
+      problem    = problem.gsub(/files\:/,' <br>&nbsp;&nbsp;&nbsp;files:')
+      message << "* #{problem}<br/>"
+    end
+    message
+  end
+
 end

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

@@ -1,4 +1,5 @@
 MetricFu::Configuration.run do |config|
+  require 'flay'
   config.add_metric(:flay)
   config.add_graph(:flay)
   config.configure_metric(:flay,

data/lib/metric_fu/metrics/flog/flog.rb

@@ -1,7 +1,6 @@
 require 'pathname'
 require 'optparse'
 require 'rbconfig'
-require 'flog'
 class RubyParser
   alias_method :original_process, :process
   def process(s,f,t)
@@ -33,9 +32,12 @@ module MetricFu
       @flogger = ::Flog.new options
       @flogger.flog files
 
-    rescue LoadError
-      if defined?(JRUBY_VERSION)
-        puts 'running in jruby - flog tasks not available'
+    rescue LoadError => e
+      message = "#{e.class}\t#{e.message}\n\t#{e.backtrace.join('\n\t')}"
+      if MetricFu.configuration.mri?
+        puts "Flog Error: #{message}"
+      else
+        puts "Flog tasks only available in MRI: #{message}"
       end
     end
 

data/lib/metric_fu/metrics/flog/flog_bluff_grapher.rb

@@ -0,0 +1,16 @@
+MetricFu.metrics_require   { 'flog/flog_grapher' }
+module MetricFu
+  class FlogBluffGrapher < FlogGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Flog: code complexity';
+        g.data('average', [#{@flog_average.join(',')}]);
+        g.data('top 5% average', [#{@top_five_percent_average.join(',')}])
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'flog.js'), 'w') {|f| f << content }
+    end
+  end
+end