| 1 |
module Spec |
| 2 |
module Mocks |
| 3 |
class Proxy |
| 4 |
DEFAULT_OPTIONS = { |
| 5 |
:null_object => false, |
| 6 |
} |
| 7 |
|
| 8 |
def initialize(target, name, options={}) |
| 9 |
@target = target |
| 10 |
@name = name |
| 11 |
@error_generator = ErrorGenerator.new target, name |
| 12 |
@expectation_ordering = OrderGroup.new @error_generator |
| 13 |
@expectations = [] |
| 14 |
@messages_received = [] |
| 15 |
@stubs = [] |
| 16 |
@proxied_methods = [] |
| 17 |
@options = options ? DEFAULT_OPTIONS.dup.merge(options) : DEFAULT_OPTIONS |
| 18 |
end |
| 19 |
|
| 20 |
def null_object? |
| 21 |
@options[:null_object] |
| 22 |
end |
| 23 |
|
| 24 |
def add_message_expectation(expected_from, sym, opts={}, &block) |
| 25 |
__add sym |
| 26 |
@expectations << MessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, block_given? ? block : nil, 1, opts) |
| 27 |
@expectations.last |
| 28 |
end |
| 29 |
|
| 30 |
def add_negative_message_expectation(expected_from, sym, &block) |
| 31 |
__add sym |
| 32 |
@expectations << NegativeMessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, block_given? ? block : nil) |
| 33 |
@expectations.last |
| 34 |
end |
| 35 |
|
| 36 |
def add_stub(expected_from, sym, opts={}) |
| 37 |
__add sym |
| 38 |
@stubs.unshift MessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, nil, :any, opts) |
| 39 |
@stubs.first |
| 40 |
end |
| 41 |
|
| 42 |
def verify |
| 43 |
verify_expectations |
| 44 |
ensure |
| 45 |
reset |
| 46 |
end |
| 47 |
|
| 48 |
def reset |
| 49 |
clear_expectations |
| 50 |
clear_stubs |
| 51 |
reset_proxied_methods |
| 52 |
clear_proxied_methods |
| 53 |
end |
| 54 |
|
| 55 |
def received_message?(sym, *args, &block) |
| 56 |
@messages_received.any? {|array| array == [sym, args, block]} |
| 57 |
end |
| 58 |
|
| 59 |
def has_negative_expectation?(sym) |
| 60 |
@expectations.detect {|expectation| expectation.negative_expectation_for?(sym)} |
| 61 |
end |
| 62 |
|
| 63 |
def message_received(sym, *args, &block) |
| 64 |
if expectation = find_matching_expectation(sym, *args) |
| 65 |
expectation.invoke(args, block) |
| 66 |
elsif stub = find_matching_method_stub(sym, *args) |
| 67 |
if expectation = find_almost_matching_expectation(sym, *args) |
| 68 |
if expectation.expected_messages_received? |
| 69 |
stub.invoke([], block) |
| 70 |
else |
| 71 |
expectation.advise(args, block) |
| 72 |
stub.invoke([], block) |
| 73 |
end |
| 74 |
else |
| 75 |
stub.invoke([], block) |
| 76 |
end |
| 77 |
elsif expectation = find_almost_matching_expectation(sym, *args) |
| 78 |
raise_unexpected_message_args_error(expectation, *args) unless has_negative_expectation?(sym) unless null_object? |
| 79 |
else |
| 80 |
@target.send :method_missing, sym, *args, &block |
| 81 |
end |
| 82 |
end |
| 83 |
|
| 84 |
def raise_unexpected_message_args_error(expectation, *args) |
| 85 |
@error_generator.raise_unexpected_message_args_error expectation, *args |
| 86 |
end |
| 87 |
|
| 88 |
def raise_unexpected_message_error(sym, *args) |
| 89 |
@error_generator.raise_unexpected_message_error sym, *args |
| 90 |
end |
| 91 |
|
| 92 |
private |
| 93 |
|
| 94 |
def __add(sym) |
| 95 |
$rspec_mocks.add(@target) unless $rspec_mocks.nil? |
| 96 |
define_expected_method(sym) |
| 97 |
end |
| 98 |
|
| 99 |
def define_expected_method(sym) |
| 100 |
if target_responds_to?(sym) && !target_metaclass.method_defined?(munge(sym)) |
| 101 |
munged_sym = munge(sym) |
| 102 |
target_metaclass.instance_eval do |
| 103 |
alias_method munged_sym, sym if method_defined?(sym.to_s) |
| 104 |
end |
| 105 |
@proxied_methods << sym |
| 106 |
end |
| 107 |
|
| 108 |
target_metaclass.class_eval(<<-EOF, __FILE__, __LINE__) |
| 109 |
def #{sym}(*args, &block) |
| 110 |
__mock_proxy.message_received :#{sym}, *args, &block |
| 111 |
end |
| 112 |
EOF |
| 113 |
end |
| 114 |
|
| 115 |
def target_responds_to?(sym) |
| 116 |
return @target.send(munge(:respond_to?),sym) if @already_proxied_respond_to |
| 117 |
return @already_proxied_respond_to = true if sym == :respond_to? |
| 118 |
return @target.respond_to?(sym) |
| 119 |
end |
| 120 |
|
| 121 |
def munge(sym) |
| 122 |
"proxied_by_rspec__#{sym.to_s}".to_sym |
| 123 |
end |
| 124 |
|
| 125 |
def clear_expectations |
| 126 |
@expectations.clear |
| 127 |
end |
| 128 |
|
| 129 |
def clear_stubs |
| 130 |
@stubs.clear |
| 131 |
end |
| 132 |
|
| 133 |
def clear_proxied_methods |
| 134 |
@proxied_methods.clear |
| 135 |
end |
| 136 |
|
| 137 |
def target_metaclass |
| 138 |
class << @target; self; end |
| 139 |
end |
| 140 |
|
| 141 |
def verify_expectations |
| 142 |
@expectations.each do |expectation| |
| 143 |
expectation.verify_messages_received |
| 144 |
end |
| 145 |
end |
| 146 |
|
| 147 |
def reset_proxied_methods |
| 148 |
@proxied_methods.each do |sym| |
| 149 |
munged_sym = munge(sym) |
| 150 |
target_metaclass.instance_eval do |
| 151 |
if method_defined?(munged_sym.to_s) |
| 152 |
alias_method sym, munged_sym |
| 153 |
undef_method munged_sym |
| 154 |
else |
| 155 |
undef_method sym |
| 156 |
end |
| 157 |
end |
| 158 |
end |
| 159 |
end |
| 160 |
|
| 161 |
def find_matching_expectation(sym, *args) |
| 162 |
@expectations.find {|expectation| expectation.matches(sym, args)} |
| 163 |
end |
| 164 |
|
| 165 |
def find_almost_matching_expectation(sym, *args) |
| 166 |
@expectations.find {|expectation| expectation.matches_name_but_not_args(sym, args)} |
| 167 |
end |
| 168 |
|
| 169 |
def find_matching_method_stub(sym, *args) |
| 170 |
@stubs.find {|stub| stub.matches(sym, args)} |
| 171 |
end |
| 172 |
|
| 173 |
end |
| 174 |
end |
| 175 |
end |
