RubyGems - rails-realtime-erd - Versions diffs - 0.1.0 - Mend

rails-realtime-erd 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +21 -0
data/README.md +76 -0
data/Rakefile +9 -0
data/app/assets/stylesheets/rails_realtime_erd/erd.css +214 -0
data/app/controllers/rails_realtime_erd/application_controller.rb +5 -0
data/app/controllers/rails_realtime_erd/assets_controller.rb +23 -0
data/app/controllers/rails_realtime_erd/erd_controller.rb +18 -0
data/app/helpers/rails_realtime_erd/erd_helper.rb +25 -0
data/app/javascript/rails_realtime_erd/application.js +640 -0
data/app/javascript/rails_realtime_erd/vendor/mermaid.js +2029 -0
data/app/javascript/rails_realtime_erd/vendor/stimulus.js +2588 -0
data/app/views/layouts/rails_realtime_erd/application.html.erb +18 -0
data/app/views/rails_realtime_erd/erd/_main.html.erb +40 -0
data/app/views/rails_realtime_erd/erd/_sidebar.html.erb +106 -0
data/app/views/rails_realtime_erd/erd/show.html.erb +44 -0
data/config/routes.rb +4 -0
data/lib/rails-realtime-erd/builder.rb +167 -0
data/lib/rails-realtime-erd/configuration.rb +11 -0
data/lib/rails-realtime-erd/engine.rb +18 -0
data/lib/rails-realtime-erd/version.rb +3 -0
data/lib/rails-realtime-erd.rb +20 -0
metadata +138 -0

data/app/views/layouts/rails_realtime_erd/application.html.erb ADDED Viewed

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title><%= @app_name %> - Rails Realtime ERD</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <%= csrf_meta_tags %>
+  <%= inline_stylesheet "app/assets/stylesheets/rails_realtime_erd/erd.css" %>
+</head>
+<body>
+  <%= yield %>
+  <script src="<%= engine_asset_path("stimulus.js") %>"></script>
+  <script src="<%= engine_asset_path("mermaid.js") %>"></script>
+  <script src="<%= engine_asset_path("application.js") %>"></script>
+</body>
+</html>

data/app/views/rails_realtime_erd/erd/_main.html.erb ADDED Viewed

@@ -0,0 +1,40 @@
+<div class="space-x-2 inline-flex p-4">
+  <button type="button" data-tab-target="erdButton" data-action="click->tab#showErd" class="text-xs py-1 px-2 rounded hover:bg-white focus:ring-2 focus:ring-white focus:ring-offset-2 focus:ring-offset-gray-900 bg-white text-gray-900">ERD</button>
+  <button type="button" data-tab-target="codeButton" data-action="click->tab#showCode" class="text-xs py-1 px-2 rounded hover:bg-white focus:ring-2 focus:ring-white focus:ring-offset-2 focus:ring-offset-gray-900 bg-gray-400 text-gray-900">Code</button>
+</div>
+<div data-tab-target="erdPane" class="px-4 w-full min-h-[calc(100vh-56px-32px-56px)] relative overflow-hidden" data-zoom-pan-target="canvas">
+  <div data-zoom-pan-target="area">
+    <div id="rre-preview" data-diagram-target="preview"></div>
+  </div>
+  <div class="absolute bottom-0 left-1/2 -translate-x-1/2 p-4 pointer-events-none">
+    <div class="bg-gray-800 text-white text-[10px] px-3 py-1.5 rounded inline-flex items-center space-x-6">
+      <div class="inline-flex items-center">
+        <span class="font-medium">Movement:</span>
+        <span class="ml-1 text-white/60">Space + Mouse Drag / Middle Click + Drag</span>
+      </div>
+      <div class="inline-flex items-center">
+        <span class="font-medium">Zoom:</span>
+        <span class="ml-1 text-white/60">Mouse Wheel / Pinch In/Out</span>
+      </div>
+    </div>
+  </div>
+  <div class="absolute bottom-0 right-0 p-4 space-x-4 flex">
+    <div class="space-x-2 flex items-center">
+      <button type="button" data-action="click->zoom-pan#zoomIn" class="text-xs py-1 px-2 rounded hover:bg-white focus:ring-2 focus:ring-white focus:ring-offset-2 focus:ring-offset-gray-900 bg-gray-400 text-gray-900">+</button>
+      <button type="button" data-action="click->zoom-pan#zoomOut" class="text-xs py-1 px-2 rounded hover:bg-white focus:ring-2 focus:ring-white focus:ring-offset-2 focus:ring-offset-gray-900 bg-gray-400 text-gray-900">-</button>
+    </div>
+    <div class="flex items-center space-x-2">
+      <button type="button" data-action="click->zoom-pan#moveLeft" class="text-xs py-1 px-2 rounded hover:bg-white focus:ring-2 focus:ring-white focus:ring-offset-2 focus:ring-offset-gray-900 bg-gray-400 text-gray-900">&larr;</button>
+      <div class="flex flex-col space-y-8">
+        <button type="button" data-action="click->zoom-pan#moveUp" class="text-xs py-1 px-2 rounded hover:bg-white focus:ring-2 focus:ring-white focus:ring-offset-2 focus:ring-offset-gray-900 bg-gray-400 text-gray-900">&uarr;</button>
+        <button type="button" data-action="click->zoom-pan#moveDown" class="text-xs py-1 px-2 rounded hover:bg-white focus:ring-2 focus:ring-white focus:ring-offset-2 focus:ring-offset-gray-900 bg-gray-400 text-gray-900">&darr;</button>
+      </div>
+      <button type="button" data-action="click->zoom-pan#moveRight" class="text-xs py-1 px-2 rounded hover:bg-white focus:ring-2 focus:ring-white focus:ring-offset-2 focus:ring-offset-gray-900 bg-gray-400 text-gray-900">&rarr;</button>
+    </div>
+  </div>
+</div>
+<textarea data-tab-target="codePane" data-rre-hidden data-diagram-target="codeOutput" readonly class="px-4 bg-gray-900 text-gray-300 font-mono w-full text-xs min-h-[calc(100vh-56px-32px-56px)] border-0 focus:ring-0 block"></textarea>

data/app/views/rails_realtime_erd/erd/_sidebar.html.erb ADDED Viewed

@@ -0,0 +1,106 @@
+<div class="p-2">
+  <h2 class="font-medium text-gray-900 mb-1">Actions</h2>
+  <div class="space-y-2">
+    <button data-action="click->filter#reset" type="button" class="text-xs border border-gray-300 rounded py-1 w-full hover:bg-gray-100 flex justify-center items-center focus:ring focus:ring-red-600 focus:ring-offset-2">
+      <svg class="w-4 h-4 mr-2" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M9 15L3 9m0 0l6-6M3 9h12a6 6 0 010 12h-3"/></svg>
+      <span>Reset</span>
+    </button>
+    <button data-action="click->clipboard#copyUrl" data-clipboard-target="copyUrlButton" type="button" class="text-xs border border-gray-300 rounded py-1 w-full hover:bg-gray-100 flex justify-center items-center focus:ring focus:ring-red-600 focus:ring-offset-2">
+      <svg class="w-4 h-4 mr-2" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M9 12h3.75M9 15h3.75M9 18h3.75m3 .75H18a2.25 2.25 0 002.25-2.25V6.108c0-1.135-.845-2.098-1.976-2.192a48.424 48.424 0 00-1.123-.08m-5.801 0c-.065.21-.1.433-.1.664 0 .414.336.75.75.75h4.5a.75.75 0 00.75-.75 2.25 2.25 0 00-.1-.664m-5.8 0A2.251 2.251 0 0113.5 2.25H15c1.012 0 1.867.668 2.15 1.586m-5.8 0c-.376.023-.75.05-1.124.08C9.095 4.01 8.25 4.973 8.25 6.108V8.25m0 0H4.875c-.621 0-1.125.504-1.125 1.125v11.25c0 .621.504 1.125 1.125 1.125h9.75c.621 0 1.125-.504 1.125-1.125V9.375c0-.621-.504-1.125-1.125-1.125H8.25z"/></svg>
+      <span data-clipboard-target="copyUrlLabel">Copy Link for Sharing</span>
+    </button>
+    <button data-action="click->clipboard#copyMermaid" data-clipboard-target="copyMermaidButton" type="button" class="text-xs border border-gray-300 rounded py-1 w-full hover:bg-gray-100 flex justify-center items-center focus:ring focus:ring-red-600 focus:ring-offset-2">
+      <svg class="w-4 h-4 mr-2" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M9 12h3.75M9 15h3.75M9 18h3.75m3 .75H18a2.25 2.25 0 002.25-2.25V6.108c0-1.135-.845-2.098-1.976-2.192a48.424 48.424 0 00-1.123-.08m-5.801 0c-.065.21-.1.433-.1.664 0 .414.336.75.75.75h4.5a.75.75 0 00.75-.75 2.25 2.25 0 00-.1-.664m-5.8 0A2.251 2.251 0 0113.5 2.25H15c1.012 0 1.867.668 2.15 1.586m-5.8 0c-.376.023-.75.05-1.124.08C9.095 4.01 8.25 4.973 8.25 6.108V8.25m0 0H4.875c-.621 0-1.125.504-1.125 1.125v11.25c0 .621.504 1.125 1.125 1.125h9.75c.621 0 1.125-.504 1.125-1.125V9.375c0-.621-.504-1.125-1.125-1.125H8.25z"/></svg>
+      <span data-clipboard-target="copyMermaidLabel">Copy Mermaid Code</span>
+    </button>
+    <button data-action="click->clipboard#copyMarkdown" data-clipboard-target="copyMarkdownButton" type="button" class="text-xs border border-gray-300 rounded py-1 w-full hover:bg-gray-100 flex justify-center items-center focus:ring focus:ring-red-600 focus:ring-offset-2">
+      <svg class="w-4 h-4 mr-2" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M9 12h3.75M9 15h3.75M9 18h3.75m3 .75H18a2.25 2.25 0 002.25-2.25V6.108c0-1.135-.845-2.098-1.976-2.192a48.424 48.424 0 00-1.123-.08m-5.801 0c-.065.21-.1.433-.1.664 0 .414.336.75.75.75h4.5a.75.75 0 00.75-.75 2.25 2.25 0 00-.1-.664m-5.8 0A2.251 2.251 0 0113.5 2.25H15c1.012 0 1.867.668 2.15 1.586m-5.8 0c-.376.023-.75.05-1.124.08C9.095 4.01 8.25 4.973 8.25 6.108V8.25m0 0H4.875c-.621 0-1.125.504-1.125 1.125v11.25c0 .621.504 1.125 1.125 1.125h9.75c.621 0 1.125-.504 1.125-1.125V9.375c0-.621-.504-1.125-1.125-1.125H8.25z"/></svg>
+      <span data-clipboard-target="copyMarkdownLabel">Copy Markdown Code</span>
+    </button>
+    <button data-action="click->download#downloadSvg" type="button" class="text-xs border border-gray-300 rounded py-1 w-full hover:bg-gray-100 flex justify-center items-center focus:ring focus:ring-red-600 focus:ring-offset-2">
+      <svg class="w-4 h-4 mr-2" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M3 16.5v2.25A2.25 2.25 0 005.25 21h13.5A2.25 2.25 0 0021 18.75V16.5M16.5 12L12 16.5m0 0L7.5 12m4.5 4.5V3"/></svg>
+      <span>Download SVG File</span>
+    </button>
+    <button data-action="click->download#downloadPng" type="button" class="text-xs border border-gray-300 rounded py-1 w-full hover:bg-gray-100 flex justify-center items-center focus:ring focus:ring-red-600 focus:ring-offset-2">
+      <svg class="w-4 h-4 mr-2" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M3 16.5v2.25A2.25 2.25 0 005.25 21h13.5A2.25 2.25 0 0021 18.75V16.5M16.5 12L12 16.5m0 0L7.5 12m4.5 4.5V3"/></svg>
+      <span>Download PNG File</span>
+    </button>
+  </div>
+</div>
+<div class="p-2">
+  <h2 class="font-medium text-gray-900 mb-1">Options</h2>
+  <div class="space-y-1">
+    <label class="relative flex items-start cursor-pointer hover:bg-gray-100 rounded text-sm">
+      <input type="checkbox" class="h-4 w-4 rounded border-gray-300 text-red-600 mr-2 focus:ring-red-600" data-filter-target="previewRelations" data-action="change->filter#onOptionChange">
+      <span class="text-xs text-gray-900">Preview Relationships</span>
+    </label>
+    <label class="relative flex items-start cursor-pointer hover:bg-gray-100 rounded text-sm">
+      <input type="checkbox" class="h-4 w-4 rounded border-gray-300 text-red-600 mr-2 focus:ring-red-600" data-filter-target="showRelationComment" data-action="change->filter#onOptionChange">
+      <span class="text-xs text-gray-900">Show Relationship Comment</span>
+    </label>
+    <label class="relative flex items-start cursor-pointer hover:bg-gray-100 rounded text-sm">
+      <input type="checkbox" class="h-4 w-4 rounded border-gray-300 text-red-600 mr-2 focus:ring-red-600" data-filter-target="hideColumns" data-action="change->filter#onOptionChange">
+      <span class="text-xs text-gray-900">Hide Columns</span>
+    </label>
+    <label class="relative flex items-start hover:bg-gray-100 rounded text-sm" data-filter-target="showKeyLabel">
+      <input type="checkbox" class="h-4 w-4 rounded border-gray-300 text-red-600 mr-2 focus:ring-red-600" data-filter-target="showKey" data-action="change->filter#onOptionChange">
+      <span class="text-xs text-gray-900">Show Key</span>
+    </label>
+    <label class="relative flex items-start hover:bg-gray-100 rounded text-sm" data-filter-target="showCommentLabel">
+      <input type="checkbox" class="h-4 w-4 rounded border-gray-300 text-red-600 mr-2 focus:ring-red-600" data-filter-target="showComment" data-action="change->filter#onOptionChange">
+      <span class="text-xs text-gray-900">Show Column Comment</span>
+    </label>
+    <label class="relative flex items-start hover:bg-gray-100 rounded text-sm" data-filter-target="showOnlyKeysLabel">
+      <input type="checkbox" class="h-4 w-4 rounded border-gray-300 text-red-600 mr-2 focus:ring-red-600" data-filter-target="showOnlyKeys" data-action="change->filter#onOptionChange">
+      <span class="text-xs text-gray-900">Only Show Keys</span>
+    </label>
+  </div>
+</div>
+<div class="p-2">
+  <h2 class="font-medium text-gray-900 mb-1">Models</h2>
+  <div>
+    <input type="search" placeholder="Filter" data-filter-target="search" data-action="input->filter#onSearchChange" class="rounded text-xs w-full py-1 px-2 border border-gray-300 bg-gray-100 focus:border-red-600 focus:ring-red-600">
+  </div>
+  <div class="space-x-1 text-xs text-gray-900 my-1">
+    <span>Select</span>
+    <button type="button" data-action="click->filter#selectAll" class="text-red-600 font-bold hover:text-red-900 rounded focus:ring-2 focus:ring-red-600 focus:ring-offset-1">All</button>
+    <span>/</span>
+    <button type="button" data-action="click->filter#unselectAll" class="text-red-600 font-bold hover:text-red-900 rounded focus:ring-2 focus:ring-red-600 focus:ring-offset-1">None</button>
+  </div>
+  <div class="space-y-1" data-filter-target="modelList">
+    <% @schema[:Models].sort_by { |m| m[:ModelName] }.each do |model| %>
+      <label class="relative flex items-start cursor-pointer hover:bg-gray-100 rounded" data-filter-target="modelRow" data-model-name="<%= model[:ModelName] %>" data-table-name="<%= model[:TableName] %>">
+        <div class="min-w-0 flex-1 text-xs text-gray-900 inline-flex items-center">
+          <input
+            type="checkbox"
+            class="h-4 w-4 rounded border-gray-300 text-red-600 mr-2 focus:ring-red-600"
+            data-filter-target="modelCheckbox"
+            data-action="change->filter#onModelToggle"
+            value="<%= model[:ModelName] %>"
+          >
+          <% unless model[:IsModelExist] %>
+            <svg class="text-orange-900 mr-1 h-3 w-3" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v3.75m-9.303 3.376c-.866 1.5.217 3.374 1.948 3.374h14.71c1.73 0 2.813-1.874 1.948-3.374L13.949 3.378c-.866-1.5-3.032-1.5-3.898 0L2.697 16.126zM12 15.75h.007v.008H12v-.008z"/></svg>
+          <% end %>
+          <span><%= model[:ModelName] %></span>
+        </div>
+      </label>
+    <% end %>
+  </div>
+</div>

data/app/views/rails_realtime_erd/erd/show.html.erb ADDED Viewed

@@ -0,0 +1,44 @@
+<%= schema_data_tag(@schema) %>
+<div
+  id="rre-app"
+  data-controller="hash-state filter diagram clipboard download tab zoom-pan"
+  data-hash-state-filter-outlet="[data-controller~='filter']"
+  data-filter-diagram-outlet="[data-controller~='diagram']"
+  data-clipboard-diagram-outlet="[data-controller~='diagram']"
+  data-download-diagram-outlet="[data-controller~='diagram']"
+>
+  <header class="bg-red-600">
+    <nav class="mx-auto px-4">
+      <div class="flex w-full items-center justify-between py-4">
+        <h1 class="text-white inline-flex space-x-2 items-center">
+          <svg class="h-6 w-6" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" aria-hidden="true">
+            <path d="M3 4h18v4H3zM3 10h18v4H3zM3 16h18v4H3z"/>
+          </svg>
+          <span class="font-bold">Rails Realtime ERD</span>
+        </h1>
+        <div class="space-x-4 inline-flex items-center">
+          <span class="text-white/80 text-xs"><%= @app_name %></span>
+        </div>
+      </div>
+    </nav>
+  </header>
+  <div class="flex">
+    <aside class="w-[250px] border-r border-gray-300 flex-none p-2">
+      <%= render "sidebar" %>
+    </aside>
+    <main class="flex-1 bg-gray-900 min-h-[calc(100vh-56px-32px)]">
+      <%= render "main" %>
+    </main>
+  </div>
+  <footer class="bg-gray-100">
+    <p class="text-center text-xs text-gray-600 py-2">
+      <a href="https://github.com/" class="hover:text-gray-400" target="_blank" rel="noopener noreferrer">
+        Rails Realtime ERD v<%= @version %>
+      </a>
+    </p>
+  </footer>
+</div>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,4 @@
+RailsRealtimeErd::Engine.routes.draw do
+  root to: "erd#show", as: :erd
+  get "assets/:name", to: "assets#show", as: :engine_asset, constraints: {name: /[\w.\-]+/}
+end

data/lib/rails-realtime-erd/builder.rb ADDED Viewed

@@ -0,0 +1,167 @@
+module RailsRealtimeErd
+  class Builder
+    class << self
+      def model_data
+        result = {Models: [], Relations: []}
+        ::Rails.application.eager_load!
+        ::ActiveRecord::Base.descendants.sort_by(&:name).each do |defined_model|
+          next unless defined_model.table_exists?
+          next if defined_model.name.nil?
+          next if defined_model.name.include?("HABTM_")
+          next if defined_model.table_name.blank?
+          next if defined_model.abstract_class?
+          next if defined_model.name.start_with?("ActiveRecord::")
+          next if defined_model.name.start_with?("ActiveStorage::")
+          next if defined_model.name.start_with?("ActionText::")
+          next if defined_model.name.start_with?("ActionMailbox::")
+          table_name = defined_model.table_name
+          model = {
+            TableName: table_name,
+            TableComment: ::ActiveRecord::Base.connection.table_comment(table_name.to_sym) || "",
+            ModelName: defined_model.name,
+            IsModelExist: true,
+            Columns: []
+          }
+          foreign_keys = ::ActiveRecord::Base.connection.foreign_keys(defined_model.table_name).map { |k| k.options[:column] }
+          primary_key = defined_model.primary_key
+          defined_model.columns.each do |column|
+            key = ""
+            if column.name == primary_key
+              key = "PK"
+            elsif foreign_keys.include?(column.name)
+              key = "FK"
+            end
+            model[:Columns] << {
+              name: column.name,
+              type: column.type,
+              key: key,
+              comment: column.comment
+            }
+          end
+          result[:Models] << model
+          defined_model.reflect_on_all_associations(:has_many).each do |reflection|
+            reflection_model_name = get_reflection_model_name(reflection)
+            reverse_relation = result[:Relations].find { |r|
+              if reflection.options[:through]
+                r[:RightModelName] == model[:ModelName] && r[:LeftModelName] == reflection_model_name && r[:Line] == ".."
+              else
+                r[:RightModelName] == model[:ModelName] && r[:LeftModelName] == reflection_model_name && r[:Line] == "--"
+              end
+            }
+            if reverse_relation
+              reverse_relation[:Comment] = if reflection.options[:through]
+                "#{reverse_relation[:Comment]}, HMT:#{reflection.name}"
+              else
+                "#{reverse_relation[:Comment]}, HM:#{reflection.name}"
+              end
+            else
+              result[:Relations] << {
+                LeftModelName: model[:ModelName],
+                LeftValue: reflection.options[:through] ? "}o" : "||",
+                Line: reflection.options[:through] ? ".." : "--",
+                RightModelName: reflection_model_name,
+                RightValue: "o{",
+                Comment: reflection.options[:through] ? "HMT:#{reflection.name}" : "HM:#{reflection.name}"
+              }
+            end
+          end
+          defined_model.reflect_on_all_associations(:has_and_belongs_to_many).each do |reflection|
+            reflection_model_name = get_reflection_model_name(reflection)
+            reverse_relation = result[:Relations].find { |r| r[:RightModelName] == model[:ModelName] && r[:LeftModelName] == reflection_model_name }
+            if reverse_relation
+              reverse_relation[:Comment] = "HABTM"
+            else
+              result[:Relations] << {
+                LeftModelName: model[:ModelName],
+                LeftValue: "}o",
+                Line: "..",
+                RightModelName: reflection_model_name,
+                RightValue: "o{",
+                Comment: "HABTM"
+              }
+            end
+          end
+          defined_model.reflect_on_all_associations(:belongs_to).each do |reflection|
+            reflection_model_name = get_reflection_model_name(reflection)
+            reverse_relation = result[:Relations].find { |r| r[:RightModelName] == model[:ModelName] && r[:LeftModelName] == reflection_model_name }
+            if reverse_relation
+              if (::Rails.application.config.active_record.belongs_to_required_by_default && reflection.options[:optional]) || (!::Rails.application.config.active_record.belongs_to_required_by_default && !reflection.options[:required])
+                reverse_relation[:LeftValue] = "|o"
+              end
+              reverse_relation[:Comment] = "#{reverse_relation[:Comment]}, BT:#{reflection.name}"
+            else
+              right_value = if (::Rails.application.config.active_record.belongs_to_required_by_default && reflection.options[:optional]) || (!::Rails.application.config.active_record.belongs_to_required_by_default && !reflection.options[:required])
+                "o|"
+              else
+                "||"
+              end
+              result[:Relations] << {
+                LeftModelName: model[:ModelName],
+                LeftValue: "}o",
+                Line: "--",
+                RightModelName: reflection_model_name,
+                RightValue: right_value,
+                Comment: "BT:#{reflection.name}"
+              }
+            end
+          end
+          defined_model.reflect_on_all_associations(:has_one).each do |reflection|
+            reflection_model_name = get_reflection_model_name(reflection)
+            reverse_relation = result[:Relations].find { |r|
+              if reflection.options[:through]
+                r[:RightModelName] == model[:ModelName] && r[:LeftModelName] == reflection_model_name && r[:Line] == ".."
+              else
+                r[:RightModelName] == model[:ModelName] && r[:LeftModelName] == reflection_model_name && r[:Line] == "--"
+              end
+            }
+            if reverse_relation
+              reverse_relation[:LeftValue] = "|o"
+              reverse_relation[:Comment] = if reflection.options[:through]
+                "#{reverse_relation[:Comment]}, HOT:#{reflection.name}"
+              else
+                "#{reverse_relation[:Comment]}, HO:#{reflection.name}"
+              end
+            else
+              result[:Relations] << {
+                LeftModelName: model[:ModelName],
+                LeftValue: reflection.options[:through] ? "}o" : "||",
+                Line: reflection.options[:through] ? ".." : "--",
+                RightModelName: reflection_model_name,
+                RightValue: "o|",
+                Comment: reflection.options[:through] ? "HOT:#{reflection.name}" : "HO:#{reflection.name}"
+              }
+            end
+          end
+        end
+        result
+      end
+      def get_reflection_model_name(reflection)
+        if reflection.options[:class_name]
+          reflection.options[:class_name].to_s.classify
+        elsif reflection.options[:through]
+          if reflection.options[:source]
+            reflection.options[:source].to_s.classify
+          else
+            reflection.class_name
+          end
+        else
+          reflection.class_name
+        end
+      end
+    end
+  end
+end

data/lib/rails-realtime-erd/configuration.rb ADDED Viewed

@@ -0,0 +1,11 @@
+module RailsRealtimeErd
+  class Configuration
+    attr_accessor :mount_path, :auto_mount, :enabled_environments
+    def initialize
+      @mount_path = "/rails/erd"
+      @auto_mount = true
+      @enabled_environments = %w[development test]
+    end
+  end
+end

data/lib/rails-realtime-erd/engine.rb ADDED Viewed

@@ -0,0 +1,18 @@
+require "rails/engine"
+module RailsRealtimeErd
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsRealtimeErd
+    initializer "rails_realtime_erd.auto_mount" do |app|
+      config = RailsRealtimeErd.configuration
+      next unless config.auto_mount
+      next unless config.enabled_environments.map(&:to_s).include?(Rails.env.to_s)
+      mount_path = config.mount_path
+      app.routes.append do
+        mount RailsRealtimeErd::Engine => mount_path, as: :rails_realtime_erd
+      end
+    end
+  end
+end

data/lib/rails-realtime-erd/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module RailsRealtimeErd
+  VERSION = "0.1.0"
+end

data/lib/rails-realtime-erd.rb ADDED Viewed

@@ -0,0 +1,20 @@
+require_relative "rails-realtime-erd/version"
+require_relative "rails-realtime-erd/configuration"
+require_relative "rails-realtime-erd/builder"
+require_relative "rails-realtime-erd/engine"
+module RailsRealtimeErd
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    def configure
+      yield configuration
+    end
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rails-realtime-erd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jackson Pires
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7.10
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.4.2
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.28.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.28.5
+description: Mounts /rails/erd in your Rails app. On every request the gem introspects
+  ActiveRecord models and renders a Mermaid ERD viewer with Stimulus-driven filters,
+  zoom/pan, copy & download. No pre-generated HTML file.
+email:
+- jackson@linkana.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/rails_realtime_erd/erd.css
+- app/controllers/rails_realtime_erd/application_controller.rb
+- app/controllers/rails_realtime_erd/assets_controller.rb
+- app/controllers/rails_realtime_erd/erd_controller.rb
+- app/helpers/rails_realtime_erd/erd_helper.rb
+- app/javascript/rails_realtime_erd/application.js
+- app/javascript/rails_realtime_erd/vendor/mermaid.js
+- app/javascript/rails_realtime_erd/vendor/stimulus.js
+- app/views/layouts/rails_realtime_erd/application.html.erb
+- app/views/rails_realtime_erd/erd/_main.html.erb
+- app/views/rails_realtime_erd/erd/_sidebar.html.erb
+- app/views/rails_realtime_erd/erd/show.html.erb
+- config/routes.rb
+- lib/rails-realtime-erd.rb
+- lib/rails-realtime-erd/builder.rb
+- lib/rails-realtime-erd/configuration.rb
+- lib/rails-realtime-erd/engine.rb
+- lib/rails-realtime-erd/version.rb
+homepage: https://github.com/jacksonpires/rails-realtime-erd
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jacksonpires/rails-realtime-erd
+  source_code_uri: https://github.com/jacksonpires/rails-realtime-erd
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key:
+specification_version: 4
+summary: Live Mermaid ERD viewer mounted as a Rails route, powered by Hotwire.
+test_files: []