metric_fu 4.10.0 → 4.11.0

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

@@ -1,5 +1,13 @@
+if defined?(JRUBY_VERSION)
+  if ENV["JRUBY_OPTS"].to_s !~ /-Xcli.debug=true/
+    warn "Coverage may be inaccurate; Try setting JRUBY_OPTS=\"-Xcli.debug=true --debug\""
+    # see https://github.com/metricfu/metric_fu/pull/226
+    #     https://github.com/jruby/jruby/issues/1196
+    #     https://jira.codehaus.org/browse/JRUBY-6106
+    #     https://github.com/colszowka/simplecov/issues/86
+  end
+end
 require 'simplecov'
-require 'metric_fu'
 require_relative 'external_client'
 require_relative 'rcov_format_coverage'
 
@@ -35,6 +43,7 @@ class SimpleCov::Formatter::MetricFu
     'rcov.txt'
   end
 
+  # report should reference file used to build it
   class FormatLikeRCov
     def initialize(result)
       @result = result
@@ -48,7 +57,9 @@ class SimpleCov::Formatter::MetricFu
         content << "=" * 80
         content << "\n"
         source_file.lines.each do |line|
-          content << (line.missed? ? '!!'  : '  ')
+          content << '!!' if line.missed?
+          content << '--' if line.never? || line.skipped?
+          content << '  ' if line.covered?
           content << " #{line.src.chomp}\n"
         end
         content << "\n"

data/lib/metric_fu/metrics/reek/{reek_hotspot.rb → hotspot.rb}

@@ -1,5 +1,5 @@
 # coding: utf-8
-class ReekHotspot < MetricFu::Hotspot
+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

data/lib/metric_fu/metrics/stats/{stats.rb → generator.rb}

@@ -8,7 +8,7 @@ module MetricFu
 
     def emit
       require 'code_metrics/statistics'
-      @output = MfDebugger::Logger.capture_output do
+      @output = MetricFu::Utility.capture_output do
         CodeMetrics::Statistics.new(*dirs).to_s
       end
     end

data/lib/metric_fu/templates/configuration.rb

@@ -1,3 +1,4 @@
+MetricFu.lib_require { 'templates/metrics_template' }
 module MetricFu::Templates
   class Configuration
 
@@ -5,7 +6,7 @@ module MetricFu::Templates
 
     def initialize
       @options = {}
-      @options[:template_class] = AwesomeTemplate
+      @options[:template_class] = MetricFu::Templates::MetricsTemplate
       @options[:darwin_txmt_protocol_no_thanks] = true
       # turning off syntax_highlighting may avoid some UTF-8 issues
       @options[:syntax_highlighting] = true
@@ -24,4 +25,4 @@ module MetricFu::Templates
 
   end
 
-end
+end

data/lib/metric_fu/{reporting/templates/awesome → templates}/index.html.erb

@@ -1,4 +1,4 @@
-<h3>Metric Fu Results</h3>
+<h3><%= MetricFu.metric_name %> Results</h3>
 <ul id='projects'>
 <% metric_links.each do |link| %>
   <li class='even failure'>

data/lib/metric_fu/{reporting/templates/awesome → templates}/layout.html.erb

@@ -24,7 +24,7 @@
       <h1><a href="/">metrics</a> | <a href="index.html"><%= @name %></a></h1>
       <address class='watermark'>
         built with
-        <a href='https://github.com/metricfu/metric_fu'>metric-fu</a>
+        <a href='<%= MetricFu.metric_url %>'><%= MetricFu.metric_name %></a>
       </address>
     </div>
     <div id='content'>

data/lib/metric_fu/templates/metrics_template.rb

@@ -0,0 +1,68 @@
+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
+# to actually write out the template.
+module MetricFu
+  class Templates::MetricsTemplate < MetricFu::Template
+    attr_accessor :result, :per_file_data, :formatter, :metrics, :name, :html
+
+    def write
+      self.name = MetricFu.report_name
+
+      # Copy javascripts to output directory
+      Dir[File.join(template_directory, 'javascripts', '*')].each do |f|
+        FileUtils.cp(f, File.join(self.output_directory, File.basename(f)))
+      end
+
+      self.metrics = {}
+      result.each_pair do |section, contents|
+        if template_exists?(section)
+          create_instance_var(section, contents)
+          self.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}"
+          self.html = erbify(section)
+          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}"
+        end
+      end
+
+      # 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')
+        formatter.write_template(layout, fn)
+      else
+        mf_debug  "no template for section index for result #{result.class}"
+      end
+
+      write_file_data
+    end
+
+    def write_file_data
+      per_file_data.each_pair do |file, lines|
+        next if file.to_s.empty?
+        next unless File.file?(file)
+        report = MetricFu::Templates::Report.new(file, lines).render
+
+        formatter.write_template(report, html_filename(file))
+      end
+    end
+
+    def html_filename(file)
+      "#{file.gsub(%r{/}, '_')}.html"
+    end
+
+    def template_directory
+      File.dirname(__FILE__)
+    end
+
+  end
+end

data/lib/metric_fu/templates/report.rb

@@ -1,17 +1,25 @@
 MetricFu.lib_require { 'formatter/syntax' }
+MetricFu.lib_require { 'templates/template' }
 
+
+# Creates an HTML document for a given analyzed file,
+# with scored metrics annotating the relevant line.
 module MetricFu
   module Templates
     class Report < MetricFu::Template
 
+      # @param file [String] the analyzed file to annotate
+      # @param lines [Hash] of line number [String] keyed to an list [[Array] of metrics for that line. Each metric in the list is a hash containing the keys :type => metric_name, :descrption => metric_score
+      # @example file and lines
+      #   file: "lib/metric_fu/gem_version.rb
+      #   lines: {"30"=>[{:type=>:flog, :description=>"Score of 22.43"}], "42"=>[{:type=>:flog, :description=>"Score of 8.64"}]}
       def initialize(file, lines)
         @file = file
         @lines = lines
-        @data = File.readlines(file)
+        @data = File.open(file, 'rb') {|f| f.readlines }
       end
 
-      def render(metrics)
-        @metrics = metrics
+      def render
         erbify('report')
       end
 

data/lib/metric_fu/{metrics/base_template.rb → templates/template.rb}

@@ -1,22 +1,17 @@
 require 'erb'
 module MetricFu
 
-  # The Template class is intended as an abstract class for concrete
-  # template classes to subclass.  It provides a variety of utility
-  # methods to make templating a bit easier.  However, classes do not
-  # have to inherit from here in order to provide a template.  The only
-  # requirement for a template class is that it provides a #write method
-  # to actually write out the template.  See AwesomeTemplate for an
-  # example.
   class Template
-    attr_accessor :result, :per_file_data, :formatter, :output_directory
-
+    attr_accessor :output_directory
 
     def output_directory
       @output_directory || MetricFu::Io::FileSystem.directory('output_directory')
     end
 
     # Renders a partial and add optional instance variables to the template
+    # @param name <String> name of partial, omitting leading underscore (_)
+    # @param instance_variables <Hash> of instance variable
+    # names and values to set
     def render_partial(name, instance_variables = {})
       create_instance_vars(instance_variables)
       erbify("_#{name}")
@@ -80,20 +75,14 @@ module MetricFu
       # TODO: each MetricFu::Metric should know about its templates
       #  This class knows too much about the filesystem structure
       if MetricFu::Metric.enabled_metrics.map(&:name).include?(section) # expects a symbol
-        File.join(template_dir(section.to_s), "#{section}.html.erb")
+        metric_template_path(section.to_s)
       else
         File.join(template_directory,  section.to_s + ".html.erb")
       end
     end
 
-    def template_dir(metric)
-      File.join(MetricFu.metrics_dir, metric, metric_template_dir)
-    end
-
-    # e.g. template_awesome, template_standard
-    def metric_template_dir
-      template_name = self.class.name.sub('Template', '')[/^([A-Z][a-z]+)+/].downcase
-      "template_#{template_name}"
+    def metric_template_path(metric)
+      File.join(MetricFu.metrics_dir, metric, 'report.html.erb')
     end
 
     # Determines whether a template file exists for a given section
@@ -252,13 +241,8 @@ module MetricFu
       string.split('_').collect{|word| word[0] = word[0..0].upcase; word}.join(" ")
     end
 
-    # belive me, I tried to meta program this with an inherited hook
-    # I couldn't get it working
     def template_directory
-      raise "you need to define this method in each subclass with File.dirname(__FILE__)"
-      # def template_directory
-      #   File.dirname(__FILE__)
-      # end
+      fail "subclasses must specify template_directory. Usually File.dirname(__FILE__)"
     end
   end
 end

data/lib/metric_fu/utility.rb

@@ -43,5 +43,30 @@ module MetricFu
       File.binread(file)
     end
 
+    # From episode 029 of Ruby Tapas by Avdi
+    # https://rubytapas.dpdcart.com/subscriber/post?id=88
+    def capture_output(stream=STDOUT, &block)
+      old_stdout = stream.clone
+      pipe_r, pipe_w = IO.pipe
+      pipe_r.sync    = true
+      output         = ""
+      reader = Thread.new do
+        begin
+          loop do
+            output << pipe_r.readpartial(1024)
+          end
+        rescue EOFError
+        end
+      end
+      stream.reopen(pipe_w)
+      yield
+    ensure
+      stream.reopen(old_stdout)
+      pipe_w.close
+      reader.join
+      pipe_r.close
+      return output
+    end
+
   end
 end

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = '4.10.0'
+  VERSION = '4.11.0'
 end

data/metric_fu.gemspec

@@ -59,6 +59,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'coderay'
   # to_json support
   s.add_runtime_dependency 'multi_json'
+  # open browser support
+  s.add_runtime_dependency 'launchy', '~> 2.0'
 
   # temporary filesystem to act on
   s.add_development_dependency   'test_construct'

data/spec/capture_warnings.rb

@@ -0,0 +1,48 @@
+# https://raw.githubusercontent.com/metric_fu/metric_fu/master/spec/capture_warnings.rb
+require 'rubygems' if RUBY_VERSION =~ /^1\.8/
+require 'bundler/setup'
+require 'rspec/core'
+require 'rspec/expectations'
+require 'tempfile'
+
+stderr_file = Tempfile.new("metric_fu.stderr")
+current_dir = Dir.pwd
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    $stderr.reopen(stderr_file.path)
+    $VERBOSE = true
+  end
+
+  config.after(:suite) do
+    stderr_file.rewind
+    lines = stderr_file.read.split("\n").uniq
+    stderr_file.close!
+
+    $stderr.reopen(STDERR)
+
+    metric_fu_warnings, other_warnings = lines.partition { |line| line.include?(current_dir) }
+
+    if metric_fu_warnings.any?
+      puts
+      puts "-" * 30 + " metric_fu warnings: " + "-" * 30
+      puts
+      puts metric_fu_warnings.join("\n")
+      puts
+      puts "-" * 75
+      puts
+    end
+
+    if other_warnings.any?
+      File.open('tmp/warnings.txt', 'w') { |f| f.write(other_warnings.join("\n")) }
+      puts
+      puts "Non-metric_fu warnings written to tmp/warnings.txt"
+      puts
+    end
+
+    # fail the build...
+    raise "Failing build due to metric_fu warnings" if metric_fu_warnings.any?
+  end
+
+end

data/spec/dummy/lib/bad_encoding.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+class SomeClass
+  def initialize(a,b,c)
+    "hey, invalid ASCII\xED"
+  end
+end

data/spec/fixtures/coverage-153.rb

@@ -0,0 +1,11 @@
+# from https://github.com/metricfu/metric_fu/issues/153
+class A
+  def m(arg1)
+    p "this is my method" # Assume that none of the line covered in this method
+    if arg1 > 5
+        p 'more than 5'
+    else
+       p 'not more than 5'
+    end
+  end
+end