Libraries/GTM/YAJL_GTMBase64.h Libraries/GTM/YAJL_GTMBase64.m Tests/Samples/gen_expected_ignore_unknown1.json Tests/Samples/gen_expected_plist1.json @@ -38,12 +38,30 @@ extern NSString *const YAJLGenInvalidObjectException; enum { YAJLGenOptionsNone = 0, YAJLGenOptionsBeautify = 1 << 0, + YAJLGenOptionsIgnoreUnknownTypes = 1 << 1, // Ignore unknown types (will use null value) + YAJLGenOptionsIncludeUnsupportedTypes = 1 << 2, // Handle non-JSON types (including NSDate, NSData, NSURL) }; typedef NSUInteger YAJLGenOptions; - +/*! + YAJL JSON string generator. + Supports the following types: + - NSArray + - NSDictionary + - NSString + - NSNumber + - NSNull + + We also support the following types (if using YAJLGenOptionsIncludeUnsupportedTypes option), + by converting to JSON supported types: + - NSDate -> number representing number of milliseconds since (1970) epoch + - NSData -> Base64 encoded string + - NSURL -> URL (absolute) string + */ @interface YAJLGen : NSObject { yajl_gen gen_; + + YAJLGenOptions genOptions_; } - (id)initWithGenOptions:(YAJLGenOptions)genOptions indentString:(NSString *)indentString; Classes/YAJLGen.h @@ -28,6 +28,7 @@ // #import "YAJLGen.h" +#import "YAJL_GTMBase64.h" NSString *const YAJLGenInvalidObjectException = @"YAJLGenInvalidObjectException"; @@ -39,6 +40,7 @@ NSString *const YAJLGenInvalidObjectException = @"YAJLGenInvalidObjectException" - (id)initWithGenOptions:(YAJLGenOptions)genOptions indentString:(NSString *)indentString { if ((self = [super init])) { + genOptions_ = genOptions; yajl_gen_config cfg = { ((genOptions & YAJLGenOptionsBeautify) ? 1 : 0), [indentString UTF8String] @@ -78,8 +80,32 @@ NSString *const YAJLGenInvalidObjectException = @"YAJLGenInvalidObjectException" [self string:obj]; } else if ([obj isKindOfClass:[NSNull class]]) { [self null]; - } else { - [NSException raise:YAJLGenInvalidObjectException format:@"Invalid object: %@", obj]; + } else { + + BOOL unknownType = NO; + if (genOptions_ & YAJLGenOptionsIncludeUnsupportedTypes) { + // Begin with support for non-JSON representable (PList) types + if ([obj isKindOfClass:[NSDate class]]) { + [self number:[NSNumber numberWithLongLong:round([obj timeIntervalSince1970] * 1000)]]; + } else if ([obj isKindOfClass:[NSData class]]) { + [self string:[YAJL_GTMBase64 stringByEncodingData:obj]]; + } else if ([obj isKindOfClass:[NSURL class]]) { + [self string:[obj absoluteString]]; + } else { + unknownType = YES; + } + } else { + unknownType = YES; + } + + // If we didn't handle special PList types + if (unknownType) { + if (!(genOptions_ & YAJLGenOptionsIgnoreUnknownTypes)) { + [NSException raise:YAJLGenInvalidObjectException format:@"Unknown object type: %@ (%@)", [obj class], obj]; + } else { + [self null]; // Use null value for unknown type if we are ignoring + } + } } } @@ -133,3 +159,7 @@ NSString *const YAJLGenInvalidObjectException = @"YAJLGenInvalidObjectException" } @end + + + + Classes/YAJLGen.m @@ -76,4 +76,42 @@ GHAssertEqualStrings(buffer, expected, nil); } +- (void)testGenObjectUnknownType { + NSDictionary *dict = [NSDictionary dictionaryWithObjectsAndKeys:[NSDate dateWithTimeIntervalSince1970:1], @"date", nil]; + YAJLGen *gen = [[YAJLGen alloc] init]; + GHAssertThrows([gen object:dict], nil); + [gen release]; +} + +- (void)testGenObjectIgnoreUnknownType { + NSDictionary *dict = [NSDictionary dictionaryWithObjectsAndKeys:[NSDate dateWithTimeIntervalSince1970:1], @"date", nil]; + + YAJLGen *gen = [[YAJLGen alloc] initWithGenOptions:YAJLGenOptionsIgnoreUnknownTypes indentString:@""]; + [gen object:dict]; + NSString *buffer = [gen buffer]; + [gen release]; + + NSString *expected = [self loadString:@"gen_expected_ignore_unknown1"]; + GHTestLog(buffer); + GHAssertEqualStrings(buffer, expected, nil); +} + +- (void)testGenObjectPListTypes { + const char *testData = "ABCDEFG"; + NSArray *array = [NSArray arrayWithObjects: + [NSDate dateWithTimeIntervalSince1970:1], + [NSData dataWithBytes:testData length:6], + [NSURL URLWithString:@"http://www.yelp.com/"], + nil]; + + YAJLGen *gen = [[YAJLGen alloc] initWithGenOptions:YAJLGenOptionsIncludeUnsupportedTypes indentString:@""]; + [gen object:array]; + NSString *buffer = [gen buffer]; + [gen release]; + + NSString *expected = [self loadString:@"gen_expected_plist1"]; + GHTestLog(buffer); + GHAssertEqualStrings(buffer, expected, nil); +} + @end Tests/YAJLGenTest.m 34515ffd3017a45a6308c5884a4f8a127d52bd31 Gabriel Handford gabrielh@gmail.com http://github.com/gabriel/yajl-objc/commit/df6742e1594b40f47aba20aa55aac935f2062b84 df6742e1594b40f47aba20aa55aac935f2062b84 2009-10-30T11:31:51-07:00 2009-10-30T11:31:51-07:00 Adding options to support unsupported types b3738e60856dfc30420b4909932f688f004e4689 Gabriel Handford gabrielh@gmail.com