nielsm-metric_fu 1.1.1 → 1.3.1

data/HISTORY

@@ -1,3 +1,49 @@
+=== 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)
+* When running Rcov you can configure the RAILS_ENV (defaults to 'test') so running metric_fu doesn't interfere with other environments
+* Changed devver-construct (a gem hosted by GitHub) development dependency to test-construct dependency (on Gemcutter) - Dan Mayer
+* Upgrade Bluff to 0.3.6 and added tooltips to graphs - Édouard Brière
+* Removed Saikuro from vendor and added it as a gem dependency - Édouard Brière
+* Churn has moved outside metric_fu and is now a gem and a dependency - Dan Mayer
+* Fix 'activesupport' deprecation (it should be 'active_support') - Bryan Helmkamp
+* Declared development dependencies
+* Cleaned and sped up specs
+
+=== MetricFu 1.2.0 / 2010-01-09
+
+* ftools isn't supported by 1.9 so moved to fileutils.
+* Overhauled the graphing to use Gruff or Google Charts so we no longer depend on ImageMagick/rmagick -- thanks to Carl Youngblood.
+* Stopped relying on Github gems as they will be going away.
+
+=== MetricFu 1.1.6 / 2009-12-14
+
+* Now compatible with Reek 1.2x thanks to Kevin Rutherford
+* Fixed problem with deleted files still showing up in Flog reports thanks to Dan Mayer
+
+=== MetricFu 1.1.5 / 2009-8-13
+
+* Previous Ruby 1.9 fix was not quite fix-y enough
+
+=== MetricFu 1.1.4 / 2009-7-13
+
+* Fixed another Ruby 1.9x bug
+
+=== MetricFu 1.1.3 / 2009-7-10
+
+* MetricFu is now Ruby 1.9x compatible
+* Removed the check for deprecated ways of configuring metric_fu as the tests were causing Ruby 1.9x problems and it's been forever since they were supported.
+* Removed total flog score from graph (which will always go up and so doesn't mean much) and replacing it with top_five_percent_average which is an average of the worst 5 percent of your methods.
+* Sort Flog by highest score in the class which I feel is more important than the total flog flog score.
+
+=== MetricFu 1.1.2 / 2009-7-09
+
+* Removed dependency on gruff and rmagick (unless the user wants graphs, of course).
+* New look for styling -- Edouard Brière
+* Extra param in rcov call was causing problems -- Stewart Welbourne
+* Preventing rake task from being run multiple times when other rake tasks switch the environment -- Matthew Van Horn
+* Typo in Rcov dependency verification and fixing parsing Saikuro nested information -- Mark Wilden
+
 === MetricFu 1.1.1 / 2009-6-29
 
 * Fix for empty flog files

data/Rakefile

@@ -2,17 +2,14 @@ require 'rake'
 require 'rake/rdoctask'
 require 'spec/rake/spectask'
 require 'lib/metric_fu'
-
+ 
 desc "Run all specs in spec directory"
 Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
-   t.rcov = true
-   t.rcov_opts = ['--exclude', 'spec,config,Library,usr/lib/ruby']
-   t.rcov_dir = File.join(File.dirname(__FILE__), "tmp")
 end
-
+ 
 MetricFu::Configuration.run do |config|
   config.template_class = AwesomeTemplate
 end
-
-task :default => [:"metrics:all"]
+ 
+task :default => :spec

data/TODO

@@ -2,10 +2,6 @@
 
 * Color code flog results with scale from: http://jakescruggs.blogspot.com/2008/08/whats-good-flog-score.html
 * Integrate Flog, Saikuro, and Coverage into one report so you can see methods that have high complexity and low coverage (this is a big one)
-* Move HTML out of code and into templates/
-* Replace #generate_report with #new on each metric class
-* Make each class descend from MetricFu::CodeMetric
-* Generate metrics:* rake tasks for each of CodeMetric's descendants
 * Update flog specs so that they actually run flog
 * Add flay specs that run flay
 * Convert readme to markdown and rename to README.mkdn so github will render it

data/lib/base/base_template.rb

@@ -139,8 +139,7 @@ module MetricFu
     def cycle(first_value, second_value, iteration)
       return first_value if iteration % 2 == 0
       return second_value
-    end      
-    
+    end
 
   end
 end

data/lib/base/configuration.rb

@@ -9,6 +9,7 @@ module MetricFu
                        :roodi, :saikuro, :rcov]
 
   AVAILABLE_GRAPHS = [:flog, :flay, :reek, :roodi, :rcov]
+  AVAILABLE_GRAPH_ENGINES = [:gchart, :bluff]
 
   # The @@configuration class variable holds a global type configuration
   # object for any parts of the system to use.
@@ -51,7 +52,6 @@ module MetricFu
   class Configuration
 
     def initialize #:nodoc:#
-      warn_about_deprecated_config_options
       reset
       add_attr_accessors_to_self
       add_class_methods_to_metric_fu
@@ -82,25 +82,6 @@ module MetricFu
       end
     end
 
-    # Check if certain constants that are deprecated have been
-    # assigned.  If so, warn the user about them, and the 
-    # fact that they will have no effect.
-    def warn_about_deprecated_config_options
-      if defined?(::MetricFu::CHURN_OPTIONS)
-        raise("Use config.churn instead of MetricFu::CHURN_OPTIONS")
-      end
-      if defined?(::MetricFu::DIRECTORIES_TO_FLOG)
-        raise("Use config.flog[:dirs_to_flog] "+
-              "instead of MetricFu::DIRECTORIES_TO_FLOG") 
-      end
-      if defined?(::MetricFu::SAIKURO_OPTIONS)
-        raise("Use config.saikuro instead of MetricFu::SAIKURO_OPTIONS")
-      end
-      if defined?(SAIKURO_OPTIONS)
-        raise("Use config.saikuro instead of SAIKURO_OPTIONS")
-      end
-    end
-
     # This allows us to have a nice syntax like:
     #
     #   MetricFu.run do |config|
@@ -128,7 +109,8 @@ module MetricFu
       set_metrics
       set_graphs
       set_code_dirs
-      @flay     = { :dirs_to_flay => @code_dirs  } 
+      @flay     = { :dirs_to_flay => @code_dirs,
+                    :minimum_score => 100 } 
       @flog     = { :dirs_to_flog => @code_dirs  }
       @reek     = { :dirs_to_reek => @code_dirs  }
       @roodi    = { :dirs_to_roodi => @code_dirs }
@@ -141,7 +123,8 @@ module MetricFu
                     :formater => "text"}
       @churn    = {}
       @stats    = {}
-      @rcov     = { :test_files => ['test/**/*_test.rb', 
+      @rcov     = { :environment => 'test',
+                    :test_files => ['test/**/*_test.rb', 
                                     'spec/**/*_spec.rb'],
                     :rcov_opts => ["--sort coverage", 
                                    "--no-html", 
@@ -150,19 +133,10 @@ module MetricFu
                                    "--profile",
                                    "--rails",
                                    "--exclude /gems/,/Library/,/usr/,spec"]}
+
+      @file_globs_to_ignore = []
                                    
-      @graph_theme = { :colors => %w(orange purple green white red blue pink yellow),
-                       :marker_color => 'blue',
-                       :background_colors => %w(white white)}
-      
-      relative_font_path = [File.dirname(__FILE__), '..', '..', 'vendor', '_fonts', 'monaco.ttf']
-      @graph_font = File.expand_path(File.join(relative_font_path))
-      @graph_size = "1000x400"
-      @graph_title_font_size = 12
-      @graph_legend_box_size = 12
-      @graph_legend_font_size = 10
-      @graph_marker_font_size = 10
-      
+      @graph_engine = :bluff # can be :bluff or :gchart
     end
 
     # Perform a simple check to try and guess if we're running
@@ -197,7 +171,7 @@ module MetricFu
     end
     
     def platform #:nodoc:
-      return PLATFORM
+      return RUBY_PLATFORM
     end
     
     def is_cruise_control_rb?

data/lib/base/generator.rb

@@ -97,6 +97,13 @@ module MetricFu
       self.class.metric_directory
     end
 
+    def remove_excluded_files(paths, globs_to_remove = MetricFu.file_globs_to_ignore)
+      files_to_remove = []
+      globs_to_remove.each do |glob|
+        files_to_remove.concat(Dir[glob])
+      end
+      paths - files_to_remove
+    end
    
     # Defines some hook methods for the concrete classes to hook into.
     %w[emit analyze].each do |meth|
@@ -125,7 +132,8 @@ module MetricFu
     end
 
     def round_to_tenths(decimal)
-      (decimal * 10).round / 10.0 
+      decimal=0.0 if decimal.to_s.eql?('NaN')
+      (decimal.to_i * 10).round / 10.0 
     end
     
     # Allows subclasses to check for required gems

data/lib/base/graph.rb

@@ -12,21 +12,23 @@ module MetricFu
       self.clazz = []
     end
     
-    def add(graph_type)
-      grapher_name = graph_type.to_s.capitalize + "Grapher"
+    def add(graph_type, graph_engine)
+      grapher_name = graph_type.to_s.capitalize + graph_engine.to_s.capitalize + "Grapher"
       self.clazz.push MetricFu.const_get(grapher_name).new
     end
     
     
     def generate
+      return if self.clazz.empty?
       puts "Generating graphs"
       Dir[File.join(MetricFu.data_directory, '*.yml')].sort.each do |metric_file|
         puts "Generating graphs for #{metric_file}"
         date = metric_file.split('/')[3].split('.')[0]
+        y, m, d = date[0..3].to_i, date[4..5].to_i, date[6..7].to_i
         metrics = YAML::load(File.open(metric_file))
         
         self.clazz.each do |grapher|
-          grapher.get_metrics(metrics, date)
+          grapher.get_metrics(metrics, "#{m}/#{d}")
         end
       end
       self.clazz.each do |grapher|

data/lib/base/report.rb

@@ -35,9 +35,9 @@ module MetricFu
 
     # 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 StandardTemplate) and
-    # assigns the report_hash to the report_hash to the template and
-    # asks itself to write itself out.
+    # in your rake file (defaults to the included AwesomeTemplate),
+    # assigns the report_hash to the report_hash in the template, and
+    # tells the template to to write itself out.
     def save_templatized_report
       @template = MetricFu.template_class.new
       @template.report = report_hash

data/lib/generators/churn.rb

@@ -1,91 +1,34 @@
-require 'chronic'
-require 'generator'
 module MetricFu
-  
+
   class Churn < Generator
 
-    
     def initialize(options={})
       super
-      if self.class.git?
-        @source_control = Git.new(MetricFu.churn[:start_date])
-      elsif File.exist?(".svn")
-        @source_control = Svn.new(MetricFu.churn[:start_date])
-      else
-        raise "Churning requires a subversion or git repo"
-      end
-      @minimum_churn_count = MetricFu.churn[:minimum_churn_count] || 5
     end
 
-    def self.git?
-      system("git branch")
+    def self.verify_dependencies!
+      result = `churn --help`
+      raise 'sudo gem install churn # if you want the churn tasks' unless result.match(/churn/)
     end
+
     
     def emit
-      @changes = parse_log_for_changes.reject {|file, change_count| change_count < @minimum_churn_count}
+      @output = `churn --yaml`
+      yaml_start = @output.index("---")
+      @output = @output[yaml_start...@output.length] if yaml_start
     end
 
     def analyze
-      @changes = @changes.to_a.sort {|x,y| y[1] <=> x[1]}
-      @changes = @changes.map {|change| {:file_path => change[0], :times_changed => change[1] }}
-    end
-
-    def to_h
-      {:churn => {:changes => @changes}}
-    end
-
-    private
-
-    def parse_log_for_changes
-      changes = {}
-
-      logs = @source_control.get_logs
-      logs.each do |line|
-        changes[line] ? changes[line] += 1 : changes[line] = 1
-      end
-      changes
-    end
-
-
-    class SourceControl
-      def initialize(start_date=nil)
-        @start_date = start_date
-      end
-    end
-
-    class Git < SourceControl
-      def get_logs
-        `git log #{date_range} --name-only --pretty=format:`.split(/\n/).reject{|line| line == ""}
-      end
-
-      private
-      def date_range
-        if @start_date
-          date = Chronic.parse(@start_date)
-          "--after=#{date.strftime('%Y-%m-%d')}"
-        end
+      if @output.match(/fatal: Not a git repository/)
+        @churn = [:churn => {}]
+      else
+        @churn = YAML::load(@output)
       end
-
     end
 
-    class Svn < SourceControl
-      def get_logs
-        `svn log #{date_range} --verbose`.split(/\n/).map { |line| clean_up_svn_line(line) }.compact
-      end
-
-      private
-      def date_range
-        if @start_date
-          date = Chronic.parse(@start_date)
-          "--revision {#{date.strftime('%Y-%m-%d')}}:{#{Time.now.strftime('%Y-%m-%d')}}"
-        end
-      end
-
-      def clean_up_svn_line(line)
-        m = line.match(/\W*[A,M]\W+(\/.*)\b/)
-        m ? m[1] : nil
-      end
+    def to_h
+      {:churn => @churn[:churn]}
     end
-
   end
+
 end

data/lib/generators/flay.rb

@@ -1,4 +1,3 @@
-require 'generator'
 module MetricFu
   
   class Flay < Generator
@@ -10,7 +9,9 @@ module MetricFu
 
     def emit
       files_to_flay = MetricFu.flay[:dirs_to_flay].map{|dir| Dir[File.join(dir, "**/*.rb")] }
-      @output = `flay #{files_to_flay.join(" ")}`
+      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(" ")}`
     end
 
     def analyze

data/lib/generators/flog.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module MetricFu
 
   class Flog < Generator
@@ -15,11 +17,17 @@ module MetricFu
     def emit
       metric_dir = MetricFu::Flog.metric_directory
       MetricFu.flog[:dirs_to_flog].each do |directory|
-        Dir.glob("#{directory}/**/*.rb").each do |filename|
+        directory = "." if directory=='./'
+        files = Dir.glob("#{directory}/**/*.rb")
+        files = remove_excluded_files(files)
+        files.each do |filename|
           output_dir = "#{metric_dir}/#{filename.split("/")[0..-2].join("/")}"
           mkdir_p(output_dir, :verbose => false) unless File.directory?(output_dir)
-          if MetricFu::MD5Tracker.file_changed?(filename, metric_dir)
-            `flog -ad #{filename} > #{metric_dir}/#{filename.split('.')[0]}.txt`
+          pathname         = Pathname.new(filename)
+          if MetricFu::MD5Tracker.file_changed?(filename, metric_dir) 
+		base_name = pathname.basename.to_s.gsub(/\..*$/,'.txt')
+                editted_filename = File.join(pathname.dirname.to_s, base_name)
+         `flog -ad #{filename} > #{metric_dir}/#{editted_filename}`
           end
         end
       end
@@ -54,7 +62,10 @@ module MetricFu
         page = parse(open(path, "r") { |f| f.read })
         if page
           page.path = path.sub(metric_directory, "").sub(".txt", ".rb") 
-          @pages << page
+          #don't include old cached flog results for files that no longer exist.
+	  if is_file_current?(page.path.to_s)
+            @pages << page
+          end
         end
       end
     end
@@ -62,14 +73,30 @@ module MetricFu
     def to_h
       number_of_methods = @pages.inject(0) {|count, page| count += page.scanned_methods.size}
       total_flog_score = @pages.inject(0) {|total, page| total += page.score}
-      sorted_pages = @pages.sort_by {|page| page.score }.reverse 
+      sorted_pages = @pages.sort_by {|page| page.highest_score }.reverse 
       {:flog => { :total => total_flog_score,
                   :average => average_score(total_flog_score, number_of_methods),
                   :pages => sorted_pages.map {|page| page.to_h}}}
     end
     
     private
-    
+
+    def is_file_current?(pathname)
+      pathname        = pathname.gsub(/^\//,'')
+      local_pathname  = "./#{pathname}"
+      exists = false
+
+      MetricFu.flog[:dirs_to_flog].each do |directory|
+      	directory = "." if directory=='./'
+        files = Dir.glob("#{directory}/**/*.rb")
+        if files.include?(pathname) || files.include?(local_pathname)
+          exists = true
+          break
+        end
+      end
+      exists
+    end
+
     def average_score(total_flog_score, number_of_methods)
       return 0 if total_flog_score == 0
       round_to_tenths(total_flog_score/number_of_methods)

data/lib/generators/rcov.rb

@@ -5,17 +5,6 @@ module MetricFu
   class Rcov < Generator
     NEW_FILE_MARKER =  ("=" * 80) + "\n"
 
-    def self.verify_dependencies!
-      `flay --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,28 +19,38 @@ module MetricFu
     end
 
     def emit
-      begin
-        FileUtils.rm_rf(MetricFu::Rcov.metric_directory, :verbose => false)
-        Dir.mkdir(MetricFu::Rcov.metric_directory)
-        test_files = FileList[*MetricFu.rcov[:test_files]].join(' ')
-        rcov_opts = MetricFu.rcov[:rcov_opts].join(' ')
-        output = ">> #{MetricFu::Rcov.metric_directory}/rcov.txt"
-        `rcov --include-file #{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
+      FileUtils.rm_rf(MetricFu::Rcov.metric_directory, :verbose => false)
+      Dir.mkdir(MetricFu::Rcov.metric_directory)
+      test_files = FileList[*MetricFu.rcov[:test_files]].join(' ')
+      rcov_opts = MetricFu.rcov[:rcov_opts].join(' ')
+      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}`
     end
 
 
     def analyze
       output = File.open(MetricFu::Rcov.metric_directory + '/rcov.txt').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") }
@@ -63,12 +62,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
@@ -76,12 +76,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