rspec-expectations 2.11.2 → 2.11.3

data/Changelog.md

@@ -1,3 +1,19 @@
+### 2.11.3 / 2012-09-04
+[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.2...v.2.11.3)
+
+Bug fixes
+
+* Fix (and deprecate) `expect { }.should` syntax so that it works even
+  though it was never a documented or intended syntax. It worked as a
+  consequence of the implementation of `expect` in RSpec 2.10 and
+  earlier. (Myron Marston)
+* Ensure #== is defined on build in matchers so that they can be composed.
+  For example:
+
+    expect {
+      user.emailed!
+    }.to change { user.last_emailed_at }.to be_within(1.second).of(Time.zone.now)
+
 ### 2.11.2 / 2012-07-25
 [full changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.1...v2.11.2)
 

data/lib/rspec/expectations.rb

@@ -1,7 +1,7 @@
 require 'rspec/expectations/extensions'
 require 'rspec/matchers'
-require 'rspec/matchers/configuration'
 require 'rspec/expectations/expectation_target'
+require 'rspec/matchers/configuration'
 require 'rspec/expectations/fail_with'
 require 'rspec/expectations/errors'
 require 'rspec/expectations/deprecation'

data/lib/rspec/expectations/expectation_target.rb

@@ -10,6 +10,11 @@ module RSpec
     #   # with `to_not`
     #   expect(actual).to_not eq(3)
     class ExpectationTarget
+      class << self
+        attr_accessor :deprecated_should_enabled
+        alias deprecated_should_enabled? deprecated_should_enabled
+      end
+
       # @api private
       def initialize(target)
         @target = target
@@ -44,6 +49,31 @@ module RSpec
       end
       alias not_to to_not
 
+      def self.enable_deprecated_should
+        return if deprecated_should_enabled?
+
+        def should(*args)
+          RSpec.deprecate "`expect { }.should`", "`expect { }.to`", 3
+          @target.should(*args)
+        end
+
+        def should_not(*args)
+          RSpec.deprecate "`expect { }.should_not`", "`expect { }.to_not`", 3
+          @target.should_not(*args)
+        end
+
+        self.deprecated_should_enabled = true
+      end
+
+      def self.disable_deprecated_should
+        return unless deprecated_should_enabled?
+
+        remove_method :should
+        remove_method :should_not
+
+        self.deprecated_should_enabled = false
+      end
+
     private
 
       def prevent_operator_matchers(verb, matcher)

data/lib/rspec/expectations/syntax.rb

@@ -57,6 +57,8 @@ module RSpec
             ::RSpec::Expectations::NegativeExpectationHandler.handle_matcher(self, matcher, message, &block)
           end
         end
+
+        ::RSpec::Expectations::ExpectationTarget.enable_deprecated_should if expect_enabled?
       end
 
       # @api private
@@ -68,6 +70,8 @@ module RSpec
           undef should
           undef should_not
         end
+
+        ::RSpec::Expectations::ExpectationTarget.disable_deprecated_should
       end
 
       # @api private
@@ -82,6 +86,8 @@ module RSpec
             ::RSpec::Expectations::ExpectationTarget.new(target.first)
           end
         end
+
+        ::RSpec::Expectations::ExpectationTarget.enable_deprecated_should if should_enabled?
       end
 
       # @api private
@@ -92,6 +98,8 @@ module RSpec
         syntax_host.module_eval do
           undef expect
         end
+
+        ::RSpec::Expectations::ExpectationTarget.disable_deprecated_should
       end
 
       # @api private

data/lib/rspec/expectations/version.rb

@@ -2,7 +2,7 @@ module RSpec
   module Expectations
     # @private
     module Version
-      STRING = '2.11.2'
+      STRING = '2.11.3'
     end
   end
 end

data/lib/rspec/matchers/built_in/be_within.rb

@@ -12,6 +12,7 @@ module RSpec
           raise needs_subtractable unless @actual.respond_to? :-
           (@actual - @expected).abs <= @delta
         end
+        alias == matches?
 
         def of(expected)
           @expected = expected

data/lib/rspec/matchers/built_in/change.rb

@@ -18,6 +18,7 @@ module RSpec
 
           (!change_expected? || changed?) && matches_before? && matches_after? && matches_expected_delta? && matches_min? && matches_max?
         end
+        alias == matches?
 
         def raise_block_syntax_error
           raise SyntaxError.new(<<-MESSAGE)

data/lib/rspec/matchers/built_in/has.rb

@@ -9,6 +9,7 @@ module RSpec
         def matches?(actual)
           actual.__send__(predicate(@expected), *@args)
         end
+        alias == matches?
 
         def failure_message_for_should
           "expected ##{predicate(@expected)}#{failure_message_args_description} to return true, got false"

data/lib/rspec/matchers/built_in/have.rb

@@ -31,6 +31,7 @@ module RSpec
           else                @actual == @expected
           end
         end
+        alias == matches?
 
         def determine_collection(collection_or_owner)
           if collection_or_owner.respond_to?(@collection_name)

data/lib/rspec/matchers/built_in/raise_error.rb

@@ -35,6 +35,7 @@ module RSpec
         ensure
           return (@raised_expected_error & @with_expected_message) ? (@eval_block ? @eval_block_passed : true) : false
         end
+        alias == matches?
 
         def eval_block
           @eval_block = true

data/lib/rspec/matchers/built_in/respond_to.rb

@@ -10,6 +10,7 @@ module RSpec
         def matches?(actual)
           find_failing_method_names(actual, :reject).empty?
         end
+        alias == matches?
 
         def does_not_match?(actual)
           find_failing_method_names(actual, :select).empty?

data/lib/rspec/matchers/built_in/satisfy.rb

@@ -11,6 +11,7 @@ module RSpec
           @actual = actual
           @block.call(actual)
         end
+        alias == matches?
 
         def failure_message_for_should
           "expected #{@actual} to satisfy block"

data/lib/rspec/matchers/built_in/throw_symbol.rb

@@ -51,6 +51,7 @@ module RSpec
             end
           end
         end
+        alias == matches?
 
         def failure_message_for_should
           "expected #{expected} to be thrown, got #{caught}"

data/lib/rspec/matchers/built_in/yield.rb

@@ -115,6 +115,7 @@ module RSpec
           @actual = @probe.single_yield_args
           @probe.yielded_once?(:yield_with_args) && args_match?
         end
+        alias == matches?
 
         def failure_message_for_should
           "expected given block to yield with arguments, but #{positive_failure_reason}"
@@ -184,6 +185,7 @@ module RSpec
           @actual = @probe.successive_yield_args
           args_match?
         end
+        alias == matches?
 
         def failure_message_for_should
           "expected given block to yield successively with arguments, but yielded with unexpected arguments" +

data/spec/rspec/matchers/be_instance_of_spec.rb

@@ -4,6 +4,10 @@ module RSpec
   module Matchers
     [:be_an_instance_of, :be_instance_of].each do |method|
       describe "actual.should #{method}(expected)" do
+        it_behaves_like "an RSpec matcher", :valid_value => 5, :invalid_value => "a" do
+          let(:matcher) { send(method, Fixnum) }
+        end
+
         it "passes if actual is instance of expected class" do
           5.should send(method, Fixnum)
         end

data/spec/rspec/matchers/be_kind_of_spec.rb

@@ -4,6 +4,10 @@ module RSpec
   module Matchers
     [:be_a_kind_of, :be_kind_of].each do |method|
       describe "actual.should #{method}(expected)" do
+        it_behaves_like "an RSpec matcher", :valid_value => 5, :invalid_value => "a" do
+          let(:matcher) { send(method, Fixnum) }
+        end
+
         it "passes if actual is instance of expected class" do
           5.should send(method, Fixnum)
         end

data/spec/rspec/matchers/be_within_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 module RSpec
   module Matchers
     describe "[actual.should] be_within(delta).of(expected)" do
+      it_behaves_like "an RSpec matcher", :valid_value => 5, :invalid_value => -5 do
+        let(:matcher) { be_within(2).of(4.0) }
+      end
+
       it "matches when actual == expected" do
         be_within(0.5).of(5.0).matches?(5.0).should be_true
       end
@@ -50,7 +54,7 @@ module RSpec
       end
 
       it "works with Time" do
-        Time.now.should be_within(0.001).of(Time.now)
+        Time.now.should be_within(0.1).of(Time.now)
       end
 
       it "provides a description" do

data/spec/rspec/matchers/change_spec.rb

@@ -153,6 +153,12 @@ describe "should_not change(actual, message)" do
 end
 
 describe "should change { block }" do
+  o = SomethingExpected.new
+  it_behaves_like "an RSpec matcher", :valid_value => lambda { o.some_value = 5 },
+                                      :invalid_value => lambda { } do
+    let(:matcher) { change { o.some_value } }
+  end
+
   before(:each) do
     @instance = SomethingExpected.new
     @instance.some_value = 5

data/spec/rspec/matchers/configuration_spec.rb

@@ -121,6 +121,48 @@ module RSpec
           expect(3).to eq(3)
         end
       end
+
+      it 'does not add the deprecated #should to ExpectationTarget when only :should is enabled' do
+        et = Expectations::ExpectationTarget
+
+        sandboxed do
+          configure_syntax :should
+          et.new(Proc.new {}).should be_an(et)
+          et.new(Proc.new {}).should_not be_a(Proc)
+        end
+      end
+
+      it 'does not add the deprecated #should to ExpectationTarget when only :expect is enabled' do
+        sandboxed do
+          configure_syntax :expect
+          expect(expect(3)).not_to respond_to(:should)
+          expect(expect(3)).not_to respond_to(:should_not)
+        end
+      end
+
+      context 'when both :expect and :should are enabled' do
+        before { RSpec.stub(:warn) }
+
+        it 'allows `expect {}.should` to be used' do
+          sandboxed do
+            configure_syntax [:should, :expect]
+            expect { raise "boom" }.should raise_error("boom")
+            expect { }.should_not raise_error
+          end
+        end
+
+        it 'prints a deprecation notice when `expect {}.should` is used' do
+          sandboxed do
+            configure_syntax [:should, :expect]
+
+            RSpec.should_receive(:warn).with(/please use `expect \{ \}.to.*instead/)
+            expect { raise "boom" }.should raise_error("boom")
+
+            RSpec.should_receive(:warn).with(/please use `expect \{ \}.to_not.*instead/)
+            expect { }.should_not raise_error
+          end
+        end
+      end
     end
 
     describe "configuring rspec-expectations directly" do

data/spec/rspec/matchers/cover_spec.rb

@@ -2,6 +2,10 @@ require 'spec_helper'
 
 if (1..2).respond_to?(:cover?)
   describe "should cover(expected)" do
+    it_behaves_like "an RSpec matcher", :valid_value => (1..10), :invalid_value => (20..30) do
+      let(:matcher) { cover(5) }
+    end
+
     context "for a range target" do
       it "passes if target covers expected" do
         (1..10).should cover(5)

data/spec/rspec/matchers/eq_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 module RSpec
   module Matchers
     describe "eq" do
+      it_behaves_like "an RSpec matcher", :valid_value => 1, :invalid_value => 2 do
+        let(:matcher) { eq(1) }
+      end
+
       it "is diffable" do
         eq(1).should be_diffable
       end

data/spec/rspec/matchers/eql_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 module RSpec
   module Matchers
     describe "eql" do
+      it_behaves_like "an RSpec matcher", :valid_value => 1, :invalid_value => 2 do
+        let(:matcher) { eql(1) }
+      end
+
       it "is diffable" do
         eql(1).should be_diffable
       end

data/spec/rspec/matchers/equal_spec.rb

@@ -2,6 +2,9 @@ require 'spec_helper'
 module RSpec
   module Matchers
     describe "equal" do
+      it_behaves_like "an RSpec matcher", :valid_value => :a, :invalid_value => :b do
+        let(:matcher) { equal(:a) }
+      end
 
       def inspect_object(o)
         "#<#{o.class}:#{o.object_id}> => #{o.inspect}"

data/spec/rspec/matchers/exist_spec.rb

@@ -1,6 +1,12 @@
 require 'spec_helper'
+require 'ostruct'
 
 describe "exist matcher" do
+  it_behaves_like "an RSpec matcher", :valid_value => OpenStruct.new(:exist? => true),
+                                      :invalid_value => OpenStruct.new(:exist? => false) do
+    let(:matcher) { exist }
+  end
+
   context "when the object does not respond to #exist? or #exists?" do
     subject { mock }
 

data/spec/rspec/matchers/has_spec.rb

@@ -1,6 +1,11 @@
 require 'spec_helper'
 
 describe "should have_sym(*args)" do
+  it_behaves_like "an RSpec matcher", :valid_value => { :a => 1 },
+                                      :invalid_value => {} do
+    let(:matcher) { have_key(:a) }
+  end
+
   it "passes if #has_sym?(*args) returns true" do
     {:a => "A"}.should have_key(:a)
   end

data/spec/rspec/matchers/have_spec.rb

@@ -29,6 +29,9 @@ describe "have matcher" do
   end
 
   describe "should have(n).items" do
+    it_behaves_like "an RSpec matcher", :valid_value => [1, 2], :invalid_value => [1] do
+      let(:matcher) { have(2).items }
+    end
 
     it "passes if target has a collection of items with n members" do
       owner = create_collection_owner_with(3)

data/spec/rspec/matchers/include_spec.rb

@@ -6,6 +6,10 @@ describe "#include matcher" do
   end
 
   describe "should include(with_one_arg)" do
+    it_behaves_like "an RSpec matcher", :valid_value => [1, 2], :invalid_value => [1] do
+      let(:matcher) { include(2) }
+    end
+
     context "for a string target" do
       it "passes if target includes expected" do
         "abc".should include("a")

data/spec/rspec/matchers/match_array_spec.rb

@@ -15,6 +15,10 @@ class UnsortableObject
 end
 
 describe "using match_array with expect" do
+  it_behaves_like "an RSpec matcher", :valid_value => [1, 2], :invalid_value => [1] do
+    let(:matcher) { match_array([2, 1]) }
+  end
+
   it "passes a valid positive expectation" do
     expect([1, 2]).to match_array [2, 1]
   end

data/spec/rspec/matchers/match_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe "should match(expected)" do
+  it_behaves_like "an RSpec matcher", :valid_value => 'ab', :invalid_value => 'bc' do
+    let(:matcher) { match(/a/) }
+  end
+
   it "passes when target (String) matches expected (Regexp)" do
     "string".should match(/tri/)
   end

data/spec/rspec/matchers/raise_error_spec.rb

@@ -1,6 +1,11 @@
 require 'spec_helper'
 
 describe "should raise_error" do
+  it_behaves_like("an RSpec matcher", :valid_value => lambda { raise "boom" },
+                                      :invalid_value => lambda { }) do
+    let(:matcher) { raise_error(/boom/) }
+  end
+
   it "passes if anything is raised" do
     lambda {raise}.should raise_error
   end

data/spec/rspec/matchers/respond_to_spec.rb

@@ -1,6 +1,9 @@
 require 'spec_helper'
 
 describe "should respond_to(:sym)" do
+  it_behaves_like "an RSpec matcher", :valid_value => "s", :invalid_value => 5 do
+    let(:matcher) { respond_to(:upcase) }
+  end
   
   it "passes if target responds to :sym" do
     Object.new.should respond_to(:methods)

data/spec/rspec/matchers/satisfy_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe "should satisfy { block }" do
+  it_behaves_like "an RSpec matcher", :valid_value => true, :invalid_value => false do
+    let(:matcher) { satisfy { |v| v } }
+  end
+
   it "describes itself" do
     satisfy.description.should eq("satisfy block")
   end

data/spec/rspec/matchers/start_with_end_with_spec.rb

@@ -1,6 +1,10 @@
 require "spec_helper"
 
 describe "should start_with" do
+  it_behaves_like "an RSpec matcher", :valid_value => "ab", :invalid_value => "bc" do
+    let(:matcher) { start_with("a") }
+  end
+
   context "with a string" do
     it "passes if it matches the start of the actual string" do
       "this string".should start_with "this str"
@@ -87,6 +91,10 @@ describe "should_not start_with" do
 end
 
 describe "should end_with" do
+  it_behaves_like "an RSpec matcher", :valid_value => "ab", :invalid_value => "bc" do
+    let(:matcher) { end_with("b") }
+  end
+
   context "with a string" do
     it "passes if it matches the end of the actual string" do
       "this string".should end_with "is string"

data/spec/rspec/matchers/throw_symbol_spec.rb

@@ -2,6 +2,11 @@ require 'spec_helper'
 
 module RSpec::Matchers::BuiltIn
   describe ThrowSymbol do
+    it_behaves_like("an RSpec matcher", :valid_value => lambda { throw :foo },
+                                        :invalid_value => lambda { }) do
+      let(:matcher) { throw_symbol(:foo) }
+    end
+
     describe "with no args" do
       before(:each) { @matcher = throw_symbol }
 

data/spec/rspec/matchers/yield_spec.rb

@@ -35,6 +35,13 @@ end
 
 describe "yield_control matcher" do
   include YieldHelpers
+  extend  YieldHelpers
+
+  it_behaves_like "an RSpec matcher",
+      :valid_value => lambda { |b| _yield_with_no_args(&b) },
+      :invalid_value => lambda { |b| _dont_yield(&b) } do
+    let(:matcher) { yield_control }
+  end
 
   it 'has a description' do
     yield_control.description.should eq("yield control")
@@ -90,6 +97,13 @@ end
 
 describe "yield_with_no_args matcher" do
   include YieldHelpers
+  extend  YieldHelpers
+
+  it_behaves_like "an RSpec matcher",
+      :valid_value => lambda { |b| _yield_with_no_args(&b) },
+      :invalid_value => lambda { |b| _dont_yield(&b) } do
+    let(:matcher) { yield_with_no_args }
+  end
 
   it 'has a description' do
     yield_with_no_args.description.should eq("yield with no args")
@@ -154,6 +168,13 @@ end
 
 describe "yield_with_args matcher" do
   include YieldHelpers
+  extend  YieldHelpers
+
+  it_behaves_like "an RSpec matcher",
+      :valid_value => lambda { |b| _yield_with_args(1, &b) },
+      :invalid_value => lambda { |b| _dont_yield(&b) } do
+    let(:matcher) { yield_with_args }
+  end
 
   it 'has a description' do
     yield_with_args.description.should eq("yield with args")
@@ -283,6 +304,13 @@ end
 
 describe "yield_successive_args matcher" do
   include YieldHelpers
+  extend  YieldHelpers
+
+  it_behaves_like "an RSpec matcher",
+      :valid_value => lambda { |b| [1, 2].each(&b) },
+      :invalid_value => lambda { |b| _dont_yield(&b) } do
+    let(:matcher) { yield_successive_args(1, 2) }
+  end
 
   it 'has a description' do
     yield_successive_args(1, 3).description.should eq("yield successive args(1, 3)")

data/spec/support/shared_examples.rb

@@ -0,0 +1,13 @@
+shared_examples_for "an RSpec matcher" do |options|
+  let(:valid_value)   { options.fetch(:valid_value) }
+  let(:invalid_value) { options.fetch(:invalid_value) }
+
+  it 'matches a valid value when using #== so it can be composed' do
+    expect(matcher).to eq(valid_value)
+  end
+
+  it 'does not match an invalid value when using #== so it can be composed' do
+    expect(matcher).not_to eq(invalid_value)
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-expectations
 version: !ruby/object:Gem::Version 
-  hash: 39
+  hash: 37
   prerelease: 
   segments: 
   - 2
   - 11
-  - 2
-  version: 2.11.2
+  - 3
+  version: 2.11.3
 platform: ruby
 authors: 
 - Steven Baker
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-26 00:00:00 Z
+date: 2012-09-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: diff-lcs
@@ -217,6 +217,7 @@ files:
 - spec/support/in_sub_process.rb
 - spec/support/matchers.rb
 - spec/support/ruby_version.rb
+- spec/support/shared_examples.rb
 homepage: http://github.com/rspec/rspec-expectations
 licenses: 
 - MIT
@@ -249,7 +250,7 @@ rubyforge_project: rspec
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: rspec-expectations-2.11.2
+summary: rspec-expectations-2.11.3
 test_files: 
 - features/README.md
 - features/Upgrade.md
@@ -325,4 +326,5 @@ test_files:
 - spec/support/in_sub_process.rb
 - spec/support/matchers.rb
 - spec/support/ruby_version.rb
+- spec/support/shared_examples.rb
 has_rdoc: