opy-rs 0.3.9

//! Canonical WIR lowering coverage for HUD actions.

use std::path::{Path, PathBuf};

use crate::Compiler;
use workshop_rs::catalog::{Catalog, Locale};
use workshop_rs::roundtrip::equivalent;
use workshop_rs::{Action, Value};

fn fixture_dir() -> PathBuf {
    Path::new(env!("CARGO_MANIFEST_DIR")).join("tests/fixtures/corpus/synthetic/hud-subheader")
}

fn oracle_workshop() -> String {
    let value: serde_json::Value = serde_json::from_str(
        &std::fs::read_to_string(fixture_dir().join("oracle.json"))
            .expect("oracle must be readable"),
    )
    .expect("oracle must parse");
    value["compile"]["workshop"]
        .as_str()
        .expect("oracle must contain Workshop output")
        .to_string()
}

#[test]
fn hud_subheader_matches_the_pinned_canonical_wir() {
    let dir = fixture_dir();
    let source = std::fs::read_to_string(dir.join("source.opy")).expect("source must be readable");
    let hir = crate::compile(&source, "source.opy", &dir).expect("source must resolve");
    let artifact = Compiler::new()
        .expect("released workshop contract must load")
        .compile_hir(&hir)
        .expect("hudSubheader must lower to canonical WIR");

    let catalog = Catalog::builtin().expect("catalog must load");
    let oracle = workshop_rs::parser::parse(&oracle_workshop(), &catalog, &Locale::new("en-US"))
        .expect("oracle output must reparse");
    let program = super::canonical_program(&artifact);
    assert!(
        equivalent(&program, &oracle),
        "hudSubheader WIR diverged from the pinned oracle\n--- native ---\n{}\n--- oracle ---\n{}",
        artifact.emitted,
        oracle_workshop()
    );

    let rule = program.rules.first().expect("fixture has one rule");
    let Action::Call { name, args } = rule.actions.first().expect("fixture has one action") else {
        panic!("hudSubheader must lower to a canonical action call");
    };
    assert_eq!(name, "createHudText");
    assert_eq!(args.len(), 11);
    assert!(matches!(
        &args[0],
        Value::Call { name, args } if name == "allPlayers" && args.len() == 1
    ));
    assert!(matches!(args[1], Value::Null));
    assert!(matches!(args[3], Value::Null));
    assert!(matches!(args[6], Value::Null));
    assert!(matches!(args[8], Value::Null));
    assert!(matches!(
        &args[4],
        Value::Enum { value_type, value }
            if value_type == "HudPosition" && value == "TOP"
    ));
    assert!(matches!(
        &args[7],
        Value::Enum { value_type, value }
            if value_type == "Color" && value == "WHITE"
    ));
    assert!(matches!(
        &args[9],
        Value::Enum { value_type, value }
            if value_type == "HudReeval" && value == "VISIBILITY"
    ));
    assert!(matches!(
        &args[10],
        Value::Enum { value_type, value }
            if value_type == "SpecVisibility" && value == "DEFAULT"
    ));
}

#[test]
fn hud_subheader_omitted_spectators_use_default_visibility() {
    let source = "rule \"r\":\n    @Event global\n    hudSubheader(getAllPlayers(), \"text\", HudPosition.TOP, 0, Color.WHITE, HudReeval.VISIBILITY)\n";
    let hir = crate::compile(source, "source.opy", Path::new(".")).expect("source must resolve");
    let artifact = Compiler::new()
        .expect("released workshop contract must load")
        .compile_hir(&hir)
        .expect("hudSubheader default visibility must lower");
    let program = super::canonical_program(&artifact);
    let Action::Call { args, .. } = &program.rules[0].actions[0] else {
        panic!("hudSubheader must lower to a canonical action call");
    };
    assert!(matches!(
        &args[10],
        Value::Enum { value_type, value }
            if value_type == "SpecVisibility" && value == "DEFAULT"
    ));
}

#[test]
fn other_hud_helpers_lower_to_their_canonical_text_slots() {
    for helper in ["hudHeader", "hudSubtext"] {
        let source = format!(
            "rule \"r\":\n    @Event global\n    {helper}(getAllPlayers(), \"text\", HudPosition.TOP, 0, Color.WHITE, HudReeval.VISIBILITY, SpecVisibility.DEFAULT)\n"
        );
        let hir =
            crate::compile(&source, "source.opy", Path::new(".")).expect("source must resolve");
        let artifact = Compiler::new()
            .expect("released workshop contract must load")
            .compile_hir(&hir)
            .expect("HUD helper must lower");
        let program = super::canonical_program(&artifact);
        let Action::Call { name, args } = &program.rules[0].actions[0] else {
            panic!("HUD helper must lower to a canonical action call");
        };
        assert_eq!(name, "createHudText");
        let text_slot = if helper == "hudHeader" { 1 } else { 3 };
        assert!(matches!(
            &args[text_slot],
            Value::Call { name, args } if name == "customString" && args.len() == 1
        ));
    }
}

#[test]
fn hud_helpers_keep_existing_formatted_text_calls_flat() {
    let source = "rule \"r\":\n    @Event global\n    hudHeader(getAllPlayers(), \"value: {}\".format(1), HudPosition.TOP, 0, Color.WHITE, HudReeval.VISIBILITY, SpecVisibility.DEFAULT)\n";
    let hir = crate::compile(source, "source.opy", Path::new(".")).unwrap();
    let artifact = Compiler::new().unwrap().compile_hir(&hir).unwrap();

    assert!(
        artifact
            .emitted
            .contains("Custom String(\"value: 1\"), Null, Null, Top")
    );
    assert!(!artifact.emitted.contains("Custom String(Custom String("));
}