p8-metric_fu 0.9.0.2 → 0.9.0.3

data/README

@@ -154,4 +154,4 @@ You can also change the minimum churn count like so:
 
 ****Thanks****
 
-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.
+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, Jacob Kjeldahl, Toby Tripp, Paul Gross, and Chirdeep Shetty for their help and advice.

data/lib/metric_fu/base.rb

@@ -3,15 +3,118 @@ 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 
+  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?
+      configuration.general[:open_in_browser] && PLATFORM['darwin'] && !run_by_cruise_control?
+    end
+    
+    def saikuro
+      configuration.saikuro
+    end
+
+    def reek
+      configuration.reek
+    end    
+
+    def roodi
+      configuration.roodi
+    end
+
+    def run_by_cruise_control?
+      !!ENV['CC_BUILD_ARTIFACTS']
+    end
+
+    def uses_git?
+      File.exist?(".git")      
+    end
+    
+    def uses_svn?
+      File.exist?(".svn")
+    end
+    
+    def can_churn?
+      uses_git? || uses_svn?
+    end
+    
+    def is_rails?
+      File.exist?("config/environment.rb")
+    end
+    
+    def code_dirs
+      dirs = ['lib']
+      dirs << 'app' if is_rails?
+      dirs.sort{|v1, v2| v1.to_s <=> v2.to_s}
+    end
+    
+    def default_metrics
+      metrics = [:coverage, :flog, :flay, :reek, :roodi, :saikuro ]      
+      metrics << :stats if is_rails?
+      # Churning requires a subversion or git repo
+      metrics << :churn if can_churn?
+      metrics.sort{|v1, v2| v1.to_s <=> v2.to_s}
+    end
+    
+  end
+  
+  class Configuration
+    attr_accessor :churn, :coverage, :flay, :flog, :metrics, :reek, :roodi, :saikuro, :general
+    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
+      @general  = { :open_in_browser => true }
+      @churn    =  {}
+      rcov_opts =  ["--sort coverage", "--html", "--exclude /gems/,/Library/,spec"]
+      rcov_opts << "--rails" if MetricFu.is_rails?
+      @coverage = { :test_files => ['test/**/*_test.rb', 'spec/**/*_spec.rb'],
+                    :rcov_opts => rcov_opts }
+      @flay     = { :dirs_to_flay => MetricFu.code_dirs}
+      @flog     = { :dirs_to_flog => MetricFu.code_dirs}
+      @reek     = { :dirs_to_reek => MetricFu.code_dirs}
+      @roodi    = { :dirs_to_roodi => MetricFu.code_dirs}
+      @metrics          = MetricFu.default_metrics
+      @saikuro  = {}
+    end
+    
+    def saikuro=(options)
+      raise "saikuro need to be a Hash" unless options.is_a?(Hash)
+      @saikuro = options
+    end
+  end
 
   module Base
     
@@ -101,83 +204,4 @@ module MetricFu
     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?
-      configuration.general[:open_in_browser] && PLATFORM['darwin'] && !run_by_cruise_control?
-    end
-    
-    def saikuro
-      configuration.saikuro
-    end
-
-    def reek
-      configuration.reek
-    end    
-
-    def roodi
-      configuration.roodi
-    end
-
-    def run_by_cruise_control?
-      !!ENV['CC_BUILD_ARTIFACTS']
-    end
-
-  end
-  
-  class Configuration
-    attr_accessor :churn, :coverage, :flay, :flog, :metrics, :reek, :roodi, :saikuro, :general
-    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
-      @general  = { :open_in_browser => true }
-      @churn    =  {}
-      @coverage = { :test_files => ['test/**/*_test.rb', 'spec/**/*_spec.rb'],
-                    :rcov_opts => ["--sort coverage", "--html", "--rails", "--exclude /gems/,/Library/,spec"] }
-      @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

@@ -9,9 +9,9 @@ module MetricFu
 
     def initialize(options={})
       @base_dir = File.join(MetricFu::BASE_DIRECTORY, template_name)
-      if File.exist?(".git")
+      if MetricFu.uses_git?
         @source_control = Git.new(options[:start_date])
-      elsif File.exist?(".svn")
+      elsif MetricFu.uses_svn?
         @source_control = Svn.new(options[:start_date])
       else
         raise "Churning requires a subversion or git repo"
@@ -35,8 +35,7 @@ module MetricFu
       end
       changes
     end
-
-
+    
     class SourceControl
       def initialize(start_date=nil)
         @start_date = start_date

data/lib/tasks/flog.rake

@@ -47,7 +47,7 @@ begin
       end
 
       desc "Generate and open flog report"
-      if MetricFu::RAILS
+      if MetricFu.is_rails?
         task :all => [:models, :controllers, :helpers, :lib] do
           MetricFu.generate_flog_report
         end

data/lib/tasks/metric_fu.rake

@@ -2,7 +2,7 @@
 MetricFu.metrics.each { |task| import "#{File.dirname(__FILE__)}/#{task}.rake" }
 
 namespace :metrics do
-  if MetricFu::RAILS
+  if MetricFu.is_rails?
 
     desc "Generate coverage, cyclomatic complexity, flog, flay, railroad, reek, roodi, stats and churn reports"
     task :all => MetricFu.metrics

data/lib/tasks/saikuro.rake

@@ -9,7 +9,7 @@ namespace :metrics do
 
     raise "SAIKURO_OPTIONS is now MetricFu::SAIKURO_OPTIONS" if defined?(SAIKURO_OPTIONS)
     options = { :output_directory => SAIKURO_DIR,
-                        :input_directory => MetricFu::CODE_DIRS,
+                        :input_directory => MetricFu.code_dirs,
                         :cyclo => "",
                         :filter_cyclo => "0",
                         :warn_cyclo => "5",

data/spec/config_spec.rb

@@ -19,12 +19,38 @@ describe MetricFu::Configuration do
 
   describe "metrics" do
     it "should be configurable" do
-      MetricFu.metrics.should == [:coverage, :churn, :flog, :flay, :reek, :roodi, :saikuro]
+      MetricFu.metrics.should == [:churn, :coverage, :flay, :flog, :reek, :roodi, :saikuro]
       MetricFu::Configuration.run do |config|
         config.metrics = [:coverage, :flog]
       end
       MetricFu.metrics.should == [:coverage, :flog]
     end
+  end
+  
+  describe "default metrics" do  
+    it "should have :stats for rails projects" do
+      MetricFu.should_receive(:is_rails?).and_return(true)    
+      MetricFu.should_receive(:can_churn?).and_return(false)      
+      MetricFu.default_metrics.should == [:coverage, :flay, :flog, :reek, :roodi, :saikuro, :stats]
+    end
+    
+    it "should have exclude :churn for projects whcih can churn" do
+      MetricFu.should_receive(:is_rails?).and_return(false)    
+      MetricFu.should_receive(:can_churn?).and_return(true)
+      MetricFu.default_metrics.should == [:churn, :coverage, :flay, :flog, :reek, :roodi, :saikuro]
+    end      
+  end  
+  
+  describe "code dirs" do  
+    it "should return code dirs" do
+      MetricFu.should_receive(:is_rails?).and_return(false)
+      MetricFu.code_dirs.should == ['lib']
+    end
+        
+    it "should have 'app' for rails projects" do
+      MetricFu.should_receive(:is_rails?).and_return(true)      
+      MetricFu.code_dirs.should == ['app', 'lib']
+    end 
   end  
   
   describe "churn" do
@@ -46,6 +72,20 @@ describe MetricFu::Configuration do
       end
       MetricFu.coverage[:test_files].should == ['test/**/test_*.rb']
     end
+    
+    it "should have configurable rcov_opts" do
+      MetricFu.coverage[:rcov_opts].should ==  ["--sort coverage", "--html", "--exclude /gems/,/Library/,spec"]
+      MetricFu::Configuration.run do |config|
+        config.coverage[:rcov_opts] =  ["--sort coverage", "--html"]
+      end
+      MetricFu.coverage[:rcov_opts].should ==  ["--sort coverage", "--html"]
+    end
+    
+    it "should have --rails in rcov_opts if it's a rails project" do      
+      MetricFu.should_receive(:is_rails?).at_least(1).and_return(true)
+      MetricFu.configuration.reset
+      MetricFu.coverage[:rcov_opts].should ==  ["--sort coverage", "--html", "--exclude /gems/,/Library/,spec", "--rails"]
+    end   
   end
 
   describe "flay" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: p8-metric_fu
 version: !ruby/object:Gem::Version 
-  version: 0.9.0.2
+  version: 0.9.0.3
 platform: ruby
 authors: 
 - Jake Scruggs