Merge pull request #1 from finestructure/safe-api

Safe api

Author: finestructure

Package.resolved

@@ -13,9 +13,15 @@ let package = Package(
     products: [
         .library(name: "ShellOut", targets: ["ShellOut"])
     ],
+    dependencies: [
+        .package(url: "https://github.com/SwiftPackageIndex/ShellQuote", from: "1.0.2"),
+    ],
     targets: [
         .target(
             name: "ShellOut",
+            dependencies: [
+                .product(name: "ShellQuote", package: "ShellQuote")
+            ],
             path: "Sources"
         ),
         .testTarget(

Package.swift

@@ -0,0 +1,53 @@
+import Foundation
+
+
+public enum Argument {
+    case quoted(QuotedString)
+    case verbatim(String)
+
+    public init(quoted string: String) {
+        self = .quoted(.init(string))
+    }
+
+    public init(verbatim string: String) {
+        self = .verbatim(string)
+    }
+
+    public var string: String {
+        switch self {
+            case let .quoted(value):
+                return value.quoted
+            case let .verbatim(string):
+                return string
+        }
+    }
+}
+
+
+extension Argument: ExpressibleByStringLiteral {
+    public init(stringLiteral value: StringLiteralType) {
+        self = .quoted(.init(value))
+    }
+}
+
+
+extension Argument: CustomStringConvertible {
+    public var description: String { string }
+}
+
+
+extension Argument {
+    public static func url(_ url: URL) -> Self { url.absoluteString.verbatim }
+}
+
+
+extension String {
+    public var quoted: Argument { .init(quoted: self) }
+    public var verbatim: Argument { .init(verbatim: self) }
+}
+
+
+extension Array where Element == String {
+    public var quoted: [Argument] { map(\.quoted) }
+    public var verbatim: [Argument] { map(\.verbatim) }
+}

Sources/Argument.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/QuotedString.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 {
+    public var checked: SafeString {
+        get throws { try .init(self) }
+    }
+    public var unchecked: SafeString { .init(unchecked: self) }
+}