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