opal-rspec 0.4.3 → 0.5.0.beta1

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

@@ -0,0 +1,267 @@
+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
+
+        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-existant 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
+        instance = Class.new(SimpleDelegator).new(1)
+        def instance.foo; :bar; end
+        expect(instance).to receive(:foo).and_call_original
+        expect(instance.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
+
+      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
+
+    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
+      klass = Class.new do
+        class << self
+          alias alternate_new new
+        end
+      end
+
+      expect(klass).to receive(:alternate_new).and_call_original
+      expect(klass.alternate_new).to be_an_instance_of(klass)
+    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 overriden' 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

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

@@ -0,0 +1,21 @@
+module RSpec
+  module Mocks
+    RSpec.describe 'and_return' do
+      let(:obj) { double('obj') }
+
+      context 'when a block is passed' do
+        it 'raises ArgumentError' do
+          expect {
+            allow(obj).to receive(:foo).and_return('bar') { 'baz' }
+          }.to raise_error(ArgumentError, /implementation block/i)
+        end
+      end
+
+      context 'when no argument is passed' do
+        it 'raises ArgumentError' do
+          expect { allow(obj).to receive(:foo).and_return }.to raise_error(ArgumentError)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+RSpec.describe "and_wrap_original" do
+  context "on a partial double" do
+    let(:klass) do
+      Class.new do
+        def results
+          (1..100).to_a
+        end
+      end
+    end
+
+    let(:instance) { klass.new }
+
+    it "allows us to modify the results of the original method" do
+      expect {
+        allow(instance).to receive(:results).and_wrap_original do |m|
+          m.call.first(10)
+        end
+      }.to change { instance.results.size }.from(100).to(10)
+    end
+
+    it "raises a name error if the method does not exist" do
+      expect {
+        allow(instance).to receive(:no_results).and_wrap_original { |m| m.call }
+        instance.no_results
+      }.to raise_error NameError
+    end
+
+    it "passes in the original method" do
+      value = nil
+      original_method = instance.method(:results)
+      allow(instance).to receive(:results).and_wrap_original { |m| value = m }
+      instance.results
+      expect(value).to eq original_method
+    end
+
+    it "passes along the message arguments" do
+      values = nil
+      allow(instance).to receive(:results).and_wrap_original { |_, *args| values  = args }
+      instance.results(1, 2, 3)
+      expect(values).to eq [1, 2, 3]
+    end
+
+    it "passes along any supplied block" do
+      value = nil
+      allow(instance).to receive(:results).and_wrap_original { |&b| value = b }
+      instance.results(&(block = proc {}))
+      expect(value).to eq block
+    end
+
+    it "ignores previous stubs" do
+      allow(instance).to receive(:results) { "results" }
+      allow(instance).to receive(:results).and_wrap_original { |m| m.call }
+      expect(instance.results).to_not eq "results"
+    end
+
+    it "can be constrained by specific arguments" do
+      allow(instance).to receive(:results) { :all }
+      allow(instance).to receive(:results).with(5).and_wrap_original { |m, n| m.call.first(n) }
+      expect(instance.results 5).to eq [1,2,3,4,5]
+      expect(instance.results).to eq :all
+    end
+  end
+end

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

@@ -0,0 +1,161 @@
+RSpec.describe RSpec::Mocks::Double do
+
+  let(:obj) { double }
+
+  describe "#and_yield" do
+    context 'when the method double has been constrained by `with`' do
+      it 'uses the default stub if the provided args do not match' do
+        allow(obj).to receive(:foo) { 15 }
+        allow(obj).to receive(:foo).with(:yield).and_yield
+
+        # should_receive is required to trigger the bug:
+        # https://github.com/rspec/rspec-mocks/issues/127
+        expect(obj).to receive(:foo)
+
+        expect(obj.foo(:dont_yield)).to eq(15)
+      end
+    end
+
+    context "with eval context as block argument" do
+
+      it "evaluates the supplied block as it is read" do
+        evaluated = false
+        allow(obj).to receive(:method_that_accepts_a_block).and_yield do |eval_context|
+          evaluated = true
+        end
+        expect(evaluated).to be_truthy
+      end
+
+      it "passes an eval context object to the supplied block" do
+        allow(obj).to receive(:method_that_accepts_a_block).and_yield do |eval_context|
+          expect(eval_context).not_to be_nil
+        end
+      end
+
+      it "evaluates the block passed to the stubbed method in the context of the supplied eval context" do
+        expected_eval_context = nil
+        actual_eval_context = nil
+
+        allow(obj).to receive(:method_that_accepts_a_block).and_yield do |eval_context|
+          expected_eval_context = eval_context
+        end
+
+        obj.method_that_accepts_a_block do
+          actual_eval_context = self
+        end
+
+        expect(actual_eval_context).to equal(expected_eval_context)
+      end
+
+      context "and no yielded arguments" do
+
+        it "passes when expectations set on the eval context are met" do
+          configured_eval_context = nil
+          allow(obj).to receive(:method_that_accepts_a_block).and_yield do |eval_context|
+            configured_eval_context = eval_context
+            expect(configured_eval_context).to receive(:foo)
+          end
+
+          obj.method_that_accepts_a_block do
+            foo
+          end
+
+          verify configured_eval_context
+        end
+
+        it "fails when expectations set on the eval context are not met" do
+          configured_eval_context = nil
+          allow(obj).to receive(:method_that_accepts_a_block).and_yield do |eval_context|
+            configured_eval_context = eval_context
+            expect(configured_eval_context).to receive(:foo)
+          end
+
+          obj.method_that_accepts_a_block do
+            # foo is not called here
+          end
+
+          expect { verify configured_eval_context }.to raise_error(RSpec::Mocks::MockExpectationError)
+        end
+
+      end
+
+      context "and yielded arguments" do
+
+        it "passes when expectations set on the eval context and yielded arguments are met" do
+          configured_eval_context = nil
+          yielded_arg = Object.new
+          allow(obj).to receive(:method_that_accepts_a_block).and_yield(yielded_arg) do |eval_context|
+            configured_eval_context = eval_context
+            expect(configured_eval_context).to receive(:foo)
+            expect(yielded_arg).to receive(:bar)
+          end
+
+          obj.method_that_accepts_a_block do |obj|
+            obj.bar
+            foo
+          end
+
+          verify configured_eval_context
+          verify yielded_arg
+        end
+
+        context "that are optional", :if => RSpec::Support::RubyFeatures.optional_and_splat_args_supported? do
+          it "yields the default argument when the argument is not given" do
+            pending "Not sure how to achieve this yet. See rspec/rspec-mocks#714 and rspec/rspec-support#85."
+            default_arg = Object.new
+            obj = Object.new
+
+            allow(obj).to receive(:a_message).and_yield
+            expect(default_arg).to receive(:bar)
+
+            eval("obj.a_message { |receiver=default_arg| receiver.bar }")
+          end
+
+          it "yields given argument when the argument is given" do
+            default_arg = Object.new
+            allow(default_arg).to receive(:bar)
+
+            given_arg = Object.new
+            obj = Object.new
+
+            allow(obj).to receive(:a_message).and_yield(given_arg)
+            expect(given_arg).to receive(:bar)
+
+            eval("obj.a_message { |receiver=default_arg| receiver.bar }")
+          end
+        end
+
+        it 'can yield to a block that uses `super`' do
+          klass    = Class.new { def foo; 13; end }
+          subklass = Class.new(klass) { def foo(arg); arg.bar { super() }; end }
+
+          arg = double
+          expect(arg).to receive(:bar).and_yield
+
+          instance = subklass.new
+          instance.foo(arg)
+        end
+
+        it "fails when expectations set on the eval context and yielded arguments are not met" do
+          configured_eval_context = nil
+          yielded_arg = Object.new
+          allow(obj).to receive(:method_that_accepts_a_block).and_yield(yielded_arg) do |eval_context|
+            configured_eval_context = eval_context
+            expect(configured_eval_context).to receive(:foo)
+            expect(yielded_arg).to receive(:bar)
+          end
+
+          obj.method_that_accepts_a_block do |obj|
+            # obj.bar is not called here
+            # foo is not called here
+          end
+
+          expect { verify configured_eval_context }.to raise_error(RSpec::Mocks::MockExpectationError)
+          expect { verify yielded_arg }.to raise_error(RSpec::Mocks::MockExpectationError)
+        end
+
+      end
+
+    end
+  end
+end

data/rspec-mocks/spec/rspec/mocks/any_instance/message_chains_spec.rb

@@ -0,0 +1,39 @@
+RSpec.describe RSpec::Mocks::AnyInstance::MessageChains do
+  let(:recorder) { double }
+  let(:chains) { RSpec::Mocks::AnyInstance::MessageChains.new }
+  let(:stub_chain) { RSpec::Mocks::AnyInstance::StubChain.new recorder }
+  let(:expectation_chain) { RSpec::Mocks::AnyInstance::PositiveExpectationChain.new recorder }
+
+  it "knows if a method does not have an expectation set on it" do
+    chains.add(:method_name, stub_chain)
+    expect(chains.has_expectation?(:method_name)).to be_falsey
+  end
+
+  it "knows if a method has an expectation set on it" do
+    chains.add(:method_name, stub_chain)
+    chains.add(:method_name, expectation_chain)
+    expect(chains.has_expectation?(:method_name)).to be_truthy
+  end
+
+  it "can remove all stub chains" do
+    chains.add(:method_name, stub_chain)
+    chains.add(:method_name, expectation_chain)
+    chains.add(:method_name, RSpec::Mocks::AnyInstance::StubChain.new(recorder))
+
+    chains.remove_stub_chains_for!(:method_name)
+    expect(chains[:method_name]).to eq([expectation_chain])
+  end
+
+  context "creating stub chains" do
+    it "understands how to add a stub chain for a method" do
+      chains.add(:method_name, stub_chain)
+      expect(chains[:method_name]).to eq([stub_chain])
+    end
+
+    it "allows multiple stub chains for a method" do
+      chains.add(:method_name, stub_chain)
+      chains.add(:method_name, another_stub_chain = RSpec::Mocks::AnyInstance::StubChain.new(recorder))
+      expect(chains[:method_name]).to eq([stub_chain, another_stub_chain])
+    end
+  end
+end