metric_fu 4.11.3 → 4.11.4

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

@@ -7,41 +7,6 @@ module MetricFu
       @rcov_text = rcov_text
     end
 
-    class Line
-      attr_accessor :content, :was_run
-
-      def initialize(content, was_run)
-        @content = content
-        @was_run = was_run
-      end
-
-      def to_h
-        {:content => @content, :was_run => @was_run}
-      end
-
-      def covered?
-        @was_run.one?
-      end
-      def missed?
-        @was_run.zero?
-      end
-      def ignored?
-        @was_run.nil?
-      end
-      def self.line_coverage(lines)
-        lines.map{|line| line[:was_run] }
-      end
-      def self.covered_lines(line_coverage)
-        line_coverage.count(1)
-      end
-      def self.missed_lines(line_coverage)
-        line_coverage.count(0)
-      end
-      def self.ignored_lines(line_coverage)
-        line_coverage.count(nil)
-      end
-    end
-
     def to_h
       rcov_text = @rcov_text.split(NEW_FILE_MARKER)
 
@@ -49,7 +14,6 @@ module MetricFu
 
       files = assemble_files(rcov_text)
 
-
       TestCoverage.new(files).to_h
     end
 
@@ -57,21 +21,21 @@ module MetricFu
 
     def assemble_files(rcov_text)
       files = {}
-      rcov_text.each_slice(2) {|out| files[out.first.strip] = out.last}
-      files.each_pair {|fname, content| files[fname] = content.split("\n") }
+      rcov_text.each_slice(2) { |out| files[out.first.strip] = out.last }
+      files.each_pair { |fname, content| files[fname] = content.split("\n") }
       files.each_pair do |fname, content|
         content.map! do |raw_line|
-          covered_line = if raw_line.start_with?('--')
+          covered_line = if raw_line.start_with?("--")
                            nil # simplecov ignores some lines
-                         elsif raw_line.start_with?('!!')
+                         elsif raw_line.start_with?("!!")
                            0
                          else
                            1
                          end
-          Line.new(raw_line[3..-1], covered_line).to_h
+          RCovLine.new(raw_line[3..-1], covered_line).to_h
         end
-        content.reject! {|line| line[:content].to_s == '' }
-        files[fname] = {:lines => content}
+        content.reject! { |line| line[:content].to_s == "" }
+        files[fname] = { lines: content }
       end
       files
     end
@@ -101,9 +65,9 @@ module MetricFu
       end
 
       def self.percent_run(lines)
-        line_coverage = Line.line_coverage(lines)
-        covered_lines = Line.covered_lines(line_coverage)
-        ignored_lines = Line.ignored_lines(line_coverage)
+        line_coverage = RCovLine.line_coverage(lines)
+        covered_lines = RCovLine.covered_lines(line_coverage)
+        ignored_lines = RCovLine.ignored_lines(line_coverage)
         relevant_lines = lines.count - ignored_lines
         if block_given?
           yield covered_lines, relevant_lines
@@ -113,6 +77,7 @@ module MetricFu
       end
 
       private
+
       # TODO: remove multiple side effects
       #   sets global ivars and
       #   modifies the param passed in
@@ -131,9 +96,9 @@ module MetricFu
 
       def add_global_percent_run(test_coverage, total_lines, total_lines_run)
         percentage = self.class.floating_percent(total_lines_run, total_lines)
-        test_coverage.update({
-          :global_percent_run => round_to_tenths(percentage)
-        })
+        test_coverage.update(
+          global_percent_run: round_to_tenths(percentage)
+        )
       end
 
       def add_method_data(test_coverage)
@@ -141,7 +106,7 @@ module MetricFu
           file_contents = ""
           coverage = []
 
-          info[:lines].each_with_index do |line, index|
+          info[:lines].each_with_index do |line, _index|
             file_contents << "#{line[:content]}\n"
             coverage << line[:was_run]
           end
@@ -172,17 +137,13 @@ module MetricFu
           method_coverage_map.each do |method_name, coverage_data|
             test_coverage[file_path][:methods][method_name] = (coverage_data[:uncovered] / coverage_data[:total].to_f) * 100.0
           end
-
         end
       end
 
       def round_to_tenths(decimal)
-        decimal = 0.0 if decimal.to_s.eql?('NaN')
+        decimal = 0.0 if decimal.to_s.eql?("NaN")
         (decimal * 10).round / 10.0
       end
-
-
     end
-
   end
 end

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

@@ -0,0 +1,48 @@
+module MetricFu
+  class RCovLine
+    attr_accessor :content, :was_run
+
+    def initialize(content, was_run)
+      @content = content
+      @was_run = was_run
+    end
+
+    def to_h
+      { content: @content, was_run: @was_run }
+    end
+
+    def covered?
+      @was_run == 1
+    end
+
+    def missed?
+      @was_run == 0
+    end
+
+    def ignored?
+      @was_run.nil?
+    end
+
+    def self.line_coverage(lines)
+      lines.map { |line| line[:was_run] }
+    end
+
+    def self.covered_lines(line_coverage)
+      line_coverage.count(1)
+    end
+
+    def self.missed_lines(line_coverage)
+      line_coverage.count(0)
+    end
+
+    def self.ignored_lines(line_coverage)
+      line_coverage.count(nil)
+    end
+
+    def css_class
+      return "" if ignored?
+
+      missed? ? "rcov_not_run" : "rcov_run"
+    end
+  end
+end

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

@@ -29,8 +29,8 @@
     <table class="rcov_code">
     <% file[:lines].each_with_index do |line, index| %>
       <tr>
-        <% css_class = line[:was_run] ? "rcov_run" : "rcov_not_run" %>
-        <td class="<%= css_class %>"><%= link_to_filename(fname, index + 1, "<pre>#{line[:content]}</pre>") %></td>
+        <% rcov_line = RCovLine.new(line[:content], line[:was_run]) %>
+        <td class="<%= rcov_line.css_class %>"><%= link_to_filename(fname, index + 1, "<pre>#{line[:content]}</pre>") %></td>
       </tr>
     <% end %>
     </table>

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

@@ -7,12 +7,12 @@ if defined?(JRUBY_VERSION)
     #     https://github.com/colszowka/simplecov/issues/86
   end
 end
-require 'simplecov'
-require_relative 'external_client'
-require_relative 'rcov_format_coverage'
+require "simplecov"
+require "metric_fu/logger"
+require_relative "external_client"
+require_relative "rcov_format_coverage"
 
 class SimpleCov::Formatter::MetricFu
-
   def format(result)
     rcov_text = FormatLikeRCov.new(result).format
     client = MetricFu::RCovTestCoverageClient.new(coverage_file_path)
@@ -26,7 +26,7 @@ class SimpleCov::Formatter::MetricFu
   end
 
   def default_coverage_file_path
-    File.join(SimpleCov.root, 'coverage', 'rcov', output_file_name)
+    File.join(SimpleCov.root, "coverage", "rcov", output_file_name)
   end
 
   # TODO: Read in from legacy coverage/rcov/rcov.txt path, when set
@@ -40,7 +40,7 @@ class SimpleCov::Formatter::MetricFu
   #   going forward, the file name will be in a date-stamped
   #   format like for all other reported metrics.
   def output_file_name
-    'rcov.txt'
+    "rcov.txt"
   end
 
   # report should reference file used to build it
@@ -57,9 +57,9 @@ class SimpleCov::Formatter::MetricFu
         content << "=" * 80
         content << "\n"
         source_file.lines.each do |line|
-          content << '!!' if line.missed?
-          content << '--' if line.never? || line.skipped?
-          content << '  ' if line.covered?
+          content << "!!" if line.missed?
+          content << "--" if line.never? || line.skipped?
+          content << "  " if line.covered?
           content << " #{line.src.chomp}\n"
         end
         content << "\n"
@@ -68,8 +68,7 @@ class SimpleCov::Formatter::MetricFu
     end
 
     def simple_file_name(source_file)
-      source_file.filename.gsub(SimpleCov.root, '.')
+      source_file.filename.gsub(SimpleCov.root, ".")
     end
   end
-
 end

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

@@ -1,5 +1,4 @@
 module MetricFu
-
   class ReekGenerator < Generator
     REEK_REGEX = /^(\S+) (.*) \((.*)\)$/
 
@@ -20,7 +19,7 @@ module MetricFu
     end
 
     def run!(args)
-      require 'reek/cli/application'
+      require "reek/cli/application"
 
       MetricFu::Utility.capture_output do
         Reek::Cli::Application.new(args).execute
@@ -28,24 +27,24 @@ 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") }
       @matches = @matches.map do |match|
         break {} if zero_warnings?(match)
-        file_path = match.shift.split(' -- ').first
-        file_path = file_path.gsub('"', ' ').strip
+        file_path = match.shift.split(" -- ").first
+        file_path = file_path.gsub('"', " ").strip
         code_smells = match.map do |smell|
           match_object = smell.match(REEK_REGEX)
           next unless match_object
-          {:method => match_object[1].strip,
-           :message => match_object[2].strip,
-           :type => match_object[3].strip}
+          { method: match_object[1].strip,
+            message: match_object[2].strip,
+            type: match_object[3].strip }
         end.compact
-        {:file_path => file_path, :code_smells => code_smells}
+        { file_path: file_path, code_smells: code_smells }
       end
     end
 
     def to_h
-      {:reek => {:matches => @matches}}
+      { reek: { matches: @matches } }
     end
 
     def per_file_info(out)
@@ -53,7 +52,7 @@ module MetricFu
         file_path = file_data[:file_path]
         next if File.extname(file_path) =~ /\.erb|\.html|\.haml/
         begin
-          line_numbers = MetricFu::LineNumbers.new(File.read(file_path),file_path)
+          line_numbers = MetricFu::LineNumbers.new(File.read(file_path), file_path)
         rescue StandardError => e
           raise e unless e.message =~ /you shouldn't be able to get here/
           mf_log "ruby_parser blew up while trying to parse #{file_path}. You won't have method level reek information for this file."
@@ -62,8 +61,8 @@ module MetricFu
 
         file_data[:code_smells].each do |smell_data|
           line = line_numbers.start_line_for_method(smell_data[:method])
-          out[file_data[:file_path]][line.to_s] << {:type => :reek,
-                                                    :description => "#{smell_data[:type]} - #{smell_data[:message]}"}
+          out[file_data[:file_path]][line.to_s] << { type: :reek,
+                                                     description: "#{smell_data[:type]} - #{smell_data[:message]}" }
         end
       end
     end
@@ -74,7 +73,7 @@ module MetricFu
     end
 
     def massage_for_reek_12
-      section_break = ''
+      section_break = ""
       @output.split("\n").map do |line|
         case line
         when /^  /
@@ -84,7 +83,7 @@ module MetricFu
           if parts[1].nil?
             "#{line}\n"
           else
-            warnings = parts[1].gsub(/ \(.*\):/, ':')
+            warnings = parts[1].gsub(/ \(.*\):/, ":")
             result = "#{section_break}\"#{parts[0]}\" -- #{warnings}\n"
             section_break = "\n"
             result
@@ -97,7 +96,7 @@ module MetricFu
 
     def files_to_analyze
       dirs_to_reek = options[:dirs_to_reek]
-      files_to_reek = dirs_to_reek.map{|dir| Dir[File.join(dir, "**","*.rb")] }.flatten
+      files_to_reek = dirs_to_reek.map { |dir| Dir[File.join(dir, "**", "*.rb")] }.flatten
       remove_excluded_files(files_to_reek)
     end
 
@@ -114,30 +113,30 @@ module MetricFu
     def config_option
       config_file_pattern =  options[:config_file_pattern]
       if config_file_pattern.to_s.empty?
-        ['']
+        [""]
       else
-        ['--config', config_file_pattern]
+        ["--config", config_file_pattern]
       end
     end
 
     # Work around "Error: invalid option: --no-color" in reek < 1.3.7
     def turn_off_color
-      if reek_version >= '1.3.7'
-        '--no-color'
+      if reek_version >= "1.3.7"
+        "--no-color"
       else
-        ''
+        ""
       end
     end
 
     def reek_version
-      @reek_version ||=  `reek --version`.chomp.sub(/\s*reek\s*/,'')
+      @reek_version ||=  `reek --version`.chomp.sub(/\s*reek\s*/, "")
       # use the above, as the below may activate a version not available in
       # a Bundler context
       # MetricFu::GemVersion.activated_version('reek').to_s
     end
 
     def disable_line_number_option
-      '--no-line-numbers'
+      "--no-line-numbers"
     end
 
     def zero_warnings?(match)

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

@@ -1,4 +1,4 @@
-MetricFu.reporting_require { 'graphs/grapher' }
+MetricFu.reporting_require { "graphs/grapher" }
 module MetricFu
   class ReekGrapher < Grapher
     attr_accessor :reek_count, :labels
@@ -16,7 +16,7 @@ module MetricFu
     def get_metrics(metrics, date)
       if metrics && metrics[:reek]
         counter = @labels.size
-        @labels.update( { @labels.size => date })
+        @labels.update(@labels.size => date)
 
         metrics[:reek][:matches].each do |reek_chunk|
           reek_chunk[:code_smells].each do |code_smell|
@@ -33,17 +33,17 @@ module MetricFu
     end
 
     def title
-      'Reek: code smells'
+      "Reek: code smells"
     end
 
     def data
       @reek_count.map do |name, count|
-        [name, nil_counts_to_zero(count).join(',')]
+        [name, nil_counts_to_zero(count).join(",")]
       end
     end
 
     def output_filename
-      'reek.js'
+      "reek.js"
     end
 
     private
@@ -51,6 +51,5 @@ module MetricFu
     def nil_counts_to_zero(counts)
       counts.map { |count| count || 0 }
     end
-
   end
 end

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

@@ -1,13 +1,12 @@
 # coding: utf-8
 class MetricFu::ReekHotspot < MetricFu::Hotspot
-
   # Note that in practice, the prefix reek__ is appended to each one
   # This was a partially implemented idea to avoid column name collisions
   # but it is only done in the ReekHotspot
   COLUMNS = %w{type_name message value value_description comparable_message}
 
   def columns
-    COLUMNS.map{|column| "#{name}__#{column}"}
+    COLUMNS.map { |column| "#{name}__#{column}" }
   end
 
   def name
@@ -27,7 +26,7 @@ class MetricFu::ReekHotspot < MetricFu::Hotspot
   end
 
   def generate_records(data, table)
-    return if data==nil
+    return if data == nil
     data[:matches].each do |match|
       file_path = match[:file_path]
       match[:code_smells].each do |smell|
@@ -65,7 +64,7 @@ class MetricFu::ReekHotspot < MetricFu::Hotspot
   def comparable_message(type_name, message)
     if self.class.numeric_smell?(type_name)
       match = message.match(/\d+/)
-      if(match)
+      if match
         match.pre_match + match.post_match
       else
         message
@@ -77,7 +76,7 @@ class MetricFu::ReekHotspot < MetricFu::Hotspot
 
   def build_value_description(type_name, message)
     item_type = message.match(/\d+ (.*)$/)
-    if(item_type)
+    if item_type
       "number of #{item_type[1]} in #{type_name.downcase}"
     else
       nil
@@ -87,11 +86,10 @@ class MetricFu::ReekHotspot < MetricFu::Hotspot
   def parse_value(message)
     # mf_debug "parsing #{message}"
     match = message.match(/\d+/)
-    if(match)
+    if match
       match[0].to_i
     else
       nil
     end
   end
-
 end