feat: add ERD

Gemfile

@@ -73,6 +73,7 @@ group :development do
   gem 'ruby-lsp-rails'
   gem 'web-console'
   gem 'bullet'
+  gem 'rails-mermaid_erd'
 end
 
 group :test do

Gemfile.lock

@@ -334,6 +334,8 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
+    rails-mermaid_erd (0.5.0)
+      rails (>= 5.2)
     railties (7.2.1.1)
       actionpack (= 7.2.1.1)
       activesupport (= 7.2.1.1)
@@ -554,6 +556,7 @@ DEPENDENCIES
   puma (>= 5.0)
   pundit (~> 2.4)
   rails (~> 7.2.0)
+  rails-mermaid_erd
   redis (>= 4.0.1)
   rolify
   rspec-rails

Rakefile

@@ -18,3 +18,10 @@ desc 'Apply auto-corrections'
 task fix: %w[eslint:autocorrect stylelint:autocorrect rubocop:autocorrect_all] do
   puts '>>>>>> [OK] All fixes applied!'
 end
+
+# Trigger run mermaid_erd after db:migrate
+Rake::Task['db:migrate'].enhance do
+  puts 'Running mermaid_erd after db:migrate...'
+  system('bundle exec rails mermaid_erd')
+  puts '>>>>>> Generated mermaid_erd done!'
+end

app/controllers/docs_controller.rb

@@ -0,0 +1,5 @@
+class DocsController < ApplicationController
+  def erd
+    render file: Rails.root.join('docs/erd.html'), layout: false
+  end
+end

config/mermaid_erd.yml

@@ -0,0 +1 @@
+result_path: docs/erd.html

config/routes.rb

@@ -3,6 +3,8 @@
 Rails.application.routes.draw do
   if Rails.env.development?
     mount Lookbook::Engine, at: '/lookbook'
+    # ERD
+    get '/erd', to: 'docs#erd'
   end
 
   authenticate :user, lambda { |u| u.has_role?(:super_admin) } do