kimun 0.31.1

Code metrics tool — health score, complexity, duplication, hotspots, ownership
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

use super::*;

#[test]
fn a_file_and_its_test_are_at_the_same_place() {
    let same = |source: &str, test: &str| place(Path::new(source)) == place(Path::new(test));

    assert!(same(
        "lib/app_web/controllers/user_controller.ex",
        "test/app_web/controllers/user_controller_test.exs"
    ));
    assert!(same("apps/a/lib/a/b.ex", "apps/a/test/a/b_test.exs"));
    assert!(same("src/ui/button.ts", "src/ui/button.test.ts"));
    assert!(same("src/ui/button.ts", "src/ui/__tests__/button.spec.ts"));
    assert!(same("pkg/parser.py", "pkg/tests/test_parser.py"));
    assert!(same("src/Parser.hs", "test/ParserSpec.hs"));
    // Another project, another directory or another name is another place.
    assert!(!same("apps/a/lib/a/b.ex", "apps/c/test/a/b_test.exs"));
    assert!(!same(
        "lib/app/users.ex",
        "test/app/accounts/users_test.exs"
    ));
    assert!(!same("lib/app/user.ex", "test/app/users_test.exs"));
}

fn named(test: &str, source: &str) -> bool {
    named_after(&place(Path::new(test)), &place(Path::new(source)))
}

#[test]
fn a_test_named_after_a_file_a_directory_apart() {
    // The source has a directory the test does not.
    assert!(named(
        "test/app_web/page_live_test.exs",
        "lib/app_web/live/page_live.ex"
    ));
    assert!(named(
        "test/app_web/controllers/user_controller_test.exs",
        "lib/app_web/controllers/internal/user_controller.ex"
    ));
    // Or the other way around.
    assert!(named(
        "test/app_web/live/page_live_test.exs",
        "lib/app_web/page_live.ex"
    ));
    // At the same place it is a mirror, not a namesake.
    assert!(!named(
        "test/app_web/page_live_test.exs",
        "lib/app_web/page_live.ex"
    ));
    // Two directories apart, the name alone says little: `helpers` is everywhere.
    assert!(!named(
        "test/app_web/helpers_test.exs",
        "lib/app_web/live/users_live/helpers.ex"
    ));
    // Another branch of the tree is another file.
    assert!(!named(
        "test/app_web/admin/page_live_test.exs",
        "lib/app_web/live/page_live.ex"
    ));
    assert!(!named(
        "test/other_web/page_live_test.exs",
        "lib/app_web/live/page_live.ex"
    ));
}

#[test]
fn a_test_named_after_the_directory_of_a_file() {
    // A view with a directory of its own, tested as a whole.
    assert!(named(
        "test/app_web/live/operators_live_test.exs",
        "lib/app_web/live/operators_live/index.ex"
    ));
    assert!(named(
        "test/app_web/operators_live_test.exs",
        "lib/app_web/live/operators_live/form.ex"
    ));
    // The directory has to be the one right above the file.
    assert!(!named(
        "test/app_web/live/operators_live_test.exs",
        "lib/app_web/live/operators_live/components/row.ex"
    ));
    assert!(!named(
        "test/app_web/live/users_live_test.exs",
        "lib/app_web/live/operators_live/index.ex"
    ));
    assert!(!named("test/x_test.exs", "x.ex"));
}

/// Tests of the files given as `(path, is_test)`, with `refers` as the
/// pairs `(test, file)` of what each test refers to, by index.
fn tests_of(files: &[(&str, bool)], refers: &[(usize, usize)]) -> Tests {
    let paths: Vec<PathBuf> = files.iter().map(|(p, _)| PathBuf::from(p)).collect();
    let mut referring = vec![Vec::new(); files.len()];
    for &(test, file) in refers {
        referring[file].push(test);
    }
    Tests::of(&paths, referring, |f| files[f].1, |f| !files[f].1)
}

#[test]
fn protection_from_the_strongest_test_there_is() {
    let files = [
        ("lib/app/users.ex", false), // 0: a test refers to it
        ("lib/app_web/controllers/user_controller.ex", false), // 1: mirrored
        ("lib/app_web/live/page_live.ex", false), // 2: named
        ("lib/app/formatting.ex", false), // 3: used by 2
        ("lib/app/orphan.ex", false), // 4: nothing
        ("lib/app/leaf.ex", false),  // 5: used by 4 only
        ("test/app/accounts_test.exs", true), // 6
        ("test/app_web/controllers/user_controller_test.exs", true), // 7
        ("test/app_web/page_live_test.exs", true), // 8
    ];
    let tests = tests_of(&files, &[(6, 0)]);

    assert_eq!(tests.protection(0, &[]), Protection::Direct);
    assert_eq!(tests.direct(0), [6]);
    assert_eq!(tests.protection(1, &[]), Protection::Direct);
    assert_eq!(tests.direct(1), [7]);
    assert_eq!(tests.protection(2, &[]), Protection::Named);
    assert!(tests.direct(2).is_empty());
    assert_eq!(tests.own(2).collect::<Vec<_>>(), [8]);
    // No test of its own; the view that uses it has one.
    assert_eq!(tests.protection(3, &[2]), Protection::Users);
    assert_eq!(tests.protection(4, &[]), Protection::None);
    // Being used by a file with no test protects nothing.
    assert_eq!(tests.protection(5, &[4]), Protection::None);
    // A user that is itself only protected through its users does not count.
    assert_eq!(tests.protection(5, &[3]), Protection::None);
}

#[test]
fn a_reference_and_a_mirror_count_once() {
    let files = [
        ("lib/app/users.ex", false),
        ("test/app/users_test.exs", true),
    ];
    let tests = tests_of(&files, &[(1, 0)]);
    assert_eq!(tests.direct(0), [1]);
}

#[test]
fn protection_orders_from_strongest_to_none() {
    assert!(Protection::Direct < Protection::Named);
    assert!(Protection::Named < Protection::Users);
    assert!(Protection::Users < Protection::None);
}

#[test]
fn a_test_at_the_place_of_a_source_names_no_other() {
    let files = [
        ("lib/app.ex", false),                                // 0: mirrored by 5
        ("lib/app/orders.ex", false), // 1: in the directory 5 is named after
        ("lib/app_web/live/page_live/index.ex", false), // 2: mirrored by 6
        ("lib/app_web/live/page_live/edit/index.ex", false), // 3: same name as 6, a directory apart
        ("lib/app_web/live/cart_live/index.ex", false), // 4: named by 7
        ("test/app_test.exs", true),  // 5
        ("test/app_web/live/page_live/index_test.exs", true), // 6
        ("test/app_web/live/cart_live_test.exs", true), // 7
    ];
    let tests = tests_of(&files, &[]);

    assert_eq!(tests.protection(0, &[]), Protection::Direct);
    assert_eq!(tests.protection(1, &[]), Protection::None);
    assert_eq!(tests.protection(2, &[]), Protection::Direct);
    assert_eq!(tests.protection(3, &[]), Protection::None);
    assert_eq!(tests.protection(4, &[]), Protection::Named);
}