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    loop {
80        let Some(character) = characters.next() else {
81            break;
82        };
83
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            loop {
98                let Some(character) = characters.next() else {
99                    break;
100                };
101
102                if character.is_lowercase() || character.is_numeric() {
103                    prefix_length += 1;
104                } else {
105                    break;
106                }
107            }
108
109            break;
110        }
111
112        break;
113    }
114
115    let prefix = &non_class_case_string[..prefix_length];
116    let remaining = &non_class_case_string[prefix_length..];
117    if remaining.is_empty() {
118        return prefix.to_string();
119    }
120
121    if prefix.is_empty() {
122        return cruet::case::to_case_camel_like(
123            non_class_case_string,
124            cruet::case::CamelOptions {
125                new_word: true,
126                last_char: ' ',
127                first_word: false,
128                injectable_char: ' ',
129                has_seperator: false,
130                inverted: false,
131                concat_num: true,
132            },
133        );
134    }
135
136    let mut class_name = crate::to_class_case(remaining);
137    class_name.insert_str(0, prefix);
138
139    class_name
140}
141
142/// Determines if a `&str` is `snake_case` `bool`
143///
144/// Unlike `cruet::case::is_snake_case`, this function allows for
145/// numbers to be included in the string without separating them.
146///
147/// ```
148/// use mago_casing::is_snake_case;
149///
150/// assert!(is_snake_case("foo_2_bar"));
151/// assert!(is_snake_case("foo2bar"));
152/// assert!(is_snake_case("foo_bar"));
153/// assert!(is_snake_case("http_foo_bar"));
154/// assert!(is_snake_case("http_foo_bar"));
155/// assert!(is_snake_case("foo_bar"));
156/// assert!(is_snake_case("foo"));
157/// assert!(!is_snake_case("FooBar"));
158/// assert!(!is_snake_case("FooBarIsAReallyReallyLongString"));
159/// assert!(!is_snake_case("FooBarIsAReallyReallyLongStrings"));
160/// assert!(!is_snake_case("foo-bar-string-that-is-really-really-long"));
161/// ```
162#[must_use]
163pub fn is_snake_case(test_string: &str) -> bool {
164    test_string == to_snake_case(test_string)
165}
166
167/// Converts a `&str` to `snake_case` `String`
168///
169/// Unlike `cruet::case::to_snake_case`, this function allows for
170/// numbers to be included in the string without separating them.
171///
172/// ```
173/// use mago_casing::to_snake_case;
174///
175/// assert_eq!(to_snake_case("foo_2_bar"),  "foo_2_bar");
176/// assert_eq!(to_snake_case("foo_bar"),  "foo_bar");
177/// assert_eq!(to_snake_case("HTTP Foo bar"),  "http_foo_bar");
178/// assert_eq!(to_snake_case("HTTPFooBar"),  "http_foo_bar");
179/// assert_eq!(to_snake_case("Foo bar"),  "foo_bar");
180/// assert_eq!(to_snake_case("Foo Bar"),  "foo_bar");
181/// assert_eq!(to_snake_case("FooBar"),  "foo_bar");
182/// assert_eq!(to_snake_case("FOO_BAR"),  "foo_bar");
183/// assert_eq!(to_snake_case("fooBar"),  "foo_bar");
184/// assert_eq!(to_snake_case("fooBar3"),  "foo_bar3");
185/// assert_eq!(to_snake_case("lower2upper"),  "lower2upper");
186/// ```
187#[must_use]
188pub fn to_snake_case(non_snake_case_string: &str) -> String {
189    let mut first_character: bool = true;
190    let mut last_separator: bool = true;
191    let mut result: String = String::with_capacity(non_snake_case_string.len() * 2);
192
193    for char_with_index in non_snake_case_string.trim_end_matches(|c: char| !c.is_alphanumeric()).char_indices() {
194        if char_with_index.1.is_alphanumeric() {
195            first_character = false;
196            if !last_separator
197                && !first_character
198                && char_with_index.1.is_uppercase()
199                && (non_snake_case_string.chars().nth(char_with_index.0 + 1).unwrap_or('A').is_lowercase()
200                    || non_snake_case_string.chars().nth(char_with_index.0 - 1).unwrap_or('A').is_lowercase())
201            {
202                last_separator = true;
203                result.push('_');
204            } else {
205                last_separator = false;
206            }
207
208            result.push(char_with_index.1.to_ascii_lowercase());
209        } else if !first_character && !last_separator {
210            first_character = true;
211            last_separator = true;
212            result.push('_');
213        }
214    }
215    result
216}
mago_casing/lib.rs

mago_casing/
lib.rs
