ASCIIString and ASCIICharacter: Added joined()

Author: orchetect

Sources/SwiftASCII/ASCIICharacter.swift

@@ -241,3 +241,23 @@ extension ASCIICharacter {
     }
 
 }
+
+extension Sequence where Element == ASCIICharacter {
+    
+    /// Returns a new string by concatenating the elements of the sequence.
+    public func joined() -> ASCIIString {
+        
+        ASCIIString(self)
+        
+    }
+    
+    /// Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.
+    public func joined(separator: ASCIIString) -> ASCIIString {
+        
+        let joinedStr = map { "\($0.characterValue)" }.joined(separator: separator.stringValue)
+        let joinedData = Data(map { $0.rawData }.joined(separator: separator.rawData))
+        return ASCIIString(guaranteedASCII: joinedStr, rawData: joinedData)
+        
+    }
+    
+}

Sources/SwiftASCII/ASCIIString.swift

@@ -81,6 +81,7 @@ public struct ASCIIString: Hashable {
 
     }
 
+    /// Returns a new `ASCIIString` instance from an `ASCIICharacter`.
     @inlinable
     public init(_ character: ASCIICharacter) {
 
@@ -174,3 +175,40 @@ extension ASCIIString {
     }
 
 }
+
+extension Sequence where Element == ASCIIString {
+    
+    /// Returns a new string by concatenating the elements of the sequence.
+    public func joined() -> ASCIIString {
+        
+        let joinedStr = map { $0.stringValue }.joined()
+        let joinedData = Data(map { $0.rawData }.joined())
+        return ASCIIString(guaranteedASCII: joinedStr, rawData: joinedData)
+        
+    }
+    
+    /// Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.
+    public func joined(separator: ASCIIString) -> ASCIIString {
+        
+        let joinedStr = map { $0.stringValue }.joined(separator: separator.stringValue)
+        let joinedData = Data(map { $0.rawData }.joined(separator: separator.rawData))
+        return ASCIIString(guaranteedASCII: joinedStr, rawData: joinedData)
+        
+    }
+    
+}
+
+// MARK: - Internal Utility
+
+extension ASCIIString {
+    
+    /// Internal use only.
+    /// Used when string and data are already known to be valid ASCII.
+    internal init(guaranteedASCII string: String, rawData: Data) {
+        
+        self.stringValue = string
+        self.rawData = rawData
+        
+    }
+    
+}

Tests/SwiftASCIITests/ASCIICharacter Tests.swift

@@ -166,6 +166,25 @@ class ASCIICharacterTests: XCTestCase {
 
     }
 
+    func testJoined() {
+        
+        XCTAssertEqual(
+            [ASCIICharacter("A"), ASCIICharacter("B")].joined(),
+            ASCIIString("AB")
+        )
+        
+        XCTAssertEqual(
+            [ASCIICharacter("A"), ASCIICharacter("B")].joined(separator: "_"),
+            ASCIIString("A_B")
+        )
+        
+        XCTAssertEqual(
+            [ASCIICharacter("A"), ASCIICharacter("B")].joined(separator: "123"),
+            ASCIIString("A123B")
+        )
+        
+    }
+    
 }
 
 #endif

Tests/SwiftASCIITests/ASCIIString Tests.swift

@@ -119,6 +119,25 @@ class ASCIIStringTests: XCTestCase {
 
     }
 
+    func testJoined() {
+        
+        XCTAssertEqual(
+            [ASCIIString("AB"), ASCIIString("CD")].joined(),
+            ASCIIString("ABCD")
+        )
+        
+        XCTAssertEqual(
+            [ASCIIString("AB"), ASCIIString("CD")].joined(separator: "_"),
+            ASCIIString("AB_CD")
+        )
+        
+        XCTAssertEqual(
+            [ASCIIString("AB"), ASCIIString("CD")].joined(separator: "123"),
+            ASCIIString("AB123CD")
+        )
+        
+    }
+    
 }
 
 #endif