hexser 0.5.0

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

//! Visualization Tutorial
//!
//! Learn to visualize your hexagonal architecture using hex's
//! built-in export capabilities.
//!
//! Run with: cargo run --example visualization_tutorial --features visualization

fn main() -> hexser::HexResult<()> {
  use hexser::showcase::visualizable::Visualizable;
  println!("Architecture Visualization Tutorial\n");
  println!("{}", "=".repeat(60));

  // Build sample architecture
  let graph = hexser::graph::builder::GraphBuilder::new()
    .with_description("E-commerce System")
    .add_node(hexser::graph::hex_node::HexNode::new(
      hexser::graph::node_id::NodeId::from_name("Product"),
      hexser::graph::layer::Layer::Domain,
      hexser::graph::role::Role::Entity,
      "Product",
      "domain::product",
    ))
    .add_node(hexser::graph::hex_node::HexNode::new(
      hexser::graph::node_id::NodeId::from_name("ProductRepository"),
      hexser::graph::layer::Layer::Port,
      hexser::graph::role::Role::Repository,
      "ProductRepository",
      "ports::product_repository",
    ))
    .add_node(hexser::graph::hex_node::HexNode::new(
      hexser::graph::node_id::NodeId::from_name("PostgresProductRepository"),
      hexser::graph::layer::Layer::Adapter,
      hexser::graph::role::Role::Adapter,
      "PostgresProductRepository",
      "adapters::postgres_product_repository",
    ))
    .add_edge(hexser::graph::hex_edge::HexEdge::new(
      hexser::graph::node_id::NodeId::from_name("ProductRepository"),
      hexser::graph::node_id::NodeId::from_name("Product"),
      hexser::graph::relationship::Relationship::Depends,
    ))
    .add_edge(hexser::graph::hex_edge::HexEdge::new(
      hexser::graph::node_id::NodeId::from_name("PostgresProductRepository"),
      hexser::graph::node_id::NodeId::from_name("ProductRepository"),
      hexser::graph::relationship::Relationship::Implements,
    ))
    .build();

  println!("\n1. Basic Graph Info");
  println!("{}", "-".repeat(60));
  graph.pretty_print();

  println!("\n2. Export to DOT (GraphViz)");
  println!("{}", "-".repeat(60));
  let dot = graph.to_dot()?;
  println!("Generated DOT format ({} bytes)", dot.len());
  println!("\nTo render:");
  println!(
    "  echo '{}' | dot -Tpng > architecture.png",
    dot.lines().next().unwrap()
  );

  println!("\n3. Export to Mermaid");
  println!("{}", "-".repeat(60));
  let mermaid = graph.to_mermaid()?;
  println!("Generated Mermaid format ({} bytes)", mermaid.len());
  println!("\nTo use:");
  println!("  Copy to markdown:");
  println!("  ```mermaid");
  println!("  {}", mermaid.lines().next().unwrap());
  println!("  ...");
  println!("  ```");

  #[cfg(feature = "visualization")]
  {
    println!("\n4. Export to JSON (D3.js)");
    println!("{}", "-".repeat(60));
    let json = graph.to_json()?;
    println!("Generated JSON format ({} bytes)", json.len());
    println!("\nTo use:");
    println!("  Load in D3.js force graph visualization");
  }

  println!("\n{}", "=".repeat(60));
  println!("Tutorial Complete!");
  println!("\nNext Steps:");
  println!("  1. Save exports to files with std::fs::write");
  println!("  2. Integrate with documentation tools");
  println!("  3. Add to CI/CD for automated diagrams");
  println!("{}", "=".repeat(60));

  Ok(())
}