Generalize ASCII parsing to accept Collection<UInt8>

coenttb · coenttb · commit cf3244e68b25 · 2025-11-25T15:48:41.000+01:00
- Update init(ascii:) to accept generic Collection&lt;UInt8&gt; instead of [UInt8]
- Bump swift-incits-4-1986 dependency to 0.4.0
- Apply swift-format code style
- Conform to UInt8.ASCII.RawRepresentable protocol
diff --git a/.gitignore b/.gitignore
@@ -23,3 +23,7 @@ Thumbs.db
 !CODE_OF_CONDUCT.md
 !SECURITY.md
 !**/*.docc/**/*.md
+
+
+# SwiftLint Remote Config Cache
+.swiftlint/RemoteConfigCache
diff --git a/Package.swift b/Package.swift
@@ -18,21 +18,21 @@ let package = Package(
         .macOS(.v15),
         .iOS(.v18),
         .tvOS(.v18),
-        .watchOS(.v11)
+        .watchOS(.v11),
     ],
     products: [
-        .library(name: .rfc1035, targets: [.rfc1035]),
+        .library(name: .rfc1035, targets: [.rfc1035])
     ],
     dependencies: [
         .package(url: "https://github.com/swift-standards/swift-standards.git", from: "0.1.0"),
-        .package(url: "https://github.com/swift-standards/swift-incits-4-1986.git", from: "0.3.0"),
+        .package(url: "https://github.com/swift-standards/swift-incits-4-1986.git", from: "0.4.0"),
     ],
     targets: [
         .target(
             name: .rfc1035,
             dependencies: [
                 .standards,
-                .incits41986
+                .incits41986,
             ]
         ),
         .testTarget(
@@ -52,9 +52,10 @@ extension String {
 
 for target in package.targets where ![.system, .binary, .plugin].contains(target.type) {
     let existing = target.swiftSettings ?? []
-    target.swiftSettings = existing + [
-        .enableUpcomingFeature("ExistentialAny"),
-        .enableUpcomingFeature("InternalImportsByDefault"),
-        .enableUpcomingFeature("MemberImportVisibility")
-    ]
+    target.swiftSettings =
+        existing + [
+            .enableUpcomingFeature("ExistentialAny"),
+            .enableUpcomingFeature("InternalImportsByDefault"),
+            .enableUpcomingFeature("MemberImportVisibility"),
+        ]
 }
diff --git a/Sources/RFC 1035/RFC_1035.Domain.Error.swift b/Sources/RFC 1035/RFC_1035.Domain.Error.swift
@@ -16,6 +16,7 @@
 // Domain-level validation errors
 
 // MARK: - Errors
+
 extension RFC_1035.Domain {
     /// Errors that can occur during domain validation
     ///
diff --git a/Sources/RFC 1035/RFC_1035.Domain.Label.Error.swift b/Sources/RFC 1035/RFC_1035.Domain.Label.Error.swift
@@ -53,7 +53,8 @@ extension RFC_1035.Domain.Label.Error: CustomStringConvertible {
         case .tooLong(let length, let label):
             return "Domain label '\(label)' is too long (\(length) bytes, maximum 63)"
         case .invalidCharacters(let label, let byte, let reason):
-            return "Domain label '\(label)' has invalid byte 0x\(String(byte, radix: 16)): \(reason)"
+            return
+                "Domain label '\(label)' has invalid byte 0x\(String(byte, radix: 16)): \(reason)"
         case .startsWithHyphen(let label):
             return "Domain label '\(label)' cannot start with a hyphen"
         case .endsWithHyphen(let label):
diff --git a/Sources/RFC 1035/RFC_1035.Domain.Label.swift b/Sources/RFC 1035/RFC_1035.Domain.Label.swift
@@ -48,7 +48,7 @@ extension RFC_1035.Domain {
         ///   - unchecked: Void parameter to prevent accidental use
         ///   - rawValue: The raw label value (unchecked)
         init(
-            __unchecked: Void,
+            __unchecked _: Void,
             rawValue: String
         ) {
             self.rawValue = rawValue
@@ -113,49 +113,60 @@ extension RFC_1035.Domain.Label: UInt8.ASCII.Serializing {
     ///
     /// - Parameter bytes: The ASCII byte representation of the label
     /// - Throws: `RFC_1035.Domain.Label.Error` if the bytes are malformed
-    public init(ascii bytes: [UInt8]) throws(Error) {
-        // Empty check
-        guard !bytes.isEmpty else {
+    public init<Bytes: Collection>(ascii bytes: Bytes) throws(Error)
+    where Bytes.Element == UInt8 {
+        guard let firstByte = bytes.first else {
             throw Error.empty
         }
 
-        // Length check (RFC 1035: max 63 octets)
-        guard bytes.count <= RFC_1035.Domain.Limits.maxLabelLength else {
-            let string = String(decoding: bytes, as: UTF8.self)
-            throw Error.tooLong(bytes.count, label: string)
+        var count = 0
+        var lastByte = firstByte
+
+        for byte in bytes {
+            count += 1
+            lastByte = byte
+
+            let validInterior = byte.ascii.isLetter || byte.ascii.isDigit || byte == .ascii.hyphen
+            guard validInterior else {
+                let string = String(decoding: bytes, as: UTF8.self)
+                throw Error.invalidCharacters(
+                    string,
+                    byte: byte,
+                    reason: "Only letters, digits, and hyphens allowed"
+                )
+            }
         }
 
-        let firstByte = bytes.first!
-        let lastByte = bytes.last!
+        guard count <= RFC_1035.Domain.Limits.maxLabelLength else {
+            let string = String(decoding: bytes, as: UTF8.self)
+            throw Error.tooLong(count, label: string)
+        }
 
-        // Must start with a letter (RFC 1035)
         guard firstByte.ascii.isLetter else {
             let string = String(decoding: bytes, as: UTF8.self)
             if firstByte == .ascii.hyphen {
                 throw Error.startsWithHyphen(string)
             } else if firstByte.ascii.isDigit {
                 throw Error.startsWithDigit(string)
             } else {
-                throw Error.invalidCharacters(string, byte: firstByte, reason: "Must start with a letter")
+                throw Error.invalidCharacters(
+                    string,
+                    byte: firstByte,
+                    reason: "Must start with a letter"
+                )
             }
         }
 
-        // Must end with a letter or digit (RFC 1035)
         guard lastByte.ascii.isLetter || lastByte.ascii.isDigit else {
             let string = String(decoding: bytes, as: UTF8.self)
             if lastByte == .ascii.hyphen {
                 throw Error.endsWithHyphen(string)
             } else {
-                throw Error.invalidCharacters(string, byte: lastByte, reason: "Must end with a letter or digit")
-            }
-        }
-
-        // Interior characters: letters, digits, and hyphens only
-        for byte in bytes {
-            let valid = byte.ascii.isLetter || byte.ascii.isDigit || byte == .ascii.hyphen
-            guard valid else {
-                let string = String(decoding: bytes, as: UTF8.self)
-                throw Error.invalidCharacters(string, byte: byte, reason: "Only letters, digits, and hyphens allowed")
+                throw Error.invalidCharacters(
+                    string,
+                    byte: lastByte,
+                    reason: "Must end with a letter or digit"
+                )
             }
         }
 
@@ -198,5 +209,5 @@ extension [UInt8] {
 
 // MARK: - Protocol Conformances
 
-extension RFC_1035.Domain.Label: RawRepresentable {}
+extension RFC_1035.Domain.Label: UInt8.ASCII.RawRepresentable {}
 extension RFC_1035.Domain.Label: CustomStringConvertible {}
diff --git a/Sources/RFC 1035/RFC_1035.Domain.swift b/Sources/RFC 1035/RFC_1035.Domain.swift
@@ -51,7 +51,7 @@ extension RFC_1035 {
         ///   - rawValue: The raw domain name (unchecked)
         ///   - labels: Pre-validated labels
         init(
-            __unchecked: Void,
+            __unchecked _: Void,
             rawValue: String,
             labels: [RFC_1035.Domain.Label]
         ) {
@@ -117,7 +117,7 @@ extension RFC_1035.Domain: UInt8.ASCII.Serializing {
     ///
     /// - Parameter bytes: The ASCII byte representation of the domain
     /// - Throws: `RFC_1035.Domain.Error` if the bytes are malformed
-    public init(ascii bytes: [UInt8]) throws(Error) {
+    public init<Bytes: Collection>(ascii bytes: Bytes) throws(Error) where Bytes.Element == UInt8 {
         // Empty check
         guard !bytes.isEmpty else {
             throw Error.empty
@@ -131,26 +131,29 @@ extension RFC_1035.Domain: UInt8.ASCII.Serializing {
         // Split on dots (0x2E) and parse each label
         var labels: [RFC_1035.Domain.Label] = []
         var currentStart = bytes.startIndex
+        var currentIndex = bytes.startIndex
 
-        for (index, byte) in bytes.enumerated() {
-            if byte == .ascii.period {
-                let labelBytes = Array(bytes[currentStart..<index])
-                if !labelBytes.isEmpty {
+        while currentIndex < bytes.endIndex {
+            if bytes[currentIndex] == .ascii.period {
+                // Found a dot - extract label
+                if currentStart < currentIndex {
+                    let labelBytes = bytes[currentStart..<currentIndex]
                     do {
-                        labels.append(try RFC_1035.Domain.Label(ascii: labelBytes))
+                        try labels.append(RFC_1035.Domain.Label(ascii: labelBytes))
                     } catch {
                         throw Error.invalidLabel(error)
                     }
                 }
-                currentStart = bytes.index(after: index)
+                currentStart = bytes.index(after: currentIndex)
             }
+            currentIndex = bytes.index(after: currentIndex)
         }
 
         // Handle final label (after last dot or entire string if no dots)
         if currentStart < bytes.endIndex {
-            let labelBytes = Array(bytes[currentStart...])
+            let labelBytes = bytes[currentStart...]
             do {
-                labels.append(try RFC_1035.Domain.Label(ascii: labelBytes))
+                try labels.append(RFC_1035.Domain.Label(ascii: labelBytes))
             } catch {
                 throw Error.invalidLabel(error)
             }
@@ -200,13 +203,13 @@ extension [UInt8] {
     ///
     /// - Parameter domain: The domain name to serialize
     public init(_ domain: RFC_1035.Domain) {
-        self = Array(domain.rawValue.utf8)
+        self = Self(domain.rawValue.utf8)
     }
 }
 
 // MARK: - Protocol Conformances
 
-extension RFC_1035.Domain: RawRepresentable {}
+extension RFC_1035.Domain: UInt8.ASCII.RawRepresentable {}
 extension RFC_1035.Domain: CustomStringConvertible {}
 
 // MARK: - Domain Properties
@@ -242,7 +245,7 @@ extension RFC_1035.Domain {
         var newLabels: [Label] = []
         for component in components {
             do {
-                newLabels.append(try Label(component))
+                try newLabels.append(Label(component))
             } catch {
                 throw Error.invalidLabel(error)
             }
@@ -263,7 +266,7 @@ extension RFC_1035.Domain {
 
     /// Creates a subdomain by prepending new labels
     public func addingSubdomain(_ components: String...) throws(Error) -> RFC_1035.Domain {
-        try self.addingSubdomain(components)
+        try addingSubdomain(components)
     }
 
     /// Returns the parent domain by removing the leftmost label
@@ -311,7 +314,7 @@ extension RFC_1035.Domain {
         var validatedLabels: [Label] = []
         for labelString in labelStrings {
             do {
-                validatedLabels.append(try Label(labelString))
+                try validatedLabels.append(Label(labelString))
             } catch {
                 throw Error.invalidLabel(error)
             }
diff --git a/Tests/RFC 1035 Tests/RFC 1035 Tests.swift b/Tests/RFC 1035 Tests/RFC 1035 Tests.swift
@@ -1,5 +1,5 @@
 //
-//  File.swift
+//  RFC 1035 Tests.swift
 //  swift-web
 //
 //  Created by Coen ten Thije Boonkkamp on 28/12/2024.
@@ -20,15 +20,15 @@ struct `RFC 1035 Domain Tests` {
     @Test
     func `Successfully creates domain from Substring`() throws {
         let fullString = "www.example.com"
-        let substring = fullString.dropFirst(4) // "example.com"
+        let substring = fullString.dropFirst(4)  // "example.com"
         let domain = try RFC_1035.Domain(substring)
         #expect(domain.name == "example.com")
     }
 
     @Test
     func `Successfully creates label from Substring`() throws {
         let labelStr = "test-label"
-        let substring = labelStr.dropLast(6) // "test"
+        let substring = labelStr.dropLast(6)  // "test"
         let label = try RFC_1035.Domain.Label(substring)
         #expect(label == "test")
     }
diff --git a/Tests/RFC 1035 Tests/ReadmeVerificationTests.swift b/Tests/RFC 1035 Tests/ReadmeVerificationTests.swift
@@ -5,13 +5,12 @@
 //  Verifies that README code examples actually work
 //
 
+import Foundation
 import RFC_1035
 import Testing
-import Foundation
 
 @Suite
 struct `README Verification` {
-
     @Test
     func `README Line 51-52: Create from string`() throws {
         let domain = try RFC_1035.Domain("example.com")
