Fixup formatting for SwiftLint rules

Author: Raymond McCrae

.swiftlint.yml

@@ -10,10 +10,13 @@ opt_in_rules:
 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
+file_length:
+  warning: 600
+  error: 1000
 line_length: 120
 function_body_length:
-  - 20
-  - 40
+  - 30
+  - 50
 nesting:
   type_level:
     warning: 3

Sources/HTMLSAXParser/EscapeSpecialCharacters.swift

@@ -40,14 +40,25 @@ 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? {
+    // swiftlint:disable:next function_parameter_count
+    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)
+            let result = htmlEncodeEntities(outputBuffer,
+                                            outputLengthBytes,
+                                            inputBytes,
+                                            inputLengthBytes,
+                                            quoteCharacter.characterCode)
 
             if result == 0 { // zero represents success
                 // Have we consumed the length of the input buffer
@@ -87,7 +98,13 @@ public extension Data {
             inputLengthBytes.pointee = CInt(inputLength)
             outputLengthBytes.pointee = CInt(outputLength)
 
-            let outputData = encodeHTMLEntitiesBytes(&outputLength, outputLengthBytes, inputLengthBytes, quoteCharacter, inputLength, &loop, bufferGrowthFactor)
+            let outputData = encodeHTMLEntitiesBytes(&outputLength,
+                                                     outputLengthBytes,
+                                                     inputLengthBytes,
+                                                     quoteCharacter,
+                                                     inputLength,
+                                                     &loop,
+                                                     bufferGrowthFactor)
 
             if let outputData = outputData {
                 return outputData

Sources/HTMLSAXParser/HTMLSAXParser+libxml2.swift

@@ -46,7 +46,12 @@ internal extension HTMLSAXParser {
             let handlerContext = HandlerContext(handler: handler)
             let handlerContextPtr = Unmanaged<HandlerContext>.passUnretained(handlerContext).toOpaque()
             var libxmlHandler = HTMLSAXParser.libxmlSAXHandler
-            guard let parserContext = htmlCreatePushParserCtxt(&libxmlHandler, handlerContextPtr, dataBytes, Int32(dataLength), nil, charEncoding) else {
+            guard let parserContext = htmlCreatePushParserCtxt(&libxmlHandler,
+                                                               handlerContextPtr,
+                                                               dataBytes,
+                                                               Int32(dataLength),
+                                                               nil,
+                                                               charEncoding) else {
                 throw Error.unknown
             }
             defer {

Sources/HTMLSAXParser/HTMLSAXParser.swift

@@ -57,7 +57,12 @@ open class HTMLSAXParser {
         public static let ignoreEncodingHint = ParseOptions(rawValue: Int(HTML_PARSE_IGNORE_ENC.rawValue))
 
         /// Default set of parse options.
-        public static let `default`: ParseOptions = [.recover, .noBlanks, .noNetwork, .noImpliedElements, .compactTextNodes]
+        public static let `default`: ParseOptions = [
+            .recover,
+            .noBlanks,
+            .noNetwork,
+            .noImpliedElements,
+            .compactTextNodes]
     }
 
     public struct Location {

Tests/HTMLSAXParser/HTMLParserTests.swift

@@ -41,31 +41,31 @@ class HTMLParserTests: XCTestCase {
         do {
             let parser = HTMLSAXParser()
             try parser.parse(data: data, handler: { (_, _) in
-                XCTFail()
+                XCTFail("Empty document should not generate any events")
             })
-            XCTFail()
+            XCTFail("Empty document should throw an error")
         } catch HTMLSAXParser.Error.emptyDocument {
             threwError = true
         } catch {
-            XCTFail()
+            XCTFail("Wrong type of error thrown")
         }
 
         XCTAssertTrue(threwError)
     }
 
-    func test_parse_strint_empty() {
+    func test_parse_string_empty() {
         let string = ""
         var threwError = false
         do {
             let parser = HTMLSAXParser()
             try parser.parse(string: string, handler: { (_, _) in
-                XCTFail()
+                XCTFail("Empty document should not generate any events")
             })
-            XCTFail()
+            XCTFail("Empty document should throw an error")
         } catch HTMLSAXParser.Error.emptyDocument {
             threwError = true
         } catch {
-            XCTFail()
+            XCTFail("Wrong type of error thrown")
         }
 
         XCTAssertTrue(threwError)
@@ -92,7 +92,7 @@ class HTMLParserTests: XCTestCase {
                 }
             }
         } catch {
-            XCTFail()
+            XCTFail("Unexpected error thrown")
         }
 
         XCTAssertTrue(calledStartElement)
@@ -134,10 +134,12 @@ class HTMLParserTests: XCTestCase {
     func testImageExtraction() {
         do {
             let imageSources = try self.imageSources(from: HTMLParserTests.testHTMLArticleWithImages)
+            // swiftlint:disable line_length
             XCTAssertEqual(imageSources, [
                 "https://upload.wikimedia.org/wikipedia/commons/thumb/9/93/01-COBRA-SUCURI-3M-WAGNER-MEIER_MG_2458.JPG/640px-01-COBRA-SUCURI-3M-WAGNER-MEIER_MG_2458.JPG",
                 "https://upload.wikimedia.org/wikipedia/commons/thumb/9/98/Brachypelma_smithi_2009_G03.jpg/640px-Brachypelma_smithi_2009_G03.jpg",
                 "https://upload.wikimedia.org/wikipedia/commons/d/d7/Panamanian_night_monkey.jpg"])
+            // swiftlint:enable line_length
         } catch {
             XCTFail("Error thrown while parsing")
         }