opal-connect-rspec 0.5.0

data/rspec-mocks/spec/rspec/mocks/stub_implementation_spec.rb

@@ -0,0 +1,98 @@
+module RSpec
+  module Mocks
+    RSpec.describe "stub implementation" do
+      describe "with no args" do
+        it "execs the block when called" do
+          obj = double()
+          allow(obj).to receive(:foo) { :bar }
+          expect(obj.foo).to eq :bar
+        end
+      end
+
+      describe "with one arg" do
+        it "execs the block with that arg when called" do
+          obj = double()
+          allow(obj).to receive(:foo) {|given| given}
+          expect(obj.foo(:bar)).to eq :bar
+        end
+      end
+
+      describe "with variable args" do
+        it "execs the block when called" do
+          obj = double()
+          allow(obj).to receive(:foo) {|*given| given.first}
+          expect(obj.foo(:bar)).to eq :bar
+        end
+      end
+    end
+
+    RSpec.describe "unstubbing with `and_call_original`" do
+      it "replaces the stubbed method with the original method" do
+        obj = Object.new
+        def obj.foo; :original; end
+        allow(obj).to receive(:foo)
+        allow(obj).to receive(:foo).and_call_original
+        expect(obj.foo).to eq :original
+      end
+
+      it "removes all stubs with the supplied method name" do
+        obj = Object.new
+        def obj.foo; :original; end
+        allow(obj).to receive(:foo).with(1)
+        allow(obj).to receive(:foo).with(2)
+        allow(obj).to receive(:foo).and_call_original
+        expect(obj.foo).to eq :original
+      end
+
+      it "does not remove any expectations with the same method name" do
+        obj = Object.new
+        def obj.foo; :original; end
+        expect(obj).to receive(:foo).with(3).and_return(:three)
+        allow(obj).to receive(:foo).with(1)
+        allow(obj).to receive(:foo).with(2)
+        allow(obj).to receive(:foo).and_call_original
+        expect(obj.foo(3)).to eq :three
+      end
+
+      shared_examples_for "stubbing `new` on class objects" do
+        it "restores the correct implementations when stubbed and unstubbed on a parent and child class" do
+          parent = stub_const("Parent", Class.new)
+          child  = stub_const("Child", Class.new(parent))
+
+          allow(parent).to receive(:new)
+          allow(child).to receive(:new)
+          allow(parent).to receive(:new).and_call_original
+          allow(child).to receive(:new).and_call_original
+
+          expect(parent.new).to be_an_instance_of parent
+          expect(child.new).to be_an_instance_of child
+        end
+
+        it "restores the correct implementations when stubbed and unstubbed on a grandparent and grandchild class" do
+          grandparent = stub_const("GrandParent", Class.new)
+          parent      = stub_const("Parent", Class.new(grandparent))
+          child       = stub_const("Child", Class.new(parent))
+
+          allow(grandparent).to receive(:new)
+          allow(child).to receive(:new)
+          allow(grandparent).to receive(:new).and_call_original
+          allow(child).to receive(:new).and_call_original
+
+          expect(grandparent.new).to be_an_instance_of grandparent
+          expect(child.new).to be_an_instance_of child
+        end
+      end
+
+      context "when partial doubles are not verified" do
+        before { expect(RSpec::Mocks.configuration.verify_partial_doubles?).to be false }
+        include_examples "stubbing `new` on class objects"
+      end
+
+      context "when partial doubles are verified" do
+        include_context "with isolated configuration"
+        before { RSpec::Mocks.configuration.verify_partial_doubles = true }
+        include_examples "stubbing `new` on class objects"
+      end
+    end
+  end
+end

data/rspec-mocks/spec/rspec/mocks/stub_spec.rb

@@ -0,0 +1,520 @@
+module RSpec
+  module Mocks
+    RSpec.describe "A method stub" do
+      before(:each) do
+        @class = Class.new do
+          class << self
+            def existing_class_method
+              existing_private_class_method
+            end
+
+            private
+            def existing_private_class_method
+              :original_value
+            end
+          end
+
+          def existing_instance_method
+            existing_private_instance_method
+          end
+
+          private
+          def existing_private_instance_method
+            :original_value
+          end
+        end
+        @instance = @class.new
+        @stub = Object.new
+      end
+
+      describe "using stub" do
+        it "returns declared value when message is received" do
+          allow(@instance).to receive(:msg).and_return(:return_value)
+          expect(@instance.msg).to equal(:return_value)
+          verify @instance
+        end
+      end
+
+      it "instructs an instance to respond_to the message" do
+        allow(@instance).to receive(:msg)
+        expect(@instance).to respond_to(:msg)
+      end
+
+      it "instructs a class object to respond_to the message" do
+        allow(@class).to receive(:msg)
+        expect(@class).to respond_to(:msg)
+      end
+
+      it "ignores when expected message is received with no args" do
+        allow(@instance).to receive(:msg)
+        @instance.msg
+        expect do
+          verify @instance
+        end.not_to raise_error
+      end
+
+      it "ignores when message is received with args" do
+        allow(@instance).to receive(:msg)
+        @instance.msg(:an_arg)
+        expect do
+          verify @instance
+        end.not_to raise_error
+      end
+
+      it "ignores when expected message is not received" do
+        allow(@instance).to receive(:msg)
+        expect do
+          verify @instance
+        end.not_to raise_error
+      end
+
+      it "handles multiple stubbed methods" do
+        allow(@instance).to receive_messages(:msg1 => 1, :msg2 => 2)
+        expect(@instance.msg1).to eq(1)
+        expect(@instance.msg2).to eq(2)
+      end
+
+      it "is retained when stubbed object is `clone`d" do
+        allow(@stub).to receive(:foobar).and_return(1)
+        expect(@stub.clone.foobar).to eq(1)
+      end
+
+      it "is cleared when stubbed object when `dup`ed" do
+        allow(@stub).to receive(:foobar).and_return(1)
+        expect{ @stub.dup.foobar }.to raise_error NoMethodError, /foobar/
+      end
+
+      context "using `with`" do
+        it 'determines which value is returned' do
+          allow(@stub).to receive(:foo).with(1) { :one }
+          allow(@stub).to receive(:foo).with(2) { :two }
+
+          expect(@stub.foo(2)).to eq(:two)
+          expect(@stub.foo(1)).to eq(:one)
+        end
+
+        it 'allows differing arities' do
+          allow(@stub).to receive(:foo).with(:two, :args) { :two_args }
+          allow(@stub).to receive(:foo).with(:three, :args, :total) { :three_args_total }
+
+          expect(@stub.foo(:two, :args)).to eq(:two_args)
+          expect(@stub.foo(:three, :args, :total)).to eq(:three_args_total)
+        end
+      end
+
+      context "stubbing with prepend", :if => Support::RubyFeatures.module_prepends_supported? do
+        module ToBePrepended
+          def value
+            "#{super}_prepended".to_sym
+          end
+        end
+
+        it "handles stubbing prepended methods" do
+          klass = Class.new { prepend ToBePrepended; def value; :original; end }
+          instance = klass.new
+          expect(instance.value).to eq :original_prepended
+          allow(instance).to receive(:value) { :stubbed }
+          expect(instance.value).to eq :stubbed
+        end
+
+        it "handles stubbing prepended methods on a class's singleton class" do
+          klass = Class.new { class << self; prepend ToBePrepended; end; def self.value; :original; end }
+          expect(klass.value).to eq :original_prepended
+          allow(klass).to receive(:value) { :stubbed }
+          expect(klass.value).to eq :stubbed
+        end
+
+        it "handles stubbing prepended methods on an object's singleton class" do
+          object = Object.new
+          def object.value; :original; end
+          object.singleton_class.send(:prepend, ToBePrepended)
+
+          expect(object.value).to eq :original_prepended
+          allow(object).to receive(:value) { :stubbed }
+          expect(object.value).to eq :stubbed
+        end
+
+        it 'does not unnecessarily prepend a module when the prepended module does not override the stubbed method' do
+          object = Object.new
+          def object.value; :original; end
+          object.singleton_class.send(:prepend, Module.new)
+
+          expect {
+            allow(object).to receive(:value) { :stubbed }
+          }.not_to change { object.singleton_class.ancestors }
+        end
+
+        it 'does not unnecessarily prepend a module when stubbing a method on a module extended onto itself' do
+          mod = Module.new do
+            extend self
+            def foo; :bar; end
+          end
+
+          expect {
+            allow(mod).to receive(:foo)
+          }.not_to change { mod.singleton_class.ancestors }
+        end
+
+        it 'does not unnecessarily prepend a module when the module was included' do
+          object = Object.new
+          def object.value; :original; end
+          object.singleton_class.send(:include, ToBePrepended)
+
+          expect {
+            allow(object).to receive(:value) { :stubbed }
+          }.not_to change { object.singleton_class.ancestors }
+        end
+
+        it 'reuses our prepend module so as not to keep mutating the ancestors' do
+          object = Object.new
+          def object.value; :original; end
+          object.singleton_class.send(:prepend, ToBePrepended)
+          allow(object).to receive(:value) { :stubbed }
+
+          RSpec::Mocks.teardown
+          RSpec::Mocks.setup
+
+          expect {
+            allow(object).to receive(:value) { :stubbed }
+          }.not_to change { object.singleton_class.ancestors }
+        end
+
+        context "when multiple modules are prepended, only one of which overrides the stubbed method" do
+          it "can still be stubbed and reset" do
+            object = Object.new
+            object.singleton_class.class_eval do
+              def value; :original; end
+              prepend ToBePrepended
+              prepend Module.new { }
+            end
+
+            expect(object.value).to eq :original_prepended
+            allow(object).to receive(:value) { :stubbed }
+            expect(object.value).to eq :stubbed
+            reset object
+            expect(object.value).to eq :original_prepended
+          end
+        end
+
+        context "when a module with a method override is prepended after reset" do
+          it "can still be stubbed again" do
+            object = Object.new
+            def object.value; :original; end
+            object.singleton_class.send(:prepend, ToBePrepended)
+            allow(object).to receive(:value) { :stubbed }
+
+            RSpec::Mocks.teardown
+            RSpec::Mocks.setup
+
+            object.singleton_class.send(:prepend, Module.new {
+              def value
+                :"#{super}_extra_prepend"
+              end
+            })
+
+            allow(object).to receive(:value) { :stubbed_2 }
+            expect(object.value).to eq(:stubbed_2)
+          end
+        end
+      end
+
+      describe "#rspec_reset" do
+        it "removes stubbed methods that didn't exist" do
+          allow(@instance).to receive(:non_existent_method)
+          reset @instance
+          expect(@instance).not_to respond_to(:non_existent_method)
+        end
+
+        it "restores existing instance methods" do
+          # See bug reports 8302 and 7805
+          allow(@instance).to receive(:existing_instance_method) { :stub_value }
+          reset @instance
+          expect(@instance.existing_instance_method).to eq(:original_value)
+        end
+
+        it "restores existing singleton methods with the appropriate context" do
+          klass = Class.new do
+            def self.say_hello
+              @hello if defined?(@hello)
+            end
+          end
+
+          subclass = Class.new(klass)
+
+          subclass.instance_variable_set(:@hello, "Hello")
+          expect(subclass.say_hello).to eq("Hello")
+
+          allow(klass).to receive(:say_hello) { "Howdy" }
+          expect(subclass.say_hello).to eq("Howdy")
+
+          reset klass
+          expect(subclass.say_hello).to eq("Hello")
+        end
+
+        it "restores existing private instance methods" do
+          # See bug reports 8302 and 7805
+          allow(@instance).to receive(:existing_private_instance_method) { :stub_value }
+          reset @instance
+          expect(@instance.send(:existing_private_instance_method)).to eq(:original_value)
+        end
+
+        it "restores existing class methods" do
+          # See bug reports 8302 and 7805
+          allow(@class).to receive(:existing_class_method) { :stub_value }
+          reset @class
+          expect(@class.existing_class_method).to eq(:original_value)
+        end
+
+        it "restores existing private class methods" do
+          # See bug reports 8302 and 7805
+          allow(@class).to receive(:existing_private_class_method) { :stub_value }
+          reset @class
+          expect(@class.send(:existing_private_class_method)).to eq(:original_value)
+        end
+
+        it "does not remove existing methods that have been stubbed twice" do
+          allow(@instance).to receive(:existing_instance_method)
+          allow(@instance).to receive(:existing_instance_method)
+
+          reset @instance
+
+          expect(@instance.existing_instance_method).to eq(:original_value)
+        end
+
+        it "correctly restores the visibility of methods whose visibility has been tweaked on the singleton class" do
+          # hello is a private method when mixed in, but public on the module
+          # itself
+          mod = Module.new {
+            extend self
+            def hello; :hello; end
+
+            private :hello
+            class << self; public :hello; end;
+          }
+
+          expect(mod.hello).to eq(:hello)
+
+          allow(mod).to receive(:hello) { :stub }
+          reset mod
+
+          expect(mod.hello).to eq(:hello)
+        end
+
+        it "correctly handles stubbing inherited mixed in class methods" do
+          mod = Module.new do
+                  def method_a
+                    raise "should not execute method_a"
+                  end
+
+                  def self.included(other)
+                    other.extend self
+                  end
+                end
+
+          a = Class.new { include mod }
+          b = Class.new(a) do
+                def self.method_b
+                  "executed method_b"
+                end
+              end
+
+          allow(a).to receive(:method_a)
+          allow(b).to receive(:method_b).and_return("stubbed method_b")
+
+          expect(b.method_b).to eql("stubbed method_b")
+        end
+
+        if Support::RubyFeatures.module_prepends_supported?
+          context "with a prepended module (ruby 2.0.0+)" do
+            module ToBePrepended
+              def existing_method
+                "#{super}_prepended".to_sym
+              end
+            end
+
+            before do
+              @prepended_class = Class.new do
+                prepend ToBePrepended
+
+                def existing_method
+                  :original_value
+                end
+
+                def non_prepended_method
+                  :not_prepended
+                end
+              end
+              @prepended_instance = @prepended_class.new
+            end
+
+            it "restores prepended instance methods" do
+              allow(@prepended_instance).to receive(:existing_method) { :stubbed }
+              expect(@prepended_instance.existing_method).to eq :stubbed
+
+              reset @prepended_instance
+              expect(@prepended_instance.existing_method).to eq :original_value_prepended
+            end
+
+            it "restores non-prepended instance methods" do
+              allow(@prepended_instance).to receive(:non_prepended_method) { :stubbed }
+              expect(@prepended_instance.non_prepended_method).to eq :stubbed
+
+              reset @prepended_instance
+              expect(@prepended_instance.non_prepended_method).to eq :not_prepended
+            end
+
+            it "restores prepended class methods" do
+              klass = Class.new do
+                class << self; prepend ToBePrepended; end
+                def self.existing_method
+                  :original_value
+                end
+              end
+
+              allow(klass).to receive(:existing_method) { :stubbed }
+              expect(klass.existing_method).to eq :stubbed
+
+              reset klass
+              expect(klass.existing_method).to eq :original_value_prepended
+            end
+
+            it "restores prepended object singleton methods" do
+              object = Object.new
+              def object.existing_method; :original_value; end
+              object.singleton_class.send(:prepend, ToBePrepended)
+
+              allow(object).to receive(:existing_method) { :stubbed }
+              expect(object.existing_method).to eq :stubbed
+
+              reset object
+              expect(object.existing_method).to eq :original_value_prepended
+            end
+          end
+        end
+      end
+
+      it "returns values in order to consecutive calls" do
+        allow(@instance).to receive(:msg).and_return("1",2,:three)
+        expect(@instance.msg).to eq("1")
+        expect(@instance.msg).to eq(2)
+        expect(@instance.msg).to eq(:three)
+      end
+
+      it "keeps returning last value in consecutive calls" do
+        allow(@instance).to receive(:msg).and_return("1",2,:three)
+        expect(@instance.msg).to eq("1")
+        expect(@instance.msg).to eq(2)
+        expect(@instance.msg).to eq(:three)
+        expect(@instance.msg).to eq(:three)
+        expect(@instance.msg).to eq(:three)
+      end
+
+      it "yields a specified object" do
+        allow(@instance).to receive(:method_that_yields).and_yield(:yielded_obj)
+        current_value = :value_before
+        @instance.method_that_yields {|val| current_value = val}
+        expect(current_value).to eq :yielded_obj
+        verify @instance
+      end
+
+      it "yields multiple times with multiple calls to and_yield" do
+        allow(@instance).to receive(:method_that_yields_multiple_times).and_yield(:yielded_value).
+                                                       and_yield(:another_value)
+        current_value = []
+        @instance.method_that_yields_multiple_times {|val| current_value << val}
+        expect(current_value).to eq [:yielded_value, :another_value]
+        verify @instance
+      end
+
+      it "yields a specified object and return another specified object" do
+        yielded_obj = double("my mock")
+        expect(yielded_obj).to receive(:foo).with(:bar)
+        allow(@instance).to receive(:method_that_yields_and_returns).and_yield(yielded_obj).and_return(:baz)
+        expect(@instance.method_that_yields_and_returns { |o| o.foo :bar }).to eq :baz
+      end
+
+      it "throws when told to" do
+        allow(@stub).to receive(:something).and_throw(:up)
+        expect { @stub.something }.to throw_symbol(:up)
+      end
+
+      it "throws with argument when told to" do
+        allow(@stub).to receive(:something).and_throw(:up, 'high')
+        expect { @stub.something }.to throw_symbol(:up, 'high')
+      end
+
+      it "overrides a pre-existing method" do
+        allow(@stub).to receive(:existing_instance_method).and_return(:updated_stub_value)
+        expect(@stub.existing_instance_method).to eq :updated_stub_value
+      end
+
+      it "overrides a pre-existing stub" do
+        allow(@stub).to receive(:foo) { 'bar' }
+        allow(@stub).to receive(:foo) { 'baz' }
+        expect(@stub.foo).to eq 'baz'
+      end
+
+      it "allows a stub and an expectation" do
+        allow(@stub).to receive(:foo).with("bar")
+        expect(@stub).to receive(:foo).with("baz")
+        @stub.foo("bar")
+        @stub.foo("baz")
+      end
+    end
+
+    RSpec.describe "A method stub with args" do
+      before(:each) do
+        @stub = Object.new
+        allow(@stub).to receive(:foo).with("bar")
+      end
+
+      it "does not complain if not called" do
+      end
+
+      it "does not complain if called with arg" do
+        @stub.foo("bar")
+      end
+
+      it "complains if called with no arg" do
+        expect {
+          @stub.foo
+        }.to raise_error(/received :foo with unexpected arguments/)
+      end
+
+      it "complains if called with other arg", :github_issue => [123,147] do
+        expect {
+          @stub.foo("other")
+        }.to raise_error(/received :foo with unexpected arguments.*Please stub a default value/m)
+      end
+
+      it "does not complain if also mocked w/ different args" do
+        expect(@stub).to receive(:foo).with("baz")
+        @stub.foo("bar")
+        @stub.foo("baz")
+      end
+
+      it "complains if also mocked w/ different args AND called w/ a 3rd set of args" do
+        expect(@stub).to receive(:foo).with("baz")
+        @stub.foo("bar")
+        @stub.foo("baz")
+        expect {
+          @stub.foo("other")
+        }.to raise_error
+      end
+
+      it 'uses the correct stubbed response when responding to a mock expectation' do
+        allow(@stub).to receive(:bar) { 15 }
+        allow(@stub).to receive(:bar).with(:eighteen) { 18 }
+        allow(@stub).to receive(:bar).with(:thirteen) { 13 }
+
+        expect(@stub).to receive(:bar).exactly(4).times
+
+        expect(@stub.bar(:blah)).to eq(15)
+        expect(@stub.bar(:thirteen)).to eq(13)
+        expect(@stub.bar(:eighteen)).to eq(18)
+        expect(@stub.bar).to eq(15)
+      end
+    end
+
+  end
+end