fosk 0.1.9

In-memory SQL-like query engine and lightweight data store for testing and prototyping.
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
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
use crate::parser::{ast::{ArgsExpr, ComparatorOp, ScalarExpr, Truth}, ParseError, QueryParser};

#[derive(Clone, PartialEq)]
pub enum Predicate {
    And(Vec<Predicate>),
    Or(Vec<Predicate>),
    //Not(Box<Predicate>),

    // Predicates that *embed* scalars:
    Compare { left: ScalarExpr, op: ComparatorOp, right: ScalarExpr }, // =, <, <=, >, >=, <>, !=
    IsNull  { expr: ScalarExpr, negated: bool },
    InList  { expr: ScalarExpr, list: Vec<ScalarExpr>, negated: bool },
    Like    { expr: ScalarExpr, pattern: ScalarExpr, negated: bool },

    Const3(Truth),
}

impl Predicate {
    pub fn is_start(parser: &QueryParser) -> bool {
        parser.comparers.on.compare(parser)
    }

    pub fn parse_single(parser: &mut QueryParser, allow_wildcard: bool) -> Result<Self, ParseError> {

        let left = ScalarExpr::parse(parser, allow_wildcard)?;

        parser.next_non_whitespace();

        let pivot = parser.position;
        let comparator = ComparatorOp::check(parser);

        if let Some(op) = comparator {
            parser.next_non_whitespace();
            let right = ScalarExpr::parse(parser, false)?;

            return Ok(Self::Compare { left, op, right });
        }

        if parser.comparers.is_null.compare(parser) {
            parser.jump(parser.comparers.is_null.length);
            return Ok(Self::IsNull { expr: left, negated: false });
        }

        if parser.comparers.is_not_null.compare(parser) {
            parser.jump(parser.comparers.is_not_null.length);
            return Ok(Self::IsNull { expr: left, negated: true });
        }

        if parser.comparers.r#in.compare(parser) {
            parser.jump(parser.comparers.r#in.length);
            parser.next_non_whitespace();
            let args_expr = ArgsExpr::parse(parser, allow_wildcard)?;
            return Ok(Self::InList { expr: left, list: args_expr.args, negated: false });
        }

        if parser.comparers.not_in.compare(parser) {
            parser.jump(parser.comparers.not_in.length);
            parser.next_non_whitespace();
            let args_expr = ArgsExpr::parse(parser, allow_wildcard)?;
            return Ok(Self::InList { expr: left, list: args_expr.args, negated: true });
        }

        if parser.comparers.like.compare(parser) {
            parser.jump(parser.comparers.like.length);
            parser.next_non_whitespace();

            let pattern = ScalarExpr::parse(parser, false)?;
            return Ok(Self::Like { expr: left, pattern, negated: false });
        }

        if parser.comparers.not_like.compare(parser) {
            parser.jump(parser.comparers.not_like.length);
            parser.next_non_whitespace();

            let pattern = ScalarExpr::parse(parser, true)?;
            return Ok(Self::Like { expr: left, pattern, negated: false });
        }

        ParseError::new("Invalid predicate", pivot, parser).err()
    }

    pub fn parse_all(parser: &mut QueryParser, allow_wildcard: bool, depth: i8) -> Result<Self, ParseError> {
        let mut pivot = parser.position;
        let mut predicates: Vec<Predicate> = vec![];
        let mut and = false;
        let mut or = false;
        while (!parser.check_next_phase()) && (depth == 0 || parser.current() != ')')   {
            predicates.push(Self::parse_single(parser, allow_wildcard)?);
            parser.next_non_whitespace();

            if parser.comparers.and.compare(parser) {
                parser.jump(parser.comparers.and.length);
                parser.next_non_whitespace();
                and = true;
            }

            if parser.comparers.or.compare(parser) {
                parser.jump(parser.comparers.or.length);
                parser.next_non_whitespace();
                or = true;
            }

            if parser.current() == '(' {
                parser.next();
                predicates.push(Self::parse_all(parser, allow_wildcard, depth + 1)?);
                parser.next();
            }

            pivot = parser.position;
        }

        if depth > 0 && parser.current() != ')' {
            return ParseError::new("Invalid predicate", pivot, parser).err();
        }

        if and {
            if predicates.len() == 1 {
                return ParseError::new("Invalid predicate", pivot, parser).err();
            }
            return Ok(Self::And(predicates));
        }

        if or {
            if predicates.len() == 1 {
                return ParseError::new("Invalid predicate", pivot, parser).err();
            }
            return Ok(Self::Or(predicates));
        }

        if predicates.len() == 1 {
            return Ok(predicates.pop().unwrap());
        }

        ParseError::new("Invalid predicate", pivot, parser).err()
    }

    pub fn parse(parser: &mut QueryParser, allow_wildcard: bool) -> Result<Self, ParseError> {
        Self::parse_all(parser, allow_wildcard, 0)
    }
}

use std::fmt;

impl fmt::Display for Predicate {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Predicate::And(items) => {
                let s = items.iter().map(|p| format!("{}", p)).collect::<Vec<_>>().join(" AND ");
                write!(f, "({})", s)
            }
            Predicate::Or(items) => {
                let s = items.iter().map(|p| format!("{}", p)).collect::<Vec<_>>().join(" OR ");
                write!(f, "({})", s)
            }
            Predicate::Compare { left, op, right } => write!(f, "{} {} {}", left, op, right),
            Predicate::IsNull { expr, negated } => {
                if *negated { write!(f, "{} IS NOT NULL", expr) } else { write!(f, "{} IS NULL", expr) }
            }
            Predicate::InList { expr, list, negated } => {
                let items = list.iter().map(|s| format!("{}", s)).collect::<Vec<_>>().join(", ");
                if *negated { write!(f, "{} NOT IN [{}]", expr, items) } else { write!(f, "{} IN [{}]", expr, items) }
            }
            Predicate::Like { expr, pattern, negated } => {
                if *negated { write!(f, "{} NOT LIKE {}", expr, pattern) } else { write!(f, "{} LIKE {}", expr, pattern) }
            }
            Predicate::Const3(t) => write!(f, "{}", t),
        }
    }
}

impl fmt::Debug for Predicate {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Predicate({})", self)
    }
}

#[cfg(test)]
mod tests {
    use crate::parser::{ast::{ComparatorOp, Predicate}, QueryParser};

    #[test]
    pub fn test_predicate_single_equal() {
        let text = "columnA = columnB";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::Compare { left: _, op, right: _ } => assert_eq!(op, ComparatorOp::Eq),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_not_equal_b() {
        let text = r#"columnA <> "columnB""#;

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::Compare { left: _, op, right: _ } => assert_eq!(op, ComparatorOp::NotEq),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_not_equal_c() {
        let text = "columnA != 'columnB'";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::Compare { left: _, op, right: _ } => assert_eq!(op, ComparatorOp::NotEq),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_not_less_than() {
        let text = "columnA < 10";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::Compare { left: _, op, right: _ } => assert_eq!(op, ComparatorOp::Lt),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_not_less_than_or_equal() {
        let text = "columnA <= 10";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::Compare { left: _, op, right: _ } => assert_eq!(op, ComparatorOp::LtEq),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_not_greater_than() {
        let text = "columnA > 10";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::Compare { left: _, op, right: _ } => assert_eq!(op, ComparatorOp::Gt),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_not_greater_than_or_equal() {
        let text = "columnA >= 10";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::Compare { left: _, op, right: _ } => assert_eq!(op, ComparatorOp::GtEq),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_is_null() {
        let text = "columnA IS NULL";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::IsNull { expr: _, negated } => assert!(!negated),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_is_not_null() {
        let text = "columnA IS NOT NULL";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::IsNull { expr: _, negated } => assert!(negated),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_in() {
        let text = "columnA IN(1, 2, 3)";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::InList { expr: _, list, negated } => {
                assert_eq!(list.len(), 3);
                assert!(!negated);
            },
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_not_in() {
        let text = "columnA NOT IN(1, 2, 3)";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::InList { expr: _, list, negated } => {
                assert_eq!(list.len(), 3);
                assert!(negated);
            },
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_like() {
        let text = "columnA LIKE '%pattern%'";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::Like { expr: _, pattern: _, negated } => assert!(!negated),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_not_like() {
        let text = r#"columnA Not Like "%pattern%""#;

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::Like { expr: _, pattern: _, negated } => assert!(!negated),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_single_wrong_comparer() {
        let text = "columnA =! 'columnB'";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false);

        match result {
            Ok(_) => panic!(),
            Err(err) => {
                assert_eq!(err.text, "=");
                assert_eq!(err.start, 8);
                assert_eq!(err.end, 8);
            },
        };
    }

    #[test]
    pub fn test_predicate_single_without_right_side() {
        let text = "columnA != ";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse_single(&mut parser, false);

        match result {
            Ok(_) => panic!(),
            Err(err) => {
                assert_eq!(err.text, "");
                assert_eq!(err.start, 11);
                assert_eq!(err.end, 11);
            },
        };
    }

    #[test]
    pub fn test_predicate_and() {
        let text = "columnA = columnB AND columnC = columnD";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::And(predicates) => assert_eq!(predicates.len(), 2),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_and_p_or() {
        let text = "columnA = columnB AND (columnC = columnD OR columnE = columnF)";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse(&mut parser, false).expect("Failed to parse predicate");

        match result {
            Predicate::And(predicates) => assert_eq!(predicates.len(), 2),
            _ => panic!(),
        };
    }

    #[test]
    pub fn test_predicate_and_p_or_without_end() {
        let text = "columnA = columnB AND (columnC = columnD OR columnE = columnF FROM";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse(&mut parser, false);

        match result {
            Ok(_) => panic!(),
            Err(err) => {
                assert_eq!(err.text, "");
                assert_eq!(err.start, 66);
                assert_eq!(err.end, 66);
            },
        };
    }

    #[test]
    pub fn test_predicate_and_p_or_without_end_case2() {
        let text = "columnA = columnB AND (columnC = columnD OR columnE = columnF FROM ";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse(&mut parser, false);

        match result {
            Ok(_) => panic!(),
            Err(err) => {
                assert_eq!(err.text, "F");
                assert_eq!(err.start, 62);
                assert_eq!(err.end, 62);
            },
        };
    }

    #[test]
    pub fn test_predicate_and_p_or_without_start() {
        let text = "columnA = columnB AND columnC = columnD OR columnE = columnF) FROM ";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse(&mut parser, false);

        match result {
            Ok(_) => panic!(),
            Err(err) => {
                assert_eq!(err.text, ")");
                assert_eq!(err.start, 60);
                assert_eq!(err.end, 60);
            },
        };
    }

    #[test]
    pub fn test_predicate_double_and_p_or_without_start() {
        let text = "columnA = columnB AND AND columnC = columnD OR columnE = columnF FROM ";

        let mut parser = QueryParser::new(text);

        let result = Predicate::parse(&mut parser, false);

        match result {
            Ok(_) => panic!(),
            Err(err) => {
                assert_eq!(err.text, "c");
                assert_eq!(err.start, 26);
                assert_eq!(err.end, 26);
            },
        };
    }
}