metric_fu 4.2.1 → 4.3.0

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

@@ -1,16 +1,17 @@
 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 = #{MultiJson.dump(@labels)};
-        g.draw();
-      EOS
-      File.open(File.join(MetricFu.output_directory, 'flog.js'), 'w') {|f| f << content }
+    def title
+      'Flog: code complexity'
+    end
+    def data
+      [
+        ['average', @flog_average.join(',')],
+        ['top 5% average', @top_five_percent_average.join(',')]
+      ]
+    end
+    def output_filename
+      'flog.js'
     end
   end
 end

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

@@ -1,21 +1,28 @@
 MetricFu.metrics_require   { 'flog/flog_grapher' }
 module MetricFu
   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% average'],
-        :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, 'flog.png'))
+    def title
+      "Flog: code complexity"
+    end
+    def legend
+      ['average', 'top 5% average']
+    end
+    def data
+      [@flog_average, @top_five_percent_average]
+    end
+    def output_filename
+      'flog.png'
+    end
+    def gchart_line_options
+      super.merge({
+          :bar_colors => COLORS[0..1],
+          :legend => legend,
+          :custom => 'chdlp=t',
+          :stacked => false,
+        })
+    end
+    def y_axis_scale_argument
+      @top_five_percent_average + @flog_average
     end
   end
 end

data/lib/metric_fu/metrics/generator.rb

@@ -6,7 +6,7 @@ module MetricFu
   # skeleton for producing different types of metrics.
   #
   # It drives the production of the metrics through a template
-  # method - #generate_report(options={}).  This method calls
+  # method - #generate_result(options={}).  This method calls
   # #emit, #analyze and #to_h in order to produce the metrics.
   #
   # To implement a concrete class to generate a metric, therefore,
@@ -30,7 +30,7 @@ module MetricFu
   # in general setup the directory structure that the MetricFu system
   # expects.
   class Generator
-    attr_reader :report, :template, :options
+    attr_reader :result, :template, :options
 
     def initialize(options={})
       @options = options
@@ -40,17 +40,17 @@ module MetricFu
     end
 
     # Creates a new generator and returns the output of the
-    # #generate_report method.  This is the typical way to
-    # generate a new MetricFu report. For more information see
-    # the #generate_report instance method.
+    # #generate_result method.  This is the typical way to
+    # generate a new MetricFu result. For more information see
+    # the #generate_result instance method.
     #
     # @params options Hash
     #   A currently unused hash to configure the Generator
     #
-    # @see generate_report
-    def self.generate_report(options={})
+    # @see generate_result
+    def self.generate_result(options={})
       generator = self.new(options)
-      generator.generate_report
+      generator.generate_result
     end
 
     # Provides the unqualified class name of an implemented concrete
@@ -121,7 +121,7 @@ module MetricFu
     # This template method also calls before_emit, after_emit... etc.
     # methods to allow extra hooks into the processing methods, and help
     # to keep the logic of your Generators clean.
-    def generate_report
+    def generate_result
       mf_debug "Executing #{self.class.to_s.gsub(/.*::/, '')}"
 
       %w[emit analyze].each do |meth|
@@ -154,7 +154,7 @@ module MetricFu
       EOF
     end
 
-    def to_graph #:nodoc:
+    def to_h #:nodoc:
       raise <<-EOF
         This method must be implemented by a concrete class descending
         from Generator.  See generator class documentation for more

data/lib/metric_fu/metrics/graph.rb

@@ -12,9 +12,9 @@ module MetricFu
       self.clazz = []
     end
 
-    def add(graph_type, graph_engine)
+    def add(graph_type, graph_engine, output_directory = MetricFu.output_directory)
       grapher_name = graph_type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } + graph_engine.to_s.capitalize + "Grapher"
-      self.clazz.push MetricFu.const_get(grapher_name).new
+      self.clazz.push MetricFu.const_get(grapher_name).new.tap{|g| g.output_directory = output_directory }
     end
 
 

data/lib/metric_fu/metrics/hotspots/analysis/scoring_strategies.rb

@@ -21,9 +21,9 @@ module MetricFu
       # remove dependency on statarray
       # scores.to_statarray.mean
       score_length = scores.length
-      sum = 0
-      sum = scores.inject( nil ) { |sum,x| sum ? sum+x : x }
-      (sum.to_f / score_length.to_f)
+      total = 0
+      total= scores.inject( nil ) { |sum,x| sum ? sum+x : x }
+      (total.to_f / score_length.to_f)
     end
 
     extend self

data/lib/metric_fu/metrics/hotspots/hotspot.rb

@@ -19,11 +19,12 @@ module MetricFu
     end
 
     # TODO simplify calculation
+    # DUPLICATES CODE IN ScoringStrategies
     def get_mean(collection)
       collection_length = collection.length
-      sum = 0
-      sum = collection.inject( nil ) { |sum,x| sum ? sum+x : x }
-      (sum.to_f / collection_length.to_f)
+      total = 0
+      total = collection.inject( nil ) { |sum,x| sum ? sum+x : x }
+      (total.to_f / collection_length.to_f)
     end
   end
 end

data/lib/metric_fu/metrics/hotspots/hotspot_analyzer.rb

@@ -11,36 +11,44 @@ module MetricFu
     COMMON_COLUMNS = %w{metric}
     GRANULARITIES =  %w{file_path class_name method_name}
 
-    # UNUSED
+    # TODO , UNUSED
     # attr_accessor :table
 
     def tool_analyzers
       MetricFu::Hotspot.analyzers
     end
 
-    def initialize(report_hash)
-      # we can't depend on the Report
+    def initialize(result_hash)
+      # we can't depend on the result
       # returning a parsed yaml file as a hash?
-      report_hash = YAML::load(report_hash) if report_hash.is_a?(String)
-      setup(report_hash)
+      result_hash = YAML::load(result_hash) if result_hash.is_a?(String)
+      setup(result_hash)
     end
 
-    # def worst_items
+    # def worst_items; previous method name
     def hotspots
       analyzed_problems.worst_items
     end
-    # just for testing
+
     def analyzed_problems
       @analyzed_problems = MetricFu::HotspotAnalyzedProblems.new(@rankings, @analyzer_tables)
     end
+    # just for testing
+    # TODO remove the delegators
+    # and refactor the tests
     alias_method :worst_items, :hotspots
     extend Forwardable
     def_delegators  :@analyzer_tables, :table
     def_delegators  :@analyzed_problems, :problems_with, :location
     def_delegators  :@rankings, :worst_files, :worst_methods, :worst_classes
+
     private
 
-    def setup(report_hash)
+    # TODO clarify each of these steps in setup
+    # extract into its own method
+    # remove unnecessary constants,
+    # turn into methods
+    def setup(result_hash)
       # TODO There is likely a clash that will happen between
       # column names eventually. We should probably auto-prefix
       # them (e.g. "roodi_problem")
@@ -51,16 +59,17 @@ module MetricFu
       # to ultimately generate the hotspots
       @analyzer_tables = MetricFu::AnalyzerTables.new(analyzer_columns)
       tool_analyzers.each do |analyzer|
-        analyzer.generate_records(report_hash[analyzer.name], @analyzer_tables.table)
+        analyzer.generate_records(result_hash[analyzer.name], @analyzer_tables.table)
       end
       @analyzer_tables.generate_records
       @rankings = MetricFu::HotspotRankings.new(@analyzer_tables.tool_tables)
       @rankings.calculate_scores(tool_analyzers, GRANULARITIES)
       # just for testing
+      # TODO does it not need to return something here?
       analyzed_problems
     end
 
-    # UNUSED
+    # TODO remove, UNUSED
     # def most_common_column(column_name, size)
     #   #grouping = Ruport::Data::Grouping.new(@table,
     #   #                                      :by => column_name,

data/lib/metric_fu/metrics/hotspots/hotspots.rb

@@ -12,7 +12,7 @@ module MetricFu
     end
 
     def emit
-      @analyzer = MetricFu::HotspotAnalyzer.new(MetricFu.report.report_hash)
+      @analyzer = MetricFu::HotspotAnalyzer.new(MetricFu.result.result_hash)
     end
 
     def analyze

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

@@ -3,60 +3,60 @@
 <br/>
 
 <% if !@hotspots || @hotspots.size == 0 %>
-No Hotspots were found.
+  No Hotspots were found.
 <% elsif @hotspots && @hotspots.size > 0 %>
 
-<% granularities = [:files, :classes, :methods] %>
-<table>
-<tr valign="top">
-<% granularities.each do |granularity| %>
-   <th width='33%'>
-<%= granularity.to_s.capitalize %></th>
-<% end %>
-</tr>
+  <% granularities = [:files, :classes, :methods] %>
+  <table>
+    <tr valign="top">
+    <% granularities.each do |granularity| %>
+       <th width='33%'>
+    <%= granularity.to_s.capitalize %></th>
+    <% end %>
+    </tr>
 
-<% items = [] %>
-<% granularities.each_index do |index| %>
-  <% granularity = granularities[index] %>
-  <% items << @hotspots[granularity] %>
-<% end %>
+    <% items = [] %>
+    <% granularities.each_index do |index| %>
+      <% granularity = granularities[index] %>
+      <% items << @hotspots[granularity] %>
+    <% end %>
 
-<% items_length = 0 %>
-<% columns = [0, 1, 2] %>
-<% while (items_length < items[0].length || items_length < items[1].length || items_length < items[2].length) do %>
-    <tr  valign="top">
-       <% columns.each do |column| %>
-       <% item = items[column].length >= items_length ? items[column][items_length] : nil %>
-       <% if item %>
-       <td>
-       <b>
-          <%= display_location(item[:location], nil) %>
-        </b>
-        <% if item[:location].file_path %>
-          <% file, line = item[:location].file_path.split(/:/) %>
-          <% if per_file_data[file] %>
-            <small>&laquo;
-              <b><a href="<%= file.gsub(%r{/}, '_') %>.html<%= (line.nil? ? '' : "#line#{line}") %>">annotate</a></b>
-            &raquo;</small>
+    <% items_length = 0 %>
+    <% columns = [0, 1, 2] %>
+    <% while (items_length < items[0].length || items_length < items[1].length || items_length < items[2].length) do %>
+      <tr  valign="top">
+        <% columns.each do |column| %>
+          <% item = items[column].length >= items_length ? items[column][items_length] : nil %>
+          <% if item %>
+            <% location = item[:location] %>
+            <% file, line =  location.file_name, location.line_number %>
+            <td>
+            <b>
+              <%= display_location(location) %>
+            </b>
+            <% if file != '' %>
+              <% if per_file_data[file] %>
+                <small>&laquo;
+                  <b><a href="<%= file.gsub(%r{/}, '_') %>.html<%= (line.nil? ? '' : "#line#{line}") %>">annotate</a></b>
+                 &raquo;</small>
+              <% end %>
+            <% end %>
+            <br/><br/>
+            <!-- TODO HOTSPOTS for metric fu nice metric_link method -->
+            <% item[:details].each do |metric, info| %>
+              <%#= metric_link(@stat, metric, h(metric.to_s.capitalize)) + ": " + h(info)%><br/>
+              <%= "#{metric.to_s.capitalize}: #{info}" %><br/>
+            <% end %>
+            </td>
+          <% else %>
+          <td> &nbsp; </td>
           <% end %>
         <% end %>
-        <br/><br/>
-        <!-- TODO HOTSPOTS for metric fu nice metric_link method -->
-        <% item[:details].each do |metric, info| %>
-          <%#= metric_link(@stat, metric, h(metric.to_s.capitalize)) + ": " + h(info)%><br/>
-          <%= "#{metric.to_s.capitalize}: #{info}" %><br/>
-          <% end %>
-          </td>
-      <% else %>
-      <td> &nbsp; </td>
-      <% end %>
-      <% end %>
-      <% items_length += 1 %>
+        <% items_length += 1 %>
       </tr>
     <% end %>
 
-</table>
+  </table>
 <% end %>
 
-
 <p>Generated on <%= Time.now.localtime %></p>

data/lib/metric_fu/metrics/rails_best_practices/rails_best_practices_bluff_grapher.rb

@@ -1,15 +1,16 @@
 MetricFu.metrics_require   { 'rails_best_practices/rails_best_practices_grapher' }
 module MetricFu
   class RailsBestPracticesBluffGrapher < RailsBestPracticesGrapher
-    def graph!
-      content = <<-EOS
-        #{BLUFF_DEFAULT_OPTIONS}
-        g.title = 'Rails Best Practices: design problems';
-        g.data('rails_best_practices', [#{@rails_best_practices_count.join(',')}]);
-        g.labels = #{MultiJson.dump(@labels)};
-        g.draw();
-      EOS
-      File.open(File.join(MetricFu.output_directory, 'rails_best_practices.js'), 'w') {|f| f << content }
+    def title
+      'Rails Best Practices: design problems'
+    end
+    def data
+      [
+        ['rails_best_practices', @rails_best_practices_count.join(',')]
+      ]
+    end
+    def output_filename
+      'rails_best_practices.js'
     end
   end
 end

data/lib/metric_fu/metrics/rails_best_practices/rails_best_practices_gchart_grapher.rb

@@ -1,21 +1,27 @@
 MetricFu.metrics_require   { 'rails_best_practices/rails_best_practices_grapher' }
 module MetricFu
   class RailsBestPracticesGchartGrapher < RailsBestPracticesGrapher
-    def graph!
-      determine_y_axis_scale(@rails_best_practices_count)
-      url = Gchart.line(
-        :size => GCHART_GRAPH_SIZE,
-        :title => URI.escape("Rails Best Practices: design problems"),
-        :data => self.rails_best_practices_count,
-        :bar_colors => COLORS[0..1],
-        :legend => ['Problems'],
-        :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, 'rails_best_practices.png')
-      )
+    def title
+      "Rails Best Practices: design problems"
+    end
+    def legend
+      ['Problems']
+    end
+    def data
+      self.rails_best_practices_count
+    end
+    def output_filename
+      'rails_best_practices.png'
+    end
+    def gchart_line_options
+      super.merge({
+          :bar_colors => COLORS[0..1],
+          :legend => legend,
+          :custom => 'chdlp=t',
+        })
+    end
+    def y_axis_scale_argument
+      @rails_best_practices_count
     end
   end
 end

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

@@ -113,7 +113,7 @@ module MetricFu
       files.each_pair {|fname, content| files[fname] = content.split("\n") }
       files.each_pair do |fname, content|
         content.map! do |raw_line|
-          line = Line.new(raw_line[3..-1], !raw_line.match(/^!!/)).to_h
+          Line.new(raw_line[3..-1], !raw_line.match(/^!!/)).to_h
         end
         content.reject! {|line| line[:content].to_s == '' }
         files[fname] = {:lines => content}

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

@@ -1,15 +1,16 @@
 MetricFu.metrics_require   { 'rcov/rcov_grapher' }
 module MetricFu
   class RcovBluffGrapher < RcovGrapher
-    def graph!
-      content = <<-EOS
-        #{BLUFF_DEFAULT_OPTIONS}
-        g.title = 'Rcov: code coverage';
-        g.data('rcov', [#{@rcov_percent.join(',')}]);
-        g.labels = #{MultiJson.dump(@labels)};
-        g.draw();
-      EOS
-      File.open(File.join(MetricFu.output_directory, 'rcov.js'), 'w') {|f| f << content }
+    def title
+      'Rcov: code coverage'
+    end
+    def data
+      [
+        ['rcov', @rcov_percent.join(',')]
+      ]
+    end
+    def output_filename
+      'rcov.js'
     end
   end
 end