mermaid_rails_erd 1.0.1

data/lib/mermaid_rails_erd/relationship_symbol_mapper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module MermaidRailsErd
+  class RelationshipSymbolMapper
+    def map(assoc_type)
+      {
+        has_many: "||--o{",
+        has_one: "||--||",
+        belongs_to: "}o--||",
+      }[assoc_type] || "--"
+    end
+  end
+end

data/lib/mermaid_rails_erd/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MermaidRailsErd
+  VERSION = "1.0.1"
+end

data/lib/mermaid_rails_erd.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "mermaid_rails_erd/version"
+require_relative "mermaid_rails_erd/generator"
+require_relative "mermaid_rails_erd/relationship"
+require_relative "mermaid_rails_erd/mermaid_emitter"
+require_relative "mermaid_rails_erd/column_info"
+require_relative "mermaid_rails_erd/model_loader"
+require_relative "mermaid_rails_erd/association_resolver"
+require_relative "mermaid_rails_erd/polymorphic_targets_resolver"
+require_relative "mermaid_rails_erd/relationship_symbol_mapper"
+require_relative "mermaid_rails_erd/relationship_registry"
+require_relative "mermaid_rails_erd/model_data_collector"
+require_relative "mermaid_rails_erd/relationship_builders/base_relationship_builder"
+require_relative "mermaid_rails_erd/relationship_builders/belongs_to_relationship_builder"
+require_relative "mermaid_rails_erd/relationship_builders/has_many_relationship_builder"
+require_relative "mermaid_rails_erd/relationship_builders/has_one_relationship_builder"
+require_relative "mermaid_rails_erd/relationship_builders/habtm_relationship_builder"
+require_relative "mermaid_rails_erd/railtie" if defined?(Rails)
+
+module MermaidRailsErd
+  class Error < StandardError; end
+
+  # Build and return a Generator instance with all data collected
+  # @return [Generator] Generator instance with collected data
+  def self.build
+    Generator.new.build
+  end
+
+  # Generate Mermaid ERD and write to output stream
+  # @param output [IO] Output stream to write the ERD to
+  def self.generate(output: $stdout)
+    build.emit(output: output)
+  end
+end

data/lib/tasks/mermaid_rails_erd.rake

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "mermaid_rails_erd"
+
+namespace :mermaid_rails_erd do
+  desc "Generate Mermaid ERD diagram from ActiveRecord models"
+  task generate: :environment do
+    output_path = Rails.root.join("tmp", "#{ActiveRecord::Base.connection.current_database}.mmd")
+
+    # Ensure tmp directory exists
+    FileUtils.mkdir_p(File.dirname(output_path))
+
+    if File.exist?(output_path)
+      puts "Warning: Overwriting existing file at #{output_path}"
+      # Optional: Create backup
+      # FileUtils.cp(output_path, "#{output_path}.bak")
+    end
+
+    begin
+      File.open(output_path, "w") do |file|
+        puts "Generating Mermaid ERD diagram..."
+        MermaidRailsErd.generate(output: file)
+      end
+    rescue Errno::EACCES, IOError => e
+      puts "Error: Could not write to #{output_path}: #{e.message}"
+    end
+
+    # Make output instructions more visible
+    puts "\n#{'=' * 80}"
+    puts "\n ERD diagram generated at: #{output_path}"
+    puts "\n  📊 DIAGRAM VIEWING:\n".upcase
+    puts "\n   - Mermaid ERD Visualizer: https://github.com/delexw/mermaid-erd-visualizer"
+    puts "\n"
+    puts "#{'=' * 80}\n"
+  end
+end

data/mermaid_rails_erd.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "lib/mermaid_rails_erd/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mermaid_rails_erd"
+  spec.version       = MermaidRailsErd::VERSION
+  spec.authors       = ["YL"]
+  spec.email         = ["adamyoungliu@gmail.com"]
+
+  spec.summary       = "Generate Mermaid.js Entity Relationship Diagrams from ActiveRecord models"
+  spec.description   = "A Ruby gem that introspects ActiveRecord models and generates Mermaid.js ERD syntax for visualizing database relationships in Rails applications."
+  spec.homepage      = "https://github.com/delexw/mermaid_rails_erd"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/delexw/mermaid_rails_erd"
+  spec.metadata["changelog_uri"] = "https://github.com/delexw/mermaid_rails_erd/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.glob("{lib,bin}/**/*") + Dir.glob("lib/tasks/**/*.rake") + %w[
+    README.md
+    Rakefile
+    mermaid_rails_erd.gemspec
+    LICENSE
+  ]
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Dependencies
+  spec.add_dependency "activerecord", ">= 6.0"
+  spec.add_dependency "activesupport", ">= 6.0"
+  spec.add_dependency "railties", ">= 6.0"
+
+  # Development dependencies
+  spec.add_development_dependency "bundler-audit", "~> 0.9"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.6"
+  spec.add_development_dependency "rubocop", "~> 1.50"
+  spec.add_development_dependency "rubocop-rspec", "~> 3.6.0"
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: mermaid_rails_erd
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- YL
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+description: A Ruby gem that introspects ActiveRecord models and generates Mermaid.js
+  ERD syntax for visualizing database relationships in Rails applications.
+email:
+- adamyoungliu@gmail.com
+executables:
+- console
+- release
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/release
+- bin/setup
+- lib/mermaid_rails_erd.rb
+- lib/mermaid_rails_erd/association_resolver.rb
+- lib/mermaid_rails_erd/column_info.rb
+- lib/mermaid_rails_erd/generator.rb
+- lib/mermaid_rails_erd/mermaid_emitter.rb
+- lib/mermaid_rails_erd/model_data_collector.rb
+- lib/mermaid_rails_erd/model_loader.rb
+- lib/mermaid_rails_erd/parsed_data.rb
+- lib/mermaid_rails_erd/polymorphic_targets_resolver.rb
+- lib/mermaid_rails_erd/railtie.rb
+- lib/mermaid_rails_erd/relationship.rb
+- lib/mermaid_rails_erd/relationship_builders/base_relationship_builder.rb
+- lib/mermaid_rails_erd/relationship_builders/belongs_to_relationship_builder.rb
+- lib/mermaid_rails_erd/relationship_builders/habtm_relationship_builder.rb
+- lib/mermaid_rails_erd/relationship_builders/has_many_relationship_builder.rb
+- lib/mermaid_rails_erd/relationship_builders/has_one_relationship_builder.rb
+- lib/mermaid_rails_erd/relationship_registry.rb
+- lib/mermaid_rails_erd/relationship_symbol_mapper.rb
+- lib/mermaid_rails_erd/version.rb
+- lib/tasks/mermaid_rails_erd.rake
+- mermaid_rails_erd.gemspec
+homepage: https://github.com/delexw/mermaid_rails_erd
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/delexw/mermaid_rails_erd
+  source_code_uri: https://github.com/delexw/mermaid_rails_erd
+  changelog_uri: https://github.com/delexw/mermaid_rails_erd/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.18
+signing_key:
+specification_version: 4
+summary: Generate Mermaid.js Entity Relationship Diagrams from ActiveRecord models
+test_files: []