Class: RSpec::Matchers::BuiltIn::YieldControl Private
- Inherits:
-
BaseMatcher
- Object
- BaseMatcher
- RSpec::Matchers::BuiltIn::YieldControl
- Defined in:
- lib/rspec/matchers/built_in/yield.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.
Provides the implementation for yield_control
.
Not intended to be instantiated directly.
Constant Summary
Constant Summary
Constants inherited from BaseMatcher
Instance Method Summary (collapse)
-
- (Object) at_least(number)
Specifies the minimum number of times the method is expected to yield.
-
- (Object) at_most(number)
Specifies the maximum number of times the method is expected to yield.
-
- (Object) exactly(number)
Specifies that the method is expected to yield the given number of times.
- - (String) failure_message private
- - (String) failure_message_when_negated private
-
- (YieldControl) initialize
constructor
private
A new instance of YieldControl.
-
- (Object) once
Specifies that the method is expected to yield once.
-
- (Object) thrice
Specifies that the method is expected to yield thrice.
-
- (Object) times
No-op.
-
- (Object) twice
Specifies that the method is expected to yield twice.
Methods inherited from BaseMatcher
#description, #diffable?, #expects_call_stack_jump?, #match_unless_raises
Methods included from Composable
#===, #and, #description_of, enumerable?, #or, surface_descriptions_in, #values_match?
Methods included from Pretty
#name, split_words, #to_sentence, #to_word
Constructor Details
- (YieldControl) initialize
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 YieldControl
96 97 98 99 |
# File 'lib/rspec/matchers/built_in/yield.rb', line 96 def initialize @expectation_type = nil @expected_yields_count = nil end |
Instance Method Details
- (Object) at_least(number)
Specifies the minimum number of times the method is expected to yield
138 139 140 141 |
# File 'lib/rspec/matchers/built_in/yield.rb', line 138 def at_least(number) set_expected_yields_count(:>=, number) self end |
- (Object) at_most(number)
Specifies the maximum number of times the method is expected to yield
131 132 133 134 |
# File 'lib/rspec/matchers/built_in/yield.rb', line 131 def at_most(number) set_expected_yields_count(:<=, number) self end |
- (Object) exactly(number)
Specifies that the method is expected to yield the given number of times.
124 125 126 127 |
# File 'lib/rspec/matchers/built_in/yield.rb', line 124 def exactly(number) set_expected_yields_count(:==, number) self end |
- (String) failure_message
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.
168 169 170 |
# File 'lib/rspec/matchers/built_in/yield.rb', line 168 def 'expected given block to yield control' + failure_reason end |
- (String) failure_message_when_negated
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.
174 175 176 |
# File 'lib/rspec/matchers/built_in/yield.rb', line 174 def 'expected given block not to yield control' + failure_reason end |
- (Object) once
Specifies that the method is expected to yield once.
103 104 105 106 |
# File 'lib/rspec/matchers/built_in/yield.rb', line 103 def once exactly(1) self end |
- (Object) thrice
Specifies that the method is expected to yield thrice.
117 118 119 120 |
# File 'lib/rspec/matchers/built_in/yield.rb', line 117 def thrice exactly(3) self end |
- (Object) times
No-op. Provides syntactic sugar.
145 146 147 |
# File 'lib/rspec/matchers/built_in/yield.rb', line 145 def times self end |
- (Object) twice
Specifies that the method is expected to yield twice.
110 111 112 113 |
# File 'lib/rspec/matchers/built_in/yield.rb', line 110 def twice exactly(2) self end |