metric_fu 4.2.1 → 4.3.0

data/lib/metric_fu/metrics/rcov/rcov_gchart_grapher.rb

@@ -1,17 +1,22 @@
 MetricFu.metrics_require   { 'rcov/rcov_grapher' }
 module MetricFu
   class RcovGchartGrapher < RcovGrapher
-    def graph!
-      url = Gchart.line(
-        :size => GCHART_GRAPH_SIZE,
-        :title => URI.escape("Rcov: code coverage"),
-        :data => self.rcov_percent,
+    def title
+      "Rcov: code coverage"
+    end
+    def data
+      self.rcov_percent
+    end
+    def output_filename
+      'rcov.png'
+    end
+    # overrides method
+    def y_axis_scale_options
+      {
         :max_value => 101,
         :axis_with_labels => 'x,y',
         :axis_labels => [self.labels.values, [0,20,40,60,80,100]],
-        :format => 'file',
-        :filename => File.join(MetricFu.output_directory, 'rcov.png')
-      )
+      }
     end
   end
 end

data/lib/metric_fu/metrics/reek/reek_bluff_grapher.rb

@@ -1,20 +1,16 @@
 MetricFu.metrics_require   { 'reek/reek_grapher' }
 module MetricFu
   class ReekBluffGrapher < ReekGrapher
-    def graph!
-      legend = @reek_count.keys.sort
-      data = ""
-      legend.each do |name|
-        data += "g.data('#{name}', [#{@reek_count[name].join(',')}])\n"
+    def title
+      'Reek: code smells'
+    end
+    def data
+      @reek_count.map do |name, count|
+        [name, count.join(',')]
       end
-      content = <<-EOS
-        #{BLUFF_DEFAULT_OPTIONS}
-        g.title = 'Reek: code smells';
-        #{data}
-        g.labels = #{MultiJson.dump(@labels)};
-        g.draw();
-      EOS
-      File.open(File.join(MetricFu.output_directory, 'reek.js'), 'w') {|f| f << content }
+    end
+    def output_filename
+      'reek.js'
     end
   end
 end

data/lib/metric_fu/metrics/reek/reek_gchart_grapher.rb

@@ -1,25 +1,30 @@
 MetricFu.metrics_require   { 'reek/reek_grapher' }
 module MetricFu
   class ReekGchartGrapher < ReekGrapher
-    def graph!
-      determine_y_axis_scale(@reek_count.values.flatten.uniq)
+    def title
+      "Reek: code smells"
+    end
+    def legend
+      @legend ||= @reek_count.keys.sort
+    end
+    def data
       values = []
-      legend = @reek_count.keys.sort
       legend.collect {|k| values << @reek_count[k]}
-
-      url = Gchart.line(
-        :size => GCHART_GRAPH_SIZE,
-        :title => URI.escape("Reek: code smells"),
-        :data => values,
-        :stacked => false,
-        :bar_colors => COLORS,
-        :legend => legend,
-        :custom => "chdlp=t",
-        :max_value => @max_value,
-        :axis_with_labels => 'x,y',
-        :axis_labels => [@labels.values, @yaxis],
-        :format => 'file',
-        :filename => File.join(MetricFu.output_directory, 'reek.png'))
+      values
+    end
+    def output_filename
+      'reek.png'
+    end
+    def gchart_line_options
+      super.merge({
+          :bar_colors => COLORS,
+          :stacked => false,
+          :legend => legend,
+          :custom => 'chdlp=t',
+        })
+    end
+    def y_axis_scale_argument
+      @reek_count.values.flatten.uniq
     end
   end
 end

data/lib/metric_fu/metrics/roodi/roodi_bluff_grapher.rb

@@ -1,15 +1,16 @@
 MetricFu.metrics_require   { 'roodi/roodi_grapher' }
 module MetricFu
   class RoodiBluffGrapher < RoodiGrapher
-    def graph!
-      content = <<-EOS
-        #{BLUFF_DEFAULT_OPTIONS}
-        g.title = 'Roodi: design problems';
-        g.data('roodi', [#{@roodi_count.join(',')}]);
-        g.labels = #{MultiJson.dump(@labels)};
-        g.draw();
-      EOS
-      File.open(File.join(MetricFu.output_directory, 'roodi.js'), 'w') {|f| f << content }
+    def title
+      'Roodi: design problems'
+    end
+    def data
+      [
+        ['roodi', @roodi_count.join(',')]
+      ]
+    end
+    def output_filename
+      'roodi.js'
     end
   end
 end

data/lib/metric_fu/metrics/roodi/roodi_gchart_grapher.rb

@@ -1,17 +1,20 @@
 MetricFu.metrics_require   { 'roodi/roodi_grapher' }
 module MetricFu
   class RoodiGchartGrapher < RoodiGrapher
-    def graph!
-      determine_y_axis_scale(@roodi_count)
-      url = Gchart.line(
-        :size => GCHART_GRAPH_SIZE,
-        :title => URI.escape("Roodi: potential design problems"),
-        :data => @roodi_count,
-        :max_value => @max_value,
-        :axis_with_labels => 'x,y',
-        :axis_labels => [@labels.values, @yaxis],
-        :format => 'file',
-        :filename => File.join(MetricFu.output_directory, 'roodi.png'))
+    def title
+      "Roodi: potential design problems"
+    end
+    def data
+      @roodi_count
+    end
+    def output_filename
+      'roodi.png'
+    end
+    def gchart_line_options
+      super
+    end
+    def y_axis_scale_argument
+      @roodi_count
     end
   end
 end

data/lib/metric_fu/metrics/saikuro/saikuro.rb

@@ -1,8 +1,6 @@
 module MetricFu
 
   class Saikuro < Generator
-    include Rake::DSL if defined?(Rake::DSL) # rake 0.8.7 and 0.9.2 compatible
-
     def emit
       options_string = MetricFu.saikuro.inject("") do |options, option|
         option[0] == :input_directory ? options : options + "--#{option.join(' ')} "
@@ -12,36 +10,9 @@ module MetricFu
         options_string += "--input_directory #{input_dir} "
       end
 
-      saikuro_bin= $:.map{|d| d+'/../bin/saikuro'}.select{|f| File.exists? f}.first || 'saikuro'
-      mf_debug(capture_output do
-        sh %{#{saikuro_bin} #{options_string}} do |ok, response|
-          unless ok
-            mf_log "Saikuro failed with exit status: #{response.exitstatus}"
-          end
-        end
-      end)
-    end
-
-    def capture_output(&block)
-      old_stdout = STDOUT.clone
-      pipe_r, pipe_w = IO.pipe
-      pipe_r.sync    = true
-      output         = ""
-      reader = Thread.new do
-        begin
-          loop do
-            output << pipe_r.readpartial(1024)
-          end
-        rescue EOFError
-        end
-      end
-      STDOUT.reopen(pipe_w)
-      yield
-    ensure
-      STDOUT.reopen(old_stdout)
-      pipe_w.close
-      reader.join
-      return output
+      command = %Q(mf-saikuro #{options_string})
+      mf_debug "** #{command}"
+      `#{command}`
     end
 
     def format_directories
@@ -186,14 +157,14 @@ module MetricFu
         while (line = @file_handle.readline) do
           return [] if line.nil? || line !~ /\S/
           element ||= nil
-          if line.match /START/
+          if line.match(/START/)
             unless element.nil?
               @elements << element
               element = nil
             end
             line = @file_handle.readline
             element = Saikuro::ParsingElement.new(line)
-          elsif line.match /END/
+          elsif line.match(/END/)
             @elements << element if element
             element = nil
           else

data/lib/metric_fu/metrics/stats/stats.rb

@@ -10,7 +10,7 @@ module MetricFu
 
     def analyze
       output = File.open(metric_directory + '/stats.txt').read
-      lines = remove_noise(output)
+      lines = remove_noise(output).compact
 
       @stats = {}
 
@@ -34,6 +34,7 @@ module MetricFu
     end
 
     def set_global_stats(totals)
+      return if totals.nil?
       totals = totals.split("  ").find_all {|el| ! el.empty? }
       @stats[:codeLOC] = totals[0].match(/\d.*/)[0].to_i
       @stats[:testLOC] = totals[1].match(/\d.*/)[0].to_i

data/lib/metric_fu/metrics/stats/stats_bluff_grapher.rb

@@ -1,16 +1,17 @@
 MetricFu.metrics_require   { 'stats/stats_grapher' }
 module MetricFu
   class StatsBluffGrapher < StatsGrapher
-    def graph!
-      content = <<-EOS
-        #{BLUFF_DEFAULT_OPTIONS}
-        g.title = 'Stats: LOC & LOT';
-        g.data('LOC', [#{@loc_counts.join(',')}]);
-        g.data('LOT', [#{@lot_counts.join(',')}])
-        g.labels = #{MultiJson.dump(@labels)};
-        g.draw();
-      EOS
-      File.open(File.join(MetricFu.output_directory, 'stats.js'), 'w') {|f| f << content }
+    def title
+      'Stats: LOC & LOT'
+    end
+    def data
+      [
+        ['LOC', @loc_counts.join(',')],
+        ['LOT', @lot_counts.join(',')],
+      ]
+    end
+    def output_filename
+      'stats.js'
     end
   end
 end

data/lib/metric_fu/metrics/stats/stats_gchart_grapher.rb

@@ -1,20 +1,27 @@
 MetricFu.metrics_require   { 'stats/stats_grapher' }
 module MetricFu
   class StatsGchartGrapher < StatsGrapher
-    def graph!
-      determine_y_axis_scale(@loc_counts + @lot_counts)
-      url = Gchart.line(
-        :size => GCHART_GRAPH_SIZE,
-        :title => URI.escape("Stats: LOC & LOT"),
-        :data => [@loc_counts, @lot_counts],
-        :bar_colors => COLORS[0..1],
-        :legend => ['Lines of code', 'Lines of test'],
-        :custom => "chdlp=t",
-        :max_value => @max_value,
-        :axis_with_labels => 'x,y',
-        :axis_labels => [@labels.values, @yaxis],
-        :format => 'file',
-        :filename => File.join(MetricFu.output_directory, 'stats.png'))
+    def title
+      "Stats: LOC & LOT"
+    end
+    def data
+      [@loc_counts, @lot_counts]
+    end
+    def output_filename
+      'stats.png'
+    end
+    def legend
+      ['Lines of code', 'Lines of test']
+    end
+    def gchart_line_options
+      super.merge({
+          :bar_colors => COLORS[0..1],
+          :legend => legend,
+          :custom => 'chdlp=t',
+        })
+    end
+    def y_axis_scale_argument
+      @loc_counts + @lot_counts
     end
   end
 end

data/lib/metric_fu/reporter.rb

@@ -0,0 +1,37 @@
+module MetricFu
+  class Reporter
+    def initialize(formatters=nil)
+      @formatters = Array(formatters)
+    end
+
+    def start
+      notify :start
+    end
+
+    def finish
+      notify :finish
+    end
+
+    def start_metric(metric)
+      mf_log "** STARTING METRIC #{metric}"
+      notify :start_metric, metric
+    end
+
+    def finish_metric(metric)
+      mf_log "** ENDING METRIC #{metric}"
+      notify :finish_metric, metric
+    end
+
+    def display_results
+      notify :display_results
+    end
+
+    protected
+
+    def notify(event, *args)
+      @formatters.each do |formatter|
+        formatter.send(event, *args) if formatter.respond_to?(event)
+      end
+    end
+  end
+end

data/lib/metric_fu/reporting/graphs/engines/bluff.rb

@@ -9,5 +9,25 @@ module MetricFu
       g.legend_font_size = "12px"
       g.marker_font_size = "10px"
     EOS
+    def graph!
+      title = send(:title)
+      data = send(:data)
+      labels = MultiJson.dump(@labels)
+      output_filename = send(:output_filename)
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = '#{title}';
+        #{build_data(data)}
+        g.labels = #{labels};
+        g.draw();
+      EOS
+      File.open(File.join(self.output_directory, output_filename), 'w') {|f| f << content }
+    end
+    private
+    def build_data(data)
+      Array(data).map do |label, datum|
+        "g.data('#{label}', [#{datum}]);"
+      end.join("\n")
+    end
   end
 end

data/lib/metric_fu/reporting/graphs/engines/gchart.rb

@@ -2,9 +2,42 @@ module MetricFu
   module GchartGrapher
     COLORS = %w{009999 FF7400 A60000 008500 E6399B 344AD7 00B860 D5CCB9}
     GCHART_GRAPH_SIZE = "945x317" # maximum permitted image size is 300000 pixels
-
     NUMBER_OF_TICKS = 6
+
+    # @see gchart_line_options
+    def graph!
+      options = gchart_line_options.reject{|_,v|v.nil?}
+      Gchart.line(options)
+    end
+    # @note Some values are initialized as nil to maintain consistent
+    # key ordering for the tests.  Any keys with nil values are removed
+    # before graphing
+    def gchart_line_options
+      {
+        :size => GCHART_GRAPH_SIZE,
+        :title => URI.encode(title),
+        :data => data,
+        :stacked => nil,
+        :bar_colors => nil,
+        :legend => nil,
+        :custom => nil,
+        :max_value => nil,
+        :axis_with_labels => nil,
+        :axis_labels => nil,
+        :format => 'file',
+        :filename => File.join(self.output_directory, output_filename),
+      }.merge(y_axis_scale_options)
+    end
+    def y_axis_scale_options
+      determine_y_axis_scale(y_axis_scale_argument)
+      {
+        :max_value => @max_value,
+        :axis_with_labels => 'x,y',
+        :axis_labels => [@labels.values, @yaxis],
+      }
+    end
     def determine_y_axis_scale(values)
+      values = Array(values)
       values.collect! {|val| val || 0.0 }
       if values.empty?
         @max_value = 10
@@ -17,13 +50,18 @@ module MetricFu
         @max_value = @yaxis.last
       end
     end
+    def y_axis_scale_argument
+      raise "#{__LINE__} in #{__FILE__} from #{caller.join('\n')}"
+    end
   end
 
   class Grapher
-    include MetricFu::GchartGrapher
 
     def self.require_graphing_gem
-      require 'gchart' if MetricFu.graph_engine == :gchart
+      if MetricFu.graph_engine == :gchart
+        require 'gchart'
+        include MetricFu::GchartGrapher
+      end
     rescue LoadError
       mf_log "#"*99 + "\n" +
            "If you want to use google charts for graphing, you'll need to install the googlecharts rubygem." +