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/// ```
45pub fn is_class_case(test_string: &str) -> bool {
46    to_class_case(test_string) == test_string
47}
48
49/// Converts a `&str` to `ClassCase` `String`
50///
51/// Unlike `cruet::case::to_class_case`, this function does not
52/// convert the string to singular form.
53///
54/// ```
55/// use mago_casing::to_class_case;
56///
57/// assert_eq!(to_class_case("UInt"), "UInt");
58/// assert_eq!(to_class_case("Uint"), "Uint");
59/// assert_eq!(to_class_case("Http2Client"), "Http2Client");
60/// assert_eq!(to_class_case("Fl3xxSomething"), "Fl3xxSomething");
61/// assert_eq!(to_class_case("IsUT8Test"), "IsUT8Test");
62/// assert_eq!(to_class_case("HTTP2Client"), "HTTP2Client");
63/// assert_eq!(to_class_case("FooBar"), "FooBar");
64/// assert_eq!(to_class_case("FooBars"), "FooBars");
65/// assert_eq!(to_class_case("foo_bars"), "FooBars");
66/// assert_eq!(to_class_case("Foo Bar"), "FooBar");
67/// assert_eq!(to_class_case("foo-bar"), "FooBar");
68/// assert_eq!(to_class_case("fooBar"), "FooBar");
69/// assert_eq!(to_class_case("Foo_Bar"), "FooBar");
70/// assert_eq!(to_class_case("Foo bar"), "FooBar");
71/// ```
72pub fn to_class_case(non_class_case_string: &str) -> String {
73    // grab the prefix, which is the first N - 1 uppercase characters, leaving only one uppercase
74    // character at the beginning of the string
75    let mut characters = non_class_case_string.chars();
76    let mut prefix_length = 0;
77    loop {
78        let Some(character) = characters.next() else {
79            break;
80        };
81
82        if character.is_uppercase() {
83            prefix_length += 1;
84            continue;
85        }
86
87        if character.is_numeric() {
88            prefix_length += 1;
89            continue;
90        }
91
92        if character.is_lowercase() && prefix_length > 0 {
93            prefix_length += 1;
94
95            loop {
96                let Some(character) = characters.next() else {
97                    break;
98                };
99
100                if character.is_lowercase() || character.is_numeric() {
101                    prefix_length += 1;
102                } else {
103                    break;
104                }
105            }
106
107            break;
108        }
109
110        break;
111    }
112
113    let prefix = &non_class_case_string[..prefix_length];
114    let remaining = &non_class_case_string[prefix_length..];
115    if remaining.is_empty() {
116        return prefix.to_string();
117    }
118
119    if prefix.is_empty() {
120        return cruet::case::to_case_camel_like(
121            non_class_case_string,
122            cruet::case::CamelOptions {
123                new_word: true,
124                last_char: ' ',
125                first_word: false,
126                injectable_char: ' ',
127                has_seperator: false,
128                inverted: false,
129                concat_num: true,
130            },
131        );
132    }
133
134    let mut class_name = crate::to_class_case(remaining);
135    class_name.insert_str(0, prefix);
136
137    class_name
138}
139
140/// Determines if a `&str` is `snake_case` `bool`
141///
142/// Unlike `cruet::case::is_snake_case`, this function allows for
143/// numbers to be included in the string without separating them.
144///
145/// ```
146/// use mago_casing::is_snake_case;
147///
148/// assert!(is_snake_case("foo_2_bar"));
149/// assert!(is_snake_case("foo2bar"));
150/// assert!(is_snake_case("foo_bar"));
151/// assert!(is_snake_case("http_foo_bar"));
152/// assert!(is_snake_case("http_foo_bar"));
153/// assert!(is_snake_case("foo_bar"));
154/// assert!(is_snake_case("foo"));
155/// assert!(!is_snake_case("FooBar"));
156/// assert!(!is_snake_case("FooBarIsAReallyReallyLongString"));
157/// assert!(!is_snake_case("FooBarIsAReallyReallyLongStrings"));
158/// assert!(!is_snake_case("foo-bar-string-that-is-really-really-long"));
159/// ```
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/// ```
184pub fn to_snake_case(non_snake_case_string: &str) -> String {
185    let mut first_character: bool = true;
186    let mut last_separator: bool = true;
187    let mut result: String = String::with_capacity(non_snake_case_string.len() * 2);
188
189    for char_with_index in non_snake_case_string.trim_end_matches(|c: char| !c.is_alphanumeric()).char_indices() {
190        if !char_with_index.1.is_alphanumeric() {
191            if !first_character && !last_separator {
192                first_character = true;
193                last_separator = true;
194                result.push('_');
195            }
196        } else {
197            first_character = false;
198            if !last_separator
199                && !first_character
200                && char_with_index.1.is_uppercase()
201                && (non_snake_case_string.chars().nth(char_with_index.0 + 1).unwrap_or('A').is_lowercase()
202                    || non_snake_case_string.chars().nth(char_with_index.0 - 1).unwrap_or('A').is_lowercase())
203            {
204                last_separator = true;
205                result.push('_');
206            } else {
207                last_separator = false;
208            }
209
210            result.push(char_with_index.1.to_ascii_lowercase());
211        }
212    }
213    result
214}
mago_casing/lib.rs

mago_casing/
lib.rs
