Add tests to ensure the key path of errors gets returned.

j-h-a · j-h-a · commit 3c89228fef21 · 2013-10-01T12:12:19.000+01:00
diff --git a/JSONModel/JSONModel/JSONModelError.h b/JSONModel/JSONModel/JSONModelError.h
@@ -46,6 +46,13 @@ extern NSString* const kJSONModelMissingKeys;
  */
 extern NSString* const kJSONModelTypeMismatch;
 
+/**
+ * If an error occurs in a nested model, check the userInfo dictionary of
+ * the JSONModelError instance you get back - under the kJSONModelKeyPath
+ * key you will find key-path at which the error occurred.
+ */
+extern NSString* const kJSONModelKeyPath;
+
 /////////////////////////////////////////////////////////////////////////////////////////////
 /**
  * Custom NSError subclass with shortcut methods for creating 
diff --git a/JSONModel/JSONModel/JSONModelError.m b/JSONModel/JSONModel/JSONModelError.m
@@ -19,6 +19,7 @@
 NSString* const JSONModelErrorDomain = @"JSONModelErrorDomain";
 NSString* const kJSONModelMissingKeys = @"kJSONModelMissingKeys";
 NSString* const kJSONModelTypeMismatch = @"kJSONModelTypeMismatch";
+NSString* const kJSONModelKeyPath = @"kJSONModelKeyPath";
 
 @implementation JSONModelError
 
diff --git a/JSONModelDemoTests/UnitTests/SimpleDataErrorTests.m b/JSONModelDemoTests/UnitTests/SimpleDataErrorTests.m
@@ -81,7 +81,7 @@ -(void)testBrokenJSON
     STAssertTrue(err.code == kJSONModelErrorBadJSON, @"Wrong error for missing keys");
 }
 
-- (void)performTestErrorsInNestedModelFile:(NSString*)jsonFilename
+- (NSError*)performTestErrorsInNestedModelFile:(NSString*)jsonFilename
 {
     NSString* filePath = [[NSBundle bundleForClass:[JSONModel class]].resourcePath stringByAppendingPathComponent:jsonFilename];
     NSString* jsonContents = [NSString stringWithContentsOfFile:filePath encoding:NSUTF8StringEncoding error:nil];
@@ -96,17 +96,24 @@ - (void)performTestErrorsInNestedModelFile:(NSString*)jsonFilename
     STAssertTrue(err.code == kJSONModelErrorInvalidData, @"Wrong error for missing keys");
 
 	// Make sure that 'name' is listed as the missing key
-	STAssertTrue([err.userInfo[kJSONModelMissingKeys][0] isEqualToString:@"name"], @"'name' should be the missing key.");
+	STAssertEqualObjects(err.userInfo[kJSONModelMissingKeys][0], @"name", @"'name' should be the missing key.");
+	return err;
 }
 
 -(void)testErrorsInNestedModelsArray
 {
-	[self performTestErrorsInNestedModelFile:@"nestedDataWithArrayError.json"];
+	NSError* err = [self performTestErrorsInNestedModelFile:@"nestedDataWithArrayError.json"];
+
+	// Make sure that the error is at the expected key-path
+	STAssertEqualObjects(err.userInfo[kJSONModelKeyPath], @"images[1]", @"kJSONModelKeyPath does not contain the path of the error.");
 }
 
 -(void)testErrorsInNestedModelsDictionary
 {
-	[self performTestErrorsInNestedModelFile:@"nestedDataWithDictionaryError.json"];
+	NSError* err = [self performTestErrorsInNestedModelFile:@"nestedDataWithDictionaryError.json"];
+
+	// Make sure that the error is at the expected key-path
+	STAssertEqualObjects(err.userInfo[kJSONModelKeyPath], @"imageObject.image2", @"kJSONModelKeyPath does not contain the path of the error.");
 }
 
 -(void)testForNilInputFromString

Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ -(void)testBrokenJSON`
`81`	`81`	`STAssertTrue(err.code == kJSONModelErrorBadJSON, @"Wrong error for missing keys");`
`82`	`82`	`}`
`83`	`83`
`84`		`-- (void)performTestErrorsInNestedModelFile:(NSString*)jsonFilename`
	`84`	`+- (NSError)performTestErrorsInNestedModelFile:(NSString)jsonFilename`
`85`	`85`	`{`
`86`	`86`	`NSString* filePath = [[NSBundle bundleForClass:[JSONModel class]].resourcePath stringByAppendingPathComponent:jsonFilename];`
`87`	`87`	`NSString* jsonContents = [NSString stringWithContentsOfFile:filePath encoding:NSUTF8StringEncoding error:nil];`
`@@ -96,17 +96,24 @@ - (void)performTestErrorsInNestedModelFile:(NSString*)jsonFilename`
`96`	`96`	`STAssertTrue(err.code == kJSONModelErrorInvalidData, @"Wrong error for missing keys");`
`97`	`97`
`98`	`98`	`// Make sure that 'name' is listed as the missing key`
`99`		`- STAssertTrue([err.userInfo[kJSONModelMissingKeys][0] isEqualToString:@"name"], @"'name' should be the missing key.");`
	`99`	`+ STAssertEqualObjects(err.userInfo[kJSONModelMissingKeys][0], @"name", @"'name' should be the missing key.");`
	`100`	`+ return err;`
`100`	`101`	`}`
`101`	`102`
`102`	`103`	`-(void)testErrorsInNestedModelsArray`
`103`	`104`	`{`
`104`		`- [self performTestErrorsInNestedModelFile:@"nestedDataWithArrayError.json"];`
	`105`	`+ NSError* err = [self performTestErrorsInNestedModelFile:@"nestedDataWithArrayError.json"];`
	`106`	`+`
	`107`	`+ // Make sure that the error is at the expected key-path`
	`108`	`+ STAssertEqualObjects(err.userInfo[kJSONModelKeyPath], @"images[1]", @"kJSONModelKeyPath does not contain the path of the error.");`
`105`	`109`	`}`
`106`	`110`
`107`	`111`	`-(void)testErrorsInNestedModelsDictionary`
`108`	`112`	`{`
`109`		`- [self performTestErrorsInNestedModelFile:@"nestedDataWithDictionaryError.json"];`
	`113`	`+ NSError* err = [self performTestErrorsInNestedModelFile:@"nestedDataWithDictionaryError.json"];`
	`114`	`+`
	`115`	`+ // Make sure that the error is at the expected key-path`
	`116`	`+ STAssertEqualObjects(err.userInfo[kJSONModelKeyPath], @"imageObject.image2", @"kJSONModelKeyPath does not contain the path of the error.");`
`110`	`117`	`}`
`111`	`118`
`112`	`119`	`-(void)testForNilInputFromString`