Merge pull request nfarina#16 from michalkos/master_arc

Added encodedDescription for SMXMLElement

Author: nfarina

SMXMLDocument.h

@@ -55,6 +55,7 @@ extern NSString *const SMXMLDocumentErrorDomain;
 - (SMXMLElement *)descendantWithPath:(NSString *)path;
 - (NSString *)valueWithPath:(NSString *)path;
 - (NSString *)fullDescription; // like -description, this writes the document out to an XML string, but doesn't truncate the node values.
+- (NSString *)encodedDescription; // like -fullDescription, but this does HTML encoding of element content
 
 @end
 
@@ -68,5 +69,6 @@ extern NSString *const SMXMLDocumentErrorDomain;
 + (SMXMLDocument *)documentWithData:(NSData *)data error:(NSError **)outError;
 
 - (NSString *)fullDescription;
+- (NSString *)encodedDescription;
 
 @end

SMXMLDocument.m

@@ -21,18 +21,23 @@ - (id)initWithDocument:(SMXMLDocument *)document {
 	return self;
 }
 
-- (NSString *)descriptionWithIndent:(NSString *)indent truncatedValues:(BOOL)truncated {
+- (NSString *)descriptionWithIndent:(NSString *)indent truncatedValues:(BOOL)truncated encoded:(BOOL)encode {
 
 	NSMutableString *s = [NSMutableString string];
 	[s appendFormat:@"%@<%@", indent, self.name];
 
-	for (NSString *attribute in self.attributes)
-		[s appendFormat:@" %@=\"%@\"", attribute, [self.attributes objectForKey:attribute]];
+	for (NSString *attribute in self.attributes) {
+		NSString *attributeValue = [self.attributes objectForKey:attribute];
+		[s appendFormat:@" %@=\"%@\"", attribute, encode ? [self encodeString:attributeValue] : attributeValue];
+	}
 
-    NSString *valueOrTrimmed = [self.value stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
+	NSString *valueOrTrimmed = [self.value stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
 
-    if (truncated && valueOrTrimmed.length > 25)
-        valueOrTrimmed = [NSString stringWithFormat:@"%@…", [valueOrTrimmed substringToIndex:25]];
+	if (truncated && valueOrTrimmed.length > 25)
+		valueOrTrimmed = [NSString stringWithFormat:@"%@…", [valueOrTrimmed substringToIndex:25]];
+	
+	if (encode)
+		valueOrTrimmed = [self encodeString:valueOrTrimmed];
 
 	if (self.children.count) {
 		[s appendString:@">\n"];
@@ -43,7 +48,7 @@ - (NSString *)descriptionWithIndent:(NSString *)indent truncatedValues:(BOOL)tru
 			[s appendFormat:@"%@%@\n", childIndent, valueOrTrimmed];
 
 		for (SMXMLElement *child in self.children)
-			[s appendFormat:@"%@\n", [child descriptionWithIndent:childIndent truncatedValues:truncated]];
+			[s appendFormat:@"%@\n", [child descriptionWithIndent:childIndent truncatedValues:truncated encoded:encode]];
 
 		[s appendFormat:@"%@</%@>", indent, self.name];
 	}
@@ -55,12 +60,32 @@ - (NSString *)descriptionWithIndent:(NSString *)indent truncatedValues:(BOOL)tru
 	return s;	
 }
 
+- (NSString *)encodeString:(NSString *)string
+{
+	if (!string.length)
+		return string;
+
+	NSMutableString *encoded = [NSMutableString stringWithString:string];
+
+	[encoded replaceOccurrencesOfString:@"&"  withString:@"&amp;"  options:NSLiteralSearch range:NSMakeRange(0, [encoded length])];
+	[encoded replaceOccurrencesOfString:@"\"" withString:@"&quot;" options:NSLiteralSearch range:NSMakeRange(0, [encoded length])];
+	[encoded replaceOccurrencesOfString:@"'"  withString:@"&#x27;" options:NSLiteralSearch range:NSMakeRange(0, [encoded length])];
+	[encoded replaceOccurrencesOfString:@">"  withString:@"&gt;"   options:NSLiteralSearch range:NSMakeRange(0, [encoded length])];
+	[encoded replaceOccurrencesOfString:@"<"  withString:@"&lt;"   options:NSLiteralSearch range:NSMakeRange(0, [encoded length])];
+
+	return encoded;
+}
+
 - (NSString *)description {
-	return [self descriptionWithIndent:@"" truncatedValues:YES];
+	return [self descriptionWithIndent:@"" truncatedValues:YES encoded:NO];
 }
 
 - (NSString *)fullDescription {
-	return [self descriptionWithIndent:@"" truncatedValues:NO];
+	return [self descriptionWithIndent:@"" truncatedValues:NO encoded:NO];
+}
+
+- (NSString *)encodedDescription {
+	return [self descriptionWithIndent:@"" truncatedValues:NO encoded:YES];
 }
 
 - (void)parser:(NSXMLParser *)parser foundCharacters:(NSString *)string {
@@ -187,4 +212,8 @@ - (NSString *)fullDescription {
 	return self.root.fullDescription;
 }
 
+- (NSString *)encodedDescription {
+	return self.root.encodedDescription;
+}
+
 @end