Add badges and try in playground code

Author: daniel-beard

.arena-sample.swift

@@ -0,0 +1,135 @@
+// Playground generated with 🏟 Arena (https://github.com/finestructure/arena)
+// ℹ️ If running the playground fails with an error "no such module ..."
+//    go to Product -> Build to re-trigger building the SPM package.
+// ℹ️ Please restart Xcode if autocomplete is not working.
+
+import Foundation
+import URLMatcher
+
+enum URLAction {
+    case login, signup, invite(key: String)
+}
+
+// Quick start example
+var matcher = URLMatcher<URLAction>()
+
+try matcher.add(path: "user/login") { .login }
+try matcher.add(path: "user/signup") { .signup }
+try matcher.add(path: "user/invite/<key: String>") {(_, values) in
+    .invite(key: values["key"] as! String)
+}
+
+// Grab your url from your web view or app delegate method
+let url = URL(string:"http://mydomain.com/user/invite/y78gyug76g")!
+
+if let action = matcher.matchURL(url) {
+    switch action {
+    case .login, .signup:
+        print("Show welcome form")
+    case .invite(let key):
+        // Show loading overlay
+        // Look up invite from the server
+        // Dismiss the loading overlay
+        // If available, show the accept invite flow
+        // If not, show an error alert
+        print("Load invite: \(key)")
+    }
+} else {
+    // We don't know what to do with this URL, fallback on the system
+}
+
+// Matching example
+struct UserAction {
+    let userId: Int64?
+    let action: String
+}
+extension UserAction: CustomDebugStringConvertible {
+    var debugDescription: String {
+        if let userId = userId {
+            return "\(action) user \(userId)"
+        } else {
+            return "\(action) user"
+        }
+    }
+}
+
+var userMatcher = URLMatcher<UserAction>()
+
+try userMatcher.add(path: "user/<userId:Int64>/edit") { (_, values: [String : Any]) -> UserAction in
+    return UserAction(userId: values["userId"] as? Int64, action: "edit")
+}
+
+try userMatcher.add(path: "user/<userId:Int64>/<*>") { (query: [String: String], values: [String : Any]) -> UserAction in
+    if query["force_update"] == "true" {
+        return UserAction(userId: values["userId"] as? Int64, action: "update app")
+    } else {
+        return UserAction(userId: values["userId"] as? Int64, action: "show")
+    }
+}
+
+try userMatcher.add(path: "user/<+>/<*>") { return UserAction(userId: nil, action: "unknown") }
+
+var action = userMatcher.matchURL(URL(string:"user/6578/edit")!)
+print(action!)
+
+action = userMatcher.matchURL(URL(string:"user/890822/verify/email")!)
+print(action!)
+
+action = userMatcher.matchURL(URL(string:"user/890822/verify/email?force_update=true")!)
+print(action!)
+
+action = userMatcher.matchURL(URL(string:"user/an.email@example.com/verify/email")!)
+print(action!)
+
+
+// Wildcard example
+var wildcardMatcher = URLMatcher<String>()
+
+try wildcardMatcher.add(path: "a/<+>") { "a" }
+try wildcardMatcher.add(path: "<+>/b") { "b" }
+
+var wildcard = wildcardMatcher.matchURL(URL(string:"a/b")!)
+wildcard = wildcardMatcher.matchURL(URL(string: "c/b")!)
+
+
+// Custom components example
+struct Commit : ComponentMatchable {
+    func matches(urlComponent: String) -> Bool {
+        return "c" == urlComponent || "commit" == urlComponent
+    }
+}
+
+struct HashId: ComponentParseable {
+    let label: String
+    
+    func matches(urlComponent: String) -> Bool {
+        return valueOf(urlComponent: urlComponent) != nil
+    }
+    
+    func valueOf(urlComponent: String) -> Any? {
+        // Should actually validate more completely, not great string handling
+        if 7 == urlComponent.count || 40 == urlComponent.count {
+            return String(urlComponent.prefix(7))
+        } else {
+            return nil
+        }
+    }
+}
+
+var commitMatcher = URLMatcher<String>()
+
+commitMatcher.registerType(name: "Commit") { (_) in Commit() }
+commitMatcher.registerType(name: "HashId") { HashId(label: $0) }
+
+try commitMatcher.add(path: "<Commit>/<commitId:HashId>") { (_, values: [String : Any]) -> String in
+    return values["commitId"] as! String
+}
+
+var commit = commitMatcher.matchURL(URL(string:"/c/7h1uh89")!)
+print(commit!)
+
+commit = commitMatcher.matchURL(URL(string:"/commit/7h1uh8927e39434ae8da5fuy6c1de98c56c09410")!)
+print(commit!)
+
+
+

README.md

@@ -1,5 +1,7 @@
 # URLMatcher
 
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fsplitwise%2FURLMatcher%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/splitwise/URLMatcher) [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fsplitwise%2FURLMatcher%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/splitwise/URLMatcher)
+
 URLMatcher is a flexible url matching library intended to handle the problem of what a URL is for without specifying how to handle it.
 
 Similar libraries assume you'll be binding data to a view controller, then displaying it. This makes them hard to test well and awkward to use if your behavior is different. Maybe you need to select a specific tab, push a navigation controller, then show an alert or do different data binding depending on your local state. URLMatcher leaves this up to you while making it easy to test that you're matching and parsing all the URLs you expect to handle.
@@ -49,7 +51,7 @@ The URLMatcher will find the path that matches the URL and then execute the prov
 
 ## Matching
 
-NOTE: the code samples here are based on the [Examples/Readme/main.swift](Examples/Readme/main.swift) code if you'd like the try it out.
+NOTE: the code samples here are based on the [Examples/Readme/main.swift](Examples/Readme/main.swift) code if you'd like the try it out. You can also click on `Try in a playground` on the [Swift Package Index page](https://swiftpackageindex.com/splitwise/URLMatcher) to get a generated playground containing this code.
 
 ### Basic matching