Add SwiftLint to the project

Author: Raymond McCrae

.swiftlint.yml

@@ -0,0 +1,39 @@
+included:
+  - Sources
+  - Tests
+excluded:
+
+opt_in_rules:
+  - closure_spacing  # closure should have single space inside each brace
+  - empty_count      # prefer isEmpty over comparing to 0
+  - number_separator # underscore should be used as thousand separator in large decimal numbers
+disabled_rules:
+  - todo             # todo and fixme should be avoided. Use custom script for this  
+  - vertical_parameter_alignment # parameter alignment in functions. Xcode use another alignment logic
+line_length: 120
+function_body_length:
+  - 20
+  - 40
+nesting:
+  type_level:
+    warning: 3
+  statement_level:
+    warning: 10
+type_name:
+  excluded: K
+variable_name:
+  excluded:
+    - id
+custom_rules:
+  open_bracket_blank_line:
+    included: ".*.swift"
+    name: "blank line after open bracket"
+    regex: "{\n[[[:blank:]]\n]*\n"
+    message: "Blank line after open bracket should be removed"
+    severity: warning
+  closed_brackets_blank_line:
+    included: ".*.swift"
+    name: "blank lines between closed brackets"
+    regex: "}\n[[[:blank:]]\n]*\n}"
+    message: "Blank lines between closed brackets should be removed"
+    severity: warning

HTMLSAXParser.xcodeproj/project.pbxproj

@@ -216,8 +216,8 @@
 			isa = PBXGroup;
 			children = (
 				4D9286B81F3516C3001A16FC /* testdata */,
-				4DDF8C2F1F211E2E008C2135 /* HTMLParserTests.swift */,
 				4DDF8C311F211E2E008C2135 /* Info.plist */,
+				4DDF8C2F1F211E2E008C2135 /* HTMLParserTests.swift */,
 				4D161F401F228123002573EF /* HTMLEncodeEntitiesTests.swift */,
 			);
 			name = Tests;
@@ -316,6 +316,7 @@
 			isa = PBXNativeTarget;
 			buildConfigurationList = 4DDF8C351F211E2E008C2135 /* Build configuration list for PBXNativeTarget "HTMLSAXParser iOS" */;
 			buildPhases = (
+				4D63D6581F9CB6F6009EC3CB /* SwiftLint */,
 				4DDF8C1C1F211E2D008C2135 /* Sources */,
 				4DDF8C1D1F211E2D008C2135 /* Frameworks */,
 				4DDF8C1E1F211E2D008C2135 /* Headers */,
@@ -442,6 +443,23 @@
 		};
 /* End PBXResourcesBuildPhase section */
 
+/* Begin PBXShellScriptBuildPhase section */
+		4D63D6581F9CB6F6009EC3CB /* SwiftLint */ = {
+			isa = PBXShellScriptBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputPaths = (
+			);
+			name = SwiftLint;
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "if which swiftlint >/dev/null; then\n    swiftlint\nelse\n\techo \"warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint\"\nfi";
+		};
+/* End PBXShellScriptBuildPhase section */
+
 /* Begin PBXSourcesBuildPhase section */
 		4D3D6DA41F3EDEDA00EE40CB /* Sources */ = {
 			isa = PBXSourcesBuildPhase;

Sources/HTMLSAXParser/EscapeSpecialCharacters.swift

@@ -25,7 +25,7 @@ public enum HTMLQuoteCharacter: Character {
     case none = "\0"
     case singleQuote = "'"
     case doubleQuote = "\""
-    
+
     var characterCode: CInt {
         switch self {
         case .none:
@@ -39,7 +39,36 @@ public enum HTMLQuoteCharacter: Character {
 }
 
 public extension Data {
-    
+
+    fileprivate func encodeHTMLEntitiesBytes(_ outputLength: inout Int, _ outputLengthBytes: UnsafeMutablePointer<CInt>, _ inputLengthBytes: UnsafeMutablePointer<CInt>, _ quoteCharacter: HTMLQuoteCharacter, _ inputLength: Int, _ loop: inout Bool, _ bufferGrowthFactor: Double) -> Data? {
+        return self.withUnsafeBytes { (inputBytes: UnsafePointer<UInt8>) -> Data? in
+            let outputBufferCapacity = outputLength
+            let outputBuffer = UnsafeMutablePointer<UInt8>.allocate(capacity: outputBufferCapacity)
+            defer {
+                outputBuffer.deallocate(capacity: Int(outputBufferCapacity))
+            }
+            let result = htmlEncodeEntities(outputBuffer, outputLengthBytes, inputBytes, inputLengthBytes, quoteCharacter.characterCode)
+
+            if result == 0 { // zero represents success
+                // Have we consumed the length of the input buffer
+                let consumed = inputLengthBytes.pointee
+                if consumed == inputLength {
+                    loop = false
+                    return Data(bytes: outputBuffer, count: Int(outputLengthBytes.pointee))
+                } else {
+                    // if we have not consumed the full input buffer.
+                    // estimate a new output buffer length
+                    let ratio = Double(consumed) / Double(inputLength)
+                    outputLength = Int( (2.0 - ratio) * Double(outputLength) * bufferGrowthFactor )
+                }
+            } else {
+                loop = false
+            }
+
+            return nil
+        }
+    }
+
     public func encodeHTMLEntities(quoteCharacter: HTMLQuoteCharacter = .doubleQuote) -> Data? {
         let bufferGrowthFactor = 1.4
         let inputLength = self.count
@@ -51,48 +80,21 @@ public extension Data {
             inputLengthBytes.deallocate(capacity: 1)
             outputLengthBytes.deallocate(capacity: 1)
         }
-        
+
         var loop = true
 
         repeat {
             inputLengthBytes.pointee = CInt(inputLength)
             outputLengthBytes.pointee = CInt(outputLength)
 
-            let outputData = self.withUnsafeBytes { (inputBytes: UnsafePointer<UInt8>) -> Data? in
-                let outputBufferCapacity = outputLength
-                let outputBuffer = UnsafeMutablePointer<UInt8>.allocate(capacity: outputBufferCapacity)
-                defer {
-                    outputBuffer.deallocate(capacity: Int(outputBufferCapacity))
-                }
-                let result = htmlEncodeEntities(outputBuffer, outputLengthBytes, inputBytes, inputLengthBytes, quoteCharacter.characterCode)
-
-                if result == 0 { // zero represents success
-                    // Have we consumed the length of the input buffer
-                    let consumed = inputLengthBytes.pointee
-                    if consumed == inputLength {
-                        loop = false
-                        return Data(bytes: outputBuffer, count: Int(outputLengthBytes.pointee))
-                    }
-                    else {
-                        // if we have not consumed the full input buffer.
-                        // estimate a new output buffer length
-                        let ratio = Double(consumed) / Double(inputLength)
-                        outputLength = Int( (2.0 - ratio) * Double(outputLength) * bufferGrowthFactor )
-                    }
-                }
-                else {
-                    loop = false
-                }
-
-                return nil
-            }
+            let outputData = encodeHTMLEntitiesBytes(&outputLength, outputLengthBytes, inputLengthBytes, quoteCharacter, inputLength, &loop, bufferGrowthFactor)
 
             if let outputData = outputData {
                 return outputData
             }
 
         } while loop
-        
+
         return nil
     }
 }