metric_fu 4.11.3 → 4.11.4

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

@@ -1,13 +1,11 @@
 module MetricFu
-
   class StatsGenerator < Generator
-
     def self.metric
       :stats
     end
 
     def emit
-      require 'code_metrics/statistics'
+      require "code_metrics/statistics"
       @output = MetricFu::Utility.capture_output do
         CodeMetrics::Statistics.new(*dirs).to_s
       end
@@ -25,21 +23,21 @@ module MetricFu
     end
 
     def to_h
-      {:stats => @stats}
+      { stats: @stats }
     end
 
     private
 
     def remove_noise(output)
       lines = output.split("\n")
-      lines = lines.find_all {|line| line =~ /^\s*[C|]/ }
+      lines = lines.find_all { |line| line =~ /^\s*[C|]/ }
       lines.shift
       lines
     end
 
     def set_global_stats(totals)
       return if totals.nil?
-      parsed_totals = totals.split("  ").find_all {|el| ! el.empty? }
+      parsed_totals = totals.split("  ").find_all { |el| !el.empty? }
       @stats[:codeLOC] = parsed_totals.shift.match(/\d.*/)[0].to_i
       @stats[:testLOC] = parsed_totals.shift.match(/\d.*/)[0].to_i
       matched_numbers  = Array(parsed_totals.shift.match(/1\:(\d.*)/))
@@ -54,11 +52,11 @@ module MetricFu
     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? }
+        elements.map!(&:strip)
+        elements = elements.find_all { |el| !el.empty? }
         info_line = {}
         info_line[:name] = elements.shift
-        elements.map! {|el| el.to_i }
+        elements.map!(&:to_i)
         [:lines, :loc, :classes, :methods,
          :methods_per_class, :loc_per_method].each do |sym|
           info_line[sym] = elements.shift
@@ -69,8 +67,8 @@ module MetricFu
 
     # @return [Array<[ 'Acceptance specs', 'spec/acceptance' ]>]
     def dirs
-      require 'code_metrics/stats_directories'
-      require 'code_metrics/statistics'
+      require "code_metrics/stats_directories"
+      require "code_metrics/statistics"
       stats_dirs = CodeMetrics::StatsDirectories.new
       options.fetch(:additional_test_directories).each do |option|
         stats_dirs.add_test_directories(option.fetch(:glob_pattern), option.fetch(:file_pattern))
@@ -80,6 +78,5 @@ module MetricFu
       end
       stats_dirs.directories
     end
-
   end
 end

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

@@ -1,4 +1,4 @@
-MetricFu.reporting_require { 'graphs/grapher' }
+MetricFu.reporting_require { "graphs/grapher" }
 module MetricFu
   class StatsGrapher < Grapher
     attr_accessor :loc_counts, :lot_counts, :labels
@@ -16,26 +16,25 @@ module MetricFu
 
     def get_metrics(metrics, date)
       if metrics && metrics[:stats]
-        self.loc_counts.push(metrics[:stats][:codeLOC].to_i)
-        self.lot_counts.push(metrics[:stats][:testLOC].to_i)
-        self.labels.update( { self.labels.size => date })
+        loc_counts.push(metrics[:stats][:codeLOC].to_i)
+        lot_counts.push(metrics[:stats][:testLOC].to_i)
+        labels.update(labels.size => date)
       end
     end
 
     def title
-      'Stats: LOC & LOT'
+      "Stats: LOC & LOT"
     end
 
     def data
       [
-        ['LOC', @loc_counts.join(',')],
-        ['LOT', @lot_counts.join(',')],
+        ["LOC", @loc_counts.join(",")],
+        ["LOT", @lot_counts.join(",")],
       ]
     end
 
     def output_filename
-      'stats.js'
+      "stats.js"
     end
-
   end
 end

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

@@ -1,5 +1,4 @@
 class MetricFu::StatsHotspot < MetricFu::Hotspot
-
   COLUMNS = %w{stat_name stat_value}
 
   def columns
@@ -25,7 +24,7 @@ class MetricFu::StatsHotspot < MetricFu::Hotspot
   def generate_records(data, table)
     return if data == nil
     data.each do |key, value|
-      next if value.kind_of?(Array)
+      next if value.is_a?(Array)
       table << {
         "metric" => name,
         "stat_name" => key,
@@ -33,5 +32,4 @@ class MetricFu::StatsHotspot < MetricFu::Hotspot
       }
     end
   end
-
 end

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

@@ -1,6 +1,5 @@
 module MetricFu
   class MetricStats < Metric
-
     def name
       :stats
     end
@@ -8,8 +7,8 @@ module MetricFu
     def default_run_options
       {
         # returns a list of directories that contains the glob of files that have the file_pattern in the file names
-        :additional_test_directories => [{glob_pattern: File.join('.','spec','**','*_spec.rb'), file_pattern: 'spec'}],
-        :additional_app_directories  => [{glob_pattern: File.join('.','engines','**','*.rb'), file_pattern: ''}],
+        additional_test_directories: [{ glob_pattern: File.join(".", "spec", "**", "*_spec.rb"), file_pattern: "spec" }],
+        additional_app_directories: [{ glob_pattern: File.join(".", "engines", "**", "*.rb"), file_pattern: "" }],
       }
     end
 
@@ -22,9 +21,8 @@ module MetricFu
     end
 
     def activate
-      activate_library 'code_metrics'
+      activate_library "code_metrics"
       super
     end
-
   end
 end

data/lib/metric_fu/reporter.rb

@@ -1,6 +1,6 @@
 module MetricFu
   class Reporter
-    def initialize(formatters=nil)
+    def initialize(formatters = nil)
       @formatters = Array(formatters)
     end
 

data/lib/metric_fu/reporting/graphs/graph.rb

@@ -1,27 +1,25 @@
 module MetricFu
-
   def self.graph
     @graph ||= Graph.new
   end
 
   class Graph
-
     attr_accessor :graphers
 
     def initialize
       self.graphers = []
     end
 
-    def add(metric_name, graph_engine, output_directory = MetricFu::Io::FileSystem.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
+                new.tap { |g| g.output_directory = output_directory }
+      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?
+      return if graphers.empty?
       mf_log "Generating graphs"
       generate_graphs_for_files
       graph!
@@ -33,7 +31,7 @@ module MetricFu
 
     def metric_files
       MetricFu::Utility.glob(
-        File.join(MetricFu::Io::FileSystem.directory('data_directory'), '*.yml')
+        File.join(MetricFu::Io::FileSystem.directory("data_directory"), "*.yml")
       ).sort
     end
 
@@ -54,20 +52,18 @@ module MetricFu
     end
 
     def build_graph(metrics, sortable_prefix)
-      self.graphers.each do |grapher|
+      graphers.each do |grapher|
         grapher.get_metrics(metrics, sortable_prefix)
       end
     end
 
     def graph!
-      self.graphers.each do |grapher|
-        grapher.graph!
-      end
+      graphers.each(&:graph!)
     end
 
     def year_month_day_from_filename(path_to_file_with_date)
       date = path_to_file_with_date.match(/\/(\d+).yml$/)[1]
-      {:y => date[0..3].to_i, :m => date[4..5].to_i, :d => date[6..7].to_i}
+      { y: date[0..3].to_i, m: date[4..5].to_i, d: date[6..7].to_i }
     end
   end
 end

data/lib/metric_fu/reporting/graphs/grapher.rb

@@ -1,7 +1,6 @@
-require 'multi_json'
+require "multi_json"
 module MetricFu
   class Grapher
-
     @graphers = []
     # @return all subclassed graphers [Array<MetricFu::Grapher>]
     def self.graphers
@@ -13,7 +12,7 @@ module MetricFu
     end
 
     def self.get_grapher(metric)
-      graphers.find{|grapher|grapher.metric.to_s == metric.to_s}
+      graphers.find { |grapher|grapher.metric.to_s == metric.to_s }
     end
 
     attr_accessor :output_directory
@@ -23,10 +22,10 @@ module MetricFu
     end
 
     def output_directory
-      @output_directory || MetricFu::Io::FileSystem.directory('output_directory')
+      @output_directory || MetricFu::Io::FileSystem.directory("output_directory")
     end
 
-    def get_metrics(metrics, sortable_prefix)
+    def get_metrics(_metrics, _sortable_prefix)
       not_implemented
     end
 
@@ -37,7 +36,7 @@ module MetricFu
         #{build_data(data)}
         var graph_labels = #{labels};
       EOS
-      File.open(File.join(self.output_directory, output_filename), 'w') {|f| f << content }
+      File.open(File.join(output_directory, output_filename), "w") { |f| f << content }
     end
 
     def title
@@ -55,14 +54,13 @@ module MetricFu
     private
 
     def build_data(data)
-      'var graph_series = [' << Array(data).map do |label, datum|
+      "var graph_series = [" << Array(data).map do |label, datum|
         "{name: '#{label}', data: [#{datum}]}"
-      end.join(",") << '];'
+      end.join(",") << "];"
     end
 
     def not_implemented
       raise "#{__LINE__} in #{__FILE__} from #{caller[0]}"
     end
-
   end
 end

data/lib/metric_fu/reporting/result.rb

@@ -1,5 +1,4 @@
 module MetricFu
-
   # MetricFu.result memoizes access to a Result object, that will be
   # used throughout the lifecycle of the MetricFu app.
   def self.result
@@ -12,7 +11,6 @@ module MetricFu
   #
   # It tracks the results generated by each metric used in this test run.
   class Result
-
     # Renders the result of the result_hash into a yaml serialization
     # ready for writing out to a file.
     #
@@ -57,6 +55,5 @@ module MetricFu
     def metric_options_for_result_type(result_type)
       MetricFu::Metric.get_metric(result_type).run_options
     end
-
   end
 end

data/lib/metric_fu/run.rb

@@ -3,15 +3,17 @@ module MetricFu
     def initialize
       STDOUT.sync = true
     end
-    def run(options={})
+
+    def run(options = {})
       configure_run(options)
       measure
       display_results if options[:open]
     end
 
-    def report_metrics(metrics=MetricFu::Metric.enabled_metrics)
+    def report_metrics(metrics = MetricFu::Metric.enabled_metrics)
       metrics.map(&:name)
     end
+
     def measure
       reporter.start
       report_metrics.each {|metric|
@@ -21,19 +23,23 @@ module MetricFu
       }
       reporter.finish
     end
+
     def display_results
       reporter.display_results
     end
+
     private
+
     def configure_run(options)
       disable_metrics(options)
       configure_formatters(options)
     end
+
     def disable_metrics(options)
       return if options.size == 0
       report_metrics.each do |metric|
         metric = metric.to_sym
-        if (metric_options = options[metric] )
+        if (metric_options = options[metric])
           mf_debug "using metric #{metric}"
           configure_metric(metric, metric_options) if metric_options.is_a?(Hash)
         else
@@ -43,6 +49,7 @@ module MetricFu
         end
       end
     end
+
     def configure_metric(metric, metric_options)
       MetricFu::Configuration.configure_metric(metric) do |metric|
         metric_options.each do |option, value|
@@ -51,6 +58,7 @@ module MetricFu
         end
       end
     end
+
     def configure_formatters(options)
       # Configure from command line if any.
       if options[:format]
@@ -66,6 +74,7 @@ module MetricFu
         end
       end
     end
+
     def reporter
       MetricFu::Reporter.new(MetricFu.configuration.formatters)
     end

data/lib/metric_fu/tasks/metric_fu.rake

@@ -1,26 +1,26 @@
-require 'rake'
-require 'metric_fu/run'
+require "rake"
+require "metric_fu/run"
 namespace :metrics do
   def options_tip(task_name)
     "with options, for example:  rake metrics:#{task_name}['cane: {abc_max: 81}']"
   end
   desc "Generate all metrics reports, or #{options_tip('all')}"
-  task :all, [:options] do |t,args|
+  task :all, [:options] do |_t, args|
     MetricFu.run(process_options(args.options))
   end
 
   desc "Run only specified ;-separated metrics, for example, metrics:only[cane;flog] or #{options_tip('only')}"
-  task :only, [:metrics, :options] do |t,args|
-    requested_metrics = args.metrics.to_s.split(';').map(&:strip)
+  task :only, [:metrics, :options] do |_t, args|
+    requested_metrics = args.metrics.to_s.split(";").map(&:strip)
     enabled_metrics = MetricFu::Metric.enabled_metrics.map(&:name)
-    metrics_to_run = enabled_metrics.select{|metric| requested_metrics.include?(metric.to_s) }
+    metrics_to_run = enabled_metrics.select { |metric| requested_metrics.include?(metric.to_s) }
     MetricFu.run_only(metrics_to_run, process_options(args.options))
   end
 
   MetricFu::Metric.enabled_metrics.each do |metric|
     name = metric.name
     desc "Generate report for #{name}, or #{options_tip('cane')}"
-    task name, [:options] do |t,args|
+    task name, [:options] do |_t, args|
       MetricFu.run_only(name, process_options(args.options))
     end
   end
@@ -34,7 +34,7 @@ namespace :metrics do
     def recursively_symbolize_keys!
       keys.each do |key|
         value = delete(key)
-        new_key = key.intern #rescue
+        new_key = key.intern # rescue
         self[new_key] = (value.is_a?(Hash) ? value.dup.recursively_symbolize_keys! : value)
       end
       self

data/lib/metric_fu/templates/configuration.rb

@@ -1,8 +1,7 @@
-MetricFu.lib_require { 'templates/metrics_template' }
+MetricFu.lib_require { "templates/metrics_template" }
 module MetricFu::Templates
   class Configuration
-
-    FILE_PREFIX = 'file:/'
+    FILE_PREFIX = "file:/"
 
     def initialize
       @options = {}
@@ -22,7 +21,5 @@ module MetricFu::Templates
     def option(name)
       @options.fetch(name.to_sym) { raise "No such template option: #{name}" }
     end
-
   end
-
 end

data/lib/metric_fu/templates/metrics_template.rb

@@ -1,6 +1,6 @@
-require 'fileutils'
-MetricFu.lib_require { 'templates/template' }
-MetricFu.lib_require { 'templates/report' }
+require "fileutils"
+MetricFu.lib_require { "templates/template" }
+MetricFu.lib_require { "templates/report" }
 
 # The MetricsTemplate class is the included template used by the HTML formatter.
 # The only requirement for a template class is that it provides a #write method
@@ -23,38 +23,43 @@ module MetricFu
       write_file_data
     end
 
+    def html_filename(file)
+      file = Digest::SHA1.hexdigest(file)[0..29]
+      "#{file.gsub(%r{/}, '_')}.html"
+    end
+
     private
 
     def copy_javascripts
-      Dir[File.join(template_directory, 'javascripts', '*')].each do |f|
-        FileUtils.cp(f, File.join(self.output_directory, File.basename(f)))
+      Dir[File.join(template_directory, "javascripts", "*")].each do |f|
+        FileUtils.cp(f, File.join(output_directory, File.basename(f)))
       end
     end
 
     def write_section(section, contents)
       if template_exists?(section)
         create_instance_var(section, contents)
-        self.metrics[section] = contents
+        metrics[section] = contents
         create_instance_var(:per_file_data, per_file_data)
-        mf_debug  "Generating html for section #{section} with #{template(section)} for result #{result.class}"
+        mf_debug "Generating html for section #{section} with #{template(section)} for result #{result.class}"
         self.html = erbify(section)
-        layout = erbify('layout')
+        layout = erbify("layout")
         fn = output_filename(section)
         formatter.write_template(layout, fn)
       else
-        mf_debug  "no template for section #{section} with #{template(section)} for result #{result.class}"
+        mf_debug "no template for section #{section} with #{template(section)} for result #{result.class}"
       end
     end
 
     def write_index
       # Instance variables we need should already be created from above
-      if template_exists?('index')
-        self.html = erbify('index')
-        layout = erbify('layout')
-        fn = output_filename('index')
+      if template_exists?("index")
+        self.html = erbify("index")
+        layout = erbify("layout")
+        fn = output_filename("index")
         formatter.write_template(layout, fn)
       else
-        mf_debug  "no template for section index for result #{result.class}"
+        mf_debug "no template for section index for result #{result.class}"
       end
     end
 
@@ -68,13 +73,8 @@ module MetricFu
       end
     end
 
-    def html_filename(file)
-      "#{file.gsub(%r{/}, '_')}.html"
-    end
-
     def template_directory
       File.dirname(__FILE__)
     end
-
   end
 end