zamm_yang 0.0.5

A basic, experimental code generator
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

use std::rc::Rc;
use zamm_yin::concepts::{Archetype, FormTrait};
use zamm_yin::graph::value_wrappers::KBValue;
use zamm_yin::graph::value_wrappers::StrongValue;
use zamm_yin::node_wrappers::BaseNodeTrait;

/// This trait allows documentation to be set and retrieved for a concept. This does not appear to
/// be usable from external crates.
#[allow(clippy::redundant_allocation)]
pub trait Documentable {
    /// Set documentation for this concept.
    fn set_documentation(&mut self, doc: &str);

    /// Retrieve documentation for this concept, if it exists.
    fn documentation(&self) -> Option<Rc<Box<dyn KBValue>>>;
}

impl Documentable for Archetype {
    fn set_documentation(&mut self, doc: &str) {
        set_documentation(self, doc)
    }

    fn documentation(&self) -> Option<Rc<Box<dyn KBValue>>> {
        self.essence().value()
    }
}

/// Set documentation for this concept.
pub fn set_documentation(form: &mut dyn FormTrait, doc: &str) {
    form.essence_mut()
        .set_value(Box::new(StrongValue::new(doc.to_string())));
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::concepts::{initialize_kb, Implement};
    use zamm_yin::concepts::ArchetypeTrait;
    use zamm_yin::graph::value_wrappers::unwrap_strong;

    #[test]
    fn test_archetype_documentation() {
        initialize_kb();
        Implement::archetype().set_documentation("This implements stuff.");
        assert_eq!(
            unwrap_strong(&Implement::archetype().documentation()),
            Some(&"This implements stuff.".to_string())
        );
    }
}