metric_fu 4.4.4 → 4.5.1

data/lib/metric_fu/logging/mf_debugger.rb

@@ -42,6 +42,7 @@ module MfDebugger
       STDOUT.reopen(old_stdout)
       pipe_w.close
       reader.join
+      pipe_r.close
       return output
     end
   end

data/lib/metric_fu/metric.rb

@@ -1,4 +1,5 @@
 require 'set'
+MetricFu.lib_require { 'gem_run' }
 # Encapsulates the configuration options for each metric
 module MetricFu
   class Metric
@@ -28,11 +29,33 @@ module MetricFu
       not_implemented
     end
 
+    def gem_name
+      name
+    end
+
     # @return metric run options [Hash]
     def run_options
       default_run_options.merge(configured_run_options)
     end
 
+    def default_run_args
+      run_options.map { |k, v| "--#{k} #{v}" }.join(' ')
+    end
+
+    def run
+      not_implemented
+    end
+
+    def run_external(args = default_run_args)
+      runner = GemRun.new({
+        gem_name: gem_name.to_s,
+        metric_name: name.to_s,
+        # version: ,
+        args: args,
+      })
+      runner.run
+    end
+
     def configured_run_options
       @configured_run_options
     end
@@ -97,6 +120,5 @@ module MetricFu
       @libraries << file.strip
     end
 
-
   end
 end

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

@@ -7,9 +7,13 @@ module MetricFu
     end
 
     def emit
-      command = %Q{mf-cane#{abc_max_param}#{style_measure_param}#{no_doc_param}#{no_readme_param}}
-      mf_debug "** #{command}"
-      @output = `#{command}`
+      args =  [
+        abc_max_param,
+        style_measure_param,
+        no_doc_param,
+        no_readme_param
+      ].join
+      @output = run!(args)
     end
 
     def analyze

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

@@ -3,6 +3,10 @@ module MetricFu
   class CaneGrapher < Grapher
     attr_accessor :cane_violations, :labels
 
+    def self.metric
+      :cane
+    end
+
     def initialize
       super
       @cane_violations = []
@@ -15,6 +19,21 @@ module MetricFu
         @labels.update( { @labels.size => date })
       end
     end
+
+    def title
+      'Cane: code quality threshold violations'
+    end
+
+    def data
+      [
+        ['cane', @cane_violations.join(',')]
+      ]
+    end
+
+    def output_filename
+      'cane.js'
+    end
+
   end
 end
 

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

@@ -13,12 +13,8 @@
   <p><a href='https://github.com/square/cane'>Cane</a> reports code quality threshold violations.</p>
 
   <% graph_name = 'cane' %>
-  <% if MetricFu.configuration.graph_engine == :gchart %>
-  <img src="<%= graph_name %>.png?<%= Time.now.to_i %>" />
-  <% else %>
   <canvas id="graph"></canvas>
   <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
-  <% end %>
 
   <% if @cane[:violations][:abc_complexity] && @cane[:violations][:abc_complexity].size > 0 %>
 	<h3>Methods exceeding allowed Abc complexity (<%= @cane[:violations][:abc_complexity].size %>)</h3>

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

@@ -26,7 +26,12 @@ module MetricFu
     private
 
     def generate_churn_metrics
-      ensure_output_is_valid_yaml(churn_code)
+      output = churn_code
+      ensure_output_is_valid_yaml(output)
+    end
+
+    def churn_code
+      run!(build_churn_options)
     end
 
     def ensure_output_is_valid_yaml(output)
@@ -38,12 +43,6 @@ module MetricFu
       end
     end
 
-    def churn_code
-      command = "mf-churn #{build_churn_options}"
-      mf_debug "** #{command}"
-      `#{command}`
-    end
-
     def build_churn_options
       opts = ["--yaml"]
       churn_options.each do |churn_option, command_flag|

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

@@ -8,10 +8,8 @@ module MetricFu
 
     def emit
       minimum_score_parameter = options[:minimum_score] ? "--mass #{options[:minimum_score]} " : ""
-
-      command = %Q(mf-flay #{minimum_score_parameter} #{options[:dirs_to_flay].join(" ")})
-      mf_debug "** #{command}"
-      @output = `#{command}`
+      args =  "#{minimum_score_parameter} #{options[:dirs_to_flay].join(" ")}"
+      @output = run!(args)
     end
 
     def analyze

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

@@ -3,6 +3,10 @@ module MetricFu
   class FlayGrapher < Grapher
     attr_accessor :flay_score, :labels
 
+    def self.metric
+      :flay
+    end
+
     def initialize
       super
       @flay_score = []
@@ -15,5 +19,20 @@ module MetricFu
         @labels.update( { @labels.size => date })
       end
     end
+
+    def title
+      'Flay: duplication'
+    end
+
+    def data
+      [
+        ['flay', @flay_score.join(',')]
+      ]
+    end
+
+    def output_filename
+      'flay.js'
+    end
+
   end
 end

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

@@ -3,12 +3,8 @@
 <p><a href='http://ruby.sadi.st/Flay.html'>Flay</a> analyzes ruby code for structural similarities.</p>
 
 <% graph_name = 'flay' %>
-<% if MetricFu.configuration.graph_engine == :gchart %>
-<img src="<%= graph_name %>.png?<%= Time.now.to_i %>" />
-<% else %>
 <canvas id="graph"></canvas>
 <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
-<% end %>
 
 <h4>Total Score (lower is better): <%= @flay[:total_score] %></h4>
 <h5>Scores less than <%= MetricFu::Metric.get_metric('flay').run_options[:minimum_score] %> are not shown or part of the total</h5>

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

@@ -48,8 +48,6 @@ module MetricFu
 
           file, line = data[:path].split(':')
 
-          out[file] ||= {}
-          out[file][line] ||= []
           out[file][line] << {:type => :flog, :description => "Score of %.2f" % data[:score]}
         end
       end

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

@@ -3,6 +3,10 @@ module MetricFu
   class FlogGrapher < Grapher
     attr_accessor :flog_average, :labels, :top_five_percent_average
 
+    def self.metric
+      :flog
+    end
+
     def initialize
       super
       @flog_average = []
@@ -18,6 +22,21 @@ module MetricFu
       end
     end
 
+    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
+
     private
 
     def calc_top_five_percent_average(metrics)

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

@@ -2,12 +2,8 @@
 <p><a href='http://ruby.sadi.st/Flog.html'>Flog</a> measures code complexity.</p>
 
 <% graph_name = 'flog' %>
-<% if MetricFu.configuration.graph_engine == :gchart %>
-<img src="<%= graph_name %>.png?<%= Time.now.to_i %>" />
-<% else %>
 <canvas id="graph"></canvas>
 <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
-<% end %>
 
 <h2>Total Flog score for all methods: <%= round_to_tenths @flog[:total]%></h2>
 <h2>Average Flog score for all methods: <%= round_to_tenths @flog[:average]%></h2>

data/lib/metric_fu/metrics/generator.rb

@@ -38,12 +38,24 @@ module MetricFu
       @options = options
     end
 
+    def self.metric
+      not_implemented
+    end
+
+    def metric
+      self.class.metric
+    end
+
     @generators = []
     # @return all subclassed generators [Array<MetricFu::Generator>]
     def self.generators
       @generators
     end
 
+    def self.metric
+      not_implemented
+    end
+
     def self.get_generator(metric)
       generators.find{|generator|generator.metric.to_s == metric.to_s.downcase}
     end
@@ -76,12 +88,17 @@ module MetricFu
       paths - files_to_remove
     end
 
-    # Defines some hook methods for the concrete classes to hook into.
-    %w[emit analyze].each do |meth|
-      define_method("before_#{meth}".to_sym) {}
-      define_method("after_#{meth}".to_sym) {}
+    def metric
+      self.class.metric
+    end
+
+    def metric_config
+      MetricFu::Metric.get_metric(metric)
+    end
+
+    def run!(args)
+      metric_config.run_external(args)
     end
-    define_method("before_to_h".to_sym) {}
 
     # Provides a template method to drive the production of a metric
     # from a concrete implementation of this class.  Each concrete
@@ -93,15 +110,10 @@ module MetricFu
     # methods to allow extra hooks into the processing methods, and help
     # to keep the logic of your Generators clean.
     def generate_result
-      mf_debug "Executing #{self.class.to_s.gsub(/.*::/, '')}"
-
-      %w[emit analyze].each do |meth|
-        send("before_#{meth}".to_sym)
-        send("#{meth}".to_sym)
-        send("after_#{meth}".to_sym)
-      end
-      before_to_h()
-      to_h()
+      mf_debug "Executing #{metric}"
+      emit
+      analyze
+      to_h
     end
 
     def round_to_tenths(decimal)
@@ -110,27 +122,25 @@ module MetricFu
     end
 
     def emit #:nodoc:
-      raise <<-EOF
-        This method must be implemented by a concrete class descending
-        from Generator.  See generator class documentation for more
-        information.
-      EOF
+      self.class.not_implemented
     end
 
     def analyze #:nodoc:
-      raise <<-EOF
-        This method must be implemented by a concrete class descending
-        from Generator.  See generator class documentation for more
-        information.
-      EOF
+      self.class.not_implemented
     end
 
     def to_h #:nodoc:
+      self.class.not_implemented
+    end
+
+    def self.not_implemented
       raise <<-EOF
+        Required method #{caller[0]} not implemented in #{__FILE__}.
         This method must be implemented by a concrete class descending
         from Generator.  See generator class documentation for more
         information.
       EOF
     end
+
   end
 end

data/lib/metric_fu/metrics/graph.rb

@@ -12,14 +12,14 @@ module MetricFu
       self.graphers = []
     end
 
-    def add(graph_type, graph_engine, output_directory = MetricFu::Io::FileSystem.directory('output_directory'))
-      grapher = grapher_from_type_and_engine(graph_type, graph_engine)
-      self.graphers.push grapher.new.tap{|g| g.output_directory = output_directory }
+    def add(metric_name, graph_engine, output_directory = MetricFu::Io::FileSystem.directory('output_directory'))
+      grapher = MetricFu::Grapher.get_grapher(metric_name).
+        new.tap{|g| g.output_directory = output_directory }
+      self.graphers.push grapher
     rescue NameError => e
       mf_log "#{e.message} called in MetricFu::Graph.add with #{graph_type}"
     end
 
-
     def generate
       return if self.graphers.empty?
       mf_log "Generating graphs"
@@ -31,12 +31,10 @@ module MetricFu
 
     private
 
-    def grapher_from_type_and_engine(graph_type, graph_engine)
-      grapher_name = graph_type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } + graph_engine.to_s.capitalize + "Grapher"
-      MetricFu.const_get(grapher_name)
-    end
     def metric_files
-      Dir[File.join(MetricFu::Io::FileSystem.directory('data_directory'), '*.yml')].sort
+      MetricFu::Utility.glob(
+        File.join(MetricFu::Io::FileSystem.directory('data_directory'), '*.yml')
+      ).sort
     end
 
     def generate_graphs_for_files
@@ -48,17 +46,13 @@ module MetricFu
     def generate_graphs_for_file(metric_file)
       mf_log "Generating graphs for #{metric_file}"
       date_parts = year_month_day_from_filename(metric_file)
-      metrics = load_yaml_metric_file(metric_file)
+      metrics = MetricFu::Utility.load_yaml(metric_file)
 
       build_graph(metrics, "#{date_parts[:m]}/#{date_parts[:d]}")
     rescue NameError => e
       mf_log "#{e.message} called in MetricFu::Graph.generate with #{metric_file}"
     end
 
-    def load_yaml_metric_file(metric_file)
-      YAML.load(File.open(metric_file))
-    end
-
     def build_graph(metrics, sortable_prefix)
       self.graphers.each do |grapher|
         grapher.get_metrics(metrics, sortable_prefix)

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

@@ -8,10 +8,10 @@ module MetricFu
       @analyzers.values
     end
     def self.analyzer_for_metric(metric)
-      mf_debug "Getting analyzer for #{metric}"
-      @analyzers.fetch(metric.to_sym) {
-        raise MetricFu::AnalysisError, "Unknown metric #{metric}. We only know #{@analyzers.keys.inspect}"
-      }
+      @analyzers.fetch(metric.to_sym) do
+        message = "Unknown metric #{metric}. We only know #{@analyzers.keys.inspect}"
+        fail MetricFu::AnalysisError, message
+      end
     end
     def self.inherited(subclass)
       mf_debug "Adding #{subclass} to #{@analyzers.inspect}"
@@ -42,7 +42,9 @@ module MetricFu
         :average => MetricFu::HotspotScoringStrategies.average(scores),
         :sum     => MetricFu::HotspotScoringStrategies.sum(scores),
         :absent  => 0,
-      }.fetch(reduce_strategy) { raise "#{reduce_strategy} not a know reduce strategy" }
+      }.fetch(reduce_strategy) do
+        fail "#{reduce_strategy} not a known reduce strategy"
+      end
     end
 
     def reduce_strategy

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

@@ -34,12 +34,10 @@
             <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 %>
+            <% unless per_file_data[file].empty? %>
+              <small>&laquo;
+                <b><a href="<%= file.gsub(%r{/}, '_') %>.html<%= (line.nil? ? '' : "#line#{line}") %>">annotate</a></b>
+               &raquo;</small>
             <% end %>
             <br/><br/>
             <!-- TODO HOTSPOTS for metric fu nice metric_link method -->