surrogate 0.4.3 → 0.5.0

data/lib/surrogate/rspec.rb

@@ -17,9 +17,32 @@ class Surrogate
         @mocks_loaded = bool
       end
     end
+
+    module Matchers
+      def have_been_told_to(expected)
+        HaveBeenToldTo.new expected
+      end
+
+      def have_been_asked_for_its(expected)
+        HaveBeenAskedForIts.new expected
+      end
+
+      def have_been_initialized_with(*initialization_args, &block)
+        HaveBeenInitializedWith.new *initialization_args, &block
+      end
+    end
   end
 end
 
+require 'rspec/core'
 require 'surrogate'
-require 'surrogate/rspec/api_method_matchers'
-require 'surrogate/rspec/substitutability_matchers'
+require 'surrogate/rspec/substitute_for'
+
+require 'surrogate/rspec/have_been_asked_for_its'
+require 'surrogate/rspec/have_been_initialized_with'
+require 'surrogate/rspec/have_been_told_to'
+
+
+RSpec.configure do |config|
+  config.include Surrogate::RSpec::Matchers
+end

data/lib/surrogate/values.rb

@@ -3,60 +3,53 @@ class Surrogate
   # Superclass for all types of values. Where a value is anything stored
   # in an instance variable on a surrogate, intended to be returned by an api method
   class Value
-
     # convert raw arguments into a value
     def self.factory(*args, &block)
       arg = args.first
-      # if arg.kind_of? Exception
-      #   Raiseable.new arg
-      # else
-      #   MethodQueue.new args
-      # end
       if args.size > 1
         ValueQueue.new args
       elsif arg.kind_of? Exception
         Raisable.new arg
-      elsif arg.kind_of? Value
+      elsif arg.kind_of? BaseValue
         arg
       else
-        Value.new arg
+        BaseValue.new arg
       end
     end
 
-    def initialize(value)
-      @value = value
-    end
-
-    def value(hatchling, method_name)
-      @value
-    end
+    # === the current set of possible values ===
 
-    def factory(*args, &block)
-      self.class.factory(*args, &block)
-    end
-  end
-end
+    class BaseValue
+      def initialize(value)
+        @value = value
+      end
 
+      def value(method_name)
+        @value
+      end
 
-# the current set of possible values
+      def factory(*args, &block)
+        Value.factory(*args, &block)
+      end
+    end
 
-class Surrogate
-  class Value
 
-    class Raisable < Value
+    class Raisable < BaseValue
       def value(*)
         raise @value
       end
     end
 
 
-    class ValueQueue < Value
-      QueueEmpty = Class.new StandardError
+    class ValueQueue < BaseValue
+      QueueEmpty = Class.new SurrogateError
 
-      def value(hatchling, method_name)
-        factory(dequeue).value(hatchling, method_name)
-      ensure
-        hatchling.unset_ivar method_name if empty?
+      def value(method_name)
+        if empty?
+          raise QueueEmpty
+        else
+          factory(dequeue).value(method_name)
+        end
       end
 
       def queue

data/lib/surrogate/version.rb

@@ -1,3 +1,3 @@
 class Surrogate
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/lib/surrogate.rb

@@ -5,6 +5,7 @@ require 'surrogate/options'
 require 'surrogate/values'
 require 'surrogate/endower'
 require 'surrogate/api_comparer'
+require 'surrogate/invocation'
 
 class Surrogate
   UnpreparedMethodError = Class.new StandardError

data/spec/acceptance_spec.rb

@@ -45,11 +45,11 @@ describe Surrogate do
     user_class.find(2).should == :user1
 
     # set a queue of default values
-    user_class.will_find :user1, :user2, :user3          # set three overrides
-    user_class.find(11).should == :user1                 # first override
-    user_class.find(22).should == :user2                 # second override
-    user_class.find(33).should == :user3                 # third override
-    user_class.find(44).should be_a_kind_of Mock::User   # back to default block
+    user_class.will_find :user1, :user2, :user3  # set three overrides
+    user_class.find(11).should == :user1         # first override
+    user_class.find(22).should == :user2         # second override
+    user_class.find(33).should == :user3         # third override
+    expect { user_class.find 44 }.to raise_error # raise error when nothing left to find
     # might also be nice to provide a way to raise an error
 
     # tracking invocations

data/spec/defining_api_methods_spec.rb

@@ -72,24 +72,13 @@ describe 'define' do
           instance.will_wink(1, 2, 3).should equal instance
         end
 
-        context 'it creates a queue of things to find then returns to normal behaviour' do
-          specify 'when there is no default block' do
-            mock = mocked_class.new
-            mock.will_wink :quickly, [:slowly]
-            mock.wink.should == :quickly
-            mock.wink.should == [:slowly]
-            expect { mock.wink }.to raise_error Surrogate::UnpreparedMethodError
-          end
-
-          specify 'when there is a default block' do
-            mocked_class = Surrogate.endow(Class.new)
-            mocked_class.define(:connect) { :default }
-            mock = mocked_class.new
-            mock.will_connect 1, 2
-            mock.connect.should == 1
-            mock.connect.should == 2
-            mock.connect.should == :default
-          end
+        # Is there something useful the error could say?
+        it 'creates a queue of things to find and raises a QueueEmpty error if there are none left' do
+          mock = mocked_class.new
+          mock.will_wink :quickly, [:slowly]
+          mock.wink.should == :quickly
+          mock.wink.should == [:slowly]
+          expect { mock.wink }.to raise_error Surrogate::Value::ValueQueue::QueueEmpty
         end
       end
 
@@ -140,24 +129,13 @@ describe 'define' do
           instance.will_have_age(1,2,3).should equal instance
         end
 
-        context 'it creates a queue of things to find then returns to normal behaviour' do
-          specify 'when there is no default block' do
-            mock = mocked_class.new
-            mock.will_have_age 12, 34
-            mock.age.should == 12
-            mock.age.should == 34
-            expect { mock.age }.to raise_error Surrogate::UnpreparedMethodError
-          end
-
-          specify 'when there is a default block' do
-            mocked_class = Surrogate.endow(Class.new)
-            mocked_class.define(:name) { 'default' }
-            mock = mocked_class.new
-            mock.will_have_name 'a', 'b'
-            mock.name.should == 'a'
-            mock.name.should == 'b'
-            mock.name.should == 'default'
-          end
+        # Is there something useful the error could say?
+        it 'creates a queue of things to find and raises a QueueEmpty error if there are none left' do
+          mock = mocked_class.new
+          mock.will_have_age 12, 34
+          mock.age.should == 12
+          mock.age.should == 34
+          expect { mock.age }.to raise_error Surrogate::Value::ValueQueue::QueueEmpty
         end
       end
     end
@@ -271,12 +249,11 @@ describe 'define' do
       mock = mocked_class.new
       mock.meth 1
       mock.meth 1, 2
-      mock.meth [1, 2]
-      mock.invocations(:meth).should == [
-        [1],
-        [1, 2],
-        [[1, 2]],
-      ]
+      mock.invocations(:meth).should == [Surrogate::Invocation.new([1]), Surrogate::Invocation.new([1, 2])]
+
+      val = 0
+      mock.meth(1, 2) { val =  3 }
+      expect { mock.invocations(:meth).last.block.call }.to change { val }.from(0).to(3)
     end
 
     it 'raises an error if asked about invocations for api methods it does not know' do

data/spec/rspec/block_support_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+# these all need error messages
+describe 'RSpec matchers', 'have_been_told_to(...).with { |block| }' do
+
+  let(:dir)      { Surrogate.endow(Class.new) { define(:chdir) { nil }}}
+  let(:dir_path) { '/some/dir/path' }
+
+  it 'fails if no submitted_blocks were found' do
+    dir.should_not have_been_told_to(:chdir).with(dir_path) { |block|
+      block.before { raise 'this should not be executed' }
+    }
+
+    dir.chdir dir_path
+
+    dir.should_not have_been_told_to(:chdir).with(dir_path) { |block|
+      block.before { raise 'this should not be executed' }
+    }
+
+    dir.chdir(dir_path) { }
+    dir.should have_been_told_to(:chdir).with(dir_path) { }
+  end
+
+  it "fails if the arguments don't match, even if the block does" do
+    dir.chdir(dir_path) { }
+    dir.should_not have_been_told_to(:chdir).with(dir_path.reverse) { }
+    dir.should     have_been_told_to(:chdir).with(dir_path) { }
+  end
+
+  it 'yields a test_block that can make assertions' do
+    dir.chdir(dir_path) { }
+    block_yielded = nil
+    dir.should have_been_told_to(:chdir).with(dir_path) { |block|
+      block_yielded = block
+    }
+    block_yielded.should be
+  end
+
+  describe 'the .returns assertion' do
+    it "passes if the submitted_block does return the value" do
+      dir.chdir(dir_path) { 1 }
+      dir.should_not have_been_told_to(:chdir).with(dir_path) { |block| block.returns 2 }
+      dir.should     have_been_told_to(:chdir).with(dir_path) { |block| block.returns 1 }
+    end
+
+    specify "if given a block, it passes the return value to it for making assertions" do
+      dir.chdir(dir_path) { 1 }
+
+      dir.should_not have_been_told_to(:chdir).with(dir_path) { |block|
+        block.returns { |result| result.should == 2 }
+      }
+
+      dir.should have_been_told_to(:chdir).with(dir_path) { |block|
+        block.returns { |result| result.should == 1 }
+      }
+    end
+  end
+
+
+  let(:file)      { Surrogate.endow(Class.new) { define(:write) { true }}}
+  let(:file_name) { 'some_file_name.ext' }
+  let(:file_body) { 'some file body' }
+
+  describe 'the .before and .after hooks' do
+    specify "take blocks which it will evaluate before/after invoking the submitted_block" do
+      dir.chdir(dir_path) { file.write file_name, file_body }
+      dir.should have_been_told_to(:chdir).with(dir_path) { |block|
+        block.before { file.should_not have_been_told_to :write }
+        block.after  { file.should     have_been_told_to :write }
+      }
+    end
+
+    example "multiple invocations wrong number of times" do
+      dir.chdir(dir_path) { file.write file_name, file_body }
+      dir.chdir(dir_path) { file.write file_name, file_body }
+      dir.should_not have_been_told_to(:chdir).times(1).with(dir_path) { |block|
+        block.before { file.should_not have_been_told_to :write }
+        block.after  { file.should     have_been_told_to :write }
+      }
+    end
+
+    example "multiple invocations correct number of times" do
+      dir.chdir(dir_path) { file.write file_name, file_body }
+      dir.chdir(dir_path) { file.write file_name, file_body }
+      dir.should have_been_told_to(:chdir).times(2).with(dir_path) { |block|
+        block.before { file.should_not have_been_told_to :write }
+        block.after  { file.should     have_been_told_to :write }
+      }
+    end
+  end
+
+  describe 'the .arity assertion' do
+    it "takes a number corresponding to the arity of the block" do
+      klass = Surrogate.endow(Class.new)
+      klass.define(:meth) { self }
+      klass.new.meth { |a|     }.should have_been_told_to(:meth).with { |b| b.arity  1 }
+      klass.new.meth { |a,b|   }.should have_been_told_to(:meth).with { |b| b.arity  2 }
+      klass.new.meth { |a,b,c| }.should have_been_told_to(:meth).with { |b| b.arity  3 }
+      klass.new.meth { |*a|    }.should have_been_told_to(:meth).with { |b| b.arity -1 }
+      expect {
+        klass.new.meth { |a|   }.should have_been_told_to(:meth).with { |b| b.arity 123 }
+      }.to raise_error RSpec::Expectations::ExpectationNotMetError
+    end
+  end
+
+  describe ".call_with" do
+    it 'allows the user to provide arguments' do
+      klass = Surrogate.endow(Class.new).define(:add) { self }
+      instance = klass.new
+      instance.add { |a, b, &c| a + b + c.call }
+      instance.should have_been_told_to(:add).with { |block|
+        block.call_with(1, 2) { 3 }
+        block.returns 6
+      }
+
+      instance = klass.new
+      i = 10
+      instance.add { |n, &b| i += n + b.call }
+      instance.should have_been_told_to(:add).with { |block|
+        block.call_with(3) { 4 }
+        block.after { i.should == 17 }
+      }
+    end
+  end
+
+  describe ".raising is like RSpec's raise_error interface" do
+    it { pending 'IDK what I want this to be like yet' }
+  end
+end

data/spec/rspec/messages_spec.rb

@@ -1,34 +1,37 @@
 require 'spec_helper'
 
-messages_for = Surrogate::RSpec::MessagesFor
 
-describe messages_for, 'argument inspection' do
+describe Surrogate::RSpec::AbstractFailureMessage::ArgsInspector, 'argument inspection' do
 
   describe 'individual argument inspection inspection' do
     it 'inspects non RSpec matchers as their default inspection' do
-      messages_for.inspect_argument("1").should == '"1"'
-      messages_for.inspect_argument(1).should == "1"
-      messages_for.inspect_argument([/a/]).should == "[/a/]"
+      described_class.inspect_argument("1").should == '"1"'
+      described_class.inspect_argument(1).should == "1"
+      described_class.inspect_argument([/a/]).should == "[/a/]"
     end
 
     it 'inspects rspec matchers' do
-      messages_for.inspect_argument(no_args).should == 'no args'
-      messages_for.inspect_argument(hash_including abc: 123).should == 'hash_including(:abc=>123)'
+      described_class.inspect_argument(no_args).should == 'no args'
+      described_class.inspect_argument(hash_including abc: 123).should == 'hash_including(:abc=>123)'
     end
   end
 
 
   describe 'multiple argument inspection' do
+    def inspect_args(args)
+      described_class.inspect Surrogate::Invocation.new(args)
+    end
+
     it "wraps individual arguments in `'" do
-      messages_for.inspect_arguments([/a/]).should == "`/a/'"
+      inspect_args([/a/]).should == "`/a/'"
     end
 
     it "joins arguments with commas" do
-      messages_for.inspect_arguments(['x', no_args]).should == "`\"x\", no args'"
+      inspect_args(['x', no_args]).should == "`\"x\", no args'"
     end
 
     it 'returns no_args when the array is empty' do
-      messages_for.inspect_arguments([]).should == "`no args'"
+      inspect_args([]).should == "`no args'"
     end
   end
 end

data/surrogate.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'bindable_block', '= 0.0.4'
+  s.add_runtime_dependency 'bindable_block', '= 0.0.5.1'
 
   s.add_development_dependency "rspec", '~> 2.8.0' # TODO: Figure out how far back we can work with
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surrogate
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2012-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindable_block
-  requirement: &70325486799660 !ruby/object:Gem::Requirement
+  requirement: &70339421986340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *70325486799660
+  version_requirements: *70339421986340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70325486799160 !ruby/object:Gem::Requirement
+  requirement: &70339421985140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70325486799160
+  version_requirements: *70339421985140
 description: Framework to aid in handrolling mock/spy objects.
 email:
 - josh.cheek@gmail.com
@@ -50,14 +50,22 @@ files:
 - lib/surrogate/endower.rb
 - lib/surrogate/hatchery.rb
 - lib/surrogate/hatchling.rb
+- lib/surrogate/invocation.rb
 - lib/surrogate/options.rb
 - lib/surrogate/rspec.rb
-- lib/surrogate/rspec/api_method_matchers.rb
-- lib/surrogate/rspec/substitutability_matchers.rb
+- lib/surrogate/rspec/abstract_failure_message.rb
+- lib/surrogate/rspec/have_been_asked_for_its.rb
+- lib/surrogate/rspec/have_been_initialized_with.rb
+- lib/surrogate/rspec/have_been_told_to.rb
+- lib/surrogate/rspec/invocation_matcher.rb
+- lib/surrogate/rspec/substitute_for.rb
+- lib/surrogate/rspec/times_predicate.rb
+- lib/surrogate/rspec/with_filter.rb
 - lib/surrogate/values.rb
 - lib/surrogate/version.rb
 - spec/acceptance_spec.rb
 - spec/defining_api_methods_spec.rb
+- spec/rspec/block_support_spec.rb
 - spec/rspec/have_been_asked_for_its_spec.rb
 - spec/rspec/have_been_initialized_with_spec.rb
 - spec/rspec/have_been_told_to_spec.rb
@@ -94,6 +102,7 @@ summary: Framework to aid in handrolling mock/spy objects.
 test_files:
 - spec/acceptance_spec.rb
 - spec/defining_api_methods_spec.rb
+- spec/rspec/block_support_spec.rb
 - spec/rspec/have_been_asked_for_its_spec.rb
 - spec/rspec/have_been_initialized_with_spec.rb
 - spec/rspec/have_been_told_to_spec.rb