qua 0.36.0

Structure-aware query CLI for the Quarb engine
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

//! Time expressions and the timeline: `timex` finds them by the
//! locale's lists, `time_anchor` values one against a point,
//! `@| timeline` carries the point from capsa to capsa, and a
//! period is a value that compares as an interval.

use std::path::{Path, PathBuf};

fn fixture(tag: &str) -> PathBuf {
    let dir = std::env::temp_dir().join(format!("quarb-timeline-{}-{tag}", std::process::id()));
    let _ = std::fs::remove_dir_all(&dir);
    std::fs::create_dir_all(&dir).unwrap();
    std::fs::write(
        dir.join("story.txt"),
        "On 6 October 1899 he arrived.\n\nThe next day he wrote to her.\n\n\
         Two days later the answer came.\n\nThat evening he left.\n",
    )
    .unwrap();
    std::fs::write(
        dir.join("diary.md"),
        "# 3 May 1897\n\nLeft Munich at 8:35 P.M. We reached Vienna the next morning.\n\n\
         Two days later we came to Bistritz.\n\n# 30 December 1897\n\n\
         Yesterday the snow fell. On 2 January we left.\n",
    )
    .unwrap();
    std::fs::write(
        dir.join("log.json"),
        r#"{"rows": [{"id": 1, "at": "2025-10-06T14:30:00Z"}, {"id": 2, "at": "2025-10-31"},
                     {"id": 3, "at": "2025-11-02"}, {"id": 4, "at": "2024"}, {"id": 5, "at": "soon"}]}"#,
    )
    .unwrap();
    dir
}

fn qua(dir: &Path, args: &[&str]) -> (String, String) {
    let out = std::process::Command::new(env!("CARGO_BIN_EXE_qua"))
        .env("QUARB_LOCALE", "C")
        .current_dir(dir)
        .args(args)
        .stdin(std::process::Stdio::null())
        .output()
        .unwrap();
    (
        String::from_utf8(out.stdout)
            .unwrap()
            .trim_end()
            .to_string(),
        String::from_utf8_lossy(&out.stderr).trim().to_string(),
    )
}

fn ok(dir: &Path, args: &[&str]) -> String {
    let (out, err) = qua(dir, args);
    assert!(err.is_empty(), "{args:?}: {err}");
    out
}

#[test]
fn an_expression_and_its_anchor() {
    let dir = fixture("anchor");
    assert_eq!(
        ok(&dir, &["= 'On 8 April he left.' | timex(en)"]),
        "%(text = \"8 April\"; at = 3; kind = \"date\"; value = \"XXXX-04-08\"; grain = \"day\")"
    );
    let anchored = |text: &str, at: &str| {
        ok(
            &dir,
            &[&format!("= '{text}' | timex(en) | time_anchor({at})")],
        )
    };
    assert_eq!(anchored("two months later", "1899-10-06"), "1899-12-06");
    assert_eq!(anchored("the following Monday", "1899-10-06"), "1899-10-09");
    // an offset finer than the anchor's grain has no result
    assert_eq!(anchored("the next day", "1812"), "");
    // a duration and a vague expression have none either
    assert_eq!(anchored("two weeks", "1899-10-06"), "");
    assert_eq!(anchored("that evening", "1899-10-06"), "");
    // the value text alone reads too; fields left out come from the anchor
    assert_eq!(
        ok(&dir, &["= 'XXXX-04-08' | time_anchor(1846-03-20)"]),
        "1846-04-08"
    );
    assert_eq!(
        ok(&dir, &["= '+P1M' | time_anchor(1899-01-31)"]),
        "1899-02-28"
    );
    // a locale without lists is refused, naming those carried
    let (_, err) = qua(&dir, &["= 'x' | timex(pl)"]);
    assert!(err.contains("carried: en, zh, es"), "{err}");
    // the anchor is an expression of the capsa: a diary's entry date
    assert_eq!(
        ok(
            &dir,
            &[
                "//section | .d(::lemma | tp('%d %B %Y')) | /paragraph | :: | timex(en) | time_anchor($.d)",
                "text:diary.md"
            ]
        ),
        "1897-05-03T20:35\n1897-05-04\n1897-05-05\n1897-12-29\n1897-01-02"
    );
}

#[test]
fn the_point_is_carried_from_capsa_to_capsa() {
    let dir = fixture("timeline");
    assert_eq!(
        ok(
            &dir,
            &[
                "--table",
                "/paragraph | :: | timex(en) @| timeline($_) | %(:text; :kind; :when; :from)",
                "text:story.txt"
            ]
        ),
        "text            kind      when        from\n\
         --------------  --------  ----------  ----\n\
         6 October 1899  date      1899-10-06\n\
         The next day    relative  1899-10-07  1\n\
         Two days later  relative  1899-10-09  2\n\
         That evening    vague"
    );
    // an anchor cuts the context into runs: each entry starts at its
    // date; a day offset after a time of day is a day
    let diary = |tail: &str| {
        ok(
            &dir,
            &[
                "--csv",
                &format!(
                    "//section | .d(::lemma | tp('%d %B %Y')) | /paragraph | :: | timex(en) \
                     @| timeline($_; $.d{tail}) | %(:text; :when; :from)"
                ),
                "text:diary.md",
            ],
        )
    };
    assert_eq!(
        diary(""),
        "text,when,from\n\
         8:35 P.M,1897-05-03T20:35,0\n\
         the next morning,1897-05-04,1\n\
         Two days later,1897-05-06,2\n\
         Yesterday,1897-12-29,0\n\
         2 January,1897-01-02,4"
    );
    // forward: the point never moves back (yesterday is reported and
    // left behind), and a date with its year left out is the first
    // such date at or after the point
    assert_eq!(
        diary("; forward"),
        "text,when,from\n\
         8:35 P.M,1897-05-03T20:35,0\n\
         the next morning,1897-05-04,1\n\
         Two days later,1897-05-06,2\n\
         Yesterday,1897-12-29,0\n\
         2 January,1898-01-02,0"
    );
    // with no point a relative stays unvalued
    assert_eq!(
        ok(
            &dir,
            &[
                "--csv",
                "= 'the next day; on 3 May 1897; a week later' | timex(en) @| timeline($_) | %(:value; :when; :from)"
            ]
        ),
        "value,when,from\n+P1D,,\n1897-05-03,1897-05-03,\n+P1W,1897-05-10,2"
    );
    let (_, err) = qua(&dir, &["= 1 @| timeline($_; 1; 2; 3)"]);
    assert!(err.contains("timeline takes the time expression"), "{err}");
}

#[test]
fn a_period_compares_as_an_interval() {
    let dir = fixture("period");
    let ids = |pred: &str| ok(&dir, &[&format!("/rows/*[{pred}]::id"), "log.json"]);
    // equality is containment: every instant and day of the month
    assert_eq!(ids("(::at | period) = 2025-10"), "1\n2");
    assert_eq!(ids("::at = ('2025-10' | period)"), "1\n2");
    // disjoint periods are ordered by the timeline
    assert_eq!(ids("(::at | period) < 2025-11"), "1\n2\n4");
    assert_eq!(ids("(::at | period) >= ('2025-10-31' | period)"), "2\n3");
    // constructing, coarsening, and the grain
    assert_eq!(ok(&dir, &["= 2025-10-06 | period(month)"]), "2025-10");
    assert_eq!(ok(&dir, &["= 2025-10-06 | period | grain"]), "day");
    assert_eq!(ok(&dir, &["= 1812 | period"]), "1812");
    // a grain finer than the value's own is null
    assert_eq!(
        ok(
            &dir,
            &[
                "/rows/*[::id <= 2] | ::at | period(hour) | %(p = $_) @| json",
                "log.json"
            ]
        ),
        "[{\"p\": \"2025-10-06T14\"}, {\"p\": null}]"
    );
    // a period sorts by its start, takes no part in arithmetic, reads
    // as its first instant, and is ISO text in the interchange forms
    assert_eq!(
        ok(
            &dir,
            &["/rows/*[::id < 5] | ::at | period @| sort", "log.json"]
        ),
        "2024\n2025-10-06T14:30:00\n2025-10-31\n2025-11-02"
    );
    assert_eq!(ok(&dir, &["= (2025-10 | period) + 1"]), "");
    assert_eq!(ok(&dir, &["= (2025-10 | period) | datetime"]), "2025-10-01");
    assert_eq!(
        ok(
            &dir,
            &[
                "/rows/*[::id = 2] | %(p = (::at | period(month))) @| json",
                "log.json"
            ]
        ),
        "[{\"p\": \"2025-10\"}]"
    );
    let (_, err) = qua(&dir, &["= 2025-10-06 | period(decade)"]);
    assert!(err.contains("is not a grain"), "{err}");
}