├── .gitignore ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── benches └── main.rs └── src └── lib.rs /.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "slug" 3 | keywords = ["slugify", "slug", "id"] 4 | version = "0.1.6" 5 | authors = ["Steven Allen "] 6 | edition = "2021" 7 | description = "Convert a unicode string to a slug" 8 | license = "MIT/Apache-2.0" 9 | readme = "README.md" 10 | 11 | repository = "https://github.com/Stebalien/slug-rs" 12 | homepage = "https://github.com/Stebalien/slug-rs" 13 | documentation = "https://docs.rs/slug" 14 | 15 | [lib] 16 | crate-type = ["cdylib", "rlib"] 17 | 18 | [dependencies] 19 | deunicode = "1" 20 | 21 | [target.'cfg(target_family = "wasm")'.dependencies] 22 | wasm-bindgen = "0.2" 23 | 24 | [target.'cfg(target_family = "wasm")'.dev-dependencies] 25 | wasm-bindgen-test = "0.3" 26 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 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. 202 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2015 Steven Allen 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. 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # slug 2 | A small library for generating [slugs][wikipedia] from unicode strings. 3 | 4 | Documentation: https://docs.rs/slug 5 | 6 | [wikipedia]: https://en.wikipedia.org/wiki/Semantic_URL#Slug 7 | 8 | ## Usage 9 | ```rust 10 | extern crate slug; 11 | use slug::slugify; 12 | 13 | let slug = slugify("Hello world"); 14 | ``` 15 | -------------------------------------------------------------------------------- /benches/main.rs: -------------------------------------------------------------------------------- 1 | #![feature(test)] 2 | extern crate slug; 3 | extern crate test; 4 | 5 | #[bench] 6 | fn bench_slug(b: &mut test::Bencher) { 7 | use slug::slugify; 8 | b.iter(|| { 9 | test::black_box(slugify(test::black_box("My test Slug!!"))); 10 | test::black_box(slugify(test::black_box("Test Slug2!!"))); 11 | test::black_box(slugify(test::black_box("Æúűűűű--cool?"))); 12 | test::black_box(slugify(test::black_box("long long long long long"))); 13 | }) 14 | } 15 | 16 | #[bench] 17 | fn bench_slug_normal(b: &mut test::Bencher) { 18 | use slug::slugify; 19 | b.iter(|| { 20 | test::black_box(slugify(test::black_box("My test Slug!!"))); 21 | test::black_box(slugify(test::black_box("Some other.. slug"))); 22 | test::black_box(slugify(test::black_box( 23 | "CAPSLOCK IS AN AUTOPILOT FOR COOL", 24 | ))); 25 | }) 26 | } 27 | 28 | #[bench] 29 | fn bench_unicode(b: &mut test::Bencher) { 30 | use slug::slugify; 31 | b.iter(|| { 32 | test::black_box(slugify(test::black_box("Æúűűűű--cool?"))); 33 | test::black_box(slugify(test::black_box("മലയാലമ്げんまい茶??"))); 34 | }) 35 | } 36 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | use deunicode::deunicode_char; 2 | #[cfg(target_family = "wasm")] 3 | use wasm_bindgen::prelude::*; 4 | 5 | /// Convert any unicode string to an ascii "slug" (useful for file names/url components) 6 | /// 7 | /// The returned "slug" will consist of a-z, 0-9, and '-'. Furthermore, a slug will 8 | /// never contain more than one '-' in a row and will never start or end with '-'. 9 | /// 10 | /// ```rust 11 | /// use self::slug::slugify; 12 | /// 13 | /// assert_eq!(slugify("My Test String!!!1!1"), "my-test-string-1-1"); 14 | /// assert_eq!(slugify("test\nit now!"), "test-it-now"); 15 | /// assert_eq!(slugify(" --test_-_cool"), "test-cool"); 16 | /// assert_eq!(slugify("Æúű--cool?"), "aeuu-cool"); 17 | /// assert_eq!(slugify("You & Me"), "you-me"); 18 | /// assert_eq!(slugify("user@example.com"), "user-example-com"); 19 | /// ``` 20 | pub fn slugify>(s: S) -> String { 21 | _slugify(s.as_ref()) 22 | } 23 | 24 | #[doc(hidden)] 25 | #[cfg(target_family = "wasm")] 26 | #[wasm_bindgen(js_name = slugify)] 27 | pub fn slugify_owned(s: String) -> String { 28 | _slugify(s.as_ref()) 29 | } 30 | 31 | // avoid unnecessary monomorphizations 32 | fn _slugify(s: &str) -> String { 33 | let mut slug = String::with_capacity(s.len()); 34 | // Starts with true to avoid leading - 35 | let mut prev_is_dash = true; 36 | { 37 | let mut push_char = |x: u8| { 38 | match x { 39 | b'a'..=b'z' | b'0'..=b'9' => { 40 | prev_is_dash = false; 41 | slug.push(x.into()); 42 | } 43 | b'A'..=b'Z' => { 44 | prev_is_dash = false; 45 | // Manual lowercasing as Rust to_lowercase() is unicode 46 | // aware and therefore much slower 47 | slug.push((x - b'A' + b'a').into()); 48 | } 49 | _ => { 50 | if !prev_is_dash { 51 | slug.push('-'); 52 | prev_is_dash = true; 53 | } 54 | } 55 | } 56 | }; 57 | 58 | for c in s.chars() { 59 | if c.is_ascii() { 60 | (push_char)(c as u8); 61 | } else { 62 | for &cx in deunicode_char(c).unwrap_or("-").as_bytes() { 63 | (push_char)(cx); 64 | } 65 | } 66 | } 67 | } 68 | 69 | if slug.ends_with('-') { 70 | slug.pop(); 71 | } 72 | // We likely reserved more space than needed. 73 | slug.shrink_to_fit(); 74 | slug 75 | } 76 | --------------------------------------------------------------------------------