p8-metric_fu 0.8.4.13 → 0.8.4.14

data/README

@@ -49,11 +49,11 @@ Which will check for updates every 24 hours and run all the metrics rake tasks (
 
 ****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]
-   # Don't open reports in the browser on a mac
-  config.open_in_browser = false
+  config.metrics          = [:coverage, :flog]
   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']  }
@@ -66,39 +66,38 @@ end
 
 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']
+  config.coverage_options[: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:
+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_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:
+If you want to have Saikuro look at multiple folders you can put something like this in your configuration:
 
   config.saikuro_options = {"--input_directory" => '"cms/app | cms/lib"'}
 
 
 ****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 Flay (in your rakefile) like so:
-
+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_options[: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 rakefile) like so:
+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_options[:dirs_to_flog] = ['cms/app', 'cms/lib']
+  config.flog_options[:dirs_to_flog] = ['cms/app', 'cms/lib']
 
 
 ****Notes on metrics:stats****

data/Rakefile

@@ -8,8 +8,4 @@ Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
 end
 
-MetricFu::Configuration.run do |config|
-  config.metrics = [:coverage, :flog, :flay]
-  config.open_in_browser = false
-end
 task :default => [:"metrics:all"]

data/lib/metric_fu/base.rb

@@ -103,7 +103,7 @@ module MetricFu
     end
 
     def open_in_browser?
-      PLATFORM['darwin'] && configuration.open_in_browser
+      PLATFORM['darwin'] && !ENV['CC_BUILD_ARTIFACTS']
     end
     
     def saikuro_options
@@ -113,7 +113,7 @@ module MetricFu
   end
   
   class Configuration
-    attr_accessor :churn_options, :coverage_options, :flay_options, :flog_options, :metrics, :open_in_browser, :saikuro_options
+    attr_accessor :churn_options, :coverage_options, :flay_options, :flog_options, :metrics, :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
@@ -131,7 +131,6 @@ module MetricFu
       @flay_options     = { :dirs_to_flay => CODE_DIRS}
       @flog_options     = { :dirs_to_flog => CODE_DIRS}
       @metrics          = DEFAULT_METRICS
-      @open_in_browser  = true
       @saikuro_options  = {}
     end
     

data/lib/tasks/flog.rake

@@ -4,7 +4,7 @@ begin
     Dir.glob("#{directory}/**/*.rb").each do |filename|
       output_dir = "#{MetricFu::FLOG_DIR}/#{filename.split("/")[0..-2].join("/")}"
       mkdir_p(output_dir, :verbose => false) unless File.directory?(output_dir)
-      puts `flog #{filename} > #{MetricFu::FLOG_DIR}/#{filename.split('.')[0]}.txt` if MetricFu::MD5Tracker.file_changed?(filename, MetricFu::FLOG_DIR)
+      `flog #{filename} > #{MetricFu::FLOG_DIR}/#{filename.split('.')[0]}.txt` if MetricFu::MD5Tracker.file_changed?(filename, MetricFu::FLOG_DIR)
     end
   end
 

data/spec/config_spec.rb

@@ -4,15 +4,15 @@ describe MetricFu::Configuration do
   before do
     MetricFu.configuration.reset
   end
+  after do
+    ENV['CC_BUILD_ARTIFACTS'] = nil
+  end
   describe "open_in_browser" do
-    it "should be configurable" do
+    it "should return false if running in cruise" do
       MetricFu.open_in_browser?.should == !!PLATFORM['darwin']
-      MetricFu::Configuration.run do |config|
-        config.open_in_browser = false
-      end
-      MetricFu.configuration.open_in_browser.should == false
+      ENV['CC_BUILD_ARTIFACTS'] = ''
       MetricFu.open_in_browser?.should == false
-    end
+    end    
   end
 
   describe "metrics" do

metadata

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