rspec-expectations 2.11.3 → 2.12.0

data/Changelog.md

@@ -1,5 +1,28 @@
+### 2.12.0 / 2012-11-12
+[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.3...2.12.0)
+
+Enhancements
+
+* Colorize diffs if the `--color` option is configured. (Alex Coplan)
+* Include backtraces in unexpected errors handled by `raise_error`
+  matcher (Myron Marston)
+* Print a warning when users accidentally pass a non-string argument
+  as an expectation message (Sam Phippen)
+* `=~` and `match_array` matchers output a more useful error message when
+  the actual value is not an array (or an object that responds to `#to_ary`)
+  (Sam Phippen)
+
+Bug fixes
+
+* Fix `include` matcher so that `expect({}).to include(:a => nil)`
+  fails as it should (Sam Phippen).
+* Fix `be_an_instance_of` matcher so that `Class#to_s` is used in the
+  description rather than `Class#inspect`, since some classes (like
+  `ActiveRecord::Base`) define a long, verbose `#inspect`.
+  (Tom Stuart)
+
 ### 2.11.3 / 2012-09-04
-[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.2...v.2.11.3)
+[full changelog](http://github.com/rspec/rspec-expectations/compare/v2.11.2...v2.11.3)
 
 Bug fixes
 
@@ -7,7 +30,7 @@ Bug fixes
   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.
+* Ensure #== is defined on built in matchers so that they can be composed.
   For example:
 
     expect {

data/README.md

@@ -56,6 +56,10 @@ actual.should == expected   # passes if actual == expected
 actual.should eql(expected) # passes if actual.eql?(expected)
 ```
 
+Note: we recommend the `eq` matcher over `==` to avoid Ruby's "== in a
+useless context" warning when the `==` matcher is used anywhere but the
+last statement of an example.
+
 ### Identity
 
 ```ruby
@@ -76,8 +80,8 @@ actual.should be_within(delta).of(expected)
 ### Regular expressions
 
 ```ruby
-actual.should =~ /expression/
 actual.should match(/expression/)
+actual.should =~ /expression/
 ```
 
 ### Types/classes

data/features/built_in_matchers/be.feature

@@ -9,7 +9,7 @@ Feature: "be" matchers
 
   Scenario: be_true matcher
     Given a file named "be_true_spec.rb" with:
-      """
+      """ruby
       describe "be_true matcher" do
         specify { true.should be_true }
         specify { 7.should be_true }
@@ -55,7 +55,7 @@ Feature: "be" matchers
 
   Scenario: be_false matcher
     Given a file named "be_false_spec.rb" with:
-      """
+      """ruby
       describe "be_false matcher" do
         specify { nil.should be_false }
         specify { false.should be_false }
@@ -101,7 +101,7 @@ Feature: "be" matchers
 
   Scenario: be_nil matcher
     Given a file named "be_nil_spec.rb" with:
-      """
+      """ruby
       describe "be_nil matcher" do
         specify { nil.should be_nil }
         specify { false.should_not be_nil }
@@ -147,7 +147,7 @@ Feature: "be" matchers
 
   Scenario: be matcher
     Given a file named "be_spec.rb" with:
-      """
+      """ruby
       describe "be_matcher" do
         specify { true.should be }
         specify { 7.should be }

data/features/built_in_matchers/be_within.feature

@@ -20,7 +20,7 @@ Feature: be_within matcher
 
   Scenario: basic usage
     Given a file named "be_within_matcher_spec.rb" with:
-      """
+      """ruby
       describe 27.5 do
         it { should be_within(0.5).of(27.9) }
         it { should be_within(0.5).of(28.0) }

data/features/built_in_matchers/cover.feature

@@ -11,7 +11,7 @@ Feature: cover matcher
 
   Scenario: range usage
     Given a file named "range_cover_matcher_spec.rb" with:
-      """
+      """ruby
       describe (1..10) do
         it { should cover(4) }
         it { should cover(6) }

data/features/built_in_matchers/end_with.feature

@@ -9,7 +9,7 @@ Feature: end_with matcher
 
   Scenario: string usage
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "this string" do
         it { should end_with "string" }
         it { should_not end_with "stringy" }
@@ -27,7 +27,7 @@ Feature: end_with matcher
 
   Scenario: array usage
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe [0, 1, 2, 3, 4] do
         it { should end_with 4 }
         it { should end_with 3, 4 }

data/features/built_in_matchers/equality.feature

@@ -26,7 +26,7 @@ Feature: equality matchers
 
   Scenario: compare using eq (==)
     Given a file named "compare_using_eq.rb" with:
-      """
+      """ruby
       require 'spec_helper'
 
       describe "a string" do
@@ -50,7 +50,7 @@ Feature: equality matchers
 
   Scenario: compare using ==
     Given a file named "compare_using_==.rb" with:
-      """
+      """ruby
       require 'spec_helper'
 
       describe "a string" do
@@ -74,7 +74,7 @@ Feature: equality matchers
 
   Scenario: compare using eql (eql?)
     Given a file named "compare_using_eql.rb" with:
-      """
+      """ruby
       require 'spec_helper'
 
       describe "an integer" do
@@ -97,7 +97,7 @@ Feature: equality matchers
 
   Scenario: compare using equal (equal?)
     Given a file named "compare_using_equal.rb" with:
-      """
+      """ruby
       require 'spec_helper'
 
       describe "a string" do
@@ -121,7 +121,7 @@ Feature: equality matchers
 
   Scenario: compare using be (equal?)
     Given a file named "compare_using_be.rb" with:
-      """
+      """ruby
       require 'spec_helper'
 
       describe "a string" do

data/features/built_in_matchers/exist.feature

@@ -7,7 +7,7 @@ Feature: exist matcher
 
   Scenario: basic usage
     Given a file named "exist_matcher_spec.rb" with:
-      """
+      """ruby
       class Planet
         attr_reader :name
 

data/features/built_in_matchers/expect_change.feature

@@ -4,7 +4,7 @@ Feature: expect change
 
   Background:
     Given a file named "lib/counter.rb" with:
-      """
+      """ruby
       class Counter
         class << self
           def increment
@@ -21,7 +21,7 @@ Feature: expect change
   
   Scenario: expect change
     Given a file named "spec/example_spec.rb" with:
-      """
+      """ruby
       require "counter"
 
       describe Counter, "#increment" do
@@ -41,7 +41,7 @@ Feature: expect change
 
   Scenario: expect no change
     Given a file named "spec/example_spec.rb" with:
-      """
+      """ruby
       require "counter"
 
       describe Counter, "#increment" do

data/features/built_in_matchers/expect_error.feature

@@ -48,7 +48,7 @@ Feature: raise_error matcher
 
   Scenario: match message with a string
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "matching error message with string" do
         it "matches the error message" do
           expect { raise StandardError, 'this message exactly'}.
@@ -61,7 +61,7 @@ Feature: raise_error matcher
 
   Scenario: match message with a regexp
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "matching error message with regex" do
         it "matches the error message" do
           expect { raise StandardError, "my message" }.
@@ -74,7 +74,7 @@ Feature: raise_error matcher
 
   Scenario: match type + message with string
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "matching error message with string" do
         it "matches the error message" do
           expect { raise StandardError, 'this message exactly'}.
@@ -87,7 +87,7 @@ Feature: raise_error matcher
 
   Scenario: match type + message with regexp
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "matching error message with regex" do
         it "matches the error message" do
           expect { raise StandardError, "my message" }.

data/features/built_in_matchers/have.feature

@@ -25,7 +25,7 @@ Feature: have(n).items matcher
 
   Scenario: have(x).items on a collection
     Given a file named "have_items_spec.rb" with:
-      """
+      """ruby
       describe [1, 2, 3] do
         it { should have(3).items }
         it { should_not have(2).items }
@@ -61,7 +61,7 @@ Feature: have(n).items matcher
 
   Scenario: have(x).words on a String when String#words is defined
     Given a file named "have_words_spec.rb" with:
-      """
+      """ruby
       class String
         def words
           split(' ')

data/features/built_in_matchers/include.feature

@@ -25,7 +25,7 @@ Feature: include matcher
 
   Scenario: array usage
     Given a file named "array_include_matcher_spec.rb" with:
-      """
+      """ruby
       describe [1, 3, 7] do
         it { should include(1) }
         it { should include(3) }
@@ -60,7 +60,7 @@ Feature: include matcher
 
   Scenario: string usage
     Given a file named "string_include_matcher_spec.rb" with:
-      """
+      """ruby
       describe "a string" do
         it { should include("str") }
         it { should include("a", "str", "ng") }
@@ -84,7 +84,7 @@ Feature: include matcher
 
   Scenario: hash usage
     Given a file named "hash_include_matcher_spec.rb" with:
-      """
+      """ruby
       describe Hash do
         subject { { :a => 7, :b => 5 } }
 

data/features/built_in_matchers/match.feature

@@ -14,7 +14,7 @@ Feature: match matcher
 
   Scenario: string usage
     Given a file named "string_match_spec.rb" with:
-      """
+      """ruby
       describe "a string" do
         it { should match(/str/) }
         it { should_not match(/foo/) }
@@ -32,7 +32,7 @@ Feature: match matcher
 
   Scenario: regular expression usage
     Given a file named "regexp_match_spec.rb" with:
-      """
+      """ruby
       describe /foo/ do
         it { should match("food") }
         it { should_not match("drinks") }

data/features/built_in_matchers/operators.feature

@@ -26,7 +26,7 @@ Feature: operator matchers
 
   Scenario: numeric operator matchers
     Given a file named "numeric_operator_matchers_spec.rb" with:
-      """
+      """ruby
       describe 18 do
         it { should == 18 }
         it { should be < 20 }
@@ -87,7 +87,7 @@ Feature: operator matchers
 
   Scenario: string operator matchers
     Given a file named "string_operator_matchers_spec.rb" with:
-      """
+      """ruby
       describe "Strawberry" do
         it { should == "Strawberry" }
         it { should be < "Tomato" }
@@ -178,7 +178,7 @@ Feature: operator matchers
 
   Scenario: array operator matchers
     Given a file named "array_operator_matchers_spec.rb" with:
-      """
+      """ruby
       describe [1, 2, 3] do
         it { should == [1, 2, 3] }
         it { should_not == [1, 3, 2] }

data/features/built_in_matchers/predicates.feature

@@ -17,14 +17,15 @@ Feature: predicate matchers
   provide better failure output.
 
   For any predicate method, RSpec gives you a corresponding matcher.  Simply
-  prefix the method with "be_" and remove the question mark.  Examples:
+  prefix the method with `be_` and remove the question mark.  Examples:
 
       7.should_not be_zero       # calls 7.zero?
       [].should be_empty         # calls [].empty?
       x.should be_multiple_of(3) # calls x.multiple_of?(3)
 
-  Alternately, for a predicate method that begins with "has_" like Hash#has_key?,
-  RSpec allows you to use an alternate form since "be_has_key" makes no sense.
+  Alternately, for a predicate method that begins with `has_` like
+  `Hash#has_key?`, RSpec allows you to use an alternate form since `be_has_key`
+  makes no sense.
 
       hash.should have_key(:foo)       # calls hash.has_key?(:foo)
       array.should_not have_odd_values # calls array.has_odd_values?
@@ -37,7 +38,7 @@ Feature: predicate matchers
 
   Scenario: should be_zero (based on Fixnum#zero?)
     Given a file named "should_be_zero_spec.rb" with:
-      """
+      """ruby
       describe 0 do
         it { should be_zero }
       end
@@ -52,7 +53,7 @@ Feature: predicate matchers
 
   Scenario: should_not be_empty (based on Array#empty?)
     Given a file named "should_not_be_empty_spec.rb" with:
-      """
+      """ruby
       describe [1, 2, 3] do
         it { should_not be_empty }
       end
@@ -67,7 +68,7 @@ Feature: predicate matchers
 
    Scenario: should have_key (based on Hash#has_key?)
     Given a file named "should_have_key_spec.rb" with:
-      """
+      """ruby
       describe Hash do
         subject { { :foo => 7 } }
         it { should have_key(:foo) }
@@ -80,7 +81,7 @@ Feature: predicate matchers
 
    Scenario: should_not have_all_string_keys (based on custom #has_all_string_keys? method)
      Given a file named "should_not_have_all_string_keys_spec.rb" with:
-       """
+       """ruby
        class Hash
          def has_all_string_keys?
            keys.all? { |k| String === k }
@@ -105,7 +106,7 @@ Feature: predicate matchers
 
    Scenario: matcher arguments are passed on to the predicate method
      Given a file named "predicate_matcher_argument_spec.rb" with:
-       """
+       """ruby
        class Fixnum
          def multiple_of?(x)
            (self % x).zero?

data/features/built_in_matchers/respond_to.feature

@@ -22,7 +22,7 @@ Feature: respond_to matcher
 
   Scenario: basic usage
     Given a file named "respond_to_matcher_spec.rb" with:
-      """
+      """ruby
       describe "a string" do
         it { should respond_to(:length) }
         it { should respond_to(:hash, :class, :to_s) }
@@ -53,7 +53,7 @@ Feature: respond_to matcher
 
   Scenario: specify arguments
     Given a file named "respond_to_matcher_argument_checking_spec.rb" with:
-      """
+      """ruby
       describe 7 do
         it { should respond_to(:zero?).with(0).arguments }
         it { should_not respond_to(:zero?).with(1).argument }

data/features/built_in_matchers/satisfy.feature

@@ -13,7 +13,7 @@ Feature: satisfy matcher
 
   Scenario: basic usage
     Given a file named "satisfy_matcher_spec.rb" with:
-      """
+      """ruby
       describe 10 do
         it { should satisfy { |v| v > 5 } }
         it { should_not satisfy { |v| v > 15 } }

data/features/built_in_matchers/start_with.feature

@@ -9,7 +9,7 @@ Feature: start_with matcher
 
   Scenario: with a string
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe "this string" do
         it { should start_with "this" }
         it { should_not start_with "that" }
@@ -27,7 +27,7 @@ Feature: start_with matcher
 
   Scenario: with an array
     Given a file named "example_spec.rb" with:
-      """
+      """ruby
       describe [0, 1, 2, 3, 4] do
         it { should start_with 0 }
         it { should start_with(0, 1)}