state_machines-mermaid 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 387fad10965ac7756257b30ac3a36b20770c2702631796c2727c3b0cb4eeea69
-  data.tar.gz: 26d45114695fab1ed434862f36520c4006f895d5db17903519995366e6045090
+  metadata.gz: 0d80eff2b0ed1c6b458aba82d93fd4e423281ad88d4e6c32b60057e17e2be418
+  data.tar.gz: fbd58452672027b070cd34e0be625477a1acccc553e1f0d4396496446c418824
 SHA512:
-  metadata.gz: c92e86302c88b96d81dded14771366d26225970a915e9077d0b71311fdd02cdc4e4b2a068311afbc1fca8e951e018d04fb4ed39f5e311c92035316e1acf97bb2
-  data.tar.gz: bb1ce73610a01f2892c2dc1b7737eff292b851e2a988e20a0bf13628a5c28e24a492cc9c6065714adb7278da03b7574354264f96c8a8619d714b143e5df032b3
+  metadata.gz: f0d020c31b57e63e05e880d57c855df53b7fa07b60957f20e494ce314144d6215ab339fe5d06b8ba5f09aeb000f6e025ed7b1826c5954bd3018a391cdf55f398
+  data.tar.gz: 267911f506950eb0fc12792eb60722c3c2aba6f287850e8d249e33a6dba9011eb138df373e0c81308851ef9cc1905b4b8702fcda7d24e938826ddfbb2aa2bdb0

data/lib/state_machines/mermaid/renderer.rb

@@ -14,6 +14,7 @@ module StateMachines
         @last_state_metadata = nil
         @last_transition_metadata = nil
         @last_transition_metadata_map = nil
+        @last_state_id_map = nil
       end
 
       # The new simplified approach - leverages the diagram gem's semantic structure
@@ -75,10 +76,15 @@ module StateMachines
         return diagram.to_mermaid unless @last_transition_metadata
 
         lines = ["stateDiagram-v2"]
+        state_id_map = mermaid_state_id_map(diagram)
 
         diagram.states.each do |state|
-          fragment = state.respond_to?(:to_mermaid_fragment) ? state.to_mermaid_fragment : state.id
+          fragment = render_state_fragment(state, state_id_map.fetch(state.id))
           lines << "  #{fragment}" if fragment && !fragment.empty?
+
+          metadata = @last_state_metadata[state.id] || {}
+          lines << "  [*] --> #{state_id_map.fetch(state.id)}" if metadata[:type] == 'initial'
+          lines << "  #{state_id_map.fetch(state.id)} --> [*]" if metadata[:type] == 'final'
         end
 
         diagram.transitions.each do |transition|
@@ -126,16 +132,11 @@ module StateMachines
       def build_condition_tokens(conditions)
         return [] unless conditions.is_a?(Hash)
 
-        tokens = []
-        Array(conditions[:if]).each do |token|
-          next if token.nil? || token.to_s.empty?
-          tokens << "if #{token}"
-        end
-        Array(conditions[:unless]).each do |token|
-          next if token.nil? || token.to_s.empty?
-          tokens << "unless #{token}"
+        %i[if unless if_state unless_state if_all_states unless_all_states if_any_state unless_any_state].flat_map do |kind|
+          Array(conditions[kind]).filter_map do |token|
+            "#{kind} #{token}" unless token.nil? || token.to_s.empty?
+          end
         end
-        tokens
       end
 
       def build_callback_tokens(callbacks)
@@ -153,39 +154,56 @@ module StateMachines
 
       def format_callback_reference(callback)
         case callback
-        when Symbol, String
-          callback.to_s
         when Proc, Method
-          if callback.respond_to?(:source_location) && callback.source_location
-            file, line = callback.source_location
-            filename = File.basename(file) if file
-            "lambda@#{filename}:#{line}"
-          else
-            'lambda'
-          end
+          StateMachines::Diagram::Builder.callable_label(callback)
         else
           callback.to_s
         end
       end
 
       def format_node_id(node_id)
-        node_id == '*' ? '[*]' : node_id
+        return '[*]' if node_id == '*'
+
+        @last_state_id_map.fetch(node_id, node_id)
       end
 
-      def filter_mermaid_for_state(mermaid_syntax, state_name)
-        lines = mermaid_syntax.split("\n")
-        relevant_lines = lines.select do |line|
-          line.include?(state_name) || line.start_with?("stateDiagram")
+      def mermaid_state_id_map(diagram)
+        @last_state_id_map ||= diagram.states.each_with_object({}) do |state, map|
+          map[state.id] = safe_state_id(state.id)
         end
-        relevant_lines.join("\n")
+      end
+
+      def safe_state_id(state_id)
+        value = state_id.to_s
+        return value if value.match?(/\A[A-Za-z_][A-Za-z0-9_]*\z/)
+
+        "state_#{value.bytes.map { |byte| byte.to_s(16).rjust(2, '0') }.join}"
+      end
+
+      def render_state_fragment(state, rendered_id)
+        label = state.label || state.id
+        return "#{rendered_id} : #{label}" if rendered_id == state.id
+
+        "state #{mermaid_string(label)} as #{rendered_id}"
+      end
+
+      def mermaid_string(value)
+        %Q{"#{value.to_s.gsub('"', '\\\"')}"}
+      end
+
+      def filter_mermaid_for_state(mermaid_syntax, state_name)
+        filter_mermaid_lines(mermaid_syntax, state_name)
       end
       
       def filter_mermaid_for_event(mermaid_syntax, event_name)
-        lines = mermaid_syntax.split("\n")
-        relevant_lines = lines.select do |line|
-          line.include?(event_name) || line.start_with?("stateDiagram")
-        end
-        relevant_lines.join("\n")
+        filter_mermaid_lines(mermaid_syntax, event_name)
+      end
+
+      # Keeps only the diagram header and the lines mentioning the given term
+      def filter_mermaid_lines(mermaid_syntax, term)
+        mermaid_syntax.split("\n").select do |line|
+          line.include?(term) || line.start_with?("stateDiagram")
+        end.join("\n")
       end
     end
   end

data/lib/state_machines/mermaid/version.rb

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

data/test/mermaid_renderer_test.rb

@@ -46,12 +46,23 @@ class MermaidRendererTest < Minitest::Test
   end
 
   def test_final_states
+    klass = Class.new do
+      attr_accessor :state
+
+      state_machine :state, initial: :idle do
+        event :finish do
+          transition idle: :done
+        end
+      end
+    end
+
     io = StringIO.new
-    StateMachines::Mermaid::Renderer.draw_machine(Character.state_machine(:status), io: io)
+    StateMachines::Mermaid::Renderer.draw_machine(klass.state_machine(:state), io: io)
     
     output = io.string
-    # The mermaid gem doesn't add [*] for final states by default
-    assert_includes output, "dead : dead"
+    assert_includes output, "done : done"
+    assert_includes output, "[*] --> idle"
+    assert_includes output, "done --> [*]"
   end
 
   def test_multiple_from_states
@@ -143,11 +154,10 @@ class MermaidRendererTest < Minitest::Test
     StateMachines::Mermaid::Renderer.draw_machine(klass.state_machine(:status), io: io)
     
     output = io.string
-    # The mermaid gem doesn't sanitize IDs by default
-    assert_includes output, "waiting-for-input"
-    assert_includes output, "processing/data"
-    assert_includes output, "error!"
-    assert_includes output, "waiting-for-input --> processing/data"
+    assert_includes output, 'state "waiting-for-input" as state_77616974696e672d666f722d696e707574'
+    assert_includes output, 'state "processing/data" as state_70726f63657373696e672f64617461'
+    assert_includes output, 'state "error!" as state_6572726f7221'
+    assert_includes output, 'state_77616974696e672d666f722d696e707574 --> state_70726f63657373696e672f64617461'
   end
 
   def test_dragon_age_progression
@@ -190,6 +200,33 @@ class MermaidRendererTest < Minitest::Test
     assert output.include?("-->"), "Should have transitions"
   end
 
+  def test_renders_coordinated_state_guards
+    klass = Class.new do
+      attr_accessor :state, :gate
+
+      state_machine :gate, initial: :locked do
+        event :unlock do
+          transition locked: :unlocked
+        end
+      end
+
+      state_machine :state, initial: :idle do
+        event :run do
+          transition idle: :running, if_state: { gate: :unlocked }
+        end
+      end
+    end
+
+    io = StringIO.new
+    StateMachines::Mermaid::Renderer.draw_machine(
+      klass.state_machine(:state),
+      io: io,
+      show_conditions: true
+    )
+
+    assert_includes io.string, '[if_state gate=unlocked]'
+  end
+
   def test_all_character_types_render_properly
     [@dragon, @mage, @troll, @regiment].each do |character|
       character.class.state_machines.each do |name, machine|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-mermaid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: mermaid
   requirement: !ruby/object:Gem::Requirement
@@ -83,16 +83,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.6.0
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.6.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -140,14 +140,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: Mermaid renderer for state machines
 test_files: