Add support for controlling retain/copy semantics for arguments to stubs.

Allows marking an argument in a stub as having various semantics:
  - is not retained by invocations
    Object arguments are retained by default in OCMock. In some cases to avoid retain
    loops you need to mark an argument as unretained.
  - is not retained by stub
    Stub arguments are retained by default in OCMock. In some specialized cases you
    do not want the stub arguments retained
  - is copied by invocation
    Some arguments have copy semantics and we need the invocation to copy the argument
    instead of retain it.

Author: dmaclach

Source/OCMock/NSInvocation+OCMAdditions.h

@@ -20,8 +20,7 @@
 
 + (NSInvocation *)invocationForBlock:(id)block withArguments:(NSArray *)arguments;
 
-- (void)retainObjectArgumentsExcludingObject:(id)objectToExclude;
-
+- (void)applyConstraintOptionsFromStubInvocation:(NSInvocation *)stubInvocation excludingObject:(id)objectToExclude;
 - (id)getArgumentAtIndexAsObject:(NSInteger)argIndex;
 
 - (NSString *)invocationDescription;

Source/OCMock/NSInvocation+OCMAdditions.m

@@ -54,9 +54,20 @@ + (NSInvocation *)invocationForBlock:(id)block withArguments:(NSArray *)argument
 }
 
 
+- (OCMConstraintOptions)getArgumentContraintOptionsForArgumentAtIndex:(NSUInteger)index
+{
+    id argument;
+    [self getArgument:&argument atIndex:index];
+    if(![argument isProxy] && [argument isKindOfClass:[OCMConstraint class]])
+    {
+        return [(OCMConstraint *)argument constraintOptions];
+    }
+    return OCMConstraintDefaultOptions;
+}
+
 static NSString *const OCMRetainedObjectArgumentsKey = @"OCMRetainedObjectArgumentsKey";
 
-- (void)retainObjectArgumentsExcludingObject:(id)objectToExclude
+- (void)applyConstraintOptionsFromStubInvocation:(NSInvocation *)stubInvocation excludingObject:(id)objectToExclude
 {
     if(objc_getAssociatedObject(self, OCMRetainedObjectArgumentsKey) != nil)
     {
@@ -112,7 +123,21 @@ - (void)retainObjectArgumentsExcludingObject:(id)objectToExclude
                 }
                 else
                 {
-                    [retainedArguments addObject:argument];
+                    // Conform to the constraintOptions in the stub (if any).
+                    OCMConstraintOptions constraintOptions = [stubInvocation getArgumentContraintOptionsForArgumentAtIndex:index];
+                    if((constraintOptions & OCMConstraintCopyInvocationArg))
+                    {
+                        // Copy not only retains the copy in our array
+                        // but updates the arg in the invocation that we store.
+                        id argCopy = [argument copy];
+                        [retainedArguments addObject:argCopy];
+                        [self setArgument:&argCopy atIndex:index];
+                        [argCopy release];
+                    }
+                    else if(!(constraintOptions & OCMConstraintDoNotRetainInvocationArg))
+                    {
+                        [retainedArguments addObject:argument];
+                    }
                 }
             }
         }

Source/OCMock/OCMArg.h

@@ -16,10 +16,36 @@
 
 #import <Foundation/Foundation.h>
 
-@interface OCMArg : NSObject
+// Options for controlling how OCMArgs function.
+typedef NS_OPTIONS(NSUInteger, OCMArgOptions) {
+    // The OCMArg will retain/release the value passed to it, and invocations on a stub that has
+    // arguments that the OCMArg is constraining will retain the values passed to them for the
+    // arguments being constrained by the OCMArg.
+    OCMArgDefaultOptions = 0UL,
+
+    // The OCMArg will not retain/release the value passed to it. Is only applicable for
+    // `isEqual:options:` and `isNotEqual:options`. The caller is responsible for making sure that the
+    // arg is valid for the required lifetime. Note that unless `OCMArgDoNotRetainInvocationArg` is
+    // also specified, invocations of the stub that the OCMArg arg is constraining will retain values
+    // passed to them for the arguments being constrained by the OCMArg. `OCMArgNeverRetainArg` is
+    // usually what you want to use.
+    OCMArgDoNotRetainStubArg = (1UL << 0),
+
+    // Invocations on a stub that has arguments that the OCMArg is constraining will retain/release
+    // the values passed to them for the arguments being constrained by the OCMArg.
+    OCMArgDoNotRetainInvocationArg = (1UL << 1),
+
+    // Invocations on a stub that has arguments that the OCMArg is constraining will copy/release
+    // the values passed to them for the arguments being constrained by the OCMArg.
+    OCMArgCopyInvocationArg = (1UL << 2),
 
+    OCMArgNeverRetainArg = OCMArgDoNotRetainStubArg | OCMArgDoNotRetainInvocationArg,
+};
+
+@interface OCMArg : NSObject
 // constraining arguments
 
+// constrain using OCMArgDefaultOptions
 + (id)any;
 + (SEL)anySelector;
 + (void *)anyPointer;
@@ -32,6 +58,15 @@
 + (id)checkWithSelector:(SEL)selector onObject:(id)anObject;
 + (id)checkWithBlock:(BOOL (^)(id obj))block;
 
++ (id)anyWithOptions:(OCMArgOptions)options;
++ (id)isNilWithOptions:(OCMArgOptions)options;
++ (id)isNotNilWithOptions:(OCMArgOptions)options;
++ (id)isEqual:(id)value options:(OCMArgOptions)options;
++ (id)isNotEqual:(id)value options:(OCMArgOptions)options;
++ (id)isKindOfClass:(Class)cls options:(OCMArgOptions)options;
++ (id)checkWithSelector:(SEL)selector onObject:(id)anObject options:(OCMArgOptions)options;
++ (id)checkWithOptions:(OCMArgOptions)options withBlock:(BOOL (^)(id obj))block;
+
 // manipulating arguments
 
 + (id *)setTo:(id)value;

Source/OCMock/OCMArg.m

@@ -25,7 +25,7 @@ @implementation OCMArg
 
 + (id)any
 {
-    return [[[OCMAnyConstraint alloc] init] autorelease];
+	  return [self anyWithOptions:OCMArgDefaultOptions];
 }
 
 + (void *)anyPointer
@@ -45,39 +45,80 @@ + (SEL)anySelector
 
 + (id)isNil
 {
-    return [[OCMIsNilConstraint alloc] init];
+
+	  return [self isNilWithOptions:OCMArgDefaultOptions];
 }
 
 + (id)isNotNil
 {
-    return [[OCMIsNotNilConstraint alloc] init];
+	  return [self isNotNilWithOptions:OCMArgDefaultOptions];
 }
 
 + (id)isEqual:(id)value
 {
-	return [[[OCMIsEqualConstraint alloc] initWithTestValue:value] autorelease];
+    return [self isEqual:value options:OCMArgDefaultOptions];
 }
 
 + (id)isNotEqual:(id)value
 {
-    return [[[OCMIsNotEqualConstraint alloc] initWithTestValue:value] autorelease];
+    return [self isNotEqual:value options:OCMArgDefaultOptions];
 }
 
 + (id)isKindOfClass:(Class)cls
 {
-    return [[[OCMBlockConstraint alloc] initWithConstraintBlock:^BOOL(id obj) {
-        return [obj isKindOfClass:cls];
-    }] autorelease];
+    return [self isKindOfClass:cls options:OCMArgDefaultOptions];
 }
 
 + (id)checkWithSelector:(SEL)selector onObject:(id)anObject
 {
-    return [OCMConstraint constraintWithSelector:selector onObject:anObject];
+    return [self checkWithSelector:selector onObject:anObject options:OCMArgDefaultOptions];
 }
 
 + (id)checkWithBlock:(BOOL (^)(id))block
 {
-    return [[[OCMBlockConstraint alloc] initWithConstraintBlock:block] autorelease];
+    return [self checkWithOptions:OCMArgDefaultOptions withBlock:block];
+}
+
++ (id)anyWithOptions:(OCMArgOptions)options
+{
+    return [[[OCMAnyConstraint alloc] initWithOptions:[self constraintOptionsFromArgOptions:options]] autorelease];
+}
+
++ (id)isNilWithOptions:(OCMArgOptions)options
+{
+    return [[[OCMIsEqualConstraint alloc] initWithTestValue:nil options:[self constraintOptionsFromArgOptions:options]] autorelease];
+}
+
++ (id)isNotNilWithOptions:(OCMArgOptions)options
+{
+    return [[[OCMIsNotEqualConstraint alloc] initWithTestValue:nil options:[self constraintOptionsFromArgOptions:options]] autorelease];
+}
+
++ (id)isEqual:(id)value options:(OCMArgOptions)options
+{
+    return [[[OCMIsEqualConstraint alloc] initWithTestValue:value options:[self constraintOptionsFromArgOptions:options]] autorelease];
+}
+
++ (id)isNotEqual:(id)value options:(OCMArgOptions)options
+{
+    return [[[OCMIsNotEqualConstraint alloc] initWithTestValue:value options:[self constraintOptionsFromArgOptions:options]] autorelease];
+}
+
++ (id)isKindOfClass:(Class)cls options:(OCMArgOptions)options
+{
+    return [[[OCMBlockConstraint alloc] initWithOptions:[self constraintOptionsFromArgOptions:options] block:^BOOL(id obj) {
+          return [obj isKindOfClass:cls];
+      }] autorelease];
+}
+
++ (id)checkWithSelector:(SEL)selector onObject:(id)anObject options:(OCMArgOptions)options
+{
+    return [OCMConstraint constraintWithSelector:selector onObject:anObject options:[self constraintOptionsFromArgOptions:options]];
+}
+
++ (id)checkWithOptions:(OCMArgOptions)options withBlock:(BOOL (^)(id obj))block
+{
+    return [[[OCMBlockConstraint alloc] initWithOptions:[self constraintOptionsFromArgOptions:options] block:block] autorelease];
 }
 
 + (id *)setTo:(id)value
@@ -140,4 +181,13 @@ + (id)resolveSpecialValues:(NSValue *)value
     return value;
 }
 
++ (OCMConstraintOptions)constraintOptionsFromArgOptions:(OCMArgOptions)argOptions
+{
+  OCMConstraintOptions constraintOptions = 0;
+  if(argOptions & OCMArgDoNotRetainStubArg) constraintOptions |= OCMConstraintDoNotRetainStubArg;
+  if(argOptions & OCMArgDoNotRetainInvocationArg) constraintOptions |= OCMConstraintDoNotRetainInvocationArg;
+  if(argOptions & OCMArgCopyInvocationArg) constraintOptions |= OCMConstraintCopyInvocationArg;
+  return constraintOptions;
+}
+
 @end

Source/OCMock/OCMConstraint.h

@@ -16,8 +16,22 @@
 
 #import <Foundation/Foundation.h>
 
+// See OCMArgOptions for documentation on options.
+typedef NS_OPTIONS(NSUInteger, OCMConstraintOptions) {
+    OCMConstraintDefaultOptions = 0UL,
+    OCMConstraintDoNotRetainStubArg = (1UL << 0),
+    OCMConstraintDoNotRetainInvocationArg = (1UL << 1),
+    OCMConstraintCopyInvocationArg = (1UL << 2),
+    OCMConstraintNeverRetainArg = OCMConstraintDoNotRetainStubArg | OCMConstraintDoNotRetainInvocationArg,
+};
+
 @interface OCMConstraint : NSObject
 
+@property (readonly) OCMConstraintOptions constraintOptions;
+
+- (instancetype)initWithOptions:(OCMConstraintOptions)options NS_DESIGNATED_INITIALIZER;
+- (instancetype)init NS_UNAVAILABLE;
+
 - (BOOL)evaluate:(id)value;
 
 // if you are looking for any, isNil, etc, they have moved to OCMArg
@@ -27,6 +41,8 @@
 + (instancetype)constraintWithSelector:(SEL)aSelector onObject:(id)anObject;
 + (instancetype)constraintWithSelector:(SEL)aSelector onObject:(id)anObject withValue:(id)aValue;
 
++ (instancetype)constraintWithSelector:(SEL)aSelector onObject:(id)anObject options:(OCMConstraintOptions)options;
++ (instancetype)constraintWithSelector:(SEL)aSelector onObject:(id)anObject withValue:(id)aValue options:(OCMConstraintOptions)options;
 
 @end
 
@@ -44,8 +60,8 @@
     id testValue;
 }
 
-- (instancetype)initWithTestValue:(id)testValue NS_DESIGNATED_INITIALIZER;
-- (instancetype)init NS_UNAVAILABLE;
+- (instancetype)initWithTestValue:(id)testValue options:(OCMConstraintOptions)options NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithOptions:(OCMConstraintOptions)options NS_UNAVAILABLE;
 
 @end
 
@@ -60,8 +76,8 @@
     NSInvocation *invocation;
 }
 
-- (instancetype)initWithInvocation:(NSInvocation *)invocation NS_DESIGNATED_INITIALIZER;
-- (instancetype)init NS_UNAVAILABLE;
+- (instancetype)initWithInvocation:(NSInvocation *)invocation options:(OCMConstraintOptions)options NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithOptions:(OCMConstraintOptions)options NS_UNAVAILABLE;
 
 @end
 
@@ -70,8 +86,8 @@
     BOOL (^block)(id);
 }
 
-- (instancetype)initWithConstraintBlock:(BOOL (^)(id))block NS_DESIGNATED_INITIALIZER;
-- (instancetype)init NS_UNAVAILABLE;
+- (instancetype)initWithOptions:(OCMConstraintOptions)options block:(BOOL (^)(id))block NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithOptions:(OCMConstraintOptions)options NS_UNAVAILABLE;
 
 @end