uobors_core 0.0.8

Unleash OpenBOR modding in Rust
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
106
107
108
109
110

pub mod model;

use anyhow::Result;
use garde::Validate;
use model::Model;

/// The OpenBOR project.
#[derive(Debug, Clone, PartialEq, Validate)]
pub struct Project {
    #[garde(skip)]
    models: Vec<Model>,
}

impl Project {
    /// Creates a new Project.
    ///
    /// # Arguments
    ///
    /// * `models` - The models in the project.
    ///
    /// # Returns
    ///
    /// * `anyhow::Result<Project>` - The result of creating a new Project.
    pub fn new(models: Vec<Model>) -> Result<Self> {
        let project = Self { models };

        for model in &project.models {
            model.validate(&())?;
        }

        Ok(project)
    }

    /// Returns the models in the project.
    pub fn models(&self) -> &[Model] {
        &self.models
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use image::RgbaImage;
    use model::{
        animation::{
            animation_name::AnimationName,
            animation_number::AnimationNumber,
            frame::{bbox::FrameBBox, delay::FrameDelay, offset::FrameOffset, Frame},
            Animation,
        },
        model_name::ModelName,
        model_type::ModelType,
        Model,
    };
    use rstest::{fixture, rstest};

    #[fixture]
    fn stub_frame() -> Frame {
        Frame::new(
            Some(FrameDelay::new(1).unwrap()),
            Some(FrameOffset::new(0, 0).unwrap()),
            Some(FrameBBox::new(0, 0, 10, 10, 0, 0).unwrap()),
            RgbaImage::new(1, 1),
        )
        .unwrap()
    }

    #[fixture]
    fn stub_animation() -> Animation {
        Animation::new(
            AnimationName::Idle,
            AnimationNumber::new(1).unwrap(),
            vec![stub_frame()],
        )
        .unwrap()
    }

    #[fixture]
    fn stub_model() -> Model {
        Model::new(
            ModelName::new("model").unwrap(),
            ModelType::Player,
            vec![stub_animation()],
        )
        .unwrap()
    }

    #[rstest]
    fn test_new_valid_with_one_model(stub_model: Model) {
        // Act
        let project = Project::new(vec![stub_model]);

        // Assert
        assert!(project.is_ok());
    }

    #[rstest]
    fn test_getters_with_one_model(stub_model: Model) {
        // Arrange
        let model_vec = vec![stub_model];
        let project = Project::new(model_vec.clone()).unwrap();

        // Act
        let models = project.models();

        // Assert
        assert_eq!(models.len(), 1);
        assert_eq!(models, &model_vec);
    }
}