rspec-core 2.99.0.beta2 → 2.99.0.rc1

data/spec/rspec/core/configuration_options_spec.rb

@@ -75,7 +75,7 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
       expect(config.exclusion_filter).to have_key(:slow)
     end
 
-    it "forces color_enabled" do
+    it "forces color" do
       opts = config_options_object(*%w[--color])
       config = RSpec::Core::Configuration.new
       config.should_receive(:force).with(:color => true)

data/spec/rspec/core/configuration_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'tmpdir'
+require 'pathname'
 
 module RSpec::Core
 
@@ -26,6 +27,28 @@ module RSpec::Core
         config.deprecation_stream = io
         expect(config.deprecation_stream).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
+          config.deprecation_stream = double("IO")
+          expect(config).to have_received(:warn).with(/deprecation_stream.*#{__FILE__}:#{__LINE__ - 1}/)
+        end
+
+        it 'does not change the value of `output_stream`' do
+          config.deprecation_stream = double("IO")
+          expect(config.deprecation_stream).to eq($stderr)
+        end
+
+        it 'does not print a warning if set to the value it already has' do
+          config.deprecation_stream = config.deprecation_stream
+          expect(config).not_to have_received(:warn)
+        end
+      end
     end
 
     shared_examples_for "output_stream" do |attribute|
@@ -344,35 +367,92 @@ module RSpec::Core
       end
     end
 
+    def stub_expectation_adapters
+      stub_const("Test::Unit::Assertions", Module.new)
+      stub_const("Minitest::Assertions", Module.new)
+      stub_const("RSpec::Core::TestUnitAssertionsAdapter", Module.new)
+      stub_const("RSpec::Core::MinitestAssertionsAdapter", Module.new)
+      allow(config).to receive(:require)
+    end
+
     describe "#expect_with" do
       before do
-        stub_const("Test::Unit::Assertions", Module.new)
-        config.stub(:require)
+        stub_expectation_adapters
       end
 
       it_behaves_like "a configurable framework adapter", :expect_with
 
-      [
-        [:rspec,  'rspec/expectations'],
-        [:stdlib, 'test/unit/assertions']
-      ].each do |framework, required_file|
-        context "with #{framework}" do
-          it "requires #{required_file}" do
-            config.should_receive(:require).with(required_file)
-            config.expect_with framework
-          end
+      context "with :stdlib" do
+        it "is deprecated" do
+          expect_deprecation_with_call_site __FILE__, __LINE__ + 1, /:stdlib/
+          config.expect_with :stdlib
+        end
+
+        it "requires test/unit/assertions" do
+          expect(config).to receive(:require).with('test/unit/assertions')
+          config.expect_with :stdlib
+        end
+
+        it "sets the expectation framework to ::Test::Unit::Assertions" do
+          config.expect_with :stdlib
+          expect(config.expectation_frameworks).to eq [::Test::Unit::Assertions]
+        end
+      end
+
+      context "with :rspec" do
+        it "requires rspec/expectations" do
+          expect(config).to receive(:require).with('rspec/expectations')
+          config.expect_with :rspec
+        end
+
+        it "sets the expectation framework to ::RSpec::Matchers" do
+          config.expect_with :rspec
+          expect(config.expectation_frameworks).to eq [::RSpec::Matchers]
+        end
+      end
+
+      context "with :test_unit" do
+        it "requires rspec/core/test_unit_assertions_adapter" do
+          expect(config).to receive(:require).
+            with('rspec/core/test_unit_assertions_adapter')
+          config.expect_with :test_unit
+        end
+
+        it "sets the expectation framework to ::Test::Unit::Assertions" do
+          config.expect_with :test_unit
+          expect(config.expectation_frameworks).to eq [
+            ::RSpec::Core::TestUnitAssertionsAdapter
+          ]
+        end
+      end
+
+      context "with :minitest" do
+        it "requires rspec/core/minitest_assertions_adapter" do
+          expect(config).to receive(:require).
+            with('rspec/core/minitest_assertions_adapter')
+          config.expect_with :minitest
+        end
+
+        it "sets the expectation framework to ::Minitest::Assertions" do
+          config.expect_with :minitest
+          expect(config.expectation_frameworks).to eq [
+            ::RSpec::Core::MinitestAssertionsAdapter
+          ]
         end
       end
 
       it "supports multiple calls" do
         config.expect_with :rspec
-        config.expect_with :stdlib
-        expect(config.expectation_frameworks).to eq [RSpec::Matchers, Test::Unit::Assertions]
+        config.expect_with :minitest
+        expect(config.expectation_frameworks).to eq [
+          RSpec::Matchers,
+          RSpec::Core::MinitestAssertionsAdapter
+        ]
       end
 
       it "raises if block given with multiple args" do
         expect {
-          config.expect_with :rspec, :stdlib do |mod_config|
+          config.expect_with :rspec, :minitest do |mod_config|
           end
         }.to raise_error(/expect_with only accepts/)
       end
@@ -400,17 +480,16 @@ module RSpec::Core
         it 'does not raise an error if re-setting the same config' do
           groups = []
           RSpec.world.stub(:example_groups => groups)
-          config.expect_with :stdlib
+          config.expect_with :minitest
           groups << double.as_null_object
-          config.expect_with :stdlib
+          config.expect_with :minitest
         end
       end
     end
 
     describe "#expecting_with_rspec?" do
       before do
-        stub_const("Test::Unit::Assertions", Module.new)
-        config.stub(:require)
+        stub_expectation_adapters
       end
 
       it "returns false by default" do
@@ -422,18 +501,18 @@ module RSpec::Core
         expect(config).to be_expecting_with_rspec
       end
 
-      it "returns true when `expect_with :rspec, :stdlib` has been configured" do
-        config.expect_with :rspec, :stdlib
+      it "returns true when `expect_with :rspec, :minitest` has been configured" do
+        config.expect_with :rspec, :minitest
         expect(config).to be_expecting_with_rspec
       end
 
-      it "returns true when `expect_with :stdlib, :rspec` has been configured" do
-        config.expect_with :stdlib, :rspec
+      it "returns true when `expect_with :minitest, :rspec` has been configured" do
+        config.expect_with :minitest, :rspec
         expect(config).to be_expecting_with_rspec
       end
 
-      it "returns false when `expect_with :stdlib` has been configured" do
-        config.expect_with :stdlib
+      it "returns false when `expect_with :minitest` has been configured" do
+        config.expect_with :minitest
         expect(config).not_to be_expecting_with_rspec
       end
     end
@@ -576,8 +655,20 @@ module RSpec::Core
       end
     end
 
+    specify "#filename_pattern is deprecated" do
+      expect_deprecation_with_call_site __FILE__, __LINE__ + 1
+      config.filename_pattern
+    end
+
+    specify "#filename_pattern= is deprecated" do
+      expect_deprecation_with_call_site __FILE__, __LINE__ + 1
+      config.filename_pattern = "/whatever"
+    end
+
     %w[pattern= filename_pattern=].each do |setter|
       describe "##{setter}" do
+        before { allow_deprecation } if setter == "filename_pattern="
+
         context "with single pattern" do
           before { config.send(setter, "**/*_foo.rb") }
           it "loads files following pattern" do
@@ -793,8 +884,53 @@ module RSpec::Core
       end
     end
 
+    specify '#color? is deprecated' do
+      expect_deprecation_with_call_site __FILE__, __LINE__+1
+      config.color?
+    end
+
+    specify "#color_enabled? is not deprecated" do
+      expect_no_deprecation
+      config.color_enabled?
+      config.color_enabled? double("output")
+    end
+
+    specify '#color with no argument is not deprecated' do
+      expect_no_deprecation
+      config.color
+    end
+
+    specify '#color with a non tty output and color = true is deprecated' do
+      allow(config.output_stream).to receive(:tty?).and_return(false)
+      config.color = true
+      expect_warn_deprecation_with_call_site __FILE__, __LINE__+1
+      expect(config.color).to be_falsey
+    end
+
+    specify '#color with an argument is deprecated' do
+      expect_deprecation_with_call_site __FILE__, __LINE__+1
+      config.color config.output_stream
+    end
+
+    specify '#color_enabled with no argument is deprecated' do
+      expect_deprecation_with_call_site __FILE__, __LINE__+1
+      config.color_enabled
+    end
+
+    specify '#color_enabled with an argument is deprecated in favour of #color_enabled?' do
+      expect_deprecation_with_call_site __FILE__, __LINE__+1
+      config.color_enabled config.output_stream
+    end
+
     %w[color color_enabled].each do |color_option|
       describe "##{color_option}=" do
+        before { allow_deprecation } if color_option == 'color_enabled'
+
+        specify "color_enabled is deprecated" do
+          expect_deprecation_with_call_site __FILE__, __LINE__+1
+          config.color_enabled = true
+        end
+
         context "given true" do
           before { config.send "#{color_option}=", true }
 
@@ -953,7 +1089,7 @@ module RSpec::Core
       end
 
       it "requires a formatter file based on its fully qualified name" do
-        config.should_receive(:require).with('rspec/custom_formatter') do
+        config.formatter_loader.should_receive(:require).with('rspec/custom_formatter') do
           stub_const("RSpec::CustomFormatter", Class.new(Formatters::BaseFormatter))
         end
         config.add_formatter "RSpec::CustomFormatter"
@@ -961,7 +1097,7 @@ module RSpec::Core
       end
 
       it "raises NameError if class is unresolvable" do
-        config.should_receive(:require).with('rspec/custom_formatter3')
+        config.formatter_loader.should_receive(:require).with('rspec/custom_formatter3')
         expect(lambda { config.add_formatter "RSpec::CustomFormatter3" }).to raise_error(NameError)
       end
 
@@ -975,13 +1111,39 @@ module RSpec::Core
         expect(config.formatters.first).to be_an_instance_of Formatters::DocumentationFormatter
       end
 
+      it 'warns of deprecation of the text mate formatter' do
+        expect_deprecation_with_call_site __FILE__, __LINE__ + 1, /rspec-core/
+        config.add_formatter 't'
+      end
+
+      it 'warns of deprecation of the shortcut for the text mate formatter' do
+        stub_const("::RSpec::Mate::Formatters::TextMateFormatter", double)
+        expect_deprecation_with_call_site __FILE__, __LINE__ + 1, /shortcut/
+        config.add_formatter 't'
+      end
+
       context "with a 2nd arg defining the output" do
+        let(:path) { File.join(Dir.tmpdir, 'output.txt') }
+
         it "creates a file at that path and sets it as the output" do
-          path = File.join(Dir.tmpdir, 'output.txt')
           config.add_formatter('doc', path)
           expect(config.formatters.first.output).to be_a(File)
           expect(config.formatters.first.output.path).to eq(path)
         end
+
+        it "accepts Pathname objects for file paths" do
+           pathname = Pathname.new(path)
+           config.add_formatter('doc', pathname)
+           expect(config.formatters.first.output).to be_a(File)
+           expect(config.formatters.first.output.path).to eq(path)
+        end
+      end
+    end
+
+    describe "#formatters" do
+      it "is deprecated to mutate the array" do
+        expect_deprecation_with_call_site __FILE__, __LINE__ + 1
+        config.formatters.clear
       end
     end
 
@@ -1011,6 +1173,18 @@ module RSpec::Core
         expect(config.inclusion_filter[:foo]).to be(true)
         expect(config.inclusion_filter[:bar]).to be(false)
       end
+
+      context "given `:focused => true`" do
+        it "issues a deprecation warning" do
+          expect_warn_deprecation_with_call_site(__FILE__, __LINE__ + 1, /filter_run_including :focused/)
+          config.filter_run_including :focused => true
+        end
+
+        it "issues a deprecation warning when using `filter_run`" do
+          expect_warn_deprecation_with_call_site(__FILE__, __LINE__ + 1, /filter_run :focused/)
+          config.filter_run :focused => true
+        end
+      end
     end
 
     describe "#filter_run_excluding" do
@@ -1172,7 +1346,7 @@ module RSpec::Core
         RSpec.stub(:deprecate)
         config = Configuration.new
         config.backtrace_clean_patterns = [/.*/]
-        expect(config.backtrace_cleaner.exclude? "this").to be_truthy
+        expect(config.backtrace_formatter.exclude? "this").to be_truthy
       end
     end
 
@@ -1199,33 +1373,40 @@ module RSpec::Core
       it "can be appended to" do
         config = Configuration.new
         config.backtrace_clean_patterns << /.*/
-        expect(config.backtrace_cleaner.exclude? "this").to be_truthy
+        expect(config.backtrace_formatter.exclude? "this").to be_truthy
       end
     end
 
-    describe ".backtrace_cleaner#exclude? defaults" do
+    specify "#backtrace_cleaner is deprecated" do
+      expect_deprecation_with_call_site __FILE__, __LINE__ + 1
+      config.backtrace_cleaner
+    end
+
+    describe ".backtrace_formatter#exclude? defaults" do
+      before { allow_deprecation }
+
       it "returns true for rspec files" do
-        expect(config.backtrace_cleaner.exclude?("lib/rspec/core.rb")).to be_truthy
+        expect(config.backtrace_formatter.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_truthy
+        expect(config.backtrace_formatter.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_truthy
+        expect(config.backtrace_formatter.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_truthy
+        expect(config.backtrace_formatter.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_falsey
+        expect(config.backtrace_formatter.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_falsey
+        expect(config.backtrace_formatter.exclude?("#{Dir.getwd}/arbitrary")).to be_falsey
       end
     end
 
@@ -1801,7 +1982,12 @@ module RSpec::Core
         expect($VERBOSE).to eq false
       end
 
-      it 'returns the verbosity setting' do
+      it 'returns the verbosity setting as a predicate' do
+        expect(config.warnings?).to eq $VERBOSE
+      end
+
+      it 'warns when using the deprecated `warnings` reader' do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /warnings/)
         expect(config.warnings).to eq $VERBOSE
       end
 

data/spec/rspec/core/example_group_spec.rb

@@ -292,7 +292,7 @@ module RSpec::Core
         context "and a string in an inner group" do
           it "is the top level constant" do
             group = ExampleGroup.describe(String) do
-              describe :symbol do
+              describe "some string" do
                 example "described_class is String" do
                   expect(described_class).to eq(String)
                 end
@@ -308,7 +308,7 @@ module RSpec::Core
             group = ExampleGroup.describe(String) do
               described_class
               metadata[:example_group][:described_class] = Object
-              describe :symbol do
+              describe "inner" do
                 example "described_class is Object" do
                   expect(described_class).to eq(Object)
                 end
@@ -332,6 +332,63 @@ module RSpec::Core
 
           expect(group.run).to be_truthy, "expected examples in group to pass"
         end
+
+        def capture_deprecation_options
+          warn_opts = nil
+          allow(RSpec.configuration.reporter).to receive(:deprecation) do |opts|
+            warn_opts = opts
+          end
+
+          yield
+
+          warn_opts
+        end
+
+        it "prints a deprecation warning since the semantics are changing in RSpec 3" do
+          warn_opts = capture_deprecation_options do
+            ExampleGroup.describe(String) do
+              describe Array do
+                example { described_class }
+              end
+            end.run
+          end
+
+          expect(warn_opts[:message]).to include("#{__FILE__}:#{__LINE__ - 5}")
+          expect(warn_opts[:message]).to include("described_class")
+        end
+
+        it "prints a deprecation even when `described_class` has already been referenced in the outer group" do
+          warn_opts = capture_deprecation_options do
+            outer_dc = inner_dc = nil
+            ExampleGroup.describe(String) do
+              outer_dc = described_class
+              describe Array do
+                example { inner_dc = described_class }
+              end
+            end.run
+
+            expect(outer_dc).to eq(String)
+            expect(inner_dc).to eq(String)
+          end
+
+          expect(warn_opts[:message]).to include("#{__FILE__}:#{__LINE__ - 8}")
+          expect(warn_opts[:message]).to include("described_class")
+        end
+
+        it "does not print a deprecation warning when the inner example group has no description args" do
+          dc = :unset
+          deprecations = []
+          allow(RSpec).to receive(:warn_deprecation) { |msg| deprecations << msg }
+
+          ExampleGroup.describe(String) do
+            describe do
+              example { dc = described_class }
+            end
+          end.run
+
+          expect(dc).to be(String)
+          expect(deprecations).to eq([])
+        end
       end
 
       context "for `describe(SomeClass)` within a `describe 'some string' group" do
@@ -677,6 +734,7 @@ module RSpec::Core
       it "has access to example options within before(:each)" do
         group = ExampleGroup.describe
         option = nil
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /options/)
         group.before(:each) {|ex| option = ex.options[:data] }
         group.example("no-op", :data => :sample) { }
         group.run
@@ -686,6 +744,7 @@ module RSpec::Core
       it "has access to example options within after(:each)" do
         group = ExampleGroup.describe
         option = nil
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /options/)
         group.after(:each) {|ex| option = ex.options[:data] }
         group.example("no-op", :data => :sample) { }
         group.run
@@ -693,19 +752,37 @@ module RSpec::Core
       end
     end
 
+    context 'skip in metadata' do
+      let(:group) { ExampleGroup.describe do
+          it 'is skipped', :skip => 'skip this' do
+          end
+        end
+      }
+
+      before { group.run }
+
+      it 'generates a pending example' do
+        expect(group.examples.first).to be_pending
+      end
+
+      it 'sets the pending message' do
+        expect(group.examples.first.metadata[:execution_result][:pending_message]).to eq('skip this')
+      end
+    end
+
     %w[pending skip].each do |method_name|
       describe ".#{method_name}" do
         let(:group) { ExampleGroup.describe.tap {|x|
           x.send(method_name, "is pending") { }
         }}
 
+        before { group.run } 
+
         it "generates a pending example" do
-          group.run
           expect(group.examples.first).to be_pending
         end
 
         it "sets the pending message" do
-          group.run
           expect(group.examples.first.metadata[:execution_result][:pending_message]).to eq(RSpec::Core::Pending::NO_REASON_GIVEN)
         end
       end
@@ -717,13 +794,13 @@ module RSpec::Core
           x.send(method_name, "is pending") { }
         }}
 
+        before { group.run } 
+
         it "generates a pending example" do
-          group.run
           expect(group.examples.first).to be_pending
         end
 
         it "sets the pending message" do
-          group.run
           expect(group.examples.first.metadata[:execution_result][:pending_message]).to eq("Temporarily disabled with #{method_name}")
         end
       end
@@ -1223,5 +1300,38 @@ module RSpec::Core
         end.to raise_error(ArgumentError,%q|Could not find shared examples "shared stuff"|)
       end
     end
+
+    describe "deprecated methods" do
+      specify ".describes is deprecated" do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /describes/)
+        expect(self.class.describes).to eq(self.class.described_class)
+      end
+
+      specify ".display_name is deprecated" do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /display_name/)
+        expect(self.class.display_name).to eq(self.class.description)
+      end
+
+      specify ".alias_it_behaves_like_to is deprecated" do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 2, /alias_it_behaves_like_to/)
+        expect {
+          ExampleGroup.alias_it_behaves_like_to(:it_does_something, "it does something")
+        }.to change { ExampleGroup.respond_to?(:it_does_something) }.from(false).to(true)
+      end
+
+      specify ".alias_example_to is deprecated" do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 2, /alias_example_to/)
+        expect {
+          ExampleGroup.alias_example_to(:an_example)
+        }.to change { ExampleGroup.respond_to?(:an_example) }.from(false).to(true)
+      end
+
+      specify ".focused is deprecated" do
+        expect_deprecation_with_call_site(__FILE__, __LINE__ + 2, /focused/)
+        ExampleGroup.describe("group") do
+          focused("example") { }
+        end
+      end
+    end
   end
 end