metric_fu 4.11.1 → 4.13.0

data/lib/metric_fu/metric.rb

@@ -1,10 +1,9 @@
-require 'set'
-MetricFu.lib_require { 'gem_run' }
-MetricFu.lib_require { 'generator' }
+require "set"
+MetricFu.lib_require { "gem_run" }
+MetricFu.lib_require { "generator" }
 # Encapsulates the configuration options for each metric
 module MetricFu
   class Metric
-
     attr_accessor :enabled, :activated
 
     def initialize
@@ -20,7 +19,7 @@ module MetricFu
     # TODO: Confirm this catches load errors from requires in subclasses, such as for flog
     def activate
       MetricFu.metrics_require { default_metric_library_paths }
-      @libraries.each {|library| require(library) }
+      @libraries.each { |library| require(library) }
       self.activated = true
     rescue LoadError => e
       mf_log "#{name} metric not activated, #{e.message}"
@@ -41,7 +40,7 @@ module MetricFu
     end
 
     def default_run_args
-      run_options.map { |k, v| "--#{k} #{v}" }.join(' ')
+      run_options.map { |k, v| "--#{k} #{v}" }.join(" ")
     end
 
     def run
@@ -49,12 +48,12 @@ module MetricFu
     end
 
     def run_external(args = default_run_args)
-      runner = GemRun.new({
+      runner = GemRun.new(
         gem_name: gem_name.to_s,
         metric_name: name.to_s,
         # version: ,
         args: args,
-      })
+      )
       stdout, stderr, status = runner.run
       # TODO: do something with the stderr
       # for now, just acknowledge we got it
@@ -90,11 +89,11 @@ module MetricFu
     end
 
     def self.enabled_metrics
-      metrics.select{|metric| metric.enabled && metric.activated}.sort_by {|metric| metric.name  == :hotspots ? 1 : 0 }
+      metrics.select { |metric| metric.enabled && metric.activated }.sort_by { |metric| metric.name  == :hotspots ? 1 : 0 }
     end
 
     def self.get_metric(name)
-      metrics.find{|metric|metric.name.to_s == name.to_s}
+      metrics.find { |metric|metric.name.to_s == name.to_s }
     end
 
     def self.inherited(subclass)
@@ -119,7 +118,7 @@ module MetricFu
 
     # Used above to identify the stem of a setter method
     def method_to_attr(method)
-      method.to_s.sub(/=$/, '').to_sym
+      method.to_s.sub(/=$/, "").to_sym
     end
 
     private
@@ -136,7 +135,7 @@ module MetricFu
       paths = []
       paths << generator_path = "#{name}/generator"
       if has_graph?
-          paths << grapher_path   = "#{name}/grapher"
+        paths << grapher_path   = "#{name}/grapher"
       end
       paths
     end

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

@@ -1,4 +1,4 @@
-MetricFu.metrics_require { 'cane/violations' }
+MetricFu.metrics_require { "cane/violations" }
 module MetricFu
   class CaneGenerator < Generator
     attr_reader :violations, :total_violations
@@ -23,8 +23,9 @@ module MetricFu
     end
 
     def to_h
-      {:cane => {:total_violations => @total_violations, :violations => @violations}}
+      { cane: { total_violations: @total_violations, violations: @violations } }
     end
+
     private
 
     def abc_max_param
@@ -36,11 +37,11 @@ module MetricFu
     end
 
     def no_doc_param
-      options[:no_doc] == 'y' ? " --no-doc" : ""
+      options[:no_doc] == "y" ? " --no-doc" : ""
     end
 
     def no_readme_param
-      options[:no_readme] == 'y' ? " --no-readme" : ""
+      options[:no_readme] == "y" ? " --no-readme" : ""
     end
 
     def violations_by_category
@@ -54,12 +55,12 @@ module MetricFu
 
     def category_from(description)
       category_descriptions = {
-        :abc_complexity => /ABC complexity/,
-        :line_style => /style requirements/,
-        :comment => /comment/,
-        :documentation => /documentation/
+        abc_complexity: /ABC complexity/,
+        line_style: /style requirements/,
+        comment: /comment/,
+        documentation: /documentation/
       }
-      category, desc_matcher = category_descriptions.find {|k,v| description =~ v}
+      category, desc_matcher = category_descriptions.find { |_k, v| description =~ v }
       mf_debug desc_matcher.inspect
       category
     end

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

@@ -1,4 +1,4 @@
-MetricFu.reporting_require { 'graphs/grapher' }
+MetricFu.reporting_require { "graphs/grapher" }
 module MetricFu
   class CaneGrapher < Grapher
     attr_accessor :cane_violations, :labels
@@ -16,24 +16,22 @@ module MetricFu
     def get_metrics(metrics, date)
       if metrics && metrics[:cane]
         @cane_violations.push(metrics[:cane][:total_violations].to_i)
-        @labels.update( { @labels.size => date })
+        @labels.update(@labels.size => date)
       end
     end
 
     def title
-      'Cane: code quality threshold violations'
+      "Cane: code quality threshold violations"
     end
 
     def data
       [
-        ['cane', @cane_violations.join(',')]
+        ["cane", @cane_violations.join(",")]
       ]
     end
 
     def output_filename
-      'cane.js'
+      "cane.js"
     end
-
   end
 end
-

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

@@ -1,18 +1,17 @@
 module MetricFu
   class MetricCane < Metric
-
     def name
       :cane
     end
 
     def default_run_options
       {
-        :dirs_to_cane => MetricFu::Io::FileSystem.directory('code_dirs'),
-        :abc_max => 15,
-        :line_length => 80,
-        :no_doc => 'n',
-        :no_readme => 'n',
-        :filetypes => ['rb']
+        dirs_to_cane: MetricFu::Io::FileSystem.directory("code_dirs"),
+        abc_max: 15,
+        line_length: 80,
+        no_doc: "n",
+        no_readme: "n",
+        filetypes: ["rb"]
       }
     end
 
@@ -31,6 +30,5 @@ module MetricFu
     def activate
       super
     end
-
   end
 end

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

@@ -15,7 +15,7 @@
   <% count = 0 %>
   <% @cane[:violations][:abc_complexity].each do |violation| %>
     <tr class='<%= cycle("light", "dark", count) %>'>
-      <td><%=violation[:file]%></td>
+      <td><%=link_to_filename(violation[:file])%></td>
       <td><%=violation[:method]%></td>
       <td><%=violation[:complexity]%></td>
     </tr>
@@ -33,7 +33,7 @@
   <% count = 0 %>
   <% @cane[:violations][:line_style].each do |violation| %>
     <tr class='<%= cycle("light", "dark", count) %>'>
-      <td><%=violation[:line]%></td>
+      <td><%=link_to_filename(*violation[:line].split(':'))%></td>
       <td><%=violation[:description]%></td>
     </tr>
     <% count += 1 %>
@@ -63,7 +63,7 @@
   <% count = 0 %>
   <% @cane[:violations][:comment].each do |violation| %>
     <tr class='<%= cycle("light", "dark", count) %>'>
-      <td><%=violation[:line]%></td>
+      <td><%=link_to_filename(*violation[:line].split(':'))%></td>
       <td><%=violation[:class_name]%></td>
     </tr>
     <% count += 1 %>

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

@@ -4,7 +4,7 @@ module MetricFu
       def self.parse(violation_list)
         violation_list.split(/\n/).map do |violation|
           file, method, complexity = violation.split
-          {:file => file, :method => method, :complexity => complexity}
+          { file: file, method: method, complexity: complexity }
         end
       end
     end
@@ -12,8 +12,8 @@ module MetricFu
     class LineStyle
       def self.parse(violation_list)
         violation_list.split(/\n/).map do |violation|
-          line, description = violation.split(/\s{2,}/).reject{|x|x.strip==''}
-          {:line => line, :description => description}
+          line, description = violation.split(/\s{2,}/).reject { |x|x.strip == "" }
+          { line: line, description: description }
         end
       end
     end
@@ -22,7 +22,7 @@ module MetricFu
       def self.parse(violation_list)
         violation_list.split(/\n/).map do |violation|
           line, class_name = violation.split
-          {:line => line, :class_name => class_name}
+          { line: line, class_name: class_name }
         end
       end
     end
@@ -30,7 +30,7 @@ module MetricFu
     class Documentation
       def self.parse(violation_list)
         violation_list.split(/\n/).map do |violation|
-          {:description => violation.strip}
+          { description: violation.strip }
         end
       end
     end
@@ -38,7 +38,7 @@ module MetricFu
     class Others
       def self.parse(violation_list)
         violation_list.split(/\n/).map do |violation|
-          {:description => violation.strip}
+          { description: violation.strip }
         end
       end
     end

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

@@ -1,7 +1,5 @@
 module MetricFu
-
   class ChurnGenerator < Generator
-
     def self.metric
       :churn
     end
@@ -16,7 +14,7 @@ module MetricFu
 
     def analyze
       if @output.nil? || @output.size.zero?
-        @churn = {:churn => {}}
+        @churn = { churn: {} }
       else
         @churn = @output
       end
@@ -25,7 +23,7 @@ module MetricFu
 
     # ensure hash only has the :churn key
     def to_h
-      {:churn => @churn[:churn]}
+      { churn: @churn[:churn] }
     end
 
     # @param args [Hash] churn metric run options
@@ -35,7 +33,5 @@ module MetricFu
       #    instead of the default String
       ::Churn::ChurnCalculator.new(args).report(false)
     end
-
   end
-
 end

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

@@ -1,5 +1,4 @@
 class MetricFu::ChurnHotspot < MetricFu::Hotspot
-
   COLUMNS = %w{times_changed}
 
   def columns
@@ -28,7 +27,7 @@ class MetricFu::ChurnHotspot < MetricFu::Hotspot
   end
 
   def generate_records(data, table)
-   return if data==nil
+    return if data == nil
     Array(data[:changes]).each do |change|
       table << {
         "metric" => :churn,
@@ -41,5 +40,4 @@ class MetricFu::ChurnHotspot < MetricFu::Hotspot
   def present_group(group)
     "detected high level of churn (changed #{group[0].times_changed} times)"
   end
-
 end

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

@@ -1,16 +1,15 @@
 module MetricFu
   class MetricChurn < Metric
-
     def name
       :churn
     end
 
     def default_run_options
       {
-        :start_date => %q("1 year ago"),
-        :minimum_churn_count => 10,
-        :ignore_files => [],
-        :data_directory => MetricFu::Io::FileSystem.scratch_directory(name)
+        start_date: '"1 year ago"',
+        minimum_churn_count: 10,
+        ignore_files: [],
+        data_directory: MetricFu::Io::FileSystem.scratch_directory(name)
       }
     end
 
@@ -23,9 +22,8 @@ module MetricFu
     end
 
     def activate
-      activate_library('churn/calculator')
+      activate_library("churn/calculator")
       super
     end
-
   end
 end

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

@@ -1,7 +1,5 @@
 module MetricFu
-
   class FlayGenerator < Generator
-
     def self.metric
       :flay
     end
@@ -12,28 +10,28 @@ module MetricFu
     end
 
     def analyze
-      @matches = @output.chomp.split("\n\n").map{|m| m.split("\n  ") }
+      @matches = @output.chomp.split("\n\n").map { |m| m.split("\n  ") }
     end
 
     def to_h
-      {:flay => calculate_result(@matches)}
+      { flay: calculate_result(@matches) }
     end
 
     # TODO: move into analyze method
     def calculate_result(matches)
-      total_score = matches.shift.first.split('=').last.strip
+      total_score = matches.shift.first.split("=").last.strip
       target = []
       matches.each do |problem|
         reason = problem.shift.strip
         lines_info = problem.map do |full_line|
           name, line = full_line.split(":").map(&:strip)
-          {:name => name, :line => line}
+          { name: name, line: line }
         end
-        target << [:reason => reason, :matches => lines_info]
+        target << [reason: reason, matches: lines_info]
       end
       {
-        :total_score => total_score,
-        :matches => target.flatten
+        total_score: total_score,
+        matches: target.flatten
       }
     end
 
@@ -43,13 +41,11 @@ module MetricFu
       flay_mass = options[:minimum_score]
       return "" unless flay_mass
 
-
       "--mass #{flay_mass} "
     end
 
     def dirs_to_flay
       options[:dirs_to_flay].join(" ")
     end
-
   end
 end

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

@@ -1,4 +1,4 @@
-MetricFu.reporting_require { 'graphs/grapher' }
+MetricFu.reporting_require { "graphs/grapher" }
 module MetricFu
   class FlayGrapher < Grapher
     attr_accessor :flay_score, :labels
@@ -16,23 +16,22 @@ module MetricFu
     def get_metrics(metrics, date)
       if metrics && metrics[:flay]
         @flay_score.push(metrics[:flay][:total_score].to_i)
-        @labels.update( { @labels.size => date })
+        @labels.update(@labels.size => date)
       end
     end
 
     def title
-      'Flay: duplication'
+      "Flay: duplication"
     end
 
     def data
       [
-        ['flay', @flay_score.join(',')]
+        ["flay", @flay_score.join(",")]
       ]
     end
 
     def output_filename
-      'flay.js'
+      "flay.js"
     end
-
   end
 end

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

@@ -1,5 +1,4 @@
 class MetricFu::FlayHotspot < MetricFu::Hotspot
-
   COLUMNS = %w{flay_reason flay_matching_reason}
 
   def columns
@@ -23,23 +22,23 @@ class MetricFu::FlayHotspot < MetricFu::Hotspot
   end
 
   def generate_records(data, table)
-    return if data==nil
+    return if data == nil
     Array(data[:matches]).each do |match|
       problems  = match[:reason]
-      matching_reason = problems.gsub(/^[0-9]+\) /,'').gsub(/\:[0-9]+/,'')
+      matching_reason = problems.gsub(/^[0-9]+\) /, "").gsub(/\:[0-9]+/, "")
       files     = []
       locations = []
       match[:matches].each do |file_match|
-        file_path = file_match[:name].sub(%r{^/},'')
+        file_path = file_match[:name].sub(%r{^/}, "")
         locations << "#{file_path}:#{file_match[:line]}"
         files     << file_path
       end
       files = files.uniq
       files.each do |file|
         table << {
-          "metric" => self.name,
+          "metric" => name,
           "file_path" => file,
-          "flay_reason" => problems+" files: #{locations.join(', ')}",
+          "flay_reason" => problems + " files: #{locations.join(', ')}",
           "flay_matching_reason" => matching_reason
         }
       end
@@ -50,5 +49,4 @@ class MetricFu::FlayHotspot < MetricFu::Hotspot
     occurences = group.size
     "found #{occurences} code duplications"
   end
-
 end