metric_fu 4.11.1 → 4.13.0

data/spec/capture_warnings.rb

@@ -1,15 +1,18 @@
 # https://raw.githubusercontent.com/metric_fu/metric_fu/master/spec/capture_warnings.rb
-require 'rubygems' if RUBY_VERSION =~ /^1\.8/
-require 'bundler/setup'
-require 'rspec/core'
-require 'rspec/expectations'
-require 'tempfile'
-
-stderr_file = Tempfile.new("metric_fu.stderr")
-current_dir = Dir.pwd
+require "rubygems" if RUBY_VERSION =~ /^1\.8/
+require "bundler/setup"
+require "rspec/core"
+require "rspec/expectations"
+require "tempfile"
+require "fileutils"
+
+stderr_file = Tempfile.new("app.stderr")
+app_root ||= Dir.pwd
+output_dir = File.join(app_root, "tmp")
+FileUtils.mkdir_p(output_dir)
+bundle_dir = File.join(app_root, "bundle")
 
 RSpec.configure do |config|
-
   config.before(:suite) do
     $stderr.reopen(stderr_file.path)
     $VERBOSE = true
@@ -22,27 +25,31 @@ RSpec.configure do |config|
 
     $stderr.reopen(STDERR)
 
-    metric_fu_warnings, other_warnings = lines.partition { |line| line.include?(current_dir) }
+    app_warnings, other_warnings = lines.partition { |line|
+      line.include?(app_root) && !line.include?(bundle_dir)
+    }
 
-    if metric_fu_warnings.any?
-      puts
-      puts "-" * 30 + " metric_fu warnings: " + "-" * 30
-      puts
-      puts metric_fu_warnings.join("\n")
-      puts
-      puts "-" * 75
-      puts
+    if app_warnings.any?
+      puts <<-WARNINGS
+#{'-' * 30} app warnings: #{'-' * 30}
+
+#{app_warnings.join("\n")}
+
+#{'-' * 75}
+      WARNINGS
     end
 
     if other_warnings.any?
-      File.open('tmp/warnings.txt', 'w') { |f| f.write(other_warnings.join("\n")) }
+      output_file = File.join(output_dir, "warnings.txt")
+      File.write(output_file, other_warnings.join("\n") << "\n")
       puts
-      puts "Non-metric_fu warnings written to tmp/warnings.txt"
+      puts "Non-app warnings written to tmp/warnings.txt"
       puts
     end
 
     # fail the build...
-    raise "Failing build due to metric_fu warnings" if metric_fu_warnings.any?
+    if app_warnings.any?
+      abort "Failing build due to app warnings: #{app_warnings.inspect}"
+    end
   end
-
 end

data/spec/cli/helper_spec.rb

@@ -1,19 +1,16 @@
-require 'spec_helper'
-require 'metric_fu/cli/helper'
+require "spec_helper"
+require "metric_fu/cli/helper"
 MetricFu.configuration.configure_metric(:rcov) do |rcov|
   rcov.enabled = true
 end
 MetricFu.configure
 
 describe MetricFu::Cli::Helper do
-
   describe "defaults" do
-
     let(:helper)  { MetricFu::Cli::Helper.new }
     let(:defaults) { helper.process_options }
 
     context "on every Ruby version" do
-
       it "opens the report in a browser" do
         expect(defaults[:open]).to be_truthy
       end
@@ -59,12 +56,11 @@ describe MetricFu::Cli::Helper do
 
     if MetricFu.configuration.mri?
 
-        it "enables Rails Best Practices" do
-          expect(defaults[:rails_best_practices]).to be_truthy
-        end
+      it "enables Rails Best Practices" do
+        expect(defaults[:rails_best_practices]).to be_truthy
+      end
 
     end
-
   end
 
   describe ".parse" do
@@ -122,7 +118,6 @@ describe MetricFu::Cli::Helper do
 
     end
 
-
     it "turns hotspots off" do
       expect(helper.process_options(["--no-hotspots"])[:hotspots]).to be_falsey
     end
@@ -155,18 +150,16 @@ describe MetricFu::Cli::Helper do
       expect(helper.process_options(["--roodi"])[:roodi]).to be_truthy
     end
 
-    context 'given a single format' do
+    context "given a single format" do
       it "sets the format" do
-        expect(helper.process_options(["--format", "json"])[:format]).to eq([['json']])
+        expect(helper.process_options(["--format", "json"])[:format]).to eq([["json"]])
       end
     end
 
-    context 'given multiple formats' do
+    context "given multiple formats" do
       it "sets multiple formats" do
-        expect(helper.process_options(["--format", "json", "--format", "yaml"])[:format]).to eq([['json'], ['yaml']])
+        expect(helper.process_options(["--format", "json", "--format", "yaml"])[:format]).to eq([["json"], ["yaml"]])
       end
     end
-
   end
-
 end

data/spec/dummy/lib/bad_encoding.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 class SomeClass
-  def initialize(a,b,c)
+  def initialize(_a, _b, _c)
     "hey, invalid ASCII\xED"
   end
 end

data/spec/fixtures/coverage-153.rb

@@ -3,9 +3,9 @@ class A
   def m(arg1)
     p "this is my method" # Assume that none of the line covered in this method
     if arg1 > 5
-        p 'more than 5'
+      p "more than 5"
     else
-       p 'not more than 5'
+      p "not more than 5"
     end
   end
 end

data/spec/fixtures/coverage.rb

@@ -1,9 +1,9 @@
 class SomeClass
   def method_1
-    1+1
+    1 + 1
   end
 
-  def method_2 ( value )
+  def method_2(value)
     value * value
   end
 

data/spec/metric_fu/calculate_spec.rb

@@ -1,5 +1,5 @@
-require 'spec_helper'
-MetricFu.lib_require { 'calculate' }
+require "spec_helper"
+MetricFu.lib_require { "calculate" }
 
 describe MetricFu::Calculate do
   describe "returns a percent rounded to the nearest integer" do
@@ -15,7 +15,7 @@ describe MetricFu::Calculate do
       }.to raise_error(ArgumentError)
     end
     it "returns 0 when the denominator is 0" do
-      expect(MetricFu::Calculate.integer_percent(3,0)).to eq(0)
+      expect(MetricFu::Calculate.integer_percent(3, 0)).to eq(0)
     end
   end
 end

data/spec/metric_fu/configuration_spec.rb

@@ -1,102 +1,90 @@
 require "spec_helper"
-require 'shared/configured'
+require "shared/configured"
 
 describe MetricFu::Configuration do
-
-it_behaves_like 'configured' do
-
-  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'
+  it_behaves_like "configured" do
+    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
+          expect(@config.is_cruise_control_rb?).to be_truthy
+        end
+
+        after(:each)  do
+          ENV["CC_BUILD_ARTIFACTS"] = nil
+          FileUtils.rm_rf(File.join(MetricFu.root_dir, "is set"))
+        end
       end
 
-      it 'should return true'  do
-        expect(@config.is_cruise_control_rb?).to be_truthy
-      end
+      describe "when the CC_BUILD_ARTIFACTS env var is nil" do
+        before(:each) { ENV["CC_BUILD_ARTIFACTS"] = nil }
 
-      after(:each)  do
-        ENV['CC_BUILD_ARTIFACTS'] = nil
-        FileUtils.rm_rf(File.join(MetricFu.root_dir, 'is set'))
+        it "should return false" do
+          expect(@config.is_cruise_control_rb?).to be_falsey
+        end
       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
-        expect(@config.is_cruise_control_rb?).to be_falsey
+    describe "#reset" do
+      describe "when there is a 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
-    end
-  end
-
-  describe "#reset" do
 
-    describe 'when there is a 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'))
+      describe "when there is no CC_BUILD_ARTIFACTS environment variable" do
+        before(:each) do
+          ENV["CC_BUILD_ARTIFACTS"] = nil
+          get_new_config
+        end
+        it "should return 'tmp/metric_fu'" do
+          expect(base_directory).to eq(MetricFu.artifact_dir)
+        end
+
+        it "should set @metric_fu_root_directory to the base of the "\
+        "metric_fu application" do
+          app_root = File.join(File.dirname(__FILE__), "..", "..")
+          app_root_absolute_path = File.expand_path(app_root)
+          metric_fu_absolute_path = File.expand_path(metric_fu_root)
+          expect(metric_fu_absolute_path).to eq(app_root_absolute_path)
+          expect(MetricFu.root.to_s).to eq(app_root_absolute_path)
+        end
+
+        it "should set @scratch_directory to scratch relative "\
+        "to @base_directory" do
+          scratch_dir = MetricFu.scratch_dir
+          expect(scratch_directory).to eq(scratch_dir)
+        end
+
+        it "should set @output_directory to output relative "\
+        "to @base_directory" do
+          output_dir = MetricFu.output_dir
+          expect(output_directory).to eq(output_dir)
+        end
       end
     end
 
-    describe 'when there is no CC_BUILD_ARTIFACTS environment variable' do
+    describe "#platform" do
+      before(:each) { get_new_config }
 
-      before(:each) do
-        ENV['CC_BUILD_ARTIFACTS'] = nil
-        get_new_config
-      end
-      it 'should return "tmp/metric_fu"' do
-        expect(base_directory).to eq(MetricFu.artifact_dir)
+      it "should return the value of the PLATFORM constant" do
+        this_platform = RUBY_PLATFORM
+        expect(@config.platform).to eq(this_platform)
       end
-
-      it 'should set @metric_fu_root_directory to the base of the '+
-      'metric_fu application' do
-        app_root = File.join(File.dirname(__FILE__), '..', '..')
-        app_root_absolute_path = File.expand_path(app_root)
-        metric_fu_absolute_path = File.expand_path(metric_fu_root)
-        expect(metric_fu_absolute_path).to eq(app_root_absolute_path)
-        expect(MetricFu.root.to_s).to      eq(app_root_absolute_path)
-      end
-
-      it 'should set @scratch_directory to scratch relative '+
-      'to @base_directory' do
-        scratch_dir = MetricFu.scratch_dir
-        expect(scratch_directory).to eq(scratch_dir)
-      end
-
-      it 'should set @output_directory to output relative '+
-      'to @base_directory' do
-        output_dir = MetricFu.output_dir
-        expect(output_directory).to eq(output_dir)
-      end
-
-    end
-
-  end
-
-  describe '#platform' do
-
-    before(:each) { get_new_config }
-
-    it 'should return the value of the PLATFORM constant' do
-      this_platform = RUBY_PLATFORM
-      expect(@config.platform).to eq(this_platform)
     end
   end
-
-end
 end

data/spec/metric_fu/data_structures/line_numbers_spec.rb

@@ -1,9 +1,9 @@
 require "spec_helper"
-MetricFu.data_structures_require { 'line_numbers' }
+MetricFu.data_structures_require { "line_numbers" }
 
 describe MetricFu::LineNumbers do
   FIXTURE_DATA = ->(paths) {
-    FIXTURE.load_file( ['line_numbers'].concat(Array(paths)) )
+    FIXTURE.load_file(["line_numbers"].concat(Array(paths)))
   }
   describe "in_method?" do
     it "should know if a line is NOT in a method" do
@@ -51,7 +51,7 @@ describe MetricFu::LineNumbers do
 
     it "should work with modules" do
       ln = MetricFu::LineNumbers.new(FIXTURE_DATA["module.rb"])
-      expect(ln.method_at_line(4)).to eq('KickAss#get_beat_up?')
+      expect(ln.method_at_line(4)).to eq("KickAss#get_beat_up?")
     end
 
     it "should work with module surrounding class" do
@@ -59,7 +59,5 @@ describe MetricFu::LineNumbers do
       expect(ln.method_at_line(5)).to eq("StuffModule::ThingClass#do_it")
       # ln.method_at_line(12).should == "StuffModule#blah" #why no work?
     end
-
   end
-
 end

data/spec/metric_fu/data_structures/location_spec.rb

@@ -1,8 +1,7 @@
 require "spec_helper"
-MetricFu.data_structures_require { 'location' }
+MetricFu.data_structures_require { "location" }
 
 describe MetricFu::Location do
-
   context "with non-standard Reek method names" do
     # reek reports the method with :: not # on modules like
     # module ApplicationHelper \n def signed_in?, convert it so it records correctly
@@ -13,33 +12,29 @@ describe MetricFu::Location do
     end
 
     it "has method name" do
-      expect(@location.method_name).to eq('ApplicationHelper#section_link')
+      expect(@location.method_name).to eq("ApplicationHelper#section_link")
     end
 
     it "has nil file path" do
-      expect(@location.file_path).to   eq(nil)
+      expect(@location.file_path).to eq(nil)
     end
 
     it "has class name" do
-      expect(@location.class_name).to  eq('ApplicationHelper')
+      expect(@location.class_name).to eq("ApplicationHelper")
     end
-
   end
 
   context "using new" do
-
     before do
       @location = Location.new("lib/foo.rb", "Foo", "Foo#some_method")
     end
 
     it "should return fully qualified method" do
-      expect(@location.method_name).to eq('Foo#some_method')
+      expect(@location.method_name).to eq("Foo#some_method")
     end
-
   end
 
   context "using .for with class" do
-
     before do
       @location = Location.for("Module::Foo")
     end
@@ -53,58 +48,49 @@ describe MetricFu::Location do
     end
 
     it "has class_name" do
-      expect(@location.class_name).to eq('Foo')
+      expect(@location.class_name).to eq("Foo")
     end
-
   end
 
   context "using .for with method" do
-
     before do
       @location = Location.for("Module::Foo#some_method")
     end
 
     it "strips module from class name" do
-      expect(@location.class_name).to eq('Foo')
+      expect(@location.class_name).to eq("Foo")
     end
 
     it "strips module from method name" do
-      expect(@location.method_name).to eq('Foo#some_method')
+      expect(@location.method_name).to eq("Foo#some_method")
     end
 
     it "has nil file_path" do
       expect(@location.file_path).to be nil
     end
-
   end
 
   context "with class method" do
-
     it "provides non-qualified name" do
       location = Location.for("Foo.some_class_method")
-      expect(location.simple_method_name).to eq('.some_class_method')
+      expect(location.simple_method_name).to eq(".some_class_method")
     end
-
   end
 
   context "with instance method" do
-
     it "provides non-qualified name" do
       location = Location.for("Foo#some_class_method")
-      expect(location.simple_method_name).to eq('#some_class_method')
+      expect(location.simple_method_name).to eq("#some_class_method")
     end
-
   end
-    context "testing equality" do
+  context "testing equality" do
     before :each do
-
-      @location1 = MetricFu::Location.get('/some/path','some_class','some_method')
+      @location1 = MetricFu::Location.get("/some/path", "some_class", "some_method")
 
       # ensure that we get a new object
-      @location2 = MetricFu::Location.new('/some/path','some_class','some_method')
+      @location2 = MetricFu::Location.new("/some/path", "some_class", "some_method")
     end
     it "should match two locations with the same paths as equal" do
-
       hsh1 = {}
       hsh1[@location1] = 1
 
@@ -117,12 +103,8 @@ describe MetricFu::Location do
       expect(@location1.eql?(@location2)).to be_truthy
     end
 
-
     it "should produce the same hash value given the same paths" do
-
       expect(@location1.hash).to eq(@location2.hash)
     end
-
   end
-
 end