metric_fu 4.1.2 → 4.1.3

data/lib/metric_fu/initial_requires.rb

@@ -7,14 +7,6 @@ require 'rake'
 require 'yaml'
 require 'redcard'
 
-begin
-  require 'active_support'
-  require 'active_support/core_ext/object/to_json'
-  require 'active_support/core_ext/object/blank'
-  require 'active_support/inflector'
-rescue LoadError
-  require 'activesupport' unless defined?(ActiveSupport)
-end
 MetricFu.configure
 MetricFu.logging_require { 'mf_debugger' }
 include MfDebugger

data/lib/metric_fu/metrics/base_template.rb

@@ -149,7 +149,7 @@ module MetricFu
 
     def file_url(name, line) # :nodoc:
       return '' unless name
-      filename = File.expand_path(name.gsub(/^\//, ''))
+      filename = complete_file_path(name)
       link_prefix = MetricFu.configuration.link_prefix
       if link_prefix
         "#{link_prefix}/#{name.gsub(/:.*$/, '')}"
@@ -162,6 +162,13 @@ module MetricFu
       end
     end
 
+    def complete_file_path(filename)
+      File.expand_path(remove_leading_slash(filename))
+    end
+
+    def remove_leading_slash(filename)
+      filename.gsub(/^\//, '')
+    end
     def render_as_txmt_protocol? # :nodoc:
       config = MetricFu.configuration
       return false unless config.platform.include?('darwin')
@@ -191,6 +198,26 @@ module MetricFu
       return first_value if iteration % 2 == 0
       return second_value
     end
+
+    # available in the erb template
+    # as it's processed in the context of
+    # the binding of this class
+    def metric_links
+      @metrics.keys.map {|metric| metric_link(metric.to_s) }
+    end
+
+    def metric_link(metric)
+      <<-LINK
+      <a href="#{metric}.html">
+        #{snake_case_to_title_case(metric)}
+      </a>
+      LINK
+    end
+
+    def snake_case_to_title_case(string)
+     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

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

@@ -7,8 +7,8 @@ module MetricFu
     end
 
     def analyze
-      if @output.match(/Churning requires a subversion or git repo/)
-        @churn = [:churn => {}]
+      if @output.nil? || @output.match(/Churning requires.*git/)
+        @churn = {:churn => {}}
       else
         @churn = YAML::load(@output)
       end

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

@@ -8,12 +8,14 @@
     <th>Times Changed</th>
   </tr>
   <% count = 0 %>
-  <% @churn[:changes].each do |change| %>
-    <tr>
-      <td><%= link_to_filename(change[:file_path]) %></td>
-      <td><%= change[:times_changed] %></td>
-    </tr>
-    <% count += 1 %>
+  <% if @churn[:changes] %>
+    <% @churn[:changes].each do |change| %>
+      <tr>
+        <td><%= link_to_filename(change[:file_path]) %></td>
+        <td><%= change[:times_changed] %></td>
+      </tr>
+      <% count += 1 %>
+    <% end %>
   <% end %>
 </table>
 

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

@@ -1,5 +1,8 @@
+# TODO determine if this file should be deleted
+# it doesn't appear to be used anywhere
 require 'delegate'
 
+# TODO remove explicit metric analyzer loading
 [ 'hotspots/hotspot_analyzer',
   'flog/flog_hotspot',
   'saikuro/saikuro_hotspot',
@@ -8,6 +11,7 @@ require 'delegate'
   'flay/flay_hotspot'].each do |path|
   MetricFu.metrics_require { path }
 end
+# TODO determine if the careful_array is needed
 %w(careful_array).each do |path|
   MetricFu.data_structures_require { path }
 end
@@ -18,6 +22,7 @@ module MetricFu
     include Comparable
 
     # TODO: Yuck! 'stat_value' is a column for StatHotspot
+    # TODO remove explicit metric references
     EXCLUDED_COLUMNS =
       FlogHotspot::COLUMNS +
       SaikuroHotspot::COLUMNS +
@@ -75,6 +80,7 @@ module MetricFu
       return nil
     end
 
+    # TODO remove explicit metric references
     def modifies?(other)
       case self.metric
       when :reek

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

@@ -1,3 +1,4 @@
+# TODO remove explicit Churn dependency
 MetricFu::Configuration.run do |config|
   config.add_metric(:hotspots)
   config.configure_metric(:hotspots,

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

@@ -14,10 +14,13 @@ class AwesomeTemplate < MetricFu::Template
       FileUtils.copy(f, File.join(MetricFu.output_directory, File.basename(f)))
     end
 
+    @metrics = {}
     report.each_pair do |section, contents|
       if template_exists?(section)
         create_instance_var(section, contents)
+        @metrics[section] = contents
         create_instance_var(:per_file_data, per_file_data)
+        mf_debug  "Generating html for section #{section} with #{template(section)} for report #{report.class}"
         @html = erbify(section)
         html = erbify('layout')
         fn = output_filename(section)
@@ -40,22 +43,25 @@ class AwesomeTemplate < MetricFu::Template
     write_file_data
   end
 
-  def convert_ruby_to_html(ruby_text)
-    # convertor = Syntax::Convertors::HTML.for_syntax('ruby')
-    # convertor.convert(ruby_text)
+  def convert_ruby_to_html(ruby_text, line_number)
     tokens = CodeRay.scan(ruby_text, :ruby)
-    tokens.div( :line_numbers => :table, :css => :class, :style => :alpha )
+    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
-# CodeRay, as Syntax may be used to analyze source code, because object Tokens is a list of tokens with specified types.
+    # :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
 
@@ -63,14 +69,21 @@ class AwesomeTemplate < MetricFu::Template
       data = File.open(file, 'r').readlines
       fn = "#{file.gsub(%r{/}, '_')}.html"
 
-      out = "<html><head><style>#{inline_css('css/syntax.css')}</style></head><body>"
+      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|
-        out << "<tr><td valign='top'><small>#{idx + 1}</small></td>"
+        line_number = (idx + 1).to_s
+        out << "<tr>"
         out << "<td valign='top'>"
-        if lines.has_key?((idx + 1).to_s)
+        if lines.has_key?(line_number)
           out << "<ul>"
-          lines[(idx + 1).to_s].each do |problem|
+          lines[line_number].each do |problem|
             out << "<li>#{problem[:description]} &raquo; #{problem[:type]}</li>"
           end
           out << "</ul>"
@@ -78,8 +91,12 @@ class AwesomeTemplate < MetricFu::Template
           out << "&nbsp;"
         end
         out << "</td>"
-        line_for_display = MetricFu.configuration.syntax_highlighting ? convert_ruby_to_html(line) : line
-        out << "<td valign='top'><a name='line#{idx + 1}'>#{line_for_display}</a></td>"
+        if MetricFu.configuration.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>"

data/lib/metric_fu/reporting/templates/awesome/css/bluff.css

@@ -0,0 +1,15 @@
+.bluff-tooltip {
+	background: #fff;
+	border: 1px solid #d1edf5;
+	padding: 8px 8px 6px;
+}
+.bluff-tooltip .color {
+	display: block;
+	height: 4px;
+	width: 30px;
+	margin: 0 0 4px;
+	overflow: hidden;
+}
+.bluff-tooltip .data {
+	font-weight: bold;
+}

data/lib/metric_fu/reporting/templates/awesome/css/default.css

@@ -41,51 +41,3 @@ table td.score {
 .warning {
   background: yellow;
 }
-.rcov_code td {
-  border-bottom: 1px solid #ddd ;
-  padding: 0;
-  margin: 0;
-}
-.rcov_code tr {
-  border: 0px;
-  padding:0px;
-  margin: 0px;
-}
-.rcov_code pre {
-  border: 0px;
-  padding: 0px;
-  margin: 0px;
-}
-.rcov_run {}
-.rcov_not_run {
-  background-color: #d88;
-}
-.rcov_run a, .rcov_not_run a {
-  text-decoration: none;
-}
-.rcov_run a {
-  color: #333;
-}
-.rcov_not_run a {
-  color: #000;
-}
-.rcov_overflow {
-  overflow: auto;
-  font-size: 50%;
-}
-
-.bluff-tooltip {
-	background: #fff;
-	border: 1px solid #d1edf5;
-	padding: 8px 8px 6px;
-}
-.bluff-tooltip .color {
-	display: block;
-	height: 4px;
-	width: 30px;
-	margin: 0 0 4px;
-	overflow: hidden;
-}
-.bluff-tooltip .data {
-	font-weight: bold;
-}

data/lib/metric_fu/reporting/templates/awesome/css/rcov.css

@@ -0,0 +1,32 @@
+.rcov_code td {
+  border-bottom: 1px solid #ddd ;
+  padding: 0;
+  margin: 0;
+}
+.rcov_code tr {
+  border: 0px;
+  padding:0px;
+  margin: 0px;
+}
+.rcov_code pre {
+  border: 0px;
+  padding: 0px;
+  margin: 0px;
+}
+.rcov_run {}
+.rcov_not_run {
+  background-color: #d88;
+}
+.rcov_run a, .rcov_not_run a {
+  text-decoration: none;
+}
+.rcov_run a {
+  color: #333;
+}
+.rcov_not_run a {
+  color: #000;
+}
+.rcov_overflow {
+  overflow: auto;
+  font-size: 50%;
+}

data/lib/metric_fu/reporting/templates/awesome/index.html.erb

@@ -1,37 +1,9 @@
 <h3>Metric Fu Results</h3>
 <ul id='projects'>
-<% if @churn %>
-  <li class='even failure'><a href="churn.html">Churn</a></li>
-<% end %>
-<% if @flay %>
-  <li class='even failure'><a href="flay.html">Flay</a></li>
-<% end %>
-<% if @flog %>
-  <li class='even failure'><a href="flog.html">Flog</a></li>
-<% end %>
-<% if @rcov %>
-  <li class='even failure'><a href="rcov.html">Rcov</a></li>
-<% end %>
-<% if @reek %>
-  <li class='even failure'><a href="reek.html">Reek</a></li>
-<% end %>
-<% if @roodi %>
-  <li class='even failure'><a href="roodi.html">Roodi</a></li>
-<% end %>
-<% if @saikuro %>
-  <li class='even failure'><a href="saikuro.html">Saikuro</a></li>
-<% end %>
-<% if @cane %>
-  <li class='even failure'><a href="cane.html">Cane</a></li>
-<% end %>
-<% if @stats %>
-  <li class='even failure'><a href="stats.html">Stats</a></li>
-<% end %>
-<% if @rails_best_practices %>
-  <li class='even failure'><a href="rails_best_practices.html">Rails Best Practices report</a></li>
-<% end %>
-<% if @hotspots %>
-  <li class='even failure'><a href="hotspots.html">Hotspots</a></li>
+<% metric_links.each do |link| %>
+  <li class='even failure'>
+    <%= link %>
+  </li>
 <% end %>
 </ul>
 <p>Generated on <%= Time.now.localtime %></p>

data/lib/metric_fu/reporting/templates/awesome/layout.html.erb

@@ -9,6 +9,8 @@
     <%= inline_css("css/buttons.css") %>
     <%= inline_css("css/integrity.css") %>
     <%= inline_css("css/default.css") %>
+    <%= inline_css('css/bluff.css') if MetricFu.configuration.graph_engine == :bluff %>
+    <%= inline_css('css/rcov.css') if @metrics.has_key?(:rcov) %>
     </style>
     <link REL="SHORTCUT ICON" HREF="/favicon.ico">
     <script language="javascript" src="js-class.js" type="text/javascript"></script>

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = "4.1.2"
+  VERSION = "4.1.3"
 end

data/metric_fu.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.version     = MetricFu::VERSION
   s.summary     = "A fistful of code metrics, with awesome templates and graphs"
   s.email       = "github@benjaminfleischer.com"
-  s.homepage    = "http://github.com/metricfu/metric_fu"
+  s.homepage    = "https://github.com/metricfu/metric_fu"
   s.description = "Code metrics from Flog, Flay, Saikuro, Churn, Reek, Roodi, Rails' stats task and Rails Best Practices, and optionally RCov"
   s.authors     = ["Jake Scruggs", "Sean Soper", "Andre Arko", "Petrik de Heus", "Grant McInnes", "Nick Quaranto", "Édouard Brière", "Carl Youngblood", "Richard Huang", "Dan Mayer", "Benjamin Fleischer"]
   s.rubyforge_project = 'metric_fu'
@@ -17,32 +17,44 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
   s.files              = `git ls-files`.split($\)
   s.test_files         =  s.files.grep(%r{^(test|spec|features)/})
+  s.default_executable = %q{metric_fu}
   s.executables        =  s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.license     = 'MIT'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["HISTORY.md", "CONTRIBUTING.md", "TODO.md", "MIT-LICENSE"]
+  s.rdoc_options = ["--main", "README.md"]
 
   {
-    "rails_best_practices"  => MetricFu::MetricVersion.rails_best_practices,
-    "japgolly-Saikuro"      => MetricFu::MetricVersion.saikuro,
-    "metric_fu-roodi"       => MetricFu::MetricVersion.roodi,
+    # metric dependencies
     "flay"                  => MetricFu::MetricVersion.flay,
+    "churn"                 => MetricFu::MetricVersion.churn,
     "flog"                  => MetricFu::MetricVersion.flog,
     "reek"                  => MetricFu::MetricVersion.reek,
-    "churn"                 => MetricFu::MetricVersion.churn,
     "cane"                  => MetricFu::MetricVersion.cane,
-      # specifying dependencies for f, r, ch, f, and cane
+      # specifying gem dependencies for
+      # flay, churn, flog, reek, and cane
       "ruby_parser"           => MetricFu::MetricVersion.ruby_parser,
       "sexp_processor"        => MetricFu::MetricVersion.sexp_processor,
+      # reek
       "ruby2ruby"             => MetricFu::MetricVersion.ruby2ruby,
+      # cane
       "parallel"              => MetricFu::MetricVersion.parallel,
-    "activesupport"         => [">= 2.0.0"], # ok
+      # required by main, a churn dependency
+      "fattr"                 => ["= 2.2.1"],
+      "arrayfields"           => ["= 4.7.4"],
+      "map"                   => ["= 6.2.0"],
+    "rails_best_practices"  => MetricFu::MetricVersion.rails_best_practices,
+    "japgolly-Saikuro"      => MetricFu::MetricVersion.saikuro,
+    "metric_fu-roodi"       => MetricFu::MetricVersion.roodi,
+    #
+    # other dependencies
+    # ruby version identification
     'redcard'               => [],
+    # syntax highlighting
     "coderay"               => [],
-    "fattr"                 => ["= 2.2.1"],
-    "arrayfields"           => ["= 4.7.4"],
-    "map"                   => ["= 6.2.0"],
+    # default graphing libraries
     "bluff"                 => [],
-    "googlecharts"          => []
   }.each do |gem, version|
     if version == []
       s.add_runtime_dependency(gem)