Class: RSpec::Matchers::BuiltIn::BaseMatcher Private
- Inherits:
-
Object
- Object
- RSpec::Matchers::BuiltIn::BaseMatcher
- Includes:
- DefaultFailureMessages, Composable
- Defined in:
- lib/rspec/matchers/built_in/base_matcher.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
Used internally as a base class for matchers that ship with rspec-expectations and rspec-rails.
Warning:
This class is for internal use, and subject to change without notice. We strongly recommend that you do not base your custom matchers on this class. If/when this changes, we will announce it and remove this warning.
Direct Known Subclasses
All, Be, BeAKindOf, BeAnInstanceOf, BeBetween, BeComparedTo, BeFalsey, BeNil, BeTruthy, BeWithin, Change, ChangeRelatively, Compound, ContainExactly, Cover, DynamicPredicate, Eq, Eql, Equal, Exist, HaveAttributes, Include, Match, Output, RespondTo, Satisfy, SpecificValuesChange, StartOrEndWith, YieldControl, YieldSuccessiveArgs, YieldWithArgs, YieldWithNoArgs
Defined Under Namespace
Modules: DefaultFailureMessages
Constant Summary collapse
- UNDEFINED =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
Used to detect when no arg is passed to
initialize
.nil
cannot be used because it's a valid value to pass. Object.new.freeze
Instance Method Summary collapse
-
#description ⇒ String
private
Generates a description using EnglishPhrasing.
-
#diffable? ⇒ Boolean
private
Matchers are not diffable by default.
- #expects_call_stack_jump? ⇒ Boolean private
-
#initialize(expected = UNDEFINED) ⇒ BaseMatcher
constructor
private
A new instance of BaseMatcher.
-
#match_unless_raises(*exceptions) ⇒ Object
private
Used to wrap a block of code that will indicate failure by raising one of the named exceptions.
-
#matches?(actual) ⇒ Boolean
private
Indicates if the match is successful.
-
#supports_block_expectations? ⇒ Boolean
private
Most matchers are value matchers (i.e. meant to work with
expect(value)
) rather than block matchers (i.e. meant to work withexpect { }
), so this defaults to false.
Methods included from DefaultFailureMessages
#failure_message, #failure_message_when_negated
Methods included from Composable
#===, #and, #description_of, #or, should_enumerate?, surface_descriptions_in, unreadable_io?, #values_match?
Constructor Details
#initialize(expected = UNDEFINED) ⇒ BaseMatcher
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a new instance of BaseMatcher.
28 29 30 |
# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 28 def initialize(expected=UNDEFINED) @expected = expected unless UNDEFINED.equal?(expected) end |
Instance Method Details
#description ⇒ String
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Generates a description using EnglishPhrasing.
60 61 62 63 64 |
# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 60 def description desc = EnglishPhrasing.split_words(self.class.matcher_name) desc << EnglishPhrasing.list(@expected) if defined?(@expected) desc end |
#diffable? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Matchers are not diffable by default. Override this to make your subclass diffable.
69 70 71 |
# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 69 def diffable? false end |
#expects_call_stack_jump? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
87 88 89 |
# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 87 def expects_call_stack_jump? false end |
#match_unless_raises(*exceptions) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Used to wrap a block of code that will indicate failure by raising one of the named exceptions.
This is used by rspec-rails for some of its matchers that wrap rails' assertions.
47 48 49 50 51 52 53 54 55 |
# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 47 def match_unless_raises(*exceptions) exceptions.unshift Exception if exceptions.empty? begin yield true rescue *exceptions => @rescued_exception false end end |
#matches?(actual) ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Indicates if the match is successful. Delegates to match
, which
should be defined on a subclass. Takes care of consistently
initializing the actual
attribute.
36 37 38 39 |
# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 36 def matches?(actual) @actual = actual match(expected, actual) end |
#supports_block_expectations? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Most matchers are value matchers (i.e. meant to work with expect(value)
)
rather than block matchers (i.e. meant to work with expect { }
), so
this defaults to false. Block matchers must override this to return true.
77 78 79 |
# File 'lib/rspec/matchers/built_in/base_matcher.rb', line 77 def supports_block_expectations? false end |