metric_fu 4.2.1 → 4.3.0

data/lib/metric_fu/data_structures/location.rb

@@ -2,7 +2,8 @@ module MetricFu
   class Location
     include Comparable
 
-    attr_accessor :class_name, :method_name, :file_path, :simple_method_name, :hash
+    attr_accessor :file_path, :file_name, :line_number,
+                  :class_name, :method_name, :simple_method_name, :hash
 
     def self.get(file_path, class_name, method_name)
       location = new(file_path, class_name, method_name)
@@ -16,6 +17,7 @@ module MetricFu
 
     def initialize(file_path, class_name, method_name)
       @file_path          = file_path
+      @file_name, @line_number = file_path.to_s.split(/:/)
       @class_name         = class_name
       @method_name        = method_name
       @simple_method_name = @method_name.to_s.sub(@class_name.to_s,'')
@@ -24,7 +26,7 @@ module MetricFu
 
     # TODO - we need this method (and hash accessor above) as a temporary hack where we're using Location as a hash key
     def eql?(other)
-      # REMOVED per https://github.com/jscruggs/metric_fu/pull/67/files 
+      # REMOVED per https://github.com/jscruggs/metric_fu/pull/67/files
       # [self.file_path.to_s, self.class_name.to_s, self.method_name.to_s] == [other.file_path.to_s, other.class_name.to_s, other.method_name.to_s]
       @hash == other.hash
     end
@@ -38,6 +40,7 @@ module MetricFu
         rescue => error
           #new error during port to metric_fu occasionally a unintialized
           #MatchData object shows up here. Not expected.
+          mf_debug "ERROR on getting location for #{class_or_method_name} #{error.inspect}"
           match = nil
         end
 
@@ -68,6 +71,8 @@ module MetricFu
 
     def finalize
       @file_path   &&= @file_path.clone
+      @file_name   &&= @file_name.clone
+      @line_number &&= @line_number.clone
       @class_name  &&= @class_name.clone
       @method_name &&= @method_name.clone
       freeze  # we cache a lot of method call results, so we want location to be immutable
@@ -76,7 +81,7 @@ module MetricFu
     private
 
     def self.strip_modules(class_or_method_name)
-      # reek reports the method with :: not # on modules like 
+      # reek reports the method with :: not # on modules like
       # module ApplicationHelper \n def signed_in?, convert it so it records correctly
       # but classes have to start with a capital letter... HACK for REEK bug, reported underlying issue to REEK
       if(class_or_method_name=~/\:\:[A-Z]/)

data/lib/metric_fu/formatter.rb

@@ -0,0 +1,24 @@
+require 'metric_fu/constantize'
+module MetricFu
+  module Formatter
+    BUILTIN_FORMATS = {
+      'html' => ['MetricFu::Formatter::HTML', 'Generates a templated HTML report using the configured template class and graph engine.'],
+      'yaml' => ['MetricFu::Formatter::YAML', 'Generates the raw output as yaml']
+    }
+    DEFAULT = [[:html]]
+
+    class << self
+      include MetricFu::Constantize
+
+      def class_for(format)
+        if (builtin = BUILTIN_FORMATS[format.to_s])
+          constantize(builtin[0])
+        else
+          constantize(format.to_s)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/metric_fu/formatter/html.rb

@@ -0,0 +1,91 @@
+module MetricFu
+  module Formatter
+    class HTML
+      include MetricFu::Io
+
+      def initialize(opts={})
+        @options = opts
+      end
+
+      def finish
+        mf_log "** SAVING REPORTS"
+        mf_debug "** SAVING REPORT YAML OUTPUT TO #{MetricFu.base_directory}"
+        MetricFu::Formatter::YAML.new.finish
+
+        mf_debug "** SAVING REPORT DATA OUTPUT TO #{MetricFu.data_directory}"
+        MetricFu::Formatter::YAML.new(
+          output: Pathname.pwd.join("#{MetricFu.data_directory}/#{Time.now.strftime("%Y%m%d")}.yml")
+        ).finish
+
+        mf_debug "** SAVING TEMPLATIZED REPORT"
+        save_templatized_result
+        save_graphs
+      end
+
+      def write_template(output, file)
+        write_output(output, "#{self.output_directory}/#{file}")
+      end
+
+      def display_results
+        if self.open_in_browser?
+          mf_debug "** OPENING IN BROWSER FROM #{self.output_directory}"
+          self.show_in_browser(self.output_directory)
+        end
+      end
+
+      protected
+
+      def output_directory
+        @output ||= dir_for(@options[:output]) || Pathname.pwd.join(MetricFu.output_directory)
+      end
+
+      # Instantiates a new template class based on the configuration set
+      # in MetricFu::Configuration, or through the MetricFu.config block
+      # in your rake file (defaults to the included AwesomeTemplate),
+      # assigns the result_hash to the result_hash in the template, and
+      # tells the template to to write itself out.
+      def save_templatized_result
+        @template = MetricFu.template_class.new
+        @template.output_directory = self.output_directory
+        @template.result = MetricFu.result.result_hash
+        @template.per_file_data = MetricFu.result.per_file_data
+        @template.formatter = self
+        @template.write
+      end
+
+      def save_graphs
+        mf_log "** GENERATING GRAPHS"
+        mf_debug "** PREPARING TO GRAPH"
+        MetricFu.graphs.each {|graph|
+          mf_debug "** Graphing #{graph} with #{MetricFu.graph_engine}"
+          MetricFu.graph.add(graph, MetricFu.graph_engine, self.output_directory)
+        }
+        mf_debug "** GENERATING GRAPH"
+        MetricFu.graph.generate
+      end
+
+      # Checks to discover whether we should try and open the results
+      # of the report in the browser on this system.  We only try and open
+      # in the browser if we're on OS X and we're not running in a
+      # CruiseControl.rb environment.  See MetricFu.configuration for more
+      # details about how we make those guesses.
+      #
+      # @return Boolean
+      #   Should we open in the browser or not?
+      def open_in_browser?
+        MetricFu.configuration.platform.include?('darwin') &&
+          ! MetricFu.configuration.is_cruise_control_rb?
+      end
+
+      # Shows 'index.html' from the passed directory in the browser
+      # if we're able to open the browser on this platform.
+      #
+      # @param dir String
+      #   The directory path where the 'index.html' we want to open is
+      #   stored
+      def show_in_browser(dir)
+        system("open #{dir}/index.html") if open_in_browser?
+      end
+    end
+  end
+end

data/lib/metric_fu/formatter/yaml.rb

@@ -0,0 +1,18 @@
+module MetricFu
+  module Formatter
+    class YAML
+      include MetricFu::Io
+
+      DEFAULT_PATH = "report.yml"
+
+      def initialize(opts={})
+        @options = opts
+        @path_or_io = @options[:output] || DEFAULT_PATH
+      end
+
+      def finish
+        write_output(MetricFu.result.as_yaml, @path_or_io)
+      end
+    end
+  end
+end

data/lib/metric_fu/initial_requires.rb

@@ -1,5 +1,4 @@
 # rake is required for
-# Saikuro : sh
 # Rcov    : FileList
 # loading metric_fu.rake
 require 'rake'

data/lib/metric_fu/io.rb

@@ -0,0 +1,69 @@
+module MetricFu
+  module Io
+    # Writes the output to a file or io stream.
+    # @param output [String, #to_s] the content to write.
+    # @param path_or_io [String, #to_s, IO, #write] a file path
+    #   or an io stream that responds to write.
+    # @return [nil]
+    def write_output(output, path_or_io)
+      io_for(path_or_io) do |io|
+        io.write(output)
+      end
+    end
+
+    # Yields an io object for writing output.
+    # @example
+    #   io_for('path/to/file') do |io|
+    #     io.write(output)
+    #   end
+    #
+    #   io_for(STDOUT) do |io|
+    #     io.write(output)
+    #   end
+    #
+    #   stream = StringIO.new
+    #   io_for(stream) do |io|
+    #     io.write(output)
+    #   end
+    #
+    # @param path_or_io [String, #to_s, IO, #write] a file path
+    #   or an io stream that responds to write.
+    #
+    # @yield [IO] an open stream for writing.
+    #
+    # @note Given a path to a file, an open file will
+    #   be yielded and closed after the block completes.
+    #   Given an existing io stream, the stream will not
+    #   be automatically closed. Cleanup, if necessary, is
+    #   the responsibility of the caller.
+    def io_for(path_or_io)
+      raise ArgumentError, "No path or io provided." if path_or_io.nil?
+      raise ArgumentError, "No block given. Cannot yield io stream." unless block_given?
+
+      if path_or_io.respond_to?(:write)
+        # We have an existing open stream...
+        yield path_or_io
+      else # Otherwise, we assume its a file path...
+        file_for(path_or_io) {|io| yield io }
+      end
+    end
+
+    def file_for(path)
+      File.open(path_relative_to_base(path), 'w') do |file|
+        yield file
+      end
+    end
+
+    def dir_for(path)
+      return nil if path.nil?
+      pathname = path_relative_to_base(path)
+      FileUtils.mkdir_p(pathname) unless File.directory?(pathname)
+      pathname
+    end
+
+    def path_relative_to_base(path)
+      pathname = Pathname.pwd.join(MetricFu.base_directory) # make full path relative to base directory
+      pathname.join(path)
+    end
+  end
+end

data/lib/metric_fu/load_files.rb

@@ -1,12 +1,12 @@
 # require these first because others depend on them
-MetricFu.reporting_require { 'report' }
+MetricFu.reporting_require { 'result' }
 MetricFu.metrics_require   { 'hotspots/hotspot' }
 MetricFu.metrics_require   { 'generator' }
 MetricFu.metrics_require   { 'graph' }
 MetricFu.reporting_require { 'graphs/grapher' }
 MetricFu.metrics_require   { 'hotspots/analysis/scoring_strategies' }
 
-Dir.glob(File.join(MetricFu.lib_dir, '*.rb')).each do |file|
+Dir.glob(File.join(MetricFu.lib_dir, '*.rb')).reject{|file| file =~ /#{__FILE__}/}.each do |file|
   require file
 end
 # prevent the task from being run multiple times.
@@ -29,3 +29,6 @@ end
 Dir.glob(File.join(MetricFu.reporting_dir, '**/*.rb')).each do |file|
   require file
 end
+Dir.glob(File.join(MetricFu.formatter_dir, '**/*.rb')).each do |file|
+  require file
+end

data/lib/metric_fu/logging/mf_debugger.rb

@@ -21,6 +21,29 @@ module MfDebugger
         end
       end
     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
+      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
+      STDOUT.reopen(pipe_w)
+      yield
+    ensure
+      STDOUT.reopen(old_stdout)
+      pipe_w.close
+      reader.join
+      return output
+    end
   end
 
   def mf_debug(msg,&block)

data/lib/metric_fu/metrics/base_template.rb

@@ -10,7 +10,13 @@ module MetricFu
   # to actually write out the template.  See StandardTemplate for an
   # example.
   class Template
-    attr_accessor :report, :per_file_data
+    attr_accessor :result, :per_file_data, :formatter, :output_directory
+
+
+    def output_directory
+      @output_directory || MetricFu.output_directory
+    end
+
 
     private
     # Creates a new erb evaluated result from the passed in section.
@@ -131,10 +137,10 @@ module MetricFu
       end
     end
 
-    def display_location(location, stat)
-      file_path, class_name, method_name = location.file_path, location.class_name, location.method_name
+    def display_location(location)
+      class_name, method_name = location.class_name, location.method_name
       str = ""
-      str += link_to_filename(file_path)
+      str += link_to_filename(location.file_name, location.line_number)
       str += " : " if method_name || class_name
       if(method_name)
         str += "#{method_name}"

data/lib/metric_fu/metrics/cane/cane.rb

@@ -4,7 +4,7 @@ module MetricFu
 
     def emit
       command = %Q{mf-cane#{abc_max_param}#{style_measure_param}#{no_doc_param}#{no_readme_param}}
-      mf_debug = "** #{command}"
+      mf_debug "** #{command}"
       @output = `#{command}`
     end
 
@@ -51,6 +51,7 @@ module MetricFu
         :documentation => /documentation/
       }
       category, desc_matcher = category_descriptions.find {|k,v| description =~ v}
+      mf_debug desc_matcher.inspect
       category
     end
 

data/lib/metric_fu/metrics/cane/cane_bluff_grapher.rb

@@ -1,15 +1,16 @@
 MetricFu.metrics_require   { 'cane/cane_grapher' }
 module MetricFu
   class CaneBluffGrapher < CaneGrapher
-    def graph!
-      content = <<-EOS
-        #{BLUFF_DEFAULT_OPTIONS}
-        g.title = 'Cane: code quality threshold violations';
-        g.data('cane', [#{@cane_violations.join(',')}]);
-        g.labels = #{MultiJson.dump(@labels)};
-        g.draw();
-      EOS
-      File.open(File.join(MetricFu.output_directory, 'cane.js'), 'w') {|f| f << content }
+    def title
+      'Cane: code quality threshold violations'
+    end
+    def data
+      [
+        ['cane', @cane_violations.join(',')]
+      ]
+    end
+    def output_filename
+      'cane.js'
     end
   end
 end

data/lib/metric_fu/metrics/cane/cane_gchart_grapher.rb

@@ -0,0 +1,25 @@
+MetricFu.metrics_require   { 'cane/cane_grapher' }
+module MetricFu
+  class CaneGchartGrapher < CaneGrapher
+    def title
+      'Cane: code quality threshold violations'
+    end
+    def legend
+      ['violations']
+    end
+    def data
+      @cane_violations
+    end
+    def output_filename
+      'cane.png'
+    end
+    def gchart_line_options
+      super.merge({
+        :legend => legend,
+      })
+    end
+    def y_axis_scale_argument
+      @cane_violations
+    end
+  end
+end

data/lib/metric_fu/metrics/flay/flay_bluff_grapher.rb

@@ -1,15 +1,16 @@
 MetricFu.metrics_require   { 'flay/flay_grapher' }
 module MetricFu
   class FlayBluffGrapher < FlayGrapher
-    def graph!
-      content = <<-EOS
-        #{BLUFF_DEFAULT_OPTIONS}
-        g.title = 'Flay: duplication';
-        g.data('flay', [#{@flay_score.join(',')}]);
-        g.labels = #{MultiJson.dump(@labels)};
-        g.draw();
-      EOS
-      File.open(File.join(MetricFu.output_directory, 'flay.js'), 'w') {|f| f << content }
+    def title
+      'Flay: duplication'
+    end
+    def data
+      [
+        ['flay', @flay_score.join(',')]
+      ]
+    end
+    def output_filename
+      'flay.js'
     end
   end
 end

data/lib/metric_fu/metrics/flay/flay_gchart_grapher.rb

@@ -1,17 +1,20 @@
 MetricFu.metrics_require   { 'flay/flay_grapher' }
 module MetricFu
   class FlayGchartGrapher < FlayGrapher
-    def graph!
-      determine_y_axis_scale(@flay_score)
-      url = Gchart.line(
-        :size => GCHART_GRAPH_SIZE,
-        :title => URI.escape("Flay: duplication"),
-        :data => @flay_score,
-        :max_value => @max_value,
-        :axis_with_labels => 'x,y',
-        :axis_labels => [@labels.values, @yaxis],
-        :format => 'file',
-        :filename => File.join(MetricFu.output_directory, 'flay.png'))
+    def title
+      "Flay: duplication"
+    end
+    def data
+      @flay_score
+    end
+    def output_filename
+      'flay.png'
+    end
+    def gchart_line_options
+      super
+    end
+    def y_axis_scale_argument
+      @flay_score
     end
   end
 end