better_receive 0.3.0 → 0.4.0

data/README.md

@@ -1,6 +1,7 @@
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/se3000/better_receive)
 # BetterReceive
 
-BetterReceive helps test drive new functionality and prevent bugs by asserting that an object responds to a method before mocking it.
+Test drive new functionality and prevent bugs by asserting objects respond to methods when mocking/stubbing.
 
 ## Installation
 
@@ -10,17 +11,22 @@ BetterReceive helps test drive new functionality and prevent bugs by asserting t
 
 
 ```ruby
+
 class Foo; end
 foo = Foo.new
 
 foo.better_receive(:bar)
+# or
+foo.better_stub(bar: 1, baz: 2)
+# or
+Foo.any_instance.better_receive(:bar).with(:wibble)
+
 ```
-or
-```ruby
-Foo.any_instance.better_receive(:bar)
-```
 
-Either situation will raise an error because instances of Foo do not respond to :bar.
+Any of these situation will raise an error because instances of Foo do not respond to :bar.
+
+After the initial extra assertion, they continue to act like regular RSpec mocks/stubs.
+
 
 ## Contributing
 
@@ -32,7 +38,6 @@ Either situation will raise an error because instances of Foo do not respond to
 
 ## To Do
 
-* #better_stub
 * support arrity checks with #responds_to
 * support options other than Ruby 1.9.2+ and RSpec
 

data/lib/better_receive.rb

@@ -1,9 +1,15 @@
 require "better_receive/version"
+require "better_receive/base"
 require "better_receive/mock"
+require "better_receive/stub"
 
 module BetterReceive
-  def better_receive(*args)
-    Mock.new(self).responds_to_and_receives(*args)
+  def better_receive(*args, &block)
+    Mock.new(self).assert_with(*args, &block)
+  end
+
+  def better_stub(*args, &block)
+    Stub.new(self).assert_with(*args, &block)
   end
 end
 

data/lib/better_receive/base.rb

@@ -0,0 +1,47 @@
+module BetterReceive
+  class Base
+
+    def initialize(subject)
+      @subject = subject
+    end
+
+
+    private
+
+    attr_reader :subject
+
+    def subject_is_any_instance?
+      subject.is_a?(RSpec::Mocks::AnyInstance::Recorder)
+    end
+
+    def respond_to(selector)
+      RSpec::Matchers::BuiltIn::RespondTo.new(selector)
+    end
+
+    def subject_mock_proxy
+      @mock_proxy ||= subject.send(:__mock_proxy)
+    end
+
+    def any_instance_better_expect(selector, options, &block)
+      any_instance_should_respond_to selector
+      any_instance_add_expectation selector, &block
+    end
+
+    def any_instance_should_respond_to(selector)
+      klass = subject.instance_variable_get(:@klass)
+      unless klass.method_defined?(selector)
+        raise "Expected instances of #{klass.name} to respond to :#{selector}"
+      end
+    end
+
+    def any_instance_add_expectation(selector, &block)
+      RSpec::Mocks::space.add(subject)
+
+      subject.instance_variable_set(:@expectation_set, true)
+      subject.send(:observe!, selector)
+
+      subject.message_chains.add(selector, expectation_chain(selector, &block))
+    end
+
+  end
+end

data/lib/better_receive/mock.rb

@@ -1,13 +1,9 @@
 module BetterReceive
-  class Mock
+  class Mock < Base
 
-    def initialize(subject)
-      @subject = subject
-    end
-
-    def responds_to_and_receives(selector, options={}, &block)
-      if subject.is_a?(RSpec::Mocks::AnyInstance::Recorder)
-        any_instance_better_receive(selector, options, &block)
+    def assert_with(selector, options={}, &block)
+      if subject_is_any_instance?
+        any_instance_better_expect(selector, options, &block)
       else
         subject.should respond_to selector
         mock_subject_method(selector, options, &block)
@@ -17,42 +13,11 @@ module BetterReceive
 
     private
 
-    attr_reader :subject
-
-    def respond_to(selector)
-      RSpec::Matchers::BuiltIn::RespondTo.new(selector)
-    end
-
     def mock_subject_method(selector, options, &block)
       location = options[:expected_from] || caller(1)[2]
       subject_mock_proxy.add_message_expectation(location, selector, options, &block)
     end
 
-    def subject_mock_proxy
-      @mock_proxy ||= subject.send(:__mock_proxy)
-    end
-
-    def any_instance_better_receive(selector, options, &block)
-      any_instance_should_respond_to selector
-      any_instance_should_receive selector, &block
-    end
-
-    def any_instance_should_respond_to(selector)
-      klass = subject.instance_variable_get(:@klass)
-      unless klass.method_defined?(selector)
-        raise "Expected instances of #{klass.name} to respond to :#{selector}"
-      end
-    end
-
-    def any_instance_should_receive(selector, &block)
-      RSpec::Mocks::space.add(subject)
-
-      subject.instance_variable_set(:@expectation_set, true)
-      subject.send(:observe!, selector)
-
-      subject.message_chains.add(selector, expectation_chain(selector, &block))
-    end
-
     def expectation_chain(*args)
       if defined?(RSpec::Mocks::AnyInstance::PositiveExpectationChain)
         RSpec::Mocks::AnyInstance::PositiveExpectationChain.new(*args)

data/lib/better_receive/stub.rb

@@ -0,0 +1,36 @@
+module BetterReceive
+  class Stub < Base
+
+    def assert_with(selector_or_hash, options={}, &block)
+      if selector_or_hash.is_a?(Hash)
+        selector_or_hash.each do |selector, value|
+          better_stub_method(selector, options, &block).and_return(value)
+        end
+      else
+        better_stub_method(selector_or_hash, options, &block)
+      end
+    end
+
+
+    private
+
+    def better_stub_method(selector, options, &block)
+      if subject_is_any_instance?
+        any_instance_better_expect(selector, options, &block)
+      else
+        subject.should respond_to selector
+        stub_subject_method(selector, options, &block)
+      end
+    end
+
+    def stub_subject_method(selector, options, &block)
+      location = options[:expected_from] || caller(1)[2]
+      subject_mock_proxy.add_stub(location, selector, options, &block)
+    end
+
+    def expectation_chain(*args)
+      RSpec::Mocks::AnyInstance::StubChain.new(*args)
+    end
+
+  end
+end

data/lib/better_receive/version.rb

@@ -1,3 +1,3 @@
 module BetterReceive
-  BETTER_VERSION = "0.3.0"
+  BETTER_VERSION = "0.4.0"
 end

data/spec/lib/better_receive/mock_spec.rb

@@ -1,26 +1,26 @@
 require 'spec_helper'
 
-describe BetterReceive do
+describe BetterReceive::Mock do
   class Foo
     def bar(baz = nil)
     end
   end
 
-  describe "#responds_to_and_receives" do
+  describe "#assert_with" do
     let(:foo) { Foo.new }
     let(:br_mock) { BetterReceive::Mock.new(foo) }
 
     it "determines whether an object responds to a method" do
       foo.should_receive(:respond_to?).with(:bar).and_return(true)
 
-      br_mock.responds_to_and_receives :bar
+      br_mock.assert_with :bar
 
       foo.bar
     end
 
-    it "raises an error if it the method is not defined" do
+    it "raises an error if the method is not defined" do
       expect {
-        br_mock.responds_to_and_receives :bar_baz
+        br_mock.assert_with :bar_baz
       }.to raise_error(RSpec::Expectations::ExpectationNotMetError) { |error|
         error.message.should =~ /to respond to :bar_baz/
       }
@@ -33,7 +33,7 @@ describe BetterReceive do
         foo.should_receive(:send).with(:__mock_proxy).and_return(mock_proxy)
         mock_proxy.should_receive(:add_message_expectation)
 
-        br_mock.responds_to_and_receives :bar
+        br_mock.assert_with :bar
       end
 
       it "returns an rspec message expectation(responds to additional matchers ('with', 'once'...))" do
@@ -41,7 +41,7 @@ describe BetterReceive do
 
         foo.bar
 
-        br_mock.responds_to_and_receives(:bar).with('wibble')
+        br_mock.assert_with(:bar).with('wibble')
 
         foo.bar('wibble')
       end
@@ -58,7 +58,7 @@ describe BetterReceive do
             block.should == block_param
           end
 
-          br_mock.responds_to_and_receives(:bar, passed: true, &block_param)
+          br_mock.assert_with(:bar, passed: true, &block_param)
         end
       end
 
@@ -69,7 +69,7 @@ describe BetterReceive do
           context "and the method is called" do
             it 'does not raise an error' do
               expect {
-                br_mock.responds_to_and_receives(:bar)
+                br_mock.assert_with(:bar)
                 foo.bar
               }.to_not raise_error
             end
@@ -78,7 +78,7 @@ describe BetterReceive do
           context 'and the method is not called' do
             it 'does raise an error' do
               expect {
-                br_mock.responds_to_and_receives(:bar)
+                br_mock.assert_with(:bar)
                 RSpec::Mocks::space.verify_all
               }.to raise_error(RSpec::Mocks::MockExpectationError) { |error|
                 error.message.should == "Exactly one instance should have received the following message(s) but didn't: bar"
@@ -90,7 +90,7 @@ describe BetterReceive do
         context 'when the method is not defined' do
           it 'raises an error' do
             expect {
-              br_mock.responds_to_and_receives(:baz)
+              br_mock.assert_with(:baz)
             }.to raise_error { |error|
               error.message.should == "Expected instances of Foo to respond to :baz"
             }

data/spec/lib/better_receive/stub_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe BetterReceive::Stub do
+  class Foo
+    def bar(baz = nil)
+    end
+  end
+
+  describe "#assert_with" do
+    let(:foo) { Foo.new }
+    let(:br_stub) { BetterReceive::Stub.new(foo) }
+
+    context "when passed a single selector" do
+      context "when checking responds to" do
+        it "determines whether an object responds to a method" do
+          foo.should_receive(:respond_to?).with(:bar).and_return(true)
+
+          br_stub.assert_with :bar
+
+          foo.bar
+        end
+
+        it "raises an error if the method is not defined" do
+          expect {
+            br_stub.assert_with :bar_baz
+          }.to raise_error(RSpec::Expectations::ExpectationNotMetError) { |error|
+            error.message.should =~ /to respond to :bar_baz/
+          }
+        end
+      end
+
+      context "when stubbing" do
+        let(:mock_proxy) { double(RSpec::Mocks::Proxy).as_null_object }
+        let(:block_param) { Proc.new {} }
+        let(:options) { {passed: true} }
+
+        it "creates a mock proxy and adds an expectation to it" do
+          foo.should_receive(:send).with(:__mock_proxy).and_return(mock_proxy)
+          mock_proxy.should_receive(:add_stub)
+
+          br_stub.assert_with :bar
+        end
+
+        it "returns an rspec message expectation(responds to additional matchers ('with', 'once'...))" do
+          br_stub.assert_with(:bar).should be_a RSpec::Mocks::MessageExpectation
+
+
+          br_stub.assert_with(:bar).with('wibble')
+        end
+
+        it "passes all arguments through to the mock_proxy" do
+          foo.should_receive(:send).with(:__mock_proxy).and_return(mock_proxy)
+          mock_proxy.should_receive(:add_stub) do |*args, &block|
+          args[1].should == :bar
+          args[2].should == options
+          block.should == block_param
+          end
+
+          br_stub.assert_with(:bar, passed: true, &block_param)
+        end
+
+        it "returns the value passed in the block" do
+          br_stub.assert_with(:bar) { :baz }
+
+          foo.bar.should == :baz
+        end
+      end
+    end
+
+    context "when passed a hash" do
+      class Foo
+        def extra; end
+      end
+
+      context "and checking responds to" do
+        it "determines whether an object responds to a method" do
+          params = {bar: '1', extra: '2'}
+
+          foo.should_receive(:respond_to?).with(:bar).and_return(true)
+          foo.should_receive(:respond_to?).with(:extra).and_return(true)
+
+          br_stub.assert_with params
+        end
+
+        it "raises an error if the method is not defined" do
+          params = {bar: '1', baz: '2'}
+
+          expect{
+            br_stub.assert_with params
+          }.to raise_error(RSpec::Expectations::ExpectationNotMetError) { |error|
+            error.message.should =~ /to respond to :baz/
+          }
+        end
+      end
+
+      context "and stubbing" do
+        it 'stubs out each method' do
+          params = {bar: '1', extra: '2'}
+          br_stub.assert_with params
+
+          foo.bar.should == '1'
+          foo.extra.should == '2'
+        end
+      end
+    end
+
+    context "on .any_instance" do
+      let(:br_stub) { BetterReceive::Stub.new(Foo.any_instance) }
+
+      context "when the method is defined" do
+        it 'stubs the method out' do
+          br_stub.assert_with(:bar).and_return(:whatever)
+
+          foo.bar.should == :whatever
+        end
+      end
+
+      context 'when the method is not defined' do
+        it 'raises an error' do
+          expect {
+            br_stub.assert_with(:baz)
+          }.to raise_error { |error|
+            error.message.should == "Expected instances of Foo to respond to :baz"
+          }
+        end
+      end
+    end
+  end
+end

data/spec/lib/better_receive_spec.rb

@@ -18,9 +18,62 @@ describe BetterReceive do
     it "checks that the object responds to the method and that the method is called" do
       BetterReceive::Mock.stub(:new).with(foo).and_return(br_instance)
 
-      br_instance.should_receive(:responds_to_and_receives).with(:bar)
+      br_instance.should_receive(:assert_with).with(:bar)
 
       foo.better_receive(:bar)
     end
+
+    it "returns an RSpec expectation object" do
+      foo.better_receive(:bar).should be_a RSpec::Mocks::MessageExpectation
+
+      foo.bar
+
+
+      foo.better_receive(:bar).with('wibble')
+
+      foo.bar('wibble')
+    end
+
+    it "returns the value of the block passed in" do
+      foo.better_receive(:bar) { :baz }
+
+      foo.bar.should == :baz
+    end
+  end
+
+  describe "#better_stub" do
+    let(:foo) { Foo.new }
+    let(:br_instance) { double(BetterReceive::Stub).as_null_object }
+
+    it "passes the object being stubbed into a new BetterReceive::Stub instance" do
+      BetterReceive::Stub.should_receive(:new).with(foo).and_return(br_instance)
+
+      foo.better_stub(:bar)
+    end
+
+    it "checks that the object responds to the method and that the method is called" do
+      BetterReceive::Stub.stub(:new).with(foo).and_return(br_instance)
+
+      br_instance.should_receive(:assert_with).with(:bar)
+
+      foo.better_stub(:bar)
+    end
+
+    it "returns an RSpec expectation object" do
+      foo.better_stub(:bar).should be_a RSpec::Mocks::MessageExpectation
+
+      foo.bar
+
+
+      foo.better_stub(:bar).with('wibble')
+
+      foo.bar('wibble')
+    end
+
+    it "returns the value of the block passed in" do
+      foo.better_stub(:bar) { :baz }
+
+      foo.bar.should == :baz
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_receive
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-27 00:00:00.000000000 Z
+date: 2013-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -77,9 +77,12 @@ files:
 - Rakefile
 - better_receive.gemspec
 - lib/better_receive.rb
+- lib/better_receive/base.rb
 - lib/better_receive/mock.rb
+- lib/better_receive/stub.rb
 - lib/better_receive/version.rb
 - spec/lib/better_receive/mock_spec.rb
+- spec/lib/better_receive/stub_spec.rb
 - spec/lib/better_receive_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/se3000/better_receive
@@ -108,5 +111,6 @@ specification_version: 3
 summary: A more assertive mock.
 test_files:
 - spec/lib/better_receive/mock_spec.rb
+- spec/lib/better_receive/stub_spec.rb
 - spec/lib/better_receive_spec.rb
 - spec/spec_helper.rb