p8-metric_fu 0.8.4.9 → 0.8.4.10

data/README

@@ -47,31 +47,56 @@ 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****
+
+MetricFu::Configuration.run do |config|
+  config.open_in_browser = false # Don't open reports in the browser on a mac
+  config.churn_options    = { :start_date => lambda{ 3.months.ago } }  
+  config.coverage_options = { :test_files => ['test/**/test_*.rb'] }
+  config.flog_options     = { :dirs_to_flog => ['cms/app', 'cms/lib']  }
+  config.flay_options     = { :dirs_to_flay => ['cms/app', 'cms/lib']  }  
+  config.saikuro_options = { "--warn_cyclo" => "3", "--error_cyclo" => "4" }
+  config.open_in_browser = false # Don't open reports in the browser on a mac
+  ...
+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" }
 
-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_options = { "--warn_cyclo" => "3", "--error_cyclo" => "4" }
+
+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.
 
 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"'}
 
+  config.saikuro_options = {"--input_directory" => '"cms/app | cms/lib"'}
 
-****Notes on metrics:flog****
+
+****Notes on metrics:flay****
 
 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 rakefile) like so:
+'rake metrics:flog:custom' allows you to specify a custom set of directories to Flay (in your rakefile) like so:
+
+  config.flay_options[:dirs_to_flay] = ['cms/app', 'cms/lib']
 
-MetricFu::DIRECTORIES_TO_FLOG = ['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 rakefile) like so:
+
+    config.flog_options[:dirs_to_flog] = ['cms/app', 'cms/lib']
 
 
 ****Notes on metrics:stats****
@@ -83,17 +108,13 @@ 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_options = { :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 }
-
-If you use git, then tell churn about it:
-
-MetricFu::CHURN_OPTIONS = {:scm => :git}
+  config.churn_options = { :minimum_churn_count => 3 }
 
 
 ****Thanks****

data/lib/metric_fu/base.rb

@@ -9,15 +9,7 @@ module MetricFu
     CODE_DIRS = ['app', 'lib']
   else
     CODE_DIRS = ['lib']
-  end
-
-  def self.open_in_browser?
-    if defined?(MetricFu::OPEN_IN_BROWSER)
-      PLATFORM['darwin'] && MetricFu::OPEN_IN_BROWSER
-    else
-      PLATFORM['darwin']
-    end
-  end  
+  end 
 
   module Base
     
@@ -81,4 +73,61 @@ module MetricFu
       end      
     end
   end
+  
+  class << self
+    # The Configuration instance used to configure the Rails environment
+    def configuration
+      @@configuration ||= Configuration.new
+    end
+
+    def churn_options
+      configuration.churn_options
+    end
+
+    def coverage_options
+      configuration.coverage_options
+    end
+
+    def flay_options
+      configuration.flay_options
+    end
+
+    def flog_options
+      configuration.flog_options
+    end
+
+    def open_in_browser?
+      PLATFORM['darwin'] && configuration.open_in_browser
+    end
+    
+    def saikuro_options
+      configuration.saikuro_options
+    end
+    
+  end
+  
+  class Configuration
+    attr_accessor :churn_options, :coverage_options, :flay_options, :flog_options, :open_in_browser, :saikuro_options
+    def initialize
+      raise "Use config.churn_options instead of MetricFu::CHURN_OPTIONS" if defined? ::MetricFu::CHURN_OPTIONS
+      raise "Use config.flog_options[:dirs_to_flog] instead of MetricFu::DIRECTORIES_TO_FLOG" if defined? ::MetricFu::DIRECTORIES_TO_FLOG
+      raise "Use config.saikuro_options instead of MetricFu::SAIKURO_OPTIONS" if defined? ::MetricFu::SAIKURO_OPTIONS      
+      reset      
+    end
+    def self.run()  
+      yield MetricFu.configuration
+    end
+    def reset
+      @churn_options =  {}
+      @coverage_options = { :test_files => ['test/**/*_test.rb', 'spec/**/*_spec.rb'] }
+      @flay_options = { :dirs_to_flay => CODE_DIRS}
+      @flog_options = { :dirs_to_flog => CODE_DIRS}
+      @open_in_browser = true
+      @saikuro_options = {}
+    end
+    def saikuro_options=(options)
+      raise "saikuro_options need to be a Hash" unless options.is_a?(Hash)
+      @saikuro_options = options
+    end
+  end
 end

data/lib/metric_fu/churn.rb

@@ -1,8 +1,8 @@
-CHURN_DIR = File.join(MetricFu::BASE_DIRECTORY, 'churn')
-    
 module MetricFu
+  CHURN_DIR = File.join(MetricFu::BASE_DIRECTORY, 'churn')
+  
   def self.generate_churn_report
-    MetricFu::Churn.generate_report(CHURN_DIR, defined?(MetricFu::CHURN_OPTIONS) ? MetricFu::CHURN_OPTIONS : {} )
+    MetricFu::Churn.generate_report(CHURN_DIR, MetricFu.churn_options )
     system("open #{CHURN_DIR}/index.html") if open_in_browser?
   end
   

data/lib/metric_fu/flay.rb

@@ -9,7 +9,7 @@ module MetricFu
   class Flay < Base::Generator
 
     def analyze
-      files_to_flay = MetricFu::CODE_DIRS.map{|dir| Dir[File.join(dir, "**/*.rb")] }
+      files_to_flay = MetricFu.flay_options[: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

data/lib/tasks/coverage.rake

@@ -20,7 +20,7 @@ begin
       desc "RCov task to generate report"
       Rcov::RcovTask.new(:do => :clean) do |t|
         FileUtils.mkdir_p(MetricFu::BASE_DIRECTORY) unless File.directory?(MetricFu::BASE_DIRECTORY)
-        t.test_files = FileList['test/**/*_test.rb', 'spec/**/*_spec.rb']
+        t.test_files = FileList[*MetricFu.coverage_options[:test_files]]
         t.rcov_opts = ["--sort coverage", "--html", "--rails", "--exclude /gems/,/Library/"]
         t.output_dir = COVERAGE_DIR
         # this line is a fix for Rails 2.1 relative loading issues

data/lib/tasks/flog.rake

@@ -39,7 +39,7 @@ begin
 
       desc "Generate a flog report from specified directories"
       task :custom do
-        MetricFu::CODE_DIRS.each { |directory| flog(directory, directory) }
+        MetricFu::flog_options[:dirs_to_flog].each { |directory| flog(directory, directory) }
         MetricFu.generate_flog_report
       end
 

data/spec/base_spec.rb

@@ -47,10 +47,5 @@ describe MetricFu::Base::Generator do
       @generator.template_name.should == 'generator'
     end
   end
-  
-  describe "open_in_browser?" do
-    it "should return the value of PLATFORM['darwin']" do
-      @generator = MetricFu.open_in_browser?.should == PLATFORM['darwin']
-    end
-  end  
+
 end

metadata

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