nielsm-metric_fu 1.1.1 → 1.3.1

data/lib/generators/reek.rb

@@ -10,7 +10,34 @@ module MetricFu
 
     def emit
       files_to_reek = MetricFu.reek[:dirs_to_reek].map{|dir| Dir[File.join(dir, "**/*.rb")] }
-      @output = `reek #{files_to_reek.join(" ")}`
+      files = remove_excluded_files(files_to_reek.flatten)
+      @output = `reek #{files.join(" ")}`
+      @output = massage_for_reek_12 if reek_12?
+    end
+
+    def reek_12?
+      return false if @output.length == 0
+      (@output =~ /^"/) != 0
+    end
+
+    def massage_for_reek_12
+      section_break = ''
+      @output.split("\n").map do |line|
+        case line
+        when /^  /
+          "#{line.gsub(/^  /, '')}\n"
+        else
+          parts = line.split(" -- ")
+          if parts[1].nil?
+            "#{line}\n"
+          else
+            warnings = parts[1].gsub(/ \(.*\):/, ':')
+            result = "#{section_break}\"#{parts[0]}\" -- #{warnings}\n"
+            section_break = "\n"
+            result
+          end
+        end
+      end.join
     end
 
     def analyze

data/lib/generators/roodi.rb

@@ -9,7 +9,8 @@ module MetricFu
     
     def emit
       files_to_analyze = MetricFu.roodi[:dirs_to_roodi].map{|dir| Dir[File.join(dir, "**/*.rb")] }
-      @output = `roodi #{files_to_analyze.join(" ")}`
+      files = remove_excluded_files(files_to_analyze.flatten)
+      @output = `roodi #{files.join(" ")}`
     end
 
     def analyze

data/lib/generators/saikuro.rb

@@ -3,17 +3,13 @@ module MetricFu
   class Saikuro < Generator
 
     def emit
-      relative_path = [File.dirname(__FILE__), '..', '..',
-                       'vendor', 'saikuro', 'saikuro.rb']
-      saikuro = File.expand_path(File.join(relative_path))
- 
       MetricFu.saikuro[:input_directory] = format_directories
  
       options_string = MetricFu.saikuro.inject("") do |options, option|
         options + "--#{option.join(' ')} "
       end
  
-      sh %{ruby "#{saikuro}" #{options_string}} do |ok, response|
+      sh %{saikuro #{options_string}} do |ok, response|
         unless ok
           puts "Saikuro failed with exit status: #{response.exitstatus}"
           exit 1
@@ -27,36 +23,9 @@ module MetricFu
     end
  
     def analyze
-      @files = []
-      saikuro_results.each do |path|
-        if Saikuro::SFile.is_valid_text_file?(path)
-          file = Saikuro::SFile.new(path)
-          if file
-            @files << file
-          end
-        end
-      end
-      @files = @files.sort_by do |file|
-        file.elements.
-             max {|a,b| a.complexity.to_i <=> b.complexity.to_i}.
-             complexity.to_i
-      end
-      @files.reverse!
-      klasses = []
-      @files.each {|f| klasses << f.elements}
-      klasses.flatten!
-      @classes = klasses.sort_by {|k| k.complexity.to_i}
-      @classes.reverse!
-      meths = []
-      @files.each {|f|
-        f.elements.each {|el|
-          el.defs.each {|defn|
-            defn.name = "#{el.name}##{defn.name}"
-            meths << defn}
-        }
-      }
-      meths = meths.sort_by {|meth| meth.complexity.to_i}
-      @meths = meths.reverse
+      @files = sort_files(assemble_files)
+      @classes = sort_classes(assemble_classes(@files))
+      @meths = sort_methods(assemble_methods(@files))
     end
  
     def to_h
@@ -71,10 +40,54 @@ module MetricFu
                    }
       }
     end
- 
-    def saikuro_results
-      Dir.glob("#{metric_directory}/**/*.html")
+    
+    private
+    def sort_methods(methods)
+      methods.sort_by {|method| method.complexity.to_i}.reverse
+    end
+    
+    def assemble_methods(files)
+      methods = []
+      files.each do |file|
+        file.elements.each do |element|
+          element.defs.each do |defn|
+            defn.name = "#{element.name}##{defn.name}"
+            methods << defn
+          end
+        end
+      end
+      methods
+    end
+    
+    def sort_classes(classes)
+      classes.sort_by {|k| k.complexity.to_i}.reverse
+    end
+    
+    def assemble_classes(files)
+      files.map {|f| f.elements}.flatten
+    end
+    
+    def sort_files(files)
+      files.sort_by do |file|
+        file.elements.
+             max {|a,b| a.complexity.to_i <=> b.complexity.to_i}.
+             complexity.to_i
+      end.reverse
+    end
+    
+    def assemble_files
+      files = []
+      Dir.glob("#{metric_directory}/**/*.html").each do |path|
+        if Saikuro::SFile.is_valid_text_file?(path)
+          file = Saikuro::SFile.new(path)
+          if file
+            files << file
+          end
+        end
+      end
+      files
     end
+    
   end
  
   class Saikuro::SFile
@@ -120,10 +133,10 @@ module MetricFu
             line = @file_handle.readline
             element = Saikuro::ParsingElement.new(line)
           elsif line.match /END/
-            @elements << element unless element.nil?
+            @elements << element if element
             element = nil
           else
-            element << line
+            element << line if element
           end
         end
       rescue EOFError

data/lib/generators/stats.rb

@@ -8,18 +8,39 @@ module MetricFu
 
     def analyze
       output = File.open(metric_directory + '/stats.txt').read
-      output = output.split("\n")
-      output = output.find_all {|line| line[0].chr != "+" }
-      output = output.find_all {|line| line[0].chr != "(" }
-      output.shift
-      totals = output.pop
-      totals = totals.split("  ").find_all {|el| ! el.empty? }
+      lines = remove_noise(output)
+
       @stats = {}
+      
+      set_global_stats(lines.pop)
+      set_granular_stats(lines)
+
+      @stats
+    end
+
+    def to_h
+      {:stats => @stats}
+    end
+    
+    private
+    
+    def remove_noise(output)
+      lines = output.split("\n")
+      lines = lines.find_all {|line| line[0].chr != "+" }
+      lines = lines.find_all {|line| line[0].chr != "(" }
+      lines.shift
+      lines
+    end
+    
+    def set_global_stats(totals)
+      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
       @stats[:code_to_test_ratio] = totals[2].match(/1\:(\d.*)/)[1].to_f
-      
-      @stats[:lines] = output.map do |line|
+    end
+    
+    def set_granular_stats(lines)
+      @stats[:lines] = lines.map do |line|
         elements = line.split("|")
         elements.map! {|el| el.strip }
         elements = elements.find_all {|el| ! el.empty? }
@@ -32,11 +53,6 @@ module MetricFu
         end
         info_line
       end
-      @stats
-    end
-
-    def to_h
-      {:stats => @stats}
     end
 
   end

data/lib/graphs/engines/bluff.rb

@@ -0,0 +1,86 @@
+require 'active_support'
+
+module MetricFu
+  class Grapher
+    BLUFF_GRAPH_SIZE = "1000x600"
+    BLUFF_DEFAULT_OPTIONS = <<-EOS
+      var g = new Bluff.Line('graph', "#{BLUFF_GRAPH_SIZE}");
+      g.theme_37signals();
+      g.tooltips = true;
+      g.title_font_size = "24px"
+      g.legend_font_size = "12px"
+      g.marker_font_size = "10px"
+    EOS
+  end
+  
+  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
+
+  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
+
+  class RcovBluffGrapher < RcovGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Rcov: code coverage';
+        g.data('rcov', [#{@rcov_percent.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'rcov.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class ReekBluffGrapher < ReekGrapher
+    def graph!
+      legend = @reek_count.keys.sort
+      data = ""
+      legend.each do |name|
+        data += "g.data('#{name}', [#{@reek_count[name].join(',')}])\n"
+      end
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Reek: code smells';
+        #{data}
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'reek.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class RoodiBluffGrapher < RoodiGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Roodi: design problems';
+        g.data('roodi', [#{@roodi_count.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'roodi.js'), 'w') {|f| f << content }
+    end
+  end
+end

data/lib/graphs/engines/gchart.rb

@@ -0,0 +1,118 @@
+module MetricFu
+  module GchartGrapher
+    COLORS = %w{009999 FF7400 A60000 008500 E6399B 344AD7 00B860 D5CCB9}    
+    GCHART_GRAPH_SIZE = "1000x300" # maximum permitted image size is 300000 pixels
+    
+    NUMBER_OF_TICKS = 6
+    def determine_y_axis_scale(values)
+      values.collect! {|val| val || 0.0 }
+      if values.empty?
+        @max_value = 10
+        @yaxis = [0, 2, 4, 6, 8, 10]
+      else
+        @max_value = values.max + Integer(0.1 * values.max)
+        portion_size = (@max_value / (NUMBER_OF_TICKS - 1).to_f).ceil
+        @yaxis = []
+        NUMBER_OF_TICKS.times {|n| @yaxis << Integer(portion_size * n) }
+        @max_value = @yaxis.last
+      end
+    end
+  end
+  
+  class Grapher
+    include MetricFu::GchartGrapher
+    
+    def self.require_graphing_gem
+      require 'gchart'
+    rescue LoadError
+      puts "#"*99 + "\n" +
+           "If you want to use google charts for graphing, you'll need to install the googlecharts rubygem." +
+           "\n" + "#"*99
+    end
+  end
+
+  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
+
+  class FlogGchartGrapher < FlogGrapher
+    def graph!
+      determine_y_axis_scale(@top_five_percent_average + @flog_average)
+      url = Gchart.line(
+        :size => GCHART_GRAPH_SIZE,
+        :title => URI.escape("Flog: code complexity"),
+        :data => [@flog_average, @top_five_percent_average],
+        :stacked => false,
+        :bar_colors => COLORS[0..1],
+        :legend => ['average', 'top 5%25 average'],
+        :max_value => @max_value,
+        :axis_with_labels => 'x,y',
+        :axis_labels => [@labels.values, @yaxis],
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'flog.png'))
+    end
+  end
+  
+  class RcovGchartGrapher < RcovGrapher
+    def graph!
+      url = Gchart.line(
+        :size => GCHART_GRAPH_SIZE,
+        :title => URI.escape("Rcov: code coverage"),
+        :data => self.rcov_percent,
+        :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
+
+  class ReekGchartGrapher < ReekGrapher
+    def graph!
+      determine_y_axis_scale(@reek_count.values.flatten.uniq)
+      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,
+        :max_value => @max_value,
+        :axis_with_labels => 'x,y',
+        :axis_labels => [@labels.values, @yaxis],
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'reek.png'))
+    end
+  end
+  
+  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'))
+    end
+  end
+end

data/lib/graphs/flay_grapher.rb

@@ -1,32 +1,18 @@
-require 'gruff'
 module MetricFu
   
-  class FlayGrapher
+  class FlayGrapher < Grapher
     
     attr_accessor :flay_score, :labels
     
     def initialize
-      self.flay_score = []
-      self.labels = {}
+      super
+      @flay_score = []
+      @labels = {}
     end
     
     def get_metrics(metrics, date)
-      self.flay_score.push(metrics[:flay][:total_score].to_i)
-      self.labels.update( { self.labels.size => date })
-    end
-    
-    def graph!
-      g = Gruff::Line.new(MetricFu.graph_size)
-      g.title = "Flay: duplication"
-      g.theme = MetricFu.graph_theme
-      g.font = MetricFu.graph_font
-      g.data('flay', self.flay_score)
-      g.labels = self.labels
-      g.title_font_size = MetricFu.graph_title_font_size
-      g.legend_box_size = MetricFu.graph_legend_box_size
-      g.legend_font_size = MetricFu.graph_legend_font_size
-      g.marker_font_size = MetricFu.graph_marker_font_size
-      g.write(File.join(MetricFu.output_directory, 'flay.png'))
+      @flay_score.push(metrics[:flay][:total_score].to_i)
+      @labels.update( { @labels.size => date })
     end
     
   end