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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

use std::collections::HashMap;
use std::path::{Path, PathBuf};
use std::{fs, io};

use sofie_engine::{ActionPost, Binding, Components, Template, TemplateError};
use sofie_model::Module;

/// Read and parsed once per run, then borrowed by every rule and generator.
pub struct Screens {
    by_file: HashMap<PathBuf, io::Result<Screen>>,
    components: Components,
    /// A `web/` component that cannot be read or added, with why.
    refused_components: Vec<(PathBuf, String)>,
}

pub struct Screen {
    pub source: String,
    pub template: Result<Template, TemplateError>,
    pub bindings: Result<Vec<Binding>, TemplateError>,
    pub actions: Result<Vec<ActionPost>, TemplateError>,
}

impl Screens {
    #[must_use]
    pub fn read(modules: &[Module]) -> Self {
        let (components, refused_components) = read_components(modules);
        let files = modules
            .iter()
            .flat_map(|module| &module.areas)
            .flat_map(|area| {
                let overrides = area.overrides.iter().map(|replacement| &replacement.file);
                area.screens.iter().chain(overrides)
            });
        let by_file = files
            .map(|file| (file.clone(), Screen::read(file, &components)))
            .collect();
        Self {
            by_file,
            components,
            refused_components,
        }
    }

    /// # Panics
    ///
    /// When `file` is no screen or override of the app the screens were read from.
    #[must_use]
    pub fn screen(&self, file: &Path) -> &io::Result<Screen> {
        self.by_file.get(file).unwrap_or_else(|| {
            panic!(
                "{} is not a screen of the app the screens were read from",
                file.display()
            )
        })
    }

    #[must_use]
    pub fn components(&self) -> &Components {
        &self.components
    }

    #[must_use]
    pub fn refused_components(&self) -> &[(PathBuf, String)] {
        &self.refused_components
    }
}

fn read_components(modules: &[Module]) -> (Components, Vec<(PathBuf, String)>) {
    let mut components = Components::default();
    let mut refused = Vec::new();
    for file in modules.iter().flat_map(|module| &module.components) {
        let name = file
            .file_stem()
            .map(|stem| stem.to_string_lossy().into_owned())
            .unwrap_or_default();
        let added = fs::read_to_string(file)
            .map_err(|error| format!("the component cannot be read: {error}"))
            .and_then(|source| components.add(&name, source).map_err(|error| error.message));
        if let Err(message) = added {
            refused.push((file.clone(), message));
        }
    }
    (components, refused)
}

impl Screen {
    fn read(file: &Path, components: &Components) -> io::Result<Self> {
        let source = fs::read_to_string(file)?;
        let name = file.display().to_string();
        Ok(Self {
            template: Template::parse_with(&name, &source, components),
            bindings: sofie_engine::bindings_with(&name, &source, components),
            actions: sofie_engine::action_posts_with(&name, &source, components),
            source,
        })
    }
}