Class: RSpec::Matchers::BuiltIn::YieldControl Private

Inherits:

BaseMatcher

• Object
• BaseMatcher
• RSpec::Matchers::BuiltIn::YieldControl

show all

Defined in:

lib/rspec/matchers/built_in/yield.rb

Overview

Constant Summary

Constant Summary

Constants inherited from BaseMatcher

BaseMatcher::UNDEFINED

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, #or, should_enumerate?, surface_descriptions_in, unreadable_io?, #values_match?

100
101
102

# File 'lib/rspec/matchers/built_in/yield.rb', line 100
def initialize
  at_least(:once)
end

141
142
143
144

# File 'lib/rspec/matchers/built_in/yield.rb', line 141
def at_least(number)
  set_expected_yields_count(:>=, number)
  self
end

134
135
136
137

# File 'lib/rspec/matchers/built_in/yield.rb', line 134
def at_most(number)
  set_expected_yields_count(:<=, number)
  self
end

127
128
129
130

# File 'lib/rspec/matchers/built_in/yield.rb', line 127
def exactly(number)
  set_expected_yields_count(:==, number)
  self
end

167
168
169

# File 'lib/rspec/matchers/built_in/yield.rb', line 167
def failure_message
  'expected given block to yield control' + failure_reason
end

173
174
175

# File 'lib/rspec/matchers/built_in/yield.rb', line 173
def failure_message_when_negated
  'expected given block not to yield control' + failure_reason
end

106
107
108
109

# File 'lib/rspec/matchers/built_in/yield.rb', line 106
def once
  exactly(1)
  self
end

120
121
122
123

# File 'lib/rspec/matchers/built_in/yield.rb', line 120
def thrice
  exactly(3)
  self
end

148
149
150

# File 'lib/rspec/matchers/built_in/yield.rb', line 148
def times
  self
end

113
114
115
116

# File 'lib/rspec/matchers/built_in/yield.rb', line 113
def twice
  exactly(2)
  self
end