Merge pull request #21 from Carthage/upgrade-dependencies

Rob Rix · Rob Rix · commit eb37de2d8579 · 2015-03-01T16:01:08.000-05:00
Upgrade dependencies
diff --git a/.gitmodules b/.gitmodules
@@ -1,6 +1,6 @@
 [submodule "Carthage.checkout/LlamaKit"]
 	path = Carthage/Checkouts/LlamaKit
-	url = https://github.com/Carthage/LlamaKit.git
+	url = https://github.com/LlamaKit/LlamaKit.git
 [submodule "Carthage.checkout/Nimble"]
 	path = Carthage/Checkouts/Nimble
 	url = https://github.com/Quick/Nimble.git
diff --git a/Cartfile b/Cartfile
@@ -1 +1 @@
-github "Carthage/LlamaKit" == 0.1.1
+github "LlamaKit/LlamaKit" == 0.5
diff --git a/Cartfile.private b/Cartfile.private
@@ -1,3 +1,3 @@
-github "Quick/Quick" == 0.2.0
-github "Quick/Nimble"
+github "Quick/Quick" ~> 0.2
+github "Quick/Nimble" ~> 0.3
 github "jspahrsummers/xcconfigs" >= 0.6
diff --git a/Cartfile.resolved b/Cartfile.resolved
@@ -1,4 +1,4 @@
-github "Carthage/LlamaKit" "carthage-0.1.1"
-github "Quick/Nimble" "v0.2.0"
-github "Quick/Quick" "v0.2.0"
-github "jspahrsummers/xcconfigs" "0.7"
+github "LlamaKit/LlamaKit" "v0.5.0"
+github "Quick/Nimble" "v0.3.0"
+github "Quick/Quick" "v0.2.2"
+github "jspahrsummers/xcconfigs" "0.7.2"
diff --git a/Carthage/Checkouts/LlamaKit b/Carthage/Checkouts/LlamaKit
@@ -1 +1 @@
-Subproject commit ac2c2d36bf14bdddd0c1c489df67ad9a7ad04eb4
+Subproject commit e37b966998df6ca05445c0b5d9c6c9560f1e7b61
diff --git a/Carthage/Checkouts/Nimble b/Carthage/Checkouts/Nimble
@@ -1 +1 @@
-Subproject commit 81a2d8a63083ae6512d40f7a02d5e075e57be317
+Subproject commit aeb5da7bed72483d22ccfef5310ccdd3dd39a06f
diff --git a/Carthage/Checkouts/Quick b/Carthage/Checkouts/Quick
@@ -1 +1 @@
-Subproject commit 315ae2a4a630156d5ac094ae1f107af60edce21d
+Subproject commit b0e98286db7e9d1f1e73cd4e69eac2aae2a1e3f8
diff --git a/Carthage/Checkouts/xcconfigs b/Carthage/Checkouts/xcconfigs
@@ -1 +1 @@
-Subproject commit 6c7a02a43954c74d2be1d2fcf7bfd65a263e7c52
+Subproject commit 2e77204b59c3d97c24e5dd34966fb32c231194f0
diff --git a/Commandant/ArgumentParser.swift b/Commandant/ArgumentParser.swift
@@ -100,7 +100,7 @@ public final class ArgumentParser {
 	///
 	/// If a value is found, the key and the value are both removed from the
 	/// list of arguments remaining to be parsed.
-	internal func consumeValueForKey(key: String) -> Result<String?> {
+	internal func consumeValueForKey(key: String) -> Result<String?, CommandantError> {
 		let oldArguments = rawArguments
 		rawArguments.removeAll()
 
diff --git a/Commandant/Command.swift b/Commandant/Command.swift
@@ -20,7 +20,7 @@ public protocol CommandType {
 	var function: String { get }
 
 	/// Runs this subcommand in the given mode.
-	func run(mode: CommandMode) -> Result<()>
+	func run(mode: CommandMode) -> Result<(), CommandantError>
 }
 
 /// Describes the "mode" in which a command should run.
@@ -56,7 +56,7 @@ public final class CommandRegistry {
 	/// arguments.
 	///
 	/// Returns the results of the execution, or nil if no such command exists.
-	public func runCommand(verb: String, arguments: [String]) -> Result<()>? {
+	public func runCommand(verb: String, arguments: [String]) -> Result<(), CommandantError>? {
 		return self[verb]?.run(.Arguments(ArgumentParser(arguments)))
 	}
 
@@ -81,7 +81,7 @@ extension CommandRegistry {
 	/// If a matching command could not be found, a helpful error message will
 	/// be written to `stderr`, then the process will exit with a failure error
 	/// code.
-	@noreturn public func main(#defaultCommand: CommandType, errorHandler: NSError -> ()) {
+	@noreturn public func main(#defaultCommand: CommandType, errorHandler: CommandantError -> ()) {
 		var arguments = Process.arguments
 		assert(arguments.count >= 1)
 
@@ -100,7 +100,7 @@ extension CommandRegistry {
 			exit(EXIT_SUCCESS)
 
 		case let .Some(.Failure(error)):
-			errorHandler(error)
+			errorHandler(error.unbox)
 			exit(EXIT_FAILURE)
 
 		case .None:
diff --git a/Commandant/Errors.swift b/Commandant/Errors.swift
@@ -8,25 +8,41 @@
 
 import Foundation
 
-/// The domain for all errors originating within Commandant.
-public let CommandantErrorDomain: NSString = "org.carthage.Commandant"
+/// Possible errors that can originate from Commandant.
+public enum CommandantError {
+	/// An option was used incorrectly.
+	case UsageError(description: String)
+
+	/// Creates an NSError that represents the receiver.
+	public func toNSError() -> NSError {
+		let domain = "org.carthage.Commandant"
+
+		switch self {
+		case let .UsageError(description):
+			return NSError(domain: domain, code: 0, userInfo: [ NSLocalizedDescriptionKey: description ])
+		}
+	}
+}
 
-/// Possible error codes within `CommandantErrorDomain`.
-public enum CommandantError: Int {
-	/// One or more arguments was invalid.
-	case InvalidArgument
+extension CommandantError: Printable {
+	public var description: String {
+		switch self {
+		case let .UsageError(description):
+			return description
+		}
+	}
 }
 
 /// Constructs an `InvalidArgument` error that indicates a missing value for
 /// the argument by the given name.
-internal func missingArgumentError(argumentName: String) -> NSError {
+internal func missingArgumentError(argumentName: String) -> CommandantError {
 	let description = "Missing argument for \(argumentName)"
-	return NSError(domain: CommandantErrorDomain, code: CommandantError.InvalidArgument.rawValue, userInfo: [ NSLocalizedDescriptionKey: description ])
+	return CommandantError.UsageError(description: description)
 }
 
-/// Constructs an `InvalidArgument` error that describes how to use the
-/// option, with the given example of key (and value, if applicable) usage.
-internal func informativeUsageError<T>(keyValueExample: String, option: Option<T>) -> NSError {
+/// Constructs an error that describes how to use the option, with the given
+/// example of key (and value, if applicable) usage.
+internal func informativeUsageError<T>(keyValueExample: String, option: Option<T>) -> CommandantError {
 	var description = ""
 
 	if option.defaultValue != nil {
@@ -43,13 +59,12 @@ internal func informativeUsageError<T>(keyValueExample: String, option: Option<T
 		.reduce(""){ previous, value in
 			return previous + "\n\t" + value
 		}
-
-	return NSError(domain: CommandantErrorDomain, code: CommandantError.InvalidArgument.rawValue, userInfo: [ NSLocalizedDescriptionKey: description ])
+	
+	return CommandantError.UsageError(description: description)
 }
 
-/// Constructs an `InvalidArgument` error that describes how to use the
-/// option.
-internal func informativeUsageError<T: ArgumentType>(option: Option<T>) -> NSError {
+/// Constructs an error that describes how to use the option.
+internal func informativeUsageError<T: ArgumentType>(option: Option<T>) -> CommandantError {
 	var example = ""
 
 	if let key = option.key {
@@ -70,9 +85,8 @@ internal func informativeUsageError<T: ArgumentType>(option: Option<T>) -> NSErr
 	return informativeUsageError(example, option)
 }
 
-/// Constructs an `InvalidArgument` error that describes how to use the
-/// given boolean option.
-internal func informativeUsageError(option: Option<Bool>) -> NSError {
+/// Constructs an error that describes how to use the given boolean option.
+internal func informativeUsageError(option: Option<Bool>) -> CommandantError {
 	precondition(option.key != nil)
 
 	let key = option.key!
@@ -84,23 +98,18 @@ internal func informativeUsageError(option: Option<Bool>) -> NSError {
 	}
 }
 
-/// Combines the text of the two errors, if they're both `InvalidArgument`
-/// errors. Otherwise, uses whichever one is not (biased toward the left).
-internal func combineUsageErrors(left: NSError, right: NSError) -> NSError {
-	let combinedDescription = "\(left.localizedDescription)\n\n\(right.localizedDescription)"
-	let combinedError = NSError(domain: CommandantErrorDomain, code: CommandantError.InvalidArgument.rawValue, userInfo: [ NSLocalizedDescriptionKey: combinedDescription ])
-
-	func isUsageError(error: NSError) -> Bool {
-		return error.domain == combinedError.domain && error.code == combinedError.code
-	}
-
-	if isUsageError(left) {
-		if isUsageError(right) {
-			return combinedError
-		} else {
-			return right
-		}
-	} else {
-		return left
+/// Combines the text of the two errors, if they're both `UsageError`s.
+/// Otherwise, uses whichever one is not (biased toward the left).
+internal func combineUsageErrors(lhs: CommandantError, rhs: CommandantError) -> CommandantError {
+	switch (lhs, rhs) {
+	case let (.UsageError(left), .UsageError(right)):
+		let combinedDescription = "\(left)\n\n\(right)"
+		return CommandantError.UsageError(description: combinedDescription)
+
+	case (.UsageError, _):
+		return rhs
+	
+	case (_, .UsageError), (_, _):
+		return lhs
 	}
 }
diff --git a/Commandant/HelpCommand.swift b/Commandant/HelpCommand.swift
@@ -30,7 +30,7 @@ public struct HelpCommand: CommandType {
 		self.registry = registry
 	}
 
-	public func run(mode: CommandMode) -> Result<()> {
+	public func run(mode: CommandMode) -> Result<(), CommandantError> {
 		return HelpOptions.evaluate(mode)
 			.flatMap { options in
 				if let verb = options.verb {
@@ -68,7 +68,7 @@ private struct HelpOptions: OptionsType {
 		return self(verb: (verb == "" ? nil : verb))
 	}
 
-	static func evaluate(m: CommandMode) -> Result<HelpOptions> {
+	static func evaluate(m: CommandMode) -> Result<HelpOptions, CommandantError> {
 		return create
 			<*> m <| Option(defaultValue: "", usage: "the command to display help for")
 	}
diff --git a/Commandant/Option.swift b/Commandant/Option.swift
@@ -38,7 +38,7 @@ public protocol OptionsType {
 	///
 	/// Returns the parsed options, or an `InvalidArgument` error containing
 	/// usage information.
-	class func evaluate(m: CommandMode) -> Result<Self>
+	class func evaluate(m: CommandMode) -> Result<Self, CommandantError>
 }
 
 /// Describes an option that can be provided on the command line.
@@ -74,9 +74,9 @@ public struct Option<T> {
 
 	/// Constructs an `InvalidArgument` error that describes how the option was
 	/// used incorrectly. `value` should be the invalid value given by the user.
-	private func invalidUsageError(value: String) -> NSError {
+	private func invalidUsageError(value: String) -> CommandantError {
 		let description = "Invalid value for '\(self)': \(value)"
-		return NSError(domain: CommandantErrorDomain, code: CommandantError.InvalidArgument.rawValue, userInfo: [ NSLocalizedDescriptionKey: description ])
+		return CommandantError.UsageError(description: description)
 	}
 }
 
@@ -154,24 +154,24 @@ infix operator <| {
 ///
 /// In the context of command-line option parsing, this is used to chain
 /// together the parsing of multiple arguments. See OptionsType for an example.
-public func <*><T, U>(f: T -> U, value: Result<T>) -> Result<U> {
+public func <*><T, U>(f: T -> U, value: Result<T, CommandantError>) -> Result<U, CommandantError> {
 	return value.map(f)
 }
 
 /// Applies the function in `f` to the value in the given result.
 ///
 /// In the context of command-line option parsing, this is used to chain
 /// together the parsing of multiple arguments. See OptionsType for an example.
-public func <*><T, U>(f: Result<(T -> U)>, value: Result<T>) -> Result<U> {
+public func <*><T, U>(f: Result<(T -> U), CommandantError>, value: Result<T, CommandantError>) -> Result<U, CommandantError> {
 	switch (f, value) {
 	case let (.Failure(left), .Failure(right)):
-		return failure(combineUsageErrors(left, right))
+		return failure(combineUsageErrors(left.unbox, right.unbox))
 
 	case let (.Failure(left), .Success):
-		return failure(left)
+		return failure(left.unbox)
 
 	case let (.Success, .Failure(right)):
-		return failure(right)
+		return failure(right.unbox)
 
 	case let (.Success(f), .Success(value)):
 		let newValue = f.unbox(value.unbox)
@@ -183,7 +183,7 @@ public func <*><T, U>(f: Result<(T -> U)>, value: Result<T>) -> Result<U> {
 ///
 /// If parsing command line arguments, and no value was specified on the command
 /// line, the option's `defaultValue` is used.
-public func <|<T: ArgumentType>(mode: CommandMode, option: Option<T>) -> Result<T> {
+public func <|<T: ArgumentType>(mode: CommandMode, option: Option<T>) -> Result<T, CommandantError> {
 	switch mode {
 	case let .Arguments(arguments):
 		var stringValue: String?
@@ -193,7 +193,7 @@ public func <|<T: ArgumentType>(mode: CommandMode, option: Option<T>) -> Result<
 				stringValue = value.unbox
 
 			case let .Failure(error):
-				return failure(error)
+				return failure(error.unbox)
 			}
 		} else {
 			stringValue = arguments.consumePositionalArgument()
@@ -220,7 +220,7 @@ public func <|<T: ArgumentType>(mode: CommandMode, option: Option<T>) -> Result<
 ///
 /// If parsing command line arguments, and no value was specified on the command
 /// line, the option's `defaultValue` is used.
-public func <|(mode: CommandMode, option: Option<Bool>) -> Result<Bool> {
+public func <|(mode: CommandMode, option: Option<Bool>) -> Result<Bool, CommandantError> {
 	precondition(option.key != nil)
 
 	switch mode {
diff --git a/CommandantTests/OptionSpec.swift b/CommandantTests/OptionSpec.swift
@@ -15,62 +15,62 @@ import Quick
 class OptionsTypeSpec: QuickSpec {
 	override func spec() {
 		describe("CommandMode.Arguments") {
-			func tryArguments(arguments: String...) -> Result<TestOptions> {
+			func tryArguments(arguments: String...) -> Result<TestOptions, CommandantError> {
 				return TestOptions.evaluate(.Arguments(ArgumentParser(arguments)))
 			}
 
 			it("should fail if a required argument is missing") {
-				expect(tryArguments().isSuccess()).to(beFalsy())
+				expect(tryArguments().isSuccess).to(beFalsy())
 			}
 
 			it("should fail if an option is missing a value") {
-				expect(tryArguments("required", "--intValue").isSuccess()).to(beFalsy())
+				expect(tryArguments("required", "--intValue").isSuccess).to(beFalsy())
 			}
 
 			it("should succeed without optional arguments") {
-				let value = tryArguments("required").value()
+				let value = tryArguments("required").value
 				let expected = TestOptions(intValue: 42, stringValue: "foobar", optionalFilename: "filename", requiredName: "required", enabled: false)
 				expect(value).to(equal(expected))
 			}
 
 			it("should succeed with some optional arguments") {
-				let value = tryArguments("required", "--intValue", "3", "fuzzbuzz").value()
+				let value = tryArguments("required", "--intValue", "3", "fuzzbuzz").value
 				let expected = TestOptions(intValue: 3, stringValue: "foobar", optionalFilename: "fuzzbuzz", requiredName: "required", enabled: false)
 				expect(value).to(equal(expected))
 			}
 
 			it("should override previous optional arguments") {
-				let value = tryArguments("required", "--intValue", "3", "--stringValue", "fuzzbuzz", "--intValue", "5", "--stringValue", "bazbuzz").value()
+				let value = tryArguments("required", "--intValue", "3", "--stringValue", "fuzzbuzz", "--intValue", "5", "--stringValue", "bazbuzz").value
 				let expected = TestOptions(intValue: 5, stringValue: "bazbuzz", optionalFilename: "filename", requiredName: "required", enabled: false)
 				expect(value).to(equal(expected))
 			}
 
 			it("should enable a boolean flag") {
-				let value = tryArguments("required", "--enabled", "--intValue", "3", "fuzzbuzz").value()
+				let value = tryArguments("required", "--enabled", "--intValue", "3", "fuzzbuzz").value
 				let expected = TestOptions(intValue: 3, stringValue: "foobar", optionalFilename: "fuzzbuzz", requiredName: "required", enabled: true)
 				expect(value).to(equal(expected))
 			}
 
 			it("should re-disable a boolean flag") {
-				let value = tryArguments("required", "--enabled", "--no-enabled", "--intValue", "3", "fuzzbuzz").value()
+				let value = tryArguments("required", "--enabled", "--no-enabled", "--intValue", "3", "fuzzbuzz").value
 				let expected = TestOptions(intValue: 3, stringValue: "foobar", optionalFilename: "fuzzbuzz", requiredName: "required", enabled: false)
 				expect(value).to(equal(expected))
 			}
 
 			it("should treat -- as the end of valued options") {
-				let value = tryArguments("--", "--intValue").value()
+				let value = tryArguments("--", "--intValue").value
 				let expected = TestOptions(intValue: 42, stringValue: "foobar", optionalFilename: "filename", requiredName: "--intValue", enabled: false)
 				expect(value).to(equal(expected))
 			}
 		}
 
 		describe("CommandMode.Usage") {
 			it("should return an error containing usage information") {
-				let error = TestOptions.evaluate(.Usage).error()!
-				expect(error.localizedDescription).to(contain("intValue"))
-				expect(error.localizedDescription).to(contain("stringValue"))
-				expect(error.localizedDescription).to(contain("name you're required to"))
-				expect(error.localizedDescription).to(contain("optionally specify"))
+				let error = TestOptions.evaluate(.Usage).error
+				expect(error?.description).to(contain("intValue"))
+				expect(error?.description).to(contain("stringValue"))
+				expect(error?.description).to(contain("name you're required to"))
+				expect(error?.description).to(contain("optionally specify"))
 			}
 		}
 	}
@@ -87,7 +87,7 @@ struct TestOptions: OptionsType, Equatable {
 		return self(intValue: a, stringValue: b, optionalFilename: d, requiredName: c, enabled: e)
 	}
 
-	static func evaluate(m: CommandMode) -> Result<TestOptions> {
+	static func evaluate(m: CommandMode) -> Result<TestOptions, CommandantError> {
 		return create
 			<*> m <| Option(key: "intValue", defaultValue: 42, usage: "Some integer value")
 			<*> m <| Option(key: "stringValue", defaultValue: "foobar", usage: "Some string value")

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-github "Carthage/LlamaKit" == 0.1.1`
	`1`	`+github "LlamaKit/LlamaKit" == 0.5`