features/matchers/define_matcher_with_user_customizable_message.feature @@ -2,6 +2,9 @@ * enhancements * better messages for should[_not] be_nil (Chad Humphries and Rob Sanheim) + * should and should_not accept optional hash, allowing customized messages + (suggestion from Rob Sanheim) + * result.should be_nil, :or => "we really expected result to be nil" * bug fixes * fixed --line option for ruby 1.9.1 History.rdoc @@ -79,8 +79,8 @@ module Spec # describe Person do # it { should be_eligible_to_vote } # end - def should(matcher=nil) - self == subject ? self.__should_for_example_group__(matcher) : subject.should(matcher) + def should(matcher=nil, options={}) + self == subject ? self.__should_for_example_group__(matcher) : subject.should(matcher,options) end # Just like +should+, +should_not+ delegates to the subject (implicit or @@ -91,8 +91,8 @@ module Spec # describe Person do # it { should_not be_eligible_to_vote } # end - def should_not(matcher=nil) - self == subject ? self.__should_not_for_example_group__(matcher) : subject.should_not(matcher) + def should_not(matcher=nil, options={}) + self == subject ? self.__should_not_for_example_group__(matcher) : subject.should_not(matcher,options) end end end lib/spec/example/subject.rb @@ -23,8 +23,8 @@ module Kernel # # NOTE that this does NOT support receiver.should != expected. # Instead, use receiver.should_not == expected - def should(matcher=nil, &block) - Spec::Expectations::PositiveExpectationHandler.handle_matcher(self, matcher, &block) + def should(matcher=nil, options={}, &block) + Spec::Expectations::PositiveExpectationHandler.handle_matcher(self, matcher, options, &block) end # :call-seq: @@ -46,7 +46,7 @@ module Kernel # => Passes unless (receiver =~ regexp) # # See Spec::Matchers for more information about matchers - def should_not(matcher=nil, &block) - Spec::Expectations::NegativeExpectationHandler.handle_matcher(self, matcher, &block) + def should_not(matcher=nil, options={}, &block) + Spec::Expectations::NegativeExpectationHandler.handle_matcher(self, matcher, options, &block) end end lib/spec/expectations/extensions/kernel.rb @@ -3,7 +3,7 @@ module Spec class InvalidMatcherError < ArgumentError; end class PositiveExpectationHandler - def self.handle_matcher(actual, matcher, &block) + def self.handle_matcher(actual, matcher, options={}, &block) ::Spec::Matchers.last_should = :should ::Spec::Matchers.last_matcher = matcher return ::Spec::Matchers::PositiveOperatorMatcher.new(actual) if matcher.nil? @@ -18,13 +18,13 @@ module Spec if matcher.respond_to?(:diffable?) && matcher.diffable? ::Spec::Expectations.fail_with message, matcher.expected.first, matcher.actual else - ::Spec::Expectations.fail_with message + ::Spec::Expectations.fail_with message << (options[:or] ? "\n#{options[:or]}" : "") end end end class NegativeExpectationHandler - def self.handle_matcher(actual, matcher, &block) + def self.handle_matcher(actual, matcher, options={}, &block) ::Spec::Matchers.last_should = :should_not ::Spec::Matchers.last_matcher = matcher return ::Spec::Matchers::NegativeOperatorMatcher.new(actual) if matcher.nil? @@ -41,7 +41,7 @@ module Spec if matcher.respond_to?(:diffable?) && matcher.diffable? ::Spec::Expectations.fail_with message, matcher.expected.first, matcher.actual else - ::Spec::Expectations.fail_with message + ::Spec::Expectations.fail_with message << (options[:or] ? "\n#{options[:or]}" : "") end end end lib/spec/expectations/handler.rb @@ -95,6 +95,15 @@ module Spec Spec::Expectations::PositiveExpectationHandler.handle_matcher(actual, matcher) end + + it "appends the :or message in the options hash passed to should" do + matcher = mock("matcher", :failure_message_for_should => "message", :matches? => false) + actual = Object.new + + ::Spec::Expectations.should_receive(:fail_with).with("message\nextension") + + Spec::Expectations::PositiveExpectationHandler.handle_matcher(actual, matcher, :or => "extension") + end end end @@ -160,6 +169,15 @@ module Spec Spec::Expectations::NegativeExpectationHandler.handle_matcher(actual, matcher) end + it "appends the :or message in the options hash passed to should" do + matcher = mock("matcher", :failure_message_for_should_not => "message", :matches? => true) + actual = Object.new + + ::Spec::Expectations.should_receive(:fail_with).with("message\nextension") + + Spec::Expectations::NegativeExpectationHandler.handle_matcher(actual, matcher, :or => "extension") + end + end end spec/spec/expectations/handler_spec.rb 4e22ff08a490eb4062b04aa46725ab2577da5adf David Chelimsky dchelimsky@gmail.com http://github.com/dchelimsky/rspec/commit/1420b6f02f5fe2ba97286d895b8215617f80d4a6 1420b6f02f5fe2ba97286d895b8215617f80d4a6 2009-06-28T00:00:48-07:00 2009-06-28T00:00:48-07:00 should and should_not accept optional hash, allowing customized messages (suggestion from Rob Sanheim) 9117e424fb1b7cc26f33b8d46120c9fc62cecd25 David Chelimsky dchelimsky@gmail.com