sofie-check 0.2.0

Structure checks (comment density, god types) and the `sofie check` rules over the app model.
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

use std::path::PathBuf;

use sofie_check::{Finding, Rule, Screens};
use sofie_model::testing::{
    TemporaryDirectory, app, area, field, function, module, route, type_name,
};
use sofie_model::{InputDeclaration, Method, Route};

fn posting(path: &str, handler: &str) -> Route {
    route(Method::Post, path, handler, 2)
}

fn pick_input() -> InputDeclaration {
    InputDeclaration {
        name: "Pick".to_owned(),
        path: vec!["actions".to_owned(), "Pick".to_owned()],
        from: None,
        fields: vec![
            field("order", "OrderId", 3),
            field("note", "Option<String>", 4),
        ],
        unconstrained: Vec::new(),
        file: PathBuf::from("modules/order/src/actions.rs"),
        line: 2,
    }
}

fn action_findings(screen: &str) -> Vec<Finding> {
    let directory = TemporaryDirectory::new("sofie-check-actions");
    let routes = vec![
        posting("/orders/pick", "actions::pick"),
        posting("/orders/{order}/drop", "actions::drop"),
    ];
    let mut module = module("order", directory.path("modules/order"));
    let mut web = area(&module, "web", routes);
    web.screens = vec![directory.write("modules/order/src/areas/web/screens/orders.html", screen)];
    module.areas.push(web);
    let mut pick = function("actions::pick", "modules/order/src/actions.rs", 5);
    pick.arguments = vec![type_name("Pick")];
    module.code.functions = vec![
        pick,
        function("actions::drop", "modules/order/src/actions.rs", 9),
    ];
    module.code.inputs = vec![pick_input()];
    let app = app(directory.root(), vec![module]);
    sofie_check::check(&app, &Screens::read(&app.modules))
        .into_iter()
        .filter(|finding| finding.rule == Rule::ActionInput)
        .collect()
}

#[test]
fn an_action_posts_the_fields_its_route_s_input_requires_and_no_others() {
    let screen = "<Action post=\"/orders/pick\" label=\"x\" with={{order: data.id}} />\n\
        <Action post=\"/orders/pick\" label=\"x\" with={{order: data.id, note: 2, ordre: 1}} />\n\
        <Action post=\"/orders/pick\" label=\"x\" with={{note: 2}} />\n\
        <Action post=\"/orders/pick\" label=\"x\" />\n\
        <Action post=\"/orders/{data.id}/drop\" label=\"x\" with={{anything: 1}} />\n\
        <Action post=\"/elsewhere\" label=\"x\" with={{anything: 1}} />\n";

    let findings = action_findings(screen);

    let lines: Vec<usize> = findings.iter().map(|finding| finding.line).collect();
    assert_eq!(lines, [2, 3, 4], "{findings:#?}");
    assert!(
        findings[0]
            .message
            .contains("sends `ordre`, but its input `Pick` has no field"),
        "{}",
        findings[0].message
    );
    assert!(
        findings[1]
            .message
            .contains("does not send `order`, which its input `Pick` requires"),
        "{}",
        findings[1].message
    );
}