Skip to content

Commit 55395ed

Browse files
bors-servobors-servo
authored
Auto merge of #607 - jplatte:master, r=SimonSapin
Split form_urlencoded into its own crate Resolves #605. I wasn't sure what version to give the new crate, so I went with 1.0.0.
2 parents 06012a9 + bd3922f commit 55395ed

File tree

8 files changed

+284
-32
lines changed

8 files changed

+284
-32
lines changed

Diff for: ‎Cargo.toml

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ travis-ci = { repository = "servo/rust-url" }
1818
appveyor = { repository = "Manishearth/rust-url" }
1919

2020
[workspace]
21-
members = [".", "idna", "percent_encoding", "data-url"]
21+
members = [".", "form_urlencoded", "idna", "percent_encoding", "data-url"]
2222

2323
[[test]]
2424
name = "unit"
@@ -37,6 +37,7 @@ serde_json = "1.0"
3737
bencher = "0.1"
3838

3939
[dependencies]
40+
form_urlencoded = { version = "1.0.0", path = "./form_urlencoded" }
4041
idna = { version = "0.2.0", path = "./idna" }
4142
matches = "0.1"
4243
percent-encoding = { version = "2.1.0", path = "./percent_encoding" }

Diff for: ‎form_urlencoded/Cargo.toml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[package]
2+
name = "form_urlencoded"
3+
version = "1.0.0"
4+
authors = ["The rust-url developers"]
5+
description = "Parser and serializer for the application/x-www-form-urlencoded syntax, as used by HTML forms."
6+
repository = "https://github.com/servo/rust-url"
7+
license = "MIT/Apache-2.0"
8+
9+
[lib]
10+
test = false
11+
12+
[dependencies]
13+
matches = "0.1"
14+
percent-encoding = { version = "2.1.0", path = "../percent_encoding" }

Diff for: ‎form_urlencoded/LICENSE-APACHE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
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+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

Diff for: ‎form_urlencoded/LICENSE-MIT

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Copyright (c) 2013-2016 The rust-url developers
2+
3+
Permission is hereby granted, free of charge, to any
4+
person obtaining a copy of this software and associated
5+
documentation files (the "Software"), to deal in the
6+
Software without restriction, including without
7+
limitation the rights to use, copy, modify, merge,
8+
publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software
10+
is furnished to do so, subject to the following
11+
conditions:
12+
13+
The above copyright notice and this permission notice
14+
shall be included in all copies or substantial portions
15+
of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
18+
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
19+
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
20+
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
21+
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
24+
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25+
DEALINGS IN THE SOFTWARE.

Diff for: ‎src/form_urlencoded.rs renamed to ‎form_urlencoded/src/lib.rs

+10-26
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,19 @@
1313
//! Converts between a string (such as an URL’s query string)
1414
//! and a sequence of (name, value) pairs.
1515
16+
extern crate percent_encoding;
17+
#[macro_use]
18+
extern crate matches;
19+
1620
use percent_encoding::{percent_decode, percent_encode_byte};
17-
use query_encoding::{self, decode_utf8_lossy, EncodingOverride};
21+
use query_encoding::decode_utf8_lossy;
1822
use std::borrow::{Borrow, Cow};
1923
use std::str;
2024

25+
mod query_encoding;
26+
27+
pub use query_encoding::EncodingOverride;
28+
2129
/// Convert a byte string in the `application/x-www-form-urlencoded` syntax
2230
/// into a iterator of (name, value) pairs.
2331
///
@@ -191,30 +199,6 @@ impl<'a> Target for &'a mut String {
191199
type Finished = Self;
192200
}
193201

194-
// `as_mut_string` string here exposes the internal serialization of an `Url`,
195-
// which should not be exposed to users.
196-
// We achieve that by not giving users direct access to `UrlQuery`:
197-
// * Its fields are private
198-
// (and so can not be constructed with struct literal syntax outside of this crate),
199-
// * It has no constructor
200-
// * It is only visible (on the type level) to users in the return type of
201-
// `Url::query_pairs_mut` which is `Serializer<UrlQuery>`
202-
// * `Serializer` keeps its target in a private field
203-
// * Unlike in other `Target` impls, `UrlQuery::finished` does not return `Self`.
204-
impl<'a> Target for ::UrlQuery<'a> {
205-
fn as_mut_string(&mut self) -> &mut String {
206-
&mut self.url.as_mut().unwrap().serialization
207-
}
208-
209-
fn finish(mut self) -> &'a mut ::Url {
210-
let url = self.url.take().unwrap();
211-
url.restore_already_parsed_fragment(self.fragment.take());
212-
url
213-
}
214-
215-
type Finished = &'a mut ::Url;
216-
}
217-
218202
impl<'a, T: Target> Serializer<'a, T> {
219203
/// Create a new `application/x-www-form-urlencoded` serializer for the given target.
220204
///
@@ -299,7 +283,7 @@ impl<'a, T: Target> Serializer<'a, T> {
299283
/// If this serializer was constructed with a string, take and return that string.
300284
///
301285
/// ```rust
302-
/// use url::form_urlencoded;
286+
/// use form_urlencoded;
303287
/// let encoded: String = form_urlencoded::Serializer::new(String::new())
304288
/// .append_pair("foo", "bar & baz")
305289
/// .append_pair("saison", "Été+hiver")

Diff for: ‎src/query_encoding.rs renamed to ‎form_urlencoded/src/query_encoding.rs

File renamed without changes.

Diff for: ‎src/lib.rs

+26-3
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ assert_eq!(css_url.as_str(), "http://servo.github.io/rust-url/main.css");
109109

110110
#[macro_use]
111111
extern crate matches;
112+
pub extern crate form_urlencoded;
112113
extern crate idna;
113114
extern crate percent_encoding;
114115
#[cfg(feature = "serde")]
@@ -132,21 +133,19 @@ use std::str;
132133

133134
use std::convert::TryFrom;
134135

136+
pub use form_urlencoded::EncodingOverride;
135137
pub use host::Host;
136138
pub use origin::{OpaqueOrigin, Origin};
137139
pub use parser::{ParseError, SyntaxViolation};
138140
pub use path_segments::PathSegmentsMut;
139-
pub use query_encoding::EncodingOverride;
140141
pub use slicing::Position;
141142

142143
mod host;
143144
mod origin;
144145
mod parser;
145146
mod path_segments;
146-
mod query_encoding;
147147
mod slicing;
148148

149-
pub mod form_urlencoded;
150149
#[doc(hidden)]
151150
pub mod quirks;
152151

@@ -2668,6 +2667,30 @@ pub struct UrlQuery<'a> {
26682667
fragment: Option<String>,
26692668
}
26702669

2670+
// `as_mut_string` string here exposes the internal serialization of an `Url`,
2671+
// which should not be exposed to users.
2672+
// We achieve that by not giving users direct access to `UrlQuery`:
2673+
// * Its fields are private
2674+
// (and so can not be constructed with struct literal syntax outside of this crate),
2675+
// * It has no constructor
2676+
// * It is only visible (on the type level) to users in the return type of
2677+
// `Url::query_pairs_mut` which is `Serializer<UrlQuery>`
2678+
// * `Serializer` keeps its target in a private field
2679+
// * Unlike in other `Target` impls, `UrlQuery::finished` does not return `Self`.
2680+
impl<'a> form_urlencoded::Target for UrlQuery<'a> {
2681+
fn as_mut_string(&mut self) -> &mut String {
2682+
&mut self.url.as_mut().unwrap().serialization
2683+
}
2684+
2685+
fn finish(mut self) -> &'a mut Url {
2686+
let url = self.url.take().unwrap();
2687+
url.restore_already_parsed_fragment(self.fragment.take());
2688+
url
2689+
}
2690+
2691+
type Finished = &'a mut Url;
2692+
}
2693+
26712694
impl<'a> Drop for UrlQuery<'a> {
26722695
fn drop(&mut self) {
26732696
if let Some(url) = self.url.take() {

0 commit comments

Comments
 (0)