elkrb 1.0.0

data/benchmarks/results/elkrb_summary.json

@@ -0,0 +1,285 @@
+{
+  "timestamp": "2025-10-28T13:39:49+09:00",
+  "ruby_version": "3.3.2",
+  "elkrb_version": "0.4.3",
+  "results": {
+    "small_simple": {
+      "layered": {
+        "avg": 7.433500001206994,
+        "min": 6.854000006569549,
+        "max": 8.520000003045425,
+        "memory": 2368
+      },
+      "force": {
+        "avg": 127.22110000177054,
+        "min": 49.12799999874551,
+        "max": 782.6429999986431,
+        "memory": 1856
+      },
+      "stress": {
+        "avg": 18.048900002031587,
+        "min": 15.010000002803281,
+        "max": 23.14100001240149,
+        "memory": 288
+      },
+      "box": {
+        "avg": 6.4161000031162985,
+        "min": 5.8969999954570085,
+        "max": 6.9420000072568655,
+        "memory": 448
+      },
+      "random": {
+        "avg": 38.642400002572685,
+        "min": 6.706000000122003,
+        "max": 132.673000000068,
+        "memory": 128
+      },
+      "fixed": {
+        "avg": 15.259099996183068,
+        "min": 6.213999993633479,
+        "max": 80.09200000378769,
+        "memory": 16
+      },
+      "mrtree": {
+        "error": "Stack overflow (graph has cycles)"
+      },
+      "radial": {
+        "avg": 6.609599998046178,
+        "min": 5.982999995467253,
+        "max": 7.303000005776994,
+        "memory": 176
+      },
+      "rectpacking": {
+        "avg": 75.61830000486225,
+        "min": 6.420000005164184,
+        "max": 323.69800000742543,
+        "memory": 32
+      },
+      "disco": {
+        "avg": 11.099700002523605,
+        "min": 7.312999994610436,
+        "max": 19.619000013335608,
+        "memory": 64
+      },
+      "sporeOverlap": {
+        "error": "Unknown layout algorithm: sporeOverlap"
+      },
+      "sporeCompaction": {
+        "error": "Unknown layout algorithm: sporeCompaction"
+      },
+      "topdownpacking": {
+        "avg": 6.6470000019762665,
+        "min": 6.047000002581626,
+        "max": 7.645000005140901,
+        "memory": 192
+      },
+      "libavoid": {
+        "avg": 71.8007999996189,
+        "min": 29.284000003826804,
+        "max": 183.2050000084564,
+        "memory": 16
+      },
+      "vertiflex": {
+        "avg": 6.495000002905726,
+        "min": 6.106000000727363,
+        "max": 7.274999996297993,
+        "memory": 0
+      }
+    },
+    "medium_hierarchical": {
+      "layered": {
+        "error": "nil can't be coerced into Float"
+      },
+      "force": {
+        "error": "undefined method `+' for nil"
+      },
+      "stress": {
+        "error": "nil can't be coerced into Float"
+      },
+      "box": {
+        "error": "undefined method `+' for nil"
+      },
+      "random": {
+        "error": "undefined method `+' for nil"
+      },
+      "fixed": {
+        "error": "nil can't be coerced into Float"
+      },
+      "mrtree": {
+        "error": "undefined method `+' for nil"
+      },
+      "radial": {
+        "error": "nil can't be coerced into Integer"
+      },
+      "rectpacking": {
+        "error": "undefined method `-@' for nil"
+      },
+      "disco": {
+        "error": "nil can't be coerced into Float"
+      },
+      "sporeOverlap": {
+        "error": "Unknown layout algorithm: sporeOverlap"
+      },
+      "sporeCompaction": {
+        "error": "Unknown layout algorithm: sporeCompaction"
+      },
+      "topdownpacking": {
+        "error": "nil can't be coerced into Integer"
+      },
+      "libavoid": {
+        "error": "undefined method `+' for nil"
+      },
+      "vertiflex": {
+        "error": "undefined method `+' for nil"
+      }
+    },
+    "large_complex": {
+      "layered": {
+        "avg": 229.20739999826765,
+        "min": 216.13099999376573,
+        "max": 276.89000000827946,
+        "memory": 2448
+      },
+      "force": {
+        "error": "Timeout"
+      },
+      "stress": {
+        "error": "Timeout"
+      },
+      "box": {
+        "avg": 330.15480000176467,
+        "min": 149.9130000011064,
+        "max": 925.889999998617,
+        "memory": 256
+      },
+      "random": {
+        "avg": 211.05680000182474,
+        "min": 148.6330000043381,
+        "max": 580.1270000083605,
+        "memory": 352
+      },
+      "fixed": {
+        "avg": 215.3812000004109,
+        "min": 146.1669999989681,
+        "max": 722.7609999972628,
+        "memory": 1152
+      },
+      "mrtree": {
+        "error": "Stack overflow (graph has cycles)"
+      },
+      "radial": {
+        "avg": 245.07840000005672,
+        "min": 145.85999998962507,
+        "max": 760.4060000012396,
+        "memory": 288
+      },
+      "rectpacking": {
+        "avg": 426.3377000010223,
+        "min": 147.25500000349712,
+        "max": 1149.898999996367,
+        "memory": 160
+      },
+      "disco": {
+        "avg": 347.8637999985949,
+        "min": 271.66199999919627,
+        "max": 955.4760000028182,
+        "memory": 144
+      },
+      "sporeOverlap": {
+        "error": "Unknown layout algorithm: sporeOverlap"
+      },
+      "sporeCompaction": {
+        "error": "Unknown layout algorithm: sporeCompaction"
+      },
+      "topdownpacking": {
+        "avg": 166.12010000244481,
+        "min": 149.74500000244007,
+        "max": 237.6079999958165,
+        "memory": 48
+      },
+      "libavoid": {
+        "error": "Timeout"
+      },
+      "vertiflex": {
+        "avg": 288.4548999980325,
+        "min": 162.87099999317434,
+        "max": 799.9410000047646,
+        "memory": 176
+      }
+    },
+    "dense_network": {
+      "layered": {
+        "avg": 426.88989999878686,
+        "min": 188.48299999081064,
+        "max": 798.5009999974864,
+        "memory": 16
+      },
+      "force": {
+        "error": "Timeout"
+      },
+      "stress": {
+        "error": "Timeout"
+      },
+      "box": {
+        "avg": 368.0181999996421,
+        "min": 143.31399998627603,
+        "max": 869.9789999955101,
+        "memory": 144
+      },
+      "random": {
+        "avg": 259.617500002787,
+        "min": 150.44500000658445,
+        "max": 697.4970000010217,
+        "memory": 16
+      },
+      "fixed": {
+        "avg": 345.68620000063675,
+        "min": 148.51800000178628,
+        "max": 777.6560000056634,
+        "memory": 0
+      },
+      "mrtree": {
+        "error": "Stack overflow (graph has cycles)"
+      },
+      "radial": {
+        "avg": 323.07310000032885,
+        "min": 154.51900000334717,
+        "max": 1149.6579999948153,
+        "memory": 48
+      },
+      "rectpacking": {
+        "avg": 238.30970000271918,
+        "min": 154.08700000261888,
+        "max": 729.6930000011344,
+        "memory": -2864
+      },
+      "disco": {
+        "avg": 294.9923999971361,
+        "min": 224.77599998819642,
+        "max": 809.6569999906933,
+        "memory": 0
+      },
+      "sporeOverlap": {
+        "error": "Unknown layout algorithm: sporeOverlap"
+      },
+      "sporeCompaction": {
+        "error": "Unknown layout algorithm: sporeCompaction"
+      },
+      "topdownpacking": {
+        "avg": 202.70830000081332,
+        "min": 149.26500000001397,
+        "max": 604.8569999984466,
+        "memory": 0
+      },
+      "libavoid": {
+        "error": "Timeout"
+      },
+      "vertiflex": {
+        "avg": 197.8210000001127,
+        "min": 148.06800000951625,
+        "max": 396.78599999751896,
+        "memory": -192
+      }
+    }
+  }
+}

data/elkrb.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/elkrb/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "elkrb"
+  spec.version = Elkrb::VERSION
+  spec.authors = ["Ribose Inc."]
+  spec.email = ["open.source@ribose.com"]
+
+  spec.summary = "ElkRb: Ruby implementation of Eclipse Layout Kernel (ELK)"
+  spec.description = <<~HEREDOC
+    Pure Ruby implementation of the Eclipse Layout Kernel (ELK) providing automatic
+    layout of node-link diagrams. Supports all ELK algorithms.
+  HEREDOC
+
+  spec.homepage = "https://github.com/claricle/elkrb"
+  spec.license = "BSD-2-Clause"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/claricle/elkrb"
+  spec.metadata["changelog_uri"] = "https://github.com/claricle/elkrb"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "lutaml-model", "~> 0.7"
+  spec.add_dependency "rbs", "~> 3.0"
+  spec.add_dependency "thor", "~> 1.4"
+end

data/examples/dot_export_demo.rb

@@ -0,0 +1,133 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/elkrb"
+
+# Example 1: Simple graph with layout and DOT export
+puts "Example 1: Simple Graph"
+puts "=" * 50
+
+# Build graph using model objects
+simple_graph = Elkrb::Graph::Graph.new(id: "root")
+
+node1 = Elkrb::Graph::Node.new(id: "n1", width: 100, height: 60)
+node1.labels = [Elkrb::Graph::Label.new(text: "Node 1")]
+
+node2 = Elkrb::Graph::Node.new(id: "n2", width: 100, height: 60)
+node2.labels = [Elkrb::Graph::Label.new(text: "Node 2")]
+
+node3 = Elkrb::Graph::Node.new(id: "n3", width: 100, height: 60)
+node3.labels = [Elkrb::Graph::Label.new(text: "Node 3")]
+
+simple_graph.children = [node1, node2, node3]
+simple_graph.edges = [
+  Elkrb::Graph::Edge.new(id: "e1", sources: ["n1"], targets: ["n2"]),
+  Elkrb::Graph::Edge.new(id: "e2", sources: ["n2"], targets: ["n3"]),
+  Elkrb::Graph::Edge.new(id: "e3", sources: ["n1"], targets: ["n3"]),
+]
+
+# Layout the graph
+result = Elkrb.layout(simple_graph, algorithm: "layered")
+
+# Export to DOT format
+dot_output = Elkrb.export_dot(result, rankdir: "TB")
+puts dot_output
+puts "\n"
+
+# Example 2: Hierarchical graph
+puts "Example 2: Hierarchical Graph"
+puts "=" * 50
+
+# Build hierarchical graph using model objects
+hierarchical_graph = Elkrb::Graph::Graph.new(id: "root")
+
+# Cluster 1
+cluster1 = Elkrb::Graph::Node.new(id: "cluster1")
+cluster1.labels = [Elkrb::Graph::Label.new(text: "Group 1")]
+n1 = Elkrb::Graph::Node.new(id: "n1", width: 50, height: 30)
+n1.labels = [Elkrb::Graph::Label.new(text: "A")]
+n2 = Elkrb::Graph::Node.new(id: "n2", width: 50, height: 30)
+n2.labels = [Elkrb::Graph::Label.new(text: "B")]
+cluster1.children = [n1, n2]
+cluster1.edges = [Elkrb::Graph::Edge.new(id: "e1", sources: ["n1"],
+                                         targets: ["n2"])]
+
+# Cluster 2
+cluster2 = Elkrb::Graph::Node.new(id: "cluster2")
+cluster2.labels = [Elkrb::Graph::Label.new(text: "Group 2")]
+n3 = Elkrb::Graph::Node.new(id: "n3", width: 50, height: 30)
+n3.labels = [Elkrb::Graph::Label.new(text: "C")]
+n4 = Elkrb::Graph::Node.new(id: "n4", width: 50, height: 30)
+n4.labels = [Elkrb::Graph::Label.new(text: "D")]
+cluster2.children = [n3, n4]
+cluster2.edges = [Elkrb::Graph::Edge.new(id: "e2", sources: ["n3"],
+                                         targets: ["n4"])]
+
+hierarchical_graph.children = [cluster1, cluster2]
+hierarchical_graph.edges = [Elkrb::Graph::Edge.new(id: "e3", sources: ["n2"],
+                                                   targets: ["n3"])]
+
+# Layout and export
+hierarchical_result = Elkrb.layout(hierarchical_graph, algorithm: "layered")
+dot_hierarchical = Elkrb.export_dot(hierarchical_result)
+puts dot_hierarchical
+puts "\n"
+
+# Example 3: Force-directed layout with custom DOT attributes
+puts "Example 3: Force-Directed Layout with Custom Attributes"
+puts "=" * 50
+
+# Build force-directed graph
+force_graph = Elkrb::Graph::Graph.new(id: "root")
+
+center = Elkrb::Graph::Node.new(id: "center", width: 80, height: 80)
+center.labels = [Elkrb::Graph::Label.new(text: "Center")]
+
+na = Elkrb::Graph::Node.new(id: "a", width: 60, height: 60)
+na.labels = [Elkrb::Graph::Label.new(text: "A")]
+
+nb = Elkrb::Graph::Node.new(id: "b", width: 60, height: 60)
+nb.labels = [Elkrb::Graph::Label.new(text: "B")]
+
+nc = Elkrb::Graph::Node.new(id: "c", width: 60, height: 60)
+nc.labels = [Elkrb::Graph::Label.new(text: "C")]
+
+nd = Elkrb::Graph::Node.new(id: "d", width: 60, height: 60)
+nd.labels = [Elkrb::Graph::Label.new(text: "D")]
+
+force_graph.children = [center, na, nb, nc, nd]
+force_graph.edges = [
+  Elkrb::Graph::Edge.new(id: "e1", sources: ["center"], targets: ["a"]),
+  Elkrb::Graph::Edge.new(id: "e2", sources: ["center"], targets: ["b"]),
+  Elkrb::Graph::Edge.new(id: "e3", sources: ["center"], targets: ["c"]),
+  Elkrb::Graph::Edge.new(id: "e4", sources: ["center"], targets: ["d"]),
+  Elkrb::Graph::Edge.new(id: "e5", sources: ["a"], targets: ["b"]),
+  Elkrb::Graph::Edge.new(id: "e6", sources: ["c"], targets: ["d"]),
+]
+
+force_result = Elkrb.layout(force_graph, algorithm: "force")
+dot_force = Elkrb.export_dot(
+  force_result,
+  graph_name: "ForceDirected",
+  graph_attrs: { bgcolor: "white", splines: "true" },
+  node_attrs: { shape: "ellipse", style: "filled", fillcolor: "lightblue" },
+  edge_attrs: { color: "gray", arrowsize: 0.8 },
+)
+puts dot_force
+puts "\n"
+
+# Example 4: Write to file
+puts "Example 4: Saving to File"
+puts "=" * 50
+
+output_file = "output_graph.dot"
+File.write(output_file, dot_output)
+puts "DOT file saved to: #{output_file}"
+puts "You can render it with Graphviz:"
+puts "  dot -Tpng #{output_file} -o output_graph.png"
+puts "  dot -Tsvg #{output_file} -o output_graph.svg"
+puts "\n"
+
+puts "Demo complete!"
+puts "All graphs have been laid out and exported to DOT format."
+puts "Note: This is a pure Ruby implementation with no runtime Graphviz dependency."

data/examples/hierarchical_graph.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "elkrb"
+
+# Hierarchical graph layout example
+# This demonstrates nested graphs with parent-child relationships
+
+# Create a hierarchical graph with nested nodes
+graph = Elkrb::Graph.new(
+  id: "root",
+  children: [
+    {
+      id: "parent1",
+      width: 400,
+      height: 300,
+      children: [
+        { id: "p1_child1", width: 80, height: 40 },