mago_casing/lib.rs
1#![allow(clippy::pub_use)]
2
3pub use cruet::case::camel::is_camel_case;
4pub use cruet::case::camel::to_camel_case;
5pub use cruet::case::kebab::is_kebab_case;
6pub use cruet::case::kebab::to_kebab_case;
7pub use cruet::case::pascal::is_pascal_case;
8pub use cruet::case::pascal::to_pascal_case;
9pub use cruet::case::screaming_snake::is_screaming_snake_case as is_constant_case;
10pub use cruet::case::screaming_snake::to_screaming_snake_case as to_constant_case;
11pub use cruet::case::sentence::is_sentence_case;
12pub use cruet::case::sentence::to_sentence_case;
13pub use cruet::case::table::is_table_case;
14pub use cruet::case::table::to_table_case;
15pub use cruet::case::title::is_title_case;
16pub use cruet::case::title::to_title_case;
17pub use cruet::case::train::is_train_case;
18pub use cruet::case::train::to_train_case;
19
20/// Determines if a `&str` is `ClassCase` `bool`
21///
22/// Unlike `cruet::case::is_class_case`, this function does not
23/// require the string to be in singular form.
24///
25/// ```
26/// use mago_casing::is_class_case;
27///
28/// assert!(is_class_case("Foo"));
29/// assert!(is_class_case("FooBarIsAReallyReallyLongString"));
30/// assert!(is_class_case("FooBarIsAReallyReallyLongStrings"));
31/// assert!(is_class_case("UInt"));
32/// assert!(is_class_case("Uint"));
33/// assert!(is_class_case("Http2Client"));
34/// assert!(is_class_case("Fl3xxSomething"));
35/// assert!(is_class_case("IsUT8Test"));
36/// assert!(is_class_case("HTTP2Client"));
37///
38/// assert!(!is_class_case("foo"));
39/// assert!(!is_class_case("foo-bar-string-that-is-really-really-long"));
40/// assert!(!is_class_case("foo_bar_is_a_really_really_long_strings"));
41/// assert!(!is_class_case("fooBarIsAReallyReallyLongString"));
42/// assert!(!is_class_case("FOO_BAR_STRING_THAT_IS_REALLY_REALLY_LONG"));
43/// assert!(!is_class_case("foo_bar_string_that_is_really_really_long"));
44/// assert!(!is_class_case("Foo bar string that is really really long"));
45/// assert!(!is_class_case("Foo Bar Is A Really Really Long String"));
46/// ```
47#[inline]
48#[must_use]
49pub fn is_class_case(test_string: &str) -> bool {
50 to_class_case(test_string) == test_string
51}
52
53/// Converts a `&str` to `ClassCase` `String`
54///
55/// Unlike `cruet::case::to_class_case`, this function does not
56/// convert the string to singular form.
57///
58/// ```
59/// use mago_casing::to_class_case;
60///
61/// assert_eq!(to_class_case("UInt"), "UInt");
62/// assert_eq!(to_class_case("Uint"), "Uint");
63/// assert_eq!(to_class_case("Http2Client"), "Http2Client");
64/// assert_eq!(to_class_case("Fl3xxSomething"), "Fl3xxSomething");
65/// assert_eq!(to_class_case("IsUT8Test"), "IsUT8Test");
66/// assert_eq!(to_class_case("HTTP2Client"), "HTTP2Client");
67/// assert_eq!(to_class_case("FooBar"), "FooBar");
68/// assert_eq!(to_class_case("FooBars"), "FooBars");
69/// assert_eq!(to_class_case("foo_bars"), "FooBars");
70/// assert_eq!(to_class_case("Foo Bar"), "FooBar");
71/// assert_eq!(to_class_case("foo-bar"), "FooBar");
72/// assert_eq!(to_class_case("fooBar"), "FooBar");
73/// assert_eq!(to_class_case("Foo_Bar"), "FooBar");
74/// assert_eq!(to_class_case("Foo bar"), "FooBar");
75/// ```
76#[inline]
77#[must_use]
78pub fn to_class_case(non_class_case_string: &str) -> String {
79 // grab the prefix, which is the first N - 1 uppercase characters, leaving only one uppercase
80 // character at the beginning of the string
81 let mut characters = non_class_case_string.chars();
82 let mut prefix_length = 0;
83 while let Some(character) = characters.next() {
84 if character.is_uppercase() {
85 prefix_length += 1;
86 continue;
87 }
88
89 if character.is_numeric() {
90 prefix_length += 1;
91 continue;
92 }
93
94 if character.is_lowercase() && prefix_length > 0 {
95 prefix_length += 1;
96
97 for character in characters.by_ref() {
98 if character.is_lowercase() || character.is_numeric() {
99 prefix_length += 1;
100 } else {
101 break;
102 }
103 }
104
105 break;
106 }
107
108 break;
109 }
110
111 let prefix = &non_class_case_string[..prefix_length];
112 let remaining = &non_class_case_string[prefix_length..];
113 if remaining.is_empty() {
114 return prefix.to_string();
115 }
116
117 if prefix.is_empty() {
118 return cruet::case::to_case_camel_like(
119 non_class_case_string,
120 cruet::case::CamelOptions {
121 new_word: true,
122 last_char: ' ',
123 first_word: false,
124 injectable_char: ' ',
125 has_seperator: false,
126 inverted: false,
127 concat_num: true,
128 },
129 );
130 }
131
132 let mut class_name = crate::to_class_case(remaining);
133 class_name.insert_str(0, prefix);
134
135 class_name
136}
137
138/// Determines if a `&str` is `snake_case` `bool`
139///
140/// Unlike `cruet::case::is_snake_case`, this function allows for
141/// numbers to be included in the string without separating them.
142///
143/// ```
144/// use mago_casing::is_snake_case;
145///
146/// assert!(is_snake_case("foo_2_bar"));
147/// assert!(is_snake_case("foo2bar"));
148/// assert!(is_snake_case("foo_bar"));
149/// assert!(is_snake_case("http_foo_bar"));
150/// assert!(is_snake_case("http_foo_bar"));
151/// assert!(is_snake_case("foo_bar"));
152/// assert!(is_snake_case("foo"));
153/// assert!(!is_snake_case("FooBar"));
154/// assert!(!is_snake_case("FooBarIsAReallyReallyLongString"));
155/// assert!(!is_snake_case("FooBarIsAReallyReallyLongStrings"));
156/// assert!(!is_snake_case("foo-bar-string-that-is-really-really-long"));
157/// ```
158#[inline]
159#[must_use]
160pub fn is_snake_case(test_string: &str) -> bool {
161 test_string == to_snake_case(test_string)
162}
163
164/// Converts a `&str` to `snake_case` `String`
165///
166/// Unlike `cruet::case::to_snake_case`, this function allows for
167/// numbers to be included in the string without separating them.
168///
169/// ```
170/// use mago_casing::to_snake_case;
171///
172/// assert_eq!(to_snake_case("foo_2_bar"), "foo_2_bar");
173/// assert_eq!(to_snake_case("foo_bar"), "foo_bar");
174/// assert_eq!(to_snake_case("HTTP Foo bar"), "http_foo_bar");
175/// assert_eq!(to_snake_case("HTTPFooBar"), "http_foo_bar");
176/// assert_eq!(to_snake_case("Foo bar"), "foo_bar");
177/// assert_eq!(to_snake_case("Foo Bar"), "foo_bar");
178/// assert_eq!(to_snake_case("FooBar"), "foo_bar");
179/// assert_eq!(to_snake_case("FOO_BAR"), "foo_bar");
180/// assert_eq!(to_snake_case("fooBar"), "foo_bar");
181/// assert_eq!(to_snake_case("fooBar3"), "foo_bar3");
182/// assert_eq!(to_snake_case("lower2upper"), "lower2upper");
183/// ```
184#[inline]
185#[must_use]
186pub fn to_snake_case(non_snake_case_string: &str) -> String {
187 let mut first_character = true;
188 let mut last_separator = true;
189 let mut result = String::with_capacity(non_snake_case_string.len() * 2);
190
191 for char_with_index in non_snake_case_string.trim_end_matches(|c: char| !c.is_alphanumeric()).char_indices() {
192 if char_with_index.1.is_alphanumeric() {
193 first_character = false;
194 if !last_separator
195 && !first_character
196 && char_with_index.1.is_uppercase()
197 && (non_snake_case_string.chars().nth(char_with_index.0 + 1).unwrap_or('A').is_lowercase()
198 || non_snake_case_string.chars().nth(char_with_index.0 - 1).unwrap_or('A').is_lowercase())
199 {
200 last_separator = true;
201 result.push('_');
202 } else {
203 last_separator = false;
204 }
205
206 result.push(char_with_index.1.to_ascii_lowercase());
207 } else if !first_character && !last_separator {
208 first_character = true;
209 last_separator = true;
210 result.push('_');
211 } else {
212 // Non-alphanumeric character at the start or after another separator: skip it.
213 }
214 }
215
216 result
217}