mermaid 0.0.5 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +29 -0
  3. data/README.md +120 -111
  4. data/Rakefile +35 -3
  5. data/lib/mermaid/inline_title.rb +13 -0
  6. data/lib/mermaid/renderer.rb +105 -0
  7. data/lib/mermaid/renderers/class_renderer.rb +56 -0
  8. data/lib/mermaid/renderers/er_renderer.rb +43 -0
  9. data/lib/mermaid/renderers/flowchart_renderer.rb +27 -0
  10. data/lib/mermaid/renderers/gantt_renderer.rb +31 -0
  11. data/lib/mermaid/renderers/gitgraph_renderer.rb +50 -0
  12. data/lib/mermaid/renderers/pie_renderer.rb +34 -0
  13. data/lib/mermaid/renderers/state_renderer.rb +37 -0
  14. data/lib/mermaid/renderers/timeline_renderer.rb +24 -0
  15. data/lib/mermaid/to_mermaid.rb +9 -0
  16. data/lib/mermaid/version.rb +1 -1
  17. data/lib/mermaid.rb +8 -26
  18. data/sig/mermaid.rbs +64 -0
  19. metadata +26 -89
  20. data/lib/mermaid/class_diagram_renderer.rb +0 -45
  21. data/lib/mermaid/element_renderers/edge_renderer.rb +0 -19
  22. data/lib/mermaid/element_renderers/erd_entity_renderer.rb +0 -23
  23. data/lib/mermaid/element_renderers/erd_relationship_renderer.rb +0 -44
  24. data/lib/mermaid/element_renderers/node_renderer.rb +0 -16
  25. data/lib/mermaid/element_renderers/relationship_renderer.rb +0 -24
  26. data/lib/mermaid/element_renderers/slice_renderer.rb +0 -16
  27. data/lib/mermaid/element_renderers/state_renderer.rb +0 -15
  28. data/lib/mermaid/element_renderers/task_renderer.rb +0 -15
  29. data/lib/mermaid/element_renderers/transition_renderer.rb +0 -17
  30. data/lib/mermaid/er_diagram_renderer.rb +0 -24
  31. data/lib/mermaid/flowchart_diagram_renderer.rb +0 -23
  32. data/lib/mermaid/gantt_diagram_renderer.rb +0 -20
  33. data/lib/mermaid/gitgraph_diagram_renderer.rb +0 -113
  34. data/lib/mermaid/pie_diagram_renderer.rb +0 -16
  35. data/lib/mermaid/state_diagram_renderer.rb +0 -42
  36. data/lib/mermaid/timeline_diagram_renderer.rb +0 -29
  37. data/sig/diagrams/base.rbs +0 -8
  38. data/sig/diagrams/class_diagram.rbs +0 -18
  39. data/sig/diagrams/elements/edge.rbs +0 -16
  40. data/sig/diagrams/elements/erd_entity.rbs +0 -11
  41. data/sig/diagrams/elements/erd_relationship.rbs +0 -11
  42. data/sig/diagrams/elements/node.rbs +0 -15
  43. data/sig/diagrams/elements/relationship.rbs +0 -15
  44. data/sig/diagrams/elements/slice.rbs +0 -16
  45. data/sig/diagrams/elements/state.rbs +0 -15
  46. data/sig/diagrams/elements/task.rbs +0 -17
  47. data/sig/diagrams/elements/transition.rbs +0 -16
  48. data/sig/diagrams/er_diagram.rbs +0 -9
  49. data/sig/diagrams/flowchart_diagram.rbs +0 -14
  50. data/sig/diagrams/gantt_diagram.rbs +0 -14
  51. data/sig/diagrams/pie_diagram.rbs +0 -14
  52. data/sig/diagrams/state_diagram.rbs +0 -18
@@ -0,0 +1,50 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Mermaid
4
+ module Renderers
5
+ # Diagrams::GitgraphDiagram, whose content is already a gitGraph program:
6
+ # each statement renders as the Mermaid statement it models. Names, ids,
7
+ # messages and tags are quoted strings. A main branch other than "main"
8
+ # goes to the front matter config, which Mermaid reads without entity
9
+ # codes, so it must need none.
10
+ class GitgraphRenderer < Renderer
11
+ renders Diagrams::GitgraphDiagram, 'gitGraph'
12
+
13
+ private
14
+
15
+ def settings
16
+ return super if diagram.main_branch == 'main'
17
+ if text(diagram.main_branch) != diagram.main_branch
18
+ raise ArgumentError, "Mermaid cannot name the main branch #{diagram.main_branch.inspect}"
19
+ end
20
+
21
+ { **super, config: { gitGraph: { mainBranchName: diagram.main_branch } } }
22
+ end
23
+
24
+ def body = diagram.statements.map { statement(it) }
25
+
26
+ def statement(statement)
27
+ case statement[:command]
28
+ when :commit
29
+ "commit#{option('id', statement[:id])}#{option('msg', statement[:message])}#{tags(statement)}" \
30
+ "#{type(statement[:type])}"
31
+ when :branch then "branch #{quote(statement[:name])}#{" order: #{statement[:order]}" if statement[:order]}"
32
+ when :checkout then "checkout #{quote(statement[:name])}"
33
+ when :merge
34
+ "merge #{quote(statement[:branch])}#{option('id', statement[:id])}#{tags(statement)}" \
35
+ "#{" type: #{statement[:type]}" if statement[:type]}"
36
+ else # :cherry_pick
37
+ "cherry-pick#{option('id', statement[:commit_id])}#{option('parent', statement[:parent])}#{tags(statement)}"
38
+ end
39
+ end
40
+
41
+ def option(name, value) = value.nil? ? '' : " #{name}: #{quote(value)}"
42
+
43
+ def tags(statement) = statement.fetch(:tags, []).map { option('tag', it) }.join
44
+
45
+ # A commit's NORMAL type is Mermaid's default; a merge's explicit type is
46
+ # kept, since leaving it out draws the merge symbol instead.
47
+ def type(type) = type.nil? || type == :NORMAL ? '' : " type: #{type}"
48
+ end
49
+ end
50
+ end
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Mermaid
4
+ module Renderers
5
+ # Diagrams::PieDiagram. Values are plain decimals: Mermaid reads no
6
+ # exponent, and Float#to_s writes one for very small or large values.
7
+ class PieRenderer < Renderer
8
+ prepend InlineTitle
9
+
10
+ renders Diagrams::PieDiagram, 'pie'
11
+
12
+ private
13
+
14
+ def body = diagram.slices.map { "#{quote(it.label)} : #{decimal(it.value)}" }
15
+
16
+ # The shortest digits that read back as the same Float, without exponent:
17
+ # Float#to_s digits, with the decimal point moved by the exponent.
18
+ def decimal(value)
19
+ return value.to_s if value.is_a?(Integer)
20
+ return '0' if value.zero?
21
+
22
+ mantissa, exponent = value.to_s.split('e')
23
+ whole, fraction = mantissa.split('.')
24
+ digits = whole + fraction
25
+ point = whole.size + exponent.to_i
26
+ number = if point <= 0 then "0.#{'0' * -point}#{digits}"
27
+ elsif point >= digits.size then digits.ljust(point, '0')
28
+ else "#{digits[0...point]}.#{digits[point..]}"
29
+ end
30
+ number.include?('.') ? number.sub(/0+\z/, '').delete_suffix('.') : number
31
+ end
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,37 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Mermaid
4
+ module Renderers
5
+ # Diagrams::StateDiagram. Every state is declared, so a state without
6
+ # transitions still shows. A state id Mermaid cannot read as a plain name
7
+ # is aliased (s0, s1, ...) and shows its label, or its id. A transition
8
+ # reads "label [guard] / action".
9
+ class StateRenderer < Renderer
10
+ RESERVED = %w[state note end as direction classdef class style click hide scale default root_start root_end
11
+ acctitle accdescr].freeze
12
+
13
+ renders Diagrams::StateDiagram, 'stateDiagram-v2'
14
+
15
+ private
16
+
17
+ def body
18
+ name = names(diagram.states.map(&:id), 's', RESERVED)
19
+ [*diagram.states.map { declaration(it, name[it.id]) }, *diagram.transitions.map { transition(it, name) }]
20
+ end
21
+
22
+ def declaration(state, name)
23
+ return %(state "#{text(state.label || state.id)}" as #{name}) unless name == state.id
24
+
25
+ state.label ? "#{name} : #{text(state.label)}" : name
26
+ end
27
+
28
+ def transition(transition, name)
29
+ node = ->(id) { id == Diagrams::StateDiagram::TERMINAL ? '[*]' : name.fetch(id) }
30
+ line = "#{node[transition.source_state_id]} --> #{node[transition.target_state_id]}"
31
+ label = [transition.label, ("[#{transition.guard}]" if transition.guard),
32
+ ("/ #{transition.action}" if transition.action)].compact.join(' ')
33
+ label.empty? ? line : "#{line} : #{text(label)}"
34
+ end
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Mermaid
4
+ module Renderers
5
+ # Diagrams::TimelineDiagram. A period reads "label : event : event".
6
+ class TimelineRenderer < Renderer
7
+ prepend InlineTitle
8
+
9
+ KEYWORDS = %w[title section acctitle accdescr].freeze
10
+
11
+ renders Diagrams::TimelineDiagram, 'timeline'
12
+
13
+ private
14
+
15
+ def body
16
+ diagram.sections.flat_map do |section|
17
+ [*("section #{text(section.title)}" if section.title), *section.periods.map { period(it) }]
18
+ end
19
+ end
20
+
21
+ def period(period) = [line_start(period.label, KEYWORDS), *period.events.map { text(it) }].join(' : ')
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Mermaid
4
+ # Included into Diagrams::Base: every diagram renders itself.
5
+ module ToMermaid
6
+ # This diagram as Mermaid text.
7
+ def to_mermaid = Renderer.render(self)
8
+ end
9
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Mermaid
4
- VERSION = '0.0.5'
4
+ VERSION = '0.1.0'
5
5
  end
data/lib/mermaid.rb CHANGED
@@ -1,35 +1,17 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ require 'diagram'
4
+ require 'zeitwerk'
3
5
  require_relative 'mermaid/version'
4
- require 'diagrams'
5
6
 
6
7
  loader = Zeitwerk::Loader.for_gem
7
- loader.inflector.inflect(
8
- 'er_diagram_renderer' => 'ERDiagramRenderer',
9
- 'erd_entity_renderer' => 'ERDEntityRenderer',
10
- 'erd_relationship_renderer' => 'ERDRelationshipRenderer'
11
- )
8
+ loader.inflector.inflect('er_renderer' => 'ERRenderer')
12
9
  loader.setup
10
+ # Renderers register themselves for their diagram class as they load.
13
11
  loader.eager_load
14
12
 
15
- module Diagrams
16
- StateDiagram.prepend(Mermaid::StateDiagramRenderer)
17
- ClassDiagram.prepend(Mermaid::ClassDiagramRenderer)
18
- FlowchartDiagram.prepend(Mermaid::FlowchartDiagramRenderer)
19
- PieDiagram.prepend(Mermaid::PieDiagramRenderer)
20
- GanttDiagram.prepend(Mermaid::GanttDiagramRenderer)
21
- GitgraphDiagram.prepend(Mermaid::GitgraphDiagramRenderer)
22
- TimelineDiagram.prepend(Mermaid::TimelineDiagramRenderer)
23
- ERDiagram.prepend(Mermaid::ERDiagramRenderer)
24
- module Elements
25
- State.prepend(Mermaid::ElementRenderers::StateRenderer)
26
- Transition.prepend(Mermaid::ElementRenderers::TransitionRenderer)
27
- Relationship.prepend(Mermaid::ElementRenderers::RelationshipRenderer)
28
- Node.prepend(Mermaid::ElementRenderers::NodeRenderer)
29
- Edge.prepend(Mermaid::ElementRenderers::EdgeRenderer)
30
- Slice.prepend(Mermaid::ElementRenderers::SliceRenderer)
31
- Task.prepend(Mermaid::ElementRenderers::TaskRenderer)
32
- ERDEntity.prepend(Mermaid::ElementRenderers::ERDEntityRenderer) # Prepend ERD element renderers
33
- ERDRelationship.prepend(Mermaid::ElementRenderers::ERDRelationshipRenderer)
34
- end
13
+ # Mermaid text for the diagrams of the diagram gem: diagram.to_mermaid.
14
+ module Mermaid
35
15
  end
16
+
17
+ Diagrams::Base.include(Mermaid::ToMermaid)
data/sig/mermaid.rbs ADDED
@@ -0,0 +1,64 @@
1
+ module Mermaid
2
+ VERSION: String
3
+
4
+ module ToMermaid
5
+ def to_mermaid: () -> String
6
+ end
7
+
8
+ class Renderer
9
+ SAFE: Regexp
10
+ PLACEHOLDERS: Regexp
11
+ PLAIN: Regexp
12
+
13
+ def self.render: (Diagrams::Base diagram) -> String
14
+ def self.registry: () -> Hash[Class, singleton(Renderer)]
15
+
16
+ def initialize: (Diagrams::Base diagram) -> void
17
+ def render: () -> String
18
+ end
19
+
20
+ module InlineTitle
21
+ end
22
+
23
+ module Renderers
24
+ class FlowchartRenderer < Renderer
25
+ RESERVED: Array[String]
26
+ end
27
+
28
+ class StateRenderer < Renderer
29
+ RESERVED: Array[String]
30
+ end
31
+
32
+ class ClassRenderer < Renderer
33
+ ARROWS: Hash[Symbol, String]
34
+ RESERVED: Array[String]
35
+ OPERATION: Regexp
36
+ end
37
+
38
+ class ERRenderer < Renderer
39
+ LEFT: Hash[Symbol, String]
40
+ RIGHT: Hash[Symbol, String]
41
+ WORD: Regexp
42
+ end
43
+
44
+ class PieRenderer < Renderer
45
+ end
46
+
47
+ class GanttRenderer < Renderer
48
+ KEYWORDS: Array[String]
49
+ end
50
+
51
+ class TimelineRenderer < Renderer
52
+ KEYWORDS: Array[String]
53
+ end
54
+
55
+ class GitgraphRenderer < Renderer
56
+ end
57
+ end
58
+ end
59
+
60
+ module Diagrams
61
+ class Base
62
+ include Mermaid::ToMermaid
63
+ end
64
+ end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: mermaid
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.5
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Abdelkader Boudih
@@ -15,14 +15,14 @@ dependencies:
15
15
  requirements:
16
16
  - - ">="
17
17
  - !ruby/object:Gem::Version
18
- version: 0.3.4
18
+ version: '0.4'
19
19
  type: :runtime
20
20
  prerelease: false
21
21
  version_requirements: !ruby/object:Gem::Requirement
22
22
  requirements:
23
23
  - - ">="
24
24
  - !ruby/object:Gem::Version
25
- version: 0.3.4
25
+ version: '0.4'
26
26
  - !ruby/object:Gem::Dependency
27
27
  name: zeitwerk
28
28
  requirement: !ruby/object:Gem::Requirement
@@ -38,21 +38,21 @@ dependencies:
38
38
  - !ruby/object:Gem::Version
39
39
  version: '0'
40
40
  - !ruby/object:Gem::Dependency
41
- name: capybara
41
+ name: minitest
42
42
  requirement: !ruby/object:Gem::Requirement
43
43
  requirements:
44
- - - ">="
44
+ - - "~>"
45
45
  - !ruby/object:Gem::Version
46
- version: '0'
46
+ version: '6.0'
47
47
  type: :development
48
48
  prerelease: false
49
49
  version_requirements: !ruby/object:Gem::Requirement
50
50
  requirements:
51
- - - ">="
51
+ - - "~>"
52
52
  - !ruby/object:Gem::Version
53
- version: '0'
53
+ version: '6.0'
54
54
  - !ruby/object:Gem::Dependency
55
- name: cuprite
55
+ name: minitest-reporters
56
56
  requirement: !ruby/object:Gem::Requirement
57
57
  requirements:
58
58
  - - ">="
@@ -66,21 +66,7 @@ dependencies:
66
66
  - !ruby/object:Gem::Version
67
67
  version: '0'
68
68
  - !ruby/object:Gem::Dependency
69
- name: minitest
70
- requirement: !ruby/object:Gem::Requirement
71
- requirements:
72
- - - "~>"
73
- - !ruby/object:Gem::Version
74
- version: '5.0'
75
- type: :development
76
- prerelease: false
77
- version_requirements: !ruby/object:Gem::Requirement
78
- requirements:
79
- - - "~>"
80
- - !ruby/object:Gem::Version
81
- version: '5.0'
82
- - !ruby/object:Gem::Dependency
83
- name: minitest-reporters
69
+ name: rbs
84
70
  requirement: !ruby/object:Gem::Requirement
85
71
  requirements:
86
72
  - - ">="
@@ -149,35 +135,7 @@ dependencies:
149
135
  - - "~>"
150
136
  - !ruby/object:Gem::Version
151
137
  version: '0.6'
152
- - !ruby/object:Gem::Dependency
153
- name: simplecov
154
- requirement: !ruby/object:Gem::Requirement
155
- requirements:
156
- - - ">="
157
- - !ruby/object:Gem::Version
158
- version: '0'
159
- type: :development
160
- prerelease: false
161
- version_requirements: !ruby/object:Gem::Requirement
162
- requirements:
163
- - - ">="
164
- - !ruby/object:Gem::Version
165
- version: '0'
166
- - !ruby/object:Gem::Dependency
167
- name: steep
168
- requirement: !ruby/object:Gem::Requirement
169
- requirements:
170
- - - ">="
171
- - !ruby/object:Gem::Version
172
- version: '0'
173
- type: :development
174
- prerelease: false
175
- version_requirements: !ruby/object:Gem::Requirement
176
- requirements:
177
- - - ">="
178
- - !ruby/object:Gem::Version
179
- version: '0'
180
- description: Generate Diagrams and Flowcharts with Mermaid
138
+ description: Mermaid text for the diagrams of the diagram gem
181
139
  email:
182
140
  - terminale@gmail.com
183
141
  executables: []
@@ -189,40 +147,19 @@ files:
189
147
  - README.md
190
148
  - Rakefile
191
149
  - lib/mermaid.rb
192
- - lib/mermaid/class_diagram_renderer.rb
193
- - lib/mermaid/element_renderers/edge_renderer.rb
194
- - lib/mermaid/element_renderers/erd_entity_renderer.rb
195
- - lib/mermaid/element_renderers/erd_relationship_renderer.rb
196
- - lib/mermaid/element_renderers/node_renderer.rb
197
- - lib/mermaid/element_renderers/relationship_renderer.rb
198
- - lib/mermaid/element_renderers/slice_renderer.rb
199
- - lib/mermaid/element_renderers/state_renderer.rb
200
- - lib/mermaid/element_renderers/task_renderer.rb
201
- - lib/mermaid/element_renderers/transition_renderer.rb
202
- - lib/mermaid/er_diagram_renderer.rb
203
- - lib/mermaid/flowchart_diagram_renderer.rb
204
- - lib/mermaid/gantt_diagram_renderer.rb
205
- - lib/mermaid/gitgraph_diagram_renderer.rb
206
- - lib/mermaid/pie_diagram_renderer.rb
207
- - lib/mermaid/state_diagram_renderer.rb
208
- - lib/mermaid/timeline_diagram_renderer.rb
150
+ - lib/mermaid/inline_title.rb
151
+ - lib/mermaid/renderer.rb
152
+ - lib/mermaid/renderers/class_renderer.rb
153
+ - lib/mermaid/renderers/er_renderer.rb
154
+ - lib/mermaid/renderers/flowchart_renderer.rb
155
+ - lib/mermaid/renderers/gantt_renderer.rb
156
+ - lib/mermaid/renderers/gitgraph_renderer.rb
157
+ - lib/mermaid/renderers/pie_renderer.rb
158
+ - lib/mermaid/renderers/state_renderer.rb
159
+ - lib/mermaid/renderers/timeline_renderer.rb
160
+ - lib/mermaid/to_mermaid.rb
209
161
  - lib/mermaid/version.rb
210
- - sig/diagrams/base.rbs
211
- - sig/diagrams/class_diagram.rbs
212
- - sig/diagrams/elements/edge.rbs
213
- - sig/diagrams/elements/erd_entity.rbs
214
- - sig/diagrams/elements/erd_relationship.rbs
215
- - sig/diagrams/elements/node.rbs
216
- - sig/diagrams/elements/relationship.rbs
217
- - sig/diagrams/elements/slice.rbs
218
- - sig/diagrams/elements/state.rbs
219
- - sig/diagrams/elements/task.rbs
220
- - sig/diagrams/elements/transition.rbs
221
- - sig/diagrams/er_diagram.rbs
222
- - sig/diagrams/flowchart_diagram.rbs
223
- - sig/diagrams/gantt_diagram.rbs
224
- - sig/diagrams/pie_diagram.rbs
225
- - sig/diagrams/state_diagram.rbs
162
+ - sig/mermaid.rbs
226
163
  homepage: https://github.com/seuros/mermaid-ruby
227
164
  licenses:
228
165
  - MIT
@@ -238,14 +175,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
238
175
  requirements:
239
176
  - - ">="
240
177
  - !ruby/object:Gem::Version
241
- version: 3.3.0
178
+ version: '4.0'
242
179
  required_rubygems_version: !ruby/object:Gem::Requirement
243
180
  requirements:
244
181
  - - ">="
245
182
  - !ruby/object:Gem::Version
246
183
  version: '0'
247
184
  requirements: []
248
- rubygems_version: 3.6.9
185
+ rubygems_version: 4.0.20
249
186
  specification_version: 4
250
- summary: Generate Diagrams and Flowcharts with Mermaid
187
+ summary: Mermaid text for the diagrams of the diagram gem
251
188
  test_files: []
@@ -1,45 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Mermaid
4
- # Module containing Mermaid rendering logic for Diagrams::ClassDiagram
5
- module ClassDiagramRenderer
6
- # @!method to_mermaid
7
- # Generates the Mermaid syntax for the class diagram.
8
- # @return [String] The Mermaid syntax string.
9
- def to_mermaid
10
- mermaid_string = +"classDiagram\n"
11
-
12
- classes.each do |klass|
13
- fragment = format_class_entity(klass) # Call private helper method
14
- mermaid_string << fragment.to_s << "\n"
15
- end
16
-
17
- relationships.each do |rel|
18
- mermaid_string << rel.to_mermaid_fragment.to_s
19
- end
20
-
21
- mermaid_string.strip
22
- end
23
-
24
- private
25
-
26
- # Helper to format ClassEntity for Mermaid
27
- def format_class_entity(klass)
28
- diagram = "class #{klass.name}"
29
- attributes_list = klass[:attributes] || []
30
- methods_list = klass[:methods] || []
31
- has_members = attributes_list.any? || methods_list.any?
32
- diagram += " {\n" if has_members
33
-
34
- attributes_list.each do |attr_str|
35
- diagram += " #{attr_str}\n"
36
- end
37
- methods_list.each do |method_str|
38
- diagram += " #{method_str}\n"
39
- end
40
-
41
- diagram += "}\n" if has_members
42
- diagram
43
- end
44
- end
45
- end
@@ -1,19 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Mermaid
4
- module ElementRenderers
5
- # Module containing Mermaid rendering logic for Diagrams::ElementRenderers::Edge
6
- module EdgeRenderer
7
- # @!method to_mermaid_fragment
8
- # Generates the Mermaid fragment for a flowchart edge.
9
- # @return [String] Mermaid syntax fragment.
10
- def to_mermaid_fragment
11
- if label && !label.empty?
12
- "#{source_id} -- \"#{label}\" --> #{target_id}"
13
- else
14
- "#{source_id} --> #{target_id}"
15
- end
16
- end
17
- end
18
- end
19
- end
@@ -1,23 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Mermaid
4
- module ElementRenderers
5
- # Module containing Mermaid rendering logic for Diagrams::ElementRenderers::ERDEntity
6
- module ERDEntityRenderer
7
- # Generates the Mermaid fragment for this entity.
8
- # @return [String] The Mermaid syntax fragment for the entity.
9
- def to_mermaid_fragment
10
- fragment = "\"#{name}\" {\n"
11
- entity_attributes.each do |attr|
12
- fragment << " #{attr.type} #{attr.name}"
13
- # Join keys like PK, FK with spaces if present
14
- fragment << " #{attr.keys.join(' ')}" unless attr.keys.empty?
15
- fragment << " \"#{attr.comment}\"" if attr.comment && !attr.comment.empty?
16
- fragment << "\n"
17
- end
18
- fragment << "}\n"
19
- fragment
20
- end
21
- end
22
- end
23
- end
@@ -1,44 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Mermaid
4
- module ElementRenderers
5
- # Module containing Mermaid rendering logic for Diagrams::ElementRenderers::ERDRelationship
6
- module ERDRelationshipRenderer
7
- # Maps cardinality symbols from Diagrams::ElementRenderers::ERDRelationship::CARDINALITY
8
- # to Mermaid syntax (using right-side convention).
9
- CARDINALITY_MAP = {
10
- ZERO_OR_ONE: 'o|',
11
- ONE_ONLY: '||',
12
- ZERO_OR_MORE: 'o{', # Corrected based on Mermaid docs
13
- ONE_OR_MORE: '|{' # Corrected based on Mermaid docs
14
- }.freeze
15
-
16
- # Generates the Mermaid fragment for this relationship.
17
- # @return [String] The Mermaid syntax fragment for the relationship.
18
- def to_mermaid_fragment
19
- # Fetch symbols, raise error if invalid key (shouldn't happen if Diagrams gem validates)
20
- left_symbol_raw = CARDINALITY_MAP.fetch(cardinality1)
21
- right_symbol = CARDINALITY_MAP.fetch(cardinality2)
22
-
23
- # Generate the left symbol by mirroring the right-side convention
24
- left_symbol = case left_symbol_raw
25
- when 'o{' then '}o' # Mirror zero or more
26
- when '|{' then '}|' # Mirror one or more
27
- else left_symbol_raw.reverse # Simple reverse for |o and ||
28
- end
29
-
30
- # Always use '--' based on user feedback for compatibility
31
- id_symbol = '--'
32
-
33
- fragment = "\"#{entity1}\" "
34
- fragment << left_symbol # e.g., |o
35
- fragment << id_symbol # e.g., --
36
- fragment << right_symbol # e.g., }|
37
- fragment << " \"#{entity2}\""
38
- fragment << " : \"#{label}\"" if label && !label.strip.empty?
39
- fragment << "\n"
40
- fragment
41
- end
42
- end
43
- end
44
- end
@@ -1,16 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Mermaid
4
- module ElementRenderers
5
- # Module containing Mermaid rendering logic for Diagrams::ElementRenderers::Node
6
- module NodeRenderer
7
- # @!method to_mermaid_fragment
8
- # Generates the Mermaid fragment for a flowchart node.
9
- # @return [String] Mermaid syntax fragment.
10
- def to_mermaid_fragment
11
- escaped_label = label.gsub('"', '#quot;')
12
- "#{id}[\"#{escaped_label}\"]"
13
- end
14
- end
15
- end
16
- end
@@ -1,24 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Mermaid
4
- module ElementRenderers
5
- # Module containing Mermaid rendering logic for Diagrams::ElementRenderers::Relationship
6
- module RelationshipRenderer
7
- # Maps relationship type strings to Mermaid symbols
8
- MERMAID_RELATIONSHIP_MAP = {
9
- 'inheritance' => '<|--', 'composition' => '*--', 'aggregation' => 'o--',
10
- 'association' => '-->', 'dependency' => '..>', 'realization' => '<|..',
11
- 'link' => '--'
12
- }.freeze
13
-
14
- # @!method to_mermaid_fragment
15
- # Generates the Mermaid fragment for a relationship.
16
- # @return [String] Mermaid syntax fragment.
17
- def to_mermaid_fragment
18
- arrow = MERMAID_RELATIONSHIP_MAP[type] || '--'
19
- label_str = label ? " : #{label}" : ''
20
- "#{source_class_name} #{arrow} #{target_class_name}#{label_str}\n"
21
- end
22
- end
23
- end
24
- end
@@ -1,16 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Mermaid
4
- module ElementRenderers
5
- # Module containing Mermaid rendering logic for Diagrams::ElementRenderers::Slice
6
- module SliceRenderer
7
- # @!method to_mermaid_fragment
8
- # Generates the Mermaid fragment for a pie chart slice.
9
- # @return [String] Mermaid syntax fragment.
10
- def to_mermaid_fragment
11
- formatted_value = value.to_i == value ? value.to_i : value
12
- "\"#{label}\" : #{formatted_value}"
13
- end
14
- end
15
- end
16
- end
@@ -1,15 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Mermaid
4
- module ElementRenderers
5
- # Module containing Mermaid rendering logic for Diagrams::ElementRenderers::State
6
- module StateRenderer
7
- # @!method to_mermaid_fragment
8
- # Generates the Mermaid fragment for a state definition.
9
- # @return [String] Mermaid syntax fragment.
10
- def to_mermaid_fragment
11
- label ? "#{id} : #{label}" : id
12
- end
13
- end
14
- end
15
- end