metric_fu 1.3.0 → 1.4.0

data/HISTORY

@@ -1,3 +1,15 @@
+=== MetricFu 1.4.0 / 2010-06-19
+
+* Added support for rails_best_practices gem - Richard Huang
+* Added rails stats graphing -- Josh Cronemeyer
+* Parameterize the filetypes for flay. By default flay supports haml as well as rb and has a plugin ability for other filetypes. - bfabry
+* Support for Flog 2.4.0 line numbers - Dan Mayer
+* Saikuro multi input directory patch - Spencer Dillard and Dan Mayer
+* Can now parse rcov analysis file coming from multiple sources with an rcov :external option in the config. - Tarsoly András
+* Fixed open file handles problem in the Saikuro analyzer - aselder, erebor
+* Fix some problems with the google charts - Chris Griego
+* Stop showing the googlecharts warning if you are not using google charts.
+
 === MetricFu 1.3.0 / 2010-01-26
 
 * Flay can be configured to ignore scores below a threshold (by default it ignores scores less than 100)
@@ -171,7 +183,7 @@
 
 === MetricFu 0.5.1 / 2008-04-25
 
-* Fixed bug with Saikuro report generation
+* Fixed bug with Saikuro report generation - thanks Toby Tripp
 
 === MetricFu 0.5.0 / 2008-04-25
 

data/README

@@ -1 +1,27 @@
 See http://metric-fu.rubyforge.org/ for documentation, or the HISTORY file for a change log.
+
+How to contribute:
+
+1. Fork metric_fu on github.
+2. 'gem install metric_fu --development'  #to get development dependencies
+3. Run the tests ('rake')
+4. Run metric_fu on itself ('rake metrics:all')
+5. Make the changes you want and back them up with tests.
+6. Make sure two important rake tests still run ('rake' and 'rake metrics:all')
+7. Commit and send me a pull request with details as to what has been changed.
+
+Extra Credit:  
+1. Make sure your changes work in 1.8.7, Ruby Enterprise Edition, and 1.9.1 (Hint use 'rvm' to help install multiple rubies)
+2. Post to the Google group explaining what you did and why you did it (I don't merge things in immediately so others might want to use what you've done). 
+3. Update the documentation (web page inside the 'home_page' folder)
+4. Update the History and give yourself credit.
+
+
+The more of the above steps you do the easier it will be for me to merge in which will greatly increase you chances of getting your changes accepted.
+If you want to do something really radical (which will touch over %30 of all the files) you might what to ask the Google group first to see if anyone is interested in your change before you spend a lot of time on it.
+
+Resources:
+Homepage: http://metric-fu.rubyforge.org/
+Github: http://github.com/jscruggs/metric_fu
+Google Group: http://groups.google.com/group/metric_fu
+My Blog: http://jakescruggs.blogspot.com/

data/Rakefile

@@ -1,3 +1,4 @@
+$LOAD_PATH << '.'
 require 'rake'
 require 'rake/rdoctask'
 require 'spec/rake/spectask'
@@ -12,4 +13,4 @@ MetricFu::Configuration.run do |config|
   config.template_class = AwesomeTemplate
 end
  
-task :default => [:"metrics:all"]
+task :default => :spec

data/lib/base/configuration.rb

@@ -8,7 +8,7 @@ module MetricFu
   AVAILABLE_METRICS = [:churn, :flog, :flay, :reek, 
                        :roodi, :saikuro, :rcov]
 
-  AVAILABLE_GRAPHS = [:flog, :flay, :reek, :roodi, :rcov]
+  AVAILABLE_GRAPHS = [:flog, :flay, :reek, :roodi, :rcov, :rails_best_practices]
   AVAILABLE_GRAPH_ENGINES = [:gchart, :bluff]
 
   # The @@configuration class variable holds a global type configuration
@@ -110,7 +110,8 @@ module MetricFu
       set_graphs
       set_code_dirs
       @flay     = { :dirs_to_flay => @code_dirs,
-                    :minimum_score => 100 } 
+                    :minimum_score => 100,
+                    :filetypes => ['rb'] } 
       @flog     = { :dirs_to_flog => @code_dirs  }
       @reek     = { :dirs_to_reek => @code_dirs  }
       @roodi    = { :dirs_to_roodi => @code_dirs }
@@ -132,8 +133,10 @@ module MetricFu
                                    "--no-color",
                                    "--profile",
                                    "--rails",
-                                   "--exclude /gems/,/Library/,/usr/,spec"]}
-
+                                   "--exclude /gems/,/Library/,/usr/,spec"],
+                    :external => nil
+                  }
+      @rails_best_practices = {}
       @file_globs_to_ignore = []
                                    
       @graph_engine = :bluff # can be :bluff or :gchart
@@ -151,14 +154,18 @@ module MetricFu
     # running within rails.
     def set_metrics
       if rails?
-        @metrics = MetricFu::AVAILABLE_METRICS + [:stats]
+        @metrics = MetricFu::AVAILABLE_METRICS + [:stats, :rails_best_practices]
       else
         @metrics = MetricFu::AVAILABLE_METRICS
       end 
     end
     
     def set_graphs
-      @graphs = MetricFu::AVAILABLE_GRAPHS 
+      if rails?
+        @graphs = MetricFu::AVAILABLE_GRAPHS + [:stats]
+      else
+        @graphs = MetricFu::AVAILABLE_GRAPHS 
+      end
     end
 
     # Add the 'app' directory if we're running within rails.

data/lib/base/graph.rb

@@ -13,7 +13,7 @@ module MetricFu
     end
     
     def add(graph_type, graph_engine)
-      grapher_name = graph_type.to_s.capitalize + graph_engine.to_s.capitalize + "Grapher"
+      grapher_name = graph_type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } + graph_engine.to_s.capitalize + "Grapher"
       self.clazz.push MetricFu.const_get(grapher_name).new
     end
     

data/lib/base/report.rb

@@ -50,7 +50,7 @@ module MetricFu
     # @param report_type Hash
     #   The hash to add to the aggregate report_hash
     def add(report_type)
-      clazz = MetricFu.const_get(report_type.to_s.capitalize)
+      clazz = MetricFu.const_get(report_type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase })
       report_hash.merge!(clazz.generate_report)
     end
 

data/lib/generators/flay.rb

@@ -8,7 +8,11 @@ module MetricFu
     end
 
     def emit
-      files_to_flay = MetricFu.flay[:dirs_to_flay].map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      files_to_flay = MetricFu.flay[:dirs_to_flay].map{|dir| 
+        MetricFu.flay[:filetypes].map {|type|
+          Dir[  File.join(dir, "**/*.#{type}") ] 
+        }.flatten
+      }
       files = remove_excluded_files(files_to_flay.flatten)
       mimimum_score_parameter = MetricFu.flay[:minimum_score] ? "--mass #{MetricFu.flay[:minimum_score]} " : ""
       @output = `flay #{mimimum_score_parameter}#{files.join(" ")}`

data/lib/generators/flog.rb

@@ -120,9 +120,13 @@ module MetricFu
     end  
 
     class ScannedMethod
-      attr_accessor :name, :score, :operators
+      attr_accessor :name, :score, :operators, :line
 
       def initialize(name, score, operators = [])
+        if name.match(/\.rb:\d*/)
+          @line = name.match(/\.rb:\d*/).to_s.sub('.rb:','')
+          name = name.match(/\S*/)
+        end
         @name = name
         @score = score.to_f
         @operators = operators
@@ -130,8 +134,9 @@ module MetricFu
 
       def to_h
         {:name => @name,
-         :score => @score,
-         :operators => @operators.map {|o| o.to_h}}
+          :score => @score,
+          :operators => @operators.map {|o| o.to_h},
+          :line => @line}
       end
     end  
   

data/lib/generators/rails_best_practices.rb

@@ -0,0 +1,31 @@
+module MetricFu
+  class RailsBestPractices < Generator
+
+    def self.verify_dependencies!
+      `rails_best_practices --help`
+      raise 'sudo gem install rails_best_practices # if you want the rails_best_practices tasks' unless $?.success?
+    end
+
+    
+    def emit
+      @output = `rails_best_practices .`
+    end
+
+    def analyze
+      @matches = @output.chomp.split("\n").map{|m| m.split(" - ") }
+      total = @matches.pop
+      2.times { @matches.pop } # ignore wiki link
+      @matches.reject! {|array| array.empty? }
+      @matches.map! do |match|
+        file, line = match[0].split(':')
+        problem = match[1]
+        {:file => file, :line => line, :problem => problem}
+      end
+      @rails_best_practices_results = {:total => total, :problems => @matches}
+    end
+
+    def to_h
+      {:rails_best_practices => @rails_best_practices_results}
+    end
+  end
+end

data/lib/generators/rcov.rb

@@ -5,17 +5,6 @@ module MetricFu
   class Rcov < Generator
     NEW_FILE_MARKER =  ("=" * 80) + "\n"
 
-    def self.verify_dependencies!
-      `rcov --help`
-      unless $?.success?
-        if RUBY_PLATFORM =~ /java/
-          raise 'running in jruby - rcov tasks not available'
-        else
-          raise 'sudo gem install rcov # if you want the rcov tasks'
-        end
-      end
-    end
-
     class Line
       attr_accessor :content, :was_run
 
@@ -30,7 +19,7 @@ module MetricFu
     end
 
     def emit
-      begin
+      unless MetricFu.rcov[:external]
         FileUtils.rm_rf(MetricFu::Rcov.metric_directory, :verbose => false)
         Dir.mkdir(MetricFu::Rcov.metric_directory)
         test_files = FileList[*MetricFu.rcov[:test_files]].join(' ')
@@ -38,21 +27,33 @@ module MetricFu
         output = ">> #{MetricFu::Rcov.metric_directory}/rcov.txt"
         puts "** Running the specs/tests in the [#{MetricFu.rcov[:environment]}] environment"
         `RAILS_ENV=#{MetricFu.rcov[:environment]} rcov #{test_files} #{rcov_opts} #{output}`
-      rescue LoadError
-        if RUBY_PLATFORM =~ /java/
-          puts 'running in jruby - rcov tasks not available'
-        else
-          puts 'sudo gem install rcov # if you want the rcov tasks'
-        end
       end
     end
 
 
     def analyze
-      output = File.open(MetricFu::Rcov.metric_directory + '/rcov.txt').read
+      output_file = MetricFu.rcov[:external] ? MetricFu.rcov[:external] : MetricFu::Rcov.metric_directory + '/rcov.txt'
+      output = File.open(output_file).read
       output = output.split(NEW_FILE_MARKER)
-      # Throw away the first entry - it's the execution time etc.
-      output.shift
+      
+      output.shift # Throw away the first entry - it's the execution time etc.
+      
+      files = assemble_files(output)
+
+      @global_total_lines = 0
+      @global_total_lines_run = 0
+      
+      @rcov = add_coverage_percentage(files)
+    end
+
+    def to_h
+      global_percent_run = ((@global_total_lines_run.to_f / @global_total_lines.to_f) * 100)
+      {:rcov => @rcov.merge({:global_percent_run => round_to_tenths(global_percent_run) })}   
+    end
+    
+    private
+    
+    def assemble_files(output)
       files = {}
       output.each_slice(2) {|out| files[out.first.strip] = out.last}
       files.each_pair {|fname, content| files[fname] = content.split("\n") }
@@ -64,12 +65,13 @@ module MetricFu
             line = Line.new(raw_line, true).to_h
           end
         end
+        content.reject! {|line| line[:content].blank? }
         files[fname] = {:lines => content}
       end
-
-      # Calculate the percentage of lines run in each file
-      @global_total_lines = 0
-      @global_total_lines_run = 0
+      files
+    end
+    
+    def add_coverage_percentage(files)
       files.each_pair do |fname, content|
         lines = content[:lines]
         @global_total_lines_run += lines_run = lines.find_all {|line| line[:was_run] == true }.length
@@ -77,12 +79,7 @@ module MetricFu
         percent_run = ((lines_run.to_f / total_lines.to_f) * 100).round
         files[fname][:percent_run] = percent_run 
       end
-      @rcov = files
-    end
-
-    def to_h
-      global_percent_run = ((@global_total_lines_run.to_f / @global_total_lines.to_f) * 100)
-      {:rcov => @rcov.merge({:global_percent_run => round_to_tenths(global_percent_run) })}   
     end
+    
   end
 end

data/lib/generators/roodi.rb

@@ -10,7 +10,8 @@ module MetricFu
     def emit
       files_to_analyze = MetricFu.roodi[:dirs_to_roodi].map{|dir| Dir[File.join(dir, "**/*.rb")] }
       files = remove_excluded_files(files_to_analyze.flatten)
-      @output = `roodi #{files.join(" ")}`
+      config = MetricFu.roodi[:roodi_config] ? "-config=#{MetricFu.roodi[:roodi_config]}" : ""
+      @output = `roodi #{config} #{files.join(" ")}`
     end
 
     def analyze

data/lib/generators/saikuro.rb

@@ -2,20 +2,21 @@ module MetricFu
  
   class Saikuro < Generator
 
-    def emit
-      MetricFu.saikuro[:input_directory] = format_directories
- 
-      options_string = MetricFu.saikuro.inject("") do |options, option|
-        options + "--#{option.join(' ')} "
-      end
- 
-      sh %{saikuro #{options_string}} do |ok, response|
-        unless ok
-          puts "Saikuro failed with exit status: #{response.exitstatus}"
-          exit 1
-        end
-      end
-    end
+    def emit 
+      options_string = MetricFu.saikuro.inject("") do |options, option| 
+        options + "--#{option.join(' ')} " unless option == :input_directory 
+      end 
+      
+      MetricFu.saikuro[:input_directory].each do |input_dir| 
+        options_string += "--input_directory #{input_dir} " 
+      end 
+      sh %{saikuro #{options_string}} do |ok, response| 
+        unless ok 
+          puts "Saikuro failed with exit status: #{response.exitstatus}" 
+          exit 1 
+        end 
+      end 
+    end 
 
     def format_directories
       dirs = MetricFu.saikuro[:input_directory].join(" | ")
@@ -23,36 +24,9 @@ module MetricFu
     end
  
     def analyze
-      @files = []
-      saikuro_results.each do |path|
-        if Saikuro::SFile.is_valid_text_file?(path)
-          file = Saikuro::SFile.new(path)
-          if file
-            @files << file
-          end
-        end
-      end
-      @files = @files.sort_by do |file|
-        file.elements.
-             max {|a,b| a.complexity.to_i <=> b.complexity.to_i}.
-             complexity.to_i
-      end
-      @files.reverse!
-      klasses = []
-      @files.each {|f| klasses << f.elements}
-      klasses.flatten!
-      @classes = klasses.sort_by {|k| k.complexity.to_i}
-      @classes.reverse!
-      meths = []
-      @files.each {|f|
-        f.elements.each {|el|
-          el.defs.each {|defn|
-            defn.name = "#{el.name}##{defn.name}"
-            meths << defn}
-        }
-      }
-      meths = meths.sort_by {|meth| meth.complexity.to_i}
-      @meths = meths.reverse
+      @files = sort_files(assemble_files)
+      @classes = sort_classes(assemble_classes(@files))
+      @meths = sort_methods(assemble_methods(@files))
     end
  
     def to_h
@@ -67,10 +41,54 @@ module MetricFu
                    }
       }
     end
- 
-    def saikuro_results
-      Dir.glob("#{metric_directory}/**/*.html")
+    
+    private
+    def sort_methods(methods)
+      methods.sort_by {|method| method.complexity.to_i}.reverse
+    end
+    
+    def assemble_methods(files)
+      methods = []
+      files.each do |file|
+        file.elements.each do |element|
+          element.defs.each do |defn|
+            defn.name = "#{element.name}##{defn.name}"
+            methods << defn
+          end
+        end
+      end
+      methods
+    end
+    
+    def sort_classes(classes)
+      classes.sort_by {|k| k.complexity.to_i}.reverse
+    end
+    
+    def assemble_classes(files)
+      files.map {|f| f.elements}.flatten
+    end
+    
+    def sort_files(files)
+      files.sort_by do |file|
+        file.elements.
+             max {|a,b| a.complexity.to_i <=> b.complexity.to_i}.
+             complexity.to_i
+      end.reverse
+    end
+    
+    def assemble_files
+      files = []
+      Dir.glob("#{metric_directory}/**/*.html").each do |path|
+        if Saikuro::SFile.is_valid_text_file?(path)
+          file = Saikuro::SFile.new(path)
+          if file
+            files << file
+          end
+        end
+      end
+      files
     end
+    
   end
  
   class Saikuro::SFile
@@ -82,6 +100,8 @@ module MetricFu
       @file_handle = File.open(@path, "r")
       @elements = []
       get_elements
+    ensure
+      @file_handle.close if @file_handle
     end
  
     def self.is_valid_text_file?(path)