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
111
112
113
114
115
116
117
118
119
120
121
122

//! Wrappers around graph nodes that provide extended functionality at every level.

mod base_node;
mod final_node;
mod inheritance_node;

use crate::Wrapper;
pub use base_node::{BaseNode, BaseNodeTrait};
pub use final_node::FinalNode;
pub use inheritance_node::{InheritanceNode, InheritanceNodeTrait};
use std::fmt::{Formatter, Result};
use std::rc::Rc;

/// All wrappers around a graph node will have these functions available.
pub trait CommonNodeTrait {
    /// The unique integer that's associated with this concept.
    fn id(&self) -> usize;

    /// Associate this concept with an internal name. The name does not need to be unique.
    fn set_internal_name_str(&mut self, name: &str);

    /// The internal name that's associated with this concept, if one exists.
    fn internal_name_str(&self) -> Option<Rc<str>>;

    /// Associate this concept with an internal name. The name does not need to be unique.
    #[deprecated(since = "0.1.1", note = "Please use set_internal_name_str instead.")]
    fn set_internal_name(&mut self, name: String);

    /// The internal name that's associated with this concept, if one exists.
    #[deprecated(since = "0.1.1", note = "Please use internal_name_str instead.")]
    #[allow(clippy::rc_buffer)]
    fn internal_name(&self) -> Option<Rc<String>>;
}

impl<T> CommonNodeTrait for T
where
    T: Wrapper,
    T::BaseType: CommonNodeTrait,
{
    fn id(&self) -> usize {
        self.essence().id()
    }

    fn set_internal_name_str(&mut self, name: &str) {
        self.essence_mut().set_internal_name_str(name);
    }

    fn internal_name_str(&self) -> Option<Rc<str>> {
        self.essence().internal_name_str()
    }

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

    fn internal_name(&self) -> Option<Rc<String>> {
        self.essence()
            .internal_name_str()
            .map(|s| Rc::new((*s).to_owned()))
    }
}

/// Helper function for implementing the Debug trait for a node wrapper.
pub fn debug_wrapper(wrapper_type: &str, node: &dyn CommonNodeTrait, f: &mut Formatter) -> Result {
    match node.internal_name_str() {
        Some(name) => f.write_fmt(format_args!("{}({},{})", wrapper_type, node.id(), name)),
        None => f.write_fmt(format_args!("{}({})", wrapper_type, node.id())),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::tao::initialize_kb;

    struct TestNodeWrapper {
        actual: BaseNode,
    }

    impl From<BaseNode> for TestNodeWrapper {
        fn from(actual: BaseNode) -> Self {
            Self { actual }
        }
    }

    impl Wrapper for TestNodeWrapper {
        type BaseType = BaseNode;

        fn essence(&self) -> &BaseNode {
            &self.actual
        }

        fn essence_mut(&mut self) -> &mut BaseNode {
            &mut self.actual
        }
    }

    #[test]
    fn create_and_retrieve_node_id() {
        initialize_kb();
        let concept1 = BaseNode::new();
        let concept2 = BaseNode::new();
        assert_eq!(concept1.id() + 1, concept2.id());
    }

    #[test]
    fn create_and_retrieve_node_name() {
        initialize_kb();
        let mut concept = BaseNode::new();
        concept.set_internal_name_str("A");
        assert_eq!(concept.internal_name_str(), Some(Rc::from("A")));
    }

    #[test]
    #[allow(deprecated)]
    fn create_and_retrieve_deprecated_node_name() {
        initialize_kb();
        let mut concept = BaseNode::new();
        concept.set_internal_name("A".to_string());
        assert_eq!(concept.internal_name(), Some(Rc::new("A".to_string())));
    }
}