metric_fu 4.11.1 → 4.13.0

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

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 module MetricFu
   class Ranking
     extend Forwardable
@@ -13,8 +13,8 @@ module MetricFu
 
     def percentile(item)
       index = sorted_items.index(item)
-      worse_item_count = (length - (index+1))
-      worse_item_count.to_f/length
+      worse_item_count = (length - (index + 1))
+      worse_item_count.to_f / length
     end
 
     def_delegator :@items_to_score, :has_key?, :scored?
@@ -23,8 +23,7 @@ module MetricFu
     private
 
     def sorted_items
-      @sorted_items ||= @items_to_score.sort_by {|item, score| -score}.map {|item, score| item}
+      @sorted_items ||= @items_to_score.sort_by { |_item, score| -score }.map { |item, _score| item }
     end
-
   end
 end

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

@@ -1,11 +1,10 @@
 MetricFu.metrics_require do
   [
-    'hotspots/analysis/ranking'
+    "hotspots/analysis/ranking"
   ]
 end
 module MetricFu
   class HotspotRankings
-
     def initialize(tool_tables)
       @tool_tables = tool_tables
       @file_ranking = MetricFu::Ranking.new
@@ -88,6 +87,5 @@ module MetricFu
         master_ranking[item] += analyzer.score(metric_ranking, item) # scaling? Do we just add in the raw score?
       end
     end
-
   end
 end

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

@@ -1,15 +1,14 @@
 module MetricFu
   class Record
-
     attr_reader :data
 
-    def initialize(data, columns)
+    def initialize(data, _columns)
       @data = data
     end
 
     def method_missing(name, *args, &block)
       key = name.to_s
-      if key == 'fetch'
+      if key == "fetch"
         @data.send(name, *args, &block)
       elsif @data.has_key?(key)
         @data[key]
@@ -19,7 +18,7 @@ module MetricFu
     end
 
     def []=(key, value)
-       @data[key]=value
+      @data[key] = value
     end
 
     def [](key)
@@ -29,6 +28,5 @@ module MetricFu
     def has_key?(key)
       @data.has_key?(key)
     end
-
   end
 end

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

@@ -1,6 +1,5 @@
 module MetricFu
   module HotspotScoringStrategies
-
     module_function
 
     # per project score percentile
@@ -21,6 +20,5 @@ module MetricFu
     def average(scores)
       sum(scores).to_f / scores.size.to_f
     end
-
   end
 end

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

@@ -10,7 +10,7 @@ module MetricFu
       @rows = []
       @columns = opts.fetch(:column_names)
 
-      @make_index = opts.fetch(:make_index) {true}
+      @make_index = opts.fetch(:make_index) { true }
       @metric_index = {}
     end
 
@@ -58,11 +58,10 @@ module MetricFu
     private
 
     def updated_key_index(record)
-      if record.has_key?('metric')
-        @metric_index[record.metric] ||= MetricFu::Table.new(:column_names => @columns, :make_index => false)
+      if record.has_key?("metric")
+        @metric_index[record.metric] ||= MetricFu::Table.new(column_names: @columns, make_index: false)
         @metric_index[record.metric] << record
       end
     end
-
   end
 end

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

@@ -1,13 +1,11 @@
-MetricFu.metrics_require   { 'hotspots/hotspot_analyzer' }
+MetricFu.metrics_require   { "hotspots/hotspot_analyzer" }
 module MetricFu
-
   class HotspotsGenerator < Generator
-
     def self.metric
       :hotspots
     end
 
-    def initialize(options={})
+    def initialize(options = {})
       MetricFu::Metric.enabled_metrics.each do |metric|
         require_hotspot(metric.name)
       end
@@ -24,7 +22,7 @@ module MetricFu
     end
 
     def to_h
-      result = {:hotspots => {}}
+      result = { hotspots: {} }
       @hotspots.each do |granularity, hotspots|
         result[:hotspots][granularity.to_s] = hotspots.map(&:to_hash)
       end
@@ -39,5 +37,4 @@ module MetricFu
       mf_debug "*** No hotspot for #{metric_name}"
     end
   end
-
 end

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

@@ -1,10 +1,10 @@
-MetricFu.lib_require { 'errors/analysis_error' }
-MetricFu.metrics_require { 'hotspots/analysis/scoring_strategies' }
+MetricFu.lib_require { "errors/analysis_error" }
+MetricFu.metrics_require { "hotspots/analysis/scoring_strategies" }
 
 module MetricFu
   class Hotspot
     def self.metric
-      self.name.split('::')[-1].split('Hotspot')[0].downcase.to_sym
+      name.split("::")[-1].split("Hotspot")[0].downcase.to_sym
     end
     @analyzers = {}
     def self.analyzers
@@ -31,8 +31,8 @@ module MetricFu
 
     def mapping_strategies
       {
-        :present => 1,
-        :absent  => 0,
+        present: 1,
+        absent: 0,
       }
     end
 
@@ -42,9 +42,9 @@ module MetricFu
 
     def reduce(scores)
       {
-        :average => MetricFu::HotspotScoringStrategies.average(scores),
-        :sum     => MetricFu::HotspotScoringStrategies.sum(scores),
-        :absent  => 0,
+        average: MetricFu::HotspotScoringStrategies.average(scores),
+        sum: MetricFu::HotspotScoringStrategies.sum(scores),
+        absent: 0,
       }.fetch(reduce_strategy) do
         fail "#{reduce_strategy} not a known reduce strategy"
       end
@@ -57,9 +57,9 @@ module MetricFu
     # @return [Integer]
     def score(metric_ranking, item)
       {
-        :identity   => MetricFu::HotspotScoringStrategies.identity(metric_ranking, item),
-        :percentile => MetricFu::HotspotScoringStrategies.percentile(metric_ranking, item),
-        :absent     => 0,
+        identity: MetricFu::HotspotScoringStrategies.identity(metric_ranking, item),
+        percentile: MetricFu::HotspotScoringStrategies.percentile(metric_ranking, item),
+        absent: 0,
       }.fetch(score_strategy) { method(score_strategy).call(metric_ranking, item) }
     end
 
@@ -71,12 +71,12 @@ module MetricFu
     #   'metric',  etc.
     #   and appends the hash to the table param
     #   Has no return value
-    def generate_records(data, table)
+    def generate_records(_data, _table)
       not_implemented
     end
 
     # @return [String] description result
-    def present_group(group)
+    def present_group(_group)
       not_implemented
     end
 

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

@@ -1,16 +1,15 @@
-require 'yaml'
+require "yaml"
 MetricFu.metrics_require do
   [
-    'hotspots/hotspot',
-    'hotspots/analysis/analyzer_tables',
-    'hotspots/analysis/analyzed_problems',
-    'hotspots/analysis/rankings'
+    "hotspots/hotspot",
+    "hotspots/analysis/analyzer_tables",
+    "hotspots/analysis/analyzed_problems",
+    "hotspots/analysis/rankings"
   ]
 end
 
 module MetricFu
   class HotspotAnalyzer
-
     COMMON_COLUMNS = %w{metric}
     GRANULARITIES =  %w{file_path class_name method_name}
 
@@ -58,7 +57,5 @@ module MetricFu
       # TODO does it not need to return something here?
       analyzed_problems
     end
-
-
   end
 end

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

@@ -1,13 +1,12 @@
 module MetricFu
   class MetricHotspots < Metric
-
     def name
       :hotspots
     end
 
     # TODO remove explicit Churn dependency
     def default_run_options
-      { :start_date => "1 year ago", :minimum_churn_count => 10}
+      { start_date: "1 year ago", minimum_churn_count: 10 }
     end
 
     def has_graph?
@@ -17,6 +16,5 @@ module MetricFu
     def enable
       super
     end
-
   end
 end

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

@@ -36,7 +36,7 @@
             </b>
             <% unless per_file_data[file].empty? %>
               <small>&laquo;
-                <b><a href="<%= file.gsub(%r{/}, '_') %>.html<%= (line.nil? ? '' : "#line#{line}") %>">annotate</a></b>
+                <b><a href="<%= html_filename(file) %><%= (line.nil? ? '' : "#line#{line}") %>">annotate</a></b>
                &raquo;</small>
             <% end %>
             <br/><br/>

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

@@ -1,14 +1,17 @@
 module MetricFu
   class RailsBestPracticesGenerator < Generator
-
     def self.metric
       :rails_best_practices
     end
 
+    def initialize(options = {})
+      super(MetricFu::Utility.stringify_keys(options))
+    end
+
     def emit
       mf_debug "** Rails Best Practices"
-      path = '.'
-      analyzer = ::RailsBestPractices::Analyzer.new(path, { 'silent' => true })
+      path = "."
+      analyzer = ::RailsBestPractices::Analyzer.new(path, options)
       analyzer.analyze
       @output = analyzer.errors
     end
@@ -16,28 +19,27 @@ module MetricFu
     def analyze
       @problems = @output.collect do |problem|
         {
-          :file    => problem.filename,
-          :line    => problem.line_number,
-          :problem => problem.message,
-          :url     => problem.url
+          file: problem.filename,
+          line: problem.line_number,
+          problem: problem.message,
+          url: problem.url
         }
       end
       total = ["Found #{@problems.count} errors."]
-      @rails_best_practices_results = {:total => total, :problems => @problems}
+      @rails_best_practices_results = { total: total, problems: @problems }
     end
 
     def to_h
-      {:rails_best_practices => @rails_best_practices_results}
+      { rails_best_practices: @rails_best_practices_results }
     end
 
     def per_file_info(out)
       @rails_best_practices_results[:problems].each do |problem|
-        next if problem[:file] == '' || problem[:problem].nil?
-
+        next if problem[:file] == "" || problem[:problem].nil?
 
         lines = problem[:line].split(/\s*,\s*/)
         lines.each do |line|
-          out[problem[:file]][line] << {:type => :rails_best_practices, :description => problem[:problem]}
+          out[problem[:file]][line] << { type: :rails_best_practices, description: problem[:problem] }
         end
       end
     end

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

@@ -1,4 +1,4 @@
-MetricFu.reporting_require { 'graphs/grapher' }
+MetricFu.reporting_require { "graphs/grapher" }
 module MetricFu
   class RailsBestPracticesGrapher < Grapher
     attr_accessor :rails_best_practices_count, :labels
@@ -17,23 +17,22 @@ module MetricFu
       if metrics && metrics[:rails_best_practices]
         size = (metrics[:rails_best_practices][:problems] || []).size
         @rails_best_practices_count.push(size)
-        @labels.update( { @labels.size => date })
+        @labels.update(@labels.size => date)
       end
     end
 
     def title
-      'Rails Best Practices: design problems'
+      "Rails Best Practices: design problems"
     end
 
     def data
       [
-        ['rails_best_practices', @rails_best_practices_count.join(',')]
+        ["rails_best_practices", @rails_best_practices_count.join(",")]
       ]
     end
 
     def output_filename
-      'rails_best_practices.js'
+      "rails_best_practices.js"
     end
-
   end
 end

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

@@ -1,12 +1,14 @@
 module MetricFu
   class MetricRailsBestPractices < Metric
-
     def name
       :rails_best_practices
     end
 
     def default_run_options
-      {}
+      {
+        silent: true,
+        exclude: []
+      }
     end
 
     def has_graph?
@@ -22,9 +24,8 @@ module MetricFu
     end
 
     def activate
-      activate_library('rails_best_practices')
+      activate_library("rails_best_practices")
       super
     end
-
   end
 end

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

@@ -1,7 +1,6 @@
 # Reads and writes external coverage files as BINARY
 module MetricFu
   class RCovTestCoverageClient
-
     def initialize(coverage_file)
       @file_path = Pathname(coverage_file)
       @file_path.dirname.mkpath
@@ -17,8 +16,7 @@ module MetricFu
     end
 
     def dump(payload)
-      File.open(@file_path, 'wb') {|file| file.write(payload) }
+      File.open(@file_path, "wb") { |file| file.write(payload) }
     end
-
   end
 end

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

@@ -1,13 +1,12 @@
-MetricFu.lib_require { 'utility' }
-MetricFu.lib_require { 'calculate' }
-MetricFu.data_structures_require { 'line_numbers' }
-require_relative 'rcov_format_coverage'
-require_relative 'external_client'
+MetricFu.lib_require { "utility" }
+MetricFu.lib_require { "calculate" }
+MetricFu.data_structures_require { "line_numbers" }
+require_relative "rcov_format_coverage"
+require_relative "rcov_line"
+require_relative "external_client"
 
 module MetricFu
-
   class RcovGenerator < MetricFu::Generator
-
     def self.metric
       :rcov
     end
@@ -29,16 +28,16 @@ module MetricFu
     end
 
     def reset_output_location
-      MetricFu::Utility.rm_rf(metric_directory, :verbose => false)
+      MetricFu::Utility.rm_rf(metric_directory, verbose: false)
       MetricFu::Utility.mkdir_p(metric_directory)
     end
 
     def default_command
-      require 'rake'
+      require "rake"
       reset_output_location
-      test_files = FileList[*options[:test_files]].join(' ')
-      rcov_opts = options[:rcov_opts].join(' ')
-      %Q(RAILS_ENV=#{options[:environment]} rcov #{test_files} #{rcov_opts} >> #{default_output_file})
+      test_files = FileList[*options[:test_files]].join(" ")
+      rcov_opts = options[:rcov_opts].join(" ")
+      %(RAILS_ENV=#{options[:environment]} rcov #{test_files} #{rcov_opts} >> #{default_output_file})
     end
 
     def analyze
@@ -49,7 +48,7 @@ module MetricFu
 
     def to_h
       {
-        :rcov => @rcov
+        rcov: @rcov
       }
     end
 
@@ -70,8 +69,7 @@ module MetricFu
 
     # Only used if run_rcov? is true
     def default_output_file
-      output_file || File.join(metric_directory, 'rcov.txt')
+      output_file || File.join(metric_directory, "rcov.txt")
     end
-
   end
 end