mermaid 0.0.1 → 0.0.2

data/sig/diagrams/base.rbs

@@ -0,0 +1,8 @@
+# RBS signatures for patches applied to the 'diagram' gem's base class
+module Diagrams
+  class Base
+    # Added by mermaid-ruby gem
+    # Generates the Mermaid syntax representation of the diagram.
+    def to_mermaid: () -> String
+  end
+end

data/sig/diagrams/class_diagram.rbs

@@ -0,0 +1,18 @@
+# RBS signatures for patches applied to the 'diagram' gem's ClassDiagram class
+module Diagrams
+  class ClassDiagram < Base
+    # Added by mermaid-ruby gem
+    # Generates the Mermaid syntax for the class diagram.
+    def to_mermaid: () -> String
+
+    # Original methods from diagram gem (if known/needed for context)
+    # attr_reader classes: Array[Elements::ClassEntity]
+    # attr_reader relationships: Array[Elements::Relationship]
+    # def initialize: (classes: Array[Elements::ClassEntity], relationships: Array[Elements::Relationship], ?version: untyped) -> void
+    # ... other methods ...
+
+    # Patched private method (optional to include in RBS)
+    # private
+    # def format_class_entity: (Elements::ClassEntity) -> String
+  end
+end

data/sig/diagrams/elements/edge.rbs

@@ -0,0 +1,16 @@
+# RBS signatures for patches applied to the 'diagram' gem's Edge element class
+module Diagrams
+  module Elements
+    class Edge < Dry::Struct
+      # Added by mermaid-ruby gem
+      # Generates the Mermaid fragment for a flowchart edge.
+      def to_mermaid_fragment: () -> String
+
+      # Original attributes/methods (if known/needed)
+      # attr_reader source_id: String
+      # attr_reader target_id: String
+      # attr_reader label: String?
+      # ...
+    end
+  end
+end

data/sig/diagrams/elements/node.rbs

@@ -0,0 +1,15 @@
+# RBS signatures for patches applied to the 'diagram' gem's Node element class
+module Diagrams
+  module Elements
+    class Node < Dry::Struct
+      # Added by mermaid-ruby gem
+      # Generates the Mermaid fragment for a flowchart node.
+      def to_mermaid_fragment: () -> String
+
+      # Original attributes/methods (if known/needed)
+      # attr_reader id: String
+      # attr_reader label: String
+      # ...
+    end
+  end
+end

data/sig/diagrams/elements/relationship.rbs

@@ -0,0 +1,17 @@
+# RBS signatures for patches applied to the 'diagram' gem's Relationship element class
+module Diagrams
+  module Elements
+    class Relationship < Dry::Struct
+      # Added by mermaid-ruby gem
+      # Generates the Mermaid fragment for a relationship.
+      def to_mermaid_fragment: () -> String
+
+      # Original attributes/methods (if known/needed)
+      # attr_reader source_class_name: String
+      # attr_reader target_class_name: String
+      # attr_reader type: String
+      # attr_reader label: String?
+      # ...
+    end
+  end
+end

data/sig/diagrams/elements/slice.rbs

@@ -0,0 +1,16 @@
+# RBS signatures for patches applied to the 'diagram' gem's Slice element class
+module Diagrams
+  module Elements
+    class Slice < Dry::Struct
+      # Added by mermaid-ruby gem
+      # Generates the Mermaid fragment for a pie chart slice.
+      def to_mermaid_fragment: () -> String
+
+      # Original attributes/methods (if known/needed)
+      # attr_reader label: String
+      # attr_reader value: Float
+      # attr_reader percentage: Float?
+      # ...
+    end
+  end
+end

data/sig/diagrams/elements/state.rbs

@@ -0,0 +1,15 @@
+# RBS signatures for patches applied to the 'diagram' gem's State element class
+module Diagrams
+  module Elements
+    class State < Dry::Struct
+      # Added by mermaid-ruby gem
+      # Generates the Mermaid fragment for a state definition.
+      def to_mermaid_fragment: () -> String
+
+      # Original attributes/methods (if known/needed)
+      # attr_reader id: String
+      # attr_reader label: String?
+      # ...
+    end
+  end
+end

data/sig/diagrams/elements/task.rbs

@@ -0,0 +1,17 @@
+# RBS signatures for patches applied to the 'diagram' gem's Task element class
+module Diagrams
+  module Elements
+    class Task < Dry::Struct
+      # Added by mermaid-ruby gem
+      # Generates the Mermaid fragment for a Gantt task.
+      def to_mermaid_fragment: () -> String
+
+      # Original attributes/methods (if known/needed)
+      # attr_reader id: String
+      # attr_reader name: String
+      # attr_reader start_date: String
+      # attr_reader end_date: String
+      # ...
+    end
+  end
+end

data/sig/diagrams/elements/transition.rbs

@@ -0,0 +1,16 @@
+# RBS signatures for patches applied to the 'diagram' gem's Transition element class
+module Diagrams
+  module Elements
+    class Transition < Dry::Struct
+      # Added by mermaid-ruby gem
+      # Generates the Mermaid fragment for a transition.
+      def to_mermaid_fragment: () -> String
+
+      # Original attributes/methods (if known/needed)
+      # attr_reader source_state_id: String
+      # attr_reader target_state_id: String
+      # attr_reader label: String?
+      # ...
+    end
+  end
+end

data/sig/diagrams/flowchart_diagram.rbs

@@ -0,0 +1,14 @@
+# RBS signatures for patches applied to the 'diagram' gem's FlowchartDiagram class
+module Diagrams
+  class FlowchartDiagram < Base
+    # Added by mermaid-ruby gem
+    # Generates the Mermaid syntax for the flowchart diagram.
+    def to_mermaid: () -> String
+
+    # Original methods from diagram gem (if known/needed for context)
+    # attr_reader nodes: Array[Elements::Node]
+    # attr_reader edges: Array[Elements::Edge]
+    # def initialize: (nodes: Array[Elements::Node], edges: Array[Elements::Edge], ?version: untyped) -> void
+    # ... other methods ...
+  end
+end

data/sig/diagrams/gantt_diagram.rbs

@@ -0,0 +1,14 @@
+# RBS signatures for patches applied to the 'diagram' gem's GanttDiagram class
+module Diagrams
+  class GanttDiagram < Base
+    # Added by mermaid-ruby gem
+    # Generates the Mermaid syntax for the Gantt chart.
+    def to_mermaid: () -> String
+
+    # Original methods from diagram gem (if known/needed for context)
+    # attr_reader title: String
+    # attr_reader tasks: Array[Elements::Task]
+    # def initialize: (?title: String, ?tasks: Array[Elements::Task], ?version: untyped) -> void
+    # ... other methods ...
+  end
+end

data/sig/diagrams/pie_diagram.rbs

@@ -0,0 +1,14 @@
+# RBS signatures for patches applied to the 'diagram' gem's PieDiagram class
+module Diagrams
+  class PieDiagram < Base
+    # Added by mermaid-ruby gem
+    # Generates the Mermaid syntax for the pie chart.
+    def to_mermaid: () -> String
+
+    # Original methods from diagram gem (if known/needed for context)
+    # attr_reader title: String
+    # attr_reader slices: Array[Elements::Slice]
+    # def initialize: (?title: String, ?slices: Array[Elements::Slice], ?version: untyped) -> void
+    # ... other methods ...
+  end
+end

data/sig/diagrams/state_diagram.rbs

@@ -0,0 +1,18 @@
+# RBS signatures for patches applied to the 'diagram' gem's StateDiagram class
+module Diagrams
+  class StateDiagram < Base
+    # Added by mermaid-ruby gem
+    # Generates the Mermaid syntax for the state diagram.
+    def to_mermaid: () -> String
+
+    # Original methods from diagram gem (if known/needed for context)
+    # attr_reader states: Array[Elements::State]
+    # attr_reader transitions: Array[Elements::Transition]
+    # def initialize: (states: Array[Elements::State], transitions: Array[Elements::Transition], ?version: untyped) -> void
+    # ... other methods ...
+
+    # Patched private method (optional to include in RBS)
+    # private
+    # def validate_elements!: () -> void
+  end
+end

data/sig/mermaid/base_diagram.rbs

@@ -0,0 +1,31 @@
+module Mermaid
+  # Abstract base class for all diagram types.
+  # Subclasses should inherit from this and implement required methods.
+  class BaseDiagram < ::Dry::Struct
+    # Placeholder for Dry.Types module if needed within RBS
+    module Types
+      # Define types used in attributes if necessary
+    end
+
+    # Converts the diagram's specific data to a hash.
+    # Subclasses must implement this.
+    # @raise [NotImplementedError]
+    # @return [Hash]
+    def to_hash: () -> Hash[untyped, untyped]
+
+    # Generates the Mermaid syntax representation of the diagram.
+    # Subclasses must override this method.
+    # @raise [NotImplementedError]
+    # @return [String]
+    def to_mermaid: () -> String
+
+    # Generates the Mermaid syntax representation.
+    # @deprecated Use #to_mermaid instead.
+    # @return [String]
+    def to_s: () -> String
+
+    # Potentially add `generate` if it was meant to be public,
+    # otherwise assume it's an internal detail called by `to_s`/`to_mermaid`.
+    # def generate: () -> String
+  end
+end

data/sig/mermaid/state_diagram.rbs

@@ -0,0 +1,26 @@
+module Mermaid
+  class StateDiagram < BaseDiagram
+    KEYWORD: String
+
+    # Define types for attributes if not already globally available
+    # Assuming State and Transition types are defined elsewhere or inferred
+    # If State and Transition have their own RBS files, they should be referenced.
+    # Example:
+    # type state = StateDiagram::State
+    # type transition = StateDiagram::Transition
+
+    attr_reader id: String
+    attr_reader states: Array[StateDiagram::State] # Assuming State is defined
+    attr_reader transitions: Array[StateDiagram::Transition] # Assuming Transition is defined
+
+    # @deprecated Use #to_mermaid instead.
+    def generate: () -> String
+
+    # Generates the Mermaid syntax for the state diagram.
+    # @return [String]
+    def to_mermaid: () -> String
+
+    # Need RBS definitions for State and Transition classes as well
+    # in sig/mermaid/state_diagram/state.rbs and sig/mermaid/state_diagram/transition.rbs
+  end
+end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: mermaid
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Abdelkader Boudih
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-24 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: diagram
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -25,33 +38,145 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-types
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cuprite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :runtime
+        version: '5.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-struct
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
+        version: '1.59'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.59'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Generate Diagrams and Flowcharts with Mermaid
 email:
 - terminale@gmail.com
@@ -64,27 +189,36 @@ files:
 - README.md
 - Rakefile
 - lib/mermaid.rb
-- lib/mermaid/base_diagram.rb
-- lib/mermaid/c4_diagram.rb
-- lib/mermaid/class_diagram.rb
-- lib/mermaid/er_diagram.rb
-- lib/mermaid/flowchart_diagram.rb
-- lib/mermaid/flowchart_diagram/link.rb
-- lib/mermaid/flowchart_diagram/node.rb
-- lib/mermaid/flowchart_diagram/parser.rb
-- lib/mermaid/gantt_diagram.rb
-- lib/mermaid/git_graph_diagram.rb
-- lib/mermaid/info_flow_diagram.rb
-- lib/mermaid/mindmap_diagram.rb
-- lib/mermaid/pie_diagram.rb
-- lib/mermaid/quadrant_diagram.rb
-- lib/mermaid/requirement_diagram.rb
-- lib/mermaid/sankey_diagram.rb
-- lib/mermaid/sequence_diagram.rb
-- lib/mermaid/state_diagram.rb
-- lib/mermaid/user_journey_diagram.rb
+- lib/mermaid/class_diagram_renderer.rb
+- lib/mermaid/element_renderers/edge_renderer.rb
+- lib/mermaid/element_renderers/node_renderer.rb
+- lib/mermaid/element_renderers/relationship_renderer.rb
+- lib/mermaid/element_renderers/slice_renderer.rb
+- lib/mermaid/element_renderers/state_renderer.rb
+- lib/mermaid/element_renderers/task_renderer.rb
+- lib/mermaid/element_renderers/transition_renderer.rb
+- lib/mermaid/flowchart_diagram_renderer.rb
+- lib/mermaid/gantt_diagram_renderer.rb
+- lib/mermaid/gitgraph_diagram_renderer.rb
+- lib/mermaid/pie_diagram_renderer.rb
+- lib/mermaid/state_diagram_renderer.rb
+- lib/mermaid/timeline_diagram_renderer.rb
 - lib/mermaid/version.rb
-- lib/mermaid/xy_diagram.rb
+- sig/diagrams/base.rbs
+- sig/diagrams/class_diagram.rbs
+- sig/diagrams/elements/edge.rbs
+- sig/diagrams/elements/node.rbs
+- sig/diagrams/elements/relationship.rbs
+- sig/diagrams/elements/slice.rbs
+- sig/diagrams/elements/state.rbs
+- sig/diagrams/elements/task.rbs
+- sig/diagrams/elements/transition.rbs
+- sig/diagrams/flowchart_diagram.rbs
+- sig/diagrams/gantt_diagram.rbs
+- sig/diagrams/pie_diagram.rbs
+- sig/diagrams/state_diagram.rbs
+- sig/mermaid/base_diagram.rbs
+- sig/mermaid/state_diagram.rbs
 homepage: https://github.com/seuros/mermaid-ruby
 licenses:
 - MIT
@@ -92,7 +226,7 @@ metadata:
   homepage_uri: https://github.com/seuros/mermaid-ruby
   source_code_uri: https://github.com/seuros/mermaid-ruby
   changelog_uri: https://github.com/seuros/mermaid-ruby/blob/master/CHANGELOG.md
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -100,15 +234,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Generate Diagrams and Flowcharts with Mermaid
 test_files: []

data/lib/mermaid/base_diagram.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Mermaid
-  class BaseDiagram < Dry::Struct
-    module Types
-      include Dry.Types()
-    end
-
-    def to_s
-      generate
-    end
-  end
-end

data/lib/mermaid/c4_diagram.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Mermaid
-  class C4Diagram < BaseDiagram
-    def initialize(*)
-      raise NotImplementedError, "C4Diagram is not implemented yet"
-    end
-  end
-end

data/lib/mermaid/class_diagram.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Mermaid
-  class ClassDiagram < BaseDiagram
-    def initialize(*)
-      raise NotImplementedError, "ClassDiagram is not implemented yet"
-    end
-
-  end
-end

data/lib/mermaid/er_diagram.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Mermaid
-  class ERDiagram < BaseDiagram
-    def initialize(*)
-      raise NotImplementedError, "ERDiagram is not implemented yet"
-    end
-  end
-end

data/lib/mermaid/flowchart_diagram/link.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Mermaid
-  class FlowchartDiagram::Link < Dry::Struct
-    attribute :from, FlowchartDiagram::Types::String
-    attribute :to, FlowchartDiagram::Types::String
-    attribute :label, FlowchartDiagram::Types::String.optional.default(nil)
-    attribute :type, FlowchartDiagram::Types::String.default('arrow_head')
-                                                    .enum('arrow_head',
-                                                          'open_link',
-                                                          'text_link',
-                                                          'dotted',
-                                                          'thick',
-                                                          'invisible'
-                                                    )
-
-    def representation
-      case type
-      when 'arrow_head'
-        if label.nil?
-          '-->'
-        else
-          "-->|#{label_representation}|"
-        end
-      end
-    end
-
-    def label_representation
-      ## if label is unicode return it with quotes
-      ## else return it without quotes
-      if label.nil?
-        ''
-      else
-        if label.ascii_only?
-          label
-        else
-          "\"#{label}\""
-        end
-      end
-    end
-
-    def to_s
-       [from, representation, to].join
-    end
-  end
-end

data/lib/mermaid/flowchart_diagram/node.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Mermaid
-  class FlowchartDiagram::Node < Dry::Struct
-    SHAPES = %w(default round stadium subroutine database circle double_circle asymmetric rhombus hexagon parallelogram parallelogram_alt trapezoid trapezoid_alt).freeze
-
-    SHAPE_FORMATS = {
-      'default' => "%s[%s]", # A[Hard
-      'round' => "%s(%s)", # A(Hard)
-      'stadium' => "%s([%s])", # A([Hard])
-      'subroutine' => "%s[[%s]]", # A([[Hard]])
-      'database' => "%s[(%s)]", # A[(Hard)]
-      'circle' => "%s((%s))", # A((Hard))
-      'double_circle' => "%s(((%s)))", # A(((Hard)))
-      'asymmetric' => "%s>%s]", # A>Hard]
-      'rhombus' => "%s{%s}", # A{Hard}
-      'hexagon' => "%s{{%s}}", # A{{Hard}}
-      'parallelogram' => "%s[/%s/]", # A[/Hard/]
-      'parallelogram_alt' => "%s[\\%s\\]", # A[\Hard\]
-      'trapezoid' => "%s[/%s\\]", # A[/Hard\]
-      'trapezoid_alt' => "%s[\\%s/]" # A[\Hard/]
-    }.freeze
-
-    attribute :id, FlowchartDiagram::Types::String
-    attribute :label, FlowchartDiagram::Types::String
-    attribute :shape, FlowchartDiagram::Types::String.default('default').enum(*SHAPES)
-
-    def to_s(show_label = true)
-      if show_label
-        format(SHAPE_FORMATS[shape], id, label)
-      else
-        id
-      end
-    end
-  end
-end