statecraft 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6000e276c5fbe7a0ba8b33724c8cf6deea30dc0e8378931166e5123f799ee2a4
-  data.tar.gz: 40ab4510c265cb13a811faac8a3c04003222f1f57644233860a6f5d6031f8b12
+  metadata.gz: 1a49958ae3b97e963ada9ee0cb6f719bd0fa5a784704d7f1479f0b045a921ec1
+  data.tar.gz: e6fe7115b639e25d33e752800af3324822497413865236be7f53e01dc56674bb
 SHA512:
-  metadata.gz: 7067033a04b74f602366186bbf5536070d21ab8f2151cc955529db3a4d522cfbbd07d1586f7ed50c2ab766081ead669a490d0f76a4e20c61bc939d9d6a1669b6
-  data.tar.gz: 808b7b6a2c2d790636954a2da78a884355568487e43470885db340f75459cea23bc98e72839e3aa072fa29e45dbccc3b6c44e4efddfea27445405b8a71125b96
+  metadata.gz: 92730425ebca1937db4f9e53bac01020102a7c6c90bc76fd5518697394bec18720cb70dd826017ca9b36d4e873cd0817a6399399565098e0dfc687db853ad68b
+  data.tar.gz: f7511de223aa42b0f44c5fc0b14a0be53965887262b01bb62c9a1954abb9e4e98b4a2b5688ee967ca672cd19514ddc2357fbcd796139074612ee2ac588975357

data/README.md

@@ -222,6 +222,7 @@ order.offerable_events                             # => [:pay, :cancel] — grap
 order.refusals_for(:cancel)                        # => [#<event: :cancel, guard: :customer_cancellable?, layer: :event_record>]
 order.transitioned_to?(:paid)                      # strictly log-based
 OrderFlow.transitions_from(:pending)               # => [{ to: :paid, events: [:pay] }, ...]
+OrderFlow.to_mermaid                               # the graph as Mermaid stateDiagram-v2 text
 ```
 
 `transitions_from` is class-level and answers the graph's shape, not a
@@ -229,6 +230,19 @@ prediction: no guards are consulted, a bare edge carries an empty `events`
 list, and a state outside the graph owns no edges. Pair it with
 `available_transitions` for the prediction.
 
+The shape also draws itself: `to_mermaid` returns the graph as Mermaid
+`stateDiagram-v2` text — guards stay out of the picture, exactly like
+`transitions_from`. Paste it into a markdown fence and GitHub renders the
+diagram; the quick-start machine above comes out as:
+
+<!-- illustrative -->
+```mermaid
+stateDiagram-v2
+  [*] --> pending
+  pending --> paid : pay
+  pending --> cancelled
+```
+
 `available_transitions` tells you not only *where* you can go but *how*:
 `via` lists the events whose guards pass, plus `:direct` when the edge is
 free of event guards and its edge guards pass. Every answer is a snapshot —

data/lib/statecraft/diagram.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Statecraft
+  # Renders the compiled graph as Mermaid stateDiagram-v2 text: the states,
+  # the initial marker and event-labeled edges in declaration order. The
+  # shape only — like transitions_from, no guards are consulted or rendered.
+  module Diagram
+    def to_mermaid
+      graph = finalize!
+      lines = ["stateDiagram-v2", "  [*] --> #{graph.initial_state}"]
+      graph.edges.each_value do |edge|
+        arrow = "  #{edge.from} --> #{edge.to}"
+        lines << (edge.event_names.empty? ? arrow : "#{arrow} : #{edge.event_names.join(" / ")}")
+      end
+      "#{lines.join("\n")}\n"
+    end
+  end
+end

data/lib/statecraft/machine.rb

@@ -23,6 +23,7 @@ module Statecraft
 
     def self.included(machine_class)
       machine_class.extend(ClassMethods)
+      machine_class.extend(Diagram)
     end
 
     # Invokes a guard or callback handler with the honest-call convention:

data/lib/statecraft/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Statecraft
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/statecraft.rb

@@ -13,6 +13,7 @@ require_relative "statecraft/pipeline/edge_resolution"
 require_relative "statecraft/pipeline"
 require_relative "statecraft/pipeline/surface"
 require_relative "statecraft/introspection"
+require_relative "statecraft/diagram"
 require_relative "statecraft/mounting"
 
 ActiveSupport.on_load(:active_record) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statecraft
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Igor Pugachev
@@ -70,6 +70,7 @@ files:
 - lib/generators/statecraft/machine/templates/model.rb.tt
 - lib/generators/statecraft/machine/templates/namespace_module.rb.tt
 - lib/statecraft.rb
+- lib/statecraft/diagram.rb
 - lib/statecraft/errors.rb
 - lib/statecraft/instrumentation.rb
 - lib/statecraft/introspection.rb