sofie-cli 0.4.0

The `sofie` command: gen, check and the tools reading 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
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

use sofie_model::{App, Crate, Module};

use super::Edits;
use super::edits::{module_file, refuse_function};
use crate::gen_command::GenError;
use crate::source_edits::add_import;

const PRELUDE: (&str, &str) = ("use sofie::prelude", "*");

pub(super) fn new_event(
    edits: &mut Edits,
    app: &App,
    module: &Module,
    name: &str,
) -> Result<(), GenError> {
    let contract = module.contract.as_ref().ok_or_else(|| {
        GenError::Usage(format!(
            "module `{}` has no contract crate (`contract/`), where its events are declared",
            module.krate.crate_name
        ))
    })?;
    if module.events.iter().any(|event| event == name) {
        return Err(GenError::Usage(format!(
            "module `{}` declares the event `{name}` already",
            module.krate.crate_name
        )));
    }
    edits.append(
        &module_file(contract, "events"),
        &[PRELUDE],
        &format!("#[derive(Event)]\npub struct {name} {{}}\n"),
    )?;
    let library = contract.path.join("src").join("lib.rs");
    edits.declare(contract, &["events"])?;
    edits.edit_rust(&library, |text| {
        Ok(add_import(text, "pub use events", name))
    })?;
    edits.depend_on_framework(contract)?;
    edits.allow_unused(&app.root, &contract.package, name, "event")
}

pub(super) fn new_listener(
    edits: &mut Edits,
    app: &App,
    module: &Module,
    event: &str,
    handler: &str,
) -> Result<(), GenError> {
    let contract = event_contract(app, event)?;
    let file = module_file(&module.krate, "listeners");
    refuse_function(&file, handler)?;
    if module
        .listeners
        .iter()
        .any(|listener| listener.function.last().is_some_and(|last| last == handler))
    {
        return Err(GenError::Usage(format!(
            "{} has a function `{handler}` already; choose another name",
            file.display()
        )));
    }
    let import = format!("use {}", contract.crate_name);
    edits.append(
        &file,
        &[PRELUDE, (&import, event)],
        &format!(
            "#[on]\npub async fn {handler}(_event: {event}) -> Result<()> {{\n    Ok(())\n}}\n"
        ),
    )?;
    edits.declare(&module.krate, &["listeners"])?;
    edits.depend(&module.krate, contract)?;
    edits.stop_allowing_unused(&app.root, &contract.package, event)
}

/// Only an event its contract declares may be listened to; one declared in a module crate is a finding already.
fn event_contract<'app>(app: &'app App, event: &str) -> Result<&'app Crate, GenError> {
    let mut declaring = app.modules.iter().filter_map(|module| {
        let contract = module.contract.as_ref()?;
        let in_contract = module.events.iter().any(|name| name == event)
            && module
                .module_events
                .iter()
                .all(|declaration| declaration.name != event);
        in_contract.then_some(contract)
    });
    match (declaring.next(), declaring.next()) {
        (Some(contract), None) => Ok(contract),
        (Some(first), Some(second)) => Err(GenError::Usage(format!(
            "both `{}` and `{}` declare an event `{event}`; rename one",
            first.package, second.package
        ))),
        (None, _) => {
            let known: Vec<&str> = app
                .modules
                .iter()
                .flat_map(|module| &module.events)
                .map(String::as_str)
                .collect();
            Err(GenError::Usage(format!(
                "no contract declares an event `{event}`; the app's events: {}",
                known.join(", ")
            )))
        }
    }
}