rails-mermaid_erd_markdown 0.2.0 → 0.3.1

data/rails-mermaid_erd_markdown.gemspec

@@ -8,7 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["humzahkiani"]
   spec.email = ["89326566+humzahkiani@users.noreply.github.com"]
 
-  spec.summary = "This is a rails gem that extends the rails-mermaid_erd gem to generate a mermaid ERD for Rails Models in markdown directly in source code."
+  spec.summary = "Extends the rails-mermaid_erd gem to generate mermaid ERDs in markdown " \
+                 "for Ruby on Rails ActiveRecord Models"
   spec.homepage = "https://github.com/humzahkiani/rails-mermaid_erd_markdown"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -16,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/humzahkiani/rails-mermaid_erd_markdown"
   spec.metadata["changelog_uri"] = "https://github.com/humzahkiani/rails-mermaid_erd_markdown/blob/main/CHANGELOG.md"
-
+  spec.metadata["github_repo"] = "ssh://github.com/humzahkiani/rails-mermaid_erd_markdown"
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
@@ -26,10 +27,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
+  # Runtime Dependencies
   spec.add_dependency "rails", ">= 5.2"
-  spec.add_dependency "rails-mermaid_erd", "~> 0.4.2"
+  spec.add_dependency "rails-mermaid_erd", ">= 0.4.2"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/test/example_output/mock_ERD.md

@@ -0,0 +1,48 @@
+```mermaid
+erDiagram
+    %% --------------------------------------------------------
+    %% Entity-Relationship Diagram
+    %% --------------------------------------------------------
+
+    %% table name: users
+    User{
+        integer id PK
+        string name
+        string email
+        datetime created_at
+        datetime updated_at
+    }
+
+    %% table name: profiles
+    Profile{
+        integer id PK
+        text bio
+        integer user_id FK
+        datetime created_at
+        datetime updated_at
+    }
+
+    %% table name: articles
+    Article{
+        integer id PK
+        string title
+        text content
+        integer user_id FK
+        datetime created_at
+        datetime updated_at
+    }
+
+    %% table name: comments
+    Comment{
+        integer id PK
+        string commenter
+        text body
+        integer article_id FK
+        datetime created_at
+        datetime updated_at
+    }
+
+    Article }o--|| User : "BT:user"
+    Profile }o--|| User : "BT:user"
+    Comment }o--|| Article : "BT:article"
+```

data/test/example_output/mock_ERD_index.md

@@ -0,0 +1,10 @@
+# Entity Relationship Diagrams
+
+Each model has its own ERD diagram. The diagram shows the selected model, plus 1 associated model(s) deep. Click on the model name to view the diagram.
+
+## Models
+
+- [User](../User.md)
+- [Profile](../Profile.md)
+- [Article](../Article.md)
+- [Comment](../Comment.md)

data/test/example_output/mock_ERD_model.md

@@ -0,0 +1,46 @@
+# User Entity-Relationship Diagram
+
+## Associated Models
+
+- [Article](../app/models/ERD_Article.md)
+- [Profile](../app/models/ERD_Profile.md)
+
+## Entity-Relationship Diagram
+
+```mermaid
+erDiagram
+    %% --------------------------------------------------------
+    %% Entity-Relationship Diagram
+    %% --------------------------------------------------------
+
+    %% table name: users
+    User{
+        integer id PK
+        string name
+        string email
+        datetime created_at
+        datetime updated_at
+    }
+
+    %% table name: articles
+    Article{
+        integer id PK
+        string title
+        text content
+        integer user_id FK
+        datetime created_at
+        datetime updated_at
+    }
+
+    %% table name: profiles
+    Profile{
+        integer id PK
+        text bio
+        integer user_id FK
+        datetime created_at
+        datetime updated_at
+    }
+
+    Article }o--|| User : "BT:user"
+    Profile }o--|| User : "BT:user"
+```

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

@@ -3,6 +3,8 @@
 $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"
-require File.expand_path("./dummy-rails/config/environment", __dir__)
+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

@@ -1,49 +1,9 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require "rails-mermaid_erd"
 
 class MermaidErdMarkdownTest < Minitest::Test
   def test_that_it_has_a_version_number
     refute_nil MermaidErdMarkdown::VERSION
   end
-
-  def setup
-    markdown_file_path = File.expand_path("../../test/util/mock_ERD.md", __dir__)
-    mock_erd = File.read(markdown_file_path)
-    @mock_erd = mock_erd
-  end
-
-  def test_generate_mermaid_erd
-    stubbed_model_data = {
-      Models: [
-        { 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: "created_at", type: :datetime, key: "", comment: nil },
-            { name: "updated_at", type: :datetime, key: "", comment: nil }
-          ] },
-        { 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 }
-          ] }
-      ], Relations: [
-        { LeftModelName: "Comment", LeftValue: "}o", Line: "--", RightModelName: "Article",
-          RightValue: "||", Comment: "BT:article" }
-      ]
-    }
-    result = nil
-
-    RailsMermaidErd::Builder.stub :model_data, stubbed_model_data do
-      result = MermaidErdMarkdown.generate_mermaid_erd
-    end
-    assert_equal @mock_erd, result
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-mermaid_erd_markdown
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - humzahkiani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,14 +28,14 @@ dependencies:
   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:
@@ -45,8 +45,12 @@ 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
@@ -55,76 +59,26 @@ files:
 - 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/dummy-rails/.dockerignore
-- test/dummy-rails/.ruby-version
-- test/dummy-rails/Rakefile
-- test/dummy-rails/app/assets/config/manifest.js
-- test/dummy-rails/app/assets/images/.keep
-- test/dummy-rails/app/assets/stylesheets/application.css
-- test/dummy-rails/app/channels/application_cable/channel.rb
-- test/dummy-rails/app/channels/application_cable/connection.rb
-- test/dummy-rails/app/controllers/application_controller.rb
-- test/dummy-rails/app/controllers/concerns/.keep
-- test/dummy-rails/app/helpers/application_helper.rb
-- test/dummy-rails/app/javascript/application.js
-- test/dummy-rails/app/javascript/controllers/application.js
-- test/dummy-rails/app/javascript/controllers/hello_controller.js
-- test/dummy-rails/app/javascript/controllers/index.js
-- test/dummy-rails/app/jobs/application_job.rb
-- test/dummy-rails/app/mailers/application_mailer.rb
-- test/dummy-rails/app/models/application_record.rb
-- test/dummy-rails/app/models/concerns/.keep
-- test/dummy-rails/app/views/layouts/application.html.erb
-- test/dummy-rails/app/views/layouts/mailer.html.erb
-- test/dummy-rails/app/views/layouts/mailer.text.erb
-- test/dummy-rails/bin/bundle
-- test/dummy-rails/bin/docker-entrypoint
-- test/dummy-rails/bin/importmap
-- test/dummy-rails/bin/rails
-- test/dummy-rails/bin/rake
-- test/dummy-rails/bin/setup
-- test/dummy-rails/config.ru
-- test/dummy-rails/config/application.rb
-- test/dummy-rails/config/boot.rb
-- test/dummy-rails/config/cable.yml
-- test/dummy-rails/config/credentials.yml.enc
-- test/dummy-rails/config/database.yml
-- test/dummy-rails/config/environment.rb
-- test/dummy-rails/config/environments/development.rb
-- test/dummy-rails/config/environments/production.rb
-- test/dummy-rails/config/environments/test.rb
-- test/dummy-rails/config/importmap.rb
-- test/dummy-rails/config/initializers/content_security_policy.rb
-- test/dummy-rails/config/initializers/filter_parameter_logging.rb
-- test/dummy-rails/config/initializers/inflections.rb
-- test/dummy-rails/config/initializers/permissions_policy.rb
-- test/dummy-rails/config/locales/en.yml
-- test/dummy-rails/config/puma.rb
-- test/dummy-rails/config/routes.rb
-- test/dummy-rails/config/storage.yml
-- test/dummy-rails/db/seeds.rb
-- test/dummy-rails/test/application_system_test_case.rb
-- test/dummy-rails/test/channels/application_cable/connection_test.rb
-- test/dummy-rails/test/controllers/.keep
-- test/dummy-rails/test/fixtures/files/.keep
-- test/dummy-rails/test/helpers/.keep
-- test/dummy-rails/test/integration/.keep
-- test/dummy-rails/test/mailers/.keep
-- test/dummy-rails/test/models/.keep
-- test/dummy-rails/test/system/.keep
-- test/dummy-rails/test/test_helper.rb
-- test/dummy-rails/vendor/.keep
-- test/dummy-rails/vendor/javascript/.keep
+- 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
-- test/util/mock_ERD.md
 homepage: https://github.com/humzahkiani/rails-mermaid_erd_markdown
 licenses:
 - MIT
@@ -132,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:
@@ -150,6 +106,6 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: This is a rails gem that extends the rails-mermaid_erd gem to generate a
-  mermaid ERD for Rails Models in markdown directly in source code.
+summary: Extends the rails-mermaid_erd gem to generate mermaid ERDs in markdown for
+  Ruby on Rails ActiveRecord Models
 test_files: []