surrogate 0.1.0 → 0.2.0

data/Readme.md

@@ -1,3 +1,5 @@
+Explanation and examples coming soon.
+
 TODO
 ----
 

data/lib/surrogate/api_comparer.rb

@@ -112,9 +112,9 @@ class Surrogate
         Set.new surrogate.singleton_class.api_method_names
       end
 
-      # should have new
+      # should have new and clone (don't screw up substitutability because of how we implement these)
       def class_inherited_methods
-        Set.new surrogate.singleton_class.instance_methods - surrogate.singleton_class.instance_methods(false) + [:new]
+        Set.new surrogate.singleton_class.instance_methods - surrogate.singleton_class.instance_methods(false)
       end
 
       # should not have new

data/lib/surrogate/endower.rb

@@ -1,6 +1,8 @@
 class Surrogate
 
   # adds surrogate behaviour to your class / singleton class / instances
+  #
+  # please refactor me!
   class Endower
     def self.endow(klass, &playlist)
       new(klass, &playlist).endow
@@ -60,19 +62,22 @@ class Surrogate
     end
 
     def can_get_a_new(klass)
-      klass.define_singleton_method :reprise do
-        new_klass = Class.new self
-        surrogate = @surrogate
-        Surrogate.endow new_klass do
-          surrogate.api_methods.each do |method_name, options|
-            define method_name, options.to_hash, &options.default_proc
+      klass.extend Module.new {
+        # use a module so that the method is inherited (important for substitutability)
+        def clone
+          new_klass = Class.new self
+          surrogate = @surrogate
+          Surrogate.endow new_klass do
+            surrogate.api_methods.each do |method_name, options|
+              define method_name, options.to_hash, &options.default_proc
+            end
           end
+          @hatchery.api_methods.each do |method_name, options|
+            new_klass.define method_name, options.to_hash, &options.default_proc
+          end
+          new_klass
         end
-        @hatchery.api_methods.each do |method_name, options|
-          new_klass.define method_name, options.to_hash, &options.default_proc
-        end
-        new_klass
-      end
+      }
     end
 
     def remember_invocations_for_instances_of(klass)
@@ -86,13 +91,16 @@ class Surrogate
     end
 
     def hijack_instantiation_of(klass)
-      def klass.new(*args)
-        instance = allocate
-        hatchery = @hatchery
-        instance.instance_eval { @surrogate = Hatchling.new instance, hatchery }
-        instance.send :initialize, *args
-        instance
-      end
+      # use a module so that the method is inherited (important for substitutability)
+      klass.extend Module.new {
+        def new(*args)
+          instance = allocate
+          hatchery = @hatchery
+          instance.instance_eval { @surrogate = Hatchling.new instance, hatchery }
+          instance.send :initialize, *args
+          instance
+        end
+      }
     end
 
     def enable_defining_methods(klass)

data/lib/surrogate/hatchling.rb

@@ -15,8 +15,14 @@ class Surrogate
       invoked_methods[method_name] << args
       return get_default method_name, args unless has_ivar? method_name
       ivar = get_ivar method_name
-      return ivar unless ivar.kind_of? MethodQueue
-      play_from_queue ivar, method_name
+      case ivar
+      when MethodQueue
+        play_from_queue ivar, method_name
+      when Exception
+        raise ivar
+      else
+        ivar
+      end
     end
 
     def prepare_method(method_name, args, &block)

data/lib/surrogate/method_queue.rb

@@ -4,7 +4,9 @@ class Surrogate
 
     def dequeue
       raise QueueEmpty if empty?
-      queue.shift
+      current = queue.shift
+      raise current if current.kind_of? Exception
+      current
     end
 
     def empty?

data/lib/surrogate/version.rb

@@ -1,3 +1,3 @@
 class Surrogate
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/acceptance_spec.rb

@@ -36,7 +36,7 @@ describe Surrogate do
 
 
     # don't affect the real user class
-    user_class = Mock::User.reprise
+    user_class = Mock::User.clone
 
 
     # =====  set a default  =====
@@ -53,7 +53,7 @@ describe Surrogate do
     # might also be nice to provide a way to raise an error
 
     # tracking invocations
-    user_class = Mock::User.reprise
+    user_class = Mock::User.clone
     user_class.should_not have_been_told_to :find
     user_class.find 12
     user_class.find 12
@@ -102,6 +102,13 @@ describe Surrogate do
     # user.phone_numbers.should == [['123', '456-7890']] # <-- should we use a hook, or default block to make this happen?
 
 
+    # =====  raise errors  =====
+
+    # pass the error as the return value, it will be raised when method is invoked
+    error = StandardError.new("some message")
+    user.will_add_phone_number error
+    expect { user.add_phone_number }.to raise_error StandardError, "some message"
+
     # =====  Substitutability  =====
 
     # real user is not a suitable substitute if missing methods that mock user has

data/spec/defining_api_methods_spec.rb

@@ -9,7 +9,7 @@ describe 'define' do
         end
       end
 
-      klass1 = pristine_klass.reprise
+      klass1 = pristine_klass.clone
       klass1.should_not have_been_told_to :find
       klass1.find(1).should == 123
       klass1.should have_been_told_to(:find).with(1)
@@ -73,6 +73,25 @@ describe 'define' do
             end
           end
         end
+
+        describe 'when an argument is an error' do
+          it 'raises the error on method invocation' do
+            mocked_class = Surrogate.endow(Class.new)
+            mocked_class.define :connect
+            mock = mocked_class.new
+            error = StandardError.new("some message")
+
+            # for single invocation
+            mock.will_connect error
+            expect { mock.connect }.to raise_error StandardError, "some message"
+
+            # for queue
+            mock.will_connect 1, error, 2
+            mock.connect.should == 1
+            expect { mock.connect }.to raise_error StandardError, "some message"
+            mock.connect.should == 2
+          end
+        end
       end
 
 
@@ -246,7 +265,7 @@ describe 'define' do
   end
 
 
-  describe 'reprise' do
+  describe 'clone' do
     it 'a repetition or further performance of the klass' do
       pristine_klass = Class.new do
         Surrogate.endow self do
@@ -257,13 +276,13 @@ describe 'define' do
         define(:repeat) { 321 }
       end
 
-      klass1 = pristine_klass.reprise
+      klass1 = pristine_klass.clone
       klass1.should_not have_been_told_to :find
       klass1.find(1).should == 123
       klass1.should have_been_told_to(:find).with(1)
       klass1.bind.should == 'abc'
 
-      klass2 = pristine_klass.reprise
+      klass2 = pristine_klass.clone
       klass2.will_find 456
       klass2.find(2).should == 456
       klass1.find.should == 123
@@ -277,9 +296,9 @@ describe 'define' do
       klass1.new.repeat.should == 321
     end
 
-    it 'is a subclass of the reprised class' do
+    it 'is a subclass of the cloned class' do
       superclass = Surrogate.endow Class.new
-      superclass.reprise.new.should be_a_kind_of superclass
+      superclass.clone.new.should be_a_kind_of superclass
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surrogate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70192551591960 !ruby/object:Gem::Requirement
+  requirement: &70270582700600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70192551591960
+  version_requirements: *70270582700600
 description: Framework to aid in handrolling mock/spy objects.
 email:
 - josh.cheek@gmail.com