kui-core 0.1.0-alpha.56

//! A lookup by accessible name (backlog F137): `Core::key_named` finds a
//! node by what a reader hears it called — its `label` row, else the text
//! inside a control — where `key_of` reads the key label the view opened
//! it under, which a reader never hears.

use kui_core::{Core, NodeSpec, Size, TextStyle};

fn deck(core: &mut Core, two_deletes: bool) {
    let mut ui = core.frame(Size::new(400.0, 300.0), 1.0);
    ui.with(NodeSpec::row(), |ui| {
        ui.leaf_keyed(
            "like",
            NodeSpec::column()
                .size(40.0, 40.0)
                .on_click("like")
                .label("Like"),
        );
        ui.with_keyed("nope", NodeSpec::row().on_click("nope"), |ui| {
            ui.text("Nope", TextStyle::new(14.0));
        });
        let deletes = if two_deletes { 2 } else { 1 };
        for i in 0..deletes {
            ui.with_keyed(
                &format!("delete-{i}"),
                NodeSpec::row().on_click("delete"),
                |ui| ui.text("Delete", TextStyle::new(14.0)),
            );
        }
    });
    ui.finish();
}

#[test]
fn a_label_row_names_a_node_and_the_key_label_does_not() {
    let mut core = Core::new();
    deck(&mut core, false);
    let like = core.key_of("like").expect("keyed like");
    assert_eq!(core.key_named("Like"), Some(like));
    assert_eq!(
        core.key_named("like"),
        None,
        "the key label is not the name"
    );
    assert_eq!(core.key_of("Like"), None, "nor the name the key label");
}

#[test]
fn a_button_is_named_by_the_text_inside_it() {
    let mut core = Core::new();
    deck(&mut core, false);
    assert_eq!(core.key_named("Nope"), core.key_of("nope"));
    assert!(core.take_warnings().is_empty());
}

#[test]
fn two_nodes_with_one_name_resolve_to_the_first_and_warn() {
    let mut core = Core::new();
    deck(&mut core, true);
    assert_eq!(core.key_named("Delete"), core.key_of("delete-0"));
    let codes: Vec<_> = core.take_warnings().iter().map(|w| w.code).collect();
    assert_eq!(codes, vec!["ambiguous-name"]);
}

#[test]
fn no_node_with_the_name_is_none() {
    let mut core = Core::new();
    assert_eq!(core.key_named("Like"), None, "before any frame");
    deck(&mut core, false);
    assert_eq!(core.key_named("Superlike"), None);
}

/// Asked from inside a view, the lookup reads the last tree derived and
/// leaves the frame in progress alone: a half-built frame cached as the
/// access tree would be what a reader got for the whole frame.
#[test]
fn asked_mid_frame_it_does_not_cache_half_a_tree() {
    let mut core = Core::new();
    deck(&mut core, false);
    assert!(core.key_named("Like").is_some(), "the last frame's tree");
    let mut ui = core.frame(Size::new(400.0, 300.0), 1.0);
    ui.with(NodeSpec::row(), |ui| {
        ui.leaf_keyed(
            "alpha",
            NodeSpec::column()
                .size(10.0, 10.0)
                .on_click("a")
                .label("Alpha"),
        );
        let mid = ui.core().key_named("Like");
        assert!(mid.is_some(), "mid-frame, still the last frame's");
        ui.leaf_keyed(
            "beta",
            NodeSpec::column()
                .size(10.0, 10.0)
                .on_click("b")
                .label("Beta"),
        );
    });
    ui.finish();
    assert_eq!(
        core.key_named("Beta"),
        core.key_of("beta"),
        "the whole frame"
    );
    assert_eq!(core.key_named("Like"), None, "and not the last one");
}

/// berainder's deck (backlog F140): a round button labelled "like" and the
/// caption "like" under it are one name twice to a reader. The warning
/// says the caption is the decorative kind, and `role: none` on the box
/// around it takes it out of the tree — the lookup then finds the button
/// alone and says nothing.
#[test]
fn a_caption_beside_its_control_is_pointed_at_role_none() {
    use kui_core::Role;
    let deck = |core: &mut Core, decorative: bool| {
        let mut ui = core.frame(Size::new(400.0, 300.0), 1.0);
        ui.with(NodeSpec::column(), |ui| {
            ui.leaf_keyed(
                "like",
                NodeSpec::column()
                    .size(40.0, 40.0)
                    .on_click("like")
                    .label("like"),
            );
            let caption = if decorative {
                NodeSpec::row().role(Role::None)
            } else {
                NodeSpec::row()
            };
            ui.text_in_keyed("caption", caption, "like", TextStyle::new(12.0));
        });
        ui.finish();
    };
    let mut core = Core::new();
    deck(&mut core, false);
    assert_eq!(core.key_named("like"), core.key_of("like"));
    let warnings = core.take_warnings();
    assert_eq!(warnings.len(), 1);
    assert_eq!(warnings[0].code, "ambiguous-name");
    assert!(
        warnings[0].message.contains("role=\"none\""),
        "{}",
        warnings[0].message
    );

    deck(&mut core, true);
    assert_eq!(core.key_named("like"), core.key_of("like"));
    assert!(core.take_warnings().is_empty(), "the caption left the tree");
}

/// Two buttons with one name are not a caption: the plain message, which
/// names `label` and not `role="none"`.
#[test]
fn two_controls_with_one_name_get_the_plain_message() {
    let mut core = Core::new();
    deck(&mut core, true);
    core.key_named("Delete");
    let warnings = core.take_warnings();
    assert!(
        !warnings[0].message.contains("role="),
        "{}",
        warnings[0].message
    );
}