cruet 1.0.0

Adds String based inflections for Rust. Snake, kebab, camel, sentence, class, title and table cases as well as ordinalize, deordinalize, demodulize, foreign key, and pluralize/singularize are supported as both traits and pure functions acting on String types.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211

use crate::case::*;
/// Converts a `&str` to `Sentence case` `String`
///
/// ```
/// use cruet::case::to_sentence_case;
///
/// assert_eq!(to_sentence_case("Foo bar"), "Foo bar");
/// assert_eq!(to_sentence_case("FooBar"), "Foo bar");
/// assert_eq!(to_sentence_case("fooBar"), "Foo bar");
/// assert_eq!(to_sentence_case("FOO_BAR"), "Foo bar");
/// assert_eq!(to_sentence_case("foo_bar"), "Foo bar");
/// assert_eq!(to_sentence_case("foo-bar"), "Foo bar");
/// ```
pub fn to_sentence_case(non_sentence_case_string: &str) -> String {
    let options = CamelOptions {
        new_word: true,
        last_char: ' ',
        first_word: true,
        injectable_char: ' ',
        has_separator: true,
        inverted: true,
        concat_num: false,
    };
    to_case_camel_like(non_sentence_case_string, options)
}
/// Determines of a `&str` is `Sentence case`
///
/// ```
/// use cruet::case::is_sentence_case;
///
/// assert!(is_sentence_case("Foo"));
/// assert!(is_sentence_case(
///     "Foo bar string that is really really long"
/// ));
///
/// assert!(!is_sentence_case(
///     "foo-bar-string-that-is-really-really-long"
/// ));
/// assert!(!is_sentence_case("FooBarIsAReallyReallyLongString"));
/// assert!(!is_sentence_case("fooBarIsAReallyReallyLongString"));
/// assert!(!is_sentence_case("Foo Bar Is A Really Really Long String"));
/// assert!(!is_sentence_case(
///     "FOO_BAR_STRING_THAT_IS_REALLY_REALLY_LONG"
/// ));
/// assert!(!is_sentence_case(
///     "foo_bar_string_that_is_really_really_long"
/// ));
/// assert!(!is_sentence_case("foo"));
/// ```
pub fn is_sentence_case(test_string: &str) -> bool {
    test_string == to_sentence_case(test_string)
}

#[cfg(test)]
mod tests {
    use super::{is_sentence_case, to_sentence_case};

    #[test]
    fn from_camel_case() {
        let convertible_string: String = "fooBar".to_owned();
        let expected: String = "Foo bar".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn from_pascal_case() {
        let convertible_string: String = "FooBar".to_owned();
        let expected: String = "Foo bar".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn from_kebab_case() {
        let convertible_string: String = "foo-bar".to_owned();
        let expected: String = "Foo bar".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn from_sentence_case() {
        let convertible_string: String = "Foo bar".to_owned();
        let expected: String = "Foo bar".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn from_title_case() {
        let convertible_string: String = "Foo Bar".to_owned();
        let expected: String = "Foo bar".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn from_train_case() {
        let convertible_string: String = "Foo-Bar".to_owned();
        let expected: String = "Foo bar".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn from_screaming_snake_case() {
        let convertible_string: String = "FOO_BAR".to_owned();
        let expected: String = "Foo bar".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn from_snake_case() {
        let convertible_string: String = "foo_bar".to_owned();
        let expected: String = "Foo bar".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn from_case_with_loads_of_space() {
        let convertible_string: String = "foo           bar".to_owned();
        let expected: String = "Foo bar".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn a_name_with_a_dot() {
        let convertible_string: String = "Robert C. Martin".to_owned();
        let expected: String = "Robert c martin".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn random_text_with_bad_chars() {
        let convertible_string: String = "Random text with *(bad) chars".to_owned();
        let expected: String = "Random text with bad chars".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn trailing_bad_chars() {
        let convertible_string: String = "trailing bad_chars*(()())".to_owned();
        let expected: String = "Trailing bad chars".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn leading_bad_chars() {
        let convertible_string: String = "-!#$%leading bad chars".to_owned();
        let expected: String = "Leading bad chars".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn wrapped_in_bad_chars() {
        let convertible_string: String =
            "-!#$%wrapped in bad chars&*^*&(&*^&(<><?>><?><>))".to_owned();
        let expected: String = "Wrapped in bad chars".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn has_a_sign() {
        let convertible_string: String = "has a + sign".to_owned();
        let expected: String = "Has a sign".to_owned();
        assert_eq!(to_sentence_case(&convertible_string), expected)
    }

    #[test]
    fn is_correct_from_camel_case() {
        let convertible_string: String = "fooBar".to_owned();
        assert_eq!(is_sentence_case(&convertible_string), false)
    }

    #[test]
    fn is_correct_from_pascal_case() {
        let convertible_string: String = "FooBar".to_owned();
        assert_eq!(is_sentence_case(&convertible_string), false)
    }

    #[test]
    fn is_correct_from_kebab_case() {
        let convertible_string: String = "foo-bar".to_owned();
        assert_eq!(is_sentence_case(&convertible_string), false)
    }

    #[test]
    fn is_correct_from_sentence_case() {
        let convertible_string: String = "Foo bar".to_owned();
        assert_eq!(is_sentence_case(&convertible_string), true)
    }

    #[test]
    fn is_correct_from_title_case() {
        let convertible_string: String = "Foo Bar".to_owned();
        assert_eq!(is_sentence_case(&convertible_string), false)
    }

    #[test]
    fn is_correct_from_train_case() {
        let convertible_string: String = "Foo-Bar".to_owned();
        assert_eq!(is_sentence_case(&convertible_string), false)
    }

    #[test]
    fn is_correct_from_screaming_snake_case() {
        let convertible_string: String = "FOO_BAR".to_owned();
        assert_eq!(is_sentence_case(&convertible_string), false)
    }

    #[test]
    fn is_correct_from_snake_case() {
        let convertible_string: String = "foo_bar".to_owned();
        assert_eq!(is_sentence_case(&convertible_string), false)
    }
}