zamm_yang 0.0.3

A basic, experimental code generator
use super::{add_autogeneration_comments, into_docstring, OutputOptions};

/// Generate code for attributes.
pub fn code_attribute<'a>(options: &OutputOptions<'a>) -> String {
    let doc_insert = match &options.doc {
        Some(d) => format!("\n{}", into_docstring(d.as_str(), 0)),
        None => String::new(),
    };
    let id = if options.yin {
        format!("{}", options.id)
    } else {
        format!("YIN_MAX_ID + {}", options.id)
    };
    let crate_name = if options.yin { "crate" } else { "zamm_yin" };
    let imports = if options.yin { "" } else { ", YIN_MAX_ID" };
    let test_imports = if options.yin {
        "use crate::graph::bind_in_memory_graph;"
    } else {
        "use crate::concepts::initialize_kb;"
    };
    let init_kb = if options.yin {
        "bind_in_memory_graph();"
    } else {
        "initialize_kb();"
    };
    let code = format!(
        r##"use std::fmt::{{Debug, Formatter, Result}};
use std::rc::Rc;
use {crate}::concepts::attributes::{{Attribute, AttributeTrait}};
use {crate}::concepts::{{ArchetypeTrait, FormTrait, Tao{imports}}};
use {crate}::node_wrappers::{{debug_wrapper, CommonNodeTrait, FinalNode}};
{doc}
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct {name} {{
    attr: Attribute,
}}

impl Debug for {name} {{
    fn fmt(&self, f: &mut Formatter) -> Result {{
        debug_wrapper("{name}", Box::new(self), f)
    }}
}}

impl From<usize> for {name} {{
    fn from(id: usize) -> Self {{
        Self {{
            attr: Attribute::from(id),
        }}
    }}
}}

impl CommonNodeTrait for {name} {{
    fn id(&self) -> usize {{
        self.attr.id()
    }}

    fn set_internal_name(&mut self, name: String) {{
        self.attr.set_internal_name(name);
    }}

    fn internal_name(&self) -> Option<Rc<String>> {{
        self.attr.internal_name()
    }}
}}

impl ArchetypeTrait<{name}> for {name} {{
    const TYPE_ID: usize = {id};
    const TYPE_NAME: &'static str = "{name}";
    const PARENT_TYPE_ID: usize = Attribute::TYPE_ID;

    fn individuate_with_parent(parent_id: usize) -> Self {{
        Self {{
            attr: Attribute::individuate_with_parent(parent_id),
        }}
    }}
}}

impl FormTrait for {name} {{
    fn essence(&self) -> &FinalNode {{
        self.attr.essence()
    }}

    fn essence_mut(&mut self) -> &mut FinalNode {{
        self.attr.essence_mut()
    }}
}}

impl AttributeTrait<{name}> for {name} {{
    fn set_owner(&mut self, owner: Box<&dyn FormTrait>) {{
        self.attr.set_owner(owner);
    }}

    fn owner(&self) -> Option<Tao> {{
        self.attr.owner()
    }}

    fn set_value(&mut self, value: Box<&dyn FormTrait>) {{
        self.attr.set_value(value);
    }}

    fn value(&self) -> Option<Tao> {{
        self.attr.value()
    }}
}}

#[cfg(test)]
mod tests {{
    use super::*;
    {test_imports}

    #[test]
    fn check_type_created() {{
        {init_kb}
        assert_eq!({name}::archetype().id(), {name}::TYPE_ID);
        assert_eq!(
            {name}::archetype().internal_name(),
            Some(Rc::new({name}::TYPE_NAME.to_string()))
        );
    }}

    #[test]
    fn from_node_id() {{
        {init_kb}
        let concept = {name}::individuate();
        let concept_copy = {name}::from(concept.id());
        assert_eq!(concept.id(), concept_copy.id());
    }}

    #[test]
    fn create_and_retrieve_node_id() {{
        {init_kb}
        let concept1 = {name}::individuate();
        let concept2 = {name}::individuate();
        assert_eq!(concept1.id() + 1, concept2.id());
    }}

    #[test]
    fn create_and_retrieve_node_name() {{
        {init_kb}
        let mut concept = {name}::individuate();
        concept.set_internal_name("A".to_string());
        assert_eq!(concept.internal_name(), Some(Rc::new("A".to_string())));
    }}

    #[test]
    fn get_owner() {{
        {init_kb}
        let mut instance = {name}::individuate();
        let owner_of_owner = {name}::individuate();
        instance.set_owner(Box::new(&owner_of_owner));
        assert_eq!(instance.owner(), Some(owner_of_owner.ego_death()));
        assert_eq!(instance.value(), None);
    }}

    #[test]
    fn get_value() {{
        {init_kb}
        let mut instance = {name}::individuate();
        let value_of_owner = {name}::individuate();
        instance.set_value(Box::new(&value_of_owner));
        assert_eq!(instance.owner(), None);
        assert_eq!(instance.value(), Some(value_of_owner.ego_death()));
    }}
}}
"##,
        crate = crate_name,
        imports = imports,
        test_imports = test_imports,
        init_kb = init_kb,
        name = options.name,
        doc = doc_insert,
        id = id
    );
    if options.comment_autogen {
        add_autogeneration_comments(&code)
    } else {
        code
    }
}

#[cfg(test)]
mod tests {
    use super::super::mark_autogen::AUTOGENERATION_MARKER;
    use super::*;

    #[test]
    fn test_autogen_comments() {
        let code = code_attribute(&OutputOptions {
            name: "dummy",
            doc: None,
            id: 3,
            comment_autogen: true,
            yin: false,
        });
        assert!(code.contains(AUTOGENERATION_MARKER));
        assert!(code.contains("YIN_MAX_ID"));
    }

    #[test]
    fn test_autogen_no_comments() {
        assert!(!code_attribute(&OutputOptions {
            name: "dummy",
            doc: None,
            id: 3,
            comment_autogen: false,
            yin: false
        })
        .contains(AUTOGENERATION_MARKER));
    }

    #[test]
    fn test_autogen_yin() {
        assert!(!code_attribute(&OutputOptions {
            name: "dummy",
            doc: None,
            id: 3,
            comment_autogen: true,
            yin: true
        })
        .contains("YIN_MAX_ID"));
    }
}