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///
30/// assert!(!is_class_case("foo"));
31/// assert!(!is_class_case("foo-bar-string-that-is-really-really-long"));
32/// assert!(!is_class_case("foo_bar_is_a_really_really_long_strings"));
33/// assert!(!is_class_case("fooBarIsAReallyReallyLongString"));
34/// assert!(!is_class_case("FOO_BAR_STRING_THAT_IS_REALLY_REALLY_LONG"));
35/// assert!(!is_class_case("foo_bar_string_that_is_really_really_long"));
36/// assert!(!is_class_case("Foo bar string that is really really long"));
37/// assert!(!is_class_case("Foo Bar Is A Really Really Long String"));
38/// ```
39pub fn is_class_case(test_string: &str) -> bool {
40    to_class_case(test_string) == test_string
41}
42
43/// Converts a `&str` to `ClassCase` `String`
44///
45/// Unlike `cruet::case::to_class_case`, this function does not
46/// convert the string to singular form.
47///
48/// ```
49/// use mago_casing::to_class_case;
50///
51/// assert_eq!(to_class_case("UInt"), "UInt");
52/// assert_eq!(to_class_case("Uint"), "Uint");
53/// assert_eq!(to_class_case("Http2Client"), "Http2Client");
54/// assert_eq!(to_class_case("HTTP2Client"), "HTTP2Client");
55/// assert_eq!(to_class_case("FooBar"), "FooBar");
56/// assert_eq!(to_class_case("FooBars"), "FooBars");
57/// assert_eq!(to_class_case("foo_bars"), "FooBars");
58/// assert_eq!(to_class_case("Foo Bar"), "FooBar");
59/// assert_eq!(to_class_case("foo-bar"), "FooBar");
60/// assert_eq!(to_class_case("fooBar"), "FooBar");
61/// assert_eq!(to_class_case("Foo_Bar"), "FooBar");
62/// assert_eq!(to_class_case("Foo bar"), "FooBar");
63/// ```
64pub fn to_class_case(non_class_case_string: &str) -> String {
65    // grab the prefix, which is the first N - 1 uppercase characters, leaving only one uppercase
66    // character at the beginning of the string
67    let mut characters = non_class_case_string.chars();
68    let mut prefix_length = 0;
69    loop {
70        let Some(character) = characters.next() else {
71            break;
72        };
73
74        if character.is_uppercase() {
75            prefix_length += 1;
76            continue;
77        }
78
79        if character.is_numeric() {
80            prefix_length += 1;
81            continue;
82        }
83
84        if character.is_lowercase() {
85            prefix_length += 1;
86
87            loop {
88                let Some(character) = characters.next() else {
89                    break;
90                };
91
92                if character.is_lowercase() || character.is_numeric() {
93                    prefix_length += 1;
94                } else {
95                    break;
96                }
97            }
98
99            prefix_length += 1;
100
101            break;
102        }
103
104        break;
105    }
106
107    let options = cruet::case::CamelOptions {
108        new_word: true,
109        last_char: ' ',
110        first_word: false,
111        injectable_char: ' ',
112        has_seperator: false,
113        inverted: false,
114        concat_num: true,
115    };
116
117    if prefix_length == 0 {
118        return cruet::case::to_case_camel_like(non_class_case_string, options);
119    }
120
121    let prefix = &non_class_case_string[..prefix_length - 1];
122    let remaining = &non_class_case_string[prefix_length - 1..];
123
124    let mut class_name = cruet::case::to_case_camel_like(remaining, options);
125    class_name.insert_str(0, prefix);
126
127    class_name
128}
129
130/// Determines if a `&str` is `snake_case` `bool`
131///
132/// Unlike `cruet::case::is_snake_case`, this function allows for
133/// numbers to be included in the string without separating them.
134///
135/// ```
136/// use mago_casing::is_snake_case;
137///
138/// assert!(is_snake_case("foo_2_bar"));
139/// assert!(is_snake_case("foo2bar"));
140/// assert!(is_snake_case("foo_bar"));
141/// assert!(is_snake_case("http_foo_bar"));
142/// assert!(is_snake_case("http_foo_bar"));
143/// assert!(is_snake_case("foo_bar"));
144/// assert!(is_snake_case("foo"));
145/// assert!(!is_snake_case("FooBar"));
146/// assert!(!is_snake_case("FooBarIsAReallyReallyLongString"));
147/// assert!(!is_snake_case("FooBarIsAReallyReallyLongStrings"));
148/// assert!(!is_snake_case("foo-bar-string-that-is-really-really-long"));
149/// ```
150pub fn is_snake_case(test_string: &str) -> bool {
151    test_string == to_snake_case(test_string)
152}
153
154/// Converts a `&str` to `snake_case` `String`
155///
156/// Unlike `cruet::case::to_snake_case`, this function allows for
157/// numbers to be included in the string without separating them.
158///
159/// ```
160/// use mago_casing::to_snake_case;
161///
162/// assert_eq!(to_snake_case("foo_2_bar"),  "foo_2_bar");
163/// assert_eq!(to_snake_case("foo_bar"),  "foo_bar");
164/// assert_eq!(to_snake_case("HTTP Foo bar"),  "http_foo_bar");
165/// assert_eq!(to_snake_case("HTTPFooBar"),  "http_foo_bar");
166/// assert_eq!(to_snake_case("Foo bar"),  "foo_bar");
167/// assert_eq!(to_snake_case("Foo Bar"),  "foo_bar");
168/// assert_eq!(to_snake_case("FooBar"),  "foo_bar");
169/// assert_eq!(to_snake_case("FOO_BAR"),  "foo_bar");
170/// assert_eq!(to_snake_case("fooBar"),  "foo_bar");
171/// assert_eq!(to_snake_case("fooBar3"),  "foo_bar3");
172/// assert_eq!(to_snake_case("lower2upper"),  "lower2upper");
173/// ```
174pub fn to_snake_case(non_snake_case_string: &str) -> String {
175    let mut first_character: bool = true;
176    let mut last_separator: bool = true;
177    let mut result: String = String::with_capacity(non_snake_case_string.len() * 2);
178
179    for char_with_index in non_snake_case_string.trim_end_matches(|c: char| !c.is_alphanumeric()).char_indices() {
180        if !char_with_index.1.is_alphanumeric() {
181            if !first_character && !last_separator {
182                first_character = true;
183                last_separator = true;
184                result.push('_');
185            }
186        } else {
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        }
202    }
203    result
204}
mago_casing/lib.rs

mago_casing/
lib.rs
