Switch the test factory to using blocks instead a famously named category. Add basic example to the header docs.

Code/Testing/RKTestFactory.h

@@ -25,42 +25,6 @@
  */
 extern NSString * const RKTestFactoryDefaultStoreFilename;
 
-/**
- Defines optional callback methods for extending the functionality of the factory. Implementation can be provided via a category.
-
- @see `RKTestFactory`
- */
-@protocol RKTestFactoryCallbacks <NSObject>
-
-@optional
-
-///------------------------------
-/// @name Customizing the Factory
-///------------------------------
-
-/**
- Application specific initialization point for the factory.
- 
- Called once per unit testing run when the factory singleton instance is initialized. RestKit applications may override via a category.
- */
-+ (void)didInitialize;
-
-/**
- Application specific customization point for the factory.
- 
- Invoked each time the factory is asked to set up the environment. RestKit applications leveraging the factory may override via a category.
- */
-+ (void)didSetUp;
-
-/**
- Application specific customization point for the factory.
- 
- Invoked each time the factory is tearing down the environment. RestKit applications leveraging the factory may override via a category.
- */
-+ (void)didTearDown;
-
-@end
-
 /*
  Default Factory Names
  */
@@ -72,8 +36,55 @@ extern NSString * const RKTestFactoryDefaultNamesManagedObjectStore;
  The `RKTestFactory` class provides an interface for initializing RestKit objects within a unit testing environment. The factory is used to ensure isolation between test cases by ensuring that RestKit's important singleton objects are torn down between tests and that each test is working within a clean Core Data environment. Callback hooks are provided so that application specific set up and tear down logic can be integrated as well.
 
  The factory also provides for the definition of named factories for instantiating objects quickly. At initialization, there are factories defined for creating instances of `AFHTTPClient`, `RKObjectManager`, and `RKManagedObjectStore`. These factories may be redefined within your application should you choose to utilize a subclass or wish to centralize configuration of objects across the test suite. You may also define additional factories for building instances of objects specific to your application using the same infrastructure.
+
+ ## Customizing the Factory
+
+ The test factory is designed to be customized via an Objective-C category. All factory methods are implemented using blocks that have sensible defaults, but can be overridden by providing an alternate implementation. To do so, implement a category on the `RKTestFactory` class and provide an implementation of the `+ (void)load` method. Within the method body, configure your blocks as you see fit. An example implementation is provided below:
+
+    @interface RKTestFactory (MyApp)
+
+    // Create a convenience method for retrieving an object from the factory
+    + (GGAirport *)ohareAirport;
+    @end
+
+    @implementation RKTestFactory (MyApp)
+
+    + (void)load
+    {
+        [self setSetUpBlock:{
+            // I am called on every invocation of `setUp`!
+        }];
+
+        // Replace the default object manager factory
+        [RKTestFactory defineFactory:RKTestFactoryDefaultNamesObjectManager withBlock:^id {
+            GGObjectManager *objectManager = [[GGObjectManager alloc] initWithBaseURL:[self baseURL]];
+            return objectManager;
+         }];
+
+        // Define a new factory called 'ORD' that returns a representation of Chicago's O'Hare Airport
+        [RKTestFactory defineFactory:@"ORD" withBlock:^id{
+            GGAirport *ord = [RKTestFactory insertManagedObjectForEntityForName:@"Airport" inManagedObjectContext:nil withProperties:nil];
+            ord.airportID = @16;
+            ord.name = @"Chicago O'Hare International Airport";
+            ord.code = @"ORD";
+            ord.city = @"Chicago";
+            ord.favorite = @(YES);
+            ord.timeZoneName = @"America/Chicago";
+            ord.latitude = @(41.9781);
+            ord.longitude = @(-87.9061);
+
+            return ord;
+         }];
+    }
+
+    + (GGAirport *)ohareAirport
+    {
+        return [self objectFromFactory:@"ORD"];
+    }
+
+    @end
  */
-@interface RKTestFactory : NSObject <RKTestFactoryCallbacks>
+@interface RKTestFactory : NSObject
 
 ///------------------------------
 /// @name Configuring the Factory
@@ -178,17 +189,33 @@ extern NSString * const RKTestFactoryDefaultNamesManagedObjectStore;
  */
 + (id)managedObjectStore;
 
-///-----------------------------------------------------------------------------
-/// @name Managing Test State
-///-----------------------------------------------------------------------------
+///----------------------------------------------
+/// @name Configuring Set Up and Tear Down Blocks
+///----------------------------------------------
 
 /**
- Sets up the RestKit testing environment. Invokes the `didSetUp` callback for application specific setup.
+ Sets a block to be executed when the `setUp` method is called as part of a test run.
+ */
++ (void)setSetupBlock:(void (^)())block;
+
+/**
+ Sets a block to be executed when the `tearDown` method is called as part of a test run.
+ */
++ (void)setTearDownBlock:(void (^)())block;
+
+///--------------------------
+/// @name Managing Test State
+///--------------------------
+
+/**
+ Sets up the RestKit testing environment. Executes the block set via `setSetupBlock:` to perform application specific setup.
+
+ Note that the firt time that the `setUp` method is invoked, it will execute a `tearDown` to clear any configuration that may have taken place in during application launch.
  */
 + (void)setUp;
 
 /**
- Tears down the RestKit testing environment by clearing singleton instances, helping to ensure test case isolation. Invokes the `didTearDown` callback for application specific cleanup.
+ Tears down the RestKit testing environment by clearing singleton instances, helping to ensure test case isolation. Executes the block set via `setTearDownBlock:` to perform application specific cleanup.
  */
 + (void)tearDown;
 

Code/Testing/RKTestFactory.m

@@ -25,11 +25,19 @@
 #import "RKPathUtilities.h"
 #import "RKMIMETypeSerialization.h"
 
+// Expose MIME Type singleton and initialization routine
+@interface RKMIMETypeSerialization ()
++ (RKMIMETypeSerialization *)sharedSerialization;
+- (void)addRegistrationsForKnownSerializations;
+@end
+
 @interface RKTestFactory ()
 
 @property (nonatomic, strong) NSURL *baseURL;
 @property (nonatomic, strong) NSMutableDictionary *factoryBlocks;
 @property (nonatomic, strong) NSMutableDictionary *sharedObjectsByFactoryName;
+@property (nonatomic, copy) void (^setUpBlock)();
+@property (nonatomic, copy) void (^tearDownBlock)();
 
 + (RKTestFactory *)sharedFactory;
 - (void)defineFactory:(NSString *)factoryName withBlock:(id (^)())block;
@@ -38,29 +46,17 @@
 
 @end
 
-// Expose MIME Type singleton and initialization routine
-@interface RKMIMETypeSerialization ()
-+ (RKMIMETypeSerialization *)sharedSerialization;
-- (void)addRegistrationsForKnownSerializations;
-@end
-
-static RKTestFactory *sharedFactory = nil;
-
 @implementation RKTestFactory
 
-
 + (void)initialize
 {
     // Ensure the shared factory is initialized
     [self sharedFactory];
-
-    if ([RKTestFactory respondsToSelector:@selector(didInitialize)]) {
-        [RKTestFactory didInitialize];
-    }
 }
 
 + (RKTestFactory *)sharedFactory
 {
+    static RKTestFactory *sharedFactory = nil;
     if (! sharedFactory) {
         sharedFactory = [RKTestFactory new];
     }
@@ -214,6 +210,16 @@ static RKTestFactory *sharedFactory = nil;
     return [self sharedObjectFromFactory:RKTestFactoryDefaultNamesManagedObjectStore];
 }
 
++ (void)setSetupBlock:(void (^)())block
+{
+    [RKTestFactory sharedFactory].setUpBlock = block;
+}
+
++ (void)setTearDownBlock:(void (^)())block
+{
+    [RKTestFactory sharedFactory].tearDownBlock = block;
+}
+
 + (void)setUp
 {
     static dispatch_once_t onceToken;
@@ -238,9 +244,7 @@ static RKTestFactory *sharedFactory = nil;
     // Clear the NSURLCache
     [[NSURLCache sharedURLCache] removeAllCachedResponses];
 
-    if ([self respondsToSelector:@selector(didSetUp)]) {
-        [self didSetUp];
-    }
+    if ([RKTestFactory sharedFactory].setUpBlock) [RKTestFactory sharedFactory].setUpBlock();
 }
 
 + (void)tearDown
@@ -268,9 +272,7 @@ static RKTestFactory *sharedFactory = nil;
     [RKObjectManager setSharedManager:nil];
     [RKManagedObjectStore setDefaultStore:nil];
 
-    if ([self respondsToSelector:@selector(didTearDown)]) {
-        [self didTearDown];
-    }
+    if ([RKTestFactory sharedFactory].tearDownBlock) [RKTestFactory sharedFactory].tearDownBlock();
 }
 
 @end