zamm_yang 0.1.8

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

use crate::tao::perspective::BuildInfo;
use crate::tao::Implement;
use std::rc::Rc;
use zamm_yin::node_wrappers::CommonNodeTrait;
use zamm_yin::tao::form::FormTrait;

/// Extension functions for Implement concept.
pub trait ImplementExtension: FormTrait + CommonNodeTrait {
    /// Set the dual-purpose documentation string for this implementation.
    fn dual_document(&mut self, document: &str) {
        // already defined in Implement, it's just that Implement isn't a trait so we can't rely on
        // it here
        let implement = Implement::from(self.id());
        BuildInfo::from(implement.target().unwrap().id())
            .set_dual_purpose_documentation(document.to_owned());
    }

    /// Get the dual-purpose documentation string for this implementation.
    fn dual_documentation(&self) -> Option<Rc<str>> {
        // already defined in Implement, it's just that Implement isn't a trait so we can't rely on
        // it here
        let implement = Implement::from(self.id());
        BuildInfo::from(implement.target().unwrap().id())
            .dual_purpose_documentation()
            .map(|rc| Rc::from(rc.as_str()))
    }
}

impl ImplementExtension for Implement {}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::tao::initialize_kb;
    use zamm_yin::tao::archetype::ArchetypeTrait;
    use zamm_yin::tao::relation::attribute::Owner;

    #[test]
    fn set_and_retrieve_target() {
        initialize_kb();
        let mut implement = Implement::new();
        implement.set_target(&Owner::archetype().as_form());
        assert_eq!(implement.target(), Some(Owner::archetype().as_form()));
    }

    #[test]
    fn set_and_retrieve_dual_documentation() {
        initialize_kb();
        let mut implement = Implement::new();
        implement.set_target(&implement.as_form());
        implement.dual_document("duels as being outdated.");
        assert_eq!(
            implement.dual_documentation(),
            Some(Rc::from("duels as being outdated."))
        );
    }

    #[test]
    fn test_documentation_and_dual_documentation_independent() {
        initialize_kb();
        let mut implement = Implement::new();
        implement.set_target(&implement.as_form());
        implement.set_documentation("Some new thing.".to_owned());
        implement.dual_document("duels as being outdated.");
        assert_eq!(
            implement.documentation(),
            Some(Rc::from("Some new thing.".to_owned()))
        );
        assert_eq!(
            implement.dual_documentation(),
            Some(Rc::from("duels as being outdated."))
        );
    }
}