Class: RSpec::Mocks::MessageExpectation

Inherits:
BaseExpectation show all
Defined in:
lib/rspec/mocks/message_expectation.rb

Direct Known Subclasses

NegativeMessageExpectation

Instance Attribute Summary

Attributes inherited from BaseExpectation

#sym

Instance Method Summary collapse

Methods inherited from BaseExpectation

#and_raise, #and_return, #and_throw, #and_yield, #build_child, #called_max_times?, #expected_args, #initialize, #invoke, #matches?

Constructor Details

This class inherits a constructor from RSpec::Mocks::BaseExpectation

Instance Method Details

#advise(*args) ⇒ Object



238
239
240
# File 'lib/rspec/mocks/message_expectation.rb', line 238

def advise(*args)
  similar_messages << args
end

#any_number_of_times(&block) ⇒ Object



276
277
278
279
280
# File 'lib/rspec/mocks/message_expectation.rb', line 276

def any_number_of_times(&block)
  @method_block = block if block
  @expected_received_count = :any
  self
end

#at_least(n) ⇒ Object



261
262
263
264
# File 'lib/rspec/mocks/message_expectation.rb', line 261

def at_least(n)
  set_expected_received_count :at_least, n
  self
end

#at_most(n) ⇒ Object



266
267
268
269
# File 'lib/rspec/mocks/message_expectation.rb', line 266

def at_most(n)
  set_expected_received_count :at_most, n
  self
end

#exactly(n) ⇒ Object



256
257
258
259
# File 'lib/rspec/mocks/message_expectation.rb', line 256

def exactly(n)
  set_expected_received_count :exactly, n
  self
end

#expected_messages_received?Boolean

Returns:

  • (Boolean)


213
214
215
216
# File 'lib/rspec/mocks/message_expectation.rb', line 213

def expected_messages_received?
  ignoring_args? || matches_exact_count? ||
     matches_at_least_count? || matches_at_most_count?
end

#generate_errorObject



242
243
244
245
246
247
248
# File 'lib/rspec/mocks/message_expectation.rb', line 242

def generate_error
  if similar_messages.empty?
    @error_generator.raise_expectation_error(@sym, @expected_received_count, @actual_received_count, *@args_expectation.args)
  else
    @error_generator.raise_similar_message_args_error(self, *@similar_messages)
  end
end

#ignoring_args?Boolean

Returns:

  • (Boolean)


218
219
220
# File 'lib/rspec/mocks/message_expectation.rb', line 218

def ignoring_args?
  @expected_received_count == :any
end

#matches_at_least_count?Boolean

Returns:

  • (Boolean)


222
223
224
# File 'lib/rspec/mocks/message_expectation.rb', line 222

def matches_at_least_count?
  @at_least && @actual_received_count >= @expected_received_count
end

#matches_at_most_count?Boolean

Returns:

  • (Boolean)


226
227
228
# File 'lib/rspec/mocks/message_expectation.rb', line 226

def matches_at_most_count?
  @at_most && @actual_received_count <= @expected_received_count
end

#matches_exact_count?Boolean

Returns:

  • (Boolean)


230
231
232
# File 'lib/rspec/mocks/message_expectation.rb', line 230

def matches_exact_count?
  @expected_received_count == @actual_received_count
end

#matches_name_but_not_args(sym, *args) ⇒ Object



200
201
202
# File 'lib/rspec/mocks/message_expectation.rb', line 200

def matches_name_but_not_args(sym, *args)
  @sym == sym and not @args_expectation.args_match?(*args)
end

#negative_expectation_for?(sym) ⇒ Boolean

Returns:

  • (Boolean)


306
307
308
# File 'lib/rspec/mocks/message_expectation.rb', line 306

def negative_expectation_for?(sym)
  return false
end

#neverObject



282
283
284
285
# File 'lib/rspec/mocks/message_expectation.rb', line 282

def never
  @expected_received_count = 0
  self
end

#once(&block) ⇒ Object



287
288
289
290
291
# File 'lib/rspec/mocks/message_expectation.rb', line 287

def once(&block)
  @method_block = block if block
  @expected_received_count = 1
  self
end

#ordered(&block) ⇒ Object



299
300
301
302
303
304
# File 'lib/rspec/mocks/message_expectation.rb', line 299

def ordered(&block)
  @method_block = block if block
  @order_group.register(self)
  @ordered = true
  self
end

#similar_messagesObject



234
235
236
# File 'lib/rspec/mocks/message_expectation.rb', line 234

def similar_messages
  @similar_messages ||= []
end

#times(&block) ⇒ Object



271
272
273
274
# File 'lib/rspec/mocks/message_expectation.rb', line 271

def times(&block)
  @method_block = block if block
  self
end

#twice(&block) ⇒ Object



293
294
295
296
297
# File 'lib/rspec/mocks/message_expectation.rb', line 293

def twice(&block)
  @method_block = block if block
  @expected_received_count = 2
  self
end

#verify_messages_receivedObject



204
205
206
207
208
209
210
211
# File 'lib/rspec/mocks/message_expectation.rb', line 204

def verify_messages_received
  return if expected_messages_received? || failed_fast?
    
  generate_error
rescue RSpec::Mocks::MockExpectationError => error
  error.backtrace.insert(0, @expected_from)
  Kernel::raise error
end

#with(*args, &block) ⇒ Object



250
251
252
253
254
# File 'lib/rspec/mocks/message_expectation.rb', line 250

def with(*args, &block)
  @return_block = block if block_given?
  @args_expectation = ArgumentExpectation.new(*args, &block)
  self
end