edouard-metric_fu 1.1.1 → 1.2.0

data/HISTORY

@@ -1,3 +1,44 @@
+=== Edge
+
+* Upgrade Bluff to 0.3.6
+* Add tooltips to graphs
+* Fix `activesupport` deprecation
+* Vendor Saikuro as a gem dependency
+
+=== 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/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|
@@ -150,19 +131,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 +169,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|

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,5 +1,4 @@
 require 'chronic'
-require 'generator'
 module MetricFu
   
   class Churn < Generator

data/lib/generators/flay.rb

@@ -1,4 +1,3 @@
-require 'generator'
 module MetricFu
   
   class Flay < Generator
@@ -10,7 +9,8 @@ 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)
+      @output = `flay #{files.join(" ")}`
     end
 
     def analyze

data/lib/generators/flog.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module MetricFu
 
   class Flog < Generator
@@ -9,17 +11,23 @@ module MetricFu
     end
 
     SCORE_FORMAT = "%0.2f"
-    METHOD_LINE_REGEX = /(\d+\.\d+):\s+([A-Za-z:]+#.*)/
+    METHOD_LINE_REGEX = /\s*(\d+.\d+):\s+([A-Za-z]+(?:#|::).*)/
     OPERATOR_LINE_REGEX = /\s*(\d+\.\d+):\s(.*)$/
 
     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

@@ -6,7 +6,7 @@ module MetricFu
     NEW_FILE_MARKER =  ("=" * 80) + "\n"
 
     def self.verify_dependencies!
-      `flay --help`
+      `rcov --help`
       unless $?.success?
         if RUBY_PLATFORM =~ /java/
           raise 'running in jruby - rcov tasks not available'
@@ -36,7 +36,7 @@ module MetricFu
         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}`
+        `rcov #{test_files} #{rcov_opts} #{output}`
       rescue LoadError
         if RUBY_PLATFORM =~ /java/
           puts 'running in jruby - rcov tasks not available'

data/lib/generators/reek.rb

@@ -10,7 +10,34 @@ module MetricFu
 
     def emit
       files_to_reek = MetricFu.reek[:dirs_to_reek].map{|dir| Dir[File.join(dir, "**/*.rb")] }
-      @output = `reek #{files_to_reek.join(" ")}`
+      files = remove_excluded_files(files_to_reek.flatten)
+      @output = `reek #{files.join(" ")}`
+      @output = massage_for_reek_12 if reek_12?
+    end
+
+    def reek_12?
+      return false if @output.length == 0
+      (@output =~ /^"/) != 0
+    end
+
+    def massage_for_reek_12
+      section_break = ''
+      @output.split("\n").map do |line|
+        case line
+        when /^  /
+          "#{line.gsub(/^  /, '')}\n"
+        else
+          parts = line.split(" -- ")
+          if parts[1].nil?
+            "#{line}\n"
+          else
+            warnings = parts[1].gsub(/ \(.*\):/, ':')
+            result = "#{section_break}\"#{parts[0]}\" -- #{warnings}\n"
+            section_break = "\n"
+            result
+          end
+        end
+      end.join
     end
 
     def analyze

data/lib/generators/roodi.rb

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

data/lib/generators/saikuro.rb

@@ -3,17 +3,13 @@ module MetricFu
   class Saikuro < Generator
 
     def emit
-      relative_path = [File.dirname(__FILE__), '..', '..',
-                       'vendor', 'saikuro', 'saikuro.rb']
-      saikuro = File.expand_path(File.join(relative_path))
- 
       MetricFu.saikuro[:input_directory] = format_directories
  
       options_string = MetricFu.saikuro.inject("") do |options, option|
         options + "--#{option.join(' ')} "
       end
  
-      sh %{ruby "#{saikuro}" #{options_string}} do |ok, response|
+      sh %{saikuro #{options_string}} do |ok, response|
         unless ok
           puts "Saikuro failed with exit status: #{response.exitstatus}"
           exit 1
@@ -120,10 +116,10 @@ module MetricFu
             line = @file_handle.readline
             element = Saikuro::ParsingElement.new(line)
           elsif line.match /END/
-            @elements << element unless element.nil?
+            @elements << element if element
             element = nil
           else
-            element << line
+            element << line if element
           end
         end
       rescue EOFError

data/lib/graphs/engines/bluff.rb

@@ -0,0 +1,86 @@
+require 'active_support'
+
+module MetricFu
+  class Grapher
+    BLUFF_GRAPH_SIZE = "1000x600"
+    BLUFF_DEFAULT_OPTIONS = <<-EOS
+      var g = new Bluff.Line('graph', "#{BLUFF_GRAPH_SIZE}");
+      g.theme_37signals();
+      g.tooltips = true;
+      g.title_font_size = "24px"
+      g.legend_font_size = "12px"
+      g.marker_font_size = "10px"
+    EOS
+  end
+  
+  class FlayBluffGrapher < FlayGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Flay: duplication';
+        g.data('flay', [#{@flay_score.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'flay.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class FlogBluffGrapher < FlogGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Flog: code complexity';
+        g.data('average', [#{@flog_average.join(',')}]);
+        g.data('top 5% average', [#{@top_five_percent_average.join(',')}])
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'flog.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class RcovBluffGrapher < RcovGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Rcov: code coverage';
+        g.data('rcov', [#{@rcov_percent.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'rcov.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class ReekBluffGrapher < ReekGrapher
+    def graph!
+      legend = @reek_count.keys.sort
+      data = ""
+      legend.each do |name|
+        data += "g.data('#{name}', [#{@reek_count[name].join(',')}])\n"
+      end
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Reek: code smells';
+        #{data}
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'reek.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class RoodiBluffGrapher < RoodiGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Roodi: design problems';
+        g.data('roodi', [#{@roodi_count.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'roodi.js'), 'w') {|f| f << content }
+    end
+  end
+end