mirror of
https://github.com/zhigang1992/RestKit.git
synced 2026-04-03 22:49:50 +08:00
110 lines
4.5 KiB
Objective-C
110 lines
4.5 KiB
Objective-C
//
|
|
// RKMappingTest.h
|
|
// RKGithub
|
|
//
|
|
// Created by Blake Watters on 2/17/12.
|
|
// Copyright (c) 2012 RestKit. All rights reserved.
|
|
//
|
|
|
|
#import <Foundation/Foundation.h>
|
|
#import "RKObjectMappingOperation.h"
|
|
#import "RKMappingTestExpectation.h"
|
|
|
|
/**
|
|
An RKMappingTest object provides support for unit testing
|
|
a RestKit object mapping operation by evaluation expectations
|
|
against events recorded during an object mapping operation.
|
|
*/
|
|
@interface RKMappingTest : NSObject <RKObjectMappingOperationDelegate>
|
|
|
|
///-----------------------------------------------------------------------------
|
|
/// @name Creating Tests
|
|
///-----------------------------------------------------------------------------
|
|
|
|
/**
|
|
Creates and returns a new test for a given object mapping and source object.
|
|
|
|
@param mapping The object mapping being tested.
|
|
@param sourceObject The source object being mapped.
|
|
@return A new mapping test object for a mapping and sourceObject.
|
|
*/
|
|
+ (RKMappingTest *)testForMapping:(RKObjectMapping *)mapping object:(id)sourceObject;
|
|
|
|
/**
|
|
Creates and returns a new test for a given object mapping, source object and destination
|
|
object.
|
|
|
|
@param mapping The object mapping being tested.
|
|
@param sourceObject The source object being mapped from.
|
|
@param destinationObject The destionation object being to.
|
|
@return A new mapping test object for a mapping, a sourceObject and a destination object.
|
|
*/
|
|
+ (RKMappingTest *)testForMapping:(RKObjectMapping *)mapping sourceObject:(id)sourceObject destinationObject:(id)destinationObject;
|
|
|
|
///-----------------------------------------------------------------------------
|
|
/// @name Setting Expectations
|
|
///-----------------------------------------------------------------------------
|
|
|
|
/**
|
|
Creates and adds an expectation that a key path on the source object will be mapped to a new
|
|
key path on the destination object.
|
|
|
|
@param sourceKeyPath A key path on the sourceObject that should be mapped from.
|
|
@param destinationKeyPath A key path on the destinationObject that should be mapped to.
|
|
@see RKObjectMappingTestExpectation
|
|
*/
|
|
- (void)expectMappingFromKeyPath:(NSString *)sourceKeyPath toKeyPath:(NSString *)destinationKeyPath;
|
|
|
|
/**
|
|
Creates and adds an expectation that a key path on the source object will be mapped to a new
|
|
key path on the destination object with a given value.
|
|
|
|
@param sourceKeyPath A key path on the sourceObject that should be mapped from.
|
|
@param destinationKeyPath A key path on the destinationObject that should be mapped from.
|
|
@param value A value that is expected to be assigned to destinationKeyPath on the destinationObject.
|
|
@see RKObjectMappingTestExpectation
|
|
*/
|
|
- (void)expectMappingFromKeyPath:(NSString *)sourceKeyPath toKeyPath:(NSString *)destinationKeyPath withValue:(id)value;
|
|
|
|
/**
|
|
Creates and adds an expectation that a key path on the source object will be mapped to a new
|
|
key path on the destination object with a value that passes a given test block.
|
|
|
|
@param sourceKeyPath A key path on the sourceObject that should be mapped from.
|
|
@param destinationKeyPath A key path on the destinationObject that should be mapped to.
|
|
@param evaluationBlock A block with which to evaluate the success of the mapping.
|
|
@see RKObjectMappingTestExpectation
|
|
*/
|
|
- (void)expectMappingFromKeyPath:(NSString *)sourceKeyPath toKeyPath:(NSString *)destinationKeyPath passingTest:(BOOL (^)(RKObjectAttributeMapping *mapping, id value))evaluationBlock;
|
|
|
|
/**
|
|
Adds an expectation to the test to be evaluated during verification.
|
|
|
|
@param expectation An expectation object to evaluate during test verification.
|
|
@see RKObjectMappingTestExpectation
|
|
*/
|
|
- (void)addExpectation:(RKMappingTestExpectation *)expectation;
|
|
|
|
///-----------------------------------------------------------------------------
|
|
/// @name Verifying Results
|
|
///-----------------------------------------------------------------------------
|
|
|
|
/**
|
|
Verifies that the mapping is configured correctly by performing an object mapping operation
|
|
and ensuring that all expectations are met.
|
|
|
|
@exception NSInternalInconsistencyException Raises an
|
|
NSInternalInconsistencyException if mapping failes or any expectation is not satisfied.
|
|
*/
|
|
- (void)verify;
|
|
|
|
///-----------------------------------------------------------------------------
|
|
/// @name Test Configuration
|
|
///-----------------------------------------------------------------------------
|
|
|
|
@property (nonatomic, strong, readonly) RKObjectMapping *mapping;
|
|
@property (nonatomic, strong, readonly) id sourceObject;
|
|
@property (nonatomic, strong, readonly) id destinationObject;
|
|
|
|
@end
|