Add examples

Author: kylef

Commander/Group.swift

@@ -106,27 +106,27 @@ extension Group {
   // MARK: Argument Description Commands
 
   /// Add a command which takes one argument using a closure
-  public func command<A:ArgumentDescriptor>(name:String, a:A, closure:(A.ValueType) -> ()) {
+  public func command<A:ArgumentDescriptor>(name:String, _ a:A, closure:(A.ValueType) -> ()) {
     addCommand(name, Commander.command(a, closure: closure))
   }
 
   /// Add a command which takes two argument using a closure
-  public func command<A:ArgumentDescriptor, B:ArgumentDescriptor>(name:String, a:A, b:B, closure:(A.ValueType,B.ValueType) -> ()) {
+  public func command<A:ArgumentDescriptor, B:ArgumentDescriptor>(name:String, _ a:A, _ b:B, closure:(A.ValueType,B.ValueType) -> ()) {
     addCommand(name, Commander.command(a, b, closure: closure))
   }
 
   /// Add a command which takes three argument using a closure
-  public func command<A:ArgumentDescriptor, B:ArgumentDescriptor, C:ArgumentDescriptor>(name:String, a:A, b:B, c:C, closure:(A.ValueType,B.ValueType,C.ValueType) -> ()) {
+  public func command<A:ArgumentDescriptor, B:ArgumentDescriptor, C:ArgumentDescriptor>(name:String, _ a:A, _ b:B, _ c:C, closure:(A.ValueType,B.ValueType,C.ValueType) -> ()) {
     addCommand(name, Commander.command(a, b, c, closure: closure))
   }
 
   /// Add a command which takes four argument using a closure
-  public func command<A:ArgumentDescriptor, B:ArgumentDescriptor, C:ArgumentDescriptor, D:ArgumentDescriptor>(name:String, a:A, b:B, c:C, d:D, closure:(A.ValueType,B.ValueType,C.ValueType,D.ValueType) -> ()) {
+  public func command<A:ArgumentDescriptor, B:ArgumentDescriptor, C:ArgumentDescriptor, D:ArgumentDescriptor>(name:String, _ a:A, _ b:B, _ c:C, _ d:D, closure:(A.ValueType,B.ValueType,C.ValueType,D.ValueType) -> ()) {
     addCommand(name, Commander.command(a, b, c, d, closure: closure))
   }
 
   /// Add a command which takes five argument using a closure
-  public func command<A:ArgumentDescriptor, B:ArgumentDescriptor, C:ArgumentDescriptor, D:ArgumentDescriptor, E:ArgumentDescriptor>(name:String, a:A, b:B, c:C, d:D, e:E, closure:(A.ValueType,B.ValueType,C.ValueType,D.ValueType,E.ValueType) -> ()) {
+  public func command<A:ArgumentDescriptor, B:ArgumentDescriptor, C:ArgumentDescriptor, D:ArgumentDescriptor, E:ArgumentDescriptor>(name:String, _ a:A, _ b:B, _ c:C, _ d:D, _ e:E, closure:(A.ValueType,B.ValueType,C.ValueType,D.ValueType,E.ValueType) -> ()) {
     addCommand(name, Commander.command(a, b, c, d, e, closure: closure))
   }
 }

CommanderTests/CommandTests.swift

@@ -24,4 +24,41 @@ class CommandTests : XCTestCase {
 
     XCTAssertEqual(ranName, "Kyle")
   }
+
+  // MARK: Described Arguments
+
+  func testCommandWithDescribedArgument() {
+    var givenName = ""
+
+    let c = command(
+      Argument("name")
+    ) { name in
+      givenName = name
+    }
+
+    try! c.run(["Kyle"])
+    XCTAssertEqual(givenName, "Kyle")
+  }
+//
+//  func testCommandWithDescribedArgumentShowsUsage() {
+//    let c = command(
+//      Argument("name")
+//    ) { name in
+//    }
+//
+//    try! c.run(["Kyle"])
+//  }
+//
+//  func testCommandWithDescribedArgumentHelp() {
+//    var givenName = ""
+//
+//    let c = command(
+//      Argument("name", `default`: "World")
+//      ) { name in
+//        givenName = name
+//    }
+//
+//    try! c.run(["--help"])
+//    XCTAssertEqual(givenName, "Kyle")
+//  }
 }

Examples/Makefile

@@ -0,0 +1,2 @@
+build:
+	pod install --no-repo-update

Examples/README.md

@@ -0,0 +1,11 @@
+# Commander Examples
+
+To use the examples, first run `make` with CocoaPods and CocoaPods-Rome
+installed.
+
+```bash
+$ make
+$ ./hello.swift
+$ ./pod.swift
+```
+

Examples/hello.swift

@@ -0,0 +1,13 @@
+#!/usr/bin/swift -FRome
+
+import Commander
+
+command(
+  Option("name", "world"),
+  Option("count", 1, description: "The number of times to print.")
+) { name, count in
+  for _ in 0..<count {
+    print("Hello \(name)")
+  }
+}.run()
+

Examples/pod.swift

@@ -0,0 +1,25 @@
+#!/usr/bin/swift -FRome
+
+import Commander
+
+Group {
+  $0.command("install") {
+    print("Installing Pods")
+  }
+
+  $0.command("upgrade") { (name:String) in
+    print("Updating \(name)")
+  }
+
+  $0.command("search",
+    Flag("web", description: "Searches on cocoapods.org"),
+    Argument<String>("query")
+  ) { web, query in
+    if web {
+      print("Searching for \(query) on the web.")
+    } else {
+      print("Locally searching for \(query).")
+    }
+  }
+}.run()
+

README.md

@@ -66,30 +66,30 @@ count is 1.
 command(
   Option("name", "world"),
   Option("count", 1, description: "The number of times to print.")
-) { name, count
-  for _ in (0..<count) {
+) { name, count in
+  for _ in 0..<count {
     print("Hello \(name)")
   }
 }
 ```
 
 ```shell
-./command --help
+./hello --help
 Usage:
 
-    $ ./command
+    $ ./hello
 
 Options:
     --name
     --count - The number of times to print.
 
-./command
+./hello
 Hello world
 
-./command --name Kyle
+./hello --name Kyle
 Hello Kyle
 
-./command --name Kyle --count 4
+./hello --name Kyle --count 4
 Hello Kyle
 Hello Kyle
 Hello Kyle