rspec-core 2.99.0.beta1 → 2.99.0.beta2

data/lib/rspec/core/formatters/base_text_formatter.rb

@@ -144,8 +144,10 @@ module RSpec
               output.puts pending_color("  #{pending_example.full_description}")
               output.puts detail_color("    # #{pending_example.execution_result[:pending_message]}")
               output.puts detail_color("    # #{format_caller(pending_example.location)}")
+              # instance_variable_get is a hack to avoid a deprecation warning,
+              # it's only for 2.99.
               if pending_example.execution_result[:exception] \
-                && RSpec.configuration.show_failures_in_pending_blocks?
+                && RSpec.configuration.instance_variable_get(:@show_failures_in_pending_blocks)
                 dump_failure_info(pending_example)
                 dump_backtrace(pending_example)
               end

data/lib/rspec/core/formatters/deprecation_formatter.rb

@@ -16,7 +16,9 @@ module RSpec
 
         def printer
           @printer ||= case deprecation_stream
-                       when File, RaiseErrorStream
+                       when File
+                         ImmediatePrinter.new(FileStream.new(deprecation_stream), summary_stream, self)
+                       when RaiseErrorStream
                          ImmediatePrinter.new(deprecation_stream, summary_stream, self)
                        else
                          DelayedPrinter.new(deprecation_stream, summary_stream, self)
@@ -81,7 +83,7 @@ module RSpec
         GeneratedDeprecationMessage = Struct.new(:type) do
           def initialize(data)
             @data = data
-            super data[:deprecated]
+            super data.fetch(:type, data[:deprecated])
           end
 
           def to_s
@@ -99,19 +101,11 @@ module RSpec
         end
 
         class ImmediatePrinter
-          include ::RSpec::Core::Formatters::Helpers
-
           attr_reader :deprecation_stream, :summary_stream, :deprecation_formatter
 
           def initialize(deprecation_stream, summary_stream, deprecation_formatter)
             @deprecation_stream = deprecation_stream
 
-            # In one of my test suites, I got lots of duplicate output in the
-            # deprecation file (e.g. 200 of the same deprecation, even though
-            # the `puts` below was only called 6 times). Setting `sync = true`
-            # fixes this (but we really have no idea why!).
-            @deprecation_stream.sync = true
-
             @summary_stream = summary_stream
             @deprecation_formatter = deprecation_formatter
           end
@@ -122,10 +116,8 @@ module RSpec
           end
 
           def deprecation_summary
-            if deprecation_formatter.count > 0
-              summary_stream.puts "\n#{pluralize(deprecation_formatter.count, 'deprecation')} logged to #{deprecation_stream.path}"
-              deprecation_stream.puts RAISE_ERROR_CONFIG_NOTICE
-            end
+            return if deprecation_formatter.count.zero?
+            deprecation_stream.summarize(summary_stream, deprecation_formatter.count)
           end
         end
 
@@ -180,12 +172,38 @@ module RSpec
 
         # Not really a stream, but is usable in place of one.
         class RaiseErrorStream
+          include ::RSpec::Core::Formatters::Helpers
+
           def puts(message)
             raise DeprecationError, message
           end
 
-          def sync=(value)
-            # no-op
+          def summarize(summary_stream, deprecation_count)
+            summary_stream.puts "\n#{pluralize(deprecation_count, 'deprecation')} found."
+          end
+        end
+
+        # Wraps a File object and provides file-specific operations.
+        class FileStream
+          include ::RSpec::Core::Formatters::Helpers
+
+          def initialize(file)
+            @file = file
+
+            # In one of my test suites, I got lots of duplicate output in the
+            # deprecation file (e.g. 200 of the same deprecation, even though
+            # the `puts` below was only called 6 times). Setting `sync = true`
+            # fixes this (but we really have no idea why!).
+            @file.sync = true
+          end
+
+          def puts(*args)
+            @file.puts(*args)
+          end
+
+          def summarize(summary_stream, deprecation_count)
+            summary_stream.puts "\n#{pluralize(deprecation_count, 'deprecation')} logged to #{@file.path}"
+            puts RAISE_ERROR_CONFIG_NOTICE
           end
         end
 

data/lib/rspec/core/memoized_helpers.rb

@@ -5,6 +5,8 @@ module RSpec
       #   syntax embraced by shoulda matchers:
       #
       #       describe Widget do
+      #         it { is_expected.to validate_presence_of(:name) }
+      #         # or
       #         it { should validate_presence_of(:name) }
       #       end
       #
@@ -31,8 +33,10 @@ module RSpec
       #     end
       #   end
       #
-      #   # one-liner syntax - should is invoked on subject
+      #   # one-liner syntax - expectation is set on the subject
       #   describe Person do
+      #     it { is_expected.to be_eligible_to_vote }
+      #     # or
       #     it { should be_eligible_to_vote }
       #   end
       #
@@ -64,6 +68,11 @@ module RSpec
       #   end
       #
       # @see #subject
+      # @see #is_expected
+      #
+      # @note This only works if you are using rspec-expectations.
+      # @note If you are using RSpec's newer expect-based syntax you may
+      #       want to use `is_expected.to` instead of `should`.
       def should(matcher=nil, message=nil)
         RSpec::Expectations::PositiveExpectationHandler.handle_matcher(subject, matcher, message)
       end
@@ -78,10 +87,34 @@ module RSpec
       #   end
       #
       # @see #subject
+      # @see #is_expected
+      #
+      # @note This only works if you are using rspec-expectations.
+      # @note If you are using RSpec's newer expect-based syntax you may
+      #       want to use `is_expected.to_not` instead of `should_not`.
       def should_not(matcher=nil, message=nil)
         RSpec::Expectations::NegativeExpectationHandler.handle_matcher(subject, matcher, message)
       end
 
+      # Wraps the `subject` in `expect` to make it the target of an expectation.
+      # Designed to read nicely for one-liners.
+      #
+      # @example
+      #
+      #   describe [1, 2, 3] do
+      #     it { is_expected.to be_an Array }
+      #     it { is_expected.not_to include 4 }
+      #   end
+      #
+      # @see #subject
+      # @see #should
+      # @see #should_not
+      #
+      # @note This only works if you are using rspec-expectations.
+      def is_expected
+        expect(subject)
+      end
+
       private
 
       # @private
@@ -289,8 +322,9 @@ EOS
           before { __send__(name) }
         end
 
-        # Declares a `subject` for an example group which can then be the
-        # implicit receiver (through delegation) of calls to `should`.
+        # Declares a `subject` for an example group which can then be wrapped
+        # with `expect` using `is_expected` to make it the target of an expectation
+        # in a concise, one-line example.
         #
         # Given a `name`, defines a method with that name which returns the
         # `subject`. This lets you declare the subject once and access it
@@ -305,13 +339,13 @@ EOS
         #
         #   describe CheckingAccount, "with $50" do
         #     subject { CheckingAccount.new(Money.new(50, :USD)) }
-        #     it { should have_a_balance_of(Money.new(50, :USD)) }
-        #     it { should_not be_overdrawn }
+        #     it { is_expected.to have_a_balance_of(Money.new(50, :USD)) }
+        #     it { is_expected.not_to be_overdrawn }
         #   end
         #
         #   describe CheckingAccount, "with a non-zero starting balance" do
         #     subject(:account) { CheckingAccount.new(Money.new(50, :USD)) }
-        #     it { should_not be_overdrawn }
+        #     it { is_expected.not_to be_overdrawn }
         #     it "has a balance equal to the starting balance" do
         #       account.balance.should eq(Money.new(50, :USD))
         #     end

data/lib/rspec/core/option_parser.rb

@@ -81,7 +81,7 @@ module RSpec::Core
         end
 
         parser.on('-d', '--debugger', 'Enable debugging.') do |o|
-          options[:debug] = true
+          options[:debug] = :cli
         end
 
         parser.on('--fail-fast', 'Abort the run on first failure.') do |o|

data/lib/rspec/core/pending.rb

@@ -71,7 +71,32 @@ module RSpec
       #       it "does something", :pending => "something else getting finished" do
       #         # ...
       #       end
-      def pending(*args)
+      def pending(*args, &block)
+        RSpec.warn_deprecation(<<-EOS.gsub(/^\s+\|/, ''))
+          |The semantics of `RSpec::Core::Pending#pending` are changing in
+          |RSpec 3.  In RSpec 2.x, it caused the example to be skipped. In
+          |RSpec 3, the rest of the example will still be run but is expected
+          |to fail, and will be marked as a failure (rather than as pending)
+          |if the example passes.
+          |
+          |Any passed block will no longer be executed. This feature is being
+          |removed since it was semantically inconsistent, and the behaviour it
+          |offered is being made available with the other ways of marking an
+          |example pending.
+          |
+          |To keep the same skip semantics, change `pending` to `skip`.
+          |Otherwise, if you want the new RSpec 3 behavior, you can safely
+          |ignore this warning and continue to upgrade to RSpec 3 without
+          |addressing it.
+          |
+          |Called from #{CallerFilter.first_non_rspec_line}.
+          |
+        EOS
+
+        pending_no_warning(*args, &block)
+      end
+
+      def pending_no_warning(*args)
         return self.class.before(:each) { pending(*args) } unless RSpec.current_example
 
         options = args.last.is_a?(Hash) ? args.pop : {}
@@ -103,6 +128,9 @@ module RSpec
         end
         raise PendingDeclaredInExample.new(message)
       end
+
+      # Backport from RSpec 3 to aid in upgrading.
+      alias_method :skip, :pending_no_warning
     end
 
     # Alias the error for compatibility with extension gems (e.g. formatters)

data/lib/rspec/core/reporter.rb

@@ -115,7 +115,10 @@ module RSpec::Core
       end
     end
 
-    alias_method :abort, :finish
+    def abort(seed)
+      RSpec.deprecate "RSpec::Core::Reporter#abort", :replacement => "RSpec::Core::Reporter#finish"
+      finish(seed)
+    end
 
     def stop
       @duration = (RSpec::Core::Time.now - @start).to_f if @start

data/lib/rspec/core/version.rb

@@ -1,7 +1,7 @@
 module RSpec
   module Core
     module Version
-      STRING = '2.99.0.beta1'
+      STRING = '2.99.0.beta2'
     end
   end
 end

data/spec/rspec/core/configuration_options_spec.rb

@@ -105,7 +105,7 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
     it "sets debug directly" do
       opts = config_options_object("--debug")
       config = RSpec::Core::Configuration.new
-      config.should_receive(:debug=).with(true)
+      config.should_receive(:debug=).with(:cli)
       opts.configure(config)
     end
 
@@ -224,8 +224,8 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
 
   describe "--debug, -d" do
     it "sets :debug => true" do
-      expect(parse_options("--debug")).to include(:debug => true)
-      expect(parse_options("-d")).to include(:debug => true)
+      expect(parse_options("--debug")).to include(:debug => :cli)
+      expect(parse_options("-d")).to include(:debug => :cli)
     end
   end
 

data/spec/rspec/core/configuration_spec.rb

@@ -227,11 +227,40 @@ module RSpec::Core
       it_behaves_like "a configurable framework adapter", :mock_with
 
       [:rspec, :mocha, :rr, :flexmock].each do |framework|
-        context "with #{framework}" do
+        context "with :#{framework}" do
           it "requires the adapter for #{framework}" do
             config.should_receive(:require).with("rspec/core/mocking/with_#{framework}")
             config.mock_with framework
           end
+
+          it "does not print a deprecation" do
+            expect(RSpec).not_to receive(:deprecate)
+            config.mock_with framework
+          end
+        end
+
+        context "with #{framework.to_s.inspect}" do
+          it "requires the adapter for #{framework}" do
+            config.should_receive(:require).with("rspec/core/mocking/with_#{framework}")
+            config.mock_with framework.to_s
+          end
+
+          it "prints a deprecation warning" do
+            expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /mock_with/)
+            config.mock_with framework.to_s
+          end
+        end
+
+        context "with :the_#{framework}_adapter" do
+          it "requires the adapter for #{framework}" do
+            config.should_receive(:require).with("rspec/core/mocking/with_#{framework}")
+            config.mock_with :"the_#{framework}_adapter"
+          end
+
+          it "prints a deprecation warning" do
+            expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /mock_with/)
+            config.mock_with :"the_#{framework}_adapter"
+          end
         end
       end
 
@@ -253,9 +282,28 @@ module RSpec::Core
         end
       end
 
-      it "uses the null adapter when set to any unknown key" do
-        config.should_receive(:require).with('rspec/core/mocking/with_absolutely_nothing')
-        config.mock_with :crazy_new_mocking_framework_ive_not_yet_heard_of
+      context "with an unknown key" do
+        it "uses the null adapter" do
+          config.should_receive(:require).with('rspec/core/mocking/with_absolutely_nothing')
+          config.mock_with :crazy_new_mocking_framework_ive_not_yet_heard_of
+        end
+
+        it "prints a deprecation warning" do
+          expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /mock_with/)
+          config.mock_with :crazy_new_mocking_framework_ive_not_yet_heard_of
+        end
+      end
+
+      context "with :nothing" do
+        it "uses the null adapter" do
+          config.should_receive(:require).with('rspec/core/mocking/with_absolutely_nothing')
+          config.mock_with :nothing
+        end
+
+        it "does not print a deprecation warning" do
+          expect(RSpec).not_to receive(:deprecate)
+          config.mock_with :nothing
+        end
       end
 
       context 'when there are already some example groups defined' do
@@ -921,6 +969,12 @@ module RSpec::Core
         expect(lambda { config.add_formatter :progresss }).to raise_error(ArgumentError)
       end
 
+      it 'warns of deprecation for old document aliases' do
+        expect_deprecation_with_call_site __FILE__, __LINE__ + 1, 's'
+        config.add_formatter 's'
+        expect(config.formatters.first).to be_an_instance_of Formatters::DocumentationFormatter
+      end
+
       context "with a 2nd arg defining the output" do
         it "creates a file at that path and sets it as the output" do
           path = File.join(Dir.tmpdir, 'output.txt')
@@ -1471,30 +1525,45 @@ module RSpec::Core
     end
 
     describe "#force" do
+      let(:collection) { [1, 2, 3, 4] }
+      let(:ordered)    { config.group_ordering_block.call(collection) }
+
       it "forces order (when given default)" do
         config.force :order => "default"
         config.order = "rand"
+
         expect(config.order).to eq("default")
+        expect(ordered).to eq([1, 2, 3, 4])
       end
 
       it "forces order (when given defined)" do
         config.force :order => "defined"
         config.order = "rand"
+
         expect(config.order).to eq("defined")
+        expect(ordered).to eq([1, 2, 3, 4])
       end
 
       it "forces order and seed with :order => 'rand:37'" do
         config.force :order => "rand:37"
         config.order = "default"
+
         expect(config.order).to eq("rand")
         expect(config.seed).to eq(37)
+
+        allow(Kernel).to receive(:rand).and_return(3, 1, 4, 2)
+        expect(ordered).to_not eq([1, 2, 3, 4])
       end
 
       it "forces order and seed with :seed => '37'" do
         config.force :seed => "37"
         config.order = "defined"
+
         expect(config.seed).to eq(37)
         expect(config.order).to eq("rand")
+
+        allow(Kernel).to receive(:rand).and_return(3, 1, 4, 2)
+        expect(ordered).to eq([2, 4, 1, 3])
       end
 
       it 'can set random ordering' do
@@ -1790,5 +1859,28 @@ module RSpec::Core
       end
     end
 
+    describe '#show_failures_in_pending_blocks' do
+      specify 'reader is deprecated' do
+        expect_warn_deprecation_with_call_site(__FILE__, __LINE__ + 3,
+          /show_failures_in_pending_blocks/)
+
+        config.show_failures_in_pending_blocks
+      end
+
+      specify 'predicate is deprecated' do
+        expect_warn_deprecation_with_call_site(__FILE__, __LINE__ + 3,
+          /show_failures_in_pending_blocks/)
+
+        config.show_failures_in_pending_blocks?
+      end
+
+      specify 'writer is deprecated' do
+        expect_warn_deprecation_with_call_site(__FILE__, __LINE__ + 3,
+          /show_failures_in_pending_blocks/)
+
+        config.show_failures_in_pending_blocks = true
+      end
+    end
+
   end
 end