metric_fu 4.6.0 → 4.7.0

data/lib/metric_fu/io.rb

@@ -101,21 +101,21 @@ module MetricFu
     #   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)
+    def io_for(path_or_io, &block)
       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
+        block.call(path_or_io)
       else # Otherwise, we assume its a file path...
-        file_for(path_or_io) {|io| yield io }
+        file_for(path_or_io, &block)
       end
     end
 
-    def file_for(path)
+    def file_for(path, &block)
       File.open(path_relative_to_base(path), 'w') do |file|
-        yield file
+        block.call(file)
       end
     end
 

data/lib/metric_fu/loader.rb

@@ -72,13 +72,21 @@ module MetricFu
     end
 
     def setup
+      MetricFu.logging_require { 'mf_debugger' }
+      Object.send :include, MfDebugger
+      MfDebugger::Logger.debug_on = !!(ENV['MF_DEBUG'] =~ /true/i)
+
       MetricFu.lib_require { 'configuration' }
       MetricFu.lib_require { 'metric' }
-      # TODO: consolidate these setup files
-      MetricFu.lib_require { 'initial_requires' }
-      # Load a few things to make our lives easier elsewhere.
-      MetricFu.lib_require { 'load_files' }
+
+      Dir.glob(File.join(MetricFu.metrics_dir, '**/init.rb')).each{|init_file|require(init_file)}
+
       load_user_configuration
+
+      MetricFu.lib_require       { 'reporter' }
+      MetricFu.reporting_require { 'result' }
+
+      MetricFu.load_tasks('metric_fu.rake', task_name: 'metrics:all')
     end
 
     def load_user_configuration
@@ -88,4 +96,3 @@ module MetricFu
 
   end
 end
-

data/lib/metric_fu/metric.rb

@@ -1,5 +1,6 @@
 require 'set'
 MetricFu.lib_require { 'gem_run' }
+MetricFu.metrics_require { 'generator' }
 # Encapsulates the configuration options for each metric
 module MetricFu
   class Metric
@@ -18,6 +19,7 @@ module MetricFu
 
     # TODO: Confirm this catches load errors from requires in subclasses, such as for flog
     def activate
+      MetricFu.metrics_require { default_metric_library_paths }
       @libraries.each {|library| require(library) }
       self.activated = true
     rescue LoadError => e
@@ -120,5 +122,13 @@ module MetricFu
       @libraries << file.strip
     end
 
+    def default_metric_library_paths
+      paths = []
+      paths << generator_path = "#{name}/#{name}"
+      if has_graph?
+          paths << grapher_path   = "#{name}/#{name}_grapher"
+      end
+      paths
+    end
   end
 end

data/lib/metric_fu/metrics/base_template.rb

@@ -120,8 +120,8 @@ module MetricFu
     # @return String
     #   The contents of the css file
     def inline_css(css)
-      css_file = File.join(template_directory, css)
-      open(css_file) {|f| f.read }
+      css_file = File.join(MetricFu.lib_dir,'templates', css)
+      MetricFu::Utility.binread(css_file)
     end
 
     # Provides a link to open a file through the textmate protocol

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

@@ -1,3 +1,4 @@
+MetricFu.metrics_require { 'cane/violations' }
 module MetricFu
   class CaneGenerator < Generator
     attr_reader :violations, :total_violations

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

@@ -6,61 +6,35 @@ module MetricFu
       :churn
     end
 
+    ###
+    # options available are what can be passed to churn_calculator
+    # https://github.com/danmayer/churn#library-options
+    ###
     def emit
-      @output = generate_churn_metrics
+      @output = run(options)
     end
 
     def analyze
-      if @output.nil? || @output.match(/Churning requires.*git/)
+      if @output.nil? || @output.size.zero?
         @churn = {:churn => {}}
       else
-        @churn = YAML::load(@output)
+        @churn = @output
       end
+      @churn
     end
 
     # ensure hash only has the :churn key
     def to_h
       {:churn => @churn[:churn]}
     end
-
-    private
-
-    def generate_churn_metrics
-      output = churn_code
-      ensure_output_is_valid_yaml(output)
-    end
-
-    def churn_code
-      run!(build_churn_options)
-    end
-
-    def ensure_output_is_valid_yaml(output)
-      yaml_start = output.index("---")
-      if yaml_start
-        output[yaml_start...output.length]
-      else
-        nil
-      end
-    end
-
-    def build_churn_options
-      opts = ["--yaml"]
-      churn_options.each do |churn_option, command_flag|
-        if has_option?(churn_option)
-          opts << "#{command_flag}=#{options[churn_option]}"
-        end
-      end
-      opts.join(" ")
-    end
-
-    def has_option?(churn_option)
-      options.include?(churn_option)
-    end
-    def churn_options
-      {
-        :minimum_churn_count => '--minimum_churn_count',
-        :start_date => '--start_date'
-      }
+    
+    # @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
+      ::Churn::ChurnCalculator.new(args).report(false)
     end
 
   end

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

@@ -6,7 +6,12 @@ module MetricFu
     end
 
     def default_run_options
-      { :start_date => %q("1 year ago"), :minimum_churn_count => 10}
+      { 
+        :start_date => %q("1 year ago"),
+        :minimum_churn_count => 10,
+        :ignore_files => [],
+        :data_directory => MetricFu::Io::FileSystem.scratch_directory(name)
+      }
     end
 
     def has_graph?
@@ -18,6 +23,7 @@ module MetricFu
     end
 
     def activate
+      activate_library('churn/churn_calculator')
       super
     end
 

data/lib/metric_fu/metrics/hotspots/analysis/groupings.rb

@@ -1,3 +1,4 @@
+MetricFu.metrics_require { 'hotspots/analysis/grouping' }
 module MetricFu
   class HotspotGroupings
 

data/lib/metric_fu/metrics/hotspots/analysis/problems.rb

@@ -1,3 +1,4 @@
+MetricFu.metrics_require { 'hotspots/analysis/groupings' }
 module MetricFu
   class HotspotProblems
 

data/lib/metric_fu/metrics/hotspots/analysis/ranked_problem_location.rb

@@ -1,3 +1,5 @@
+MetricFu.lib_require { 'errors/analysis_error' }
+MetricFu.metrics_require { 'hotspots/analysis/problems' }
 module MetricFu
   class HotspotRankedProblemLocation
     MetricFu.data_structures_require { 'location' }

data/lib/metric_fu/metrics/hotspots/analysis/rankings.rb

@@ -1,3 +1,8 @@
+MetricFu.metrics_require do
+  [
+    'hotspots/analysis/ranking'
+  ]
+end
 module MetricFu
   class HotspotRankings
 

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

@@ -1,3 +1,6 @@
+MetricFu.lib_require { 'errors/analysis_error' }
+MetricFu.metrics_require { 'hotspots/analysis/scoring_strategies' }
+
 module MetricFu
   class Hotspot
     def self.metric

data/lib/metric_fu/metrics/hotspots/hotspot_analyzer.rb

@@ -1,8 +1,12 @@
-require File.expand_path('analysis_error', MetricFu.errors_dir)
-%w(table record grouping ranking problems).each do |path|
-  MetricFu.metrics_require   { "hotspots/analysis/#{path}" }
+require 'yaml'
+MetricFu.metrics_require do
+  [
+    'hotspots/hotspot',
+    'hotspots/analysis/analyzer_tables',
+    'hotspots/analysis/analyzed_problems',
+    'hotspots/analysis/rankings'
+  ]
 end
-MetricFu.metrics_require   { 'hotspots/hotspot' }
 
 module MetricFu
   class HotspotAnalyzer

data/lib/metric_fu/metrics/hotspots/hotspots.rb

@@ -8,6 +8,9 @@ module MetricFu
     end
 
     def initialize(options={})
+      MetricFu::Metric.enabled_metrics.each do |metric|
+        require_hotspot(metric.name)
+      end
       super
     end
 
@@ -27,6 +30,14 @@ module MetricFu
       end
       result
     end
+
+    private
+
+    def require_hotspot(metric_name)
+      require "metric_fu/metrics/#{metric_name}/#{metric_name}_hotspot"
+    rescue LoadError
+      mf_debug "*** No hotspot for #{metric_name}"
+    end
   end
 
 end

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

@@ -23,7 +23,7 @@ module MetricFu
     def analyze
       @matches = @output.chomp.split("\n\n").map{|m| m.split("\n") }
       @matches = @matches.map do |match|
-        file_path = match.shift.split('--').first
+        file_path = match.shift.split(' -- ').first
         file_path = file_path.gsub('"', ' ').strip
         code_smells = match.map do |smell|
           match_object = smell.match(REEK_REGEX)

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

@@ -1,5 +1,4 @@
 # coding: utf-8
-
 class ReekHotspot < MetricFu::Hotspot
 
   # Note that in practice, the prefix reek__ is appended to each one

data/lib/metric_fu/metrics/saikuro/saikuro.rb

@@ -2,6 +2,7 @@
 MetricFu.lib_require       { 'utility'                 }
 MetricFu.metrics_require   { 'saikuro/scratch_file'    }
 MetricFu.metrics_require   { 'saikuro/parsing_element' }
+MetricFu.data_structures_require { 'line_numbers' }
 module MetricFu
 
   class SaikuroGenerator < MetricFu::Generator

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

@@ -1,4 +1,3 @@
-# Class opened and modified by requiring a graph engine
 require 'multi_json'
 module MetricFu
   class Grapher

data/lib/metric_fu/reporting/templates/awesome/awesome_template.rb

@@ -1,7 +1,6 @@
 require 'fileutils'
-require 'coderay'
 MetricFu.metrics_require { 'base_template' }
-MetricFu.lib_require { 'utility' }
+MetricFu.lib_require { 'templates/report' }
 
 class AwesomeTemplate < MetricFu::Template
 
@@ -44,70 +43,20 @@ class AwesomeTemplate < MetricFu::Template
     write_file_data
   end
 
-  def convert_ruby_to_html(ruby_text, line_number)
-    tokens = CodeRay.scan(MetricFu::Utility.clean_ascii_text(ruby_text), :ruby)
-    options = { :css => :class, :style => :alpha }
-    if line_number.to_i > 0
-      options = options.merge({:line_numbers => :inline, :line_number_start => line_number.to_i })
-    end
-    tokens.div(options)
-    # CodeRay options
-    # used to analyze source code, because object Tokens is a list of tokens with specified types.
-    # :tab_width – tabulation width in spaces. Default: 8
-    # :css – how to include the styles (:class и :style). Default: :class)
-    #
-    # :wrap – wrap result in html tag :page, :div, :span or not to wrap (nil)
-    #
-    # :line_numbers – how render line numbers (:table, :inline, :list or nil)
-    #
-    # :line_number_start – first line number
-    #
-    # :bold_every – make every n-th line number bold. Default: 10
-  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(@metrics)
 
-      data = File.readlines(file)
-      fn = "#{file.gsub(%r{/}, '_')}.html"
-
-      out = <<-HTML
-        <html><head><style>
-          #{inline_css('css/syntax.css')}
-          #{inline_css('css/bluff.css') if MetricFu.configuration.graph_engine == :bluff}
-          #{inline_css('css/rcov.css') if @metrics.has_key?(:rcov)}
-        </style></head><body>
-      HTML
-      out << "<table cellpadding='0' cellspacing='0' class='ruby'>"
-      data.each_with_index do |line, idx|
-        line_number = (idx + 1).to_s
-        out << "<tr>"
-        out << "<td valign='top'>"
-        if lines.has_key?(line_number)
-          out << "<ul>"
-          lines[line_number].each do |problem|
-            out << "<li>#{problem[:description]} &raquo; #{problem[:type]}</li>"
-          end
-          out << "</ul>"
-        else
-          out << "&nbsp;"
-        end
-        out << "</td>"
-        if MetricFu::Formatter::Templates.option('syntax_highlighting')
-          line_for_display = convert_ruby_to_html(line, line_number)
-        else
-          line_for_display = "<a name='n#{line_number}' href='n#{line_number}'>#{line_number}</a>#{line}"
-        end
-        out << "<td valign='top'>#{line_for_display}</td>"
-        out << "</tr>"
-      end
-      out << "<table></body></html>"
-
-      formatter.write_template(out, fn)
+      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

data/lib/metric_fu/run.rb

@@ -70,7 +70,7 @@ module MetricFu
       end
     end
     def reporter
-      Reporter.new(MetricFu.configuration.formatters)
+      MetricFu::Reporter.new(MetricFu.configuration.formatters)
     end
   end
 end

data/lib/metric_fu/templates/report.html.erb

@@ -0,0 +1,32 @@
+<html>
+  <head>
+    <style>
+    <%=  inline_css('css/syntax.css') %>
+    <%=  inline_css('css/bluff.css') if MetricFu.configuration.graph_engine == :bluff %>
+    <%=  inline_css('css/rcov.css') if @metrics.has_key?(:rcov) %>
+    </style>
+  </head>
+  <body>
+    <table cellpadding='0' cellspacing='0' class='ruby'>
+      <% @data.each_with_index do |line, idx| %>
+        <% line_number = (idx + 1).to_s %>
+        <tr>
+          <td valign='top'>
+           <% if @lines.has_key?(line_number) %>
+             <ul>
+               <% @lines[line_number].each do |problem| %>
+                 <li><%= "#{problem[:description]} &raquo; #{problem[:type]}" %></li>
+               <% end %>
+            </ul>
+          <% else %>
+              &nbsp;
+          <% end %>
+          </td>
+          <td valign='top'>
+            <%= line_for_display(line, line_number) %>
+          </td>
+         </tr>
+         <% end %>
+    <table>
+  </body>
+</html>