graphomaton 1.0.0 → 1.1.0

data/sig/graphomaton.rbs

@@ -0,0 +1,127 @@
+class Graphomaton
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class ValidationError < Error
+  end
+
+  class ParseError < Error
+  end
+
+  class LayoutError < Error
+  end
+
+  class ExportError < Error
+  end
+
+  class ConversionError < ExportError
+  end
+
+  class SecurityError < Error
+  end
+
+  class Label < Data
+    attr_reader kind: Symbol
+    attr_reader value: untyped
+    def self.text: (untyped value) -> Label
+    def self.symbols: (*untyped values) -> Label
+    def self.epsilon: (?untyped display) -> Label
+    def self.uml: (event: untyped, ?guard: untyped, ?action: untyped) -> Label
+    def to_s: () -> String
+    def to_h: () -> Hash[Symbol, untyped]
+  end
+
+  class Diagnostic < Data
+    attr_reader code: String
+    attr_reader severity: Symbol
+    attr_reader path: Array[untyped]
+    attr_reader message: String
+    attr_reader hint: String?
+    def to_h: () -> Hash[Symbol, untyped]
+  end
+
+  class RenderOptions < Data
+    attr_reader format: Symbol
+    attr_reader width: Numeric
+    attr_reader height: Numeric
+    attr_reader options: Hash[Symbol, untyped]
+  end
+
+  class SvgOptions < Data
+    attr_reader width: Numeric
+    attr_reader height: Numeric
+    attr_reader options: Hash[Symbol, untyped]
+  end
+
+  class RenderResult < Data
+    attr_reader output: String
+    attr_reader diagnostics: Array[Diagnostic]
+    attr_reader bounds: Hash[Symbol, Numeric]?
+    attr_reader layout: Hash[untyped, Hash[Symbol, Numeric]]?
+  end
+
+  class State < Data
+    attr_reader id: untyped
+    attr_reader x: Numeric?
+    attr_reader y: Numeric?
+    attr_reader label: untyped
+    attr_reader style: Hash[untyped, untyped]?
+    attr_reader metadata: Hash[untyped, untyped]?
+    attr_reader shape: untyped
+    attr_reader kind: Symbol?
+  end
+
+  class Transition < Data
+    attr_reader id: Integer
+    attr_reader from: untyped
+    attr_reader to: untyped
+    attr_reader label: untyped
+    attr_reader style: Hash[untyped, untyped]?
+    attr_reader metadata: Hash[untyped, untyped]?
+    attr_reader line_style: untyped
+  end
+
+  def initialize: (?validation: Symbol) -> void
+  def states: () -> Hash[untyped, Hash[Symbol, untyped]]
+  def transitions: () -> Array[Hash[Symbol, untyped]]
+  def initial_state: () -> untyped
+  def final_states: () -> Array[untyped]
+  def revision: () -> Integer
+  def add_state: (untyped name, ?Numeric? x, ?Numeric? y, **untyped) -> self
+  def upsert_state: (untyped name, ?Numeric? x, ?Numeric? y, **untyped) -> self
+  def update_state: (untyped name, **untyped) -> self
+  def remove_state: (untyped name, ?cascade: bool) -> self
+  def add_transition: (untyped from, untyped to, untyped label, **untyped) -> self
+  def update_transition: (untyped identifier, **untyped) -> self
+  def remove_transition: (untyped identifier) -> self
+  def set_initial: (untyped state) -> self
+  def clear_initial: () -> self
+  def add_final: (untyped state) -> self
+  def remove_final: (untyped state) -> self
+  def validation_errors: (?profile: Symbol | Array[Symbol]) -> Array[String]
+  def validation_diagnostics: (?profile: Symbol | Array[Symbol]) -> Array[Diagnostic]
+  def validate!: (?profile: Symbol | Array[Symbol]) -> true
+  def valid?: (?profile: Symbol | Array[Symbol]) -> bool
+  def to_h: () -> Hash[Symbol, untyped]
+  def to_json: (*untyped) -> String
+  def to_yaml: (**untyped) -> String
+  def render: (?format: Symbol | String, ?width: Numeric, ?height: Numeric, ?strict_semantics: bool, **untyped) -> String
+  def render_result: (?format: Symbol | String, ?width: Numeric, ?height: Numeric, ?strict_semantics: bool, **untyped) -> RenderResult
+  def render_with: (RenderOptions options) -> String
+  def reachable_states: () -> Array[untyped]
+  def reachable_from: (untyped state) -> Array[untyped]
+  def graph_roots: () -> Array[untyped]
+  def weakly_connected_components: () -> Array[Array[untyped]]
+  def sink_states: () -> Array[untyped]
+  def self_loop_traps: () -> Array[untyped]
+  def bottom_sccs: () -> Array[Array[untyped]]
+  def write: (_Writer io, ?format: Symbol | String, ?width: Numeric, ?height: Numeric, **untyped) -> Integer
+
+  def self.from_hash: (Hash[untyped, untyped] data, **untyped) -> Graphomaton
+  def self.from_json: (String | _Reader source, **untyped) -> Graphomaton
+  def self.from_yaml: (String | _Reader source, **untyped) -> Graphomaton
+  def self.register_exporter: (Symbol | String name, **untyped) -> untyped
+                            | (Symbol | String name, **untyped) { () -> untyped } -> untyped
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphomaton
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -23,48 +23,58 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-description: Graphomaton is a lightweight Ruby library for creating and visualizing
-  finite state machines. It supports multiple output formats including SVG, Mermaid.js,
-  GraphViz DOT, and PlantUML, making it easy to generate professional automaton diagrams.
+description: Graphomaton creates, analyzes, lays out, and exports finite state machines
+  as SVG, PNG, PDF, WebP, Mermaid.js, GraphViz DOT, PlantUML, and standalone HTML.
 email:
 - t.yudai92@gmail.com
-executables: []
+executables:
+- graphomaton
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codespellignore"
-- ".rspec"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
-- Rakefile
+- SECURITY.md
+- docs/architecture.md
+- docs/cli.md
+- docs/custom-exporters.md
+- docs/exporters.md
+- docs/input-schema.md
+- docs/migration-1.1.md
+- docs/performance.md
+- docs/releasing.md
+- exe/graphomaton
 - lib/graphomaton.rb
+- lib/graphomaton/atomic_file.rb
+- lib/graphomaton/cli.rb
+- lib/graphomaton/cli/config.rb
+- lib/graphomaton/errors.rb
+- lib/graphomaton/exporter_registry.rb
 - lib/graphomaton/exporters.rb
 - lib/graphomaton/exporters/dot.rb
 - lib/graphomaton/exporters/mermaid.rb
+- lib/graphomaton/exporters/pdf.rb
 - lib/graphomaton/exporters/plantuml.rb
+- lib/graphomaton/exporters/png.rb
 - lib/graphomaton/exporters/svg.rb
+- lib/graphomaton/exporters/webp.rb
+- lib/graphomaton/identifier_allocator.rb
+- lib/graphomaton/input_policy.rb
+- lib/graphomaton/layout/force_tree.rb
+- lib/graphomaton/model.rb
+- lib/graphomaton/process_runner.rb
+- lib/graphomaton/url_policy.rb
 - lib/graphomaton/version.rb
-- sample/basic.rb
-- sample/complex.rb
-- sample/long_names.rb
-- sample/nfa.rb
-- sample/skip_states.rb
-- spec/exporters/dot_spec.rb
-- spec/exporters/mermaid_spec.rb
-- spec/exporters/plantuml_spec.rb
-- spec/exporters/svg_spec.rb
-- spec/graphomaton_edge_cases_spec.rb
-- spec/graphomaton_spec.rb
-- spec/spec_helper.rb
+- sig/graphomaton.rbs
 homepage: https://github.com/ydah/graphomaton
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/ydah/graphomaton
   source_code_uri: https://github.com/ydah/graphomaton
   changelog_uri: https://github.com/ydah/graphomaton/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/graphomaton
+  bug_tracker_uri: https://github.com/ydah/graphomaton/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -80,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
-summary: A tiny Ruby library for generating finite state machine (automaton) diagrams.
+summary: Generate and analyze finite state machine diagrams in multiple formats.
 test_files: []

data/.rspec

@@ -1 +0,0 @@
---require spec_helper

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official email address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/sample/basic.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/graphomaton'
-
-automaton = Graphomaton.new
-
-automaton.add_state('待機中')
-automaton.add_state('お金投入済み')
-automaton.add_state('商品選択済み')
-
-automaton.set_initial('待機中')
-automaton.add_final('待機中')
-
-automaton.add_transition('待機中', 'お金投入済み', 'お金を投入する')
-automaton.add_transition('お金投入済み', '商品選択済み', '商品のボタンを押す')
-automaton.add_transition('商品選択済み', '待機中', '商品を排出する')
-
-automaton.save_svg('automaton.svg')
-puts 'Generated automaton.svg'
-
-automaton.save_html('automaton.html')
-puts 'Generated automaton.html (Mermaid.js - requires internet connection)'
-
-automaton.save_dot('automaton.dot')
-puts 'Generated automaton.dot (GraphViz format)'
-puts 'To convert to PNG: dot -Tpng automaton.dot -o automaton.png'
-
-automaton.save_plantuml('automaton.puml')
-puts 'Generated automaton.puml (PlantUML format)'
-puts 'To convert to PNG: Use PlantUML server or jar file'

data/sample/complex.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/graphomaton'
-
-complex = Graphomaton.new
-
-complex.add_state('A')
-complex.add_state('B')
-complex.add_state('C')
-
-complex.set_initial('A')
-complex.add_final('C')
-
-complex.add_transition('A', 'B', 'x')
-complex.add_transition('A', 'B', 'y')
-
-complex.add_transition('B', 'C', 'a')
-complex.add_transition('C', 'B', 'b')
-
-complex.add_transition('B', 'B', 'loop')
-
-complex.save_svg('complex_transitions.svg')
-puts 'Generated complex_transitions.svg'
-
-complex.save_html('complex_transitions.html')
-puts 'Generated complex_transitions.html'
-
-complex.save_dot('complex_transitions.dot')
-puts 'Generated complex_transitions.dot'
-
-complex.save_plantuml('complex_transitions.puml')
-puts 'Generated complex_transitions.puml'

data/sample/long_names.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/graphomaton'
-
-automaton = Graphomaton.new
-
-automaton.add_state('A')
-automaton.add_state('Short')
-automaton.add_state('Medium Name')
-automaton.add_state('VeryLongStateName')
-
-automaton.set_initial('A')
-automaton.add_final('VeryLongStateName')
-
-automaton.add_transition('A', 'Short', 'go')
-automaton.add_transition('Short', 'Medium Name', 'next')
-automaton.add_transition('Medium Name', 'VeryLongStateName', 'final')
-
-automaton.save_svg('long_names.svg')
-puts 'Generated long_names.svg'

data/sample/nfa.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/graphomaton'
-
-nfa = Graphomaton.new
-
-nfa.add_state('q0')
-nfa.add_state('q1')
-nfa.add_state('q2')
-
-nfa.set_initial('q0')
-nfa.add_final('q2')
-
-nfa.add_transition('q0', 'q0', 'a,b')
-nfa.add_transition('q0', 'q1', 'a')
-nfa.add_transition('q1', 'q2', 'b')
-
-nfa.save_svg('nfa_example.svg', 600, 400)
-puts 'Generated nfa_example.svg'
-
-nfa.save_html('nfa_example.html')
-puts 'Generated nfa_example.html'
-
-nfa.save_dot('nfa_example.dot')
-puts 'Generated nfa_example.dot'
-
-nfa.save_plantuml('nfa_example.puml')
-puts 'Generated nfa_example.puml'

data/sample/skip_states.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/graphomaton'
-
-automaton = Graphomaton.new
-
-automaton.add_state('A')
-automaton.add_state('B')
-automaton.add_state('C')
-automaton.add_state('D')
-
-automaton.set_initial('A')
-automaton.add_final('D')
-
-automaton.add_transition('A', 'B', '1 step')
-automaton.add_transition('A', 'C', 'skip 1 state')
-automaton.add_transition('A', 'D', 'skip 2 states')
-automaton.add_transition('B', 'C', '1 step')
-automaton.add_transition('C', 'D', '1 step')
-automaton.add_transition('D', 'A', 'back to start')
-
-automaton.save_svg('skip_states.svg')
-puts 'Generated skip_states.svg'

data/spec/exporters/dot_spec.rb

@@ -1,146 +0,0 @@
-# frozen_string_literal: true
-
-require 'graphomaton'
-
-RSpec.describe Graphomaton::Exporters::Dot do
-  let(:automaton) { Graphomaton.new }
-  let(:dot_exporter) { described_class.new(automaton) }
-
-  describe '#export' do
-    context 'with empty automaton' do
-      it 'generates valid DOT syntax' do
-        dot_output = dot_exporter.export
-        expect(dot_output).to include('digraph')
-        expect(dot_output).to include('rankdir=LR')
-      end
-
-      it 'includes basic graph attributes' do
-        dot_output = dot_exporter.export
-        expect(dot_output).to match(/node\s+\[shape\s+=\s+circle\]/)
-      end
-    end
-
-    context 'with states' do
-      before do
-        automaton.add_state('A')
-        automaton.add_state('B')
-        automaton.add_state('C')
-        automaton.add_transition('A', 'B', 'x')
-      end
-
-      it 'includes all states in transitions' do
-        dot_output = dot_exporter.export
-        expect(dot_output).to include('"A"')
-        expect(dot_output).to include('"B"')
-      end
-
-      it 'marks final states with double circle' do
-        automaton.add_final('C')
-        dot_output = dot_exporter.export
-        expect(dot_output).to match(/node\s+\[shape\s+=\s+doublecircle\];\s+"C"/)
-      end
-    end
-
-    context 'with initial state' do
-      before do
-        automaton.add_state('Start')
-        automaton.set_initial('Start')
-      end
-
-      it 'creates invisible initial node' do
-        dot_output = dot_exporter.export
-        expect(dot_output).to include('__start__')
-        expect(dot_output).to match(/__start__\s+\[shape=point\]/)
-      end
-
-      it 'creates arrow from invisible node to initial state' do
-        dot_output = dot_exporter.export
-        expect(dot_output).to include('__start__ -> "Start"')
-      end
-    end
-
-    context 'with transitions' do
-      before do
-        automaton.add_state('A')
-        automaton.add_state('B')
-        automaton.add_state('C')
-        automaton.add_transition('A', 'B', 'input_a')
-        automaton.add_transition('B', 'C', 'input_b')
-      end
-
-      it 'includes all transitions' do
-        dot_output = dot_exporter.export
-        expect(dot_output).to include('"A" -> "B"')
-        expect(dot_output).to include('"B" -> "C"')
-      end
-
-      it 'includes transition labels' do
-        dot_output = dot_exporter.export
-        expect(dot_output).to match(/"A"\s+->\s+"B"\s+\[label="input_a"\]/)
-        expect(dot_output).to match(/"B"\s+->\s+"C"\s+\[label="input_b"\]/)
-      end
-
-      it 'handles self-loops' do
-        automaton.add_transition('B', 'B', 'loop')
-        dot_output = dot_exporter.export
-        expect(dot_output).to match(/"B"\s+->\s+"B"\s+\[label="loop"\]/)
-      end
-    end
-
-    context 'with special characters in labels' do
-      before do
-        automaton.add_state('State 1')
-        automaton.add_state('State-2')
-        automaton.add_transition('State 1', 'State-2', 'a/b')
-      end
-
-      it 'handles spaces in state names' do
-        dot_output = dot_exporter.export
-        expect(dot_output).to include('"State 1"')
-        expect(dot_output).to include('"State-2"')
-      end
-
-      it 'handles special characters in labels' do
-        dot_output = dot_exporter.export
-        expect(dot_output).to match(/label="a\/b"/)
-      end
-    end
-
-    context 'with complete automaton' do
-      before do
-        automaton.add_state('q0')
-        automaton.add_state('q1')
-        automaton.add_state('q2')
-        automaton.set_initial('q0')
-        automaton.add_final('q2')
-        automaton.add_transition('q0', 'q1', 'a')
-        automaton.add_transition('q1', 'q2', 'b')
-        automaton.add_transition('q2', 'q0', 'c')
-      end
-
-      it 'generates complete valid DOT graph' do
-        dot_output = dot_exporter.export
-
-        # Should contain digraph wrapper
-        expect(dot_output).to start_with('digraph')
-        expect(dot_output).to end_with('}')
-
-        # Should contain all states in transitions
-        expect(dot_output).to include('"q0"')
-        expect(dot_output).to include('"q1"')
-        expect(dot_output).to include('"q2"')
-
-        # Should mark final state
-        expect(dot_output).to match(/node\s+\[shape\s+=\s+doublecircle\];\s+"q2"/)
-
-        # Should have initial arrow
-        expect(dot_output).to include('__start__ -> "q0"')
-
-        # Should have all transitions
-        expect(dot_output).to include('"q0" -> "q1"')
-        expect(dot_output).to include('"q1" -> "q2"')
-        expect(dot_output).to include('"q2" -> "q0"')
-      end
-    end
-  end
-end