elkrb 1.0.0

data/sig/elkrb/graph.rbs

@@ -0,0 +1,112 @@
+module Elkrb
+  module Graph
+    class LayoutOptions
+      attr_accessor algorithm: String?
+      attr_accessor direction: String?
+      attr_accessor spacing_node_node: Float?
+      attr_accessor spacing_edge_node: Float?
+      attr_accessor spacing_edge_edge: Float?
+      attr_accessor edge_routing: String?
+      attr_accessor padding: Hash[Symbol, Float]?
+      attr_accessor aspect_ratio: Float?
+
+      def self.from_hash: (Hash[String | Symbol, untyped] hash) -> LayoutOptions
+      def to_json: () -> String
+      def to_yaml: () -> String
+    end
+
+    class Label
+      attr_accessor id: String?
+      attr_accessor text: String?
+      attr_accessor x: Float?
+      attr_accessor y: Float?
+      attr_accessor width: Float?
+      attr_accessor height: Float?
+
+      def self.from_hash: (Hash[String | Symbol, untyped] hash) -> Label
+      def to_json: () -> String
+      def to_yaml: () -> String
+    end
+
+    class Port
+      attr_accessor id: String?
+      attr_accessor x: Float?
+      attr_accessor y: Float?
+      attr_accessor width: Float?
+      attr_accessor height: Float?
+      attr_accessor labels: Array[Label]?
+
+      def self.from_hash: (Hash[String | Symbol, untyped] hash) -> Port
+      def to_json: () -> String
+      def to_yaml: () -> String
+    end
+
+    class EdgeSection
+      attr_accessor id: String?
+      attr_accessor start_point: Hash[String, Float]?
+      attr_accessor end_point: Hash[String, Float]?
+      attr_accessor bend_points: Array[Hash[String, Float]]?
+      attr_accessor incoming_shape: String?
+      attr_accessor outgoing_shape: String?
+
+      def self.from_hash: (Hash[String | Symbol, untyped] hash) -> EdgeSection
+      def to_json: () -> String
+      def to_yaml: () -> String
+    end
+
+    class Edge
+      attr_accessor id: String?
+      attr_accessor sources: Array[String]?
+      attr_accessor targets: Array[String]?
+      attr_accessor labels: Array[Label]?
+      attr_accessor sections: Array[EdgeSection]?
+      attr_accessor layout_options: LayoutOptions?
+      attr_accessor properties: Hash[String, untyped]?
+
+      def self.from_hash: (Hash[String | Symbol, untyped] hash) -> Edge
+      def to_json: () -> String
+      def to_yaml: () -> String
+    end
+
+    class Node
+      attr_accessor id: String?
+      attr_accessor x: Float?
+      attr_accessor y: Float?
+      attr_accessor width: Float?
+      attr_accessor height: Float?
+      attr_accessor labels: Array[Label]?
+      attr_accessor ports: Array[Port]?
+      attr_accessor children: Array[Node]?
+      attr_accessor edges: Array[Edge]?
+      attr_accessor layout_options: LayoutOptions?
+      attr_accessor properties: Hash[String, untyped]?
+
+      def self.from_hash: (Hash[String | Symbol, untyped] hash) -> Node
+      def to_json: () -> String
+      def to_yaml: () -> String
+      def hierarchical?: () -> bool
+      def find_node: (String node_id) -> Node?
+      def all_nodes: () -> Array[Node]
+    end
+
+    class Graph
+      attr_accessor id: String?
+      attr_accessor x: Float?
+      attr_accessor y: Float?
+      attr_accessor width: Float?
+      attr_accessor height: Float?
+      attr_accessor children: Array[Node]?
+      attr_accessor edges: Array[Edge]?
+      attr_accessor layout_options: LayoutOptions?
+      attr_accessor properties: Hash[String, untyped]?
+
+      def self.from_hash: (Hash[String | Symbol, untyped] hash) -> Graph
+      def to_json: () -> String
+      def to_yaml: () -> String
+      def hierarchical?: () -> bool
+      def find_node: (String node_id) -> Node?
+      def all_nodes: () -> Array[Node]
+      def all_edges: () -> Array[Edge]
+    end
+  end
+end

data/sig/elkrb/layout.rbs

@@ -0,0 +1,107 @@
+module Elkrb
+  module Layout
+    type algorithmMetadata = {
+      name: String,
+      description: String,
+      category: String?,
+      supports_hierarchy: bool?
+    }
+
+    type algorithmInfo = {
+      id: String,
+      name: String,
+      description: String,
+      category: String,
+      supports_hierarchy: bool
+    }
+
+    class AlgorithmRegistry
+      def self.register: (String name, singleton(Algorithms::BaseAlgorithm) algorithm_class, ?algorithmMetadata metadata) -> void
+      def self.get: (String name) -> singleton(Algorithms::BaseAlgorithm)?
+      def self.available_algorithms: () -> Array[String]
+      def self.algorithm_info: (String name) -> algorithmInfo?
+      def self.all_algorithm_info: () -> Array[algorithmInfo]
+
+      private
+
+      def self.normalize_name: (String name) -> String
+    end
+
+    class LayoutEngine
+      def self.layout: (Hash[String | Symbol, untyped] | Graph::Graph graph, Hash[String | Symbol, untyped] options) -> Graph::Graph
+      def self.known_layout_algorithms: () -> Array[algorithmInfo]
+      def self.known_layout_options: () -> Array[untyped]
+
+      private
+
+      def self.convert_to_graph: (Hash[String | Symbol, untyped] hash) -> Graph::Graph
+    end
+
+    module Algorithms
+      class BaseAlgorithm
+        attr_reader options: Hash[String | Symbol, untyped]
+
+        def initialize: (Hash[String | Symbol, untyped] options) -> void
+        def layout: (Graph::Graph graph) -> Graph::Graph
+
+        private
+
+        def option: (String | Symbol key, ?untyped default) -> untyped
+        def node_spacing: () -> Float
+        def padding: () -> Hash[Symbol, Float]
+        def calculate_bounding_box: (Array[Graph::Node] nodes) -> Geometry::Rectangle
+        def apply_padding: (Graph::Graph graph) -> void
+      end
+
+      class Random < BaseAlgorithm
+        def layout: (Graph::Graph graph) -> Graph::Graph
+      end
+
+      class Fixed < BaseAlgorithm
+        def layout: (Graph::Graph graph) -> Graph::Graph
+      end
+
+      class Box < BaseAlgorithm
+        def layout: (Graph::Graph graph) -> Graph::Graph
+      end
+
+      class Force < BaseAlgorithm
+        DEFAULT_ITERATIONS: Integer
+        DEFAULT_REPULSION: Float
+        DEFAULT_TEMPERATURE: Float
+
+        def layout: (Graph::Graph graph) -> Graph::Graph
+
+        private
+
+        def iterations: () -> Integer
+        def repulsion: () -> Float
+        def temperature: () -> Float
+        def collect_edges: (Graph::Graph graph) -> Array[Graph::Edge]
+        def initialize_positions: (Graph::Graph graph) -> void
+        def apply_forces: (Graph::Graph graph, Float repulsion, Float temperature, Integer iteration, Integer total_iterations) -> void
+        def calculate_repulsive_forces: (Array[Graph::Node] nodes, Float repulsion) -> Hash[String, Geometry::Vector]
+        def calculate_attractive_forces: (Array[Graph::Edge] edges, Float temperature) -> Hash[String, Geometry::Vector]
+        def apply_displacement: (Array[Graph::Node] nodes, Hash[String, Geometry::Vector] forces, Float cooling_factor) -> void
+      end
+
+      class Stress < BaseAlgorithm
+        DEFAULT_ITERATIONS: Integer
+        DEFAULT_EPSILON: Float
+
+        def layout: (Graph::Graph graph) -> Graph::Graph
+
+        private
+
+        def iterations: () -> Integer
+        def epsilon: () -> Float
+        def collect_edges: (Graph::Graph graph) -> Array[Graph::Edge]
+        def initialize_positions: (Graph::Graph graph) -> void
+        def calculate_distances: (Graph::Graph graph) -> Hash[String, Hash[String, Float]]
+        def calculate_stress: (Graph::Graph graph, Hash[String, Hash[String, Float]] distances) -> Float
+        def optimize_positions: (Graph::Graph graph, Hash[String, Hash[String, Float]] distances) -> void
+        def euclidean_distance: (Graph::Node n1, Graph::Node n2) -> Float
+      end
+    end
+  end
+end

data/sig/elkrb/options.rbs

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Elkrb
+  module Options
+    class ElkPadding
+      attr_reader left: Float
+      attr_reader top: Float
+      attr_reader right: Float
+      attr_reader bottom: Float
+
+      def initialize: (?left: Numeric, ?top: Numeric, ?right: Numeric, ?bottom: Numeric) -> void
+
+      def self.parse: (String | Hash[Symbol | String, Numeric] | ElkPadding value) -> ElkPadding
+
+      def self.from_hash: (Hash[Symbol | String, Numeric] hash) -> ElkPadding
+
+      def self.from_string: (String str) -> ElkPadding
+
+      def to_h: () -> Hash[Symbol, Float]
+
+      def to_s: () -> String
+
+      def ==: (untyped other) -> bool
+    end
+
+    class KVector
+      attr_reader x: Float
+      attr_reader y: Float
+
+      def initialize: (Numeric x, Numeric y) -> void
+
+      def self.parse: (String | Hash[Symbol | String, Numeric] | Array[Numeric] | KVector value) -> KVector
+
+      def self.from_hash: (Hash[Symbol | String, Numeric] hash) -> KVector
+
+      def self.from_array: (Array[Numeric] array) -> KVector
+
+      def self.from_string: (String str) -> KVector
+
+      def to_h: () -> Hash[Symbol, Float]
+
+      def to_a: () -> Array[Float]
+
+      def to_s: () -> String
+
+      def ==: (untyped other) -> bool
+    end
+
+    class KVectorChain
+      attr_reader vectors: Array[KVector]
+
+      def initialize: (?Array[Array[Numeric] | Hash[Symbol | String, Numeric] | KVector] vectors) -> void
+
+      def self.parse: (String | Array[Array[Numeric] | Hash[Symbol | String, Numeric] | KVector] | KVectorChain value) -> KVectorChain
+
+      def self.from_array: (Array[Array[Numeric] | Hash[Symbol | String, Numeric] | KVector] array) -> KVectorChain
+
+      def self.from_string: (String str) -> KVectorChain
+
+      def add: (Array[Numeric] | Hash[Symbol | String, Numeric] | KVector vector) -> self
+
+      alias << add
+
+      def []: (Integer index) -> KVector?
+
+      def size: () -> Integer
+
+      alias length size
+
+      def empty?: () -> bool
+
+      def each: () { (KVector) -> void } -> void
+
+      def to_a: () -> Array[KVector]
+
+      def to_s: () -> String
+
+      def ==: (untyped other) -> bool
+    end
+  end
+end

data/sig/elkrb.rbs

@@ -0,0 +1,32 @@
+module Elkrb
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class UnsupportedConfigurationException < Error
+    attr_reader option: String?
+    attr_reader value: untyped
+
+    def initialize: (String message, ?option: String?, ?value: untyped) -> void
+  end
+
+  class ValidationError < Error
+  end
+
+  class AlgorithmNotFoundError < Error
+    attr_reader algorithm_name: String
+
+    def initialize: (String algorithm_name) -> void
+  end
+
+  def self.layout: (Graph::Graph | Hash[Symbol, untyped] graph, ?Hash[Symbol, untyped] options) -> Graph::Graph
+
+  def self.register_algorithm: (String name, Class algorithm_class, ?Hash[Symbol, untyped] metadata) -> void
+
+  def self.known_layout_algorithms: () -> Array[Hash[Symbol, untyped]]
+
+  def self.known_layout_options: () -> Hash[String, Hash[Symbol, untyped]]
+
+  def self.known_layout_categories: () -> Hash[String, Hash[Symbol, String]]
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: elkrb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: |
+  Pure Ruby implementation of the Eclipse Layout Kernel (ELK) providing automatic
+  layout of node-link diagrams. Supports all ELK algorithms.
+email:
+- open.source@ribose.com
+executables:
+- elkrb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.adoc
+- Rakefile
+- benchmarks/README.md
+- benchmarks/elkjs_benchmark.js
+- benchmarks/elkrb_benchmark.rb
+- benchmarks/fixtures/graphs.json
+- benchmarks/generate_report.rb
+- benchmarks/generate_test_graphs.rb
+- benchmarks/results/elkrb_results.json
+- benchmarks/results/elkrb_summary.json
+- elkrb.gemspec
+- examples/dot_export_demo.rb
+- examples/hierarchical_graph.rb
+- examples/layout_constraints_demo.rb
+- examples/port_constraints_demo.rb
+- examples/self_loop_demo.rb
+- examples/simple_graph.rb
+- examples/spline_routing_demo.rb
+- exe/elkrb
+- lib/elkrb.rb
+- lib/elkrb/cli.rb
+- lib/elkrb/commands/batch_command.rb
+- lib/elkrb/commands/convert_command.rb
+- lib/elkrb/commands/diagram_command.rb
+- lib/elkrb/commands/render_command.rb
+- lib/elkrb/commands/validate_command.rb
+- lib/elkrb/errors.rb
+- lib/elkrb/geometry/bezier.rb
+- lib/elkrb/geometry/dimension.rb
+- lib/elkrb/geometry/point.rb
+- lib/elkrb/geometry/rectangle.rb
+- lib/elkrb/geometry/vector.rb
+- lib/elkrb/graph/edge.rb
+- lib/elkrb/graph/graph.rb
+- lib/elkrb/graph/label.rb
+- lib/elkrb/graph/layout_options.rb
+- lib/elkrb/graph/node.rb
+- lib/elkrb/graph/node_constraints.rb
+- lib/elkrb/graph/port.rb
+- lib/elkrb/graphviz_wrapper.rb
+- lib/elkrb/layout/algorithm_registry.rb
+- lib/elkrb/layout/algorithms/base_algorithm.rb
+- lib/elkrb/layout/algorithms/box.rb
+- lib/elkrb/layout/algorithms/disco.rb
+- lib/elkrb/layout/algorithms/fixed.rb
+- lib/elkrb/layout/algorithms/force.rb
+- lib/elkrb/layout/algorithms/layered.rb
+- lib/elkrb/layout/algorithms/layered/cycle_breaker.rb
+- lib/elkrb/layout/algorithms/layered/layer_assigner.rb
+- lib/elkrb/layout/algorithms/layered/node_placer.rb
+- lib/elkrb/layout/algorithms/libavoid.rb
+- lib/elkrb/layout/algorithms/mrtree.rb
+- lib/elkrb/layout/algorithms/radial.rb
+- lib/elkrb/layout/algorithms/random.rb
+- lib/elkrb/layout/algorithms/rectpacking.rb
+- lib/elkrb/layout/algorithms/spore_compaction.rb
+- lib/elkrb/layout/algorithms/spore_overlap.rb
+- lib/elkrb/layout/algorithms/stress.rb
+- lib/elkrb/layout/algorithms/topdown_packing.rb
+- lib/elkrb/layout/algorithms/vertiflex.rb
+- lib/elkrb/layout/constraints/alignment_constraint.rb
+- lib/elkrb/layout/constraints/base_constraint.rb
+- lib/elkrb/layout/constraints/constraint_processor.rb
+- lib/elkrb/layout/constraints/fixed_position_constraint.rb
+- lib/elkrb/layout/constraints/layer_constraint.rb
+- lib/elkrb/layout/constraints/relative_position_constraint.rb
+- lib/elkrb/layout/edge_router.rb
+- lib/elkrb/layout/hierarchical_processor.rb
+- lib/elkrb/layout/label_placer.rb
+- lib/elkrb/layout/layout_engine.rb
+- lib/elkrb/layout/port_constraint_processor.rb
+- lib/elkrb/options/elk_padding.rb
+- lib/elkrb/options/k_vector.rb
+- lib/elkrb/options/k_vector_chain.rb
+- lib/elkrb/parsers/elkt_parser.rb
+- lib/elkrb/serializers/dot_serializer.rb
+- lib/elkrb/serializers/elkt_serializer.rb
+- lib/elkrb/version.rb
+- sig/elkrb.rbs
+- sig/elkrb/constraints.rbs
+- sig/elkrb/geometry.rbs
+- sig/elkrb/graph.rbs
+- sig/elkrb/layout.rbs
+- sig/elkrb/options.rbs
+homepage: https://github.com/claricle/elkrb
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/claricle/elkrb
+  source_code_uri: https://github.com/claricle/elkrb
+  changelog_uri: https://github.com/claricle/elkrb
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: 'ElkRb: Ruby implementation of Eclipse Layout Kernel (ELK)'
+test_files: []