metric_fu 4.4.4 → 4.5.1

data/spec/metric_fu/metrics/rails_best_practices/rails_best_practices_spec.rb

@@ -25,7 +25,7 @@ describe RailsBestPracticesGenerator do
   describe "to_h method" do
     it "should put things into a hash" do
       MetricFu::Configuration.run {}
-      practices = MetricFu::RailsBestPractices.new
+      practices = MetricFu::RailsBestPracticesGenerator.new
       practices.instance_variable_set(:@rails_best_practices_results, "the_practices")
       practices.to_h[:rails_best_practices].should == "the_practices"
     end

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

@@ -21,7 +21,7 @@ describe RcovGrapher do
   describe "responding to #get_metrics" do
     context "when metrics were not generated" do
       before(:each) do
-        @metrics = YAML::load(File.open("#{resources_path}/yml/metric_missing.yml"))
+        @metrics = FIXTURE.load_metric("metric_missing.yml")
         @date = "1/2"
       end
 
@@ -38,7 +38,7 @@ describe RcovGrapher do
 
     context "when metrics have been generated" do
       before(:each) do
-        @metrics = YAML::load(File.open("#{resources_path}/yml/20090630.yml"))
+        @metrics = FIXTURE.load_metric("20090630.yml")
         @date = "1/2"
       end
 

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

@@ -28,8 +28,6 @@ describe MetricFu::RcovGenerator do
     end
 
     it "should set the RAILS_ENV" do
-      pending "Making this work with FakeFs"
-      next if breaks_when?(MetricFu.configuration.rubinius?)
       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}
@@ -39,7 +37,6 @@ describe MetricFu::RcovGenerator do
   end
 
   describe "with RCOV_OUTPUT fed into" do
-    next if breaks_when?(MetricFu.configuration.rubinius?)
     before :each do
       options = {:external =>  nil}
       @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
@@ -118,7 +115,7 @@ lib/templates/awesome/awesome_template.rb
 
      def write
 !!     # Getting rid of the crap before and after the project name from integrity
-!!     @name = File.basename(Dir.pwd).gsub(/^\w+-|-\w+$/, "")
+!!     @name = File.basename(MetricFu.run_dir).gsub(/^\w+-|-\w+$/, "")
 !!
 !!     # Copy Bluff javascripts to output directory
 !!     Dir[File.join(template_directory, '..', 'javascripts', '*')].each do |f|

data/spec/metric_fu/metrics/reek/reek_grapher_spec.rb

@@ -21,7 +21,7 @@ describe ReekGrapher do
   describe "responding to #get_metrics" do
     context "when metrics were not generated" do
       before(:each) do
-        @metrics = YAML::load(File.open("#{resources_path}/yml/metric_missing.yml"))
+        @metrics = FIXTURE.load_metric("metric_missing.yml")
         @date = "1/2"
       end
 
@@ -38,7 +38,7 @@ describe ReekGrapher do
 
     context "when metrics have been generated" do
       before(:each) do
-        @metrics = YAML::load(File.open("#{resources_path}/yml/20090630.yml"))
+        @metrics = FIXTURE.load_metric("20090630.yml")
         @date = "1/2"
       end
 

data/spec/metric_fu/metrics/reek/reek_spec.rb

@@ -7,7 +7,7 @@ describe MetricFu::ReekGenerator do
       reek = MetricFu::ReekGenerator.new(options)
       files_to_analyze = ['lib/foo.rb','lib/bar.rb']
       reek.stub(:files_to_analyze).and_return(files_to_analyze)
-      reek.should_receive(:`).with(/--config lib\/config\/\*\.reek lib\/foo.rb lib\/bar.rb/).and_return("")
+      reek.should_receive(:run!).with(/--config lib\/config\/\*\.reek lib\/foo.rb lib\/bar.rb/).and_return("")
       reek.emit
     end
   end

data/spec/metric_fu/metrics/roodi/roodi_grapher_spec.rb

@@ -21,7 +21,7 @@ describe RoodiGrapher do
   describe "responding to #get_metrics" do
     context "when metrics were not generated" do
       before(:each) do
-        @metrics = YAML::load(File.open("#{resources_path}/yml/metric_missing.yml"))
+        @metrics = FIXTURE.load_metric("metric_missing.yml")
         @date = "1/2"
       end
 
@@ -38,7 +38,7 @@ describe RoodiGrapher do
 
     context "when metrics have been generated" do
       before(:each) do
-        @metrics = YAML::load(File.open("#{resources_path}/yml/20090630.yml"))
+        @metrics = FIXTURE.load_metric("20090630.yml")
         @date = "1/2"
       end
 

data/spec/metric_fu/metrics/roodi/roodi_spec.rb

@@ -5,15 +5,15 @@ describe MetricFu::RoodiGenerator do
     it "should add config options when present" do
       options = {:roodi_config => 'lib/config/roodi_config.yml', :dirs_to_roodi => []}
       roodi = MetricFu::RoodiGenerator.new(options)
-      roodi.should_receive(:`).with(/-config=lib\/config\/roodi_config\.yml/).and_return("")
+      roodi.should_receive(:run!).with(/-config=lib\/config\/roodi_config\.yml/).and_return("")
       roodi.emit
     end
 
     it "should NOT add config options when NOT present" do
       options = {:dirs_to_roodi => []}
       roodi = MetricFu::RoodiGenerator.new(options)
-      roodi.stub(:`)
-      roodi.should_receive(:`).with(/-config/).never
+      roodi.stub(:run!)
+      roodi.should_receive(:run!).with(/-config/).never
       roodi.emit
     end
   end

data/spec/metric_fu/metrics/saikuro/saikuro_spec.rb

@@ -1,13 +1,19 @@
 require "spec_helper"
 
 describe MetricFu::SaikuroGenerator do
+  STUB_TEST_DATA = lambda do |generator|
+    # set test data dir; ensure it doesn't get cleared
+    def generator.metric_directory
+      FIXTURE.fixtures_path.join("saikuro").to_s
+    end
+    generator.stub(:clear_scratch_files!)
+  end
   describe "to_h method" do
-    before :all do
+    before do
       options = {}
       saikuro = MetricFu::SaikuroGenerator.new(options)
-      def saikuro.metric_directory
-        "#{resources_path}/saikuro"
-      end
+      STUB_TEST_DATA[saikuro]
+
       saikuro.analyze
       @output = saikuro.to_h
     end
@@ -39,15 +45,13 @@ describe MetricFu::SaikuroGenerator do
     before :all do
       options = {}
       @saikuro = MetricFu::SaikuroGenerator.new(options)
-      def @saikuro.metric_directory
-        "#{resources_path}/saikuro"
-      end
+      STUB_TEST_DATA[@saikuro]
       @saikuro.analyze
       @output = @saikuro.to_h
     end
 
     it "doesn't try to get information if the file does not exist" do
-      File.should_receive(:exists?).at_least(:once).and_return(false)
+      @saikuro.should_receive(:file_not_exists?).at_least(:once).and_return(true)
       @saikuro.per_file_info('ignore_me')
     end
   end
@@ -55,8 +59,8 @@ describe MetricFu::SaikuroGenerator do
   describe MetricFu::SaikuroScratchFile do
     describe "getting elements from a Saikuro result file" do
      it "should parse nested START/END sections" do
-       path = "#{resources_path}/saikuro_sfiles/thing.rb_cyclo.html"
-        sfile = MetricFu::SaikuroScratchFile.new path
+       path = FIXTURE.fixtures_path.join("saikuro_sfiles", "thing.rb_cyclo.html").to_s
+       sfile = MetricFu::SaikuroScratchFile.new path
        sfile.elements.map { |e| e.complexity }.sort.should eql(["0","0","2"])
       end
     end

data/spec/metric_fu/metrics/stats/stats_grapher_spec.rb

@@ -23,7 +23,7 @@ describe StatsGrapher do
   describe "responding to #get_metrics" do
     context "when metrics were not generated" do
       before(:each) do
-        @metrics = YAML::load(File.open("#{resources_path}/yml/metric_missing.yml"))
+        @metrics = FIXTURE.load_metric("metric_missing.yml")
         @date = "01022003"
       end
 
@@ -45,7 +45,7 @@ describe StatsGrapher do
 
     context "when metrics have been generated" do
       before(:each) do
-        @metrics = YAML::load(File.open("#{resources_path}/yml/20090630.yml"))
+        @metrics = FIXTURE.load_metric("20090630.yml")
         @date = "01022003"
       end
 

data/spec/metric_fu/reporting/graphs/{engines/bluff_spec.rb → grapher_spec.rb}

@@ -1,18 +1,24 @@
 require "spec_helper"
 
 describe "Bluff graphers responding to #graph!" do
+  before do
+    setup_fs
+  end
+  after do
+    cleanup_fs
+  end
   it "should write chart file" do
     graphs = {}
     available_graphs = MetricFu::Metric.enabled_metrics.select{|m|m.has_graph?}.map(&:name)
     available_graphs.each do |graph|
       grapher_name = graph.to_s.gsub("MetricFu::",'').gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
-      grapher_name =  grapher_name+"BluffGrapher"
+      grapher_name =  grapher_name+"Grapher"
       graphs[graph] = MetricFu.const_get(grapher_name).new
     end
     graphs.each do |key, val|
       val.graph!
       output_dir = File.expand_path(File.join(MetricFu::Io::FileSystem.directory('output_directory')))
-      lambda{ File.open(File.join(output_dir, "#{key.to_s.downcase}.js")) }.should_not raise_error
+      lambda{ File.read(File.join(output_dir, "#{key.to_s.downcase}.js")) }.should_not raise_error
     end
   end
 end

data/spec/{run_spec.rb → metric_fu/run_spec.rb}

@@ -4,10 +4,6 @@ require 'metric_fu/cli/client'
 describe MetricFu do
   let(:helper)  { MetricFu::Cli::Helper.new }
 
-  before(:all) do
-    MetricFu.configuration.configure_graph_engine(:bluff)
-  end
-
   before do
     setup_fs
   end
@@ -43,13 +39,6 @@ describe MetricFu do
 
     end
 
-    it "loads the .metrics file" do
-      # Global only for testing that this file gets loaded
-      $metric_file_loaded = false
-      metric_fu
-      $metric_file_loaded.should be_true
-    end
-
     it "creates a report yaml file" do
       expect { metric_fu }.to create_file("#{base_directory}/report.yml")
     end
@@ -187,14 +176,20 @@ describe MetricFu do
   end
 
   def metric_fu(options = "--no-open")
-    MfDebugger::Logger.capture_output {
+    message = ''
+    out = MfDebugger::Logger.capture_output {
       begin
         argv = Shellwords.shellwords(options)
         MetricFu::Cli::Client.new.run(argv)
-      rescue SystemExit
         # Catch system exit so that it doesn't halt spec.
+      rescue SystemExit => system_exit
+        status =  system_exit.success? ? "SUCCESS" : "FAILURE"
+        message << "#{status} with code #{system_exit.status}: " <<
+          "#{system_exist.message} #{system_exit.backtrace}"
       end
     }
+    STDERR.puts message if message.start_with?('FAILURE')
+    out
   end
 
 end

data/spec/spec_helper.rb

@@ -1,17 +1,27 @@
+require 'rspec/autorun'
+
 if ENV['COVERAGE']
   require 'simplecov'
-  require 'simplecov-rcov-text'
-  SimpleCov.formatter = SimpleCov::Formatter::RcovTextFormatter
+  formatters = [SimpleCov::Formatter::HTMLFormatter]
+  begin
+    puts '[COVERAGE] Running with SimpleCov HTML Formatter'
+    require 'simplecov-rcov-text'
+    formatters << SimpleCov::Formatter::RcovTextFormatter
+    puts '[COVERAGE] Running with SimpleCov Rcov Formatter'
+  rescue LoadError
+    puts '[COVERAGE] SimpleCov Rcov formatter could not be loaded'
+  end
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[ *formatters ]
   SimpleCov.start
 end
 
-require 'rspec/autorun'
 require 'date'
 require 'construct'
 require 'json'
+require 'pry-nav'
 
 # add lib to the load path just like rubygems does
-$:.push File.expand_path("../../lib", __FILE__)
+$:.unshift File.expand_path("../../lib", __FILE__)
 require 'metric_fu'
 include MetricFu
 def mf_log(msg); mf_debug(msg); end
@@ -21,11 +31,26 @@ def mf_log(msg); mf_debug(msg); end
 Dir[MetricFu.root_dir + "/spec/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+  config.filter_run_excluding :slow unless ENV["SLOW_SPECS"]
+  config.fail_fast = ENV.include?('FAIL_FAST')
+  config.order = 'random'
+
   # :suite after/before all specs
   # :each every describe block
   # :all every it block
 
-  config.order = 'random'
+  def run_dir
+    File.expand_path('dummy', File.dirname(__FILE__))
+  end
+
+  config.before(:suite) do
+    MetricFu.run_dir = run_dir
+  end
 
   config.after(:suite) do
     cleanup_fs

data/spec/support/deferred_garbaged_collection.rb

@@ -0,0 +1,34 @@
+class DeferredGarbageCollection
+
+  DEFERRED_GC_THRESHOLD = (ENV['DEFER_GC'] || 15.0).to_f
+
+  @@last_gc_run = Time.now
+
+  def self.start
+    GC.disable if DEFERRED_GC_THRESHOLD > 0
+  end
+
+  def self.reconsider
+    if DEFERRED_GC_THRESHOLD > 0 && Time.now - @@last_gc_run >= DEFERRED_GC_THRESHOLD
+      GC.enable
+      GC.start
+      GC.disable
+      @@last_gc_run = Time.now
+    end
+  end
+
+  def self.configure(config)
+    return if defined?(JRUBY_VERSION)
+    config.before(:all) do
+      DeferredGarbageCollection.start
+    end
+
+    config.after(:all) do
+      DeferredGarbageCollection.reconsider
+    end
+  end
+end
+
+RSpec.configure do |config|
+  DeferredGarbageCollection.configure(config)
+end

data/spec/support/helper_methods.rb

@@ -1,6 +1,6 @@
 def metric_not_activated?(metric_name)
   MetricFu.configuration.configure_metrics
-  if MetricFu::Metric.get_metric(metric_name.intern).activated
+  if MetricFu::Metric.get_metric(metric_name.intern).activate
     false
   else
     p "Skipping #{metric_name} tests, not activated"
@@ -13,20 +13,6 @@ def breaks_when?(bool)
   bool
 end
 
-def read_resource(path_in_resources)
-  File.read("#{resources_path}/#{path_in_resources}")
-end
-
-def metric_data(path_in_resources)
-  metric_path = read_resource("yml/#{path_in_resources}")
-  YAML.load( metric_path )
-end
-
-def resources_path
-  "#{MetricFu.root_dir}/spec/resources"
-  # directory(name)
-end
-
 def compare_paths(path1, path2)
   File.join(MetricFu.root_dir, path1).should == File.join(MetricFu.root_dir, path2)
 end

data/spec/support/suite.rb

@@ -7,40 +7,20 @@ 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
-def using_fake_filesystem
-  return false unless MetricFu.configuration.mri?
-  require 'fakefs/safe'
-  true
-rescue NameError, LoadError
-  warn "Fake filesystem not available"
-  false
-end
-
 def artifact_test_dir
   @artficat_test_dir ||= File.join(MetricFu::APP_ROOT, 'tmp','metric_fu','test')
 end
 
+# Let's shift the output directories so that we don't interfere with
+#   existing historical metric data.
 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')
-  end
+  cleanup_fs
   MetricFu::Io::FileSystem.set_directories
 end
 
 def cleanup_fs
-  if using_fake_filesystem
-    FakeFS::FileSystem.clear
-    FakeFS.deactivate!
-  else
-    # Not ideal, but workaround for non-mri rubies
-    FileUtils.rm_rf(artifact_test_dir)
-  end
+  FileUtils.rm_rf(artifact_test_dir)
 end

data/spec/support/test_fixtures.rb

@@ -0,0 +1,39 @@
+require 'pathname'
+class TestFixtures
+
+  attr_reader :fixtures_path
+
+  def initialize
+    @loaded_data = {}
+    @fixtures_path = Pathname(MetricFu.root_dir).join('spec','fixtures')
+  end
+
+  def load_metric(path)
+    retrieve_data(path) do |path|
+       YAML.load_file( fixture_path(path) )
+    end
+  end
+
+  def load_file(path)
+    retrieve_data(path) do |path|
+      File.read( fixture_path(path) )
+    end
+  end
+
+  def fixture_path(path)
+    fixtures_path.join(*Array(path))
+  end
+
+  private
+
+  def retrieve_data(path)
+    @loaded_data.fetch(path) do
+      @loaded_data[path] = yield(path)
+    end
+  end
+
+end
+FIXTURE = TestFixtures.new
+HOTSPOT_DATA = ->(paths) {
+  FIXTURE.load_metric( ['hotspots'].concat(Array(paths)) )
+}