rspec-expectations 2.9.0 → 2.9.1

data/Changelog.md

@@ -1,3 +1,14 @@
+### 2.9.1 / 2012-04-03
+[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.9.0...2.9.1)
+
+Bug fixes
+
+* Provide a helpful message if the diff between two objects is empty.
+* Fix bug diffing single strings with multiline strings.
+* Fix for error with using custom matchers inside other custom matchers
+  (mirasrael)
+* Fix using execution context methods in nested DSL matchers (mirasrael)
+
 ### 2.9.0 / 2012-03-17
 [full changelog](http://github.com/rspec/rspec-expectations/compare/v2.8.0...v2.9.0)
 
@@ -9,7 +20,7 @@ Enhancements
 
 Bug fixes
 
-* Align respond_to? and method_missing in DSL-defined matchers.
+* Align `respond_to?` and `method_missing` in DSL-defined matchers.
 * Clear out user-defined instance variables between invocations of DSL-defined
   matchers.
 * Dup the instance of a DSL generated matcher so its state is not changed by

data/lib/rspec/expectations/differ.rb

@@ -5,15 +5,12 @@ require 'pp'
 module RSpec
   module Expectations
     class Differ
-      def initialize(ignore=nil)
-      end
-
       # This is snagged from diff/lcs/ldiff.rb (which is a commandline tool)
       def diff_as_string(data_new, data_old)
         data_old = data_old.split(/\n/).map! { |e| e.chomp }
         data_new = data_new.split(/\n/).map! { |e| e.chomp }
-        output = ""
         diffs = Diff::LCS.diff(data_old, data_new)
+        output = ""
         return output if diffs.empty?
         oldhunk = hunk = nil
         file_length_difference = 0
@@ -41,10 +38,18 @@ module RSpec
         output << oldhunk.diff(format) << "\n"
       end
 
-      def diff_as_object(actual,expected)
-        actual = object_to_string(actual)
-        expected = object_to_string(expected)
-        diff_as_string(actual, expected)
+      def diff_as_object(actual, expected)
+        actual_as_string = object_to_string(actual)
+        expected_as_string = object_to_string(expected)
+        diff = diff_as_string(actual_as_string, expected_as_string)
+
+        if diff.empty?
+          "#{actual}.==(#{expected}) returned false even though the diff " \
+          "between #{actual} and #{expected} is empty. Check the " \
+          "implementation of #{actual}.==."
+        else
+          diff
+        end
       end
 
     protected

data/lib/rspec/expectations/fail_with.rb

@@ -5,7 +5,7 @@ module RSpec
       def differ
         @differ ||= Differ.new
       end
-      
+
       # Raises an RSpec::Expectations::ExpectationNotMetError with message.
       # @param [String] message
       # @param [Object] expected
@@ -22,6 +22,7 @@ module RSpec
         if actual && expected
           if all_strings?(actual, expected)
             if any_multiline_strings?(actual, expected)
+              expected = expected.join(',') if Array === expected
               message << "\nDiff:" << differ.diff_as_string(actual, expected)
             end
           elsif no_procs?(actual, expected) && no_numbers?(actual, expected)

data/lib/rspec/expectations/version.rb

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

data/lib/rspec/matchers/block_aliases.rb

@@ -1,3 +1,4 @@
+require 'rspec/expectations/extensions/kernel'
 module RSpec
   module Matchers
     module BlockAliases

data/lib/rspec/matchers/dsl.rb

@@ -4,10 +4,11 @@ module RSpec
       # Defines a custom matcher.
       # @see RSpec::Matchers
       def define(name, &declarations)
-        matcher = RSpec::Matchers::DSL::Matcher.new(name, &declarations)
+        matcher_template = RSpec::Matchers::DSL::Matcher.new(name, &declarations)
         define_method name do |*expected|
-          $matcher_execution_context = self
-          matcher.for_expected(*expected)
+          matcher = matcher_template.for_expected(*expected)
+          matcher.matcher_execution_context = @matcher_execution_context || self
+          matcher
         end
       end
 

data/lib/rspec/matchers/matcher.rb

@@ -11,6 +11,7 @@ module RSpec
         include RSpec::Matchers
 
         attr_reader :expected, :actual, :rescued_exception
+        attr_accessor :matcher_execution_context
 
         # @api private
         def initialize(name, &declarations)
@@ -23,7 +24,7 @@ module RSpec
           @messages = {}
         end
 
-        PERSISENT_INSTANCE_VARIABLES = [
+        PERSISTENT_INSTANCE_VARIABLES = [
           :@name, :@declarations, :@diffable, :@messages,
           :@match_block, :@match_for_should_not_block,
           :@expected_exception
@@ -34,7 +35,7 @@ module RSpec
           @expected = expected
           dup.instance_eval do
             instance_variables.map {|ivar| ivar.intern}.each do |ivar|
-              instance_variable_set(ivar, nil) unless (PERSISENT_INSTANCE_VARIABLES + [:@expected]).include?(ivar)
+              instance_variable_set(ivar, nil) unless (PERSISTENT_INSTANCE_VARIABLES + [:@expected]).include?(ivar)
             end
             making_declared_methods_public do
               instance_eval_with_args(*@expected, &@declarations)
@@ -222,14 +223,14 @@ module RSpec
         end
 
         def respond_to?(method, include_private=false)
-          $matcher_execution_context.respond_to?(method, include_private) || super
+          super || @matcher_execution_context.respond_to?(method, include_private)
         end
 
         private
 
         def method_missing(method, *args, &block)
-          if $matcher_execution_context.respond_to?(method)
-            $matcher_execution_context.send method, *args, &block
+          if @matcher_execution_context.respond_to?(method)
+            @matcher_execution_context.send method, *args, &block
           else
             super(method, *args, &block)
           end

data/spec/rspec/expectations/differ_spec.rb

@@ -2,34 +2,15 @@ require 'spec_helper'
 require 'ostruct'
 
 module RSpec
-  module Fixtures
-    class Animal
-      def initialize(name,species)
-        @name,@species = name,species
-      end
+  module Expectations
+    describe Differ do
+      let(:differ) { RSpec::Expectations::Differ.new }
 
-      def inspect
-        <<-EOA
-<Animal
-  name=#{@name},
-  species=#{@species}
->
-        EOA
-      end
-    end
-  end
-end
-
-describe "Diff" do
-  before(:each) do
-    @options = OpenStruct.new(:diff_format => :unified, :context_lines => 3)
-    @differ = RSpec::Expectations::Differ.new(@options)
-  end
-
-  it "outputs unified diff of two strings" do
-    expected="foo\nbar\nzap\nthis\nis\nsoo\nvery\nvery\nequal\ninsert\na\nline\n"
-    actual="foo\nzap\nbar\nthis\nis\nsoo\nvery\nvery\nequal\ninsert\na\nanother\nline\n"
-    expected_diff= <<'EOD'
+      describe '#diff_as_string' do
+        it "outputs unified diff of two strings" do
+          expected="foo\nbar\nzap\nthis\nis\nsoo\nvery\nvery\nequal\ninsert\na\nline\n"
+          actual="foo\nzap\nbar\nthis\nis\nsoo\nvery\nvery\nequal\ninsert\na\nanother\nline\n"
+          expected_diff= <<'EOD'
 
 
 @@ -1,6 +1,6 @@
@@ -48,15 +29,58 @@ describe "Diff" do
  line
 EOD
 
-    diff = @differ.diff_as_string(expected, actual)
-    diff.should eql(expected_diff)
-  end
+          diff = differ.diff_as_string(expected, actual)
+          diff.should eql(expected_diff)
+        end
+      end
+
+      describe '#diff_as_object' do
+        it "outputs unified diff message of two objects" do
+          animal_class = Class.new do
+            def initialize(name, species)
+              @name, @species = name, species
+            end
 
-  it "outputs unified diff message of two arrays" do
-    expected = [ :foo, 'bar', :baz, 'quux', :metasyntactic, 'variable', :delta, 'charlie', :width, 'quite wide' ]
-    actual   = [ :foo, 'bar', :baz, 'quux', :metasyntactic, 'variable', :delta, 'tango'  , :width, 'very wide'  ]
+            def inspect
+              <<-EOA
+<Animal
+  name=#{@name},
+  species=#{@species}
+>
+              EOA
+            end
+          end
 
-    expected_diff = <<EOD
+          expected = animal_class.new "bob", "giraffe"
+          actual   = animal_class.new "bob", "tortoise"
+
+          expected_diff = <<'EOD'
+
+@@ -1,5 +1,5 @@
+ <Animal
+   name=bob,
+-  species=tortoise
++  species=giraffe
+ >
+EOD
+
+          diff = differ.diff_as_object(expected,actual)
+          diff.should == expected_diff
+        end
+
+        it "outputs a message if the diff is empty" do
+          diff = differ.diff_as_object('foo', 'foo')
+          diff.should eq(
+            "foo.==(foo) returned false even though the diff between " \
+            "foo and foo is empty. Check the implementation of foo.==."
+          )
+        end
+
+        it "outputs unified diff message of two arrays" do
+          expected = [ :foo, 'bar', :baz, 'quux', :metasyntactic, 'variable', :delta, 'charlie', :width, 'quite wide' ]
+          actual   = [ :foo, 'bar', :baz, 'quux', :metasyntactic, 'variable', :delta, 'tango'  , :width, 'very wide'  ]
+
+          expected_diff = <<'EOD'
 
 
 @@ -5,7 +5,7 @@
@@ -70,33 +94,15 @@ EOD
 + "quite wide"]
 EOD
 
-    diff = @differ.diff_as_object(expected,actual)
-    diff.should == expected_diff
-  end
-
-  it "outputs unified diff message of two objects" do
-    expected = RSpec::Fixtures::Animal.new "bob", "giraffe"
-    actual   = RSpec::Fixtures::Animal.new "bob", "tortoise"
-
-    expected_diff = <<'EOD'
-
-@@ -1,5 +1,5 @@
- <Animal
-   name=bob,
--  species=tortoise
-+  species=giraffe
- >
-EOD
-
-    diff = @differ.diff_as_object(expected,actual)
-    diff.should == expected_diff
-  end
+          diff = differ.diff_as_object(expected,actual)
+          diff.should == expected_diff
+        end
 
-  it "outputs unified diff message of two hashes" do
-    expected = { :foo => 'bar', :baz => 'quux', :metasyntactic => 'variable', :delta => 'charlie', :width =>'quite wide' }
-    actual   = { :foo => 'bar', :metasyntactic => 'variable', :delta => 'charlotte', :width =>'quite wide' }
+        it "outputs unified diff message of two hashes" do
+          expected = { :foo => 'bar', :baz => 'quux', :metasyntactic => 'variable', :delta => 'charlie', :width =>'quite wide' }
+          actual   = { :foo => 'bar', :metasyntactic => 'variable', :delta => 'charlotte', :width =>'quite wide' }
 
-    expected_diff = <<'EOD'
+          expected_diff = <<'EOD'
 
 @@ -1,4 +1,5 @@
 -:delta => "charlotte",
@@ -107,30 +113,30 @@ EOD
  :width => "quite wide"
 EOD
 
-    diff = @differ.diff_as_object(expected,actual)
-    diff.should == expected_diff
-  end
+          diff = differ.diff_as_object(expected,actual)
+          diff.should == expected_diff
+        end
 
-  it "outputs unified diff of single line strings" do
-    expected = "this is one string"
-    actual   = "this is another string"
+        it "outputs unified diff of single line strings" do
+          expected = "this is one string"
+          actual   = "this is another string"
 
-    expected_diff = <<EOD
+          expected_diff = <<'EOD'
 
 @@ -1,2 +1,2 @@
 -"this is another string"
 +"this is one string"
 EOD
 
-    diff = @differ.diff_as_object(expected,actual)
-    diff.should == expected_diff
-  end
+          diff = differ.diff_as_object(expected,actual)
+          diff.should == expected_diff
+        end
 
-  it "outputs unified diff of multi line strings" do
-    expected = "this is:\n  one string"
-    actual   = "this is:\n  another string"
+        it "outputs unified diff of multi line strings" do
+          expected = "this is:\n  one string"
+          actual   = "this is:\n  another string"
 
-    expected_diff = <<EOD
+          expected_diff = <<'EOD'
 
 @@ -1,3 +1,3 @@
  this is:
@@ -138,7 +144,10 @@ EOD
 +  one string
 EOD
 
-    diff = @differ.diff_as_object(expected,actual)
-    diff.should == expected_diff
+          diff = differ.diff_as_object(expected,actual)
+          diff.should == expected_diff
+        end
+      end
+    end
   end
 end

data/spec/rspec/matchers/dsl_spec.rb

@@ -5,6 +5,22 @@ describe "a matcher defined using the matcher DSL" do
     :answer
   end
 
+  def ok
+    "ok"
+  end
+
+  it "supports calling custom matchers from within other custom matchers" do
+    RSpec::Matchers.define :be_ok do
+      match { |actual| actual == ok }
+    end
+
+    RSpec::Matchers.define :be_well do
+      match { |actual| actual.should be_ok }
+    end
+
+    ok.should be_well
+  end
+
   it "has access to methods available in the scope of the example" do
     RSpec::Matchers::define(:ignore) {}
     ignore.question?.should eq(:answer)

data/spec/rspec/matchers/include_spec.rb

@@ -16,6 +16,18 @@ describe "#include matcher" do
           "abc".should include("d")
         }.should fail_matching("expected \"abc\" to include \"d\"")
       end
+
+      it "includes a diff when actual is multiline" do
+        lambda {
+          "abc\ndef".should include("g")
+        }.should fail_matching("expected \"abc\\ndef\" to include \"g\"\nDiff")
+      end
+
+      it "includes a diff when actual is multiline and there are multiple expecteds" do
+        lambda {
+          "abc\ndef".should include("g", "h")
+        }.should fail_matching("expected \"abc\\ndef\" to include \"g\" and \"h\"\nDiff")
+      end
     end
 
     context "for an array target" do

metadata

@@ -1,96 +1,87 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rspec-expectations
-version: !ruby/object:Gem::Version 
-  hash: 43
+version: !ruby/object:Gem::Version
+  version: 2.9.1
   prerelease: 
-  segments: 
-  - 2
-  - 9
-  - 0
-  version: 2.9.0
 platform: ruby
-authors: 
+authors:
 - Steven Baker
 - David Chelimsky
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-17 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2012-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 1
-        - 3
+      - !ruby/object:Gem::Version
         version: 1.1.3
-  prerelease: false
-  requirement: *id001
-  name: diff-lcs
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 9
-        - 2
-        version: 0.9.2
-  prerelease: false
-  requirement: *id002
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
   name: rake
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 1
-        - 9
-        version: 1.1.9
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
   prerelease: false
-  requirement: *id003
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
   name: cucumber
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 4
-        - 11
-        version: 0.4.11
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+  type: :development
   prerelease: false
-  requirement: *id004
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        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
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.11
 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
@@ -207,39 +198,38 @@ files:
 - spec/support/matchers.rb
 - spec/support/ruby_version.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 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -382523939105044110
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -382523939105044110
 requirements: []
-
 rubyforge_project: rspec
-rubygems_version: 1.8.15
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: rspec-expectations-2.9.0
-test_files: 
+summary: rspec-expectations-2.9.1
+test_files:
 - features/README.markdown
 - features/Upgrade.md
 - features/built_in_matchers/README.md
@@ -306,4 +296,3 @@ test_files:
 - spec/support/classes.rb
 - spec/support/matchers.rb
 - spec/support/ruby_version.rb
-has_rdoc: