rails-mermaid_erd 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 890249c9517467adbf8e8f60828570108b66490354733153af33ffad6c1a3a2a
-  data.tar.gz: 2e61e244f9eb1d32fec923e226185e49bc7901ea94e688312f6c7720b7656326
+  metadata.gz: 1a0b049ccbaa1ec74fd4f0bc0c55e9b1ca066ac4f9e7b624591e1626edbbcb47
+  data.tar.gz: 0c2a7bf4cb12c29f7623e2ceaef53de385f9a2dd9f6d3596786849623e9979c6
 SHA512:
-  metadata.gz: f152265387c8fd91bb99f64790dba988e0a09ab4bf05713456c0474f8ed89c447c084cf376bee33017c15734740c67c9add9d69edd56f660d3476bdd3cafcc9e
-  data.tar.gz: 5239d5dfbeeab9b6a7c228e4d9bfdb55ffed194d9af11451c5407ddb6c7651ad4e9065e304417b0edaaaf978a39fd1d7bb6118244b2e72cc719419c5335cc088
+  metadata.gz: 7894f5a5b2717404fb8593295138466678158de760e4704235dbd64ba968dfb180334df4610f615edf670df564d7aca1bfa869a6ba5f54e033883dba80add955
+  data.tar.gz: 44011954159232651066fb8a12b58ea27877055a12a7c677641dd37981bfb98ecf3d3caed1c0797ee0fb38f3d61bc8e9050585782d31203d262c5dede90fee46

data/README.md

@@ -1,5 +1,10 @@
+[English](./README.md) | [日本語](./README.ja.md)
+
 # Rails Mermaid ERD
 
+[![test](https://github.com/koedame/rails-mermaid_erd/actions/workflows/run-test.yml/badge.svg)](https://github.com/koedame/rails-mermaid_erd/actions/workflows/run-test.yml)
+[![Gem Version](https://badge.fury.io/rb/rails-mermaid_erd.svg)](https://rubygems.org/gems/rails-mermaid_erd)
+
 Generate [Mermaid ERD](https://mermaid-js.github.io/mermaid/#/entityRelationshipDiagram) from your Ruby on Rails application.
 
 [<img src="./docs/screen_shot.png" width="50%">](./docs/screen_shot.png)
@@ -48,6 +53,17 @@ If you share this file, it can be used by those who do not have Ruby on Rails en
 
 It would be very smart to generate it automatically using CI.
 
+## Configuration
+
+`./config/mermaid_erd.yml` to customize the configuration.
+See [./docs/example.yml](./docs/example.yml) for an example configuration.
+
+The setting items are as follows.
+
+| key | description | default |
+| --- | --- | --- |
+| `result_path` | Destination of generated files. | `mermaid_erd/index.html` |
+
 <!--
 TODO:
 ## Contributing

data/lib/rails-mermaid_erd/configuration.rb

@@ -0,0 +1,21 @@
+require "yaml"
+
+module RailsMermaidErd
+  class Configuration
+    attr_accessor :result_path
+
+    def initialize
+      config = {
+        result_path: "mermaid_erd/index.html"
+      }
+
+      config_file = Rails.root.join("config/mermaid_erd.yml")
+      if File.exist?(config_file)
+        custom_config = YAML.load(config_file.read).symbolize_keys
+        config = config.merge(custom_config)
+      end
+
+      @result_path = config[:result_path]
+    end
+  end
+end

data/lib/rails-mermaid_erd/version.rb

@@ -1,3 +1,3 @@
 module RailsMermaidErd
-  VERSION = "0.1.2"
+  VERSION = "0.3.0"
 end

data/lib/rails-mermaid_erd.rb

@@ -3,10 +3,17 @@ require "fileutils"
 require "rake"
 require "rake/dsl_definition"
 require_relative "rails-mermaid_erd/version"
+require_relative "rails-mermaid_erd/configuration"
 
 module RailsMermaidErd
   extend Rake::DSL
 
+  class << self
+    def configuration
+      @configuration ||= RailsMermaidErd::Configuration.new
+    end
+  end
+
   desc "Generate Mermaid ERD."
   task mermaid_erd: :environment do
     result = {
@@ -17,6 +24,9 @@ module RailsMermaidErd
     ::Rails.application.eager_load!
     ::ActiveRecord::Base.descendants.each do |defined_model|
       next unless defined_model.table_exists?
+
+      next if defined_model.name.include?("HABTM_")
+
       model = {
         TableName: defined_model.table_name,
         ModelName: defined_model.name,
@@ -84,6 +94,25 @@ module RailsMermaidErd
         end
       end
 
+      defined_model.reflect_on_all_associations(:has_and_belongs_to_many).each do |h|
+        reverse_relation = if h.options[:class_name]
+          result[:Relations].find { |r| r[:RightModelName] == model[:ModelName] && r[:LeftModelName] == h.options[:class_name] }
+        else
+          result[:Relations].find { |r| r[:RightModelName] == model[:ModelName] && r[:LeftModelName] == h.name.to_s.classify }
+        end
+        if reverse_relation
+          reverse_relation[:Comment] = "HABTM"
+        else
+          result[:Relations] << {
+            LeftModelName: model[:ModelName],
+            LeftValue: "}o",
+            RightModelName: h.name.to_s.classify,
+            RightValue: "o{",
+            Comment: "HABTM"
+          }
+        end
+      end
+
       defined_model.reflect_on_all_associations(:belongs_to).each do |h|
         if h.options[:class_name]
           reverse_relation = result[:Relations].find { |r| r[:RightModelName] == model[:ModelName] && r[:LeftModelName] == h.options[:class_name] }
@@ -194,9 +223,10 @@ module RailsMermaidErd
     erb = ERB.new(File.read(File.expand_path("./templates/index.html.erb", __dir__)))
     result_html = erb.result(binding)
 
-    result_dir = Rails.root.join("./mermaid_erd")
-    result_file = result_dir.join("./index.html")
+    result_dir = Rails.root.join(File.dirname(RailsMermaidErd.configuration.result_path))
     FileUtils.mkdir_p(result_dir)
+
+    result_file = Rails.root.join(RailsMermaidErd.configuration.result_path)
     File.write(result_file, result_html)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-mermaid_erd
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - 肥溜め
@@ -9,22 +9,78 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-08 00:00:00.000000000 Z
+date: 2022-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email: []
 executables: []
@@ -36,6 +92,7 @@ files:
 - Rakefile
 - lib/assets/logo.svg
 - lib/rails-mermaid_erd.rb
+- lib/rails-mermaid_erd/configuration.rb
 - lib/rails-mermaid_erd/version.rb
 - lib/templates/index.html.erb
 homepage: https://github.com/koedame/rails-mermaid_erd
@@ -43,6 +100,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/koedame/rails-mermaid_erd
+  source_code_uri: https://github.com/koedame/rails-mermaid_erd
 post_install_message:
 rdoc_options: []
 require_paths: