[platform] Remove SPM dependency

.circleci/config.yml

@@ -4,7 +4,7 @@ executors:
 
   mac:
     macos:
-      xcode: "10.1.0"
+      xcode: "10.2.0"
 
   go:
     docker:

Makefile

@@ -4,7 +4,7 @@ APP_NAME_LOWERCASE=$(shell echo '$(APP_NAME)' | tr '[:upper:]' '[:lower:]')
 APP_TMP=/tmp/$(APP_NAME).dst
 BIN_DIR=$(INSTALL_DIR)/bin
 BINARIES_DIR=/usr/local/bin
-BUILD=swift build --static-swift-stdlib
+BUILD=swift build
 BUILD_NUMBER_FILE=./Sources/$(APP_NAME)/App/BuildNumber.swift
 CONFIG_TEMPLATE=template.config.yml
 CONFIRM=./Scripts/prompt_confirmation
@@ -123,7 +123,7 @@ ifdef NEW_VERSION
 	$(eval MAJOR:=$(word 1,$(VERSION_COMPONENTS)))
 	$(eval MINOR:=$(word 2,$(VERSION_COMPONENTS)))
 	$(eval PATCH:=$(word 3,$(VERSION_COMPONENTS)))
-	@echo "import struct Utility.Version\n\nlet appVersion: Version = .init($(MAJOR), $(MINOR), $(PATCH))" > $(VERSION_FILE)
+	@echo "import Version\n\nlet appVersion: Version = .init($(MAJOR), $(MINOR), $(PATCH))" > $(VERSION_FILE)
 endif
 
 xcodeproj:

Package.resolved

@@ -2,21 +2,57 @@
   "object": {
     "pins": [
       {
-        "package": "SwiftPM",
-        "repositoryURL": "https://github.com/apple/swift-package-manager.git",
+        "package": "Commandant",
+        "repositoryURL": "https://github.com/Carthage/Commandant.git",
         "state": {
           "branch": null,
-          "revision": "235aacc514cb81a6881364b0fedcb3dd083228f3",
-          "version": "0.3.0"
+          "revision": "ab68611013dec67413628ac87c1f29e8427bc8e4",
+          "version": "0.17.0"
+        }
+      },
+      {
+        "package": "Curry",
+        "repositoryURL": "https://github.com/thoughtbot/Curry.git",
+        "state": {
+          "branch": null,
+          "revision": "4331dd50bc1db007db664a23f32e6f3df93d4e1a",
+          "version": "4.0.2"
+        }
+      },
+      {
+        "package": "Nimble",
+        "repositoryURL": "https://github.com/Quick/Nimble.git",
+        "state": {
+          "branch": null,
+          "revision": "43304bf2b1579fd555f2fdd51742771c1e4f2b98",
+          "version": "8.0.1"
+        }
+      },
+      {
+        "package": "Quick",
+        "repositoryURL": "https://github.com/Quick/Quick.git",
+        "state": {
+          "branch": null,
+          "revision": "94df9b449508344667e5afc7e80f8bcbff1e4c37",
+          "version": "2.1.0"
+        }
+      },
+      {
+        "package": "Version",
+        "repositoryURL": "https://github.com/mxcl/Version.git",
+        "state": {
+          "branch": null,
+          "revision": "61140c9f8a94c0326076fd2d44817834f4c6aafc",
+          "version": "1.1.0"
         }
       },
       {
         "package": "Yams",
         "repositoryURL": "https://github.com/jpsim/Yams.git",
         "state": {
           "branch": null,
-          "revision": "b08dba4bcea978bf1ad37703a384097d3efce5af",
-          "version": "1.0.2"
+          "revision": "c947a306d2e80ecb2c0859047b35c73b8e1ca27f",
+          "version": "2.0.0"
         }
       }
     ]

Package.swift

@@ -2,29 +2,40 @@
 
 import PackageDescription
 
+var dependencies: [Package.Dependency] = [
+        .package(url: "https://github.com/Carthage/Commandant.git", from: "0.16.0"),
+        .package(url: "https://github.com/thoughtbot/Curry.git", from: "4.0.0"),
+        .package(url: "https://github.com/jpsim/Yams.git", from: "2.0.0"),
+        .package(url: "https://github.com/mxcl/Version.git", from: "1.0.0")
+]
+
+var finchDependencies: [Target.Dependency] = ["FinchCore", "Commandant", "Curry", "Version"]
+
+#if swift(>=5.0)
+dependencies.append(.package(url: "https://github.com/antitypical/Result.git", from:"4.1.0"))
+finchDependencies.append("Result")
+#endif
+
 let package = Package(
     name: "Finch",
     products: [
         .executable(name: "finch", targets: ["Finch"]),
         .library(name: "FinchApp", targets: ["FinchApp"])
     ],
-    dependencies: [
-        .package(url: "https://github.com/apple/swift-package-manager.git", from: "0.3.0"),
-        .package(url: "https://github.com/jpsim/Yams.git", from: "1.0.1"),
-    ],
+    dependencies: dependencies,
     targets: [
         .target(
             name: "Finch",
             dependencies: ["FinchApp"]),
         .target(
             name: "FinchApp",
-            dependencies: ["FinchCore"]),
+            dependencies: finchDependencies),
         .target(
             name: "FinchCore",
             dependencies: ["FinchUtilities"]),
         .target(
             name: "FinchUtilities",
-            dependencies: ["Utility", "Yams"]),
-    ]
+            dependencies: ["Yams"])
+    ],
+    swiftLanguageVersions: [.v4, .v4_2, .version("5")]
 )
-

Sources/Finch/App/Version.swift

@@ -1,3 +1,3 @@
-import struct Utility.Version
+import Version
 
 let appVersion: Version = .init(0, 0, 23)

Sources/FinchApp/App.swift

@@ -6,12 +6,10 @@
 //  Copyright © 2019 DHL. All rights reserved.
 //
 
-import struct Utility.Version
+import Commandant
 import struct FinchCore.Configuration
 import FinchUtilities
-
-/// :nodoc:
-public typealias Version = Utility.Version
+import Version
 
 /// A structure to represent this app and its components.
 public struct App {
@@ -35,19 +33,28 @@ public struct App {
         }
     }
 
-    /// App options received from the commandline.
-    struct Options {
+    /// Abstract base class of app options received from the commandline.
+    class Options {
+        enum Key: String {
+            case configPath = "config"
+            case projectDir = "project-dir"
+            case verbose = "verbose"
+        }
+
         /// Path to config
         var configPath: String?
 
         /// The project directory if it is not the current working directory.
         var projectDir: String?
 
-        /// Print the app version information and exit.
-        var shouldPrintVersion: Bool
-
         /// Execute with verbose output.
         var verbose: Bool
+
+        init(configPath: String?, projectDir: String?, verbose: Bool) {
+            self.configPath = configPath
+            self.projectDir = projectDir
+            self.verbose = verbose
+        }
     }
 
     /// The app's derived configuration.
@@ -78,10 +85,11 @@ public struct App {
 
 /// :nodoc:
 extension App.Options {
-    static let blank: App.Options = .init(
-        configPath: nil,
-        projectDir: nil,
-        shouldPrintVersion: false,
-        verbose: false
-    )
+    static var blank: App.Options {
+        return .init(
+            configPath: nil,
+            projectDir: nil,
+            verbose: false
+        )
+    }
 }

Sources/FinchApp/AppRunner.swift

@@ -5,44 +5,63 @@
 //  Created by Dan Loman on 1/29/19.
 //
 
+import Commandant
 import FinchUtilities
-import enum Utility.ArgumentParserError
+import Foundation
+
+enum AppError: LocalizedError {
+    /// Unsupported mode (subcommand) for config command
+    case unsupportedConfigMode
+
+    /// Wraps error types which should be propogated
+    case wrapped(Error)
+
+    var localizedDescription: String {
+        switch self {
+        case .unsupportedConfigMode:
+            return Strings.Error.unsupportedConfigMode
+        case let .wrapped(error):
+            return error.localizedDescription
+        }
+
+    }
+}
 
 /**
  * A class responsible for running the app. Internally registers
  * all commands. Selects and runs the proper command.
  */
 public class AppRunner {
-    private let environment: Environment
-
-    private let meta: App.Meta
-
     private let output: OutputType
 
-    private let registry: CommandRegistry
+    private let registry: CommandRegistry<AppError> = .init()
 
     /// :nodoc:
     public init(environment: Environment, meta: App.Meta, output: OutputType = Output.instance) {
-        self.environment = environment
-        self.meta = meta
         self.output = output
-        self.registry = .init(meta: meta)
 
-        registry.register {
-            CompareCommand(meta: meta, parser: $0).bindingGlobalOptions(to: $1)
-        }
-
-        registry.register {
-            ConfigCommand(meta: meta, parser: $0).bindingGlobalOptions(to: $1)
-        }
+        registry.register(CompareCommand(env: environment, meta: meta, output: output))
+        registry.register(ConfigCommand(env: environment, meta: meta, output: output))
+        registry.register(HelpCommand(registry: registry))
+        registry.register(VersionCommand(env: environment, meta: meta, output: output))
     }
 
     /// Runs the app with the included arguments.
     public func run(arguments: [String]) {
-        do {
-            try _run(arguments: arguments)
-        } catch {
-            let message = (error as? ArgumentParserError)?.description ?? error.localizedDescription
+        // Drop argument for Finch executable
+        var args = arguments[1...]
+
+        let command = args.removeFirst()
+
+        guard let result = registry.run(command: command, arguments: Array(args)) else {
+            return
+        }
+
+        switch result {
+        case .success:
+            break
+        case .failure(let error):
+            let message = error.localizedDescription
 
             output.print(
                 Strings.Error.formatted(errorMessage: message),
@@ -51,37 +70,4 @@ public class AppRunner {
             )
         }
     }
-
-    private func _run(arguments: [String]) throws {
-        let args = Array(arguments.dropFirst())
-
-        let (command, options, result) = try registry.parse(arguments: args)
-
-        let config = Configurator(
-            options: options,
-            meta: meta,
-            environment: environment,
-            output: output
-        ).configuration
-
-        let app: App = .init(
-            configuration: config,
-            meta: meta,
-            options: options,
-            output: output
-        )
-
-        if let command = command {
-            try registry.runCommand(
-                named: command,
-                with: result,
-                app: app,
-                env: environment
-            )
-        } else if options.shouldPrintVersion {
-            app.print("\(app.meta.name) \(app.meta.version) (\(app.meta.buildNumber))")
-        } else {
-            registry.printUsage()
-        }
-    }
 }

Sources/FinchApp/Command-Routing/Command.swift

@@ -5,32 +5,43 @@
 //  Created by Dan Loman on 1/29/19.
 //
 
-import Utility
+import Commandant
+import FinchUtilities
+#if !swift(>=5.0)
+@_exported import Result
+#endif
 
-/// :nodoc:
-public typealias ParsingResult = ArgumentParser.Result
-
-/// :nodoc:
+///// :nodoc:
 public typealias Environment = [String: String]
 
-/// Protocol describing a command.
-protocol Command {
-    /// Name of the command.
-    var name: String { get }
+protocol Command: CommandProtocol where Options: App.Options {
+
+    var environment: Environment { get }
+
+    var meta: App.Meta { get }
 
-    /**
-     * Runs the command with the parsing result, app,
-     * and current environment.
-     */
-    func run(with result: ParsingResult, app: App, env: Environment) throws
+    var output: OutputType { get }
 
-    /// Optional function to allow the command to bind to the main app options,
-    func bindingGlobalOptions(to binder: ArgumentBinder<App.Options>) -> Self
+    func run(options: Options, app: App, env: Environment) -> Result<(), ClientError>
 }
 
-/// :nodoc:
 extension Command {
-    func bindingGlobalOptions(to binder: ArgumentBinder<App.Options>) -> Self {
-        return self
+    /// Should NOT be implemented by types conforming to Command.
+    func run(_ options: Options) -> Result<(), ClientError> {
+        let config = Configurator(
+            options: options,
+            meta: meta,
+            environment: environment,
+            output: output
+            ).configuration
+
+        let app: App = .init(
+            configuration: config,
+            meta: meta,
+            options: options,
+            output: output
+        )
+
+        return run(options: options, app: app, env: environment)
     }
 }