rspec-core 2.14.8 → 2.99.0.beta1

data/spec/rspec/core/caller_filter_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'rspec/core/caller_filter'
+
+module RSpec
+  describe CallerFilter do
+    def ruby_files_in_lib(lib)
+      # http://rubular.com/r/HYpUMftlG2
+      path = $LOAD_PATH.find { |p| p.match(/\/rspec-#{lib}(-[a-f0-9]+)?\/lib/) }
+
+      unless path
+        pending "Cannot locate rspec-#{lib} files."
+      end
+
+      Dir["#{path}/**/*.rb"].sort.tap do |files|
+        # Just a sanity check...
+        expect(files.count).to be > 10
+      end
+    end
+
+    describe "the filtering regex" do
+      def unmatched_from(files)
+        files.reject { |file| file.match(CallerFilter::LIB_REGEX) }
+      end
+
+      %w[ core mocks expectations ].each do |lib|
+        it "matches all ruby files in rspec-#{lib}" do
+          files = ruby_files_in_lib(lib)
+
+          files.reject! do |file|
+            # We don't care about this file -- it only has a single require statement
+            # and won't show up in any backtraces.
+            file.end_with?('lib/rspec-expectations.rb') ||
+
+            # This has a single require and a single deprecation, and won't be
+            # in backtraces.
+            file.end_with?('lib/spec/mocks.rb') ||
+
+            # Autotest files are only loaded by the autotest executable
+            # and not by the rspec command and thus won't be in backtraces.
+            file.include?('autotest')
+          end
+
+          expect(unmatched_from files).to eq([])
+        end
+      end
+
+      it "does not match other ruby files" do
+        files = %w[
+          /path/to/lib/rspec/some-extension/foo.rb
+          /path/to/spec/rspec/core/some_spec.rb
+        ]
+
+        expect(unmatched_from files).to eq(files)
+      end
+    end
+  end
+end
+

data/spec/rspec/core/command_line_spec.rb

@@ -13,6 +13,7 @@ module RSpec::Core
     before { config.stub :run_hook }
 
     it "configures streams before command line options" do
+      config.stub(:reporter => double.as_null_object)
       config.stub :load_spec_files
 
       # this is necessary to ensure that color works correctly on windows

data/spec/rspec/core/configuration_options_spec.rb

@@ -231,11 +231,11 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
 
   describe "--fail-fast" do
     it "defaults to false" do
-      expect(parse_options[:fail_fast]).to be_false
+      expect(parse_options[:fail_fast]).to be_falsey
     end
 
     it "sets fail_fast on config" do
-      expect(parse_options("--fail-fast")[:fail_fast]).to be_true
+      expect(parse_options("--fail-fast")[:fail_fast]).to be_truthy
     end
   end
 
@@ -354,11 +354,11 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
       File.open(File.expand_path("~/.rspec"), "w") {|f| f << "--color"}
       with_env_vars 'SPEC_OPTS' => "--debug --example 'foo bar'" do
         options = parse_options("--drb")
-        expect(options[:color]).to be_true
+        expect(options[:color]).to be_truthy
         expect(options[:line_numbers]).to eq(["37"])
-        expect(options[:debug]).to be_true
+        expect(options[:debug]).to be_truthy
         expect(options[:full_description]).to eq([/foo\ bar/])
-        expect(options[:drb]).to be_true
+        expect(options[:drb]).to be_truthy
         expect(options[:formatters]).to eq([['global']])
       end
     end
@@ -404,7 +404,7 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
         File.open("./custom.opts", "w") {|f| f << "--color"}
         options = parse_options("-O", "./custom.opts")
         expect(options[:format]).to be_nil
-        expect(options[:color]).to be_true
+        expect(options[:color]).to be_truthy
       end
 
       it "parses -e 'full spec description'" do

data/spec/rspec/core/configuration_spec.rb

@@ -28,6 +28,81 @@ module RSpec::Core
       end
     end
 
+    shared_examples_for "output_stream" do |attribute|
+      define_method :attribute_value do
+        config.__send__(attribute)
+      end
+
+      update_line = __LINE__ + 2
+      define_method :update_attribute do |value|
+        config.__send__(:"#{attribute}=", value)
+      end
+
+      it 'defaults to standard output' do
+        expect(attribute_value).to eq $stdout
+      end
+
+      it 'is configurable' do
+        io = double 'output io'
+        update_attribute(io)
+        expect(attribute_value).to eq io
+      end
+
+      context 'when the reporter has already been initialized' do
+        before do
+          config.reporter
+          allow(config).to receive(:warn)
+        end
+
+        it 'prints a notice indicating the reconfigured output_stream will be ignored' do
+          update_attribute(StringIO.new)
+          expect(config).to have_received(:warn).with(/output_stream.*#{__FILE__}:#{update_line}/)
+        end
+
+        it 'does not change the value of `output_stream`' do
+          update_attribute(StringIO.new)
+          expect(attribute_value).to eq($stdout)
+        end
+
+        it 'does not print a warning if set to the value it already has' do
+          update_attribute(attribute_value)
+          expect(config).not_to have_received(:warn)
+        end
+      end
+    end
+
+    describe "#output_stream" do
+      include_examples "output_stream", :output_stream
+    end
+
+    describe "#output" do
+      include_examples "output_stream", :output
+
+      specify 'the reader is deprecated' do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /output/)
+        config.output
+      end
+
+      specify 'the writer is deprecated' do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /output=/)
+        config.output = $stdout
+      end
+    end
+
+    describe "#out" do
+      include_examples "output_stream", :out
+
+      specify 'the reader is deprecated' do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /out/)
+        config.out
+      end
+
+      specify 'the writer is deprecated' do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /out=/)
+        config.out = $stdout
+      end
+    end
+
     describe "#setup_load_path_and_require" do
       include_context "isolate load path mutation"
 
@@ -94,12 +169,18 @@ module RSpec::Core
 
     describe "#treat_symbols_as_metadata_keys_with_true_values?" do
       it 'defaults to false' do
-        expect(config.treat_symbols_as_metadata_keys_with_true_values?).to be_false
+        expect(config.treat_symbols_as_metadata_keys_with_true_values?).to be_falsey
+      end
+
+      it 'prints a deprecation warning when explicitly set to false since RSpec 3 will not support that' do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1)
+        config.treat_symbols_as_metadata_keys_with_true_values = false
+        expect(config.treat_symbols_as_metadata_keys_with_true_values?).to be false
       end
 
       it 'can be set to true' do
         config.treat_symbols_as_metadata_keys_with_true_values = true
-        expect(config.treat_symbols_as_metadata_keys_with_true_values?).to be_true
+        expect(config.treat_symbols_as_metadata_keys_with_true_values?).to be_truthy
       end
     end
 
@@ -127,7 +208,7 @@ module RSpec::Core
           mod_config.custom_setting = true
         end
 
-        expect(custom_config.custom_setting).to be_true
+        expect(custom_config.custom_setting).to be_truthy
       end
 
       it "raises if framework module doesn't support configuration" do
@@ -495,6 +576,22 @@ module RSpec::Core
             expect(config.files_to_run).to include("#{dir}/a_bar.rb")
           end
         end
+
+        context "after files have already been loaded" do
+          it 'will warn that it will have no effect' do
+            allow(Kernel).to receive(:warn)
+            config.load_spec_files
+            config.send(setter, "rspec/**/*.spec"); line = __LINE__
+            expect(Kernel).to have_received(:warn).with(/has no effect.*#{__FILE__}:#{line}/)
+          end
+
+          it 'will not warn if reset is called after load_spec_files' do
+            config.load_spec_files
+            config.reset
+            expect(Kernel).to_not receive(:warn)
+            config.send(setter, "rspec/**/*.spec")
+          end
+        end
       end
     end
 
@@ -639,12 +736,12 @@ module RSpec::Core
     describe "#run_all_when_everything_filtered?" do
 
       it "defaults to false" do
-        expect(config.run_all_when_everything_filtered?).to be_false
+        expect(config.run_all_when_everything_filtered?).to be_falsey
       end
 
       it "can be queried with question method" do
         config.run_all_when_everything_filtered = true
-        expect(config.run_all_when_everything_filtered?).to be_true
+        expect(config.run_all_when_everything_filtered?).to be_truthy
       end
     end
 
@@ -661,8 +758,8 @@ module RSpec::Core
               config.tty = true
               config.output_stream.stub :tty? => true
 
-              expect(config.send(color_option)).to be_true
-              expect(config.send(color_option, output)).to be_true
+              expect(config.send(color_option)).to be_truthy
+              expect(config.send(color_option, output)).to be_truthy
             end
           end
 
@@ -674,8 +771,8 @@ module RSpec::Core
               config.tty = true
               config.output_stream.stub :tty? => false
 
-              expect(config.send(color_option)).to be_true
-              expect(config.send(color_option, output)).to be_true
+              expect(config.send(color_option)).to be_truthy
+              expect(config.send(color_option, output)).to be_truthy
             end
           end
 
@@ -687,8 +784,8 @@ module RSpec::Core
               config.tty = false
               config.output_stream.stub :tty? => true
 
-              expect(config.send(color_option)).to be_true
-              expect(config.send(color_option, output)).to be_true
+              expect(config.send(color_option)).to be_truthy
+              expect(config.send(color_option, output)).to be_truthy
             end
           end
 
@@ -700,8 +797,8 @@ module RSpec::Core
               config.tty = false
               config.output_stream.stub :tty? => false
 
-              expect(config.send(color_option)).to be_false
-              expect(config.send(color_option, output)).to be_false
+              expect(config.send(color_option)).to be_falsey
+              expect(config.send(color_option, output)).to be_falsey
             end
           end
 
@@ -724,7 +821,7 @@ module RSpec::Core
                 config.output_stream = StringIO.new
                 config.output_stream.stub :tty? => true
                 config.send "#{color_option}=", true
-                expect(config.send(color_option)).to be_true
+                expect(config.send(color_option)).to be_truthy
               end
 
               it "leaves output stream intact" do
@@ -749,7 +846,7 @@ module RSpec::Core
                 config.stub(:require) { raise LoadError }
                 config.send "#{color_option}=", true
                 config.color_enabled = true
-                expect(config.send(color_option)).to be_false
+                expect(config.send(color_option)).to be_falsey
               end
             end
           end
@@ -761,7 +858,7 @@ module RSpec::Core
         config.output_stream.stub :tty? => true
         config.force :color => true
         config.color = false
-        expect(config.color).to be_true
+        expect(config.color).to be_truthy
       end
     end
 
@@ -919,29 +1016,29 @@ module RSpec::Core
 
       describe "the default :if filter" do
         it "does not exclude a spec with  { :if => true } metadata" do
-          expect(config.exclusion_filter[:if].call(true)).to be_false
+          expect(config.exclusion_filter[:if].call(true)).to be_falsey
         end
 
         it "excludes a spec with  { :if => false } metadata" do
-          expect(config.exclusion_filter[:if].call(false)).to be_true
+          expect(config.exclusion_filter[:if].call(false)).to be_truthy
         end
 
         it "excludes a spec with  { :if => nil } metadata" do
-          expect(config.exclusion_filter[:if].call(nil)).to be_true
+          expect(config.exclusion_filter[:if].call(nil)).to be_truthy
         end
       end
 
       describe "the default :unless filter" do
         it "excludes a spec with  { :unless => true } metadata" do
-          expect(config.exclusion_filter[:unless].call(true)).to be_true
+          expect(config.exclusion_filter[:unless].call(true)).to be_truthy
         end
 
         it "does not exclude a spec with { :unless => false } metadata" do
-          expect(config.exclusion_filter[:unless].call(false)).to be_false
+          expect(config.exclusion_filter[:unless].call(false)).to be_falsey
         end
 
         it "does not exclude a spec with { :unless => nil } metadata" do
-          expect(config.exclusion_filter[:unless].call(nil)).to be_false
+          expect(config.exclusion_filter[:unless].call(nil)).to be_falsey
         end
       end
     end
@@ -1021,7 +1118,7 @@ module RSpec::Core
         RSpec.stub(:deprecate)
         config = Configuration.new
         config.backtrace_clean_patterns = [/.*/]
-        expect(config.backtrace_cleaner.exclude? "this").to be_true
+        expect(config.backtrace_cleaner.exclude? "this").to be_truthy
       end
     end
 
@@ -1048,33 +1145,33 @@ module RSpec::Core
       it "can be appended to" do
         config = Configuration.new
         config.backtrace_clean_patterns << /.*/
-        expect(config.backtrace_cleaner.exclude? "this").to be_true
+        expect(config.backtrace_cleaner.exclude? "this").to be_truthy
       end
     end
 
     describe ".backtrace_cleaner#exclude? defaults" do
       it "returns true for rspec files" do
-        expect(config.backtrace_cleaner.exclude?("lib/rspec/core.rb")).to be_true
+        expect(config.backtrace_cleaner.exclude?("lib/rspec/core.rb")).to be_truthy
       end
 
       it "returns true for spec_helper" do
-        expect(config.backtrace_cleaner.exclude?("spec/spec_helper.rb")).to be_true
+        expect(config.backtrace_cleaner.exclude?("spec/spec_helper.rb")).to be_truthy
       end
 
       it "returns true for java files (for JRuby)" do
-        expect(config.backtrace_cleaner.exclude?("org/jruby/RubyArray.java:2336")).to be_true
+        expect(config.backtrace_cleaner.exclude?("org/jruby/RubyArray.java:2336")).to be_truthy
       end
 
       it "returns true for files within installed gems" do
-        expect(config.backtrace_cleaner.exclude?('ruby-1.8.7-p334/gems/mygem-2.3.0/lib/mygem.rb')).to be_true
+        expect(config.backtrace_cleaner.exclude?('ruby-1.8.7-p334/gems/mygem-2.3.0/lib/mygem.rb')).to be_truthy
       end
 
       it "returns false for files in projects containing 'gems' in the name" do
-        expect(config.backtrace_cleaner.exclude?('code/my-gems-plugin/lib/plugin.rb')).to be_false
+        expect(config.backtrace_cleaner.exclude?('code/my-gems-plugin/lib/plugin.rb')).to be_falsey
       end
 
       it "returns false for something in the current working directory" do
-        expect(config.backtrace_cleaner.exclude?("#{Dir.getwd}/arbitrary")).to be_false
+        expect(config.backtrace_cleaner.exclude?("#{Dir.getwd}/arbitrary")).to be_falsey
       end
     end
 
@@ -1088,6 +1185,8 @@ module RSpec::Core
         end
         config.stub(:require)
         Object.const_set("Debugger", debugger)
+
+        allow_deprecation
       end
 
       after do
@@ -1106,32 +1205,43 @@ module RSpec::Core
         debugger.should_receive(:start)
         config.debug = true
       end
+
+      it "warns that this feature is deprecated" do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1)
+        config.debug = true
+      end
     end
 
     describe "#debug=false" do
+      before { allow_deprecation }
+
       it "does not require 'ruby-debug'" do
         config.should_not_receive(:require).with('ruby-debug')
         config.debug = false
       end
+
+      it "warns that this feature is deprecated" do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1)
+        config.debug = false
+      end
     end
 
     describe "#debug?" do
+      before { allow_deprecation }
+
       it 'returns true if the debugger has been loaded' do
         stub_const("Debugger", Object.new)
-        expect(config.debug?).to be_true
+        expect(config.debug?).to be_truthy
       end
 
       it 'returns false if the debugger has not been loaded' do
         hide_const("Debugger")
-        expect(config.debug?).to be_false
+        expect(config.debug?).to be_falsey
       end
-    end
 
-    describe "#output=" do
-      it "sets the output" do
-        output = double("output")
-        config.output = output
-        expect(config.output).to equal(output)
+      it "warns that this feature is deprecated" do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1)
+        config.debug?
       end
     end
 
@@ -1181,7 +1291,7 @@ module RSpec::Core
           end
 
           it "adds a predicate" do
-            expect(config.custom_option?).to be_false
+            expect(config.custom_option?).to be_falsey
           end
 
           it "can be overridden" do
@@ -1200,7 +1310,7 @@ module RSpec::Core
           end
 
           it "returns true for the predicate" do
-            expect(config.custom_option?).to be_true
+            expect(config.custom_option?).to be_truthy
           end
 
           it "can be overridden with a truthy value" do
@@ -1245,7 +1355,7 @@ module RSpec::Core
 
         it "delegates the predicate to the other option" do
           config.custom_option = true
-          expect(config.another_custom_option?).to be_true
+          expect(config.another_custom_option?).to be_truthy
         end
       end
     end
@@ -1361,12 +1471,18 @@ module RSpec::Core
     end
 
     describe "#force" do
-      it "forces order" do
+      it "forces order (when given default)" do
         config.force :order => "default"
         config.order = "rand"
         expect(config.order).to eq("default")
       end
 
+      it "forces order (when given defined)" do
+        config.force :order => "defined"
+        config.order = "rand"
+        expect(config.order).to eq("defined")
+      end
+
       it "forces order and seed with :order => 'rand:37'" do
         config.force :order => "rand:37"
         config.order = "default"
@@ -1376,7 +1492,7 @@ module RSpec::Core
 
       it "forces order and seed with :seed => '37'" do
         config.force :seed => "37"
-        config.order = "default"
+        config.order = "defined"
         expect(config.seed).to eq(37)
         expect(config.order).to eq("rand")
       end
@@ -1392,11 +1508,11 @@ module RSpec::Core
       it "forces 'false' value" do
         config.add_setting :custom_option
         config.custom_option = true
-        expect(config.custom_option?).to be_true
+        expect(config.custom_option?).to be_truthy
         config.force :custom_option => false
-        expect(config.custom_option?).to be_false
+        expect(config.custom_option?).to be_falsey
         config.custom_option = true
-        expect(config.custom_option?).to be_false
+        expect(config.custom_option?).to be_falsey
       end
     end
 
@@ -1412,7 +1528,7 @@ module RSpec::Core
         before { config.order = :random }
 
         it 'returns true' do
-          expect(config.randomize?).to be_true
+          expect(config.randomize?).to be_truthy
         end
       end
 
@@ -1420,9 +1536,14 @@ module RSpec::Core
         before { config.order = nil }
 
         it 'returns false' do
-          expect(config.randomize?).to be_false
+          expect(config.randomize?).to be_falsey
         end
       end
+
+      it 'is deprecated' do
+        expect_warn_deprecation_with_call_site(__FILE__, __LINE__ + 1, /randomize\?/)
+        config.randomize?
+      end
     end
 
     describe '#order=' do
@@ -1445,10 +1566,10 @@ module RSpec::Core
         end
       end
 
-      context 'given "default"' do
+      shared_examples_for "defined order" do |order|
         before do
           config.order = 'rand:123'
-          config.order = 'default'
+          config.order = order
         end
 
         it "sets the order to nil" do
@@ -1466,10 +1587,26 @@ module RSpec::Core
           expect(list.ordered).to eq([1, 2, 3, 4])
         end
       end
+
+      context "given 'default'" do
+        include_examples "defined order", 'default'
+
+        it 'prints a deprecation notice' do
+          expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /default/)
+          config.order = 'default'
+        end
+      end
+
+      context "given 'defined'" do
+        include_examples "defined order", 'defined'
+      end
     end
 
     describe "#order_examples" do
-      before { RSpec.stub(:configuration => config) }
+      before do
+        allow_deprecation
+        RSpec.stub(:configuration => config)
+      end
 
       it 'sets a block that determines the ordering of a collection extended with Extensions::Ordered::Examples' do
         examples = [1, 2, 3, 4]
@@ -1482,6 +1619,11 @@ module RSpec::Core
         config.order_examples { |examples| examples.reverse }
         expect(config.order).to eq("custom")
       end
+
+      it 'prints a deprecation warning' do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /RSpec::Configuration#order_examples/)
+        config.order_examples { }
+      end
     end
 
     describe "#example_ordering_block" do
@@ -1491,7 +1633,10 @@ module RSpec::Core
     end
 
     describe "#order_groups" do
-      before { RSpec.stub(:configuration => config) }
+      before do
+        allow_deprecation
+        RSpec.stub(:configuration => config)
+      end
 
       it 'sets a block that determines the ordering of a collection extended with Extensions::Ordered::ExampleGroups' do
         groups = [1, 2, 3, 4]
@@ -1504,6 +1649,11 @@ module RSpec::Core
         config.order_groups { |groups| groups.reverse }
         expect(config.order).to eq("custom")
       end
+
+      it 'prints a deprecation warning' do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /RSpec::Configuration#order_groups/)
+        config.order_groups { }
+      end
     end
 
     describe "#group_ordering_block" do
@@ -1530,6 +1680,41 @@ module RSpec::Core
       end
     end
 
+    describe "#register_ordering(:global)" do
+      let(:examples) { [1, 2, 3, 4].extend Extensions::Ordered::Examples }
+      let(:groups)   { [1, 2, 3, 4].extend Extensions::Ordered::ExampleGroups }
+
+      before do
+        RSpec.stub(:configuration => config)
+        config.register_ordering(:global) { |list| list.reverse }
+      end
+
+      it 'sets a block that determines the ordering of a collection extended with Extensions::Ordered::Examples' do
+        expect(examples.ordered).to eq([4, 3, 2, 1])
+      end
+
+      it 'sets a block that determines the ordering of a collection extended with Extensions::Ordered::ExampleGroups' do
+        expect(groups.ordered).to eq([4, 3, 2, 1])
+      end
+
+      it 'sets #order to "custom"' do
+        expect(config.order).to eq("custom")
+      end
+
+      it 'raises an ArgumentError if given a symbol other than `:global`' do
+        expect {
+          config.register_ordering(:custom) { }
+        }.to raise_error(ArgumentError, /:global/)
+      end
+    end
+
+    describe "#order" do
+      it 'is deprecated' do
+        expect_warn_deprecation_with_call_site(__FILE__, __LINE__ + 1, /order/)
+        config.order
+      end
+    end
+
     describe '#warnings' do
       around do |example|
         @_original_setting = $VERBOSE
@@ -1557,5 +1742,53 @@ module RSpec::Core
       end
     end
 
+    describe "#raise_errors_for_deprecations!" do
+      it 'causes deprecations to raise errors rather than printing to the deprecation stream' do
+        config.deprecation_stream = stream = StringIO.new
+        config.raise_errors_for_deprecations!
+
+        expect {
+          config.reporter.deprecation(:deprecated => "foo", :call_site => "foo.rb:1")
+        }.to raise_error(RSpec::Core::DeprecationError, /foo is deprecated/)
+
+        expect(stream.string).to eq("")
+      end
+    end
+
+    describe "#expose_current_running_example_as" do
+      before { stub_const(Configuration::ExposeCurrentExample.name, Module.new) }
+
+      it 'exposes the current example via the named method' do
+        RSpec.configuration.expose_current_running_example_as :the_example
+        RSpec.configuration.expose_current_running_example_as :another_example_helper
+
+        value_1 = value_2 = nil
+
+        ExampleGroup.describe "Group" do
+          it "works" do
+            value_1 = the_example
+            value_2 = another_example_helper
+          end
+        end.run
+
+        expect(value_1).to be_an(RSpec::Core::Example)
+        expect(value_1.description).to eq("works")
+        expect(value_2).to be(value_1)
+      end
+
+      [:example, :running_example].each do |name|
+        it "silences the deprecation warning for ##{name} when configured to expose via that name" do
+          RSpec.configuration.expose_current_running_example_as name
+          allow(RSpec).to receive(:deprecate)
+
+          ExampleGroup.describe "Group" do
+            specify { __send__(name) }
+          end.run
+
+          expect(RSpec).to_not have_received(:deprecate)
+        end
+      end
+    end
+
   end
 end