rails-mermaid_erd 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f74497263f036ef73eb9cb8d72294040700d589d5f1ce5aa2d7521f2dc7ae4e
-  data.tar.gz: b8ef91443c959d00c30bca24adf8e62d73d3eb827119119ab3dc6b2c033d5295
+  metadata.gz: 27a3b346f33bfc899475fc0c00f6c512bf8ba1e1e028c3518c24496e5eb3e016
+  data.tar.gz: d0317f33acd321ed8b9a3b2bc5bb818b02593bba6c002925973f629fbfc110c7
 SHA512:
-  metadata.gz: 621de1f859e6dfc56965016c859fb34d722d8b7c438c8b11b02cf120deb2a6c2eb63deff8c713adc15891f53da69ac20dc612b81946f8cc3bc1257a2189a8931
-  data.tar.gz: 970a6cc600ef093fad0dd5eae21423870bcef5ff8b5d4cbb4b55a17d58fce2f64600cdaf336beae36eb60cebb93fba8d9239db05f1bdcb30e4e08bef859754d3
+  metadata.gz: '09d7df6654042f5a327a18cf9ddfb7f4c43bb41717ff3ed937cb5dc95aed8d502d983000c2b31970370e2532fba62acda6506d9ff5dd0c073ae1f1db1fc7705c'
+  data.tar.gz: 020f4ba3e58cfbbe8cd77a28414138073ba248eccfdef2ec3a55cf19a068ffa8913f1dc526bc2c5b7a23e35faca7265db4bbce34dee86d4f2e3f78feff737129

data/README.md

@@ -21,7 +21,7 @@ The editor is a single HTML file, so the entire editor can be shared.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "rails-mermaid_erd", group: :development
+gem "rails-mermaid_erd", group: :development, require: false
 ```
 
 And then execute:
@@ -30,6 +30,16 @@ And then execute:
 $ bundle install
 ```
 
+Add this line to your application's Rakefile:
+
+```ruby
+begin
+  require "rails-mermaid_erd"
+rescue LoadError
+  # Do nothing.
+end
+```
+
 ## Usage
 
 Run rake task `mermaid_erd` will generate `<app_root>/mermaid_erd/index.html`.
@@ -48,8 +58,8 @@ This file is not required for Git management, so you can add it to `.gitignore`
 mermaid_erd
 ```
 
-`<app_root>/mermaid_erd/index.html` is single HTML file.
-If you share this file, it can be used by those who do not have Ruby on Rails environment. Or, you can upload the file to a web server and share it with the same URL.
+`<app_root>/mermaid_erd/index.html` is a single HTML file.
+If you share this file, it can be used by those who do not have a Ruby on Rails environment. Or, you can upload the file to a web server and share it with the same URL.
 
 It would be very smart to generate it automatically using CI.
 

data/lib/rails-mermaid_erd/builder.rb

@@ -14,8 +14,10 @@ class RailsMermaidErd::Builder
         next if defined_model.name.include?("HABTM_")
         next if defined_model.table_name.blank?
 
+        table_name = defined_model.table_name
         model = {
-          TableName: defined_model.table_name,
+          TableName: table_name,
+          TableComment: ::ActiveRecord::Base.connection.table_comment(table_name.to_sym) || "",
           ModelName: defined_model.name,
           IsModelExist: true,
           Columns: []
@@ -91,12 +93,12 @@ class RailsMermaidErd::Builder
 
           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[:requried])
+            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[:requried])
+            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
               "||"

data/lib/rails-mermaid_erd/version.rb

@@ -1,3 +1,3 @@
 module RailsMermaidErd
-  VERSION = "0.4.2"
+  VERSION = "0.5.1"
 end

data/lib/templates/index.html.erb

@@ -228,7 +228,27 @@
           <button @click="tab = 'erd'" :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 ${tab === 'erd' ? 'bg-white text-gray-900' : 'bg-gray-400 text-gray-900'}`">{{i18n[language]["tab"]["erd"]}}</button>
           <button @click="tab = 'code'" :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 ${tab === 'code' ? 'bg-white text-gray-900' : 'bg-gray-400 text-gray-900'}`">{{i18n[language]["tab"]["code"]}}</button>
         </div>
-        <div v-show="tab === 'erd'" class="px-4 w-full min-h-[calc(100vh-56px-32px-56px)]" id="preview"></div>
+        <div v-show="tab === 'erd'" class="px-4 w-full min-h-[calc(100vh-56px-32px-56px)] relative overflow-hidden">
+          <div class="absolute inset-0" :style="zoomStyle" ref="zoomArea">
+            <div id="preview"></div>
+          </div>
+
+          <div class="absolute bottom-0 right-0 p-4 space-x-4 flex">
+            <div class="space-x-2 flex items-center">
+              <button 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" @click="zoomIn">+</button>
+              <button 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" @click="zoomOut">-</button>
+            </div>
+            <div class="flex items-center space-x-2">
+              <button 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" @click="moveLeft">←</button>
+              <div class="flex flex-col space-y-8">
+                <button 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" @click="moveUp">↑</button>
+                <button 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" @click="moveDown">↓</button>
+              </div>
+              <button 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" @click="moveRight">→</button>
+            </div>
+          </div>
+
+        </div>
         <textarea v-show="tab === 'code'" 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" readonly v-model="mermaidErd"></textarea>
       </div>
     </div>
@@ -338,6 +358,37 @@
         const isShowComment = Vue.ref(false)
         const isHideColumns = Vue.ref(false)
 
+        const scale = Vue.ref(1)
+        const posX = Vue.ref(0)
+        const posY = Vue.ref(0)
+        const zoomArea = Vue.ref(null)
+
+        const zoomStyle = Vue.computed(() => {
+          return {
+            transform: `scale(${scale.value}) translate(${posX.value}px, ${posY.value}px)`,
+            transformOrigin: 'top left'
+          }
+        })
+
+        const zoomIn = () => {
+          scale.value = Math.min(scale.value + 0.1, 3)
+        }
+
+        const zoomOut = () => {
+          scale.value = Math.max(scale.value - 0.1, 0.5)
+        }
+
+        const move = (dx, dy) => {
+          const step = 10 / scale.value
+          posX.value += dx * step
+          posY.value += dy * step
+        }
+
+        const moveUp = () => move(0, -10)
+        const moveDown = () => move(0, 10)
+        const moveLeft = () => move(-10, 0)
+        const moveRight = () => move(10, 0)
+
         const restoreFromHash = () => {
           try {
             const h = location.hash.substr(1, location.hash.length)
@@ -427,6 +478,7 @@
 
           filteredData.value.Models.forEach(model => {
             lines.push(`    %% table name: ${model.TableName}`)
+            lines.push(`    %% table comment: ${model.TableComment}`)
             lines.push(`    ${model.ModelName.replace(/:/g, '-')} {`)
 
             if (!isHideColumns.value) {
@@ -473,7 +525,7 @@
         const filterText = Vue.ref('')
 
         const reRender = () => {
-          mermaid.initialize({theme: 'dark'})
+          mermaid.initialize({theme: 'dark', maxTextSize: 99999999})
           mermaid.init()
           graph.value = mermaid.mermaidAPI.render("mermaid-erd", mermaidErd.value);
           document.getElementById('preview').innerHTML = graph.value
@@ -597,6 +649,14 @@
           tab,
           updateHash,
           isHideColumns,
+          zoomStyle,
+          zoomArea,
+          zoomIn,
+          zoomOut,
+          moveUp,
+          moveDown,
+          moveLeft,
+          moveRight
         }
       }
     }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-mermaid_erd
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - 肥溜め
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-22 00:00:00.000000000 Z
+date: 2024-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Generate Mermaid ERD for Ruby on Rails