rails-mermaid_erd_markdown 0.1.0 → 0.3.0

data/test/mock_data/models.rb

@@ -0,0 +1,105 @@
+module MockData
+  module Models
+    def user_model
+      {
+        TableName: "users", ModelName: "User", IsModelExist: true,
+        Columns: [
+          { name: "id", type: :integer, key: "PK", comment: nil },
+          { name: "name", type: :string, key: "", comment: nil },
+          { name: "email", type: :string, key: "", comment: nil },
+          { name: "created_at", type: :datetime, key: "", comment: nil },
+          { name: "updated_at", type: :datetime, key: "", comment: nil }
+        ]
+      }
+    end
+
+    def profile_model
+      {
+        TableName: "profiles", ModelName: "Profile", IsModelExist: true,
+        Columns: [
+          { name: "id", type: :integer, key: "PK", comment: nil },
+          { name: "bio", type: :text, key: "", comment: nil },
+          { name: "user_id", type: :integer, key: "FK", comment: nil },
+          { name: "created_at", type: :datetime, key: "", comment: nil },
+          { name: "updated_at", type: :datetime, key: "", comment: nil }
+        ]
+      }
+    end
+
+    def article_model
+      {
+        TableName: "articles", ModelName: "Article", IsModelExist: true,
+        Columns: [
+          { name: "id", type: :integer, key: "PK", comment: nil },
+          { name: "title", type: :string, key: "", comment: nil },
+          { name: "content", type: :text, key: "", comment: nil },
+          { name: "user_id", type: :integer, key: "FK", comment: nil },
+          { name: "created_at", type: :datetime, key: "", comment: nil },
+          { name: "updated_at", type: :datetime, key: "", comment: nil }
+        ]
+      }
+    end
+
+    def comment_model
+      {
+        TableName: "comments", ModelName: "Comment", IsModelExist: true,
+        Columns: [
+          { name: "id", type: :integer, key: "PK", comment: nil },
+          { name: "commenter", type: :string, key: "", comment: nil },
+          { name: "body", type: :text, key: "", comment: nil },
+          { name: "article_id", type: :integer, key: "FK", comment: nil },
+          { name: "created_at", type: :datetime, key: "", comment: nil },
+          { name: "updated_at", type: :datetime, key: "", comment: nil }
+        ]
+      }
+    end
+
+    def article_relation
+      {
+        LeftModelName: "Article",
+        LeftValue: "}o",
+        Line: "--",
+        RightModelName: "User",
+        RightValue: "||",
+        Comment: "BT:user"
+      }
+    end
+
+    def profile_relation
+      {
+        LeftModelName: "Profile",
+        LeftValue: "}o",
+        Line: "--",
+        RightModelName: "User",
+        RightValue: "||",
+        Comment: "BT:user"
+      }
+    end
+
+    def comment_relation
+      {
+        LeftModelName: "Comment",
+        LeftValue: "}o",
+        Line: "--",
+        RightModelName: "Article",
+        RightValue: "||",
+        Comment: "BT:article"
+      }
+    end
+
+    def stubbed_model_data
+      {
+        Models: [
+          user_model,
+          profile_model,
+          article_model,
+          comment_model
+        ], Relations: [
+          article_relation,
+          profile_relation,
+          comment_relation
+        ]
+      }
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "rails-mermaid_erd_markdown"
+require "rails-mermaid_erd_markdown/configuration"
+require "rails-mermaid_erd_markdown/generator"
+require "rails-mermaid_erd_markdown/markdown_document"
+require "rails-mermaid_erd_markdown/source_data"
+
+require "minitest/autorun"

data/test/test_rails/rails-mermaid_erd_markdown/test_generator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "../../mock_data/models"
+require "test_helper"
+
+class MermaidErdMarkdown::GeneratorTest < Minitest::Test
+  include MockData::Models
+
+  def test_index_markdown
+    markdown_file_path = File.expand_path(
+      "../../example_output/mock_ERD_index.md", __dir__
+    )
+    mock_markdown = File.read(markdown_file_path)
+
+    files = {
+      "User" => "User.md",
+      "Profile" => "Profile.md",
+      "Article" => "Article.md",
+      "Comment" => "Comment.md"
+    }
+
+    result = MermaidErdMarkdown::Generator.new.index_markdown(files)
+
+    assert_equal mock_markdown, result
+  end
+
+  def test_model_markdown
+    markdown_file_path = File.expand_path(
+      "../../example_output/mock_ERD_model.md", __dir__
+    )
+    mock_markdown = File.read(markdown_file_path)
+
+    source = {
+      Models: [user_model, article_model, profile_model],
+      Relations: [article_relation, profile_relation]
+    }
+
+    result = MermaidErdMarkdown::Generator.new.model_markdown(source)
+
+    assert_equal mock_markdown, result
+  end
+
+  def test_mermaid_markdown
+    markdown_file_path =
+      File.expand_path("../../example_output/mock_ERD.md", __dir__)
+    mock_markdown = File.read(markdown_file_path)
+
+    result = MermaidErdMarkdown::Generator.new.mermaid_markdown(
+      stubbed_model_data
+    )
+
+    assert_equal mock_markdown, result
+  end
+end

data/test/test_rails/rails-mermaid_erd_markdown/test_markdown_document.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class MermaidErdMarkdown::MarkdownDocumentTest < Minitest::Test
+  def test_generate
+    markdown = MermaidErdMarkdown::MarkdownDocument.create do
+      add(header("Header"))
+      add(subheader("Subheader"))
+      add(list_item("List item"))
+      add(link("Link", "https://example.com"))
+      add("")
+    end
+
+    assert_equal <<~MARKDOWN, markdown
+      # Header
+
+      ## Subheader
+
+      - List item
+      [Link](https://example.com)
+    MARKDOWN
+  end
+
+  def test_erd
+    model = {
+      TableName: "table",
+      ModelName: "Table",
+      IsModelExist: true,
+      Columns: [{
+        name: "name",
+        type: "type",
+        key: "key",
+        comment: "comment"
+      }]
+    }
+    relation = {
+      LeftModelName: "left_model",
+      LeftValue: "left_value",
+      Line: "--",
+      RightValue: "right_value",
+      RightModelName: "right_model",
+      Comment: "comment"
+    }
+
+    markdown = MermaidErdMarkdown::MarkdownDocument.create do
+      erd do
+        add(
+          erd_table(model[:TableName], model[:ModelName]) do
+            erd_table_column(model[:Columns].first)
+          end
+        )
+        add(
+          erd_relation(relation)
+        )
+      end
+      add("")
+    end
+
+    assert_equal <<~MARKDOWN, markdown
+      ```mermaid
+      erDiagram
+          %% --------------------------------------------------------
+          %% Entity-Relationship Diagram
+          %% --------------------------------------------------------
+
+          %% table name: table
+          Table{
+              type name key
+          }
+
+          left_model left_value--right_value right_model : "comment"
+      ```
+    MARKDOWN
+  end
+end

data/test/test_rails/rails-mermaid_erd_markdown/test_source_data.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "../../mock_data/models"
+require "test_helper"
+
+class MermaidErdMarkdown::SourceDataTest < Minitest::Test
+  include MockData::Models
+
+  def test_split_output
+    expected_user = {
+      Models: [user_model, article_model, profile_model],
+      Relations: [article_relation, profile_relation]
+    }
+    expected_profile = {
+      Models: [profile_model, user_model],
+      Relations: [profile_relation]
+    }
+    expected_article = {
+      Models: [article_model, user_model, comment_model],
+      Relations: [article_relation, comment_relation]
+    }
+    expected_comment = {
+      Models: [comment_model, article_model],
+      Relations: [comment_relation]
+    }
+    expected = [
+      expected_user,
+      expected_profile,
+      expected_article,
+      expected_comment
+    ]
+
+    RailsMermaidErd::Builder.stub :model_data, stubbed_model_data do
+      result = MermaidErdMarkdown::SourceData.new.split_output
+
+      assert_equal expected, result
+    end
+  end
+
+  def test_split_output_with_depth
+    expected_user = {
+      Models: [user_model, article_model, profile_model, comment_model],
+      Relations: [article_relation, profile_relation, comment_relation]
+    }
+    expected_profile = {
+      Models: [profile_model, user_model, article_model],
+      Relations: [profile_relation, article_relation]
+    }
+    expected_article = {
+      Models: [article_model, user_model, comment_model, profile_model],
+      Relations: [article_relation, comment_relation, profile_relation]
+    }
+    expected_comment = {
+      Models: [comment_model, article_model, user_model],
+      Relations: [comment_relation, article_relation]
+    }
+    expected = [
+      expected_user,
+      expected_profile,
+      expected_article,
+      expected_comment
+    ]
+
+    RailsMermaidErd::Builder.stub :model_data, stubbed_model_data do
+      result = MermaidErdMarkdown::SourceData.new.split_output(2)
+
+      assert_equal expected, result
+    end
+  end
+end

data/test/test_rails/test_rails-mermaid_erd_markdown.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class MermaidErdMarkdownTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil MermaidErdMarkdown::VERSION
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-mermaid_erd_markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - humzahkiani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-28 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rails-mermaid_erd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 description:
 email:
 - 89326566+humzahkiani@users.noreply.github.com
@@ -31,12 +45,40 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS.md"
+- ".github/workflows/CI.yml"
+- ".github/workflows/codeql.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/rubocop
+- bin/setup
 - docs/examples/erd.yml
 - lib/rails-mermaid_erd_markdown.rb
 - lib/rails-mermaid_erd_markdown/configuration.rb
+- lib/rails-mermaid_erd_markdown/generator.rb
+- lib/rails-mermaid_erd_markdown/markdown_document.rb
+- lib/rails-mermaid_erd_markdown/source_data.rb
 - lib/rails-mermaid_erd_markdown/version.rb
+- rails-mermaid_erd_markdown.gemspec
+- sig/rails/mermaid_erd_markdown.rbs
+- test/example_output/mock_ERD.md
+- test/example_output/mock_ERD_index.md
+- test/example_output/mock_ERD_model.md
+- test/mock_data/models.rb
+- test/test_helper.rb
+- test/test_rails/rails-mermaid_erd_markdown/test_generator.rb
+- test/test_rails/rails-mermaid_erd_markdown/test_markdown_document.rb
+- test/test_rails/rails-mermaid_erd_markdown/test_source_data.rb
+- test/test_rails/test_rails-mermaid_erd_markdown.rb
 homepage: https://github.com/humzahkiani/rails-mermaid_erd_markdown
 licenses:
 - MIT
@@ -44,6 +86,8 @@ metadata:
   homepage_uri: https://github.com/humzahkiani/rails-mermaid_erd_markdown
   source_code_uri: https://github.com/humzahkiani/rails-mermaid_erd_markdown
   changelog_uri: https://github.com/humzahkiani/rails-mermaid_erd_markdown/blob/main/CHANGELOG.md
+  github_repo: ssh://github.com/humzahkiani/rails-mermaid_erd_markdown
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: