1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 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 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
|
require 'delegate'
RSpec.describe "and_call_original" do
context "on a partial double" do
let(:klass) do
Class.new do
def meth_1
:original
end
def meth_2(x)
yield x, :additional_yielded_arg
end
if RSpec::Support::RubyFeatures.kw_args_supported?
binding.eval(<<-RUBY, __FILE__, __LINE__)
def meth_3(**kwargs)
kwargs
end
def meth_4(x: 1)
x
end
RUBY
end
if RSpec::Support::RubyFeatures.required_kw_args_supported?
binding.eval(<<-RUBY, __FILE__, __LINE__)
def meth_5(x:)
x
end
RUBY
end
def self.new_instance
new
end
end
end
let(:instance) { klass.new }
context "when a method that exists has been stubbed previously" do
before { allow(instance).to receive(:meth_1).and_return(:override) }
it 'restores the original behavior' do
expect {
allow(instance).to receive(:meth_1).and_call_original
}.to change(instance, :meth_1).from(:override).to(:original)
end
end
context "when a non-existent method has been stubbed previously" do
it 'restores the original NameError behavior' do
expect { instance.abcd }.to raise_error(NameError).with_message(/abcd/)
allow(instance).to receive(:abcd).and_return(:override)
expect(instance.abcd).to eq(:override)
allow(instance).to receive(:abcd).and_call_original
expect { instance.abcd }.to raise_error(NameError).with_message(/abcd/)
end
end
it 'passes the received message through to the original method' do
expect(instance).to receive(:meth_1).and_call_original
expect(instance.meth_1).to eq(:original)
end
it 'ignores prior declared stubs' do
allow(instance).to receive(:meth_1).and_return(:stubbed_value)
expect(instance).to receive(:meth_1).and_call_original
expect(instance.meth_1).to eq(:original)
end
it 'passes args and blocks through to the original method' do
expect(instance).to receive(:meth_2).and_call_original
value = instance.meth_2(:submitted_arg) { |a, b| [a, b] }
expect(value).to eq([:submitted_arg, :additional_yielded_arg])
end
it 'errors when you pass through the wrong number of args' do
expect(instance).to receive(:meth_1).and_call_original
expect(instance).to receive(:meth_2).twice.and_call_original
expect { instance.meth_1 :a }.to raise_error ArgumentError
expect { instance.meth_2 {} }.to raise_error ArgumentError
expect { instance.meth_2(:a, :b) {} }.to raise_error ArgumentError
end
it 'warns when you override an existing implementation' do
expect(RSpec).to receive(:warning).with(/overriding a previous stub implementation of `meth_1`.*#{__FILE__}:#{__LINE__ + 1}/)
expect(instance).to receive(:meth_1) { true }.and_call_original
instance.meth_1
end
context "for singleton methods" do
it 'works' do
def instance.foo; :bar; end
expect(instance).to receive(:foo).and_call_original
expect(instance.foo).to eq(:bar)
end
it 'works for SimpleDelegator subclasses', :if => (RUBY_VERSION.to_f > 1.8) do
inst = Class.new(SimpleDelegator).new(1)
def inst.foo; :bar; end
expect(inst).to receive(:foo).and_call_original
expect(inst.foo).to eq(:bar)
end
end
it 'works for methods added through an extended module' do
instance.extend Module.new { def foo; :bar; end }
expect(instance).to receive(:foo).and_call_original
expect(instance.foo).to eq(:bar)
end
it "works for method added through an extended module onto a class's ancestor" do
sub_sub_klass = Class.new(Class.new(klass))
klass.extend Module.new { def foo; :bar; end }
expect(sub_sub_klass).to receive(:foo).and_call_original
expect(sub_sub_klass.foo).to eq(:bar)
end
it "finds the method on the most direct ancestor even if the method " \
"is available on more distant ancestors" do
klass.extend Module.new { def foo; :klass_bar; end }
sub_klass = Class.new(klass)
sub_klass.extend Module.new { def foo; :sub_klass_bar; end }
expect(sub_klass).to receive(:foo).and_call_original
expect(sub_klass.foo).to eq(:sub_klass_bar)
end
it "finds the method on the most direct singleton class ancestors even if the method " \
"is available on more distant ancestors" do
klass.extend Module.new { def foo; :klass_bar; end }
sub_klass = Class.new(klass) { def self.foo; :sub_klass_bar; end }
sub_sub_klass = Class.new(sub_klass)
expect(sub_sub_klass).to receive(:foo).and_call_original
expect(sub_sub_klass.foo).to eq(:sub_klass_bar)
end
context 'when using any_instance' do
it 'works for instance methods defined on the class' do
expect_any_instance_of(klass).to receive(:meth_1).and_call_original
expect(klass.new.meth_1).to eq(:original)
end
if RSpec::Support::RubyFeatures.kw_args_supported?
binding.eval(<<-RUBY, __FILE__, __LINE__)
it 'works for instance methods that use double splat' do
expect_any_instance_of(klass).to receive(:meth_3).and_call_original
expect(klass.new.meth_3(x: :kwarg)).to eq({x: :kwarg})
end
it 'works for instance methods that use optional keyword arguments' do
expect_any_instance_of(klass).to receive(:meth_4).and_call_original
expect(klass.new.meth_4).to eq(1)
end
it 'works for instance methods that use optional keyword arguments with an argument supplied' do
expect_any_instance_of(klass).to receive(:meth_4).and_call_original
expect(klass.new.meth_4(x: :kwarg)).to eq(:kwarg)
end
RUBY
end
if RSpec::Support::RubyFeatures.required_kw_args_supported?
binding.eval(<<-RUBY, __FILE__, __LINE__)
it 'works for instance methods that use required keyword arguments' do
expect_any_instance_of(klass).to receive(:meth_5).and_call_original
expect(klass.new.meth_5(x: :kwarg)).to eq(:kwarg)
end
RUBY
end
it 'works for instance methods defined on the superclass of the class' do
subclass = Class.new(klass)
expect_any_instance_of(subclass).to receive(:meth_1).and_call_original
expect(subclass.new.meth_1).to eq(:original)
end
it 'works when mocking the method on one class and calling the method on an instance of a subclass' do
expect_any_instance_of(klass).to receive(:meth_1).and_call_original
expect(Class.new(klass).new.meth_1).to eq(:original)
end
end
it 'works for class methods defined on a superclass' do
subclass = Class.new(klass)
expect(subclass).to receive(:new_instance).and_call_original
expect(subclass.new_instance).to be_a(subclass)
end
context 'when a class method is stubbed in the superclass' do
it 'still works for class methods defined on a superclass' do
superclass = Class.new { def self.foo; "foo"; end }
subclass = Class.new(superclass)
allow(superclass).to receive(:foo).and_return(:fake)
expect(subclass).to receive(:foo).and_call_original
expect(superclass.foo).to be :fake
expect(subclass.foo).to eq "foo"
end
end
it 'works for class methods defined on a grandparent class' do
sub_subclass = Class.new(Class.new(klass))
expect(sub_subclass).to receive(:new_instance).and_call_original
expect(sub_subclass.new_instance).to be_a(sub_subclass)
end
it 'works for class methods defined on the Class class' do
expect(klass).to receive(:new).and_call_original
expect(klass.new).to be_an_instance_of(klass)
end
it "works for instance methods defined on the object's class's superclass" do
subclass = Class.new(klass)
inst = subclass.new
expect(inst).to receive(:meth_1).and_call_original
expect(inst.meth_1).to eq(:original)
end
it 'works for aliased methods' do
klazz = Class.new do
class << self
alias alternate_new new
end
end
expect(klazz).to receive(:alternate_new).and_call_original
expect(klazz.alternate_new).to be_an_instance_of(klazz)
end
if RSpec::Support::RubyFeatures.kw_args_supported?
binding.eval(<<-CODE, __FILE__, __LINE__)
it "works for methods that accept keyword arguments" do
def instance.foo(bar: nil); bar; end
expect(instance).to receive(:foo).and_call_original
expect(instance.foo(bar: "baz")).to eq("baz")
end
CODE
end
if RSpec::Support::RubyFeatures.required_kw_args_supported?
binding.eval(<<-RUBY, __FILE__, __LINE__)
context 'on an object with a method propagated by method_missing' do
before do
klass.class_exec do
private
def call_method_with_kwarg(arg, kwarg:)
[arg, kwarg]
end
def method_missing(name, *args, **kwargs)
if name.to_s == "method_with_kwarg"
call_method_with_kwarg(*args, **kwargs)
else
super
end
end
end
end
it 'works for the method propagated by method missing' do
expect(instance).to receive(:method_with_kwarg).with(:arg, kwarg: 1).and_call_original
expect(instance.method_with_kwarg(:arg, kwarg: 1)).to eq([:arg, 1])
end
it 'works for the method of any_instance mock propagated by method missing' do
expect_any_instance_of(klass).to receive(:method_with_kwarg).with(:arg, kwarg: 1).and_call_original
expect(instance.method_with_kwarg(:arg, kwarg: 1)).to eq([:arg, 1])
end
end
RUBY
end
context 'on an object that defines method_missing' do
before do
klass.class_exec do
private
def method_missing(name, *args)
if name.to_s == "greet_jack"
"Hello, jack"
else
super
end
end
end
end
it 'works when the method_missing definition handles the message' do
expect(instance).to receive(:greet_jack).and_call_original
expect(instance.greet_jack).to eq("Hello, jack")
end
it 'works for an any_instance partial mock' do
expect_any_instance_of(klass).to receive(:greet_jack).and_call_original
expect(instance.greet_jack).to eq("Hello, jack")
end
it 'raises an error for an unhandled message for an any_instance partial mock' do
expect_any_instance_of(klass).to receive(:not_a_handled_message).and_call_original
expect {
instance.not_a_handled_message
}.to raise_error(NameError, /not_a_handled_message/)
end
it 'raises an error on invocation if method_missing does not handle the message' do
expect(instance).to receive(:not_a_handled_message).and_call_original
# Note: it should raise a NoMethodError (and usually does), but
# due to a weird rspec-expectations issue (see #183) it sometimes
# raises a `NameError` when a `be_xxx` predicate matcher has been
# recently used. `NameError` is the superclass of `NoMethodError`
# so this example will pass regardless.
# If/when we solve the rspec-expectations issue, this can (and should)
# be changed to `NoMethodError`.
expect {
instance.not_a_handled_message
}.to raise_error(NameError, /not_a_handled_message/)
end
end
end
context "on a partial double that overrides #method" do
let(:request_klass) do
Struct.new(:method, :url) do
def perform
:the_response
end
def self.method
:some_method
end
end
end
let(:request) { request_klass.new(:get, "http://foo.com/bar") }
it 'still works even though #method has been overridden' do
expect(request).to receive(:perform).and_call_original
expect(request.perform).to eq(:the_response)
end
it 'works for a singleton method' do
def request.perform
:a_response
end
expect(request).to receive(:perform).and_call_original
expect(request.perform).to eq(:a_response)
end
end
context "on a pure test double" do
let(:instance) { double }
it 'raises an error even if the double object responds to the message' do
expect(instance.to_s).to be_a(String)
mock_expectation = expect(instance).to receive(:to_s)
instance.to_s # to satisfy the expectation
expect {
mock_expectation.and_call_original
}.to raise_error(/pure test double.*and_call_original.*partial double/i)
end
end
end
|