rspec-expectations 2.12.0 → 2.12.1

data/Changelog.md

@@ -1,5 +1,17 @@
+### 2.12.1 / 2012-12-15
+[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.12.0...v2.12.1)
+
+Bug fixes
+
+* Improve the failure message for an expression like
+  `{}.should =~ {}`. (Myron Marston and Andy Lindeman)
+* Provide a `match_regex` alias so that custom matchers
+  built using the matcher DSL can use it (since `match`
+  is a different method in that context).
+  (Steven Harman)
+
 ### 2.12.0 / 2012-11-12
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.3...2.12.0)
+[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.3...v2.12.0)
 
 Enhancements
 

data/features/custom_matchers/define_matcher.feature

@@ -338,3 +338,31 @@ Feature: define matcher
       | 4 examples, 2 failures               |
       | expected 9 to be a multiple of 2     |
       | expected 9 not to be a multiple of 3 |
+
+  Scenario: matching against a regular expression
+    Given a file named "regular_expression_matcher_spec.rb" with:
+      """ruby
+      # Due to Ruby's method dispatch mechanism, use the `#match_regex` alias
+      # rather than the `#match` matcher when defining custom matchers via the
+      # DSL.
+
+      RSpec::Matchers.define :be_valid_us_zipcode do
+        match do |actual|
+          expect(actual).to match_regex(/\A\d{5}(-\d{4})?\z/)
+        end
+      end
+
+      describe "30316" do
+        it { should be_valid_us_zipcode }
+      end
+
+      describe "30316-0001" do
+        it { should be_valid_us_zipcode }
+      end
+
+      describe "1000-61303" do
+        it { should_not be_valid_us_zipcode }
+      end
+      """
+    When I run `rspec regular_expression_matcher_spec.rb`
+    Then the stdout should contain "3 examples, 0 failures"

data/lib/rspec/expectations/version.rb

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

data/lib/rspec/matchers.rb

@@ -214,7 +214,7 @@ module RSpec
     #
     # Given true, false, or nil, will pass if actual value is true, false or
     # nil (respectively). Given no args means the caller should satisfy an if
-    # condition (to be or not to be). 
+    # condition (to be or not to be).
     #
     # Predicates are any Ruby method that ends in a "?" and returns true or
     # false.  Given be_ followed by arbitrary_predicate (without the "?"),
@@ -246,7 +246,7 @@ module RSpec
     def be_an_instance_of(expected)
       BuiltIn::BeAnInstanceOf.new(expected)
     end
-    
+
     alias_method :be_instance_of, :be_an_instance_of
 
     # Passes if actual.kind_of?(expected)
@@ -288,20 +288,20 @@ module RSpec
     # @example
     #
     #   lambda {
-    #     team.add_player(player) 
+    #     team.add_player(player)
     #   }.should change(roster, :count)
     #
     #   lambda {
-    #     team.add_player(player) 
+    #     team.add_player(player)
     #   }.should change(roster, :count).by(1)
     #
     #   lambda {
-    #     team.add_player(player) 
+    #     team.add_player(player)
     #   }.should change(roster, :count).by_at_least(1)
     #
     #   lambda {
     #     team.add_player(player)
-    #   }.should change(roster, :count).by_at_most(1)    
+    #   }.should change(roster, :count).by_at_most(1)
     #
     #   string = "string"
     #   lambda {
@@ -311,7 +311,7 @@ module RSpec
     #   lambda {
     #     person.happy_birthday
     #   }.should change(person, :birthday).from(32).to(33)
-    #       
+    #
     #   lambda {
     #     employee.develop_great_new_social_networking_app
     #   }.should change(employee, :title).from("Mail Clerk").to("CEO")
@@ -491,10 +491,20 @@ module RSpec
     #
     #   email.should match(/^([^\s]+)((?:[-a-z0-9]+\.)+[a-z]{2,})$/i)
     #   email.should match("@example.com")
+    #   zipcode.should match_regex(/\A\d{5}(-\d{4})?\z/)
+    #   zipcode.should match_regex("90210")
+    #
+    # @note Due to Ruby's method dispatch mechanism, using the `#match` matcher
+    # within a custom matcher defined via the matcher DSL
+    # (`RSpec::Matcher.define`) will result Ruby calling the wrong `#match`
+    # method and raising an `ArgumentError`. Instead, use the aliased
+    # `#match_regex` method.
     def match(expected)
       BuiltIn::Match.new(expected)
     end
 
+    alias_method :match_regex, :match
+
     # With no args, matches if any error is raised.
     # With a named error, matches only if that specific error is raised.
     # With a named error and messsage specified as a String, matches only if both match.
@@ -523,7 +533,7 @@ module RSpec
     # provided. Names can be Strings or Symbols.
     #
     # @example
-    # 
+    #
     def respond_to(*names)
       BuiltIn::RespondTo.new(*names)
     end
@@ -684,6 +694,6 @@ module RSpec
       BuiltIn::MatchArray.new(array)
     end
 
-    OperatorMatcher.register(Array, '=~', BuiltIn::MatchArray)
+    OperatorMatcher.register(Enumerable, '=~', BuiltIn::MatchArray)
   end
 end

data/lib/rspec/matchers/operator_matcher.rb

@@ -11,8 +11,17 @@ module RSpec
           registry[klass][operator] = matcher
         end
 
+        def unregister(klass, operator)
+          registry[klass] && registry[klass].delete(operator)
+        end
+
         def get(klass, operator)
-          registry[klass] && registry[klass][operator]
+          klass.ancestors.each { |ancestor|
+            matcher = registry[ancestor] && registry[ancestor][operator]
+            return matcher if matcher
+          }
+
+          nil
         end
       end
 
@@ -22,7 +31,7 @@ module RSpec
 
       def self.use_custom_matcher_or_delegate(operator)
         define_method(operator) do |expected|
-          if matcher = OperatorMatcher.get(@actual.class, operator)
+          if uses_generic_implementation_of?(operator) && matcher = OperatorMatcher.get(@actual.class, operator)
             @actual.send(::RSpec::Matchers.last_should, matcher.new(expected))
           else
             eval_match(@actual, operator, expected)
@@ -53,6 +62,22 @@ module RSpec
 
       private
 
+      if Method.method_defined?(:owner) # 1.8.6 lacks Method#owner :-(
+        def uses_generic_implementation_of?(op)
+          @actual.method(op).owner == ::Kernel
+        end
+      else
+        def uses_generic_implementation_of?(op)
+          # This is a bit of a hack, but:
+          #
+          # {}.method(:=~).to_s # => "#<Method: Hash(Kernel)#=~>"
+          #
+          # In the absence of Method#owner, this is the best we
+          # can do to see if the method comes from Kernel.
+          @actual.method(op).to_s.include?('(Kernel)')
+        end
+      end
+
       def eval_match(actual, operator, expected)
         ::RSpec::Matchers.last_matcher = self
         @operator, @expected = operator, expected

data/spec/rspec/matchers/match_array_spec.rb

@@ -113,6 +113,17 @@ the missing elements were:      [1]
 MESSAGE
   end
 
+  context "when the array defines a `=~` method" do
+    it 'delegates to that method rather than using the match_array matcher' do
+      array = []
+      def array.=~(other)
+        other == :foo
+      end
+
+      array.should =~ :foo
+      expect { array.should =~ :bar }.to fail_with(/expected: :bar/)
+    end
+  end
 end
 
 describe "should_not =~ [:with, :multiple, :args]" do
@@ -135,4 +146,8 @@ describe "matching against things that aren't arrays" do
   it "fails with a string and the expected error message is given" do
     expect { "I like turtles".should match_array([1,2,3]) }.to fail_with(/expected an array/)
   end
+
+  it 'fails with a clear message when given a hash using the `should =~` syntax' do
+    expect { {}.should =~ {} }.to fail_with(/expected an array/)
+  end
 end

data/spec/rspec/matchers/operator_matcher_spec.rb

@@ -196,6 +196,29 @@ describe "should <=" do
 
 end
 
+describe "OperatorMatcher registry" do
+  let(:custom_klass) { Class.new }
+  let(:custom_subklass) { Class.new(custom_klass) }
+
+  after {
+    RSpec::Matchers::OperatorMatcher.unregister(custom_klass, "=~")
+  }
+
+  it "allows operator matchers to be registered for types" do
+    RSpec::Matchers::OperatorMatcher.register(custom_klass, "=~", RSpec::Matchers::BuiltIn::Match)
+    expect(RSpec::Matchers::OperatorMatcher.get(custom_klass, "=~")).to eq(RSpec::Matchers::BuiltIn::Match)
+  end
+
+  it "considers ancestors when finding an operator matcher" do
+    RSpec::Matchers::OperatorMatcher.register(custom_klass, "=~", RSpec::Matchers::BuiltIn::Match)
+    expect(RSpec::Matchers::OperatorMatcher.get(custom_subklass, "=~")).to eq(RSpec::Matchers::BuiltIn::Match)
+  end
+
+  it "returns nil if there is no matcher registered for a type" do
+    expect(RSpec::Matchers::OperatorMatcher.get(custom_klass, "=~")).to be_nil
+  end
+end
+
 describe RSpec::Matchers::BuiltIn::PositiveOperatorMatcher do
 
   it "works when the target has implemented #send" do

metadata

@@ -1,87 +1,96 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: rspec-expectations
-version: !ruby/object:Gem::Version
-  version: 2.12.0
+version: !ruby/object:Gem::Version 
+  hash: 61
   prerelease: 
+  segments: 
+  - 2
+  - 12
+  - 1
+  version: 2.12.1
 platform: ruby
-authors:
+authors: 
 - Steven Baker
 - David Chelimsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-13 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: diff-lcs
-  requirement: !ruby/object:Gem::Requirement
+
+date: 2012-12-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 1
+        - 3
         version: 1.1.3
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.3
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  name: diff-lcs
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 79
+        segments: 
+        - 10
+        - 0
+        - 0
         version: 10.0.0
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 10.0.0
-- !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.9
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rake
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 1
+        - 9
         version: 1.1.9
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.11
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+  name: cucumber
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 4
+        - 11
         version: 0.4.11
+  prerelease: false
+  type: :development
+  name: aruba
+  requirement: *id004
 description: rspec expectations (should[_not] and matchers)
 email: rspec-users@rubyforge.org
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/rspec-expectations.rb
 - lib/rspec/expectations.rb
 - lib/rspec/expectations/deprecation.rb
@@ -211,38 +220,39 @@ files:
 - spec/support/ruby_version.rb
 - spec/support/shared_examples.rb
 homepage: http://github.com/rspec/rspec-expectations
-licenses:
+licenses: 
 - MIT
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --charset=UTF-8
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -3915124233678140450
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -3915124233678140450
+      version: "0"
 requirements: []
+
 rubyforge_project: rspec
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: rspec-expectations-2.12.0
-test_files:
+summary: rspec-expectations-2.12.1
+test_files: 
 - features/README.md
 - features/Upgrade.md
 - features/built_in_matchers/README.md