weavatrix-scan 0.1.1

Deterministic, safe repository scanner for code intelligence
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

use super::parser::parse_rule;
use super::*;

#[test]
fn parser_handles_negation_case_and_invalid_patterns() {
    let rule = parse_rule("!DROP.RS", true).unwrap().unwrap();
    assert_eq!(rule.action, RuleAction::Include);
    assert!(rule.matcher.matches(&rule.pattern, "drop.rs"));
    assert!(parse_rule("{broken", false).is_err());
}

#[test]
fn preserves_escaped_trailing_spaces() {
    let rule = parse_rule(r"name\ ", false).unwrap().unwrap();
    assert!(rule.matcher.matches(&rule.pattern, "name "));
    assert!(!rule.matcher.matches(&rule.pattern, "name"));
}

#[test]
fn valid_gitignore_patterns_match_the_reference_backend() {
    use ignore::gitignore::GitignoreBuilder;

    const PATTERNS: &[&str] = &[
        "*.rs",
        "!keep.rs",
        "/root.rs",
        "docs/",
        "foo/bar",
        "foo/**/bar",
        "abc/**",
        "**/cache/*.tmp",
        "[ab].rs",
        "[!a-c].rs",
        r"file\[1\].rs",
        r"\#literal",
        r"\!literal",
        r"name\ space",
        r"name\ ",
        r"foo\/",
        "{foo,bar}.rs",
        "a/***/b",
        "[literal",
        "foo*",
        "*foo",
        "src/*",
        "/foo*",
        "foo?",
        "foo[0-9]",
        "foo[!0-9].txt",
        "**/foo",
        "foo/**",
        "foo/**/*",
        "a/**/b/**/c",
        "a*b/c",
        "/foo/bar",
        "foo/bar/",
        "!foo/bar",
        "**",
    ];
    const CANDIDATES: &[(&str, bool)] = &[
        ("root.rs", false),
        ("src/root.rs", false),
        ("keep.rs", false),
        ("src/keep.rs", false),
        ("drop.rs", false),
        ("docs", true),
        ("docs/guide.rs", false),
        ("src/docs", true),
        ("foo", true),
        ("foo/bar", false),
        ("foo/a/bar", false),
        ("foo/a/b/bar", false),
        ("abc", true),
        ("abc/child", false),
        ("src/cache/drop.tmp", false),
        ("cache/keep.rs", false),
        ("a.rs", false),
        ("z.rs", false),
        ("file[1].rs", false),
        ("#literal", false),
        ("!literal", false),
        ("name space", false),
        ("name ", false),
        ("foo.rs", false),
        ("bar.rs", false),
        ("a/x/b", false),
        ("[literal", false),
        ("foo0", false),
        ("foo9", false),
        ("fooa", false),
        ("foo7.txt", false),
        ("fooa.txt", false),
        ("nested/foo", false),
        ("foo/child", false),
        ("foo/deep/child", false),
        ("a/x/b/y/c", false),
        ("axxb/c", false),
        ("nested/foo/bar", false),
        ("foo/bar", true),
    ];

    for pattern in PATTERNS {
        let mut ours = RuleSet::default();
        let rule = parse_rule(pattern, false)
            .unwrap_or_else(|error| panic!("{pattern:?}: {error}"))
            .expect("test patterns are not comments");
        ours.push(rule);

        let mut builder = GitignoreBuilder::new("");
        builder
            .add_line(None, pattern)
            .unwrap_or_else(|error| panic!("{pattern:?}: {error}"));
        let reference = builder.build().unwrap();
        for &(candidate, is_directory) in CANDIDATES {
            let ours = ours.matches(candidate, is_directory);
            let matched = reference.matched_path_or_any_parents(candidate, is_directory);
            let expected = if matched.is_ignore() {
                Some(RuleAction::Ignore)
            } else if matched.is_whitelist() {
                Some(RuleAction::Include)
            } else {
                None
            };
            assert_eq!(
                ours, expected,
                "pattern={pattern:?} candidate={candidate:?} dir={is_directory}"
            );
        }
    }
}