tldr-core 0.1.2

Core analysis engine for TLDR code analysis tool
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
//! Test coverage for tldr-core validation module
//!
//! Tests all public functions from:
//! - crates/tldr-core/src/validation.rs

use std::path::Path;

use tempfile::TempDir;

use tldr_core::validation::*;
use tldr_core::{Language, TldrError};

// =============================================================================
// validate_file_path Tests
// =============================================================================

#[test]
fn test_validate_file_path_relative_with_project() {
    let temp = TempDir::new().unwrap();
    let src_dir = temp.path().join("src");
    std::fs::create_dir(&src_dir).unwrap();
    let main_rs = src_dir.join("main.rs");
    std::fs::write(&main_rs, "fn main() {}").unwrap();

    let result = validate_file_path("src/main.rs", Some(temp.path()));

    assert!(result.is_ok(), "Expected Ok, got {:?}", result);
    let path = result.unwrap();
    assert!(path.ends_with("src/main.rs"));
}

#[test]
fn test_validate_file_path_relative_nested() {
    let temp = TempDir::new().unwrap();
    let deep_dir = temp.path().join("a").join("b").join("c");
    std::fs::create_dir_all(&deep_dir).unwrap();
    let file = deep_dir.join("file.txt");
    std::fs::write(&file, "content").unwrap();

    let result = validate_file_path("a/b/c/file.txt", Some(temp.path()));

    assert!(result.is_ok());
    assert!(result.unwrap().ends_with("a/b/c/file.txt"));
}

#[test]
fn test_validate_file_path_absolute() {
    let temp = TempDir::new().unwrap();
    let file = temp.path().join("test.txt");
    std::fs::write(&file, "content").unwrap();

    let result = validate_file_path(file.to_str().unwrap(), None);

    assert!(result.is_ok());
    assert_eq!(result.unwrap(), file.canonicalize().unwrap());
}

#[test]
fn test_validate_file_path_absolute_with_project() {
    let temp = TempDir::new().unwrap();
    let file = temp.path().join("test.txt");
    std::fs::write(&file, "content").unwrap();

    // Absolute path should work even with project specified
    let result = validate_file_path(file.to_str().unwrap(), Some(temp.path()));

    assert!(result.is_ok());
}

#[test]
fn test_validate_file_path_not_found() {
    let result = validate_file_path("/definitely/nonexistent/path/file.rs", None);

    assert!(result.is_err());
    match result.unwrap_err() {
        TldrError::PathNotFound(_) => {}
        _ => panic!("Expected PathNotFound error"),
    }
}

#[test]
fn test_validate_file_path_not_found_relative() {
    let temp = TempDir::new().unwrap();

    let result = validate_file_path("nonexistent.rs", Some(temp.path()));

    assert!(result.is_err());
    match result.unwrap_err() {
        TldrError::PathNotFound(_) => {}
        _ => panic!("Expected PathNotFound error"),
    }
}

#[test]
fn test_validate_file_path_traversal_blocked() {
    let temp = TempDir::new().unwrap();
    let project_dir = temp.path().join("project");
    std::fs::create_dir(&project_dir).unwrap();
    // Create a file outside project dir
    let escape_file = temp.path().join("escape.rs");
    std::fs::write(&escape_file, "// escaped").unwrap();

    let result = validate_file_path("../escape.rs", Some(&project_dir));

    assert!(
        matches!(result, Err(TldrError::PathTraversal(_))),
        "Expected PathTraversal error, got {:?}",
        result
    );
}

#[test]
fn test_validate_file_path_traversal_multiple_levels() {
    let temp = TempDir::new().unwrap();
    let project_dir = temp.path().join("a").join("b").join("project");
    std::fs::create_dir_all(&project_dir).unwrap();
    // Create file outside
    let escape_file = temp.path().join("secret.rs");
    std::fs::write(&escape_file, "// secret").unwrap();

    let result = validate_file_path("../../../secret.rs", Some(&project_dir));

    assert!(matches!(result, Err(TldrError::PathTraversal(_))));
}

#[test]
fn test_validate_file_path_traversal_in_project_root() {
    let temp = TempDir::new().unwrap();
    let project_dir = temp.path();
    // Create file outside project (in parent of temp)
    // Note: Can't actually go above temp dir, so this tests the mechanism

    // Try to escape from root of temp
    let _result = validate_file_path("../", Some(project_dir));

    // This might succeed or fail depending on temp dir location
    // but should not panic
}

#[test]
fn test_validate_file_path_relative_without_project() {
    // This tests that relative paths resolve against cwd
    let temp = TempDir::new().unwrap();
    let file = temp.path().join("local.txt");
    std::fs::write(&file, "content").unwrap();

    // Use absolute path since we can't change cwd easily in tests
    let result = validate_file_path(file.to_str().unwrap(), None);

    assert!(result.is_ok());
}

#[test]
fn test_validate_file_path_with_symlink() {
    let temp = TempDir::new().unwrap();
    let real_file = temp.path().join("real.txt");
    std::fs::write(&real_file, "content").unwrap();

    let link = temp.path().join("link.txt");
    #[cfg(unix)]
    std::os::unix::fs::symlink(&real_file, &link).unwrap();
    #[cfg(windows)]
    std::os::windows::fs::symlink_file(&real_file, &link).unwrap();

    let result = validate_file_path("link.txt", Some(temp.path()));

    // Should resolve symlink and return canonical path
    assert!(result.is_ok());
    assert!(result.unwrap().ends_with("real.txt"));
}

#[test]
fn test_validate_file_path_directory_instead_of_file() {
    let temp = TempDir::new().unwrap();
    let subdir = temp.path().join("subdir");
    std::fs::create_dir(&subdir).unwrap();

    // Trying to validate a directory as a file
    let result = validate_file_path("subdir", Some(temp.path()));

    // Directories can be canonicalized too, so this might succeed
    // The function doesn't specifically check if it's a file
    assert!(result.is_ok());
}

#[test]
fn test_validate_file_path_empty_string() {
    let temp = TempDir::new().unwrap();

    // Empty string should fail (current dir)
    let result = validate_file_path("", Some(temp.path()));

    // This attempts to canonicalize temp.path() itself
    assert!(result.is_ok()); // The temp dir exists
}

#[test]
fn test_validate_file_path_special_characters() {
    let temp = TempDir::new().unwrap();
    // Create file with special characters
    let file = temp.path().join("file with spaces.rs");
    std::fs::write(&file, "content").unwrap();

    let result = validate_file_path("file with spaces.rs", Some(temp.path()));

    assert!(result.is_ok());
}

#[test]
fn test_validate_file_path_unicode() {
    let temp = TempDir::new().unwrap();
    // Create file with unicode name
    let file = temp.path().join("文件.rs");
    std::fs::write(&file, "content").unwrap();

    let result = validate_file_path("文件.rs", Some(temp.path()));

    assert!(result.is_ok());
}

// =============================================================================
// detect_or_parse_language Tests
// =============================================================================

#[test]
fn test_parse_explicit_python() {
    let result = detect_or_parse_language(Some("python"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Python);
}

#[test]
fn test_parse_explicit_python_short() {
    let result = detect_or_parse_language(Some("py"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Python);
}

#[test]
fn test_parse_explicit_typescript() {
    let result = detect_or_parse_language(Some("typescript"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::TypeScript);
}

#[test]
fn test_parse_explicit_typescript_short() {
    let result = detect_or_parse_language(Some("ts"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::TypeScript);
}

#[test]
fn test_parse_explicit_rust() {
    let result = detect_or_parse_language(Some("rust"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Rust);
}

#[test]
fn test_parse_explicit_rust_short() {
    let result = detect_or_parse_language(Some("rs"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Rust);
}

#[test]
fn test_parse_explicit_go() {
    let result = detect_or_parse_language(Some("go"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Go);
}

#[test]
fn test_parse_explicit_go_alt() {
    let result = detect_or_parse_language(Some("golang"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Go);
}

#[test]
fn test_parse_explicit_java() {
    let result = detect_or_parse_language(Some("java"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Java);
}

#[test]
fn test_parse_explicit_c() {
    let result = detect_or_parse_language(Some("c"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::C);
}

#[test]
fn test_parse_explicit_cpp() {
    let result = detect_or_parse_language(Some("cpp"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Cpp);
}

#[test]
fn test_parse_explicit_cpp_alt() {
    let result = detect_or_parse_language(Some("c++"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Cpp);
}

#[test]
fn test_parse_explicit_ruby() {
    let result = detect_or_parse_language(Some("ruby"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Ruby);
}

#[test]
fn test_parse_explicit_kotlin() {
    let result = detect_or_parse_language(Some("kotlin"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Kotlin);
}

#[test]
fn test_parse_explicit_swift() {
    let result = detect_or_parse_language(Some("swift"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Swift);
}

#[test]
fn test_parse_explicit_csharp() {
    let result = detect_or_parse_language(Some("csharp"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::CSharp);
}

#[test]
fn test_parse_explicit_csharp_alt() {
    let result = detect_or_parse_language(Some("c#"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::CSharp);
}

#[test]
fn test_parse_explicit_scala() {
    let result = detect_or_parse_language(Some("scala"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Scala);
}

#[test]
fn test_parse_explicit_php() {
    let result = detect_or_parse_language(Some("php"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Php);
}

#[test]
fn test_parse_explicit_lua() {
    let result = detect_or_parse_language(Some("lua"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Lua);
}

#[test]
fn test_parse_explicit_luau() {
    let result = detect_or_parse_language(Some("luau"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Luau);
}

#[test]
fn test_parse_explicit_elixir() {
    let result = detect_or_parse_language(Some("elixir"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Elixir);
}

#[test]
fn test_parse_explicit_ocaml() {
    let result = detect_or_parse_language(Some("ocaml"), Path::new("any.xyz"));
    assert_eq!(result.unwrap(), Language::Ocaml);
}

#[test]
fn test_parse_invalid_language() {
    let result = detect_or_parse_language(Some("invalid_lang"), Path::new("any.xyz"));

    assert!(result.is_err());
    match result.unwrap_err() {
        TldrError::UnsupportedLanguage(lang) => {
            assert_eq!(lang, "invalid_lang");
        }
        _ => panic!("Expected UnsupportedLanguage error"),
    }
}

#[test]
fn test_parse_empty_language() {
    let result = detect_or_parse_language(Some(""), Path::new("any.xyz"));

    assert!(result.is_err());
    match result.unwrap_err() {
        TldrError::UnsupportedLanguage(lang) => {
            assert_eq!(lang, "");
        }
        _ => panic!("Expected UnsupportedLanguage error"),
    }
}

#[test]
fn test_detect_python_extension() {
    let result = detect_or_parse_language(None, Path::new("script.py"));
    assert_eq!(result.unwrap(), Language::Python);
}

#[test]
fn test_detect_rust_extension() {
    let result = detect_or_parse_language(None, Path::new("lib.rs"));
    assert_eq!(result.unwrap(), Language::Rust);
}

#[test]
fn test_detect_typescript_extension() {
    let result = detect_or_parse_language(None, Path::new("app.ts"));
    assert_eq!(result.unwrap(), Language::TypeScript);
}

#[test]
fn test_detect_typescript_tsx_extension() {
    let result = detect_or_parse_language(None, Path::new("component.tsx"));
    assert_eq!(result.unwrap(), Language::TypeScript);
}

#[test]
fn test_detect_go_extension() {
    let result = detect_or_parse_language(None, Path::new("main.go"));
    assert_eq!(result.unwrap(), Language::Go);
}

#[test]
fn test_detect_javascript_extension() {
    let result = detect_or_parse_language(None, Path::new("app.js"));
    assert_eq!(result.unwrap(), Language::JavaScript);
}

#[test]
fn test_detect_javascript_jsx_extension() {
    let result = detect_or_parse_language(None, Path::new("component.jsx"));
    assert_eq!(result.unwrap(), Language::JavaScript);
}

#[test]
fn test_detect_java_extension() {
    let result = detect_or_parse_language(None, Path::new("Main.java"));
    assert_eq!(result.unwrap(), Language::Java);
}

#[test]
fn test_detect_c_extension() {
    let result = detect_or_parse_language(None, Path::new("main.c"));
    assert_eq!(result.unwrap(), Language::C);
}

#[test]
fn test_detect_cpp_extension() {
    let result = detect_or_parse_language(None, Path::new("main.cpp"));
    assert_eq!(result.unwrap(), Language::Cpp);
}

#[test]
fn test_detect_unknown_extension() {
    let result = detect_or_parse_language(None, Path::new("file.xyz"));

    assert!(result.is_err());
    match result.unwrap_err() {
        TldrError::UnsupportedLanguage(msg) => {
            assert!(msg.contains("Could not detect language"));
            assert!(msg.contains("file.xyz"));
        }
        _ => panic!("Expected UnsupportedLanguage error"),
    }
}

#[test]
fn test_detect_no_extension() {
    let result = detect_or_parse_language(None, Path::new("Makefile"));

    assert!(result.is_err());
}

#[test]
fn test_detect_empty_path() {
    let result = detect_or_parse_language(None, Path::new(""));

    assert!(result.is_err());
}

#[test]
fn test_detect_dot_file() {
    let result = detect_or_parse_language(None, Path::new(".gitignore"));

    assert!(result.is_err());
}

#[test]
fn test_explicit_overrides_extension() {
    // Even if file is .py, explicit "rust" should win
    let result = detect_or_parse_language(Some("rust"), Path::new("script.py"));
    assert_eq!(result.unwrap(), Language::Rust);
}

#[test]
fn test_explicit_overrides_unknown_extension() {
    // Explicit language works even with unknown extension
    let result = detect_or_parse_language(Some("python"), Path::new("script.xyz"));
    assert_eq!(result.unwrap(), Language::Python);
}

#[test]
fn test_detect_case_insensitive_extension() {
    let result = detect_or_parse_language(None, Path::new("script.PY"));
    assert_eq!(result.unwrap(), Language::Python);
}

#[test]
fn test_detect_case_insensitive_mixed() {
    let result = detect_or_parse_language(None, Path::new("script.Py"));
    assert_eq!(result.unwrap(), Language::Python);
}

// =============================================================================
// Edge Cases and Integration Tests
// =============================================================================

#[test]
fn test_validate_and_detect_workflow() {
    let temp = TempDir::new().unwrap();
    let py_file = temp.path().join("script.py");
    std::fs::write(&py_file, "print('hello')").unwrap();

    // First validate the path
    let validated = validate_file_path("script.py", Some(temp.path())).unwrap();

    // Then detect language
    let lang = detect_or_parse_language(None, &validated).unwrap();

    assert_eq!(lang, Language::Python);
}

#[test]
fn test_validate_and_explicit_language() {
    let temp = TempDir::new().unwrap();
    // File with no extension
    let file = temp.path().join("script");
    std::fs::write(&file, "content").unwrap();

    // Validate path
    let validated = validate_file_path("script", Some(temp.path())).unwrap();

    // Use explicit language since no extension
    let lang = detect_or_parse_language(Some("python"), &validated).unwrap();

    assert_eq!(lang, Language::Python);
}

#[test]
fn test_validate_many_files() {
    let temp = TempDir::new().unwrap();

    // Create many files
    for i in 0..100 {
        let file = temp.path().join(format!("file{}.py", i));
        std::fs::write(&file, "pass").unwrap();
    }

    // Validate all
    for i in 0..100 {
        let path = format!("file{}.py", i);
        let result = validate_file_path(&path, Some(temp.path()));
        assert!(result.is_ok(), "Failed for file{}", i);
    }
}

#[test]
fn test_detect_various_extensions() {
    let temp = TempDir::new().unwrap();

    let test_cases = vec![
        ("test.py", Language::Python),
        ("test.rs", Language::Rust),
        ("test.go", Language::Go),
        ("test.ts", Language::TypeScript),
        ("test.tsx", Language::TypeScript),
        ("test.js", Language::JavaScript),
        ("test.jsx", Language::JavaScript),
        ("test.java", Language::Java),
        ("test.c", Language::C),
        ("test.cpp", Language::Cpp),
        ("test.rb", Language::Ruby),
        ("test.kt", Language::Kotlin),
        ("test.swift", Language::Swift),
        ("test.cs", Language::CSharp),
        ("test.scala", Language::Scala),
        ("test.php", Language::Php),
        ("test.lua", Language::Lua),
        ("test.luau", Language::Luau),
        ("test.ex", Language::Elixir),
        ("test.ml", Language::Ocaml),
    ];

    for (filename, expected_lang) in test_cases {
        let file = temp.path().join(filename);
        std::fs::write(&file, "content").unwrap();

        let result = detect_or_parse_language(None, &file);
        assert_eq!(result.unwrap(), expected_lang, "Failed for {}", filename);
    }
}