mermaid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1adee7a6d24996d2cfe5bdc3e2bf812fd8491d3a15dd900cc32632363beb6ac
+  data.tar.gz: a5d9f2ee2722d208202031ab780c9586691a7feec371b500ab60cf899fb34d22
+SHA512:
+  metadata.gz: 450ccbce6c9bde4f918fca49c09761950d7f0b6b0f057bee6010a99a85ed43e8e585d6934d1db131b735c6e1c408d75960edab7a961011bf2a4bf19f47ebf2c0
+  data.tar.gz: 2c27efa7b199251b37b8d5d9ce52df250922dcb9124ed1a715b1b25a5c5d4da3ef044c48447a1668074f1c370b0e4aafe1a5a97616f4f64d159130cd04298114

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-01-23
+
+- Draft release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Abdelkader Boudih
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Mermaid
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mermaid`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mermaid.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/mermaid/base_diagram.rb

@@ -0,0 +1,13 @@
+# 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

@@ -0,0 +1,9 @@
+# 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

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,9 @@
+# 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

@@ -0,0 +1,46 @@
+# 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

@@ -0,0 +1,36 @@
+# 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

data/lib/mermaid/flowchart_diagram/parser.rb

@@ -0,0 +1,30 @@
+module Mermaid
+  module FlowchartDiagram::Parser
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def parse(input)
+        lines = input.split("\n")
+        _, direction = lines.shift.split
+        nodes = []
+        links = []
+        lines.each do |line|
+          if line =~ /^(\S+)(?:\[(.*)\]|\((.*)\)|\{(.*)\})/
+            id = $1
+            label = $2 || $3 || $4
+            shape = $2 ? 'box' : $3 ? 'round' : 'decision'
+            nodes << Node.new(id: id, label: label, shape: shape)
+          elsif line =~ /^(\S+)\s+-->(?:\|(.*)\|\s+)?(\S+)/
+            from = $1
+            label = $2
+            to = $3
+            links << Link.new(from: from, to: to, label: label)
+          end
+        end
+        new(id: 'parsed', direction: direction, nodes: nodes, links: links)
+      end
+    end
+  end
+end

data/lib/mermaid/flowchart_diagram.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Mermaid
+  class FlowchartDiagram < BaseDiagram
+    include Parser
+    NAME = 'flowchart'
+    Direction = Types::String.default('LR').enum('LR', 'RL', 'TB', 'BT')
+    attribute :id, Types::String
+    attribute :direction, Direction
+    attribute :nodes, Types::Array.of(Node)
+    attribute :links, Types::Array.of(Link)
+
+    def generate
+      diagram = "#{NAME} #{direction}\n"
+      labeled_nodes = Set.new
+      links.each do |link|
+        from_node = nodes.find { |node| node.id == link.from }
+        to_node = nodes.find { |node| node.id == link.to }
+        from_node_already_labeled = !labeled_nodes.include?(from_node)
+        to_node_already_labeled = !labeled_nodes.include?(to_node)
+        diagram += "  #{from_node.to_s(from_node_already_labeled)} -->#{link.label ? "|#{link.label}|" : ''} #{to_node.to_s(to_node_already_labeled)}\n"
+        labeled_nodes << from_node if from_node.label
+        labeled_nodes << to_node if to_node.label
+      end
+      diagram
+    end
+
+    def inspect
+      "#<#{self.class.name}: Nodes: #{nodes.size}, Links: #{links.size}>"
+    end
+  end
+end

data/lib/mermaid/gantt_diagram.rb

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

data/lib/mermaid/git_graph_diagram.rb

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

data/lib/mermaid/info_flow_diagram.rb

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

data/lib/mermaid/mindmap_diagram.rb

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

data/lib/mermaid/pie_diagram.rb

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

data/lib/mermaid/quadrant_diagram.rb

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

data/lib/mermaid/requirement_diagram.rb

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

data/lib/mermaid/sankey_diagram.rb

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

data/lib/mermaid/sequence_diagram.rb

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

data/lib/mermaid/state_diagram.rb

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

data/lib/mermaid/user_journey_diagram.rb

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

data/lib/mermaid/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Mermaid
+  VERSION = '0.0.1'
+end

data/lib/mermaid/xy_diagram.rb

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

data/lib/mermaid.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'mermaid/version'
+require 'zeitwerk'
+require 'dry-types'
+require 'dry-struct'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  'er_diagram' => 'ERDiagram',
+  'xy_diagram' => 'XYDiagram'
+)
+loader.setup
+
+module Mermaid
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: mermaid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Abdelkader Boudih
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Generate Diagrams and Flowcharts with Mermaid
+email:
+- terminale@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- 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/version.rb
+- lib/mermaid/xy_diagram.rb
+homepage: https://github.com/seuros/mermaid-ruby
+licenses:
+- MIT
+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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Generate Diagrams and Flowcharts with Mermaid
+test_files: []