Skip to content

Commit 43405ec

Browse files
daniel-bearddaniel-beard
committed
Open source URLMatcher
0 parents  commit 43405ec

12 files changed

Lines changed: 1399 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.DS_Store
2+
/.build
3+
/Packages
4+
xcuserdata/
5+
DerivedData/
6+
.swiftpm/configuration/registries.json
7+
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
8+
.netrc

‎Examples/BasicDemo/main.swift‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
import URLMatcher
2+
import Foundation
3+
4+
var matcher = URLMatcher<String>()
5+
6+
print("default handling")
7+
8+
try matcher.add(path:"/root/path/<*>") { "default handling" }
9+
10+
matcher.matchURL(URL(string:"http://example.com")!)
11+
matcher.matchURL(URL(string:"http://example.com/root/path")!)
12+
matcher.matchURL(URL(string:"myprefix://example.com/root/path")!)
13+
matcher.matchURL(URL(string:"https://example.com/root/path/more/path")!)
14+
15+
try matcher.add(path:"/root/path/more/path") { "more path handling" }
16+
17+
matcher.matchURL(URL(string:"http://example.com/root/path/more/path")!)
18+
19+
try matcher.add(path:"/root/path/query") { (params, _) -> String in
20+
return "\(params)"
21+
}
22+
23+
matcher.matchURL(URL(string:"http://example.com/root/path/query?test=true")!)
24+
25+
try matcher.add(path:"/root/user/<email: String>") { (_, values) -> String in
26+
return values["email"] as! String
27+
}
28+
29+
matcher.matchURL(URL(string:"http://example.com/root/user/test@example.com")!)
30+
matcher.matchURL(URL(string:"http://example.com/root/user/different_test@example.com")!)
31+
32+
try! matcher.add(path:"/root/path/<resourceId: UUID>") { (params, values) -> String in
33+
return "Resource id: \(values["resourceId"]!), title: \(params["title"] ?? "")"
34+
}
35+
36+
try! matcher.add(path:"/root/path/<resourceId: Int64>") { (params, values) -> String in
37+
return "Resource id: \(values["resourceId"]!), title: \(params["title"] ?? "")"
38+
}
39+
40+
matcher.matchURL(URL(string:"https://example.com/root/path/\(UUID())")!)
41+
42+
matcher.matchURL(URL(string: "https://example.com/root/path/64?title=Bears")!)
43+

‎Examples/Readme/main.swift‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
import Foundation
2+
import URLMatcher
3+
4+
enum URLAction {
5+
case login, signup, invite(key: String)
6+
}
7+
8+
// Quick start example
9+
var matcher = URLMatcher<URLAction>()
10+
11+
try matcher.add(path: "user/login") { .login }
12+
try matcher.add(path: "user/signup") { .signup }
13+
try matcher.add(path: "user/invite/<key: String>") {(_, values) in
14+
.invite(key: values["key"] as! String)
15+
}
16+
17+
// Grab your url from your web view or app delegate method
18+
let url = URL(string:"http://mydomain.com/user/invite/y78gyug76g")!
19+
20+
if let action = matcher.matchURL(url) {
21+
switch action {
22+
case .login, .signup:
23+
print("Show welcome form")
24+
case .invite(let key):
25+
// Show loading overlay
26+
// Look up invite from the server
27+
// Dismiss the loading overlay
28+
// If available, show the accept invite flow
29+
// If not, show an error alert
30+
print("Load invite: \(key)")
31+
}
32+
} else {
33+
// We don't know what to do with this URL, fallback on the system
34+
}
35+
36+
// Matching example
37+
struct UserAction {
38+
let userId: Int64?
39+
let action: String
40+
}
41+
extension UserAction: CustomDebugStringConvertible {
42+
var debugDescription: String {
43+
if let userId = userId {
44+
return "\(action) user \(userId)"
45+
} else {
46+
return "\(action) user"
47+
}
48+
}
49+
}
50+
51+
var userMatcher = URLMatcher<UserAction>()
52+
53+
try userMatcher.add(path: "user/<userId:Int64>/edit") { (_, values: [String : Any]) -> UserAction in
54+
return UserAction(userId: values["userId"] as? Int64, action: "edit")
55+
}
56+
57+
try userMatcher.add(path: "user/<userId:Int64>/<*>") { (query: [String: String], values: [String : Any]) -> UserAction in
58+
if query["force_update"] == "true" {
59+
return UserAction(userId: values["userId"] as? Int64, action: "update app")
60+
} else {
61+
return UserAction(userId: values["userId"] as? Int64, action: "show")
62+
}
63+
}
64+
65+
try userMatcher.add(path: "user/<+>/<*>") { return UserAction(userId: nil, action: "unknown") }
66+
67+
var action = userMatcher.matchURL(URL(string:"user/6578/edit")!)
68+
print(action!)
69+
70+
action = userMatcher.matchURL(URL(string:"user/890822/verify/email")!)
71+
print(action!)
72+
73+
action = userMatcher.matchURL(URL(string:"user/890822/verify/email?force_update=true")!)
74+
print(action!)
75+
76+
action = userMatcher.matchURL(URL(string:"user/an.email@example.com/verify/email")!)
77+
print(action!)
78+
79+
80+
// Wildcard example
81+
var wildcardMatcher = URLMatcher<String>()
82+
83+
try wildcardMatcher.add(path: "a/<+>") { "a" }
84+
try wildcardMatcher.add(path: "<+>/b") { "b" }
85+
86+
var wildcard = wildcardMatcher.matchURL(URL(string:"a/b")!)
87+
wildcard = wildcardMatcher.matchURL(URL(string: "c/b")!)
88+
89+
90+
// Custom components example
91+
struct Commit : ComponentMatchable {
92+
func matches(urlComponent: String) -> Bool {
93+
return "c" == urlComponent || "commit" == urlComponent
94+
}
95+
}
96+
97+
struct HashId: ComponentParseable {
98+
let label: String
99+
100+
func matches(urlComponent: String) -> Bool {
101+
return valueOf(urlComponent: urlComponent) != nil
102+
}
103+
104+
func valueOf(urlComponent: String) -> Any? {
105+
// Should actually validate more completely, not great string handling
106+
if 7 == urlComponent.count || 40 == urlComponent.count {
107+
return String(urlComponent.prefix(7))
108+
} else {
109+
return nil
110+
}
111+
}
112+
}
113+
114+
var commitMatcher = URLMatcher<String>()
115+
116+
commitMatcher.registerType(name: "Commit") { (_) in Commit() }
117+
commitMatcher.registerType(name: "HashId") { HashId(label: $0) }
118+
119+
try commitMatcher.add(path: "<Commit>/<commitId:HashId>") { (_, values: [String : Any]) -> String in
120+
return values["commitId"] as! String
121+
}
122+
123+
var commit = commitMatcher.matchURL(URL(string:"/c/7h1uh89")!)
124+
print(commit!)
125+
126+
commit = commitMatcher.matchURL(URL(string:"/commit/7h1uh8927e39434ae8da5fuy6c1de98c56c09410")!)
127+
print(commit!)
128+
129+
130+

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)