Merge branch 'release/3.1.0'

Author: iabudiab

.jazzy.yaml

@@ -1,5 +1,5 @@
 module: HTMLKit
-module_version: 3.0.0
+module_version: 3.1.0
 author: Iskandar Abudiab 
 author_url: https://twitter.com/iabudiab
 github_url: https://github.com/iabudiab/HTMLKit
@@ -33,6 +33,7 @@ custom_categories:
     - HTMLTemplate
     - HTMLDOMTokenList
     - HTMLRange
+    - HTMLSerializer
 
   - name: Iteration & Filtering
     children:
@@ -41,7 +42,9 @@ custom_categories:
     - HTMLNodeFilterShowOptions
     - HTMLNodeFilterValue
     - HTMLNodeFilterBlock
+    - HTMLNodeVisitor
     - HTMLSelectorNodeFilter
+    - HTMLTreeVisitor
     - HTMLTreeWalker
 
   - name: Structures

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## [3.1.0](https://github.com/iabudiab/HTMLKit/releases/tag/3.1.0)
+
+Release on 2019.08.20
+
+### Added
+
+- `HTMLTreeVisitor` that walks the DOM in tree order
+- New HTML serialization implementation based on visitor pattern
+
+### Fixes
+
+- HTML serialization for deeply nested DOM trees (issue #33)
+- Occasional Internal Consistency exceptions when deallocating node iterator (issue #36)
+
+
 ## [3.0.0](https://github.com/iabudiab/HTMLKit/releases/tag/3.0.0) 
 
 Released on 2019.03.28

Example/HTMLKitExample/HTMLKitExample/main.swift

@@ -112,7 +112,7 @@ do {
 	try scraper.load()
 
 	// Parse the selector
-	let repositoryContent = try CSSSelectorParser.parseSelector("[role='main'] .repository-content > .file-wrap > .files tr.js-navigation-item")
+	let repositoryContent = try CSSSelectorParser.parseSelector(".repository-content > .file-wrap > table.files tr.js-navigation-item")
 
 	// Query matching elements
 	let files =  try scraper.listElements(matching: repositoryContent)
@@ -131,13 +131,10 @@ do {
 	// The following selector: "[role='main'] div.file table.js-file-line-container td:nth-child(2)"
 	// can be defined in type-safe manner:
 	let selector = allOf([
-		descendantOfElementSelector(
-			attributeSelector(.exactMatch, "role", "main")
-		),
 		descendantOfElementSelector(
 			allOf([
 				typeSelector("div"),
-				classSelector("file")
+				classSelector("repository-content")
 			])
 		),
 		descendantOfElementSelector(

HTMLKit.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name               = "HTMLKit"
-  s.version            = "3.0.0"
+  s.version            = "3.1.0"
   s.summary            = "HTMLKit, an Objective-C framework for your everyday HTML needs."
   s.license            = "MIT"
   s.homepage           = "https://github.com/iabudiab/HTMLKit"

HTMLKit.xcodeproj/project.pbxproj

@@ -77,7 +77,7 @@ To add `HTMLKit` as a dependency into your project using CocoaPods just add the
 
 ```ruby
 target 'MyTarget' do
-  pod 'HTMLKit', '~> 2.1'
+  pod 'HTMLKit', '~> 3.1'
 end
 ```
 
@@ -94,7 +94,7 @@ $ pod install
 Add `HTMLKit` to your `Package.swift` dependecies:
 
 ```swift
-.Package(url: "https://github.com/iabudiab/HTMLKit", majorVersion: 2)
+.Package(url: "https://github.com/iabudiab/HTMLKit", majorVersion: 3)
 ```
 
 Then run:

README.md

@@ -21,13 +21,6 @@ - (instancetype)initWithData:(NSString *)data
 	return [super initWithName:@"#comment" type:HTMLNodeComment data:data];
 }
 
-#pragma mark - Serialization
-
-- (NSString *)outerHTML
-{
-	return [NSString stringWithFormat:@"<!--%@-->", self.data];
-}
-
 #pragma mark - Description
 
 - (NSString *)description

Sources/HTMLComment.m

@@ -141,7 +141,7 @@ - (void)attachNodeIterator:(HTMLNodeIterator *)iterator
 
 - (void)detachNodeIterator:(HTMLNodeIterator *)iterator
 {
-	[_nodeIterators removeObject:iterator];
+	// NOOP
 }
 
 #pragma mark - Ranges
@@ -153,7 +153,7 @@ - (void)attachRange:(HTMLRange *)range
 
 - (void)detachRange:(HTMLRange *)range
 {
-	[_ranges removeObject:range];
+	// NOOP
 }
 
 - (void)didRemoveCharacterDataInNode:(HTMLCharacterData *)node atOffset:(NSUInteger)offset withLength:(NSUInteger)length

Sources/HTMLDocument.m

@@ -144,13 +144,6 @@ - (id)copyWithZone:(NSZone *)zone
 	return copy;
 }
 
-#pragma mark - Serialization
-
-- (NSString *)outerHTML
-{
-	return [NSString stringWithFormat:@"<!DOCTYPE %@>", self.name];
-}
-
 #pragma mark - Description
 
 - (NSString *)description

Sources/HTMLDocumentType.m

@@ -149,42 +149,6 @@ - (id)copyWithZone:(NSZone *)zone
 	return copy;
 }
 
-#pragma mark - Serialization
-
-- (NSString *)outerHTML
-{
-	NSMutableString *result = [NSMutableString string];
-
-	[result appendFormat:@"<%@", self.tagName];
-	[self.attributes enumerateKeysAndObjectsUsingBlock:^(NSString *key, NSString *value, BOOL *stop) {
-		NSMutableString *escaped = [value mutableCopy];
-		[escaped replaceOccurrencesOfString:@"&" withString:@"&amp;" options:0 range:NSMakeRange(0, escaped.length)];
-		[escaped replaceOccurrencesOfString:@"0x00A0" withString:@"&nbsp;" options:0 range:NSMakeRange(0, escaped.length)];
-		[escaped replaceOccurrencesOfString:@"\"" withString:@"&quot;" options:0 range:NSMakeRange(0, escaped.length)];
-
-		[result appendFormat:@" %@=\"%@\"", key, escaped];
-	}];
-
-	[result appendString:@">"];
-
-	if ([self.tagName isEqualToAny:@"area", @"base", @"basefont", @"bgsound", @"br", @"col", @"embed",
-		 @"frame", @"hr", @"img", @"input", @"keygen", @"link", @"menuitem", @"meta", @"param", @"source",
-		 @"track", @"wbr", nil]) {
-		return result;
-	}
-
-	if ([self.tagName isEqualToAny:@"pre", @"textarea", @"listing", nil] && self.firstChild.nodeType == HTMLNodeText) {
-		HTMLText *textNode = (HTMLText *)self.firstChild;
-		if ([textNode.data hasPrefix:@"\n"]) {
-			[result appendString:@"\n"];
-		}
-	}
-	[result appendString:self.innerHTML];
-	[result appendFormat:@"</%@>", self.tagName];
-
-	return result;
-}
-
 #pragma mark - Description
 
 - (NSString *)description