plumb-core 0.0.12

Deterministic design-system linter — rule engine and core types.
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

//! Multi-snapshot orchestration: `run_many` aggregates per-viewport
//! snapshots into one deterministic, sorted, deduped violation list.

use plumb_core::{Config, PlumbSnapshot, ViewportKey, Violation, run_many};

fn snapshot_for(viewport: &str, width: u32, height: u32) -> PlumbSnapshot {
    let mut snap = PlumbSnapshot::canned();
    snap.viewport = ViewportKey::new(viewport);
    snap.viewport_width = width;
    snap.viewport_height = height;
    snap
}

fn keys(violations: &[Violation]) -> Vec<(&str, &str, &str, u64)> {
    violations.iter().map(Violation::sort_key).collect()
}

#[test]
fn run_many_collects_violations_from_every_snapshot() {
    let mobile = snapshot_for("mobile", 375, 812);
    let desktop = snapshot_for("desktop", 1280, 800);
    let config = Config::default();

    let violations = run_many([&mobile, &desktop], &config);

    // The canned snapshot's `body` carries `padding-top: 13px`, which
    // is off-grid against the default `spacing.base_unit = 4`. Each
    // snapshot produces exactly one violation; both viewports must be
    // represented after sort + dedup.
    assert_eq!(violations.len(), 2);

    let viewports: Vec<&str> = violations.iter().map(|v| v.viewport.as_str()).collect();
    assert!(viewports.contains(&"mobile"));
    assert!(viewports.contains(&"desktop"));
}

#[test]
fn run_many_sorts_by_rule_id_viewport_selector_dom_order() {
    let mobile = snapshot_for("mobile", 375, 812);
    let desktop = snapshot_for("desktop", 1280, 800);
    let config = Config::default();

    let violations = run_many([&mobile, &desktop], &config);

    // Sort key is (rule_id, viewport, selector, dom_order). Both
    // violations share rule_id and selector, so viewport breaks the
    // tie alphabetically: `desktop` < `mobile`.
    assert_eq!(
        keys(&violations),
        vec![
            ("spacing/grid-conformance", "desktop", "html > body", 2_u64,),
            ("spacing/grid-conformance", "mobile", "html > body", 2_u64,),
        ],
    );
}

#[test]
fn run_many_is_input_order_independent() {
    let mobile = snapshot_for("mobile", 375, 812);
    let desktop = snapshot_for("desktop", 1280, 800);
    let config = Config::default();

    let forward = run_many([&mobile, &desktop], &config);
    let reverse = run_many([&desktop, &mobile], &config);

    assert_eq!(forward, reverse);
}