feat: init

Author: QiuZhiFei

.github/workflows/swift.yml

@@ -0,0 +1,19 @@
+name: Swift
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: macos-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build
+      run: swift build -v
+    - name: Run tests
+      run: swift test -v

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+DerivedData/
+.swiftpm

Commands.podspec

@@ -0,0 +1,14 @@
+Pod::Spec.new do |s|
+  s.name        = "Commands"
+  s.version     = "0.1.0"
+  s.summary     = "Swift utilities for running commands."
+  s.homepage    = "https://github.com/qiuzhifei/swift-commands"
+  s.license     = { :type => "MIT" }
+  s.authors     = { "lingoer" => "qiuzhifei521@gmail.com", "tangplin" => "qiuzhifei521@gmail.com" }
+
+  s.requires_arc = true
+  s.swift_versions = ['5.1', '5.2', '5.3']
+  s.osx.deployment_target = "10.9"
+  s.source   = { :git => "https://github.com/qiuzhifei/swift-commands.git", :tag => s.version }
+  s.source_files = "Sources/*/*.swift"
+end

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2021 qiuzhifei <qiuzhifei521@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Package.swift

@@ -0,0 +1,16 @@
+// swift-tools-version:5.3
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+  name: "swift-commands",
+  products: [
+    .library(name: "Commands", targets: ["Commands"]),
+  ],
+  dependencies: [],
+  targets: [
+    .target(name: "Commands", dependencies: []),
+    .testTarget(name: "CommandsTests", dependencies: ["Commands"])
+  ]
+)

README.md

@@ -0,0 +1,60 @@
+# Swift Commands
+![SPM](https://img.shields.io/badge/SPM-compatible-brightgreen.svg)
+![CocoaPods](https://img.shields.io/cocoapods/v/Commands.svg)
+[![CI Status](https://img.shields.io/github/workflow/status/qiuzhifei/swift-commands/Swift)](https://github.com/qiuzhifei/swift-commands/actions)
+[![License](https://img.shields.io/github/license/qiuzhifei/swift-commands)](https://github.com/qiuzhifei/swift-commands/blob/main/LICENSE)
+![Platform](https://img.shields.io/badge/platforms-macOS%2010.9-orange)
+
+Swift utilities for running commands.
+
+The `Commands` module allows you to take a system command as a string and return the standard output.
+
+## Usage
+```
+import Commands
+```
+
+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)")
+}
+```
+
+## 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:
+
+```swift
+let package = Package(
+    // name, platforms, products, etc.
+    dependencies: [
+        .package(url: "https://github.com/qiuzhifei/swift-commands", from: "0.1.0"),
+        // other dependencies
+    ],
+    targets: [
+        .target(name: "<command-line-tool>", dependencies: [
+            .product(name: "Commands", package: "swift-commands"),
+        ]),
+        // other targets
+    ]
+)
+```
+
+## CocoaPods (OS X 10.9+)
+You can use [CocoaPods](http://cocoapods.org/) to install `Commands` by adding it to your `Podfile`:
+```ruby
+pod 'Commands',        '~> 0.1.0'
+```
+
+## References
+- [https://github.com/apple/swift-argument-parser](https://github.com/apple/swift-argument-parser)

Sources/Commands/Commands.swift

@@ -0,0 +1,20 @@
+//
+//  Commands.swift
+//  
+//
+//  Created by zhifei qiu on 2021/8/2.
+//
+
+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) -> CustomENV {
+    return CustomENV(executableURL, dashc: dashc)
+  }
+}

Sources/Commands/CommandsENV.swift

@@ -0,0 +1,80 @@
+//
+//  CommandsENV.swift
+//  
+//
+//  Created by zhifei qiu on 2021/8/2.
+//
+
+import Foundation
+
+public protocol CommandsENV {
+  var executableURL: String { get }
+  var dashc: String { get }
+  
+  func env()
+  
+  func run(_ command: String) -> Commands.Result
+  func system(_ command: String)
+}
+
+public extension CommandsENV {
+  func env() {
+    let desc = """
+      ExecutableURL: \(executableURL)
+      Dashc: \(dashc)
+      """
+    print(desc)
+  }
+  
+  @discardableResult
+  func run(_ command: String) -> Commands.Result {
+    let process = prepare(command)
+    
+    let output = Pipe()
+    process.standardOutput = output
+    
+    let error = Pipe()
+    process.standardError = error
+    
+    run(process)
+    
+    let outputData = output.fileHandleForReading.readDataToEndOfFile()
+    let outputActual = String(data: outputData, encoding: .utf8)!.trimmingCharacters(in: .whitespacesAndNewlines)
+    
+    let errorData = error.fileHandleForReading.readDataToEndOfFile()
+    let errorActual = String(data: errorData, encoding: .utf8)!.trimmingCharacters(in: .whitespacesAndNewlines)
+    
+    if process.terminationStatus == EXIT_SUCCESS {
+      return Commands.Result.Success(output: outputActual)
+    }
+    
+    return Commands.Result.Failure(code: process.terminationStatus, output: errorActual)
+  }
+  
+  func system(_ command: String) {
+    let process = prepare(command)
+    run(process)
+  }
+}
+
+private extension CommandsENV {
+  func prepare(_ command: String) -> Process {
+    let process = Process()
+    if #available(macOS 10.13, *) {
+      process.executableURL = URL(fileURLWithPath: executableURL)
+    } else {
+      process.launchPath = executableURL
+    }
+    process.arguments = [dashc, command]
+    return process
+  }
+  
+  func run(_ process: Process) {
+    if #available(macOS 10.13, *) {
+      try? process.run()
+    } else {
+      process.launch()
+    }
+    process.waitUntilExit()
+  }
+}

Sources/Commands/CommandsENVWrapper.swift

@@ -0,0 +1,53 @@
+//
+//  CommandsENVWrapper.swift
+//  
+//
+//  Created by zhifei qiu on 2021/8/3.
+//
+
+import Foundation
+
+// MARK: - Custom
+
+public extension Commands {
+  struct CustomENV: CommandsENV {
+    public var executableURL: String
+    public var dashc: String
+    
+    init(_ executableURL: String, dashc: String) {
+      self.executableURL = executableURL
+      self.dashc = dashc
+    }
+  }
+}
+
+// MARK: - Bash
+
+public extension Commands {
+  struct BashENV: CommandsENV {
+    public var executableURL: String = "/bin/bash"
+    public var dashc: String = "-c"
+  }
+}
+
+// MARK: - Ruby
+
+public extension Commands {
+  struct RubyENV: CommandsENV {
+    public var executableURL: String = {
+      return Bash.run("which ruby").output
+    }()
+    public var dashc: String = "-e"
+  }
+}
+
+// MARK: - Python
+
+public extension Commands {
+  struct PythonENV: CommandsENV {
+    public var executableURL: String = {
+      return Bash.run("which python").output
+    }()
+    public var dashc: String = "-c"
+  }
+}

Sources/Commands/CommandsResult.swift

@@ -0,0 +1,39 @@
+//
+//  CommandsResult.swift
+//  
+//
+//  Created by zhifei qiu on 2021/8/2.
+//
+
+public extension Commands {
+  enum Result {
+    case Success(output: String)
+    case Failure(code: Int32, output: String)
+  }
+}
+
+public extension Commands.Result {
+  var output: String {
+    switch self {
+    case .Success(let output):
+      return output
+    case .Failure(_, let output):
+      return output
+    }
+  }
+}
+
+public extension Commands.Result {
+  var isSuccess: Bool {
+    switch self {
+    case .Success(_):
+      return true
+    default:
+      return false
+    }
+  }
+  
+  var isFailure: Bool {
+    !isSuccess
+  }
+}