metric_fu 2.0.1 → 2.1.0

data/HISTORY

@@ -1,3 +1,15 @@
+=== MetricFu 2.1.0 / 2011-03-1
+
+* Flog gemspec version was >= 2.2.0, which was too early and didn't work. Changed to >= 2.3.0 -  Chris Griego
+* RCov generator now uses a regex with begin and end line anchor to avoid splitting on comments with equal signs in source files - Andrew Selder
+* RCov generator now always strips the 3 leading characters from the lines when reconstruction source files so that heredocs and block comments parse successfully - Andrew Selder
+* Dan Mayer ported some specs for the Hotspots code into MetricFu from Caliper's code.
+* Stefan Huber fixed some problems with churn pretending not to support Svn.
+* Kakutani Shintaro added the ability to opt out of opening files with TextMate (config.darwin_txmt_protocol_no_thanks = true).
+* Joel Nimety and Andrew Selder fixed a problem where Saikuro was parsing a dir twice.
+* Dan Sinclair added some awesome 'annotate' functionality to the Hotspots page. Click on it so see the file with problems in-line. 
+* Dan Sinclair added a verbose mode (config.verbose = true).
+
 === MetricFu 2.0.1 / 2010-11-13
 
 * Delete trailing whitespaces - Delwyn de Villiers

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008,2009,2010 Jake Scruggs
+Copyright (c) 2008,2009,2010,2011 Jake Scruggs
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/lib/base/base_template.rb

@@ -8,7 +8,7 @@ module MetricFu
   # to actually write out the template.  See StandardTemplate for an
   # example.
   class Template
-    attr_accessor :report
+    attr_accessor :report, :per_file_data
 
     private
     # Creates a new erb evaluated result from the passed in section.
@@ -137,13 +137,19 @@ module MetricFu
     def file_url(name, line) # :nodoc:
       return '' unless name
       filename = File.expand_path(name.gsub(/^\//, ''))
-      if MetricFu.configuration.platform.include?('darwin')
+      if render_as_txmt_protocol?
         "txmt://open/?url=file://#{filename}" << (line ? "&line=#{line}" : "")
       else
        "file://#{filename}"
       end
     end
 
+    def render_as_txmt_protocol? # :nodoc:
+      config = MetricFu.configuration
+      return false unless config.platform.include?('darwin')
+      return !config.darwin_txmt_protocol_no_thanks
+    end
+
     # Provides a brain dead way to cycle between two values during
     # an iteration of some sort.  Pass in the first_value, the second_value,
     # and the cardinality of the iteration.
@@ -162,6 +168,5 @@ module MetricFu
       return first_value if iteration % 2 == 0
       return second_value
     end
-
   end
 end

data/lib/base/churn_analyzer.rb

@@ -35,18 +35,4 @@ class ChurnAnalyzer
     end
   end
 
-  private
-
-  def self.update_changes(total, changed)
-    changed.each do |change|
-      #should work as has_key(change), but hash == doesn't work on 1.8.6 here for some reason it never matches
-      if total.has_key?(change.to_a.sort)
-        total[change.to_a.sort] += 1
-      else
-        total[change.to_a.sort] = 1
-      end
-    end
-    total
-  end
-
 end

data/lib/base/configuration.rb

@@ -8,9 +8,9 @@ module MetricFu
   AVAILABLE_METRICS = [:churn, :flog, :flay, :reek,
                        :roodi, :rcov,
                       :hotspots]
-                      
+
   AVAILABLE_METRICS << :saikuro unless RUBY_VERSION == '1.9.2'
-  
+
   AVAILABLE_GRAPHS = [:flog, :flay, :reek, :roodi, :rcov, :rails_best_practices]
   AVAILABLE_GRAPH_ENGINES = [:gchart, :bluff]
 
@@ -145,7 +145,11 @@ module MetricFu
       @hotspots = {}
       @file_globs_to_ignore = []
 
+      @verbose = false
+
       @graph_engine = :bluff # can be :bluff or :gchart
+
+      @darwin_txmt_protocol_no_thanks = false
     end
 
     # Perform a simple check to try and guess if we're running

data/lib/base/generator.rb

@@ -121,6 +121,10 @@ module MetricFu
     # methods to allow extra hooks into the processing methods, and help
     # to keep the logic of your Generators clean.
     def generate_report
+      if MetricFu.configuration.verbose
+        puts "Executing #{self.class.to_s.gsub(/.*::/, '')}"
+      end
+
       %w[emit analyze].each do |meth|
         send("before_#{meth}".to_sym)
         send("#{meth}".to_sym)

data/lib/base/line_numbers.rb

@@ -4,8 +4,8 @@ module MetricFu
 
     def initialize(contents)
       rp = RubyParser.new
-      file_sexp = rp.parse(contents)
       @locations = {}
+      file_sexp = rp.parse(contents)
       case file_sexp[0]
       when :class
         process_class(file_sexp)
@@ -15,6 +15,9 @@ module MetricFu
         file_sexp.each_of_type(:class) { |sexp| process_class(sexp) }
       else
       end
+    rescue Exception
+      #catch errors for files ruby_parser fails on
+      @locations
     end
 
     def in_method? line_number
@@ -31,6 +34,11 @@ module MetricFu
       found_method_and_range.first
     end
 
+    def start_line_for_method(method)
+      return nil unless @locations.has_key?(method)
+      @locations[method].first
+    end
+
     private
 
     def process_module(sexp)
@@ -63,4 +71,4 @@ module MetricFu
     end
 
   end
-end
+end

data/lib/base/reek_analyzer.rb

@@ -3,23 +3,70 @@
 class ReekAnalyzer
   include ScoringStrategies
 
-  REEK_ISSUE_INFO = {'Uncommunicative Name' =>
-    {'link' => 'http://wiki.github.com/kevinrutherford/reek/uncommunicative-name', 'info' => 'An Uncommunicative Name is a name that doesn’t communicate its intent well enough.'},
+  REEK_ISSUE_INFO = {
+    'Uncommunicative Name' =>
+      {'link' => 'http://wiki.github.com/kevinrutherford/reek/uncommunicative-name',
+       'info' => 'An Uncommunicative Name is a name that doesn’t communicate its intent well enough.'},
     'Class Variable' =>
-    {'link' => 'http://wiki.github.com/kevinrutherford/reek/class-variable', 'info' => 'Class variables form part of the global runtime state, and as such make it easy for one part of the system to accidentally or inadvertently depend on another part of the system.'},
-    'Duplication' => {'link' =>'http://wiki.github.com/kevinrutherford/reek/duplication', 'info' => 'Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.'},
-    'Low Cohesion' => {'link' => 'http://en.wikipedia.org/wiki/Cohesion_(computer_science)', 'info' => 'Low cohesion is associated with undesirable traits such as being difficult to maintain, difficult to test, difficult to reuse, and even difficult to understand.'},
-    'Nested Iterators' => {'link' =>'http://wiki.github.com/kevinrutherford/reek/nested-iterators', 'info' => 'Nested Iterator occurs when a block contains another block.'},
-    'Control Couple' => {'link' =>'http://wiki.github.com/kevinrutherford/reek/control-couple', 'info' => 'Control coupling occurs when a method or block checks the value of a parameter in order to decide which execution path to take. The offending parameter is often called a “Control Couple”.'},
-    'Irresponsible Module' => {'link' =>'http://wiki.github.com/kevinrutherford/reek/irresponsible-module', 'info' => 'Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.'},
-    'Long Parameter List' => {'link' =>'http://wiki.github.com/kevinrutherford/reek/long-parameter-list', 'info' => 'A Long Parameter List occurs when a method has more than one or two parameters, or when a method yields more than one or two objects to an associated block.'},
-    'Data Clump' => {'link' =>'http://wiki.github.com/kevinrutherford/reek/data-clump', 'info' => 'In general, a Data Clump occurs when the same two or three items frequently appear together in classes and parameter lists, or when a group of instance variable names start or end with similar substrings.'},
-    'Simulated Polymorphism' => {'link' =>'http://wiki.github.com/kevinrutherford/reek/simulated-polymorphism', 'info' => 'Simulated Polymorphism occurs when, code uses a case statement (especially on a type field) or code uses instance_of?, kind_of?, is_a?, or === to decide what code to execute'},
-    'Large Class' => {'link' =>'http://wiki.github.com/kevinrutherford/reek/large-class', 'info' => 'A Large Class is a class or module that has a large number of instance variables, methods or lines of code in any one piece of its specification.'},
-    'Long Method' => {'link' =>'http://wiki.github.com/kevinrutherford/reek/long-method', 'info' => 'Long methods can be hard to read and understand. They often are harder to test and maintain as well, which can lead to buggier code.'},
-    'Feature Envy' => {'link' =>'http://wiki.github.com/kevinrutherford/reek/feature-envy', 'info' => 'Feature Envy occurs when a code fragment references another object more often than it references itself, or when several clients do the same series of manipulations on a particular type of object.'},
-    'Utility Function' => {'link' =>'http://wiki.github.com/kevinrutherford/reek/utility-function', 'info' => 'A Utility Function is any instance method that has no dependency on the state of the instance. It reduces the code’s ability to communicate intent. Code that “belongs” on one class but which is located in another can be hard to find.'},
-    'Attribute' => {'link' => 'http://wiki.github.com/kevinrutherford/reek/attribute', 'info' => 'A class that publishes a getter or setter for an instance variable invites client classes to become too intimate with its inner workings, and in particular with its representation of state.'}
+      {'link' => 'http://wiki.github.com/kevinrutherford/reek/class-variable',
+       'info' => 'Class variables form part of the global runtime state, and as such make it ' +
+                 'easy for one part of the system to accidentally or inadvertently depend on ' +
+                 'another part of the system.'},
+    'Duplication' =>
+      {'link' =>'http://wiki.github.com/kevinrutherford/reek/duplication',
+       'info' => 'Duplication occurs when two fragments of code look nearly identical, or when ' +
+                 'two fragments of code have nearly identical effects at some conceptual level.'},
+    'Low Cohesion' =>
+      {'link' => 'http://en.wikipedia.org/wiki/Cohesion_(computer_science)',
+       'info' => 'Low cohesion is associated with undesirable traits such as being difficult to ' +
+                 'maintain, difficult to test, difficult to reuse, and even difficult to understand.'},
+    'Nested Iterators' =>
+      {'link' =>'http://wiki.github.com/kevinrutherford/reek/nested-iterators',
+       'info' => 'Nested Iterator occurs when a block contains another block.'},
+    'Control Couple' =>
+      {'link' =>'http://wiki.github.com/kevinrutherford/reek/control-couple',
+       'info' => 'Control coupling occurs when a method or block checks the value of a parameter in ' +
+                 'order to decide which execution path to take. The offending parameter is often called a “Control Couple”.'},
+    'Irresponsible Module' =>
+      {'link' =>'http://wiki.github.com/kevinrutherford/reek/irresponsible-module',
+       'info' => 'Classes and modules are the units of reuse and release. It is therefore considered ' +
+                 'good practice to annotate every class and module with a brief comment outlining its responsibilities.'},
+    'Long Parameter List' =>
+      {'link' =>'http://wiki.github.com/kevinrutherford/reek/long-parameter-list',
+       'info' => 'A Long Parameter List occurs when a method has more than one or two parameters, ' +
+                 'or when a method yields more than one or two objects to an associated block.'},
+    'Data Clump' =>
+      {'link' =>'http://wiki.github.com/kevinrutherford/reek/data-clump',
+       'info' => 'In general, a Data Clump occurs when the same two or three items frequently appear ' +
+                 'together in classes and parameter lists, or when a group of instance variable names ' +
+                 'start or end with similar substrings.'},
+    'Simulated Polymorphism' =>
+      {'link' =>'http://wiki.github.com/kevinrutherford/reek/simulated-polymorphism',
+       'info' => 'Simulated Polymorphism occurs when, code uses a case statement (especially on a ' +
+                 'type field) or code uses instance_of?, kind_of?, is_a?, or === to decide what code to execute'},
+    'Large Class' =>
+      {'link' =>'http://wiki.github.com/kevinrutherford/reek/large-class',
+       'info' => 'A Large Class is a class or module that has a large number of instance variables, ' +
+                 'methods or lines of code in any one piece of its specification.'},
+    'Long Method' =>
+      {'link' =>'http://wiki.github.com/kevinrutherford/reek/long-method',
+       'info' => 'Long methods can be hard to read and understand. They often are harder to test and ' +
+                 'maintain as well, which can lead to buggier code.'},
+    'Feature Envy' =>
+      {'link' =>'http://wiki.github.com/kevinrutherford/reek/feature-envy',
+       'info' => 'Feature Envy occurs when a code fragment references another object more often than ' +
+                 'it references itself, or when several clients do the same series of manipulations ' +
+                 'on a particular type of object.'},
+    'Utility Function' =>
+      {'link' =>'http://wiki.github.com/kevinrutherford/reek/utility-function',
+       'info' => 'A Utility Function is any instance method that has no dependency on the state of the ' +
+                 'instance. It reduces the code’s ability to communicate intent. Code that “belongs” on ' +
+                 'one class but which is located in another can be hard to find.'},
+    'Attribute' =>
+      {'link' => 'http://wiki.github.com/kevinrutherford/reek/attribute',
+       'info' => 'A class that publishes a getter or setter for an instance variable invites client ' +
+                 'classes to become too intimate with its inner workings, and in particular with its ' +
+                 'representation of state.'}
   }
 
   # Note that in practice, the prefix reek__ is appended to each one

data/lib/base/report.rb

@@ -28,6 +28,9 @@ module MetricFu
       report_hash.to_yaml
     end
 
+    def per_file_data
+      @per_file_data ||= {}
+    end
 
     def report_hash #:nodoc:
       @report_hash ||= {}
@@ -41,6 +44,7 @@ module MetricFu
     def save_templatized_report
       @template = MetricFu.template_class.new
       @template.report = report_hash
+      @template.per_file_data = per_file_data
       @template.write
     end
 
@@ -51,7 +55,11 @@ module MetricFu
     #   The hash to add to the aggregate report_hash
     def add(report_type)
       clazz = MetricFu.const_get(report_type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase })
-      report_hash.merge!(clazz.generate_report)
+      inst = clazz.new
+
+      report_hash.merge!(inst.generate_report)
+
+      inst.per_file_info(per_file_data) if inst.respond_to?(:per_file_info)
     end
 
     # Saves the passed in content to the passed in directory.  If

data/lib/generators/churn.rb

@@ -13,7 +13,7 @@ module MetricFu
     end
 
     def analyze
-      if @output.match(/fatal: Not a git repository/)
+      if @output.match(/Churning requires a subversion or git repo/)
         @churn = [:churn => {}]
       else
         @churn = YAML::load(@output)

data/lib/generators/flog.rb

@@ -48,6 +48,19 @@ module MetricFu
                   :method_containers => sorted_containers.map {|method_container| method_container.to_h}}}
     end
 
+    def per_file_info(out)
+      @method_containers.each_pair do |klass, container|
+        container.methods.each_pair do |method_name, data|
+          next if data[:path].nil?
+
+          file, line = data[:path].split(':')
+
+          out[file] ||= {}
+          out[file][line] ||= []
+          out[file][line] << {:type => :flog, :description => "Score of %.2f" % data[:score]}
+        end
+      end
+    end
   end
 
   class MethodContainer

data/lib/generators/rails_best_practices.rb

@@ -2,24 +2,52 @@ module MetricFu
   class RailsBestPractices < Generator
 
     def emit
-      @output = `rails_best_practices .`
+      @output = `rails_best_practices --without-color .`
     end
 
     def analyze
       @matches = @output.chomp.split("\n").map{|m| m.split(" - ") }
       total = @matches.pop
+      cleanup_color_switches(total.first)
+
       2.times { @matches.pop } # ignore wiki link
       @matches.reject! {|array| array.empty? }
       @matches.map! do |match|
         file, line = match[0].split(':')
         problem = match[1]
+
+        cleanup_color_switches(file)
+        cleanup_color_switches(problem)
+
+        file.gsub!(/^\.\//, '')
+
         {:file => file, :line => line, :problem => problem}
       end
       @rails_best_practices_results = {:total => total, :problems => @matches}
     end
 
+    def cleanup_color_switches(str)
+      return if str.nil?
+      str.gsub!(%r{^\e\[3[1|2]m}, '')
+      str.gsub!(%r{\e\[0m$}, '')
+    end
+
     def to_h
       {:rails_best_practices => @rails_best_practices_results}
     end
+
+    def per_file_info(out)
+      @rails_best_practices_results[:problems].each do |problem|
+        next if problem[:file] == '' || problem[:problem].nil?
+
+        out[problem[:file]] ||= {}
+
+        lines = problem[:line].split(/\s*,\s*/)
+        lines.each do |line|
+          out[problem[:file]][line] ||= []
+          out[problem[:file]][line] << {:type => :rails_best_practices, :description => problem[:problem]}
+        end
+      end
+    end
   end
 end

data/lib/generators/rcov.rb

@@ -3,7 +3,7 @@ require 'enumerator'
 module MetricFu
 
   class Rcov < Generator
-    NEW_FILE_MARKER =  ("=" * 80) + "\n"
+    NEW_FILE_MARKER = /^={80}$/.freeze
 
     class Line
       attr_accessor :content, :was_run
@@ -100,11 +100,7 @@ module MetricFu
       files.each_pair {|fname, content| files[fname] = content.split("\n") }
       files.each_pair do |fname, content|
         content.map! do |raw_line|
-          if raw_line.match(/^!!/)
-            line = Line.new(raw_line.gsub('!!', '  '), false).to_h
-          else
-            line = Line.new(raw_line, true).to_h
-          end
+          line = Line.new(raw_line[3..-1], !raw_line.match(/^!!/)).to_h
         end
         content.reject! {|line| line[:content].blank? }
         files[fname] = {:lines => content}

data/lib/generators/reek.rb

@@ -56,5 +56,26 @@ module MetricFu
       {:reek => {:matches => @matches}}
     end
 
+    def per_file_info(out)
+      @matches.each do |file_data|
+        next if File.extname(file_data[:file_path]) == '.erb'
+        begin
+          line_numbers = MetricFu::LineNumbers.new(File.open(file_data[:file_path], 'r').read)
+        rescue StandardError => e
+          raise e unless e.message =~ /you shouldn't be able to get here/
+          puts "ruby_parser blew up while trying to parse #{file_path}. You won't have method level reek information for this file."
+          next
+        end
+
+        out[file_data[:file_path]] ||= {}
+        file_data[:code_smells].each do |smell_data|
+          line = line_numbers.start_line_for_method(smell_data[:method])
+          out[file_data[:file_path]][line.to_s] ||= []
+          out[file_data[:file_path]][line.to_s] << {:type => :reek,
+                                                    :description => "#{smell_data[:type]} - #{smell_data[:message]}"}
+        end
+      end
+    end
+
   end
 end

data/lib/generators/roodi.rb

@@ -23,5 +23,13 @@ module MetricFu
     def to_h
       {:roodi => @roodi_results}
     end
+
+    def per_file_info(out)
+      @matches.each do |match|
+        out[match[:file]] ||= {}
+        out[match[:file]][match[:line]] ||= []
+        out[match[:file]][match[:line]] << {:type => :roodi, :description => match[:problem]}
+      end
+    end
   end
 end

data/lib/generators/saikuro.rb

@@ -4,7 +4,7 @@ module MetricFu
 
     def emit
       options_string = MetricFu.saikuro.inject("") do |options, option|
-        options + "--#{option.join(' ')} " unless option == :input_directory
+        option[0] == :input_directory ? options : options + "--#{option.join(' ')} "
       end
 
       MetricFu.saikuro[:input_directory].each do |input_dir|
@@ -32,14 +32,42 @@ module MetricFu
     def to_h
       files = @files.map do |file|
         my_file = file.to_h
-        my_file[:filename] = file.filename
+
+        f = file.filepath
+        f.gsub!(%r{^#{metric_directory}/}, '')
+        f << "/#{file.filename}"
+
+        my_file[:filename] = f
         my_file
       end
-      {:saikuro => {:files => files,
-                    :classes => @classes.map {|c| c.to_h},
-                    :methods => @meths.map {|m| m.to_h}
-                   }
-      }
+      @saikuro_data = {:files => files,
+                       :classes => @classes.map {|c| c.to_h},
+                       :methods => @meths.map {|m| m.to_h}
+                      }
+      {:saikuro => @saikuro_data}
+    end
+
+    def per_file_info(out)
+      @saikuro_data[:files].each do |file_data|
+        next if File.extname(file_data[:filename]) == '.erb' || !File.exists?(file_data[:filename])
+        begin
+          line_numbers = MetricFu::LineNumbers.new(File.open(file_data[:filename], 'r').read)
+        rescue StandardError => e
+          raise e unless e.message =~ /you shouldn't be able to get here/
+          puts "ruby_parser blew up while trying to parse #{file_path}. You won't have method level Saikuro information for this file."
+          next
+        end
+
+        out[file_data[:filename]] ||= {}
+        file_data[:classes].each do |class_data|
+          class_data[:methods].each do |method_data|
+            line = line_numbers.start_line_for_method(method_data[:name])
+            out[file_data[:filename]][line.to_s] ||= []
+            out[file_data[:filename]][line.to_s] << {:type => :saikuro,
+                                                      :description => "Complexity #{method_data[:complexity]}"}
+          end
+        end
+      end
     end
 
     private
@@ -118,6 +146,10 @@ module MetricFu
       File.basename(@path, '_cyclo.html')
     end
 
+    def filepath
+      File.dirname(@path)
+    end
+
     def to_h
       merge_classes
       {:classes => @elements}

data/lib/generators/stats.rb

@@ -26,8 +26,7 @@ module MetricFu
 
     def remove_noise(output)
       lines = output.split("\n")
-      lines = lines.find_all {|line| line[0].chr != "+" }
-      lines = lines.find_all {|line| line[0].chr != "(" }
+      lines = lines.find_all {|line| line =~ /^\s*[C|]/ }
       lines.shift
       lines
     end

data/lib/metric_fu.rb

@@ -3,6 +3,7 @@ require 'yaml'
 begin
   require 'active_support/core_ext/object/to_json'
   require 'active_support/core_ext/object/blank'
+  require 'active_support/inflector'
 rescue LoadError
   require 'activesupport'
 end

data/lib/templates/awesome/awesome_template.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'syntax/convertors/html'
 
 class AwesomeTemplate < MetricFu::Template
 
@@ -14,6 +15,7 @@ class AwesomeTemplate < MetricFu::Template
     report.each_pair do |section, contents|
       if template_exists?(section)
         create_instance_var(section, contents)
+        create_instance_var(:per_file_data, per_file_data)
         @html = erbify(section)
         html = erbify('layout')
         fn = output_filename(section)
@@ -28,6 +30,39 @@ class AwesomeTemplate < MetricFu::Template
       fn = output_filename('index')
       MetricFu.report.save_output(html, MetricFu.output_directory, fn)
     end
+
+    write_file_data
+  end
+
+  def write_file_data
+    convertor = Syntax::Convertors::HTML.for_syntax('ruby')
+
+    per_file_data.each_pair do |file, lines|
+      data = File.open(file, 'r').readlines
+      fn = "#{file.gsub(%r{/}, '_')}.html"
+
+      out = "<html><head><style>#{inline_css('css/syntax.css')}</style></head><body>"
+      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>"
+        out << "<td valign='top'>"
+        if lines.has_key?((idx + 1).to_s)
+          out << "<ul>"
+          lines[(idx + 1).to_s].each do |problem|
+            out << "<li>#{problem[:description]} &raquo; #{problem[:type]}</li>"
+          end
+          out << "</ul>"
+        else
+          out << "&nbsp;"
+        end
+        out << "</td>"
+        out << "<td valign='top'><a name='line#{idx + 1}'>#{convertor.convert(line)}</a></td>"
+        out << "</tr>"
+      end
+      out << "<table></body></html>"
+
+      MetricFu.report.save_output(out, MetricFu.output_directory, fn)
+    end
   end
 
   def this_directory

data/lib/templates/awesome/css/syntax.css

@@ -0,0 +1,19 @@
+table { background: #fff; color: #000; }
+.ruby .normal { color: #000; }
+.ruby .comment { color: #005; font-style: italic; }
+.ruby .keyword { color: #A44; font-weight: bold; }
+.ruby .method { color: #44f; }
+.ruby .class { color: #b1713d; }
+.ruby .module { color: #050; }
+.ruby .punct { color: #668; font-weight: bold; }
+.ruby .symbol { color: #00f; }
+.ruby .string { color: #4a4; }
+.ruby .char { color: #F07; }
+.ruby .ident { color: #000; }
+.ruby .constant { color: #b1713d; }
+.ruby .regex { color: #B66; background: #FEF; }
+.ruby .number { color: #F99; }
+.ruby .attribute { color: #f84; }
+.ruby .global { color: #7FB; }
+.ruby .expr { color: #227; }
+.ruby .escape { color: #277; }

data/lib/templates/awesome/hotspots.html.erb

@@ -32,6 +32,14 @@ No Hotspots were found.
        <b>
           <%= display_location(item[:location], nil) %>
         </b>
+        <% if item[:location].file_path %>
+          <% file, line = item[:location].file_path.split(/:/) %>
+          <% if per_file_data[file] %>
+            <small>&laquo;
+              <b><a href="<%= file.gsub(%r{/}, '_') %>.html<%= (line.nil? ? '' : "#line#{line}") %>">annotate</a></b>
+            &raquo;</small>
+          <% end %>
+        <% end %>
         <br/><br/>
         <!-- TODO HOTSPOTS for metric fu nice metric_link method -->
         <% item[:details].each do |metric, info| %>

data/lib/templates/awesome/rails_best_practices.html.erb

@@ -1,6 +1,6 @@
 <h3>Rails Best Practices Results</h3>
 
-<p><a href="http://github.com/flyerhzm/rails_best_practices">rails_best_practices</a> checks quality of rails app files according to ihower’s presentation from Kungfu RailsConf in Shanghai China.</p>
+<p><a href="http://github.com/flyerhzm/rails_best_practices">rails_best_practices</a> is a code metric tool for rails projects.</p>
 
 <% graph_name = 'rails_best_practices' %>
 <% if MetricFu.configuration.graph_engine == :gchart %>

data/spec/base/base_template_spec.rb

@@ -88,6 +88,7 @@ describe MetricFu::Template do
       before(:each) do
         config = mock("configuration")
         config.stub!(:platform).and_return('universal-darwin-9.0')
+        config.stub!(:darwin_txmt_protocol_no_thanks).and_return(false)
         MetricFu.stub!(:configuration).and_return(config)
       end
 
@@ -112,6 +113,22 @@ describe MetricFu::Template do
                          + "/expanded/filename&line=6'>filename:6</a>")
       end
 
+      describe "but no thanks for txtmt" do
+        before(:each) do
+          config = mock("configuration")
+          config.stub!(:platform).and_return('universal-darwin-9.0')
+          config.stub!(:darwin_txmt_protocol_no_thanks).and_return(true)
+          MetricFu.stub!(:configuration).and_return(config)
+          File.should_receive(:expand_path).and_return('filename')
+        end
+
+        it "should return a file protocol link" do
+          name = "filename"
+          result = @template.send(:link_to_filename, name)
+          result.should == "<a href='file://filename'>filename</a>"
+        end
+      end
+
       describe "and given link text" do
         it "should use the submitted link text" do
           File.stub!(:expand_path).with('filename').and_return('/expanded/filename')
@@ -126,6 +143,7 @@ describe MetricFu::Template do
       before(:each) do
         config = mock("configuration")
         config.should_receive(:platform).and_return('other')
+        config.stub!(:darwin_txmt_protocol_no_thanks).and_return(false)
         MetricFu.stub!(:configuration).and_return(config)
         File.should_receive(:expand_path).and_return('filename')
       end
@@ -157,5 +175,3 @@ describe MetricFu::Template do
   end
 
 end
-
-

data/spec/base/report_spec.rb

@@ -34,6 +34,7 @@ describe MetricFu::Report do
       template_class.should_receive(:new).and_return(template_class)
       MetricFu.should_receive(:template_class).and_return(template_class)
       template_class.should_receive(:report=)
+      template_class.should_receive(:per_file_data=)
       template_class.should_receive(:write)
       @report.save_templatized_report
     end
@@ -43,7 +44,13 @@ describe MetricFu::Report do
     it 'should add a passed hash to the report_hash instance variable' do
       report_type = mock('report_type')
       report_type.should_receive(:to_s).and_return('type')
-      report_type.should_receive(:generate_report).and_return({:a => 'b'})
+
+      report_inst = mock('report_inst')
+      report_type.should_receive(:new).and_return(report_inst)
+
+      report_inst.should_receive(:generate_report).and_return({:a => 'b'})
+      report_inst.should_receive(:respond_to?).and_return(false)
+
       MetricFu.should_receive(:const_get).
                with('Type').and_return(report_type)
       report_hash = mock('report_hash')

data/spec/generators/churn_spec.rb

@@ -11,7 +11,7 @@ describe Churn do
 
     it "should be empty on error" do
       churn = MetricFu::Churn.new
-      churn.instance_variable_set(:@output, "fatal: Not a git repository")
+      churn.instance_variable_set(:@output, "Churning requires a subversion or git repo")
       result = churn.analyze
       result.should == [:churn => {}]
     end

data/spec/generators/rails_best_practices_spec.rb

@@ -5,7 +5,7 @@ describe RailsBestPractices do
     it "should gather the raw data" do
       MetricFu::Configuration.run {}
       practices = MetricFu::RailsBestPractices.new
-      practices.should_receive(:`).with("rails_best_practices .")
+      practices.should_receive(:`).with("rails_best_practices --without-color .")
       practices.emit
     end
   end
@@ -34,10 +34,10 @@ describe RailsBestPractices do
       @results[:problems].size.should == 2
       @results[:problems].first.should == { :line => "17",
         :problem => "replace instance variable with local variable",
-        :file => "./app/views/admin/testimonials/_form.html.erb" }
+        :file => "app/views/admin/testimonials/_form.html.erb" }
       @results[:problems][1].should == { :line => "24,45,68,85",
         :problem => "use before_filter for show,edit,update,destroy",
-        :file => "./app/controllers/admin/campaigns_controller.rb" }
+        :file => "app/controllers/admin/campaigns_controller.rb" }
     end
   end
 

data/spec/generators/rcov_spec.rb

@@ -47,12 +47,12 @@ describe MetricFu::Rcov do
 
       it "should know which lines were run" do
         @files["lib/templates/awesome/awesome_template.rb"][:lines].
-              should include({:content=>"   require 'fileutils'", :was_run=>true})
+              should include({:content=>"require 'fileutils'", :was_run=>true})
       end
 
       it "should know which lines NOT were run" do
         @files["lib/templates/awesome/awesome_template.rb"][:lines].
-              should include({:content=>"         if template_exists?(section)", :was_run=>false})
+              should include({:content=>"      if template_exists?(section)", :was_run=>false})
       end
     end
 

data/spec/generators/saikuro_spec.rb

@@ -12,7 +12,7 @@ describe Saikuro do
     end
 
     it "should find the filename of a file" do
-      @output[:saikuro][:files].first[:filename].should == 'users_controller.rb'
+      @output[:saikuro][:files].first[:filename].should == 'app/controllers/users_controller.rb'
     end
 
     it "should find the name of the classes" do
@@ -33,6 +33,22 @@ describe Saikuro do
       @output[:saikuro][:methods].first[:lines].should == 15
     end
   end
+  
+  describe "per_file_info method" do
+    before :all do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      @saikuro = MetricFu::Saikuro.new
+      @saikuro.stub!(:metric_directory).and_return(File.join(File.dirname(__FILE__), "..", "resources", "saikuro"))
+      @saikuro.analyze
+      @output = @saikuro.to_h
+    end
+    
+    it "doesn't try to get information if the file does not exist" do
+      File.should_receive(:exists?).at_least(:once).and_return(false)
+      @saikuro.per_file_info('ignore_me')
+    end
+  end
 
   describe "format_directories method" do
     it "should format the directories" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: metric_fu
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 2
-  - 0
   - 1
-  version: 2.0.1
+  - 0
+  version: 2.1.0
 platform: ruby
 authors: 
 - Jake Scruggs
@@ -24,7 +24,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-13 00:00:00 -06:00
+date: 2011-03-01 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,12 +51,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
         - 2
-        - 2
+        - 3
         - 0
-        version: 2.2.0
+        version: 2.3.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -116,12 +116,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 51
+        hash: 15
         segments: 
         - 0
-        - 3
-        - 16
-        version: 0.3.16
+        - 6
+        - 4
+        version: 0.6.4
   type: :runtime
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
@@ -132,12 +132,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 17
+        hash: 19
         segments: 
         - 0
-        - 2
         - 3
-        version: 0.2.3
+        - 0
+        version: 0.3.0
   type: :runtime
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
@@ -189,9 +189,23 @@ dependencies:
   type: :runtime
   version_requirements: *id010
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: syntax
   prerelease: false
   requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -203,11 +217,11 @@ dependencies:
         - 0
         version: 1.3.0
   type: :development
-  version_requirements: *id011
+  version_requirements: *id012
 - !ruby/object:Gem::Dependency 
   name: test-construct
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -219,11 +233,11 @@ dependencies:
         - 0
         version: 1.2.0
   type: :development
-  version_requirements: *id012
+  version_requirements: *id013
 - !ruby/object:Gem::Dependency 
   name: googlecharts
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
+  requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -233,7 +247,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id013
+  version_requirements: *id014
 description: Code metrics from Flog, Flay, RCov, Saikuro, Churn, Reek, Roodi, Rails' stats task and Rails Best Practices
 email: jake.scruggs@gmail.com
 executables: []
@@ -296,6 +310,7 @@ files:
 - lib/templates/awesome/css/default.css
 - lib/templates/awesome/css/integrity.css
 - lib/templates/awesome/css/reset.css
+- lib/templates/awesome/css/syntax.css
 - lib/templates/awesome/flay.html.erb
 - lib/templates/awesome/flog.html.erb
 - lib/templates/awesome/hotspots.html.erb