state_machines-diagram 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dea8376942dd89e9671884fffabcf95cefb34e39e4c6366a6413deca1f965d0f
-  data.tar.gz: 9dbc0c5784bcf3b68b07f57fcde2681b7623d05ace83582dfe0c7a8c8e3a8c66
+  metadata.gz: '03019279aa49c2b91412b51dec857605336d30b20badb3de3ae33478343689c4'
+  data.tar.gz: 5bd3185cd7c949225c77183fb6318becf60a44cdae689a1ac5c08a41ac9b2c03
 SHA512:
-  metadata.gz: ff56f38bbb64f4d539f5b6418e6ffa8f90627f47c1401b30f63f845815ce666bdc5b0661ffc019383346e0fd99fa896c75e8425d31f894c84c24ccfee9d82cd0
-  data.tar.gz: 1345f579d826b86595a08b7a1a7c82d1521ccd83bb53af1165bc870b91b811af96ab9bc7e267d0ad610d11c2f08b0cea834948c1de3bc624258922de42e08d60
+  metadata.gz: 600b7969ba70e92c709feaf262467819216b1a5ad23dbb03e5f3327eb808f233661d91a44fbf871aaf8e8c5a177745705c6463705a321867c20bf9ed4503f3d4
+  data.tar.gz: a9559beefddd3ba6dac1505777bfa93f2a024fce034237771ea59fcb528e7f34c0768062fca4a8b972fb17e5d887923bf5240c98b99cc220d38d010d4161c47d

data/lib/state_machines/diagram/builder.rb

@@ -7,6 +7,17 @@ module StateMachines
     class Builder
       attr_reader :machine, :options, :diagram, :state_metadata, :transition_metadata
 
+      # Human-readable label for a Proc/Method, pointing at its source location
+      def self.callable_label(callable)
+        if callable.respond_to?(:source_location) && callable.source_location
+          file, line = callable.source_location
+          filename = File.basename(file) if file
+          "lambda@#{filename}:#{line}"
+        else
+          'lambda'
+        end
+      end
+
       def initialize(machine, options = {})
         @machine = machine
         @options = options
@@ -231,13 +242,7 @@ module StateMachines
           method_name += '?' unless method_name.end_with?('?')
           method_name
         when Proc, Method
-          if condition.respond_to?(:source_location) && condition.source_location
-            file, line = condition.source_location
-            filename = File.basename(file) if file
-            "lambda@#{filename}:#{line}"
-          else
-            'lambda'
-          end
+          self.class.callable_label(condition)
         else
           condition.to_s
         end
@@ -266,16 +271,7 @@ module StateMachines
       def format_action(action)
         case action
         when Proc, Method
-          # Try to extract source location for better readability
-          if action.respond_to?(:source_location) && action.source_location
-            file, line = action.source_location
-            filename = File.basename(file) if file
-            "lambda@#{filename}:#{line}"
-          else
-            'lambda'
-          end
-        when Symbol
-          action.to_s
+          self.class.callable_label(action)
         else
           action.to_s
         end

data/lib/state_machines/diagram/renderer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'builder'
+require_relative 'schema_builder'
 require 'set'
 
 module StateMachines
@@ -20,6 +21,10 @@ module StateMachines
         [diagram, builder]
       end
 
+      def machine_schema(machine, options = {})
+        SchemaBuilder.new(machine, options).build
+      end
+
       def output_diagram(diagram, io, options, builder = nil)
         case options[:format]
         when :json
@@ -27,6 +32,10 @@ module StateMachines
         when :yaml
           require 'yaml'
           io.puts diagram_hash_with_metadata(diagram, builder).to_yaml
+        when :machine_schema
+          # Output MachineSchema format compatible with state-machines-rs CLI
+          schema = SchemaBuilder.new(builder.machine, options)
+          io.puts schema.to_json
         else
           # Default text representation
           io.puts diagram_to_text(diagram, options, builder)
@@ -57,13 +66,7 @@ module StateMachines
         end
 
         # Build diagram with all involved states
-        builder = Builder.new(machine, options)
-        builder.instance_variable_set(:@diagram, builder.send(:create_diagram))
-
-        # Add all involved states first
-        machine.states.select { |s| states_involved.include?(s.name) }.each do |s|
-          builder.send(:add_state_node, s)
-        end
+        builder = build_filtered_builder(machine, states_involved, options)
 
         # Then add transitions
         machine.events.each do |event|
@@ -138,13 +141,7 @@ module StateMachines
         end
 
         # Build a fresh diagram for this event
-        builder = Builder.new(machine, options)
-        builder.instance_variable_set(:@diagram, builder.send(:create_diagram))
-
-        # Add states to diagram first
-        machine.states.select { |s| states_involved.include?(s.name) }.each do |state|
-          builder.send(:add_state_node, state)
-        end
+        builder = build_filtered_builder(machine, states_involved, options)
 
         # Add transitions for this event
         builder.send(:add_event_transitions, event)
@@ -166,18 +163,24 @@ module StateMachines
         end
 
         # Build fresh diagram
-        builder = Builder.new(machine, {})
+        builder = build_filtered_builder(machine, states_involved)
+
+        # Add transitions
+        builder.send(:add_branch_transitions, branch, event)
+
+        output_diagram(builder.diagram, io, {}, builder)
+      end
+
+      # Creates a fresh builder whose diagram only contains the given states
+      def build_filtered_builder(machine, states_involved, options = {})
+        builder = Builder.new(machine, options)
         builder.instance_variable_set(:@diagram, builder.send(:create_diagram))
 
-        # Add states first
         machine.states.select { |s| states_involved.include?(s.name) }.each do |state|
           builder.send(:add_state_node, state)
         end
 
-        # Add transitions
-        builder.send(:add_branch_transitions, branch, event)
-
-        output_diagram(builder.diagram, io, {}, builder)
+        builder
       end
 
       def diagram_to_text(diagram, options = {}, builder = nil)
@@ -284,11 +287,10 @@ module StateMachines
         end
 
         conditions = metadata.fetch(:conditions, {})
-        Array(conditions[:if]).compact.each do |condition|
-          Array(condition).each { |item| guard_terms[:if] << normalize_condition_name(item) }
-        end
-        Array(conditions[:unless]).compact.each do |condition|
-          Array(condition).each { |item| guard_terms[:unless] << normalize_condition_name(item) }
+        %i[if unless].each do |kind|
+          Array(conditions[kind]).compact.each do |condition|
+            Array(condition).each { |item| guard_terms[kind] << normalize_condition_name(item) }
+          end
         end
 
         guard_terms[:if].uniq!

data/lib/state_machines/diagram/schema_builder.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module StateMachines
+  module Diagram
+    # Builds a MachineSchema-compatible hash from a state_machines machine.
+    # This format is compatible with the state-machines-rs CLI tool.
+    class SchemaBuilder
+      attr_reader :machine, :options
+
+      def initialize(machine, options = {})
+        @machine = machine
+        @options = options
+      end
+
+      def build
+        {
+          name: machine_name,
+          initial: initial_state,
+          states: state_names,
+          superstates: build_superstates,
+          events: build_events,
+          async_mode: false
+        }.compact
+      end
+
+      def to_json(*args)
+        build.to_json(*args)
+      end
+
+      private
+
+      def machine_name
+        "#{machine.owner_class.name}##{machine.name}"
+      end
+
+      def initial_state
+        state = machine.initial_state(machine.owner_class)
+        if state.respond_to?(:name)
+          state.name&.to_s
+        else
+          state&.to_s
+        end || machine.states.first&.name&.to_s
+      end
+
+      def state_names
+        machine.states.by_priority.map { |s| s.name&.to_s || 'nil' }
+      end
+
+      def build_superstates
+        # state_machines gem doesn't have native superstate support
+        # Return empty array for compatibility
+        []
+      end
+
+      def build_events
+        machine.events.map do |event|
+          {
+            name: event.name.to_s,
+            transitions: build_event_transitions(event),
+            guards: extract_event_guards(event),
+            payload: nil
+          }.tap do |h|
+            h.delete(:guards) if h[:guards].empty?
+            h.delete(:payload) if h[:payload].nil?
+          end
+        end
+      end
+
+      def build_event_transitions(event)
+        transitions = []
+
+        event.branches.each do |branch|
+          branch.state_requirements.each do |requirement|
+            valid_states = machine.states.by_priority.map(&:name)
+            from_states = requirement[:from].filter(valid_states)
+            to_states = requirement[:to].values
+
+            # Handle loopback transitions (empty to_states means same state)
+            to_states = from_states if to_states.empty?
+
+            to_states.each do |to_state|
+              transitions << {
+                sources: from_states.map { |s| s&.to_s || 'nil' },
+                target: to_state&.to_s || 'nil',
+                guards: extract_branch_guards(branch),
+                unless: extract_branch_unless(branch)
+              }.tap do |h|
+                h.delete(:guards) if h[:guards].empty?
+                h.delete(:unless) if h[:unless].empty?
+              end
+            end
+          end
+        end
+
+        # Merge transitions with same target
+        merge_transitions(transitions)
+      end
+
+      def merge_transitions(transitions)
+        # Group by target and merge sources
+        grouped = transitions.group_by { |t| [t[:target], t[:guards], t[:unless]] }
+
+        grouped.map do |(_target, _guards, _unless), group|
+          sources = group.flat_map { |t| t[:sources] }.uniq
+          base = group.first.dup
+          base[:sources] = sources
+          base
+        end
+      end
+
+      def extract_event_guards(event)
+        guards = []
+        event.branches.each do |branch|
+          guards.concat(extract_branch_guards(branch))
+        end
+        guards.uniq
+      end
+
+      def extract_branch_guards(branch)
+        guards = []
+        if branch.if_condition
+          guards << normalize_condition(branch.if_condition)
+        end
+        guards.compact
+      end
+
+      def extract_branch_unless(branch)
+        guards = []
+        if branch.unless_condition
+          guards << normalize_condition(branch.unless_condition)
+        end
+        guards.compact
+      end
+
+      def normalize_condition(condition)
+        case condition
+        when Symbol
+          name = condition.to_s
+          name += '?' unless name.end_with?('?')
+          name
+        when Proc, Method
+          if condition.respond_to?(:source_location) && condition.source_location
+            file, line = condition.source_location
+            "lambda@#{File.basename(file)}:#{line}"
+          else
+            'lambda'
+          end
+        else
+          condition.to_s
+        end
+      end
+    end
+  end
+end

data/lib/state_machines/diagram/version.rb

@@ -2,6 +2,6 @@
 
 module StateMachines
   module Diagram
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-diagram
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -63,14 +63,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.25'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.25'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,7 @@ files:
 - lib/state_machines-diagram.rb
 - lib/state_machines/diagram/builder.rb
 - lib/state_machines/diagram/renderer.rb
+- lib/state_machines/diagram/schema_builder.rb
 - lib/state_machines/diagram/version.rb
 homepage: https://github.com/state-machines/state_machines-diagram
 licenses:
@@ -111,14 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.3.0
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Diagram building for state machines
 test_files: []