metric_fu 4.8.0 → 4.9.0

data/Rakefile

@@ -1,7 +1,6 @@
 #!/usr/bin/env rake
 require 'bundler/setup'
 
-
 Dir['./gem_tasks/*.rake'].each do |task|
   import(task)
 end

data/checksum/metric_fu-4.8.0.gem.sha512

@@ -0,0 +1 @@
+d46528ba18e30ce561e3d0dfb4245ee2e4b7ff72a895cff24cb4bb4a86ace4ed3f759eba96b26aa9e512ebd253d78d9697423bf468c09a09fb764597977f26c2

data/gem_tasks/usage_test.rake

@@ -0,0 +1,30 @@
+require 'redcarpet'
+require 'English'
+require 'tmpdir'
+ROOT_PATH    = File.expand_path("..", File.dirname(__FILE__))
+require File.join(ROOT_PATH, 'spec', 'support', 'usage_test')
+LIB_PATH     = File.join(ROOT_PATH, 'lib')
+BIN_PATH     = File.join(ROOT_PATH, 'bin')
+EXAMPLE_FILES = [
+  File.join(ROOT_PATH, 'README.md'),
+  File.join(ROOT_PATH, 'DEV.md')
+]
+task "load_path" do
+  $LOAD_PATH.unshift(LIB_PATH)
+  $VERBOSE = nil
+  ENV['PATH'] = "#{BIN_PATH}:#{ENV['PATH']}"
+  ENV['CC_BUILD_ARTIFACTS'] = 'turn_off_browser_opening'
+end
+desc "Test that documentation usage works"
+task "usage_test" => %w[load_path] do
+  usage_test = UsageTest.new
+  usage_test.test_files(EXAMPLE_FILES)
+end
+
+class HTMLRenderAndVerifyCodeBlocks < Redcarpet::Render::HTML
+
+  def block_code(code, language)
+    SnippetRunner.new(code, language).test!
+  end
+
+end

data/lib/metric_fu/configuration.rb

@@ -78,6 +78,7 @@ module MetricFu
       @templates_configuration = MetricFu::Templates::Configuration.new
       MetricFu::Formatter::Templates.templates_configuration = @templates_configuration
       @formatters = []
+      @graph_engine = :bluff
     end
 
     # This allows us to have a nice syntax like:
@@ -128,8 +129,12 @@ module MetricFu
       MetricFu::Metric.enabled_metrics.select{|metric|metric.has_graph?}.map(&:name)
     end
 
+    def configure_graph_engine(graph_engine)
+      @graph_engine = graph_engine
+    end
+
     def graph_engine
-      :bluff
+      @graph_engine
     end
 
     # This allows us to configure the templates with:

data/lib/metric_fu/data_structures/line_numbers.rb

@@ -37,7 +37,7 @@ module MetricFu
     end
 
     # @param method [String] the method name being queried
-    # @erturn [Integer, nil] the line number at which the given method is defined
+    # @return [Integer, nil] the line number at which the given method is defined
     def start_line_for_method(method)
       return nil unless @locations.has_key?(method)
       @locations[method].first

data/lib/metric_fu/environment.rb

@@ -123,14 +123,9 @@ module MetricFu
     end
 
     def ruby_strangely_makes_accessors_private?
-       ruby192? || jruby?
+       @private_accessors ||= ruby192? || jruby?
     end
+    module_function :ruby_strangely_makes_accessors_private?
 
-    # HACK: for using this module via inclusion in Configuration
-    def self.included(host_class)
-      def host_class.ruby_strangely_makes_accessors_private?
-        @private_accessors ||= allocate.ruby_strangely_makes_accessors_private?
-      end
-    end
   end
 end

data/lib/metric_fu/logging/mf_debugger.rb

@@ -23,8 +23,8 @@ module MfDebugger
     end
     # From episode 029 of Ruby Tapas by Avdi
     # https://rubytapas.dpdcart.com/subscriber/post?id=88
-    def self.capture_output(&block)
-      old_stdout = STDOUT.clone
+    def self.capture_output(stream=STDOUT, &block)
+      old_stdout = stream.clone
       pipe_r, pipe_w = IO.pipe
       pipe_r.sync    = true
       output         = ""
@@ -36,10 +36,10 @@ module MfDebugger
         rescue EOFError
         end
       end
-      STDOUT.reopen(pipe_w)
+      stream.reopen(pipe_w)
       yield
     ensure
-      STDOUT.reopen(old_stdout)
+      stream.reopen(old_stdout)
       pipe_w.close
       reader.join
       pipe_r.close

data/lib/metric_fu/metric.rb

@@ -62,12 +62,12 @@ module MetricFu
       @configured_run_options
     end
 
-    # @return default metric run options [Hash]
+    # @return [Hash] default metric run options
     def default_run_options
       not_implemented
     end
 
-    # @return metric_options [Hash]
+    # @return [Hash] metric_options
     def has_graph?
       not_implemented
     end

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

@@ -1,100 +1,89 @@
-<html>
-<head>
-	<title>Cane Results</title>
-	<style>
-	<%= inline_css("css/default.css") %>
-	</style>
-</head>
+<h3>Cane Results</h3>
 
-<body>
-	<h1>Cane Results</h1>
-  <a href="index.html">back to menu</a>
-	<h2>Total Violations: <%= @cane[:total_violations] %></h2>
-  <p><a href='https://github.com/square/cane'>Cane</a> reports code quality threshold violations.</p>
+<p><a href='https://github.com/square/cane'>Cane</a> reports code quality threshold violations.</p>
 
-  <% graph_name = 'cane' %>
-  <canvas id="graph"></canvas>
-  <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
+<div id="graph_container"></div>
 
-  <% if @cane[:violations][:abc_complexity] && @cane[:violations][:abc_complexity].size > 0 %>
-	<h3>Methods exceeding allowed Abc complexity (<%= @cane[:violations][:abc_complexity].size %>)</h3>
-	<table>
-    <tr>
-		  <th>File</th>
-		  <th>Method</th>
-		  <th>Complexity</th>
+<% graph_name = 'cane' %>
+<script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
+
+<% if @cane[:violations][:abc_complexity] && @cane[:violations][:abc_complexity].size > 0 %>
+<h3>Methods exceeding allowed Abc complexity (<%= @cane[:violations][:abc_complexity].size %>)</h3>
+<table>
+  <tr>
+    <th>File</th>
+    <th>Method</th>
+    <th>Complexity</th>
+  </tr>
+  <% count = 0 %>
+  <% @cane[:violations][:abc_complexity].each do |violation| %>
+    <tr class='<%= cycle("light", "dark", count) %>'>
+      <td><%=violation[:file]%></td>
+      <td><%=violation[:method]%></td>
+      <td><%=violation[:complexity]%></td>
     </tr>
-    <% count = 0 %>
-    <% @cane[:violations][:abc_complexity].each do |violation| %>
-      <tr class='<%= cycle("light", "dark", count) %>'>
-        <td><%=violation[:file]%></td>
-        <td><%=violation[:method]%></td>
-        <td><%=violation[:complexity]%></td>
-      </tr>
-      <% count += 1 %>
-		<% end %>
-	</table>
+    <% count += 1 %>
   <% end %>
-  <% if @cane[:violations][:line_style] && @cane[:violations][:line_style].size > 0 %>
-	<h3>Lines violating style requirements (<%= @cane[:violations][:line_style].size %>)</h3>
-	<table>
-    <tr>
-		  <th>File</th>
-		  <th>Description</th>
+</table>
+<% end %>
+<% if @cane[:violations][:line_style] && @cane[:violations][:line_style].size > 0 %>
+<h3>Lines violating style requirements (<%= @cane[:violations][:line_style].size %>)</h3>
+<table>
+  <tr>
+    <th>File</th>
+    <th>Description</th>
+  </tr>
+  <% count = 0 %>
+  <% @cane[:violations][:line_style].each do |violation| %>
+    <tr class='<%= cycle("light", "dark", count) %>'>
+      <td><%=violation[:line]%></td>
+      <td><%=violation[:description]%></td>
     </tr>
-    <% count = 0 %>
-    <% @cane[:violations][:line_style].each do |violation| %>
-      <tr class='<%= cycle("light", "dark", count) %>'>
-        <td><%=violation[:line]%></td>
-        <td><%=violation[:description]%></td>
-      </tr>
-      <% count += 1 %>
-		<% end %>
-	</table>
+    <% count += 1 %>
   <% end %>
-  <% if @cane[:violations][:documentation] && @cane[:violations][:documentation].size > 0 %>
-  <h3>Missing documentation (<%= @cane[:violations][:documentation].size %>)</h3>
-  <table>
+</table>
+<% end %>
+<% if @cane[:violations][:documentation] && @cane[:violations][:documentation].size > 0 %>
+<h3>Missing documentation (<%= @cane[:violations][:documentation].size %>)</h3>
+<table>
+  <tr>
+    <th>Description</th>
+  </tr>
+  <% @cane[:violations][:documentation].each do |violation| %>
     <tr>
-      <th>Description</th>
+      <td><%=violation[:description]%></td>
     </tr>
-    <% @cane[:violations][:documentation].each do |violation| %>
-      <tr>
-        <td><%=violation[:description]%></td>
-      </tr>
-    <% end %>
-  </table>
   <% end %>
-  <% if @cane[:violations][:comment] && @cane[:violations][:comment].size > 0 %>
-	<h3>Class definitions requiring comments (<%= @cane[:violations][:comment].size %>)</h3>
-	<table>
-    <tr>
-		  <th>File</th>
-		  <th>Class</th>
+</table>
+<% end %>
+<% if @cane[:violations][:comment] && @cane[:violations][:comment].size > 0 %>
+<h3>Class definitions requiring comments (<%= @cane[:violations][:comment].size %>)</h3>
+<table>
+  <tr>
+    <th>File</th>
+    <th>Class</th>
+  </tr>
+  <% count = 0 %>
+  <% @cane[:violations][:comment].each do |violation| %>
+    <tr class='<%= cycle("light", "dark", count) %>'>
+      <td><%=violation[:line]%></td>
+      <td><%=violation[:class_name]%></td>
     </tr>
-    <% count = 0 %>
-    <% @cane[:violations][:comment].each do |violation| %>
-      <tr class='<%= cycle("light", "dark", count) %>'>
-        <td><%=violation[:line]%></td>
-        <td><%=violation[:class_name]%></td>
-      </tr>
-      <% count += 1 %>
-		<% end %>
-	</table>
+    <% count += 1 %>
   <% end %>
-  <% if @cane[:violations][:others] && @cane[:violations][:others].size > 0 %>
-  <h3>Others (<%= @cane[:violations][:others].size %>)</h3>
-  <table>
+</table>
+<% end %>
+<% if @cane[:violations][:others] && @cane[:violations][:others].size > 0 %>
+<h3>Others (<%= @cane[:violations][:others].size %>)</h3>
+<table>
+  <tr>
+    <th>Description</th>
+  </tr>
+  <% @cane[:violations][:others].each do |violation| %>
     <tr>
-      <th>Description</th>
+      <td><%=violation[:description]%></td>
     </tr>
-    <% @cane[:violations][:others].each do |violation| %>
-      <tr>
-        <td><%=violation[:description]%></td>
-      </tr>
-    <% end %>
-  </table>
   <% end %>
-	<p>Generated on <%= Time.now.localtime %></p>
-</body>
-</html>
+</table>
+<% end %>
+<p>Generated on <%= Time.now.localtime %></p>

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

@@ -27,10 +27,9 @@ module MetricFu
     def to_h
       {:churn => @churn[:churn]}
     end
-    
+
     # @param args [Hash] churn metric run options
     # @return [Hash] churn results
-    # @example {something}
     def run(args)
       # @note passing in false to report will return a hash
       #    instead of the default String

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

@@ -2,8 +2,9 @@
 
 <p><a href='http://ruby.sadi.st/Flay.html'>Flay</a> analyzes ruby code for structural similarities.</p>
 
+<div id="graph_container"></div>
+
 <% graph_name = 'flay' %>
-<canvas id="graph"></canvas>
 <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
 
 <h4>Total Score (lower is better): <%= @flay[:total_score] %></h4>

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

@@ -1,8 +1,9 @@
 <h3>Flog Results</h3>
 <p><a href='http://ruby.sadi.st/Flog.html'>Flog</a> measures code complexity.</p>
 
+<div id="graph_container"></div>
+
 <% graph_name = 'flog' %>
-<canvas id="graph"></canvas>
 <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
 
 <h2>Total Flog score for all methods: <%= round_to_tenths @flog[:total]%></h2>

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

@@ -2,8 +2,9 @@
 
 <p><a href="http://github.com/railsbp/rails_best_practices">rails_best_practices</a> is a code metric tool for rails projects.</p>
 
+<div id="graph_container"></div>
+
 <% graph_name = 'rails_best_practices' %>
-<canvas id="graph"></canvas>
 <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
 
 <table>

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

@@ -0,0 +1,24 @@
+# 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
+    end
+
+    def post_results(payload)
+      mf_log "Saving coverage payload to #{@file_path}"
+      dump(payload)
+    end
+
+    def load
+      File.binread(@file_path)
+    end
+
+    def dump(payload)
+      File.open(@file_path, 'wb') {|file| file.write(payload) }
+    end
+
+  end
+end

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

@@ -1,29 +1,17 @@
 MetricFu.lib_require { 'utility' }
 MetricFu.lib_require { 'calculate' }
 MetricFu.data_structures_require { 'line_numbers' }
+require_relative 'rcov_format_coverage'
+require_relative 'external_client'
 
 module MetricFu
 
   class RcovGenerator < MetricFu::Generator
-    NEW_FILE_MARKER = /^={80}$/.freeze
 
     def self.metric
       :rcov
     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
-    end
-
     def emit
       if run_rcov?
         mf_debug "** Running the specs/tests in the [#{options[:environment]}] environment"
@@ -54,105 +42,26 @@ module MetricFu
     end
 
     def analyze
-      output = load_output
-      output = output.split(NEW_FILE_MARKER)
-
-      output.shift # Throw away the first entry - it's the execution time etc.
-
-      files = assemble_files(output)
-
-      @global_total_lines = 0
-      @global_total_lines_run = 0
-
-      @rcov = add_coverage_percentage(files)
+      rcov_text = load_output
+      formatter = MetricFu::RCovFormatCoverage.new(rcov_text)
+      @rcov = formatter.to_h
     end
 
     def to_h
-      global_percent_run = ((@global_total_lines_run.to_f / @global_total_lines.to_f) * 100)
-      add_method_data
-      {:rcov => @rcov.merge({:global_percent_run => round_to_tenths(global_percent_run) })}
+      {
+        :rcov => @rcov
+      }
     end
 
     private
 
-    def add_method_data
-      @rcov.each_pair do |file_path, info|
-        file_contents = ""
-        coverage = []
-
-        info[:lines].each_with_index do |line, index|
-          file_contents << "#{line[:content]}\n"
-          coverage << line[:was_run]
-        end
-
-        begin
-          line_numbers = MetricFu::LineNumbers.new(file_contents)
-        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 Rcov information for this file."
-          next
-        end
-
-        method_coverage_map = {}
-        coverage.each_with_index do |covered, index|
-          line_number = index + 1
-          if line_numbers.in_method?(line_number)
-            method_name = line_numbers.method_at_line(line_number)
-            method_coverage_map[method_name] ||= {}
-            method_coverage_map[method_name][:total] ||= 0
-            method_coverage_map[method_name][:total] += 1
-            method_coverage_map[method_name][:uncovered] ||= 0
-            method_coverage_map[method_name][:uncovered] += 1 if !covered
-          end
-        end
-
-        @rcov[file_path][:methods] = {}
-
-        method_coverage_map.each do |method_name, coverage_data|
-          @rcov[file_path][:methods][method_name] = (coverage_data[:uncovered] / coverage_data[:total].to_f) * 100.0
-        end
-
-      end
-    end
-
-    def assemble_files(output)
-      files = {}
-      output.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 = raw_line.match(/^!!/).nil?
-          Line.new(raw_line[3..-1], covered_line).to_h
-        end
-        content.reject! {|line| line[:content].to_s == '' }
-        files[fname] = {:lines => content}
-      end
-      files
-    end
-
-    # TODO: remove multiple side effects
-    #   sets global ivars and
-    #   modifies the param passed in
-    def add_coverage_percentage(files)
-      files.each_pair do |fname, content|
-        lines = content[:lines]
-        lines_run = lines.count {|line| line[:was_run] }
-        total_lines = lines.length
-        integer_percent = Calculate.integer_percent(lines_run, total_lines)
-
-        files[fname][:percent_run] = integer_percent
-        @global_total_lines_run += lines_run
-        @global_total_lines += total_lines
-      end
-    end
-
     # We never run rcov anymore
     def run_rcov?
       false
     end
 
     def load_output
-      File.read(output_file)
+      MetricFu::RCovTestCoverageClient.new(output_file).load
     end
 
     def output_file