rest-sql 0.1.0

RSQL/FIQL filter parser and validator for REST APIs — parse, validate, compile to native DB queries
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
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
use crate::Operator;
use crate::error::{ParseError, ParseErrorAt};
use crate::parsing::span::Span;
use crate::parsing::token::Token::Op;
use crate::parsing::token::{Spanned, Token, operator_map};

// ─── Lexer struct ─────────────────────────────────────────────────────────────

struct Lexer<'a> {
    input: &'a str,
    chars: std::iter::Peekable<std::str::CharIndices<'a>>,
}

impl<'a> Lexer<'a> {
    fn new(input: &'a str) -> Self {
        Lexer {
            input,
            chars: input.char_indices().peekable(),
        }
    }

    fn next_token(&mut self) -> Result<Option<Spanned>, ParseError> {
        // Skip whitespace
        loop {
            match self.chars.peek() {
                Some(&(_, c)) if c.is_whitespace() => {
                    self.chars.next();
                }
                _ => break,
            }
        }

        let (start, ch) = match self.chars.next() {
            Some(t) => t,
            None => return Ok(None),
        };

        let spanned = match ch {
            '(' => Spanned::new(Token::LParen, Span::new(start, start + 1)),
            ')' => Spanned::new(Token::RParen, Span::new(start, start + 1)),
            ',' => Spanned::new(Token::Comma, Span::new(start, start + 1)),
            ';' => Spanned::new(Token::Semi, Span::new(start, start + 1)),

            // `=`-delimited operators: read everything up to and including the
            // closing `=`, then validate against the operator map.
            // Covers both FIQL-style (=in=, =between=, …) and `==`.
            '=' => {
                let mut end = start + 1;
                let mut closed = false;
                for (pos, c) in self.chars.by_ref() {
                    end = pos + c.len_utf8();
                    if c == '=' {
                        closed = true;
                        break;
                    }
                }
                if !closed {
                    return Err(self.error(
                        start,
                        1,
                        "unterminated operator (missing closing '=')",
                    ));
                }
                let op_str = &self.input[start..end];
                match operator_map().get(op_str) {
                    Some(op) => Spanned::new(Op(op.clone()), Span::new(start, end)),
                    None => {
                        return Err(self.error(
                            start,
                            end - start,
                            &format!("unknown operator {op_str:?}"),
                        ));
                    }
                }
            }

            // `!=` — the only valid use of `!`
            '!' => match self.chars.next_if(|&(_, c)| c == '=') {
                Some(_) => Spanned::new(Op(Operator::Neq), Span::new(start, start + 2)),
                None => return Err(self.error(start, 1, "expected '=' after '!'")),
            },

            // `<` or `<=`
            '<' => match self.chars.next_if(|&(_, c)| c == '=') {
                Some(_) => Spanned::new(Op(Operator::Lte), Span::new(start, start + 2)),
                None => Spanned::new(Op(Operator::Lt), Span::new(start, start + 1)),
            },

            // `>` or `>=`
            '>' => match self.chars.next_if(|&(_, c)| c == '=') {
                Some(_) => Spanned::new(Op(Operator::Gte), Span::new(start, start + 2)),
                None => Spanned::new(Op(Operator::Gt), Span::new(start, start + 1)),
            },

            // Quoted string — single or double quote, no escape processing
            '"' | '\'' => self.scan_quoted(start, ch)?,

            // Word / literal — any char not already covered above
            c if !is_word_end(c) => self.scan_literal(start, c),

            c => {
                return Err(self.error(
                    start,
                    c.len_utf8(),
                    &format!("unexpected character {c:?}"),
                ));
            }
        };

        Ok(Some(spanned))
    }

    // Consume chars until the closing quote. Quotes are stripped.
    fn scan_quoted(&mut self, start: usize, quote: char) -> Result<Spanned, ParseError> {
        let content_start = start + 1; // byte after opening quote
        loop {
            match self.chars.next() {
                None => return Err(self.error(start, 1, "unterminated string literal")),
                Some((pos, c)) if c == quote => {
                    let content = self.input[content_start..pos].to_string();
                    return Ok(Spanned::new(
                        Token::QuotedStr(content),
                        Span::new(start, pos + 1),
                    ));
                }
                _ => {}
            }
        }
    }

    // Consume chars while they are word characters, then classify the result.
    // `first` is already consumed. Produces a typed token (Null/Bool/Integer/Float/Word).
    fn scan_literal(&mut self, start: usize, first: char) -> Spanned {
        let mut end = start + first.len_utf8();
        while let Some(&(pos, c)) = self.chars.peek() {
            if is_word_end(c) {
                break;
            }
            end = pos + c.len_utf8();
            self.chars.next();
        }
        let word = &self.input[start..end];
        let token = match word {
            "null" => Token::Null,
            "true" => Token::Bool(true),
            "false" => Token::Bool(false),
            w => try_integer(w)
                .map(Token::Integer)
                .or_else(|| try_float(w).map(Token::Float))
                .or_else(|| as_datetime(w))
                .or_else(|| as_date(w))
                .unwrap_or_else(|| Token::Word(w.to_string())),
        };
        Spanned::new(token, Span::new(start, end))
    }

    fn error(&self, pos: usize, span_len: usize, message: &str) -> ParseError {
        let span = Span::new(pos, pos + span_len);
        let (line, col) = span.line_col(self.input);
        ParseError::At(ParseErrorAt {
            line,
            col,
            span_len,
            snippet: span.source_line(self.input).to_string(),
            message: message.to_string(),
        })
    }
}

// ─── Literal classifiers ──────────────────────────────────────────────────────

// Matches `YYYY-MM-DD` (no semantic validation — 2024-99-99 passes format).
fn is_date(s: &str) -> bool {
    let b = s.as_bytes();
    b.len() == 10
        && b[4] == b'-'
        && b[7] == b'-'
        && b[..4].iter().all(|c| c.is_ascii_digit())
        && b[5..7].iter().all(|c| c.is_ascii_digit())
        && b[8..10].iter().all(|c| c.is_ascii_digit())
}

// Matches `YYYY-MM-DDTHH:MM:SSZ`.
fn is_datetime(s: &str) -> bool {
    let b = s.as_bytes();
    b.len() == 20
        && is_date(&s[..10])
        && b[10] == b'T'
        && b[13] == b':'
        && b[16] == b':'
        && b[19] == b'Z'
        && b[11..13].iter().all(|c| c.is_ascii_digit())
        && b[14..16].iter().all(|c| c.is_ascii_digit())
        && b[17..19].iter().all(|c| c.is_ascii_digit())
}

fn as_datetime(s: &str) -> Option<Token> {
    if is_datetime(s) {
        Some(Token::DateTime(s.to_string()))
    } else {
        None
    }
}

fn as_date(s: &str) -> Option<Token> {
    if is_date(s) {
        Some(Token::Date(s.to_string()))
    } else {
        None
    }
}

fn try_integer(s: &str) -> Option<i64> {
    let rest = s.strip_prefix('-').unwrap_or(s);
    if rest.is_empty() || !rest.chars().all(|c| c.is_ascii_digit()) {
        return None;
    }
    s.parse::<i64>().ok()
}

fn try_float(s: &str) -> Option<f64> {
    let rest = s.strip_prefix('-').unwrap_or(s);
    let dot = rest.find('.')?;
    let int_part = &rest[..dot];
    let frac_part = &rest[dot + 1..];
    if int_part.is_empty() || !int_part.chars().all(|c| c.is_ascii_digit()) {
        return None;
    }
    if frac_part.is_empty() || !frac_part.chars().all(|c| c.is_ascii_digit()) {
        return None;
    }
    s.parse::<f64>().ok()
}

// A character that ends a Word token.
fn is_word_end(c: char) -> bool {
    c.is_whitespace()
        || matches!(c, '(' | ')' | ',' | ';' | '"' | '\'')
        || matches!(c, '=' | '<' | '>' | '!')
}

// ─── Public entry point ───────────────────────────────────────────────────────

/// Transforms a source string into a flat, ordered token stream.
///
/// Literals are typed at lex time: `null`/`true`/`false` become their own
/// variants; digit sequences become `Integer` or `Float`. Everything else
/// becomes `Word` and is treated as a bare-string value by the grammar.
///
/// Character classes:
///   - Whitespace           → silently skipped
///   - `(`, `)`, `,`, `;`   → structural delimiters (LParen/RParen/Comma/Semi)
///   - `=`                  → `=xxx=` FIQL or `==`, validated against operator map
///   - `<`, `>`, `!`        → symbolic operators, optional `=` consumed via `next_if`
///   - `"` or `'`           → quoted string (no escape processing)
///   - Everything else      → Word (runs until a word-end character)
///
/// FIQL spec note: `=`, `<`, `>`, `!` are not in the unreserved character set
/// for values, so unquoted values never contain them — the lexer is context-free.
pub fn tokenize(source: &str) -> Result<Vec<Spanned>, ParseError> {
    let mut lexer = Lexer::new(source);
    let mut tokens = Vec::new();
    while let Some(tok) = lexer.next_token()? {
        tokens.push(tok);
    }
    Ok(tokens)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ast::Operator;

    fn tokens(source: &str) -> Vec<Token> {
        tokenize(source)
            .unwrap()
            .into_iter()
            .map(|s| s.token)
            .collect()
    }

    #[test]
    fn simple_constraint() {
        assert_eq!(
            tokens("name==Alice"),
            vec![
                Token::Word("name".into()),
                Token::Op(Operator::Eq),
                Token::Word("Alice".into()),
            ]
        );
    }

    #[test]
    fn and_and_or_separators() {
        assert_eq!(
            tokens("a==1;b>2,c<3"),
            vec![
                Token::Word("a".into()),
                Token::Op(Operator::Eq),
                Token::Integer(1),
                Token::Semi,
                Token::Word("b".into()),
                Token::Op(Operator::Gt),
                Token::Integer(2),
                Token::Comma,
                Token::Word("c".into()),
                Token::Op(Operator::Lt),
                Token::Integer(3),
            ]
        );
    }

    #[test]
    fn in_list() {
        assert_eq!(
            tokens("role=in=(admin,user)"),
            vec![
                Token::Word("role".into()),
                Token::Op(Operator::In),
                Token::LParen,
                Token::Word("admin".into()),
                Token::Comma,
                Token::Word("user".into()),
                Token::RParen,
            ]
        );
    }

    #[test]
    fn quoted_string_double() {
        assert_eq!(
            tokens(r#"name=="hello world""#),
            vec![
                Token::Word("name".into()),
                Token::Op(Operator::Eq),
                Token::QuotedStr("hello world".into()),
            ]
        );
    }

    #[test]
    fn quoted_string_single() {
        assert_eq!(
            tokens("name=='hello world'"),
            vec![
                Token::Word("name".into()),
                Token::Op(Operator::Eq),
                Token::QuotedStr("hello world".into()),
            ]
        );
    }

    #[test]
    fn whitespace_is_ignored() {
        assert_eq!(tokens("a == 1"), tokens("a==1"));
        assert_eq!(tokens("  a  ==  1  "), tokens("a==1"));
    }

    #[test]
    fn fiql_longest_match() {
        assert_eq!(tokens("x=between=(1,2)")[1], Token::Op(Operator::Between));
        assert_eq!(tokens("x=notnull=true")[1], Token::Op(Operator::NotNull));
    }

    #[test]
    fn symbolic_two_char_before_one_char() {
        assert_eq!(tokens("a<=b")[1], Token::Op(Operator::Lte));
        assert_eq!(tokens("a>=b")[1], Token::Op(Operator::Gte));
        assert_eq!(tokens("a!=b")[1], Token::Op(Operator::Neq));
    }

    #[test]
    fn unterminated_string_returns_error() {
        let err = tokenize(r#"name=="oops"#);
        assert!(matches!(err, Err(ParseError::At(_))));
    }

    // ── Literal classification ────────────────────────────────────────────────

    #[test]
    fn null_and_bool_keywords() {
        assert_eq!(tokens("null"), vec![Token::Null]);
        assert_eq!(tokens("true"), vec![Token::Bool(true)]);
        assert_eq!(tokens("false"), vec![Token::Bool(false)]);
    }

    #[test]
    fn integer_and_float_literals() {
        assert_eq!(tokens("0"), vec![Token::Integer(0)]);
        assert_eq!(tokens("42"), vec![Token::Integer(42)]);
        assert_eq!(tokens("-7"), vec![Token::Integer(-7)]);
        assert_eq!(tokens("3.5"), vec![Token::Float(3.5)]);
        assert_eq!(tokens("-0.5"), vec![Token::Float(-0.5)]);
    }

    #[test]
    fn leading_dot_is_word_not_float() {
        // `.14` has an empty integer part → not a valid float
        assert_eq!(tokens(".14"), vec![Token::Word(".14".into())]);
        // `-.14` has `-` then empty integer part
        assert_eq!(tokens("-.14"), vec![Token::Word("-.14".into())]);
    }

    #[test]
    fn trailing_dot_is_word_not_float() {
        // `3.` has an empty fractional part → not a valid float
        assert_eq!(tokens("3."), vec![Token::Word("3.".into())]);
    }

    #[test]
    fn non_digit_in_fractional_part_is_word() {
        // `3.14a5` — fractional part contains a non-digit character
        assert_eq!(tokens("3.14a5"), vec![Token::Word("3.14a5".into())]);
    }

    #[test]
    fn date_literal() {
        assert_eq!(tokens("2024-01-15"), vec![Token::Date("2024-01-15".into())]);
        assert_eq!(tokens("1900-12-31"), vec![Token::Date("1900-12-31".into())]);
    }

    #[test]
    fn datetime_literal() {
        assert_eq!(
            tokens("2024-01-15T10:30:00Z"),
            vec![Token::DateTime("2024-01-15T10:30:00Z".into())]
        );
    }

    #[test]
    fn datetime_takes_priority_over_date_prefix() {
        // Le lexer lit le mot entier avant de classifier — "2024-01-15T10:30:00Z" est
        // un seul token DateTime, pas un Date suivi de junk.
        let toks = tokens("2024-01-15T10:30:00Z");
        assert_eq!(toks.len(), 1);
        assert!(matches!(toks[0], Token::DateTime(_)));
    }

    #[test]
    fn date_in_constraint() {
        assert_eq!(
            tokens("created_at>=2024-01-15"),
            vec![
                Token::Word("created_at".into()),
                Token::Op(Operator::Gte),
                Token::Date("2024-01-15".into()),
            ]
        );
    }

    #[test]
    fn malformed_date_stays_word() {
        // Trop court, ou mauvais séparateur — pas classifié comme Date
        assert_eq!(tokens("2024-1-15"), vec![Token::Word("2024-1-15".into())]);
        assert_eq!(tokens("2024/01/15"), vec![Token::Word("2024/01/15".into())]);
    }

    #[test]
    fn malformed_datetime_stays_word() {
        // Sans le Z final
        assert_eq!(
            tokens("2024-01-15T10:30:00"),
            vec![Token::Word("2024-01-15T10:30:00".into())]
        );
    }

    // ── Operator errors ───────────────────────────────────────────────────────

    #[test]
    fn unterminated_fiql_operator() {
        // `=foo` without a closing `=` → "unterminated operator"
        let err = tokenize("name=foo");
        if let Err(ParseError::At(e)) = err {
            assert!(
                e.message.contains("unterminated operator"),
                "got: {}",
                e.message
            );
        } else {
            panic!("expected ParseError::At");
        }
    }

    #[test]
    fn unknown_fiql_operator() {
        // `=foo=` is syntactically closed but not in the operator table
        let err = tokenize("name=foo=bar");
        if let Err(ParseError::At(e)) = err {
            assert!(e.message.contains("unknown operator"), "got: {}", e.message);
            assert!(
                e.message.contains("=foo="),
                "message should quote the bad op: {}",
                e.message
            );
        } else {
            panic!("expected ParseError::At");
        }
    }

    #[test]
    fn lone_exclamation_mark() {
        // `!` not followed by `=` → "expected '=' after '!'"
        let err = tokenize("name!bar");
        assert!(matches!(err, Err(ParseError::At(_))));
    }

    // ── Error position ────────────────────────────────────────────────────────

    #[test]
    fn unterminated_fiql_col_is_correct() {
        // `name=bad` — the `=` is at byte 4, so col should be 5 (1-based)
        let err = tokenize("name=bad");
        if let Err(ParseError::At(e)) = err {
            assert_eq!(e.line, 1);
            assert_eq!(e.col, 5);
        } else {
            panic!("expected ParseError::At");
        }
    }

    #[test]
    fn unknown_operator_span_covers_full_token() {
        // `=xyz=` is 5 bytes; span_len should cover the whole operator
        let err = tokenize("=xyz=");
        if let Err(ParseError::At(e)) = err {
            assert_eq!(e.col, 1);
            assert_eq!(e.span_len, 5);
        } else {
            panic!("expected ParseError::At");
        }
    }

    #[test]
    fn spans_are_correct() {
        let spanned = tokenize("name==Alice").unwrap();
        assert_eq!(spanned[0].span, Span::new(0, 4)); // "name"
        assert_eq!(spanned[1].span, Span::new(4, 6)); // "=="
        assert_eq!(spanned[2].span, Span::new(6, 11)); // "Alice"
    }

    #[test]
    fn parens_have_correct_spans() {
        let spanned = tokenize("(a)").unwrap();
        assert_eq!(spanned[0].span, Span::new(0, 1));
        assert_eq!(spanned[2].span, Span::new(2, 3));
    }

    // ── Unicode / multi-byte ──────────────────────────────────────────────────

    #[test]
    fn accented_chars_in_word_tokens() {
        assert_eq!(
            tokens("prénom==André"),
            vec![
                Token::Word("prénom".into()),
                Token::Op(Operator::Eq),
                Token::Word("André".into()),
            ]
        );
    }

    #[test]
    fn accented_word_byte_spans() {
        // "prénom" = p(1)+r(1)+é(2)+n(1)+o(1)+m(1) = 7 bytes
        // "André"  = A(1)+n(1)+d(1)+r(1)+é(2)      = 6 bytes
        let spanned = tokenize("prénom==André").unwrap();
        assert_eq!(spanned[0].span, Span::new(0, 7)); // "prénom"
        assert_eq!(spanned[1].span, Span::new(7, 9)); // "=="
        assert_eq!(spanned[2].span, Span::new(9, 15)); // "André"
    }

    #[test]
    fn cjk_chars_in_word() {
        assert_eq!(
            tokens("label==日本語"),
            vec![
                Token::Word("label".into()),
                Token::Op(Operator::Eq),
                Token::Word("日本語".into()),
            ]
        );
    }

    #[test]
    fn emoji_in_word() {
        assert_eq!(
            tokens("tag==🚀"),
            vec![
                Token::Word("tag".into()),
                Token::Op(Operator::Eq),
                Token::Word("🚀".into()),
            ]
        );
    }

    #[test]
    fn unicode_in_quoted_string_double() {
        assert_eq!(
            tokens(r#"name=="Ségolène Royal""#),
            vec![
                Token::Word("name".into()),
                Token::Op(Operator::Eq),
                Token::QuotedStr("Ségolène Royal".into()),
            ]
        );
    }

    #[test]
    fn cjk_in_quoted_string() {
        assert_eq!(
            tokens(r#"label=="日本語テスト""#),
            vec![
                Token::Word("label".into()),
                Token::Op(Operator::Eq),
                Token::QuotedStr("日本語テスト".into()),
            ]
        );
    }

    #[test]
    fn emoji_in_quoted_string() {
        assert_eq!(
            tokens(r#"tag=="🚀 rocket""#),
            vec![
                Token::Word("tag".into()),
                Token::Op(Operator::Eq),
                Token::QuotedStr("🚀 rocket".into()),
            ]
        );
    }

    #[test]
    fn unterminated_string_with_unicode() {
        let err = tokenize(r#"name=="café"#);
        assert!(matches!(err, Err(ParseError::At(_))));
    }
}