metric_fu 4.4.3 → 4.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b6f6cc83dd1f84b3b744197df56b2fa179390c7
-  data.tar.gz: 2059f5c9368c4246db6d724ed18396a0fa891b17
+  metadata.gz: 8e516022008f58e6b2c1a6b80630159b8781a1ba
+  data.tar.gz: 4bdeda9dc9ce45911a0f8bd7685b02b5d2a0b84b
 SHA512:
-  metadata.gz: 07b0c5284d8c083cb8259d529450960aa9a842d2fe835e7daa3428c38190c96b23efbc3d55f4fa39289d4c2bb24deab2b829eeabfde0023d40e9c250664b928a
-  data.tar.gz: 1bc9bf9f893e4f8745b30eec8e508d72245341563d208757b3540511c86ec0b5dfc17e25354027564b78029b76a8dd173366f61f497901b7bea25baa366303e7
+  metadata.gz: ca89e540f54237b18a66282491c3b2e46b5837c9619a9682b8d5e82a2c434f8dd793752d39e9464a94efdb8c2c0eb465d24a56e0bc84287ac6fe1de9ed78b5fd
+  data.tar.gz: 3a339a545cf614a37cfe8b963705e56bc28ffb73c100a4e6ea1b33fc610c9fafdca2f56b8ff5c6d23db4c8f0b6b037712bbb86bbdeed58222759c63e9c1a9e4f

data/.metrics

@@ -15,6 +15,7 @@ $metric_file_loaded = true
 #     rcov.enabled = true
 #     coverage_file = File.expand_path("coverage/rcov/rcov.txt", Dir.pwd)
 #     rcov.external = coverage_file
+#     rcov.activate
 #   end
 #
 #   config.configure_metric(:cane) do |cane|

data/CONTRIBUTORS

@@ -1 +1,2 @@
 George Erickson
+Carlos Fernandez

data/HISTORY.md

@@ -10,7 +10,16 @@ As such, a _Feature_ would map to either major or minor. A _bug fix_ to a patch.
 * Fixes
 * Misc
 
-### MetricFu [4.4.3 / 2013-09-25](https://github.com/metricfu/metric_fu/compare/v4.4.1...v4.4.3)
+### MetricFu [4.4.4 / 2013-09-27](https://github.com/metricfu/metric_fu/compare/v4.4.3...v4.4.4)
+
+* Features
+* Fixes
+  * Update rcov config instructions in README to include call to activate (Carlos Fernandez, #145)
+  * rcov hotspot analyzer (MetricFu::RcovHotspot) now overrides map_strategy instead of map (Carlos Fernandez, #145)
+  * Fix test failures relating to artifact directory missing (Benjamin Fleischer, #144)
+* Misc
+
+### MetricFu [4.4.3 / 2013-09-25](https://github.com/metricfu/metric_fu/compare/v4.4.2...v4.4.3)
 
 * Features
 * Fixes

data/README.md

@@ -121,6 +121,7 @@ in your .metrics file add the below to run pre-generated metrics
         rcov.enabled = true
         coverage_file = File.expand_path("coverage/rcov/rcov.txt", Dir.pwd)
         rcov.external = coverage_file
+        rcov.activate
       end
     end
 

data/checksum/metric_fu-4.4.3.gem.sha512

@@ -0,0 +1 @@
+6d7c86a7231183dc5cf3d13b03fa4174873ffa6202d0b3fa09b485acc0e076951d6c906a99816fa9908fed75fa513cfba1ce29fb3911f881a93fb0922a70ff8f

data/lib/metric_fu/io.rb

@@ -1,13 +1,21 @@
-require 'fileutils'
+MetricFu.lib_require { 'utility' }
 module MetricFu
   module Io
     # TODO: Move this module / functionality elsewhere and make less verbose
     module FileSystem
 
       # TODO: Use a better environmental variable name for the output / artiface dir.  Set to a different default in tests.
+      @default_artifact_dir = 'tmp/metric_fu'
+      def self.default_artifact_dir
+        @default_artifact_dir
+      end
       def self.artifact_dir
-        (ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu')
+        (ENV['CC_BUILD_ARTIFACTS'] || @artifact_dir)
+      end
+      def self.artifact_dir=(artifact_dir)
+        @artifact_dir = artifact_dir
       end
+      self.artifact_dir = default_artifact_dir
 
       module_function
 
@@ -46,7 +54,7 @@ module MetricFu
         # due to behavior differences between ruby 1.8.7 and 1.9.3
         # this is good enough for now
         Array(*dirs).each do |dir|
-          FileUtils.mkdir_p dir
+          MetricFu::Utility.mkdir_p dir
         end
       end
 
@@ -114,7 +122,7 @@ module MetricFu
     def dir_for(path)
       return nil if path.nil?
       pathname = path_relative_to_base(path)
-      FileUtils.mkdir_p(pathname) unless File.directory?(pathname)
+      MetricFu::Utility.mkdir_p(pathname) unless File.directory?(pathname)
       pathname
     end
 

data/lib/metric_fu/metrics/generator.rb

@@ -1,4 +1,4 @@
-require 'fileutils'
+MetricFu.lib_require { 'utility' }
 module MetricFu
 
   # = Generator
@@ -58,7 +58,7 @@ module MetricFu
         MetricFu::Metric.get_metric(metric).run_options[:output_directory] ||
         begin
           metric_directory = MetricFu::Io::FileSystem.scratch_directory(metric)
-          FileUtils.mkdir_p(metric_directory, :verbose => false)
+          MetricFu::Utility.mkdir_p(metric_directory, :verbose => false)
         end
     end
 

data/lib/metric_fu/metrics/rcov/rcov.rb

@@ -1,9 +1,8 @@
-require 'enumerator'
-require 'fileutils'
+MetricFu.lib_require { 'utility' }
 
 module MetricFu
 
-  class RcovGenerator < Generator
+  class RcovGenerator < MetricFu::Generator
     NEW_FILE_MARKER = /^={80}$/.freeze
 
     def self.metric
@@ -39,19 +38,20 @@ module MetricFu
       @command = command
     end
 
+    def reset_output_location
+      MetricFu::Utility.rm_rf(metric_directory, :verbose => false)
+      MetricFu::Utility.mkdir_p(metric_directory)
+    end
+
     def default_command
-      FileUtils.rm_rf(MetricFu::RcovGenerator.metric_directory, :verbose => false)
-      Dir.mkdir(MetricFu::RcovGenerator.metric_directory)
-      output = ">> #{MetricFu::RcovGenerator.metric_directory}/rcov.txt"
+      reset_output_location
       test_files = FileList[*options[:test_files]].join(' ')
       rcov_opts = options[:rcov_opts].join(' ')
-      %Q(RAILS_ENV=#{options[:environment]} rcov #{test_files} #{rcov_opts} #{output})
+      %Q(RAILS_ENV=#{options[:environment]} rcov #{test_files} #{rcov_opts} >> #{default_output_file})
     end
 
-
     def analyze
-      output_file = options[:external] ? options[:external] : MetricFu::RcovGenerator.metric_directory + '/rcov.txt'
-      output = File.open(output_file).read
+      output = load_output
       output = output.split(NEW_FILE_MARKER)
 
       output.shift # Throw away the first entry - it's the execution time etc.
@@ -140,5 +140,22 @@ module MetricFu
       !(options[:external])
     end
 
+    def load_output
+      File.read(output_file)
+    end
+
+    def output_file
+      if run_rcov?
+        default_output_file
+      else
+        options.fetch(:external)
+      end
+    end
+
+    def default_output_file
+      File.join(metric_directory, 'rcov.txt')
+    end
+
+
   end
 end

data/lib/metric_fu/metrics/rcov/rcov_hotspot.rb

@@ -10,7 +10,7 @@ class MetricFu::RcovHotspot < MetricFu::Hotspot
     :rcov
   end
 
-  def map(row)
+  def map_strategy
     :percentage_uncovered
   end
 

data/lib/metric_fu/reporting/templates/awesome/awesome_template.rb

@@ -1,4 +1,3 @@
-require 'fileutils'
 require 'coderay'
 MetricFu.metrics_require { 'base_template' }
 MetricFu.lib_require { 'utility' }

data/lib/metric_fu/utility.rb

@@ -15,6 +15,13 @@ module MetricFu
       end
     end
 
+    def rm_rf(*args)
+      FileUtils.rm_rf(*args)
+    end
+
+    def mkdir_p(*args)
+      FileUtils.mkdir_p(*args)
+    end
 
   end
 end

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = "4.4.3"
+  VERSION = "4.4.4"
 end

data/spec/metric_fu/configuration_spec.rb

@@ -45,17 +45,52 @@ describe MetricFu::Configuration do
     load File.join(MetricFu.metrics_dir, metric, 'init.rb')
   end
 
+  describe '#is_cruise_control_rb? ' do
+
+    before(:each) { get_new_config }
+    describe "when the CC_BUILD_ARTIFACTS env var is not nil" do
+
+      before(:each) do
+        ENV['CC_BUILD_ARTIFACTS'] = 'is set'
+      end
+
+      it 'should return true'  do
+        @config.is_cruise_control_rb?.should be_true
+      end
+
+      after(:each)  do
+        ENV['CC_BUILD_ARTIFACTS'] = nil
+        FileUtils.rm_rf(File.join(MetricFu.root_dir, 'is set'))
+      end
+
+    end
+
+    describe "when the CC_BUILD_ARTIFACTS env var is nil" do
+      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = nil }
+
+      it 'should return false' do
+        @config.is_cruise_control_rb?.should be_false
+      end
+    end
+  end
+
   describe "#reset" do
 
     describe 'when there is a CC_BUILD_ARTIFACTS environment variable' do
 
-      it 'should return the CC_BUILD_ARTIFACTS environment variable' do
+      before do
         ENV['CC_BUILD_ARTIFACTS'] = 'foo'
         @config = MetricFu.configuration
         @config.reset
         MetricFu.configure
+      end
+      it 'should return the CC_BUILD_ARTIFACTS environment variable' do
         compare_paths(base_directory, ENV['CC_BUILD_ARTIFACTS'])
       end
+      after do
+        ENV['CC_BUILD_ARTIFACTS'] = nil
+        FileUtils.rm_rf(File.join(MetricFu.root_dir, 'foo'))
+      end
     end
 
     describe 'when there is no CC_BUILD_ARTIFACTS environment variable' do
@@ -65,7 +100,7 @@ describe MetricFu::Configuration do
         get_new_config
       end
       it 'should return "tmp/metric_fu"' do
-        base_directory.should == "tmp/metric_fu"
+        base_directory.should == MetricFu.artifact_dir
       end
 
       it 'should set @metric_fu_root_directory to the base of the '+
@@ -256,28 +291,6 @@ describe MetricFu::Configuration do
     end
   end
 
-  describe '#is_cruise_control_rb? ' do
-
-    before(:each) { get_new_config }
-    describe "when the CC_BUILD_ARTIFACTS env var is not nil" do
-
-      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = 'is set' }
-
-      it 'should return true'  do
-        @config.is_cruise_control_rb?.should be_true
-      end
-
-    end
-
-    describe "when the CC_BUILD_ARTIFACTS env var is nil" do
-      before(:each) { ENV['CC_BUILD_ARTIFACTS'] = nil }
-
-      it 'should return false' do
-        @config.is_cruise_control_rb?.should be_false
-      end
-    end
-  end
-
   describe '#configure_formatter' do
     before(:each) { get_new_config }
 

data/spec/metric_fu/metrics/generator_spec.rb

@@ -28,12 +28,11 @@ describe MetricFu::Generator do
   end
 
   describe "ConcreteClass#metric_directory" do
-    it "should be 'tmp/metric_fu/scratch/concreteclass'" do
+    it "should be '{artifact_dir}/scratch/concreteclass'" do
       concrete_metric = double('concrete_metric')
       MetricFu::Metric.should_receive(:get_metric).with(:concrete).and_return(concrete_metric)
       concrete_metric.should_receive(:run_options).and_return({})
-      compare_paths(ConcreteClass.metric_directory,
-                    "tmp/metric_fu/scratch/concrete")
+      compare_paths(ConcreteClass.metric_directory, scratch_directory('concrete'))
     end
   end
 

data/spec/metric_fu/metrics/rcov/rcov_hotspot_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+require "metric_fu/metrics/hotspots/analysis/record"
+
+describe MetricFu::RcovHotspot do
+  describe "map" do
+    let(:zero_row) do
+      MetricFu::Record.new({"percentage_uncovered"=>0.0}, nil)
+    end
+
+    let(:non_zero_row) do
+      MetricFu::Record.new({"percentage_uncovered"=>0.75}, nil)
+    end
+
+    it {subject.map(zero_row).should eql(0.0)}
+    it {subject.map(non_zero_row).should eql(0.75)}
+  end
+end

data/spec/metric_fu/metrics/rcov/rcov_spec.rb

@@ -2,10 +2,16 @@ require "spec_helper"
 
 describe MetricFu::RcovGenerator do
 
-  before :each do
-    MetricFu.configuration.configure_metric(:rcov) do |rcov|
-      rcov.enabled = true
+  before do
+    setup_fs
+    MetricFu::Configuration.run do |config|
+      config.configure_metric(:rcov) do |rcov|
+        rcov.enabled = true
+      end
     end
+  end
+
+  before :each do
     @default_options = MetricFu::Metric.get_metric(:rcov).run_options
   end
 
@@ -16,20 +22,19 @@ describe MetricFu::RcovGenerator do
     end
 
     it "should clear out previous output and make output folder" do
-      @rcov.stub(:`)
-      FileUtils.should_receive(:rm_rf).with(MetricFu::RcovGenerator.metric_directory, :verbose => false)
-      Dir.should_receive(:mkdir).with(MetricFu::RcovGenerator.metric_directory)
-      @rcov.emit
+      MetricFu::Utility.should_receive(:rm_rf).with(MetricFu::RcovGenerator.metric_directory, :verbose => false)
+      MetricFu::Utility.should_receive(:mkdir_p).with(MetricFu::RcovGenerator.metric_directory)
+      @rcov.reset_output_location
     end
 
     it "should set the RAILS_ENV" do
+      pending "Making this work with FakeFs"
       next if breaks_when?(MetricFu.configuration.rubinius?)
-      FileUtils.stub(:rm_rf)
-      Dir.stub(:mkdir)
-      options = {:environment => 'metrics'}
+      MetricFu::Utility.should_receive(:rm_rf).with(MetricFu::RcovGenerator.metric_directory, :verbose => false)
+      MetricFu::Utility.should_receive(:mkdir_p).with(MetricFu::RcovGenerator.metric_directory)
+      options = {:environment => 'metrics', :external => nil}
       @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
-      @rcov.should_receive(:`).with(/RAILS_ENV=metrics/)
-      @rcov.emit
+      expect(@rcov.command).to include('RAILS_ENV=metrics')
     end
   end
 
@@ -38,9 +43,7 @@ describe MetricFu::RcovGenerator do
     before :each do
       options = {:external =>  nil}
       @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
-      File.should_receive(:open).
-            with(MetricFu::RcovGenerator.metric_directory + '/rcov.txt').
-            and_return(double("io", :read => RCOV_OUTPUT))
+      @rcov.should_receive(:load_output).and_return(RCOV_OUTPUT)
       @files = @rcov.analyze
     end
 
@@ -74,14 +77,12 @@ describe MetricFu::RcovGenerator do
     end
 
     it "should emit nothing if external configuration option is set" do
-      FileUtils.should_not_receive(:rm_rf)
+      MetricFu::Utility.should_not_receive(:rm_rf)
       @rcov.emit
     end
 
     it "should open the external rcov analysis file" do
-      File.should_receive(:open).
-            with('coverage/rcov.txt').
-            and_return(double("io", :read => RCOV_OUTPUT))
+      @rcov.should_receive(:load_output).and_return(RCOV_OUTPUT)
       @files = @rcov.analyze
     end
 
@@ -179,4 +180,8 @@ lib/templates/standard/standard_template.rb
 
 HERE
 
+  after do
+    cleanup_fs
+  end
+
 end

data/spec/spec_helper.rb

@@ -22,13 +22,13 @@ Dir[MetricFu.root_dir + "/spec/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
   # :suite after/before all specs
-  # :each ever describe block
-  # :all ever it block
+  # :each every describe block
+  # :all every it block
 
   config.order = 'random'
 
   config.after(:suite) do
-    cleanup_test_files
+    cleanup_fs
   end
 
   config.after(:each) do

data/spec/support/suite.rb

@@ -1,13 +1,10 @@
+require 'fileutils'
 def directory(name)
   MetricFu::Io::FileSystem.directory(name)
 end
 
-# TODO these directories shouldn't be written in the first place
-def cleanup_test_files
-  FileUtils.rm_rf(Dir["#{MetricFu.root_dir}/foo"])
-  FileUtils.rm_rf(Dir["#{MetricFu.root_dir}/is set"])
-rescue => e
-  mf_debug "Failed cleaning up test files #{e.inspect}"
+def scratch_directory(name)
+  File.join(MetricFu::Io::FileSystem.artifact_dir, 'scratch', name)
 end
 
 # fakefs doesn't seem to work reliably on non-mri rubies
@@ -20,23 +17,22 @@ rescue NameError, LoadError
   false
 end
 
+def artifact_test_dir
+  @artficat_test_dir ||= File.join(MetricFu::APP_ROOT, 'tmp','metric_fu','test')
+end
+
+MetricFu::Io::FileSystem.artifact_dir = artifact_test_dir
+MetricFu::Io::FileSystem.set_directories
+
 def setup_fs
+  # # Let's shift the output directories so that we don't interfere with
+  # # existing historical metric data.
   if using_fake_filesystem
     FakeFS.activate!
     FakeFS::FileSystem.clone('lib')
     FakeFS::FileSystem.clone('.metrics')
-    FileUtils.mkdir_p(Pathname.pwd.join(directory('base_directory')))
-    FileUtils.mkdir_p(Pathname.pwd.join(directory('output_directory')))
-  else
-    # Have to use the file system, so let's shift the
-    # output directories so that we don't interfere with
-    # existing historical metric data.
-    MetricFu::Io::FileSystem.stub(:directory).with('base_directory').and_return("tmp/metric_fu/test")
-    MetricFu::Io::FileSystem.stub(:directory).with('output_directory').and_return("tmp/metric_fu/test/output")
-    MetricFu::Io::FileSystem.stub(:directory).with('data_directory').and_return("tmp/metric_fu/test/_data")
-    MetricFu::Io::FileSystem.stub(:directory).with('code_dirs').and_return(%w(lib))
-    MetricFu::Io::FileSystem.stub(:directory).with('scratch_directory').and_return('tmp/metric_fu/test/scratch')
   end
+  MetricFu::Io::FileSystem.set_directories
 end
 
 def cleanup_fs
@@ -45,11 +41,6 @@ def cleanup_fs
     FakeFS.deactivate!
   else
     # Not ideal, but workaround for non-mri rubies
-    FileUtils.rm_rf("#{directory('base_directory')}/report.yml")
-    FileUtils.rm_rf(Dir.glob("#{directory('output_directory')}/*.html"))
-    FileUtils.rm_rf(Dir.glob("#{directory('output_directory')}/*.js"))
-    FileUtils.rm_rf("#{directory('data_directory')}/#{Time.now.strftime("%Y%m%d")}.yml")
-    FileUtils.rm_rf(Dir["#{directory('base_directory')}/customdir"])
-    FileUtils.rm_rf("#{directory('base_directory')}/customreport.yml")
+    FileUtils.rm_rf(artifact_test_dir)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metric_fu
 version: !ruby/object:Gem::Version
-  version: 4.4.3
+  version: 4.4.4
 platform: ruby
 authors:
 - Jake Scruggs
@@ -19,7 +19,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-26 00:00:00.000000000 Z
+date: 2013-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -280,6 +280,7 @@ files:
 - checksum/metric_fu-4.4.0.gem.sha512
 - checksum/metric_fu-4.4.1.gem.sha512
 - checksum/metric_fu-4.4.2.gem.sha512
+- checksum/metric_fu-4.4.3.gem.sha512
 - config/roodi_config.yml
 - gem_tasks/build.rake
 - gemfiles/Gemfile.travis
@@ -440,6 +441,7 @@ files:
 - spec/metric_fu/metrics/rails_best_practices/rails_best_practices_grapher_spec.rb
 - spec/metric_fu/metrics/rails_best_practices/rails_best_practices_spec.rb
 - spec/metric_fu/metrics/rcov/rcov_grapher_spec.rb
+- spec/metric_fu/metrics/rcov/rcov_hotspot_spec.rb
 - spec/metric_fu/metrics/rcov/rcov_spec.rb
 - spec/metric_fu/metrics/reek/reek_grapher_spec.rb
 - spec/metric_fu/metrics/reek/reek_spec.rb
@@ -532,6 +534,7 @@ test_files:
 - spec/metric_fu/metrics/rails_best_practices/rails_best_practices_grapher_spec.rb
 - spec/metric_fu/metrics/rails_best_practices/rails_best_practices_spec.rb
 - spec/metric_fu/metrics/rcov/rcov_grapher_spec.rb
+- spec/metric_fu/metrics/rcov/rcov_hotspot_spec.rb
 - spec/metric_fu/metrics/rcov/rcov_spec.rb
 - spec/metric_fu/metrics/reek/reek_grapher_spec.rb
 - spec/metric_fu/metrics/reek/reek_spec.rb