hexser 0.4.7

Zero-boilerplate hexagonal architecture with graph-based introspection
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

//! Inspectable trait for components that support introspection.
//!
//! This trait enables components to expose their internal structure and
//! relationships for analysis, debugging, and visualization. It provides
//! access to dependencies, metadata, and architectural context.
//!
//! Revision History
//! - 2025-10-02T12:30:00Z @AI: Remove duplicate implementations, simplify trait.
//! - 2025-10-02T12:00:00Z @AI: Initial Inspectable trait implementation.

/// Trait for components that support introspection.
///
/// Provides methods for examining component structure, dependencies,
/// and architectural context.
///
/// # Example
///
/// ```rust
/// use hexser::showcase::Inspectable;
/// use hexser::graph::{HexNode, NodeId, Layer, Role};
///
/// let node = HexNode::new(
///     NodeId::from_name("Test"),
///     Layer::Domain,
///     Role::Entity,
///     "TestEntity",
///     "test::domain",
/// );
///
/// // Inspect the node
/// let layer_info = node.layer_info();
/// assert_eq!(layer_info.layer, Layer::Domain);
/// ```
pub trait Inspectable {
  /// Returns the layer this component belongs to.
  fn layer_info(&self) -> LayerInfo;

  /// Returns a list of component IDs this depends on.
  fn dependencies(&self) -> Vec<crate::graph::node_id::NodeId>;

  /// Returns a list of component IDs that depend on this.
  fn dependents(&self) -> Vec<crate::graph::node_id::NodeId>;
}

/// Information about a component's layer.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct LayerInfo {
  /// The architectural layer.
  pub layer: crate::graph::layer::Layer,

  /// The role within the layer.
  pub role: crate::graph::role::Role,

  /// Type name of the component.
  pub type_name: String,
}

impl Inspectable for crate::graph::hex_node::HexNode {
  fn layer_info(&self) -> LayerInfo {
    LayerInfo {
      layer: self.layer(),
      role: self.role(),
      type_name: String::from(self.type_name()),
    }
  }

  fn dependencies(&self) -> Vec<crate::graph::node_id::NodeId> {
    Vec::new()
  }

  fn dependents(&self) -> Vec<crate::graph::node_id::NodeId> {
    Vec::new()
  }
}

impl Inspectable for crate::graph::hex_graph::HexGraph {
  fn layer_info(&self) -> LayerInfo {
    LayerInfo {
      layer: crate::graph::layer::Layer::Unknown,
      role: crate::graph::role::Role::Unknown,
      type_name: String::from("HexGraph"),
    }
  }

  fn dependencies(&self) -> Vec<crate::graph::node_id::NodeId> {
    Vec::new()
  }

  fn dependents(&self) -> Vec<crate::graph::node_id::NodeId> {
    Vec::new()
  }
}

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

  /// Information about a component's layer
  #[derive(Debug, Clone, PartialEq)]
  pub struct LayerInfo {
    pub layer: crate::graph::layer::Layer,
    pub role: crate::graph::role::Role,
    pub allowed_dependencies: Vec<crate::graph::layer::Layer>,
  }

  impl crate::graph::hex_graph::HexGraph {
    /// Get dependencies for a node
    pub fn get_dependencies(
      &self,
      id: &crate::graph::node_id::NodeId,
    ) -> Vec<&crate::graph::hex_node::HexNode> {
      self
        .edges_from(id)
        .into_iter()
        .filter_map(|edge| self.get_node(&edge.target))
        .collect()
    }

    /// Get dependents for a node
    pub fn get_dependents(
      &self,
      id: &crate::graph::node_id::NodeId,
    ) -> Vec<&crate::graph::hex_node::HexNode> {
      self
        .edges_to(id)
        .into_iter()
        .filter_map(|edge| self.get_node(&edge.source))
        .collect()
    }
  }

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

    #[test]
    fn test_layer_info() {
      let info = LayerInfo {
        layer: crate::graph::layer::Layer::Domain,
        role: crate::graph::role::Role::Entity,
        allowed_dependencies: vec![],
      };

      assert_eq!(info.layer, crate::graph::layer::Layer::Domain);
      assert!(info.allowed_dependencies.is_empty());
    }
  }
  #[test]
  fn test_node_inspectable() {
    let node = crate::graph::hex_node::HexNode::new(
      crate::graph::node_id::NodeId::from_name("Test"),
      crate::graph::layer::Layer::Domain,
      crate::graph::role::Role::Entity,
      "TestEntity",
      "test::domain",
    );

    let layer_info = node.layer_info();
    assert_eq!(layer_info.layer, crate::graph::layer::Layer::Domain);
    assert_eq!(layer_info.role, crate::graph::role::Role::Entity);
    assert_eq!(layer_info.type_name, "TestEntity");

    let deps = node.dependencies();
    assert_eq!(deps.len(), 0);
  }

  #[test]
  fn test_graph_inspectable() {
    let graph = crate::graph::hex_graph::HexGraph::new();
    let layer_info = graph.layer_info();
    assert_eq!(layer_info.type_name, "HexGraph");
  }
}