Merge pull request #245 from pivotal-brian-croom/and_return_nil

Allow returning `nil` from stubs on appropriate methods
cedarbdd · May 29, 2014 · 271f0d0 · 271f0d0
2 parents 564c5dd + 33d32b8
commit 271f0d0
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 5 deletions.
diff --git a/Source/Doubles/StubbedMethod.mm b/Source/Doubles/StubbedMethod.mm
@@ -114,7 +114,7 @@
     void StubbedMethod::verify_return_value_type(id instance) const {
         if (this->has_return_value()) {
             const char * const methodReturnType = [[instance methodSignatureForSelector:this->selector()] methodReturnType];
-            if (!this->return_value().matches_encoding(methodReturnType)) {
+            if (!this->return_value().compatible_with_encoding(methodReturnType)) {
                 [[NSException exceptionWithName:NSInternalInconsistencyException
                                          reason:[NSString stringWithFormat:@"Invalid return value type '%@' instead of '%@' for <%@>", [CDRTypeUtilities typeNameForEncoding:this->return_value().value_encoding()], [CDRTypeUtilities typeNameForEncoding:methodReturnType], NSStringFromSelector(this->selector())]
                                        userInfo:nil] raise];

diff --git a/Source/Headers/Doubles/Arguments/ReturnValue.h b/Source/Headers/Doubles/Arguments/ReturnValue.h
@@ -8,7 +8,7 @@ namespace Cedar { namespace Doubles {
 
         virtual const char * const value_encoding() const = 0;
         virtual void * value_bytes() const = 0;
-        virtual bool matches_encoding(const char *) const = 0;
+        virtual bool compatible_with_encoding(const char *) const = 0;
 
         typedef std::shared_ptr<ReturnValue> shared_ptr_t;
     };
@@ -26,7 +26,10 @@ namespace Cedar { namespace Doubles {
 
         virtual const char * const value_encoding() const;
         virtual void * value_bytes() const;
-        virtual bool matches_encoding(const char *) const;
+        virtual bool compatible_with_encoding(const char *) const;
+
+    private:
+        bool matches_encoding(const char *)const;
 
     private:
         const T value_;
@@ -49,8 +52,17 @@ namespace Cedar { namespace Doubles {
     }
 
     template<typename T>
-    /* virtual */ bool TypedReturnValue<T>::matches_encoding(const char * actual_argument_encoding) const {
-        return 0 == strcmp(@encode(T), actual_argument_encoding);
+    /* virtual */ bool TypedReturnValue<T>::compatible_with_encoding(const char * actual_argument_encoding) const {
+        return matches_encoding(actual_argument_encoding);
+    }
+
+    template<>
+    /* virtual */ inline bool TypedReturnValue<NSInteger>::compatible_with_encoding(const char * actual_argument_encoding) const {
+        return (value_ == (NSInteger)nil && 0 == strcmp(@encode(id), actual_argument_encoding)) || this->matches_encoding(actual_argument_encoding);
     }
 
+    template<typename T>
+    bool TypedReturnValue<T>::matches_encoding(const char * actual_argument_encoding) const {
+        return 0 == strcmp(@encode(T), actual_argument_encoding);
+    }
 }}
diff --git a/Spec/Doubles/CedarDoubleSharedExamples.mm b/Spec/Doubles/CedarDoubleSharedExamples.mm
@@ -912,6 +912,16 @@ myDouble stub_method("incrementByNumber:").with((id)nil).and_do(^(NSInvocation *
                     memcmp(&returnValue, &returnedValue, sizeof(LargeIncrementerStruct)) should equal(0);
                 });
             });
+
+            context(@"with `nil`", ^{
+                beforeEach(^{
+                    myDouble stub_method("valueAsNumber").and_return(nil);
+                });
+
+                it(@"should return the expected value", ^{
+                    [myDouble valueAsNumber] should be_nil;
+                });
+            });
         });
     });
 });

diff --git a/Spec/Support/SimpleIncrementer.h b/Spec/Support/SimpleIncrementer.h
@@ -16,6 +16,7 @@ typedef LargeIncrementerStruct (^ComplexIncrementerBlock)(NSNumber *, LargeIncre
 @required
 - (size_t)value;
 - (size_t)aVeryLargeNumber;
+- (NSNumber *)valueAsNumber;
 - (void)increment;
 - (void)incrementBy:(size_t)amount;
 - (void)incrementByNumber:(NSNumber *)number;

diff --git a/Spec/Support/SimpleIncrementer.m b/Spec/Support/SimpleIncrementer.m
@@ -20,6 +20,10 @@ - (size_t)aVeryLargeNumber {
     return 0x7fffffff;
 }
 
+- (NSNumber *)valueAsNumber {
+    return @(self.value);
+}
+
 - (void)incrementBy:(size_t)amount {
     self.value += amount;
 }