mirror of
https://github.com/zhigang1992/RestKit.git
synced 2026-04-02 09:31:32 +08:00
1c6564f823
* Enable evaluation blocks to return an NSError describing the failure * Align all RKAttributeMapping references to RKPropertyMapping * Cleanup docs * Add `RKMappingTestExpectationTestCondition` macro for succinctly implementing mapping test evaluation blocks * Clean up descriptions for better output from Kiwi
139 lines
7.2 KiB
Objective-C
139 lines
7.2 KiB
Objective-C
//
|
|
// RKMappingTestExpectation.h
|
|
// RestKit
|
|
//
|
|
// Created by Blake Watters on 2/17/12.
|
|
// Copyright (c) 2009-2012 RestKit. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
@class RKMapping, RKPropertyMapping, RKMappingTestExpectation;
|
|
|
|
/**
|
|
@typedef RKMappingTestExpectationEvaluationBlock
|
|
|
|
@param expectation The expectation object itself. This is passed so that there is a reference available at the time of evaluation.
|
|
@param mapping The property mapping object that occurred for the source and destination key paths of the expectation. Will be an instance of `RKAttributeMapping, `RKRelationshipMapping`, or `RKConnectionMapping`.
|
|
@param mappedValue The value that was mapped.
|
|
@param error A pointer to an error object that is to be set in the event that the expectation evaluates negatively. If left to `nil`, a generic error will be generated.
|
|
*/
|
|
typedef BOOL (^RKMappingTestExpectationEvaluationBlock)(RKMappingTestExpectation *expectation, RKPropertyMapping *mapping, id mappedValue, NSError **error);
|
|
|
|
/**
|
|
@define RKMappingTestExpectationTestCondition
|
|
@abstract Tests a condition and returns `NO` and error if it is not true.
|
|
@discussion This is a useful macro when constructing mapping test evaluation blocks. It will test a condition and return `NO` as well as construct an error. This is meant to be used **only** within the body of a `RKMappingTestExpectationEvaluationBlock` object.
|
|
@param condition The condition to test.
|
|
@param error The NSError object to put the error string into. May be nil, but should usually be the error parameter from the expectation evaluation block.
|
|
@param ... A string describing the error.
|
|
*/
|
|
#define RKMappingTestExpectationTestCondition(condition, error, ...) ({ \
|
|
if (!(condition)) { \
|
|
if (error) { \
|
|
*error = [NSError errorWithDomain:RKMappingTestErrorDomain code:RKMappingTestEvaluationBlockError userInfo:[NSDictionary dictionaryWithObjectsAndKeys:[NSString stringWithFormat:__VA_ARGS__], NSLocalizedDescriptionKey, nil]]; \
|
|
} \
|
|
return NO; \
|
|
} \
|
|
})
|
|
|
|
/**
|
|
An `RKMappingTestExpectation` object defines an expected mapping event that should occur during the execution of a `RKMappingTest`.
|
|
|
|
@see `RKMappingTest`
|
|
*/
|
|
@interface RKMappingTestExpectation : NSObject
|
|
|
|
///-----------------------------------------------------------------------------
|
|
/// @name Creating Expectations
|
|
///-----------------------------------------------------------------------------
|
|
|
|
/**
|
|
Creates and returns a new expectation specifying that a key path in a source object should be mapped to another key path on a destination object. The value mapped is not evaluated.
|
|
|
|
@param sourceKeyPath A key path on the source object that should be mapped.
|
|
@param destinationKeyPath A key path on the destination object that should be mapped onto.
|
|
@return An expectation specifying that sourceKeyPath should be mapped to destinationKeyPath.
|
|
*/
|
|
+ (RKMappingTestExpectation *)expectationWithSourceKeyPath:(NSString *)sourceKeyPath destinationKeyPath:(NSString *)destinationKeyPath;
|
|
|
|
/**
|
|
Creates and returns a new expectation specifying that a key path in a source object should be mapped to another key path on a destination object with a given value.
|
|
|
|
@param sourceKeyPath A key path on the source object that should be mapped.
|
|
@param destinationKeyPath A key path on the destination object that should be mapped onto.
|
|
@param value The value that is expected to be assigned to the destination object at destinationKeyPath.
|
|
@return An expectation specifying that sourceKeyPath should be mapped to destinationKeyPath with value.
|
|
*/
|
|
+ (RKMappingTestExpectation *)expectationWithSourceKeyPath:(NSString *)sourceKeyPath destinationKeyPath:(NSString *)destinationKeyPath value:(id)value;
|
|
|
|
/**
|
|
Creates and returns a new expectation specifying that a key path in a source object should be mapped to another key path on a destinaton object and that the attribute mapping and value should evaluate to true with a given block.
|
|
|
|
@param sourceKeyPath A key path on the source object that should be mapped.
|
|
@param destinationKeyPath A key path on the destination object that should be mapped onto.
|
|
@param evaluationBlock A block with which to evaluate the success of the mapping.
|
|
@return An expectation specifying that sourceKeyPath should be mapped to destinationKeyPath with value.
|
|
*/
|
|
+ (RKMappingTestExpectation *)expectationWithSourceKeyPath:(NSString *)sourceKeyPath destinationKeyPath:(NSString *)destinationKeyPath evaluationBlock:(RKMappingTestExpectationEvaluationBlock)evaluationBlock;
|
|
|
|
/**
|
|
Creates and returns a new expectation specifying that a key path in a source object should be mapped to another key path on a destinaton object using a specific object mapping for the relationship.
|
|
|
|
@param sourceKeyPath A key path on the source object that should be mapped.
|
|
@param destinationKeyPath A key path on the destination object that should be mapped onto.
|
|
@param mapping An object mapping that is expected to be used for mapping the nested relationship.
|
|
@return An expectation specifying that sourceKeyPath should be mapped to destinationKeyPath using a specific object mapping.
|
|
*/
|
|
+ (RKMappingTestExpectation *)expectationWithSourceKeyPath:(NSString *)sourceKeyPath destinationKeyPath:(NSString *)destinationKeyPath mapping:(RKMapping *)mapping;
|
|
|
|
///-----------------------------------------------------------------------------
|
|
/// @name Expectation Values
|
|
///-----------------------------------------------------------------------------
|
|
|
|
/**
|
|
Returns a keyPath on the source object that a value should be mapped from.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSString *sourceKeyPath;
|
|
|
|
/**
|
|
Returns a keyPath on the destination object that a value should be mapped to.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSString *destinationKeyPath;
|
|
|
|
/**
|
|
Returns the expected value that should be set to the destinationKeyPath of the destination object.
|
|
*/
|
|
@property (nonatomic, strong, readonly) id value;
|
|
|
|
/**
|
|
A block used to evaluate if the expectation has been satisfied.
|
|
|
|
The block accepts three arguments, an `RKPropertyMapping` object denoting the attribute or relationship that was mapped, the mapped value, and a pointer to an error object that is to be set if the block evaluates negatively, and returns a Boolean value indicating if the mapping satisfies the expectations of the block.
|
|
*/
|
|
@property (nonatomic, copy, readonly) RKMappingTestExpectationEvaluationBlock evaluationBlock;
|
|
|
|
/**
|
|
Returns the expected object mapping to be used for mapping a nested relationship.
|
|
*/
|
|
@property (nonatomic, strong, readonly) RKMapping *mapping;
|
|
|
|
/**
|
|
Returns a string summary of the expected keyPath mapping within the expectation
|
|
|
|
@return A string describing the expected sourceKeyPath to destinationKeyPath mapping.
|
|
*/
|
|
- (NSString *)mappingDescription;
|
|
|
|
@end
|