rails-mermaid_erd_markdown 0.2.0 → 0.3.0

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.0
 platform: ruby
 authors:
 - humzahkiani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -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:

data/test/dummy-rails/.dockerignore

@@ -1,37 +0,0 @@
-# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files.
-
-# Ignore git directory.
-/.git/
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore all environment files (except templates).
-/.env*
-!/.env*.erb
-
-# Ignore all default key files.
-/config/master.key
-/config/credentials/*.key
-
-# Ignore all logfiles and tempfiles.
-/log/*
-/tmp/*
-!/log/.keep
-!/tmp/.keep
-
-# Ignore pidfiles, but keep the directory.
-/tmp/pids/*
-!/tmp/pids/.keep
-
-# Ignore storage (uploaded files in development and any SQLite databases).
-/storage/*
-!/storage/.keep
-/tmp/storage/*
-!/tmp/storage/.keep
-
-# Ignore assets.
-/node_modules/
-/app/assets/builds/*
-!/app/assets/builds/.keep
-/public/assets

data/test/dummy-rails/.ruby-version

@@ -1 +0,0 @@
-ruby-3.1.0

data/test/dummy-rails/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require_relative "config/application"
-
-Rails.application.load_tasks

data/test/dummy-rails/app/assets/config/manifest.js

@@ -1,4 +0,0 @@
-//= link_tree ../images
-//= link_directory ../stylesheets .css
-//= link_tree ../../javascript .js
-//= link_tree ../../../vendor/javascript .js

data/test/dummy-rails/app/assets/stylesheets/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS (and SCSS, if configured) file within this directory, lib/assets/stylesheets, or any plugin's
- * vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/test/dummy-rails/app/channels/application_cable/channel.rb

@@ -1,4 +0,0 @@
-module ApplicationCable
-  class Channel < ActionCable::Channel::Base
-  end
-end

data/test/dummy-rails/app/channels/application_cable/connection.rb

@@ -1,4 +0,0 @@
-module ApplicationCable
-  class Connection < ActionCable::Connection::Base
-  end
-end

data/test/dummy-rails/app/controllers/application_controller.rb

@@ -1,2 +0,0 @@
-class ApplicationController < ActionController::Base
-end

data/test/dummy-rails/app/helpers/application_helper.rb

@@ -1,2 +0,0 @@
-module ApplicationHelper
-end

data/test/dummy-rails/app/javascript/application.js

@@ -1,3 +0,0 @@
-// Configure your import map in config/importmap.rb. Read more: https://github.com/rails/importmap-rails
-import "@hotwired/turbo-rails"
-import "controllers"

data/test/dummy-rails/app/javascript/controllers/application.js

@@ -1,9 +0,0 @@
-import { Application } from "@hotwired/stimulus"
-
-const application = Application.start()
-
-// Configure Stimulus development experience
-application.debug = false
-window.Stimulus   = application
-
-export { application }

data/test/dummy-rails/app/javascript/controllers/hello_controller.js

@@ -1,7 +0,0 @@
-import { Controller } from "@hotwired/stimulus"
-
-export default class extends Controller {
-  connect() {
-    this.element.textContent = "Hello World!"
-  }
-}

data/test/dummy-rails/app/javascript/controllers/index.js

@@ -1,11 +0,0 @@
-// Import and register all your controllers from the importmap under controllers/*
-
-import { application } from "controllers/application"
-
-// Eager load all controllers defined in the import map under controllers/**/*_controller
-import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
-eagerLoadControllersFrom("controllers", application)
-
-// Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!)
-// import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading"
-// lazyLoadControllersFrom("controllers", application)

data/test/dummy-rails/app/jobs/application_job.rb

@@ -1,7 +0,0 @@
-class ApplicationJob < ActiveJob::Base
-  # Automatically retry jobs that encountered a deadlock
-  # retry_on ActiveRecord::Deadlocked
-
-  # Most jobs are safe to ignore if the underlying records are no longer available
-  # discard_on ActiveJob::DeserializationError
-end

data/test/dummy-rails/app/mailers/application_mailer.rb

@@ -1,4 +0,0 @@
-class ApplicationMailer < ActionMailer::Base
-  default from: "from@example.com"
-  layout "mailer"
-end

data/test/dummy-rails/app/models/application_record.rb

@@ -1,3 +0,0 @@
-class ApplicationRecord < ActiveRecord::Base
-  primary_abstract_class
-end

data/test/dummy-rails/app/views/layouts/application.html.erb

@@ -1,16 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>DummyRails</title>
-    <meta name="viewport" content="width=device-width,initial-scale=1">
-    <%= csrf_meta_tags %>
-    <%= csp_meta_tag %>
-
-    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
-    <%= javascript_importmap_tags %>
-  </head>
-
-  <body>
-    <%= yield %>
-  </body>
-</html>

data/test/dummy-rails/app/views/layouts/mailer.html.erb

@@ -1,13 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-    <style>
-      /* Email styles need to be inline */
-    </style>
-  </head>
-
-  <body>
-    <%= yield %>
-  </body>
-</html>

data/test/dummy-rails/app/views/layouts/mailer.text.erb

@@ -1 +0,0 @@
-<%= yield %>