lumin 0.1.16

A library for searching and displaying local files
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
use anyhow::Result;
use lumin::search::{SearchOptions, search_files};
use serial_test::serial;
use std::path::Path;

mod test_helpers;
use test_helpers::{TEST_DIR, TestEnvironment, setup_multiple_file_types};

/// Tests for the include_glob feature in search functionality
#[cfg(test)]
mod search_include_glob_tests {
    use super::*;

    /// Test including files using simple glob patterns
    #[test]
    #[serial]
    fn test_include_single_glob() -> Result<()> {
        let _env = TestEnvironment::setup()?;
        let additional_files = setup_multiple_file_types()?;

        // Search with a pattern that should be in multiple file types
        let pattern = "content";
        let mut options = SearchOptions::default();

        // Search without including anything specific first to confirm our test pattern exists in multiple files
        let all_results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        // Verify we have results in different file types
        assert!(
            all_results
                .lines
                .iter()
                .any(|r| r.file_path.to_string_lossy().ends_with(".json")),
            "Expected to find the pattern in JSON files"
        );
        assert!(
            all_results
                .lines
                .iter()
                .any(|r| r.file_path.to_string_lossy().ends_with(".txt")),
            "Expected to find the pattern in TXT files"
        );

        // Now search with include_glob for JSON files only
        options.include_glob = Some(vec!["*.json".to_string()]);

        let results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        // Should still find matches
        assert!(
            !results.lines.is_empty(),
            "Expected to find matches in JSON files"
        );

        // Should only find JSON files
        assert!(
            results
                .lines
                .iter()
                .all(|r| r.file_path.to_string_lossy().ends_with(".json")),
            "Found non-JSON files despite only including JSON files"
        );

        // Cleanup
        for file in &additional_files {
            std::fs::remove_file(file)?;
        }

        Ok(())
    }

    /// Test including files using multiple glob patterns
    #[test]
    #[serial]
    fn test_include_multiple_globs() -> Result<()> {
        let _env = TestEnvironment::setup()?;
        let additional_files = setup_multiple_file_types()?;

        // Search with a pattern that should be in multiple file types
        let pattern = "content";

        // Include only JSON and YAML files
        let mut options = SearchOptions::default();
        options.include_glob = Some(vec!["*.json".to_string(), "*.yaml".to_string()]);

        let results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        // Should find matches
        assert!(
            !results.lines.is_empty(),
            "Expected to find matches in JSON or YAML files"
        );

        // Should only find JSON or YAML files
        assert!(
            results.lines.iter().all(|r| {
                let path = r.file_path.to_string_lossy();
                path.ends_with(".json") || path.ends_with(".yaml")
            }),
            "Found files other than JSON or YAML despite only including those types"
        );

        // Cleanup
        for file in &additional_files {
            std::fs::remove_file(file)?;
        }

        Ok(())
    }

    /// Test including files with recursive glob patterns
    #[test]
    #[serial]
    fn test_include_recursive_glob() -> Result<()> {
        let _env = TestEnvironment::setup()?;
        let additional_files = setup_multiple_file_types()?;

        // Pattern that should be in multiple directories
        let pattern = "content";

        // Verify we have files in various directories
        let all_results = search_files(pattern, Path::new(TEST_DIR), &SearchOptions::default())?;
        assert!(
            all_results
                .lines
                .iter()
                .any(|r| r.file_path.to_string_lossy().contains("/docs/")),
            "Expected to find the pattern in the docs directory"
        );

        // Include only files in the docs directory and subdirectories
        let mut options = SearchOptions::default();
        // Use the path format that would match our test directory structure
        options.include_glob = Some(vec!["**/docs/**".to_string()]);

        let results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        // Should find matches
        assert!(
            !results.lines.is_empty(),
            "Expected to find matches in docs directory"
        );

        // Should only find files in the docs directory
        assert!(
            results
                .lines
                .iter()
                .all(|r| r.file_path.to_string_lossy().contains("/docs/")),
            "Found files outside the docs directory despite only including it"
        );

        // Cleanup
        for file in &additional_files {
            std::fs::remove_file(file)?;
        }

        Ok(())
    }

    /// Test case sensitivity in glob patterns
    #[test]
    #[serial]
    fn test_include_glob_case_sensitivity() -> Result<()> {
        let _env = TestEnvironment::setup()?;
        let additional_files = setup_multiple_file_types()?;

        // Create files with mixed case extensions in the test directory
        let mixed_case_file1 = Path::new(TEST_DIR).join("test.JsonML");
        let mixed_case_file2 = Path::new(TEST_DIR).join("test.JSON"); // All caps
        std::fs::write(
            &mixed_case_file1,
            "This file has content with a mixed case extension",
        )?;
        std::fs::write(
            &mixed_case_file2,
            "This file has content with an all caps extension",
        )?;

        let pattern = "content";

        // Test with case-sensitive mode
        let mut options = SearchOptions::default();
        options.case_sensitive = true;
        options.include_glob = Some(vec!["*.json".to_string()]);

        let results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        // Should only find lowercase .json files, not .JSON or .JsonML
        assert!(
            results
                .lines
                .iter()
                .all(|r| r.file_path.to_string_lossy().ends_with(".json")),
            "Found non-lowercase .json files despite case sensitivity"
        );

        // Case-insensitive mode test
        let mut options = SearchOptions::default();
        options.case_sensitive = false;
        options.include_glob = Some(vec!["*.json".to_string()]);

        let results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        // Should find all json files regardless of case
        assert!(
            results.lines.iter().all(|r| {
                let path = r.file_path.to_string_lossy();
                path.ends_with(".json") || path.ends_with(".JSON") || path.ends_with(".JsonML")
            }),
            "Expected to find all JSON files case-insensitively"
        );

        // Cleanup
        std::fs::remove_file(&mixed_case_file1)?;
        std::fs::remove_file(&mixed_case_file2)?;
        for file in &additional_files {
            std::fs::remove_file(file)?;
        }

        Ok(())
    }

    /// Test that an empty include_glob list includes nothing (since no files match)
    #[test]
    #[serial]
    fn test_empty_include_glob() -> Result<()> {
        let _env = TestEnvironment::setup()?;
        let additional_files = setup_multiple_file_types()?;

        let pattern = "content";

        // First ensure we have matches with default options
        let default_results =
            search_files(pattern, Path::new(TEST_DIR), &SearchOptions::default())?;
        assert!(
            !default_results.lines.is_empty(),
            "Expected to find matches with default options"
        );

        // Create options with an empty include_glob list
        let mut options = SearchOptions::default();
        options.include_glob = Some(vec![]);

        let results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        // Should find no matches as empty include_glob matches nothing
        assert!(
            results.lines.is_empty(),
            "Expected to find no matches with empty include_glob"
        );

        // Cleanup
        for file in &additional_files {
            std::fs::remove_file(file)?;
        }

        Ok(())
    }

    /// Test include_glob with None vs. empty vec behavior
    #[test]
    #[serial]
    fn test_include_glob_none_vs_empty() -> Result<()> {
        let _env = TestEnvironment::setup()?;
        let additional_files = setup_multiple_file_types()?;

        let pattern = "content";

        // With include_glob = None (default), should find all files
        let default_options = SearchOptions::default();
        let default_results = search_files(pattern, Path::new(TEST_DIR), &default_options)?;
        assert!(
            !default_results.lines.is_empty(),
            "Expected to find matches with include_glob = None"
        );

        // With include_glob = Some(vec![]), should find nothing
        let mut empty_options = SearchOptions::default();
        empty_options.include_glob = Some(vec![]);
        let empty_results = search_files(pattern, Path::new(TEST_DIR), &empty_options)?;
        assert!(
            empty_results.lines.is_empty(),
            "Expected to find no matches with include_glob = Some(empty vec)"
        );

        // Cleanup
        for file in &additional_files {
            std::fs::remove_file(file)?;
        }

        Ok(())
    }

    /// Test combining include_glob with gitignore
    #[test]
    #[serial]
    fn test_include_glob_with_gitignore() -> Result<()> {
        let _env = TestEnvironment::setup()?;
        let additional_files = setup_multiple_file_types()?;

        let pattern = "content";

        // Use include_glob with respect_gitignore=true (default)
        let mut options = SearchOptions::default();
        options.include_glob = Some(vec!["*.md".to_string(), "*.log".to_string()]);

        let results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        // Should find markdown files
        assert!(
            results
                .lines
                .iter()
                .any(|r| r.file_path.to_string_lossy().ends_with(".md")),
            "Expected to find markdown files"
        );

        // Should not find log files despite including them (because of gitignore)
        assert!(
            !results
                .lines
                .iter()
                .any(|r| r.file_path.to_string_lossy().ends_with(".log")),
            "Found log files despite them being in gitignore"
        );

        // Cleanup
        for file in &additional_files {
            std::fs::remove_file(file)?;
        }

        Ok(())
    }

    /// Test combining include_glob with exclude_glob
    #[test]
    #[serial]
    fn test_include_and_exclude_glob_combination() -> Result<()> {
        let _env = TestEnvironment::setup()?;
        let additional_files = setup_multiple_file_types()?;

        let pattern = "content";

        // Include all text files but exclude those in the docs directory
        let mut options = SearchOptions::default();
        options.include_glob = Some(vec!["**/*.txt".to_string()]);
        options.exclude_glob = Some(vec!["docs/**".to_string()]);

        let results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        // Should find matches
        assert!(
            !results.lines.is_empty(),
            "Expected to find matches in text files outside docs"
        );

        // Should only find .txt files
        assert!(
            results
                .lines
                .iter()
                .all(|r| r.file_path.to_string_lossy().ends_with(".txt")),
            "Found non-txt files despite only including txt files"
        );

        // Should not find any files in the docs directory
        assert!(
            !results
                .lines
                .iter()
                .any(|r| r.file_path.to_string_lossy().contains("/docs/")),
            "Found files in docs directory despite excluding it"
        );

        // Cleanup
        for file in &additional_files {
            std::fs::remove_file(file)?;
        }

        Ok(())
    }

    /// Test various glob syntax patterns
    #[test]
    #[serial]
    fn test_include_glob_syntax() -> Result<()> {
        let _env = TestEnvironment::setup()?;
        let additional_files = setup_multiple_file_types()?;

        // Create some additional files for testing glob syntax
        let test_files = [
            ("test1.rs", "fn main() { println!(\"content\"); }"),
            ("test2.rs", "fn test() { println!(\"content\"); }"),
            ("test.py", "print(\"content\")"),
            ("script.py", "print(\"python content\")"),
            ("nested/deep/file.txt", "deep nested content"),
        ];

        let mut created_files = Vec::new();
        for (filename, content) in &test_files {
            let file_path = Path::new(TEST_DIR).join(filename);
            if let Some(parent) = file_path.parent() {
                if !parent.exists() {
                    std::fs::create_dir_all(parent)?;
                }
            }
            std::fs::write(&file_path, content)?;
            created_files.push(file_path);
        }

        let pattern = "content";

        // Test 1: Brace expansion - match multiple extensions
        let mut options = SearchOptions::default();
        options.include_glob = Some(vec!["**/*.{rs,py}".to_string()]);

        let results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        assert!(
            !results.lines.is_empty(),
            "Expected to find matches with brace expansion"
        );
        assert!(
            results.lines.iter().all(|r| {
                let path = r.file_path.to_string_lossy();
                path.ends_with(".rs") || path.ends_with(".py")
            }),
            "Found files other than .rs or .py with brace expansion"
        );

        // Test 2: Character class - match test[digit].rs
        let mut options = SearchOptions::default();
        options.include_glob = Some(vec!["**/test[0-9].rs".to_string()]);

        let results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        assert!(
            !results.lines.is_empty(),
            "Expected to find matches with character class"
        );
        assert!(
            results.lines.iter().all(|r| {
                let path = r.file_path.to_string_lossy();
                path.ends_with("test1.rs") || path.ends_with("test2.rs")
            }),
            "Found files other than test[digit].rs with character class"
        );

        // Test 3: Double asterisk - find files in any directory depth
        let mut options = SearchOptions::default();
        options.include_glob = Some(vec!["**/file.txt".to_string()]);

        let results = search_files(pattern, Path::new(TEST_DIR), &options)?;

        assert!(
            !results.lines.is_empty(),
            "Expected to find matches with double asterisk"
        );
        assert!(
            results.lines.iter().any(|r| r
                .file_path
                .to_string_lossy()
                .contains("nested/deep/file.txt")),
            "Failed to find deeply nested file with double asterisk"
        );

        // Cleanup
        for file in &created_files {
            std::fs::remove_file(file)?;
            // Clean up any created directories too
            if let Some(parent) = file.parent() {
                if parent != Path::new(TEST_DIR) && parent.exists() {
                    let _ = std::fs::remove_dir_all(parent);
                }
            }
        }
        for file in &additional_files {
            std::fs::remove_file(file)?;
        }

        Ok(())
    }
}