stillwater 1.0.1

Pragmatic effect composition and validation for Rust - pure core, imperative shell
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
//! String predicates
//!
//! This module provides common predicates for string validation.

use super::combinators::Predicate;

/// Predicate that checks if a string is not empty.
#[derive(Clone, Copy, Default, Debug)]
pub struct NotEmpty;

impl Predicate<str> for NotEmpty {
    #[inline]
    fn check(&self, value: &str) -> bool {
        !value.is_empty()
    }
}

impl Predicate<String> for NotEmpty {
    #[inline]
    fn check(&self, value: &String) -> bool {
        !value.is_empty()
    }
}

/// Create a predicate that checks if a string is not empty.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(not_empty().check("hello"));
/// assert!(!not_empty().check(""));
/// ```
pub fn not_empty() -> NotEmpty {
    NotEmpty
}

/// Predicate that checks string length is in range.
#[derive(Clone, Copy, Debug)]
pub struct LenBetween {
    min: usize,
    max: usize,
}

impl Predicate<str> for LenBetween {
    #[inline]
    fn check(&self, value: &str) -> bool {
        let len = value.len();
        len >= self.min && len <= self.max
    }
}

impl Predicate<String> for LenBetween {
    #[inline]
    fn check(&self, value: &String) -> bool {
        let len = value.len();
        len >= self.min && len <= self.max
    }
}

/// Create a predicate that checks if string length is between min and max (inclusive).
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// let p = len_between(3, 10);
/// assert!(!p.check("ab"));      // too short
/// assert!(p.check("abc"));      // exactly min
/// assert!(p.check("hello"));    // in range
/// assert!(p.check("1234567890")); // exactly max
/// assert!(!p.check("12345678901")); // too long
/// ```
pub fn len_between(min: usize, max: usize) -> LenBetween {
    LenBetween { min, max }
}

/// Create a predicate that checks if string length is at least min.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(len_min(3).check("hello"));
/// assert!(len_min(3).check("abc"));
/// assert!(!len_min(3).check("ab"));
/// ```
pub fn len_min(min: usize) -> LenBetween {
    LenBetween {
        min,
        max: usize::MAX,
    }
}

/// Create a predicate that checks if string length is at most max.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(len_max(5).check("hello"));
/// assert!(len_max(5).check("hi"));
/// assert!(!len_max(5).check("toolong"));
/// ```
pub fn len_max(max: usize) -> LenBetween {
    LenBetween { min: 0, max }
}

/// Create a predicate that checks if string length is exactly len.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(len_eq(5).check("hello"));
/// assert!(!len_eq(5).check("hi"));
/// ```
pub fn len_eq(len: usize) -> LenBetween {
    LenBetween { min: len, max: len }
}

/// Predicate that checks if string starts with a prefix.
#[derive(Clone, Debug)]
pub struct StartsWith<S>(pub S);

impl<S: AsRef<str> + Send + Sync> Predicate<str> for StartsWith<S> {
    #[inline]
    fn check(&self, value: &str) -> bool {
        value.starts_with(self.0.as_ref())
    }
}

impl<S: AsRef<str> + Send + Sync> Predicate<String> for StartsWith<S> {
    #[inline]
    fn check(&self, value: &String) -> bool {
        value.starts_with(self.0.as_ref())
    }
}

/// Create a predicate that checks if string starts with prefix.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(starts_with("http").check("https://example.com"));
/// assert!(!starts_with("http").check("ftp://example.com"));
/// ```
pub fn starts_with<S: AsRef<str> + Send + Sync>(prefix: S) -> StartsWith<S> {
    StartsWith(prefix)
}

/// Predicate that checks if string ends with a suffix.
#[derive(Clone, Debug)]
pub struct EndsWith<S>(pub S);

impl<S: AsRef<str> + Send + Sync> Predicate<str> for EndsWith<S> {
    #[inline]
    fn check(&self, value: &str) -> bool {
        value.ends_with(self.0.as_ref())
    }
}

impl<S: AsRef<str> + Send + Sync> Predicate<String> for EndsWith<S> {
    #[inline]
    fn check(&self, value: &String) -> bool {
        value.ends_with(self.0.as_ref())
    }
}

/// Create a predicate that checks if string ends with suffix.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(ends_with(".rs").check("main.rs"));
/// assert!(!ends_with(".rs").check("main.py"));
/// ```
pub fn ends_with<S: AsRef<str> + Send + Sync>(suffix: S) -> EndsWith<S> {
    EndsWith(suffix)
}

/// Predicate that checks if string contains a substring.
#[derive(Clone, Debug)]
pub struct Contains<S>(pub S);

impl<S: AsRef<str> + Send + Sync> Predicate<str> for Contains<S> {
    #[inline]
    fn check(&self, value: &str) -> bool {
        value.contains(self.0.as_ref())
    }
}

impl<S: AsRef<str> + Send + Sync> Predicate<String> for Contains<S> {
    #[inline]
    fn check(&self, value: &String) -> bool {
        value.contains(self.0.as_ref())
    }
}

/// Create a predicate that checks if string contains substring.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(contains("@").check("user@example.com"));
/// assert!(!contains("@").check("invalid"));
/// ```
pub fn contains<S: AsRef<str> + Send + Sync>(substring: S) -> Contains<S> {
    Contains(substring)
}

/// Predicate that checks if all characters satisfy a predicate.
#[derive(Clone, Copy, Debug)]
pub struct AllChars<F>(pub F);

impl<F: Fn(char) -> bool + Send + Sync> Predicate<str> for AllChars<F> {
    #[inline]
    fn check(&self, value: &str) -> bool {
        value.chars().all(&self.0)
    }
}

impl<F: Fn(char) -> bool + Send + Sync> Predicate<String> for AllChars<F> {
    #[inline]
    fn check(&self, value: &String) -> bool {
        value.chars().all(&self.0)
    }
}

/// Create a predicate that checks if all characters satisfy a condition.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(all_chars(char::is_alphabetic).check("hello"));
/// assert!(!all_chars(char::is_alphabetic).check("hello123"));
/// ```
pub fn all_chars<F: Fn(char) -> bool + Send + Sync>(f: F) -> AllChars<F> {
    AllChars(f)
}

/// Predicate that checks if any character satisfies a predicate.
#[derive(Clone, Copy, Debug)]
pub struct AnyChar<F>(pub F);

impl<F: Fn(char) -> bool + Send + Sync> Predicate<str> for AnyChar<F> {
    #[inline]
    fn check(&self, value: &str) -> bool {
        value.chars().any(&self.0)
    }
}

impl<F: Fn(char) -> bool + Send + Sync> Predicate<String> for AnyChar<F> {
    #[inline]
    fn check(&self, value: &String) -> bool {
        value.chars().any(&self.0)
    }
}

/// Create a predicate that checks if any character satisfies a condition.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(any_char(char::is_numeric).check("hello123"));
/// assert!(!any_char(char::is_numeric).check("hello"));
/// ```
pub fn any_char<F: Fn(char) -> bool + Send + Sync>(f: F) -> AnyChar<F> {
    AnyChar(f)
}

/// Create a predicate that checks if all characters are ASCII.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(is_ascii().check("hello"));
/// assert!(!is_ascii().check("héllo"));
/// ```
pub fn is_ascii() -> AllChars<fn(char) -> bool> {
    AllChars(|c| c.is_ascii())
}

/// Create a predicate that checks if all characters are alphanumeric.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(is_alphanumeric().check("hello123"));
/// assert!(!is_alphanumeric().check("hello_123"));
/// ```
pub fn is_alphanumeric() -> AllChars<fn(char) -> bool> {
    AllChars(|c| c.is_alphanumeric())
}

/// Create a predicate that checks if all characters are alphabetic.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(is_alphabetic().check("hello"));
/// assert!(!is_alphabetic().check("hello123"));
/// ```
pub fn is_alphabetic() -> AllChars<fn(char) -> bool> {
    AllChars(|c| c.is_alphabetic())
}

/// Create a predicate that checks if all characters are numeric.
///
/// # Example
///
/// ```rust
/// use stillwater::predicate::*;
///
/// assert!(is_numeric().check("123"));
/// assert!(!is_numeric().check("hello123"));
/// ```
pub fn is_numeric() -> AllChars<fn(char) -> bool> {
    AllChars(|c| c.is_numeric())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::predicate::{And, PredicateExt};

    #[test]
    fn test_not_empty() {
        assert!(not_empty().check("hello"));
        assert!(!not_empty().check(""));
    }

    #[test]
    fn test_not_empty_string() {
        assert!(not_empty().check(&String::from("hello")));
        assert!(!not_empty().check(&String::new()));
    }

    #[test]
    fn test_len_between() {
        let p = len_between(3, 10);
        assert!(!p.check("ab")); // too short
        assert!(p.check("abc")); // exactly min
        assert!(p.check("hello")); // in range
        assert!(p.check("1234567890")); // exactly max
        assert!(!p.check("12345678901")); // too long
    }

    #[test]
    fn test_len_min() {
        assert!(len_min(3).check("hello"));
        assert!(len_min(3).check("abc"));
        assert!(!len_min(3).check("ab"));
    }

    #[test]
    fn test_len_max() {
        assert!(len_max(5).check("hello"));
        assert!(len_max(5).check("hi"));
        assert!(!len_max(5).check("toolong"));
    }

    #[test]
    fn test_len_eq() {
        assert!(len_eq(5).check("hello"));
        assert!(!len_eq(5).check("hi"));
        assert!(!len_eq(5).check("toolong"));
    }

    #[test]
    fn test_starts_with() {
        assert!(starts_with("http").check("https://example.com"));
        assert!(!starts_with("http").check("ftp://example.com"));
    }

    #[test]
    fn test_ends_with() {
        assert!(ends_with(".rs").check("main.rs"));
        assert!(!ends_with(".rs").check("main.py"));
    }

    #[test]
    fn test_contains() {
        assert!(contains("@").check("user@example.com"));
        assert!(!contains("@").check("invalid"));
    }

    #[test]
    fn test_all_chars() {
        assert!(all_chars(char::is_alphabetic).check("hello"));
        assert!(!all_chars(char::is_alphabetic).check("hello123"));
    }

    #[test]
    fn test_any_char() {
        assert!(any_char(char::is_numeric).check("hello123"));
        assert!(!any_char(char::is_numeric).check("hello"));
    }

    #[test]
    fn test_is_ascii() {
        assert!(is_ascii().check("hello"));
        assert!(!is_ascii().check("héllo"));
    }

    #[test]
    fn test_is_alphanumeric() {
        assert!(is_alphanumeric().check("hello123"));
        assert!(!is_alphanumeric().check("hello_123"));
    }

    #[test]
    fn test_is_alphabetic() {
        assert!(is_alphabetic().check("hello"));
        assert!(!is_alphabetic().check("hello123"));
    }

    #[test]
    fn test_is_numeric() {
        assert!(is_numeric().check("123"));
        assert!(!is_numeric().check("hello123"));
    }

    #[test]
    fn test_complex_username_validation() {
        // For combined predicates on strings, we use type annotation to specify str
        // This tells the compiler which Predicate impl to use
        let valid_username: And<And<NotEmpty, LenBetween>, AllChars<_>> = PredicateExt::<str>::and(
            PredicateExt::<str>::and(not_empty(), len_between(3, 20)),
            all_chars(|c: char| c.is_alphanumeric() || c == '_'),
        );

        // Call check on &str literals
        assert!(valid_username.check("john_doe"));
        assert!(valid_username.check("a_1"));
        assert!(!valid_username.check("ab")); // too short
        assert!(!valid_username.check("invalid-name")); // contains hyphen
    }
}