Skip to content

Commit f15932f

Browse files
coenttbcoenttb
committed
fix: replace fatalError with proper error handling
Replaced all fatalError calls in superEncoder/superDecoder methods with proper error handling following established patterns. Changes: - FormEncoder: Created ThrowingStubEncoder to handle superEncoder() methods - Cannot throw per protocol, so returns stub that throws on use - Provides clear error messages about unsupported operations - FormDecoder: Replaced fatalError with proper throw in superDecoder() - All 218 tests pass This ensures no crashes and follows the pattern of never using fatalError or precondition.
0 parents  commit f15932f

28 files changed

+7867
-0
lines changed

‎.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+
/*.xcodeproj
5+
xcuserdata/
6+
DerivedData/
7+
.swiftpm/
8+
Package.resolved

‎LICENSE‎

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

‎Package.swift‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
// swift-tools-version:6.1
2+
3+
import PackageDescription
4+
5+
extension String {
6+
static let urlFormCoding: Self = "URLFormCoding"
7+
static let urlFormCodingURLRouting: Self = "URLFormCodingURLRouting"
8+
}
9+
10+
extension Target.Dependency {
11+
static var urlFormCoding: Self { .target(name: .urlFormCoding) }
12+
static var urlFormCodingURLRouting: Self { .target(name: .urlFormCodingURLRouting) }
13+
static var rfc2388: Self { .product(name: "RFC 2388", package: "swift-rfc-2388") }
14+
static var whatwgUrlEncoding: Self { .product(name: "WHATWG URL Encoding", package: "swift-whatwg-url-encoding") }
15+
static var urlRouting: Self { .product(name: "URLRouting", package: "swift-url-routing") }
16+
}
17+
18+
let package = Package(
19+
name: "swift-url-form-coding",
20+
platforms: [
21+
.macOS(.v14),
22+
.iOS(.v17),
23+
.tvOS(.v17),
24+
.watchOS(.v10)
25+
],
26+
products: [
27+
.library(name: .urlFormCoding, targets: [.urlFormCoding]),
28+
.library(name: .urlFormCodingURLRouting, targets: [.urlFormCodingURLRouting])
29+
],
30+
dependencies: [
31+
.package(path: "../../swift-standards/swift-rfc-2388"),
32+
.package(url: "https://github.com/swift-standards/swift-whatwg-url-encoding.git", from: "0.1.0"),
33+
.package(url: "https://github.com/pointfreeco/swift-url-routing", from: "0.6.0")
34+
],
35+
targets: [
36+
.target(
37+
name: .urlFormCoding,
38+
dependencies: [
39+
.rfc2388,
40+
.whatwgUrlEncoding
41+
]
42+
),
43+
.testTarget(
44+
name: .urlFormCoding.tests,
45+
dependencies: [
46+
.urlFormCoding
47+
]
48+
),
49+
.target(
50+
name: .urlFormCodingURLRouting,
51+
dependencies: [
52+
.urlRouting,
53+
.urlFormCoding
54+
]
55+
),
56+
.testTarget(
57+
name: .urlFormCodingURLRouting.tests,
58+
dependencies: [
59+
.urlFormCoding,
60+
.urlFormCodingURLRouting
61+
]
62+
)
63+
]
64+
)
65+
66+
extension String { var tests: Self { self + " Tests" } }

‎README.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# swift-url-form-coding
2+
3+
A Swift package for encoding and decoding `application/x-www-form-urlencoded` data with Codable support.
4+
5+
## Overview
6+
7+
`swift-url-form-coding` provides type-safe conversion between Swift's Codable types and URL-encoded form data, the standard format used by HTML forms and many web APIs.
8+
9+
## Features
10+
11+
- ✅ **Codable Integration**: Seamlessly encode/decode Swift types to/from form data
12+
- ✅ **Multiple Encoding Strategies**: Support for PHP-style brackets, indexed arrays, and more
13+
- ✅ **URLRouting Integration**: First-class support for PointFree's URLRouting
14+
- ✅ **RFC Compliant**: Built on [RFC 2388](https://datatracker.ietf.org/doc/html/rfc2388) and [WHATWG URL Encoding](https://url.spec.whatwg.org/)
15+
- ✅ **Swift 6.0**: Full strict concurrency support
16+
- ✅ **Comprehensive Tests**: 218 tests covering edge cases and round-trip conversions
17+
18+
## Installation
19+
20+
Add this package to your `Package.swift`:
21+
22+
```swift
23+
dependencies: [
24+
.package(url: "https://github.com/coenttb/swift-url-form-coding", from: "0.1.0")
25+
]
26+
```
27+
28+
Then add the product to your target:
29+
30+
```swift
31+
.target(
32+
name: "YourTarget",
33+
dependencies: [
34+
.product(name: "URLFormCoding", package: "swift-url-form-coding")
35+
]
36+
)
37+
```
38+
39+
## Quick Start
40+
41+
### Basic Encoding/Decoding
42+
43+
```swift
44+
import URLFormCoding
45+
46+
struct User: Codable {
47+
let name: String
48+
let email: String
49+
let age: Int
50+
}
51+
52+
// Encoding
53+
let encoder = Form.Encoder()
54+
let user = User(name: "John Doe", email: "john@example.com", age: 30)
55+
let formData = try encoder.encode(user)
56+
// Result: "name=John%20Doe&email=john%40example.com&age=30"
57+
58+
// Decoding
59+
let decoder = Form.Decoder()
60+
let decodedUser = try decoder.decode(User.self, from: formData)
61+
```
62+
63+
### Array Encoding Strategies
64+
65+
```swift
66+
struct SearchQuery: Codable {
67+
let tags: [String]
68+
}
69+
70+
let query = SearchQuery(tags: ["swift", "ios", "server"])
71+
72+
// Accumulate Values (default)
73+
let encoder1 = Form.Encoder()
74+
encoder1.arrayEncodingStrategy = .accumulateValues
75+
// Result: "tags=swift&tags=ios&tags=server"
76+
77+
// Brackets (PHP/Rails style)
78+
let encoder2 = Form.Encoder()
79+
encoder2.arrayEncodingStrategy = .brackets
80+
// Result: "tags[]=swift&tags[]=ios&tags[]=server"
81+
82+
// Indexed Brackets
83+
let encoder3 = Form.Encoder()
84+
encoder3.arrayEncodingStrategy = .bracketsWithIndices
85+
// Result: "tags[0]=swift&tags[1]=ios&tags[2]=server"
86+
```
87+
88+
### URLRouting Integration
89+
90+
```swift
91+
import URLFormCodingURLRouting
92+
import URLRouting
93+
94+
struct ContactForm: Codable {
95+
let name: String
96+
let email: String
97+
let message: String
98+
}
99+
100+
let contactRoute = Route {
101+
Method.post
102+
Path { "contact" }
103+
Body(.form(ContactForm.self))
104+
}
105+
```
106+
107+
## Modules
108+
109+
- **URLFormCoding**: Core encoding/decoding functionality
110+
- **URLFormCodingURLRouting**: Integration with PointFree's [swift-url-routing](https://github.com/pointfreeco/swift-url-routing)
111+
112+
## Dependencies
113+
114+
- [swift-rfc-2388](https://github.com/swift-standards/swift-rfc-2388) - Form data parsing/encoding strategies
115+
- [swift-whatwg-url-encoding](https://github.com/swift-standards/swift-whatwg-url-encoding) - Percent encoding
116+
- [swift-url-routing](https://github.com/pointfreeco/swift-url-routing) - URLRouting integration
117+
118+
## License
119+
120+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
121+
122+
## Related Packages
123+
124+
- [swift-multipart-form-coding](https://github.com/coenttb/swift-multipart-form-coding) - Multipart form data encoding with file uploads
125+
- [swift-form-coding](https://github.com/coenttb/swift-form-coding) - Umbrella package that re-exports both
126+
127+
## Credits
128+
129+
Originally based on PointFree's `UrlFormEncoding` from [swift-web](https://github.com/pointfreeco/swift-web), modernized with RFC compliance and URLRouting integration.

0 commit comments

Comments
 (0)