elkrb 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c43adfbca7a5e7f9680b6363c6a350f9b4f9c2933229c48437398c0d665ebd
-  data.tar.gz: a33dbcef5f165982417f9caffd84137ba21f02594634ba27260593ea46676247
+  metadata.gz: 8699f197aff817a1de6a193b1fb421d59e5df023ed0bbb39f7cfa75cedefcf82
+  data.tar.gz: cfa580618758f94d81542c86cf4bb87014375057c3271ee00031b962f2faa598
 SHA512:
-  metadata.gz: 5b7491f8cd40a33fd457a46aef7947501a47cbe3bad2289ecfdd815ac28685216c526d2ed2a5113eac393a167d5399981ba1e19da2b6640c5e6f494a324dd1d4
-  data.tar.gz: 2814564220196fe977b08bc607f3dc5d34b97bb260e7103935de85f7cc90e574ca417ddcb08a417040b47eb14d500c1e53428ab601e2361bb2a4156537cff24d
+  metadata.gz: 19b997af148da717eae04d0c30274276a654999f8d3bac9254bf3e7098f9f0fedfaba00744961e734f54f8dfa0db009620be9c3cd7d7891b5886400af1c4ee6c
+  data.tar.gz: c7ec92a9b09af0c7797fac7c567b869a0fe0faeacdcae1ad5d7c2312c0051c5f91272f22beba34789b0856ac3bb656c3ceeb10eebd08831855de9e0fb90e113f

data/CHANGELOG.adoc

@@ -0,0 +1,364 @@
+= Changelog
+
+All notable changes to Elkrb are recorded here.
+
+== 2.0.0 (2026-10-10)
+
+=== Breaking changes
+
+* `NodeConstraints` now writes YAML in snake_case, like every other model in
+  the gem. `fixedPosition`, `alignGroup`, `alignDirection`, `relativeTo`,
+  `relativeOffset` and `positionPriority` are still read, so old documents keep
+  parsing, but they are no longer produced. Code that reads the camelCase keys
+  out of generated YAML must be updated. JSON and the other key-value formats
+  are unchanged and stay camelCase.
+
+* `Elkrb.layout` and `Elkrb::Layout::LayoutEngine.layout` now raise
+  `ArgumentError` when the graph is neither a `Hash` nor an
+  `Elkrb::Graph::Graph`. Before, other objects were accepted and failed later
+  with a `NoMethodError`, or silently did nothing. Anything passing a wrapper
+  or a duck-typed graph has to pass a real `Graph` now.
+
+* Ruby 3.3 or newer is required. Older Rubies cannot load `lutaml-model` 0.8.
+
+* `Elkrb::Graph::LayoutOptions` and its typed getters are gone. `layoutOptions`
+  is an open map read by id, so pass a plain String-keyed Hash. Writing a
+  Symbol key into the returned map in place now stores the Symbol as given;
+  use String keys, or assign the whole map through the setter, which still
+  normalises. (#4, #10)
++
+[source,ruby]
+----
+# before
+Elkrb::Graph::LayoutOptions.new(algorithm: "layered")
+# after
+{ "elk.algorithm" => "layered" }
+----
+
+* Unparseable ELKT raises `Elkrb::ParseError` with a line and column. It used
+  to return an empty graph. Rescue `Elkrb::ParseError` where you relied on
+  the empty graph. (#17)
++
+[source,ruby]
+----
+Elkrb::Parsers::ElktParser.parse("<html><body>not elkt</body></html>")
+# before: {"id":"root","layoutOptions":{},"children":[],"edges":[]}
+# after:  Elkrb::ParseError: Unexpected character "<" at line 1, column 1
+----
+
+* Layered defaults to direction `RIGHT` with a 20px gap between layers, and
+  cross-axis positions are centred. Set `"elk.direction": "DOWN"` and
+  `"elk.layered.spacing.nodeNodeBetweenLayers": 60` to approximate 1.x.
+  Layered reads the direction from `elk.direction` and, as a registered alias,
+  from the bare `direction` key. (#58)
++
+Two nodes joined by one edge, default options:
++
+[source,text]
+----
+before: a (12, 12)   b (12, 102)
+after:  a (12, 12)   b (62, 12)
+----
+
+* Edge sections start and end on node borders instead of node centres, section
+  ids change from `<edge>_section_0` to `<edge>_s0`, and sections gain
+  `incomingShape` and `outgoingShape`. Renderers that clipped centre-based
+  lines themselves should stop doing so. (#67)
++
+[source,text]
+----
+before: {"id":"e_section_0","startPoint":{"x":27.0,"y":27.0},"endPoint":{"x":27.0,"y":117.0}}
+after:  {"id":"e_s0","startPoint":{"x":42.0,"y":27.0},"endPoint":{"x":62.0,"y":27.0},
+         "incomingShape":"a","outgoingShape":"b"}
+----
+
+* Label `x` and `y` are relative to their owner (node, port or edge) instead of
+  absolute, so add the owner's position when drawing. A node label with no
+  `elk.nodeLabels.placement` stays at (0, 0); set
+  `"elk.nodeLabels.placement": "[H_CENTER,V_CENTER,INSIDE]"` to keep it
+  centred. (#65)
++
+A 60x40 node at (12,12) with a 10x10 label:
++
+[source,text]
+----
+before:                      {"text":"A","x":37.0,"y":27.0}
+after, no placement option:  {"text":"A","x":0.0,"y":0.0}
+after, placement as above:   {"text":"A","x":25.0,"y":15.0}
+----
+
+* The `_constraint_*` and `_assigned_layer` scratch keys no longer appear in
+  output `properties`, and constraint violations go through `Elkrb.logger`
+  instead of `Kernel#warn`. `ConstraintProcessor.new` takes `spacing:` and
+  `BaseConstraint#applies_to?` is removed. Stop reading the scratch keys.
+  (#66)
++
+[source,text]
+----
+before: {"id":"a","constraints":{"fixedPosition":false,"layer":1,"positionPriority":0},
+         "properties":{"_constraint_layer":1}}
+after:  {"id":"a","constraints":{"fixedPosition":false,"layer":1,"positionPriority":0}}
+----
+
+* mrtree and radial coordinates follow ELK's geometry. mrtree honours
+  `elk.direction`, and radial reads the graph's edges and centres the root.
+  There is nothing to migrate; the old coordinates did not match ELK. (#55)
++
+Root `r` with children `c1` and `c2`, 30x30 nodes, mrtree:
++
+[source,text]
+----
+before: r (12, 12)   c1 (12, 102)   c2 (62, 102)
+after:  r (45, 20)   c1 (20, 70)    c2 (70, 70)
+----
+
+* Force layout runs a deterministic Fruchterman-Reingold simulation using node
+  sizes, with ELK's 50px default padding; explicit padding still wins. Every
+  force coordinate changes. (#69)
++
+The same graph with `"elk.algorithm": "force"`:
++
+[source,text]
+----
+before: r (12, 12)           c1 (12, 102)          c2 (62, 102)
+after:  r (115.648, 106.874) c1 (50, 163.785)      c2 (181.253, 50)
+----
+
+* libavoid keeps nodes that already have a position and places only the
+  unplaced ones, in a grid to the right of the placed nodes. To get a full
+  re-layout, position every node or none. (#60)
++
+`a` at (5, 7), `b` at (200, 9) and an unplaced `c`:
++
+[source,text]
+----
+before: a (12, 12)   b (62, 12)    c (112, 12)
+after:  a (12, 12)   b (207, 14)   c (257, 12)
+----
+
+* An edge written with the elkjs primitive keys `source` and `target` is now a
+  real edge, so the graph lays out differently. (#16)
++
+[source,text]
+----
+before: {"id":"e"}
+after:  {"id":"e","sources":["a"],"targets":["b"],
+         "sections":[{"id":"e_s0","startPoint":{"x":42.0,"y":27.0},
+                      "endPoint":{"x":62.0,"y":27.0},
+                      "incomingShape":"a","outgoingShape":"b"}]}
+----
+
+* Ports are placed on their node's border. Each port now carries `x`, `y` and
+  `side`, and `offset` is filled in, where before a port had only `index` and
+  `offset: 0`. Edge sections that start or end at a port move to match. Code
+  that computed port positions itself should read these fields. (#70)
++
+Node `a` with a 6x6 port `p`, edge `p` to `b`:
++
+[source,text]
+----
+before: port {"id":"p","index":0,"offset":0.0}
+        section start (12.0, 12.0)
+after:  port {"id":"p","x":30.0,"y":12.0,"side":"EAST","index":0,"offset":12.0}
+        section start (48.0, 27.0)
+----
+
+* Layered orders the nodes within a layer by a barycenter sweep, so cross-axis
+  coordinates move whenever a layer holds more than one node.
+  `elk.layered.crossingMinimization.strategy` and
+  `elk.layered.considerModelOrder.strategy` are now honoured. Set
+  `elk.layered.crossingMinimization.strategy` to `NONE` to get insertion order
+  back. (#72)
++
+Edges `a` to `d` and `b` to `c`, default options:
++
+[source,text]
+----
+before:        a (12, 12)  b (12, 62)  c (62, 12)  d (62, 62)
+after:         a (12, 12)  b (12, 62)  c (62, 62)  d (62, 12)
+after, NONE:   a (12, 12)  b (12, 62)  c (62, 12)  d (62, 62)
+----
+
+* Self-loops leave and enter the node border and are routed outside the node
+  instead of retracing themselves, and their section id changes from
+  `<edge>_section_0` to `<edge>_s0`. An edge between two ports of the same node
+  is now routed as a loop too. Code that matches the old section id or the old
+  geometry must accept the new one. (#74)
++
+Node `a` (30x30) with an edge from `a` to `a`:
++
+[source,text]
+----
+before: {"id":"e_section_0","startPoint":{"x":42.0,"y":27.0},"endPoint":{"x":42.0,"y":37.0},
+         "bendPoints":[{"x":74.0,"y":27.0},{"x":74.0,"y":-5.0},{"x":74.0,"y":59.0},{"x":42.0,"y":32.0}]}
+after:  {"id":"e_s0","startPoint":{"x":42.0,"y":22.0},"endPoint":{"x":42.0,"y":32.0},
+         "bendPoints":[{"x":74.0,"y":22.0},{"x":74.0,"y":32.0}],
+         "incomingShape":"a","outgoingShape":"a"}
+----
+
+* `elkrb layout` rejects an unknown switch with `Unknown switches "--bogus"`
+  and a `Try: elkrb help layout` line. It used to read the switch as the input
+  file and fail with "no such file". `layout --output out.yml` now writes YAML,
+  where it wrote JSON; pass `--format json` to keep JSON. (#62)
++
+`elkrb layout --bogus graph.json`:
++
+[source,text]
+----
+before: ERROR: "elkrb layout" was called with arguments ["--bogus", "graph.json"]
+after:  Unknown switches "--bogus"
+        Try: elkrb help layout
+----
+
+* `sig/` is deleted and `rbs` is no longer a runtime dependency; the
+  signatures did not load. The gem ships an explicit file list (`lib`, `exe`,
+  `README.adoc`, `LICENSE`, `CHANGELOG.adoc`) instead of every tracked file,
+  so benchmarks, examples, docs and dotfiles are no longer packaged. (#77, #84)
+
+* Layered routes an edge that spans more than one layer around the nodes in
+  between, through a dummy lane with bend points. Nodes in the spanned layers
+  can move on the cross axis to make room. Nothing to migrate: the old route
+  could cross straight through a node. (#76)
++
+Edges a->b, b->c and a->c, default options:
++
+[source,text]
+----
+before: b (62, 12)   a->c bends []
+after:  b (62, 37)   a->c bends [(77, 2)]
+----
+
+* A graph's own `elk.algorithm` now wins over the `algorithm:` keyword of
+  `Elkrb.layout`. Before, the keyword won and the graph's value was ignored.
+  The keyword is now the fallback for graphs that name no algorithm. To force
+  an algorithm on a graph that already names one, set `elk.algorithm` on the
+  graph. (#50)
++
+A graph with `"elk.algorithm": "box"`, two 30x30 nodes, called with
+`algorithm: "force"`:
++
+[source,text]
+----
+before: runs force   a (12, 12)  b (23.09, 14.34)
+after:  runs box     a (15, 15)  b (60, 15)
+----
+
+* A duplicate node id, or a duplicate port id, within one level raises
+  `Elkrb::ValidationError` (`duplicate id: a`). Before, a duplicate node
+  failed with a `NoMethodError` and a duplicate port was silently accepted.
+  The same id may still appear at different levels. Duplicate edge ids are
+  not checked. (#5)
+
+* Layered raises `Elkrb::UnsupportedConfigurationException` for an edge with
+  more than one source or more than one target (`layered does not support
+  hyperedges (edge e)`); it used to lay the graph out.
+  Layered also no longer rewrites your edges to break cycles, so a back edge
+  keeps its source and target and `properties["reversed"]` is never written.
+  Stop reading that key.
++
+[source,text]
+----
+cycle a->b, b->c, c->a
+before: e3 {"sources":["a"],"targets":["c"],"properties":{"reversed":true}}
+after:  e3 {"sources":["c"],"targets":["a"]}
+----
+
+* The `hierarchical` option does nothing. Hierarchy is detected from nodes that
+  have `children`, as before when the option was unset, and `hierarchical`
+  is now reported as an unknown option under `strict: true`. A compound node
+  is laid out before its parent level, so the parent level places its siblings
+  against the compound's computed size instead of the `width` and `height` it
+  declared. A compound that names its own `elk.algorithm` is still laid out by
+  it, but an unknown name now raises `Elkrb::AlgorithmNotFoundError` where
+  the parent's algorithm used to be used quietly. (#63)
++
+Compound `c` declaring 500x500 and holding two 20x20 nodes, with a sibling
+`z` linked from `c`:
++
+[source,text]
+----
+before: c 84x44   z (532, 252)
+after:  c 84x44   z (116, 24)
+----
+
+* `fixed` keeps each node where its `x` and `y` put it, and reads
+  `elk.position`. It used to move the nodes so the top-left one sat at the
+  padding origin and to ignore `elk.position`. `box` uses a different packing,
+  so box coordinates and the graph size change. (#59)
++
+[source,text]
+----
+fixed, a at (100, 50) and b at (200, 80):
+before: a (12, 12)   b (112, 42)
+after:  a (100, 50)  b (200, 80)
+
+box, four 30x30 nodes:
+before: 154x104   n0 (12, 12)  n1 (62, 12)  n2 (112, 12)  n3 (12, 62)
+after:  105x105   n0 (15, 15)  n1 (60, 15)  n2 (15, 60)   n3 (60, 60)
+----
+
+=== Added
+
+* Edges read the elkjs primitive endpoint keys `source`, `target`,
+  `sourcePort` and `targetPort` in every format, YAML included. A blank port
+  value is ignored, so a real `source` or `target` still wins. Output stays
+  `sources` and `targets` only.
+
+* `junctionPoints`, `container`, `incomingSections` and `outgoingSections` on
+  edges, and `properties` on labels, are no longer dropped when parsing.
+
+* `elkrb options [ALGORITHM]` lists every layout option with its type,
+  default, status, aliases and the algorithms that read it; `--json` prints
+  the same as JSON. `elkrb algorithms --json` is new. `batch` and `diagram`
+  accept the same layout flags as `layout`, including `--spacing`
+  and `--layer-spacing`. (#62)
+
+* A `LICENSE` file (BSD-2-Clause, as the gemspec already declared) ships with
+  the gem. (#77)
+
+=== Fixed
+
+* `Rectangle#position` and `Rectangle#center` no longer raise.
+
+* `Bezier.calculate_curve` with fewer than two sample points returns copies of
+  the two endpoints instead of the caller's own `Point` objects. Its fifth
+  parameter is now named `sample_count`, which is what it always counted.
+
+* Validation now checks nested container scopes, collection shapes, finite
+  dimensions and option enum values. It rejects ambiguous hierarchical edge
+  endpoints, and the `HORIZONTAL` and `VERTICAL` direction aliases produce
+  valid layouts. Validation output remains readable on US-ASCII terminals.
+
+* Failed conversions and Graphviz renders preserve an existing destination
+  instead of replacing it with a partial result.
+
+* ELKT output preserves representable graph geometry, edge sections, ports and
+  hierarchy. DOT output keeps same-named nodes in different hierarchy scopes
+  distinct and routes scoped and hierarchical port endpoints without creating
+  phantom nodes.
+
+* `elk.selfLoopOffset` is honoured when it is carried by an edge or its node.
+
+=== Changed
+
+* `lutaml-model` is now capped below 0.9.
+
+* Layered layout uses ELK-style Brandes-Kopf placement, layer sweeps, discovery
+  and port ordering, per-gap orthogonal routing with junction points, and
+  connected-component packing. Node coordinates and edge routes can differ
+  from earlier releases.
+
+* DisCo defaults to ELK's polyomino component compaction. Set the component
+  arrangement or compaction strategy to `ROW` to retain row arrangement.
+
+* SPOrE overlap removal and compaction follow Java ELK's triangulation and tree
+  algorithms and honour their registered processing options.
+
+* Stress layout uses ELK-compatible deterministic seeding and the weighted
+  stress objective. Large line-metric graphs with the default iteration limit
+  use an exact projection, avoiding the previous quadratic timeout.
+
+=== Security
+
+* Release automation uses SHA-pinned actions, least-privilege jobs and
+  RubyGems OIDC trusted publishing instead of a long-lived API key.

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) Ribose Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.