jscruggs-metric_fu 0.8.0 → 0.8.9

data/{History.txt → HISTORY}

@@ -1,3 +1,15 @@
+=== MetricFu 0.8.9 / 2009-1-20
+
+* Thanks to Andre Arko and Petrik de Heus for adding the following features:
+* The source control type is auto-detected for Churn
+* Moved all presentation to templates
+* Wrote specs for all classes
+* Added flay, Reek and Roodi metrics
+* There's now a configuration class (see README for details)
+* Unification of metrics reports
+* Metrics can be generated using one command
+* Adding new metrics reports has been standardized
+
 === MetricFu 0.8.0 / 2008-10-06
 
 * Source Control Churn now supports git (thanks to Erik St Martin)

data/MIT-LICENSE

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

data/Manifest.txt

@@ -7,14 +7,11 @@ Rakefile
 README
 TODO.txt
 lib/metric_fu.rb
+lib/metric_fu/base.rb
+lib/metric_fu/churn.rb
+lib/metric_fu/flay_reporter.rb
 lib/metric_fu/flog_reporter.rb
 lib/metric_fu/md5_tracker.rb
-lib/metric_fu/flog_reporter/base.rb
-lib/metric_fu/flog_reporter/flog_reporter.css
-lib/metric_fu/flog_reporter/generator.rb
-lib/metric_fu/flog_reporter/operator.rb
-lib/metric_fu/flog_reporter/page.rb
-lib/metric_fu/flog_reporter/scanned_method.rb
 lib/metric_fu/saikuro/saikuro.rb
 lib/metric_fu/saikuro/SAIKURO_README
 lib/tasks/churn.rake

data/README

@@ -1,4 +1,4 @@
-Version 0.7.6
+Version 0.8.9
 http://github.com/jscruggs/metric_fu
 
 Metric_fu began its life as a plugin for Rails that generated code metrics reports.  As of version 0.7.0, metric_fu is a gem owing to the excellent work done by Sean Soper.  
@@ -12,7 +12,7 @@ Then in your Rakefile:
 require 'metric_fu'
 
 If you like to vendor gems, you can unpack metric_fu into vendor/gems and require it like so:
-require 'vendor/gems/jscruggs-metric_fu-0.7.6/lib/metric_fu'
+require 'vendor/gems/jscruggs-metric_fu-0.8.9/lib/metric_fu'
 
 then you don't have to install it on every box you run it on.
 
@@ -23,13 +23,13 @@ You must have Rcov and Flog installed to get coverage and flog reports.  Metric_
 ****Usage****
 
 Out of the box metrics provides these tasks:
-rake metrics:all                  
-rake metrics:all_with_migrate     # Useful for continuous integration
+rake metrics:all                  # Generate coverage, cyclomatic complexity, flog, flay, railroad and churn reports
 rake metrics:churn                # Which files change the most
 rake metrics:coverage             # Generate and open coverage report
 rake metrics:coverage:clean       # Delete aggregate coverage data.
 rake metrics:coverage:clobber_do  # Remove rcov products for do
 rake metrics:coverage:do          # RCov task to generate report
+rake metrics:flay                 # Generate code duplication report with flay
 rake metrics:flog:all             # Generate and open flog report
 rake metrics:flog:clean           # Delete aggregate flog data.
 rake metrics:flog:controllers     # Flog code in app/controllers
@@ -37,8 +37,12 @@ rake metrics:flog:custom          # Generate a flog report from specified direct
 rake metrics:flog:helpers         # Flog code in app/helpers
 rake metrics:flog:lib             # Flog code in lib
 rake metrics:flog:models          # Flog code in app/models
+rake metrics:reek                 # A code smell report using Reek
 rake metrics:saikuro              # A cyclomatic complexity report using Saikuro
-rake metrics:stats                # A stats report
+
+Rails projects also have the following tasks:
+
+rake metrics:stats                 # A stats report
 
 See below for more detail on the individual tasks.  It's recommended to use CruiseControl.rb to set up a metrics build.  See the CruiseControl.rb online docs for more info on how to set up cc.rb and, once you've got that figured out, change the cruise_config.rb file inside your project to have these lines:
 
@@ -48,31 +52,77 @@ project.scheduler.polling_interval = 24.hours
 Which will check for updates every 24 hours and run all the metrics rake tasks (migrating your test db first).  The output will be visible from an individual build's detail page.
 
 
+****Notes on configuration****
+
+Metric_fu can be customized to your liking by adding the following to your Rakefile
+
+MetricFu::Configuration.run do |config|
+  #define which metrics you want to use
+  config.metrics          = [:coverage, :flog]
+  config.churn    = { :start_date => lambda{ 3.months.ago } }  
+  config.coverage = { :test_files => ['test/**/test_*.rb'] }
+  config.flog     = { :dirs_to_flog => ['cms/app', 'cms/lib']  }
+  config.flay     = { :dirs_to_flay => ['cms/app', 'cms/lib']  }  
+  config.saikuro  = { "--warn_cyclo" => "3", "--error_cyclo" => "4" }
+end
+
+
 ****Notes on metrics:coverage****
 
 When creating a coverage report, metric_fu runs all the tests in the test folder and specs in spec folder using Rcov.
+You can configure the coverage test files pattern:
+  config.coverage[:test_files] = ['test/**/test_*.rb']
+
+The default value is ['test/**/*_test.rb', 'spec/**/*_spec.rb']
 
 
 ****Notes on metrics:saikuro****
 
-Saikuro is bundled with metric_fu so you don't have to install it.  Look at the SAIKURO_README (or the internet) for more documentation on Saikuro.  If you wish to change the options Saikuro is run with, then set this constant in your Rakefile:
-                  
-MetricFu::SAIKURO_OPTIONS = { "--warn_cyclo" => "3", "--error_cyclo" => "4" }
+Saikuro is bundled with metric_fu so you don't have to install it.  Look at the SAIKURO_README (or the internet) for more documentation on Saikuro.  If you wish to change the options Saikuro is run with, then set this constant in your configuration:
+
+  config.saikuro = { "--warn_cyclo" => "3", "--error_cyclo" => "4" }
+
+config.saikuro is a hash that gets merged with the default options hash.  The above example will set the warn_cyclo to 3 and the error_cyclo to 4 (which is way too low -- it's just an example) instructing Saikuro to flag methods with a higher cyclomatic complexity in it's report.
+
+If you want to have Saikuro look at multiple folders you can put something like this in your configuration:
 
-MetricFu::SAIKURO_OPTIONS is a hash that gets merged with the default options hash.  The above example will set the warn_cyclo to 3 and the error_cyclo to 4 (which is way too low -- it's just an example) instructing Saikuro to flag methods with a higher cyclomatic complexity in it's report.
+  config.saikuro = {"--input_directory" => '"cms/app | cms/lib"'}
 
-If you want to have Saikuro look at multiple folders you can put something like this in your rakefile:
-MetricFu::SAIKURO_OPTIONS = {"--input_directory" => '"cms/app | cms/lib"'}
+
+****Notes on metrics:flay****
+
+Flay analyzes ruby code for structural similarities. 
+You can configure which directories need to be flayed.
+The defaults are 'lib' for non Rails projects and ['app', 'lib'] for Rails projects.
+
+  config.flay[:dirs_to_flay] = ['cms/app', 'cms/lib']
 
 
 ****Notes on metrics:flog****
 
 Flog is another way of measuring complexity (or tortured code as the Flog authors like to put it).  You should check out the awesome, and a little scary, Flog website for more info.
+'rake metrics:flog:custom' allows you to specify a custom set of directories to Flog (in your configuration).
+The defaults are 'lib' for non Rails projects and ['app', 'lib'] for Rails projects.
+
+  config.flog[:dirs_to_flog] = ['cms/app', 'cms/lib']
+
+
+****Notes on metrics:reek****
+
+Reek detects common code smells in ruby code.
+You can configure which directories need to be checked.
+The defaults are 'lib' for non Rails projects and ['app', 'lib'] for Rails projects.
+
+  config.reek[:dirs_to_reek] = ['cms/app', 'cms/lib']
+
 
-'rake metrics:flog:custom' allows you to specify a custom set of directories to Flog (in your rakefile) like so:
+****Notes on metrics:roodi****
 
-MetricFu::DIRECTORIES_TO_FLOG = ['cms/app', 'cms/lib']
+Roodi parses your Ruby code and warns you about design issues you have based on the checks that is has configured.
+You can configure which directories need to be checked.
+The defaults are 'lib' for non Rails projects and ['app', 'lib'] for Rails projects.
 
+    config.roodi[:dirs_to_roodi] = ['cms/app', 'cms/lib']
 
 ****Notes on metrics:stats****
 
@@ -83,15 +133,15 @@ This is just 'rake stats' for Rails put into a file.  On my projects I like to b
 
 Files that change a lot in your project may be bad a sign.  This task uses "svn log" to identify those files and put them in a report.  The default is to start counting changes from the beginning of your project, which might be too far back so you can change like so:
 
-MetricFu::CHURN_OPTIONS = { :start_date => lambda{3.months.ago} }
+  config.churn = { :start_date => lambda{ 3.months.ago } }
 
 The Proc is there because '3.months.ago' only works when after the Rails Environment is loaded (and Rails extends Fixnum) which I didn't want to do every time you run a rake task.
 
 You can also change the minimum churn count like so:
 
-MetricFu::CHURN_OPTIONS = { :minimum_churn_count => 3 }
+  config.churn = { :minimum_churn_count => 3 }
 
 
 ****Thanks****
 
-I'd like to thank the authors of Saikuro, Flog, Rcov, CruiseControl.rb, and Rails for creating such excellent open source products.  Also Sean Soper, Michael Schubert, Kurtis Seebaldt, Toby Tripp, Paul Gross, and Chirdeep Shetty for their help and advice.
+I'd like to thank the authors of Saikuro, Flog, Rcov, CruiseControl.rb, Flay, Reek, Roodi and Rails for creating such excellent open source products.  Also Andre Arko, Petrik de Heus, Sean Soper, Erik St Martin, Andy Gregorowicz, Bastien, Michael Schubert, Kurtis Seebaldt, Toby Tripp, Paul Gross, and Chirdeep Shetty for their help and advice.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require File.join(File.dirname(__FILE__), 'lib', 'metric_fu')
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => [:"metrics:all"]

data/TODO

@@ -0,0 +1,13 @@
+== TODO list
+
+* Color code flog results with scale from: http://jakescruggs.blogspot.com/2008/08/whats-good-flog-score.html
+* Extract functionality from rake files and put under test
+* 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)
+* Integrate MD5 hashing with remainder of reports
+* 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/metric_fu/base.rb

@@ -0,0 +1,159 @@
+require 'erb'
+module MetricFu
+
+  TEMPLATE_DIR = File.join(File.dirname(__FILE__), '..', 'templates')
+  BASE_DIRECTORY = ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu'
+  RAILS = File.exist?("config/environment.rb")
+
+  if RAILS
+    CODE_DIRS = ['app', 'lib']
+    DEFAULT_METRICS = [:coverage, :churn, :flog, :flay, :reek, :roodi, :stats, :saikuro ]
+  else
+    CODE_DIRS = ['lib']
+    DEFAULT_METRICS = [:coverage, :churn, :flog, :flay, :reek, :roodi, :saikuro ]
+  end 
+
+  module Base
+    
+    ######################################################################
+    # Base class for report Generators
+    #
+    class Generator
+
+      def initialize(options={})
+        @base_dir = self.class.metric_dir
+      end
+
+      def self.metric_dir
+        File.join(BASE_DIRECTORY, template_name)        
+      end
+      
+      def self.template_name
+        self.to_s.split('::').last.downcase
+      end      
+
+      def self.generate_report(options={})
+        FileUtils.mkdir_p(metric_dir, :verbose => false) unless File.directory?(metric_dir)
+        self.new(options).generate_report
+      end
+
+      def save_html(content, file='index.html')
+        open("#{@base_dir}/#{file}", "w") do |f|
+          f.puts content
+        end
+      end
+
+      def generate_report
+        save_html(generate_html)
+      end
+
+      def generate_html
+        analyze
+        html = ERB.new(File.read(template_file)).result(binding)
+      end
+      
+      def template_name
+        self.class.template_name
+      end
+
+      def template_file
+        File.join(MetricFu::TEMPLATE_DIR, "#{template_name}.html.erb")
+      end      
+      
+      ########################
+      # Template methods
+      
+      def inline_css(css)
+	      open(File.join(MetricFu::TEMPLATE_DIR, css)) { |f| f.read }      
+      end
+      
+      def link_to_filename(name, line = nil)
+        filename = File.expand_path(name)
+        if PLATFORM['darwin']
+          %{<a href="txmt://open/?url=file://#{filename}&line=#{line}">#{name}</a>}
+        else
+          %{<a href="file://#{filename}">#{name}</a>}
+        end
+      end
+      
+      def cycle(first_value, second_value, iteration)
+        return first_value if iteration % 2 == 0
+        return second_value
+      end      
+    end
+  end
+  
+  class << self
+    # The Configuration instance used to configure the Rails environment
+    def configuration
+      @@configuration ||= Configuration.new
+    end
+
+    def churn
+      configuration.churn
+    end
+
+    def coverage
+      configuration.coverage
+    end
+
+    def flay
+      configuration.flay
+    end
+
+    def flog
+      configuration.flog
+    end
+
+    def metrics
+      configuration.metrics
+    end
+
+    def open_in_browser?
+      PLATFORM['darwin'] && !ENV['CC_BUILD_ARTIFACTS']
+    end
+    
+    def saikuro
+      configuration.saikuro
+    end
+
+    def reek
+      configuration.reek
+    end    
+
+    def roodi
+      configuration.roodi
+    end
+
+  end
+  
+  class Configuration
+    attr_accessor :churn, :coverage, :flay, :flog, :metrics, :reek, :roodi, :saikuro
+    def initialize
+      raise "Use config.churn instead of MetricFu::CHURN_OPTIONS" if defined? ::MetricFu::CHURN_OPTIONS
+      raise "Use config.flog[:dirs_to_flog] instead of MetricFu::DIRECTORIES_TO_FLOG" if defined? ::MetricFu::DIRECTORIES_TO_FLOG
+      raise "Use config.saikuro instead of MetricFu::SAIKURO_OPTIONS" if defined? ::MetricFu::SAIKURO_OPTIONS      
+      reset      
+    end
+    
+    def self.run()  
+      yield MetricFu.configuration
+    end
+    
+    def reset
+      @churn    =  {}
+      @coverage = { :test_files => ['test/**/*_test.rb', 'spec/**/*_spec.rb'] }
+      @flay     = { :dirs_to_flay => CODE_DIRS}
+      @flog     = { :dirs_to_flog => CODE_DIRS}
+      @reek     = { :dirs_to_reek => CODE_DIRS}
+      @roodi    = { :dirs_to_roodi => CODE_DIRS}
+      @metrics          = DEFAULT_METRICS
+      @saikuro  = {}
+    end
+    
+    def saikuro=(options)
+      raise "saikuro need to be a Hash" unless options.is_a?(Hash)
+      @saikuro = options
+    end
+  end
+end

data/lib/metric_fu/churn.rb

@@ -0,0 +1,88 @@
+module MetricFu
+  
+  def self.generate_churn_report
+    Churn.generate_report(MetricFu.churn)
+    system("open #{Churn.metric_dir}/index.html") if open_in_browser?
+  end
+  
+  class Churn < Base::Generator
+
+    def initialize(options={})
+      @base_dir = File.join(MetricFu::BASE_DIRECTORY, template_name)
+      if File.exist?(".git")
+        @source_control = Git.new(options[:start_date])
+      elsif File.exist?(".svn")
+        @source_control = Svn.new(options[:start_date])
+      else
+        raise "Churning requires a subversion or git repo"
+      end
+
+      @minimum_churn_count = options[:minimum_churn_count] || 5
+    end
+
+    def analyze
+      @changes = parse_log_for_changes.reject! {|file, change_count| change_count < @minimum_churn_count}
+    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
+
+      private
+      def require_rails_env
+        # not sure if the following works because active_support might only be in vendor/rails
+        # require 'activesupport'
+        require RAILS_ROOT + '/config/environment'
+      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
+          require_rails_env
+          "--after=#{@start_date.call.strftime('%Y-%m-%d')}"
+        end
+      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
+          require_rails_env
+          "--revision {#{@start_date.call.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
+    end
+
+  end
+end

data/lib/metric_fu/flay.rb

@@ -0,0 +1,17 @@
+module MetricFu
+  
+  def self.generate_flay_report
+    Flay.generate_report
+    system("open #{Flay.metric_dir}/index.html") if open_in_browser?    
+  end
+    
+  class Flay < Base::Generator
+
+    def analyze
+      files_to_flay = MetricFu.flay[:dirs_to_flay].map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      output = `flay #{files_to_flay.join(" ")}`
+      @matches = output.chomp.split("\n\n").map{|m| m.split("\n  ") }
+    end
+
+  end
+end

data/lib/metric_fu/flog.rb

@@ -0,0 +1,129 @@
+module MetricFu
+  
+  def self.generate_flog_report
+    Flog::Generator.generate_report
+    system("open #{Flog::Generator.metric_dir}/index.html") if open_in_browser?  
+  end
+  
+  module Flog
+    class Generator < Base::Generator
+      def generate_report
+        @base_dir = self.class.metric_dir
+        pages = []
+        flog_results.each do |filename|
+          page = Base.parse(open(filename, "r") { |f| f.read })
+          if page
+            page.filename = filename
+            pages << page
+          end
+        end
+        generate_pages(pages)
+      end
+
+      def generate_pages(pages)
+        pages.each do |page|
+          unless MetricFu::MD5Tracker.file_already_counted?(page.filename)
+            generate_page(page)
+          end
+        end      
+        save_html(ERB.new(File.read(template_file)).result(binding))
+      end
+
+      def generate_page(page)
+        save_html(page.to_html, page.path)
+      end
+
+      def flog_results
+        Dir.glob("#{@base_dir}/**/*.txt")
+      end
+      
+      def self.template_name
+        "flog"
+      end
+    end
+
+    SCORE_FORMAT = "%0.2f"
+
+    class Base
+      METHOD_LINE_REGEX = /([A-Za-z]+#.*):\s\((\d+\.\d+)\)/
+      OPERATOR_LINE_REGEX = /\s+(\d+\.\d+):\s(.*)$/
+
+      class << self
+
+        def parse(text)
+          score = text[/\w+ = (\d+\.\d+)/, 1]
+          return nil unless score
+          page = Page.new(score)
+
+          text.each_line do |method_line|
+           if match = method_line.match(METHOD_LINE_REGEX)
+              page.scanned_methods << ScannedMethod.new(match[1], match[2])
+            end
+            
+            if match = method_line.match(OPERATOR_LINE_REGEX)
+              return if page.scanned_methods.empty?
+              page.scanned_methods.last.operators << Operator.new(match[1], match[2])
+            end
+          end
+          page
+        end
+        
+      end
+    end 
+  
+    class Page < MetricFu::Base::Generator
+      attr_accessor :filename, :score, :scanned_methods
+
+      def initialize(score, scanned_methods = [])
+        @score = score.to_f
+        @scanned_methods = scanned_methods
+      end
+
+      def path
+        @path ||= File.basename(filename, ".txt") + '.html'
+      end
+
+      def to_html
+        ERB.new(File.read(template_file)).result(binding)
+      end
+
+      def average_score
+        return 0 if scanned_methods.length == 0
+        sum = 0
+        scanned_methods.each do |m|
+          sum += m.score
+        end
+        sum / scanned_methods.length
+      end
+
+      def highest_score
+        scanned_methods.inject(0) do |highest, m|
+          m.score > highest ? m.score : highest
+        end
+      end
+
+      def template_name
+        'flog_page'
+      end
+    end  
+  
+    class Operator
+      attr_accessor :score, :operator
+
+      def initialize(score, operator)
+        @score = score.to_f
+        @operator = operator
+      end
+    end  
+  
+    class ScannedMethod
+      attr_accessor :name, :score, :operators
+
+      def initialize(name, score, operators = [])
+        @name = name
+        @score = score.to_f
+        @operators = operators
+      end
+    end  
+  end
+end

data/lib/metric_fu/md5_tracker.rb

@@ -9,11 +9,11 @@ module MetricFu
     class << self
       def md5_dir(path_to_file, base_dir)
         File.join(base_dir,
-                  path_to_file.split('/')[0..-2].join('/'))        
+                  path_to_file.split('/')[0..-2].join('/'))
       end
 
       def md5_file(path_to_file, base_dir)
-        File.join(md5_dir(path_to_file, base_dir),    
+        File.join(md5_dir(path_to_file, base_dir),
                   path_to_file.split('/').last.sub(/\.[a-z]+/, '.md5'))
       end
 
@@ -25,17 +25,17 @@ module MetricFu
         f.close
         md5
       end
-      
+
       def file_changed?(path_to_file, base_dir)
         orig_md5_file = md5_file(path_to_file, base_dir)
-        return track(path_to_file, base_dir) unless File.exist?(orig_md5_file)
+        return !!track(path_to_file, base_dir) unless File.exist?(orig_md5_file)
 
         current_md5 = ""
         file = File.open(orig_md5_file, 'r')
         file.each_line { |line| current_md5 << line }
         file.close
         current_md5.chomp!
-        
+
         new_md5 = Digest::MD5.hexdigest(File.read(path_to_file))
         new_md5.chomp!
 
@@ -43,7 +43,7 @@ module MetricFu
 
         return new_md5 != current_md5
       end
-  
+
       def file_already_counted?(path_to_file)
         return @@unchanged_md5s.include?(path_to_file)
       end

data/lib/metric_fu/reek.rb

@@ -0,0 +1,17 @@
+module MetricFu
+  
+  def self.generate_reek_report
+    Reek.generate_report
+    system("open #{Reek.metric_dir}/index.html") if open_in_browser?    
+  end
+    
+  class Reek < Base::Generator
+
+    def analyze
+      files_to_reek = MetricFu.reek[:dirs_to_reek].map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      output = `reek #{files_to_reek.join(" ")}`
+      @matches = output.chomp.split("\n\n").map{|m| m.split("\n") }
+    end
+
+  end
+end