feat: add arguments

Author: QiuZhiFei

Examples/main.swift

@@ -9,12 +9,10 @@ import Commands
 
 fileprivate extension Commands.Result {
   func log() {
-    if let dashc = request.dashc {
-      print(">>> \(request.executableURL) \(dashc) \(request.command)")
-    } else {
-      print(">>> \(request.executableURL) \(request.command)")
-    }
+    print("---------------")
+    print(">>> \(request.absoluteCommand)")
     print("\(self.reponse.output)")
+    print("---------------")
   }
 }
 
@@ -28,8 +26,10 @@ Commands.Ruby.run("require 'base64'; puts Base64.encode64('qiuzhifei')").log()
 Commands.Python.run("import base64; print(base64.b64encode('qiuzhifei').decode('ascii'))").log()
 
 // Custom
-let nodeResult = Commands.Bash.run("which node")
-if nodeResult.isSuccess {
-  let node = Commands.Custom(nodeResult.output, dashc: "-e")
-  node.run("console.log('qiuzhifei')").log()
-}
+let node = Commands.Alias("node", dashc: "-e")
+node.run("console.log('qiuzhifei')").log()
+
+// Task
+Commands.Task.run("bash -c pwd").log()
+Commands.Task.run("python main.py").log()
+Commands.Task.run("ruby -v").log()

Package.swift

@@ -6,12 +6,18 @@ import PackageDescription
 let package = Package(
   name: "swift-commands",
   products: [
-    .library(name: "Commands", targets: ["Commands"]),
+    .library(name: "Commands",
+             targets: ["Commands"]),
   ],
   dependencies: [],
   targets: [
-    .target(name: "Commands", dependencies: []),
-    .target(name: "Examples", dependencies: ["Commands"], path: "Examples/"),
-    .testTarget(name: "CommandsTests", dependencies: ["Commands"])
+    .target(name: "Commands",
+            dependencies: []),
+    .target(name: "Examples",
+            dependencies: ["Commands"],
+            path: "Examples/"),
+    .testTarget(name: "CommandsTests",
+                dependencies: ["Commands"],
+                resources: [.process("Resources")])
   ]
 )

README.md

@@ -20,16 +20,6 @@ Executes command in a subprocess.
 Commands.Bash.system("ls")
 ```
 
-Returns the `Commands.Result` of running cmd in a subprocess.
-```
-let lsResult = Commands.Bash.run("ls")
-switch lsResult {
-case .Success(let output):
-  debugPrint("success output: \(output)")
-case .Failure(let code, let output):
-  debugPrint("failure code: \(code), output: \(output)")
-}
-```
 ### Python
 Executes command in a subprocess.
 ```swift
@@ -41,13 +31,54 @@ Executes command in a subprocess.
 Commands.Ruby.system("require 'base64'; puts Base64.encode64('qiuzhifei')")
 ```
 
-### Custom
-Executes command in a subprocess.
+### Alias
+Create a shortcut name for a command.
 ```swift
 let node = Commands.Custom("/usr/local/bin/node", dashc: "-e")
 node.system("console.log('qiuzhifei')")
 ```
 
+### Custom
+Executes command in a subprocess.
+```swift
+Commands.Task.system("python main.py")
+```
+```swift
+Commands.Task.system("ruby -v")
+```
+
+### Making Commands
+```swift
+Commands.Task.system("python main.py")
+```
+Or
+```swift
+let request: Commands.Request = "node -v"
+Commands.Task.system(request)
+```
+Change environment variables
+```swift
+var request: Commands.Request = "node -v"
+request.environment?.add(PATH: "/usr/local/bin")
+request.environment?["http_proxy"] = "http://127.0.0.1:7890"
+request.environment?["https_proxy"] = "http://127.0.0.1:7890"
+request.environment?["all_proxy"] = "socks5://127.0.0.1:7890"
+
+Commands.Task.system(request)
+```
+
+### Result Handler
+Returns the `Commands.Result` of running cmd in a subprocess.
+```
+let lsResult = Commands.Bash.run("ls")
+switch lsResult {
+case .Success(let request, let response):
+  debugPrint("command: \(request.absoluteCommand), success output: \(response.output)")
+case .Failure(let request, let response):
+  debugPrint("command: \(request.absoluteCommand), failure output: \(response.errorOutput)")
+}
+```
+
 ## Adding Commands as a Dependency
 To use the `Commands` library in a SwiftPM project, 
 add the following line to the dependencies in your `Package.swift` file:

Scripts/deploy.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# 1. Bump the version in https://github.com/QiuZhiFei/swift-commands/blob/dev/Commands.podspec#L3.
+# 2. Bump the git tag and push tag to github, create a release in https://github.com/QiuZhiFei/swift-commands/tags.
+# 3. Publish a cocoapods podspec, Run `pod trunk push Commands.podspec --allow-warnings --verbose`.

Sources/Commands/Commands.swift

@@ -6,15 +6,3 @@
 //
 
 public enum Commands { }
-
-public extension Commands {
-  static let Bash = BashENV()
-  
-  static let Ruby = RubyENV()
-  
-  static let Python = PythonENV()
-  
-  static func Custom(_ executableURL: String, dashc: String? = nil) -> CustomENV {
-    return CustomENV(executableURL, dashc: dashc)
-  }
-}

Sources/Commands/CommandsAlias.swift

@@ -0,0 +1,60 @@
+//
+//  CommandsAlias.swift
+//
+//
+//  Created by zhifei qiu on 2021/8/24.
+//
+
+import Foundation
+
+extension Commands {
+  public struct Alias {
+    public let executableURL: String
+    public let dashc: Commands.Arguments?
+    
+    public init(_ executableURL: String, dashc: Commands.Arguments? = nil) {
+      self.executableURL = executableURL
+      self.dashc = dashc
+    }
+  }
+}
+
+public extension Commands.Alias {
+  @discardableResult
+  func run(_ arguments: Commands.Arguments? = nil,
+           environment: Commands.ENV? = Commands.ENV()) -> Commands.Result {
+    let request = prepare(arguments, environment: environment)
+    return Commands.Task.run(request)
+  }
+  
+  func system(_ arguments: Commands.Arguments? = nil,
+              environment: Commands.ENV? = Commands.ENV()) {
+    let request = prepare(arguments, environment: environment)
+    Commands.Task.system(request)
+  }
+  
+  func system(_ arguments: Commands.Arguments? = nil,
+              environment: Commands.ENV? = Commands.ENV(),
+              output: ((String) -> Void)?,
+              errorOutput: ((String) -> Void)?) {
+    let request = prepare(arguments, environment: environment)
+    Commands.Task.system(request, output: output, errorOutput: errorOutput)
+  }
+}
+
+private extension Commands.Alias {
+  func prepare(_ arguments: Commands.Arguments?,
+               environment: Commands.ENV?) -> Commands.Request {
+    return Commands.Request(environment,
+                            executableURL: executableURL,
+                            dashc: dashc,
+                            arguments: arguments)
+  }
+}
+
+public extension Commands {
+  static let Bash = Commands.Alias("bash", dashc: "-c")
+  static let Ruby = Commands.Alias("ruby", dashc: "-e")
+  static let Python = Commands.Alias("python", dashc: "-c")
+  static let Node = Commands.Alias("node", dashc: "-e")
+}

Sources/Commands/CommandsArguments.swift

@@ -0,0 +1,64 @@
+//
+//  CommandsArguments.swift
+//
+//
+//  Created by zhifei qiu on 2021/8/6.
+//
+
+public extension Commands {
+  enum Arguments {
+    case value(String)
+    case elements([String])
+    
+    init(_ value: String) {
+      self = Arguments.value(value)
+    }
+    
+    init(_ elements: [String]) {
+      self = Arguments.elements(elements)
+    }
+  }
+}
+
+extension Commands.Arguments {
+  var raw: [String] {
+    switch self {
+    case .value(let value):
+      return [value]
+    case .elements(let elements):
+      return elements
+    }
+  }
+}
+
+extension Commands.Arguments: Swift.ExpressibleByStringLiteral {
+  public init(stringLiteral value: StringLiteralType) {
+    self.init(value)
+  }
+  
+  public init(extendedGraphemeClusterLiteral value: String) {
+    self.init(value)
+  }
+  
+  public init(unicodeScalarLiteral value: String) {
+    self.init(value)
+  }
+}
+
+extension Commands.Arguments: Swift.ExpressibleByStringInterpolation {
+  public init(stringInterpolation: DefaultStringInterpolation) {
+    self.init(stringInterpolation.description)
+  }
+}
+
+extension Commands.Arguments: Swift.ExpressibleByArrayLiteral {
+  public init(arrayLiteral elements: String...) {
+    self.init(elements)
+  }
+}
+
+extension Commands.Arguments: Equatable {
+  public static func == (lhs: Self, rhs: Self) -> Bool {
+    return lhs.raw == rhs.raw
+  }
+}

Sources/Commands/CommandsENV.swift

@@ -2,40 +2,47 @@
 //  CommandsENV.swift
 //  
 //
-//  Created by zhifei qiu on 2021/8/2.
+//  Created by zhifei qiu on 2021/8/25.
 //
 
 import Foundation
 
-public protocol CommandsENV {
-  var executableURL: String { get }
-  var dashc: String? { get }
-  
-  func run(_ command: String, environment: [String: String]?) -> Commands.Result
-  func system(_ command: String, environment: [String: String]?)
-  func system(_ command: String, environment: [String: String]?, output: ((String) -> Void)?, errorOutput: ((String) -> Void)?)
+extension Commands {
+  public struct ENV {
+    public private(set) var data: [String: String] = [:]
+    
+    public init(_ data: [String: String]? = ProcessInfo.processInfo.environment) {
+      self.data = data ?? [:]
+    }
+  }
 }
 
-public extension CommandsENV {
-  @discardableResult
-  func run(_ command: String, environment: [String: String]? = nil) -> Commands.Result {
-    let request = prepare(command, environment: environment)
-    return Commands.Task.run(request)
+public extension Commands.ENV {
+  mutating func add(PATH: String) {
+    data["PATH"] = data["PATH"] == nil ? PATH : "\(PATH):\(data["PATH"]!)"
   }
-  
-  func system(_ command: String, environment: [String: String]? = nil) {
-    let request = prepare(command, environment: environment)
-    Commands.Task.system(request)
+}
+
+public extension Commands.ENV {
+  subscript(_ key: String) -> String? {
+    set(newValue) {
+      data[key] = newValue
+    }
+    get {
+      return data[key]
+    }
   }
-  
-  func system(_ command: String, environment: [String: String]? = nil, output: ((String) -> Void)?, errorOutput: ((String) -> Void)?) {
-    let request = prepare(command, environment: environment)
-    Commands.Task.system(request, output: output, errorOutput: errorOutput)
+}
+
+extension Commands.ENV: Swift.ExpressibleByDictionaryLiteral {
+  public init(dictionaryLiteral elements: (String, String)...) {
+    let dictionary = elements.reduce(into: [String: String](), { $0[$1.0] = $1.1})
+    self.init(dictionary)
   }
 }
 
-private extension CommandsENV {
-  func prepare(_ command: String, environment: [String: String]? = nil) -> Commands.Request {
-    return Commands.Request(executableURL, dashc: dashc, command: command, environment: environment)
+extension Commands.ENV: Equatable {
+  public static func == (lhs: Self, rhs: Self) -> Bool {
+    lhs.data == rhs.data
   }
 }