Class: RSpec::Mocks::BaseExpectation

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

Direct Known Subclasses

MessageExpectation

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(error_generator, expectation_ordering, expected_from, sym, method_block, expected_received_count = 1, opts = {}, &implementation) ⇒ BaseExpectation

Returns a new instance of BaseExpectation.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/rspec/mocks/message_expectation.rb', line 11

def initialize(error_generator, expectation_ordering, expected_from, sym, method_block, expected_received_count=1, opts={}, &implementation)
  @error_generator = error_generator
  @error_generator.opts = opts
  @expected_from = expected_from
  @sym = sym
  @method_block = method_block
  @return_block = nil
  @actual_received_count = 0
  @expected_received_count = expected_received_count
  @args_expectation = ArgumentExpectation.new(ArgumentMatchers::AnyArgsMatcher.new)
  @consecutive = false
  @exception_to_raise = nil
  @symbol_to_throw = nil
  @order_group = expectation_ordering
  @at_least = nil
  @at_most = nil
  @args_to_yield = []
  @failed_fast = nil
  @args_to_yield_were_cloned = false
  @return_block = implementation
  @eval_context = nil
end

Instance Attribute Details

#sym ⇒ Object (readonly)

Returns the value of attribute sym.



5
6
7
 
# File 'lib/rspec/mocks/message_expectation.rb', line 5

def sym
  @sym
end

Instance Method Details

#and_raise(exception = Exception) ⇒ Object

:call-seq:

and_raise()
and_raise(Exception) #any exception class
and_raise(exception) #any exception object

Warning

When you pass an exception class, the MessageExpectation will raise an instance of it, creating it with new. If the exception class initializer requires any parameters, you must pass in an instance and not the class.



76
77
78
 
# File 'lib/rspec/mocks/message_expectation.rb', line 76

def and_raise(exception=Exception)
  @exception_to_raise = exception
end

#and_return(*values, &return_block) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/rspec/mocks/message_expectation.rb', line 51

def and_return(*values, &return_block)
  Kernel::raise AmbiguousReturnError unless @method_block.nil?
  case values.size
    when 0 then value = nil
    when 1 then value = values[0]
  else
    value = values
    @consecutive = true
    @expected_received_count = values.size if !ignoring_args? &&
                                              @expected_received_count < values.size
  end
  @return_block = block_given? ? return_block : lambda { value }
end

#and_throw(symbol) ⇒ Object 



80
81
82
 
# File 'lib/rspec/mocks/message_expectation.rb', line 80

def and_throw(symbol)
  @symbol_to_throw = symbol
end

#and_yield(*args, &block) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/rspec/mocks/message_expectation.rb', line 84

def and_yield(*args, &block)
  if @args_to_yield_were_cloned
    @args_to_yield.clear
    @args_to_yield_were_cloned = false
  end
  
  if block
    @eval_context = Object.new
    @eval_context.extend RSpec::Mocks::InstanceExec
    yield @eval_context
  end
  
  @args_to_yield << args
  self
end

#build_child(expected_from, method_block, expected_received_count, opts = {}) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rspec/mocks/message_expectation.rb', line 34

def build_child(expected_from, method_block, expected_received_count, opts={})
  child = clone
  child.expected_from = expected_from
  child.method_block = method_block
  child.expected_received_count = expected_received_count
  child.clear_actual_received_count!
  new_gen = error_generator.clone
  new_gen.opts = opts
  child.error_generator = new_gen
  child.clone_args_to_yield *@args_to_yield
  child
end

#called_max_times? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
140
 
# File 'lib/rspec/mocks/message_expectation.rb', line 137

def called_max_times?
  @expected_received_count != :any && @expected_received_count > 0 &&
    @actual_received_count >= @expected_received_count
end

#expected_args ⇒ Object 



47
48
49
 
# File 'lib/rspec/mocks/message_expectation.rb', line 47

def expected_args
  @args_expectation.args
end

#invoke(*args, &block) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/rspec/mocks/message_expectation.rb', line 104

def invoke(*args, &block)
  if @expected_received_count == 0
    @failed_fast = true
    @actual_received_count += 1
    @error_generator.raise_expectation_error(@sym, @expected_received_count, @actual_received_count, *args)
  end
  
  @order_group.handle_order_constraint self

  begin
    Kernel::raise @exception_to_raise unless @exception_to_raise.nil?
    Kernel::throw @symbol_to_throw unless @symbol_to_throw.nil?
    
    default_return_val = if !@method_block.nil?
                           invoke_method_block(*args, &block)
                         elsif !@args_to_yield.empty? || @eval_context
                           invoke_with_yield(&block)
                         else
                           nil
                         end
    
    if @consecutive
      invoke_consecutive_return_block(*args, &block)
    elsif @return_block
      invoke_return_block(*args, &block)
    else
      default_return_val
    end
  ensure
    @actual_received_count += 1
  end
end

#matches?(sym, *args) ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/rspec/mocks/message_expectation.rb', line 100

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