jiq 3.21.0

Interactive JSON query tool with real-time output
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
//! Tests for brace tracking in autocomplete

use super::*;
use proptest::prelude::*;

#[test]
fn test_empty_query() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("");
    assert_eq!(tracker.context_at(0), None);
    assert!(!tracker.is_in_object(0));
}

#[test]
fn test_simple_object() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("{name");
    assert_eq!(tracker.context_at(1), Some(BraceType::Curly));
    assert!(tracker.is_in_object(1));
    assert!(tracker.is_in_object(5));
}

#[test]
fn test_simple_array() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("[1, 2");
    assert_eq!(tracker.context_at(1), Some(BraceType::Square));
    assert!(!tracker.is_in_object(1));
}

#[test]
fn test_simple_paren() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("map(");
    assert_eq!(tracker.context_at(4), Some(BraceType::Paren));
    assert!(!tracker.is_in_object(4));
}

#[test]
fn test_closed_braces() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("{name: .name}");
    // After the closing brace, we're no longer in object context
    assert_eq!(tracker.context_at(13), None);
}

#[test]
fn test_object_in_array() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("[{na");
    // Position 2 is inside the object (after '{')
    assert_eq!(tracker.context_at(2), Some(BraceType::Curly));
    assert!(tracker.is_in_object(2));
}

#[test]
fn test_array_in_object() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("{items: [na");
    // Position 9 is inside the array (after '[')
    assert_eq!(tracker.context_at(9), Some(BraceType::Square));
    assert!(!tracker.is_in_object(9));
}

#[test]
fn test_deep_nesting() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("{a: [{b: (c");
    // Position 10 is inside the paren
    assert_eq!(tracker.context_at(10), Some(BraceType::Paren));
    assert!(!tracker.is_in_object(10));
}

#[test]
fn test_braces_in_string() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("\"{braces}\"");
    // Braces inside string should be ignored
    assert_eq!(tracker.context_at(5), None);
    assert!(!tracker.is_in_object(5));
}

#[test]
fn test_escaped_quote_in_string() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("\"say \\\"hi\\\" {here\"");
    // The { is inside the string, should be ignored
    assert_eq!(tracker.context_at(12), None);
}

#[test]
fn test_escaped_backslash_in_string() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("\"path\\\\{dir\"");
    // The { is inside the string after \\, should be ignored
    assert_eq!(tracker.context_at(8), None);
}

#[test]
fn test_string_then_real_braces() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("\"{fake}\" | {real");
    // Position 12 is inside the real object
    assert_eq!(tracker.context_at(12), Some(BraceType::Curly));
    assert!(tracker.is_in_object(12));
}

#[test]
fn test_object_key_after_comma() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("{name: .name, ag");
    // Position 14 is still inside the object
    assert!(tracker.is_in_object(14));
}

#[test]
fn test_real_jq_pattern_select() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("select(.active)");
    // After the closing paren, no context
    assert_eq!(tracker.context_at(15), None);
}

#[test]
fn test_real_jq_pattern_map() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("map({na");
    assert!(tracker.is_in_object(5));

    tracker.rebuild("map({name: .name})");
    assert_eq!(tracker.context_at(18), None);
    assert_eq!(tracker.context_at(5), None);
}

#[test]
fn test_mismatched_braces() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("{test]");
    assert!(tracker.is_in_object(5));
}

#[test]
fn test_unclosed_string() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("\"unclosed {");
    assert_eq!(tracker.context_at(10), None);
}

#[test]
fn test_is_stale() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("{test");
    assert!(!tracker.is_stale("{test"));
    assert!(tracker.is_stale("{test2"));
    assert!(tracker.is_stale(""));
}

#[test]
fn test_context_at_position_zero() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("{test");
    // Position 0 is before the opening brace
    assert_eq!(tracker.context_at(0), None);
}

proptest! {
    /// **Feature: object-key-autocomplete, Property 4: BraceTracker never panics**
    /// **Validates: Requirements 5.2, 5.3**
    ///
    /// For any arbitrary string input, calling rebuild() and context_at()
    /// shall not panic.
    #[test]
    fn prop_rebuild_never_panics(query in ".*") {
        let mut tracker = BraceTracker::new();
        tracker.rebuild(&query);
        // If we get here without panicking, the test passes
    }

    /// **Feature: object-key-autocomplete, Property 4: BraceTracker never panics**
    /// **Validates: Requirements 5.2, 5.3**
    ///
    /// For any position query on any string, context_at() shall not panic.
    #[test]
    fn prop_context_at_never_panics(query in ".*", pos in 0usize..1000) {
        let mut tracker = BraceTracker::new();
        tracker.rebuild(&query);
        let _ = tracker.context_at(pos);
        let _ = tracker.is_in_object(pos);
        // If we get here without panicking, the test passes
    }

    /// **Feature: object-key-autocomplete, Property 3: Braces inside strings are ignored**
    /// **Validates: Requirements 3.1, 3.2**
    ///
    /// For any query containing a string literal with braces inside,
    /// the BraceTracker shall report the same context as if those braces
    /// were not present.
    #[test]
    fn prop_string_braces_ignored(
        prefix in "[a-z .|]*",
        string_content in "[a-z{}\\[\\]()]*",
        suffix in "[a-z .|]*"
    ) {
        // Build query with braces inside a string
        let query_with_string_braces = format!("{}\"{}\"{}",  prefix, string_content, suffix);
        // Build query with empty string (no braces in string)
        let query_with_empty_string = format!("{}\"\"{}",  prefix, suffix);

        let mut tracker1 = BraceTracker::new();
        let mut tracker2 = BraceTracker::new();

        tracker1.rebuild(&query_with_string_braces);
        tracker2.rebuild(&query_with_empty_string);

        // The context after the string should be the same
        let pos_after_string1 = prefix.len() + string_content.len() + 2; // +2 for quotes
        let pos_after_string2 = prefix.len() + 2; // +2 for quotes

        prop_assert_eq!(
            tracker1.context_at(pos_after_string1),
            tracker2.context_at(pos_after_string2),
            "Context after string should be same regardless of braces inside string"
        );
    }

    /// **Feature: object-key-autocomplete, Property 4: BraceTracker never panics**
    /// **Validates: Requirements 5.2, 5.3**
    ///
    /// is_in_object should be consistent with context_at result.
    #[test]
    fn prop_is_in_object_consistent(query in ".*", pos in 0usize..500) {
        let mut tracker = BraceTracker::new();
        tracker.rebuild(&query);

        let context = tracker.context_at(pos);
        let is_object = tracker.is_in_object(pos);

        prop_assert_eq!(
            is_object,
            context == Some(BraceType::Curly),
            "is_in_object should match context_at == Curly"
        );
    }

    /// Element-context functions should always be detected
    #[test]
    fn prop_element_context_functions_always_detected(
        func in "(map|select|sort_by|group_by|unique_by|min_by|max_by|recurse|walk)",
        partial in "[a-z]{0,5}"
    ) {
        let query = format!("{}(.{}", func, partial);
        let mut tracker = BraceTracker::new();
        tracker.rebuild(&query);
        prop_assert!(
            tracker.is_in_element_context(query.len()),
            "Should detect element context in '{}' at position {}",
            query,
            query.len()
        );
    }

    /// Non-element functions should never trigger element context
    #[test]
    fn prop_non_element_functions_never_detected(
        func in "(limit|has|del|getpath|split|join|test|match)",
        partial in "[a-z]{0,5}"
    ) {
        let query = format!("{}(.{}", func, partial);
        let mut tracker = BraceTracker::new();
        tracker.rebuild(&query);
        prop_assert!(
            !tracker.is_in_element_context(query.len()),
            "Should NOT detect element context in '{}' at position {}",
            query,
            query.len()
        );
    }
}

// ============================================================================
// Element Context Detection Tests
// ============================================================================

#[test]
fn test_element_context_in_map() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("map(.");
    assert!(tracker.is_in_element_context(5));
}

#[test]
fn test_element_context_in_select() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("select(.");
    assert!(tracker.is_in_element_context(8));
}

#[test]
fn test_element_context_all_element_functions() {
    let functions = [
        "map",
        "select",
        "sort_by",
        "group_by",
        "unique_by",
        "min_by",
        "max_by",
        "recurse",
        "walk",
    ];
    for func in functions {
        let query = format!("{}(.field", func);
        let mut tracker = BraceTracker::new();
        tracker.rebuild(&query);
        assert!(
            tracker.is_in_element_context(query.len()),
            "Function '{}' should provide element context",
            func
        );
    }
}

#[test]
fn test_no_element_context_outside_function() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild(".field");
    assert!(!tracker.is_in_element_context(6));
}

#[test]
fn test_no_element_context_in_limit() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("limit(5; .");
    assert!(!tracker.is_in_element_context(10));
}

#[test]
fn test_no_element_context_in_has() {
    let mut tracker = BraceTracker::new();
    tracker.rebuild("has(.");
    assert!(!tracker.is_in_element_context(5));
}

#[test]
fn test_element_context_nested_in_limit() {
    // map(limit(5; .field)) - cursor inside limit but map provides element context
    let mut tracker = BraceTracker::new();
    tracker.rebuild("map(limit(5; .");
    assert!(
        tracker.is_in_element_context(14),
        "Should detect element context from outer map even when inside limit"
    );
}

#[test]
fn test_element_context_with_object_inside() {
    // map({name: .name}) - cursor inside object construction
    let mut tracker = BraceTracker::new();
    tracker.rebuild("map({name: .");
    assert!(tracker.is_in_element_context(12));
}

#[test]
fn test_element_context_with_array_inside() {
    // map([.x, .y]) - cursor inside array construction
    let mut tracker = BraceTracker::new();
    tracker.rebuild("map([.");
    assert!(tracker.is_in_element_context(6));
}

#[test]
fn test_no_element_context_grouping_parens() {
    // (.x + .y) - just grouping, no function
    let mut tracker = BraceTracker::new();
    tracker.rebuild("(.x + .");
    assert!(!tracker.is_in_element_context(7));
}

#[test]
fn test_element_context_after_pipe_in_function() {
    // map(. | .field) - still inside map after pipe
    let mut tracker = BraceTracker::new();
    tracker.rebuild("map(. | .");
    assert!(tracker.is_in_element_context(10));
}

#[test]
fn test_element_context_string_with_paren() {
    // "(" | map(.field) - paren in string should be ignored
    let mut tracker = BraceTracker::new();
    tracker.rebuild("\"(\" | map(.");
    assert!(tracker.is_in_element_context(11));
}

#[test]
fn test_element_context_closed_function() {
    // map(.field) | . - after map is closed
    let mut tracker = BraceTracker::new();
    tracker.rebuild("map(.field) | .");
    assert!(!tracker.is_in_element_context(15));
}

#[test]
fn test_element_context_nested_element_functions() {
    // map(select(.active)) - nested element context functions
    let mut tracker = BraceTracker::new();
    tracker.rebuild("map(select(.");
    assert!(tracker.is_in_element_context(12));
}

#[test]
fn test_element_context_whitespace_before_paren() {
    // map (.field) - space between function and paren
    let mut tracker = BraceTracker::new();
    tracker.rebuild("map (.");
    assert!(tracker.is_in_element_context(6));
}

#[test]
fn test_no_element_context_unknown_function() {
    // myfunc(.field) - user-defined function not in metadata
    let mut tracker = BraceTracker::new();
    tracker.rebuild("myfunc(.");
    assert!(!tracker.is_in_element_context(8));
}

#[test]
fn test_function_context_enum_debug() {
    // Verify FunctionContext can be debugged
    let ctx = FunctionContext::ElementIterator("map");
    assert!(format!("{:?}", ctx).contains("ElementIterator"));
    assert!(format!("{:?}", ctx).contains("map"));
}

#[test]
fn test_brace_info_struct() {
    // Verify BraceInfo fields are accessible
    let info = BraceInfo {
        pos: 5,
        brace_type: BraceType::Paren,
        context: Some(FunctionContext::ElementIterator("select")),
    };
    assert_eq!(info.pos, 5);
    assert_eq!(info.brace_type, BraceType::Paren);
    assert!(matches!(
        info.context,
        Some(FunctionContext::ElementIterator("select"))
    ));
}