Merge branch 'make-strings-type-safe' into safe-api

Author: finestructure

Sources/Argument.swift

@@ -0,0 +1,48 @@
+public enum Argument {
+    case safe(SafeString)
+    case quoted(QuotedString)
+    case verbatim(String)
+
+    init(safe string: String) throws {
+        self = try .safe(.init(string))
+    }
+
+    init(_ string: SafeString) {
+        self = .safe(string)
+    }
+
+    init(quoted string: String) {
+        self = .quoted(.init(string))
+    }
+
+    init(verbatim string: String) {
+        self = .verbatim(string)
+    }
+
+    var string: String {
+        switch self {
+            case let .safe(value):
+                return value.value
+            case let .quoted(value):
+                return value.quoted
+            case let .verbatim(string):
+                return string
+        }
+    }
+}
+
+
+extension String {
+    var quoted: Argument { .init(quoted: self) }
+    var verbatim: Argument { .init(verbatim: self) }
+}
+
+
+extension Array<String> {
+    var quoted: [Argument] { map(\.quoted) }
+
+    @available(*, deprecated)
+    func safe() throws -> [Argument] { try map(Argument.init(safe:)) }
+
+    var verbatim: [Argument] { map(\.verbatim) }
+}

Sources/QuotedString.swift

@@ -0,0 +1,17 @@
+import ShellQuote
+
+
+public struct QuotedString {
+    public var unquoted: String
+    public var quoted: String
+
+    public init(_ value: String) {
+        self.unquoted = value
+        self.quoted = ShellQuote.quote(value)
+    }
+}
+
+
+extension QuotedString: CustomStringConvertible {
+    public var description: String { quoted }
+}

Sources/SafeString.swift

@@ -0,0 +1,29 @@
+import ShellQuote
+
+
+public struct SafeString {
+    public var value: String
+
+    public init(_ value: String) throws {
+        guard !ShellQuote.hasUnsafeContent(value) else {
+            throw ShellOutCommand.Error(message: "Command must not contain characters that require quoting, was: \(value)")
+        }
+        self.value = value
+    }
+
+    public init(unchecked value: String) {
+        self.value = value
+    }
+}
+
+extension SafeString: CustomStringConvertible {
+    public var description: String { value }
+}
+
+
+extension String {
+    var safe: SafeString {
+        get throws { try .init(self) }
+    }
+    var unchecked: SafeString { .init(unchecked: self) }
+}