arerd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a3364c03a39be5bf9ac0727652516999efb340d3208fd87621556021c28de20
+  data.tar.gz: c84c46b6e3e2fec66857e74c087e5ba6f03b2fe4cc42c3ed99d9997dc5f69038
+SHA512:
+  metadata.gz: 8a634f01c34f49fe14acfcfc9e9d37407723852857b05ab16ecef35ac5f5dfb420a6eeaf5695e156d0ca44e998a8f8df7032d8e3f987ab7b51b77b66c4035dc4
+  data.tar.gz: 46d6acb3f3be56edb6630df0c97ff1a318d73b6aba02b2e009272ae0761bc616896040f6dd12ebc7beb8918845632274f7df9f70044f6ba8f4b5822f8305b1ee

data/.devcontainer/Dockerfile

@@ -0,0 +1,22 @@
+FROM mcr.microsoft.com/devcontainers/base:1-bookworm
+
+RUN apt-get update && \
+    export DEBIAN_FRONTEND=noninteractive && \
+    apt-get -y install --no-install-recommends \
+    fish \
+    build-essential autoconf libssl-dev libyaml-dev zlib1g-dev libffi-dev libgmp-dev rustc && \
+    rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/*
+
+# Install asdf
+RUN curl -L 'https://github.com/asdf-vm/asdf/releases/download/v0.18.0/asdf-v0.18.0-linux-amd64.tar.gz' | tar -xz -C /usr/local/bin && \
+    mkdir -p /home/vscode/.config/fish/conf.d && \
+    curl -L 'https://raw.githubusercontent.com/asdf-vm/asdf/refs/tags/v0.18.0/asdf.fish' > /home/vscode/.config/fish/conf.d/asdf.fish && \
+    chown -R vscode:vscode /home/vscode/.config
+
+# Install asdf plugins and specified runtimes
+USER vscode
+WORKDIR /home/vscode
+COPY --chown=vscode:vscode .tool-versions /home/vscode/.tool-versions
+RUN asdf plugin add ruby && \
+    asdf install && \
+    asdf reshim

data/.devcontainer/compose.yaml

@@ -0,0 +1,18 @@
+name: "arerd"
+
+services:
+  arerd:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+
+    volumes:
+    - ../..:/workspaces:cached
+    - ./fish/conf.d/abbrs.fish:/home/vscode/.config/fish/conf.d/abbrs.fish
+    - ./fish/functions/git.fish:/home/vscode/.config/fish/conf.d/git.fish
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+
+    # Uncomment the next line to use a non-root user for all processes.
+    user: vscode

data/.devcontainer/devcontainer.json

@@ -0,0 +1,37 @@
+// For format details, see https://containers.dev/implementors/json_reference/.
+// For config options, see the README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+  "name": "arerd",
+  "dockerComposeFile": "compose.yaml",
+  "service": "arerd",
+  "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1": {}
+  },
+
+  "containerEnv": {},
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  "forwardPorts": [],
+
+  // Configure tool-specific properties.
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "terminal.integrated.defaultProfile.linux": "fish"
+      },
+      "extensions": [
+        "EditorConfig.EditorConfig",
+        "Shopify.ruby-lsp",
+      ]
+    }
+  },
+
+  // Uncomment to connect as root instead. More info: https://containers.dev/implementors/json_reference/#remoteUser.
+  // "remoteUser": "root",
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "./.devcontainer/post_create.fish"
+}

data/.devcontainer/fish/conf.d/abbrs.fish

@@ -0,0 +1,3 @@
+if type -q git
+  abbr -a g git
+end

data/.devcontainer/fish/functions/git.fish

@@ -0,0 +1,12 @@
+if type -q git
+  function git
+    if test (count $argv) -eq 0
+      git status
+    else if test $argv[1] = "up"
+      git rev-parse --is-inside-work-tree > /dev/null 2>&1 && \
+        cd (pwd)/(git rev-parse --show-cdup)
+    else
+      command git $argv
+    end
+  end
+end

data/.devcontainer/post_create.fish

@@ -0,0 +1 @@
+#!/bin/fish

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{md,markdown}]
+trim_trailing_whitespace = false

data/.standard.yml

@@ -0,0 +1,2 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.6

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in arerd.gemspec
+gemspec
+
+group :development, :test do
+  gem "irb"
+  gem "rake"
+  gem "minitest"
+  gem "standard"
+end

data/Gemfile.lock

@@ -0,0 +1,248 @@
+PATH
+  remote: .
+  specs:
+    arerd (0.1.0)
+      rails (>= 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      activejob (= 7.2.2.1)
+      activerecord (= 7.2.2.1)
+      activestorage (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      mail (>= 2.8.0)
+    actionmailer (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      actionview (= 7.2.2.1)
+      activejob (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (7.2.2.1)
+      actionview (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4, < 3.2)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      activerecord (= 7.2.2.1)
+      activestorage (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.2.2.1)
+      activesupport (= 7.2.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.2.2.1)
+      activesupport (= 7.2.2.1)
+      globalid (>= 0.3.6)
+    activemodel (7.2.2.1)
+      activesupport (= 7.2.2.1)
+    activerecord (7.2.2.1)
+      activemodel (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      timeout (>= 0.4.0)
+    activestorage (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      activejob (= 7.2.2.1)
+      activerecord (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      marcel (~> 1.0)
+    activesupport (7.2.2.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
+    builder (3.3.0)
+    cgi (0.5.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    crass (1.0.6)
+    date (3.4.1)
+    drb (2.2.3)
+    erb (4.0.4)
+      cgi (>= 0.3.3)
+    erubi (1.13.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
+    minitest (5.25.5)
+    net-imap (0.5.9)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.8-x86_64-linux-gnu)
+      racc (~> 1.4)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.4.0)
+    psych (5.2.6)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.1.16)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (7.2.2.1)
+      actioncable (= 7.2.2.1)
+      actionmailbox (= 7.2.2.1)
+      actionmailer (= 7.2.2.1)
+      actionpack (= 7.2.2.1)
+      actiontext (= 7.2.2.1)
+      actionview (= 7.2.2.1)
+      activejob (= 7.2.2.1)
+      activemodel (= 7.2.2.1)
+      activerecord (= 7.2.2.1)
+      activestorage (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      bundler (>= 1.15.0)
+      railties (= 7.2.2.1)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    rdoc (6.14.2)
+      erb
+      psych (>= 4.0.0)
+    regexp_parser (2.10.0)
+    reline (0.6.1)
+      io-console (~> 0.5)
+    rubocop (1.75.8)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    sqlite3 (2.7.2-x86_64-linux-gnu)
+    standard (1.50.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.75.5)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.8.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.25.0)
+    stringio (3.1.7)
+    thor (1.4.0)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    useragent (0.16.11)
+    websocket-driver (0.8.0)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  arerd!
+  irb
+  minitest
+  rake
+  sqlite3
+  standard
+
+BUNDLED WITH
+   2.3.27

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Shuhei YOSHIDA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# Arerd
+
+**Arerd** is a Ruby gem that extracts Entity-Relationship (ER) information from your ActiveRecord models and generates clear, visual ER diagrams in [Mermaid](https://mermaid-js.github.io/) format.
+
+Once integrated into your Rails project, Arerd provides a convenient Rake task (`db:erd:mermaid` or `db:erd:markdown`) that outputs a Mermaid-formatted ER diagram directly to your terminal.
+
+You can also automate ER diagram generation in your CI pipeline by outputting the diagram in Markdown format. This ensures your ER diagram documentation is always up to date and easy to maintain.
+
+## Installation
+
+Add Arerd to your Rails application's Gemfile:
+
+```ruby
+gem "arerd"
+```
+
+Then install the gem:
+
+```shell
+bundle install
+```
+
+## Usage
+
+### Generate a Mermaid ER Diagram
+
+Run the following command to create a Mermaid ER diagram:
+
+```shell
+bin/rails db:erd:mermaid
+```
+
+This will output the diagram in Mermaid's `erDiagram` format to standard output. You can copy and paste the result into the [Mermaid Live Editor](https://mermaid.live/) or any Mermaid-compatible tool to visualize your ER diagram.
+
+### Generate a Markdown ER Diagram
+
+To output the ER diagram in Markdown format:
+
+```shell
+bin/rails db:erd:markdown
+```
+
+This command prints the diagram wrapped in triple backticks and tagged as `mermaid`, allowing you to preview it directly in supported Markdown editors or viewers.
+
+### Internationalization (I18n) Support
+
+Table and column names in diagrams are automatically translated using your Rails application's locale files. Arerd leverages Rails' I18n system to provide localized names for entities and attributes, making diagrams more accessible for international teams.
+
+### Notes
+
+* **All associations must specify the `inverse_of` option.**
+* Associations using `has_many :through` are ignored.
+* Polymorphic associations (e.g., `belongs_to :taggable, polymorphic: true`) are not supported.
+
+### Example Output
+
+```mermaid
+erDiagram
+  User["User (ユーザー)"] {
+    integer id PK "Id"
+    string name UK "名前 (indexed)"
+    datetime created_at "作成日時"
+    datetime updated_at "更新日時"
+  }
+  Profile["Profile (プロフィール)"] {
+    integer id PK "Id"
+    integer user_id FK "ユーザーID (indexed)"
+    string bio "自己紹介 (nullable)"
+    datetime created_at "作成日時"
+    datetime updated_at "更新日時"
+  }
+  Post["Post (投稿)"] {
+    integer id PK "Id"
+    string title "タイトル"
+    text body "本文"
+    integer user_id FK "ユーザーID (indexed)"
+    datetime created_at "作成日時"
+    datetime updated_at "更新日時"
+  }
+  Notification["Notification (通知)"] {
+    integer id PK "Id"
+    integer user_id FK "ユーザーID (indexed)"
+    integer sender_id FK "送信者ID (nullable, indexed)"
+    string message "メッセージ"
+    datetime created_at "作成日時"
+    datetime updated_at "更新日時"
+  }
+  Follow["Follow (フォロー)"] {
+    integer id PK "Id"
+    integer follower_id FK "フォロワーID (indexed)"
+    integer followed_id UK "フォロー対象ID (indexed)"
+    datetime created_at "作成日時"
+    datetime updated_at "更新日時"
+  }
+  Community["Community (コミュニティ)"] {
+    integer id PK "Id"
+    string name "名前"
+    datetime created_at "作成日時"
+    datetime updated_at "更新日時"
+  }
+
+  User ||--o{ Post : "posts / user"
+  User ||--o| Profile : "profile / user"
+  User ||--o{ Follow : "follows / follower"
+  User ||--o{ User : "followees / followers"
+  User ||--o{ Follow : "reverse_follows / followee"
+  User ||--o{ User : "followers / followees"
+  User ||--o{ Notification : "notifications / user"
+  User |o--o{ Notification : "sent_notifications / sender"
+  Community }o--o{ User : "users / communities"
+```

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/arerd/association.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Arerd
+  class Association
+    attr_reader :left_model, :left_key, :left_association_name,
+      :right_model, :right_key, :right_association_name,
+      :left_side_multiplicity, :right_side_multiplicity
+
+    def initialize(
+      left_model:,
+      left_key:,
+      left_association_name:,
+      right_model:,
+      right_key:,
+      right_association_name:,
+      left_side_multiplicity:,
+      right_side_multiplicity:
+    )
+      @left_model = left_model
+      @left_key = left_key
+      @left_association_name = left_association_name
+      @right_model = right_model
+      @right_key = right_key
+      @right_association_name = right_association_name
+      @left_side_multiplicity = left_side_multiplicity
+      @right_side_multiplicity = right_side_multiplicity
+    end
+
+    def self.build(association)
+      case association.macro
+      when :has_many
+        return if association.options[:through]
+
+        if association.inverse_of.nil?
+          warn "Association #{association.name} has no inverse association. Skipping association."
+
+          return
+        end
+
+        new(
+          left_model: association.active_record,
+          left_key: association.active_record_primary_key,
+          left_association_name: association.name,
+          right_model: association.class_name.constantize,
+          right_key: association.foreign_key,
+          right_association_name: association.inverse_of.name,
+          left_side_multiplicity: association.inverse_of.options[:optional] ? :optional_one : :one,
+          right_side_multiplicity: :optional_many
+        )
+      when :has_one
+        return if association.options[:through]
+
+        if association.inverse_of.nil?
+          warn "Association #{association.name} has no inverse association. Skipping association."
+
+          return
+        end
+
+        new(
+          left_model: association.active_record,
+          left_key: association.active_record_primary_key,
+          left_association_name: association.name,
+          right_model: association.class_name.constantize,
+          right_key: association.foreign_key,
+          right_association_name: association.inverse_of.name,
+          left_side_multiplicity: association.inverse_of.options[:optional] ? :optional_one : :one,
+          right_side_multiplicity: :optional_one
+        )
+      when :has_and_belongs_to_many
+        if association.inverse_of.nil?
+          warn "Association #{association.name} has no inverse association. Skipping association."
+
+          return
+        end
+
+        return if association.active_record.name > association.class_name # Avoid duplicate associations
+
+        new(
+          left_model: association.active_record,
+          left_key: association.active_record_primary_key,
+          left_association_name: association.name,
+          right_model: association.class_name.constantize,
+          right_key: association.foreign_key,
+          right_association_name: association.inverse_of.name,
+          left_side_multiplicity: :optional_many,
+          right_side_multiplicity: :optional_many
+        )
+      when :belongs_to
+        if association.options[:polymorphic]
+          warn "Polymorphic associations are not supported yet. Skipping association #{association.name}."
+
+          return
+        end
+
+        if association.inverse_of.nil?
+          warn "Association #{association.name} has no inverse association."
+        end
+      else
+        warn "Unknown association type: #{association.macro} for #{association.name} in #{left_model.name}"
+      end
+    end
+
+    def self.build_associations_from_models(models)
+      models.flat_map(&:reflect_on_all_associations).map { |association|
+        build(association)
+      }.compact
+    end
+  end
+end

data/lib/arerd/erd_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module Arerd
+  class ErdGenerator
+    MERMAID_TEMPLATE_PATH = File.expand_path("./templates/erd.mmd.erb", __dir__)
+    MARKDOWN_TEMPLATE_PATH = File.expand_path("./templates/erd.md.erb", __dir__)
+
+    def self.generate_markdown(models:, associations:)
+      mermaid = generate_mermaid(models:, associations:)
+
+      template = File.read(MARKDOWN_TEMPLATE_PATH)
+      ERB.new(template, trim_mode: "-").result_with_hash(mermaid:)
+    end
+
+    def self.generate_mermaid(models:, associations:)
+      template = File.read(MERMAID_TEMPLATE_PATH)
+      ERB.new(template, trim_mode: "-").result_with_hash(models:, associations:)
+    end
+
+    def self.collect_models_and_associations
+      Rails.application.eager_load!
+
+      models = ApplicationRecord.descendants
+
+      associations = Arerd::Association.build_associations_from_models(models)
+
+      {models:, associations:}
+    end
+  end
+end

data/lib/arerd/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Arerd
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load "arerd/tasks/erd.rake"
+    end
+  end
+end

data/lib/arerd/tasks/erd.rake

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "arerd/erd_generator"
+
+namespace :db do
+  desc "Output ERD as Mermaid to STDOUT"
+  namespace :erd do
+    task mermaid: :environment do
+      models, associations = Arerd::ErdGenerator.collect_models_and_associations.values_at(:models, :associations)
+      puts Arerd::ErdGenerator.generate_mermaid(models:, associations:)
+    end
+
+    task markdown: :environment do
+      models, associations = Arerd::ErdGenerator.collect_models_and_associations.values_at(:models, :associations)
+      puts Arerd::ErdGenerator.generate_markdown(models:, associations:)
+    end
+  end
+end

data/lib/arerd/templates/erd.md.erb

@@ -0,0 +1,3 @@
+```mermaid
+<%= mermaid -%>
+```

data/lib/arerd/templates/erd.mmd.erb

@@ -0,0 +1,43 @@
+erDiagram
+<%- models.each do |model| -%>
+  <%- foreign_keys = model.reflect_on_all_associations.map(&:foreign_key).uniq -%>
+  <%- indexes = (model.connection.indexes(model.table_name) rescue []) -%>
+  <%- unique_columns = (indexes.select(&:unique).flat_map(&:columns) rescue []) -%>
+  <%= model.name %>["<%= [model.name, "(#{model.model_name.human})"].compact.join(" ") %>"] {
+  <%- model.columns.each do |column| -%>
+    <%= [
+      column.type,
+      column.name,
+      if model.primary_key == column.name
+        "PK"
+      elsif foreign_keys.include?(column.name)
+        "FK"
+      elsif unique_columns.include?(column.name)
+        "UK"
+      end,
+      "\"#{
+        model.human_attribute_name(column.name)
+      }#{
+        [
+          column.null ? "nullable" : nil,
+          (indexes.any? { |idx| idx.columns.include?(column.name) } ? "indexed" : nil),
+        ].compact.join(", ").then { |c| c == "" ? "" : " (#{c})" }
+      }\"",
+    ].compact.join(" ") %>
+  <%- end -%>
+  }
+<%- end -%>
+
+<%- associations.each do |association| -%>
+  <%=
+    association.left_model.name
+  %> <%=
+    { one: "||", many: "}o", optional_one: "|o", optional_many: "}o" }[association.left_side_multiplicity]
+  %>--<%=
+    { one: "||", many: "o{", optional_one: "o|", optional_many: "o{" }[association.right_side_multiplicity]
+  %> <%=
+    association.right_model.name
+  %> : "<%=
+    "#{association.left_association_name} / #{association.right_association_name}"
+  %>"
+<%- end -%>

data/lib/arerd/version.rb

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

data/lib/arerd.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "arerd/association"
+require_relative "arerd/erd_generator"
+require_relative "arerd/version"
+
+module Arerd
+  class Error < StandardError; end
+end
+
+require "arerd/railtie" if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: arerd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shuhei YOSHIDA
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: sqlite3
+  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: Provides a Rake task (db:erd) that extracts Entity-Relationship information
+  from ActiveRecord and outputs an E-R diagram in Mermaid notation.
+email:
+- contact@yantene.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/compose.yaml"
+- ".devcontainer/devcontainer.json"
+- ".devcontainer/fish/conf.d/abbrs.fish"
+- ".devcontainer/fish/functions/git.fish"
+- ".devcontainer/post_create.fish"
+- ".editorconfig"
+- ".standard.yml"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/arerd.rb
+- lib/arerd/association.rb
+- lib/arerd/erd_generator.rb
+- lib/arerd/railtie.rb
+- lib/arerd/tasks/erd.rake
+- lib/arerd/templates/erd.md.erb
+- lib/arerd/templates/erd.mmd.erb
+- lib/arerd/version.rb
+homepage: https://github.com/yantene/arerd
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/yantene/arerd
+  source_code_uri: https://github.com/yantene/arerd
+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.27
+signing_key:
+specification_version: 4
+summary: Rails gem for generating ERD from ActiveRecord in Mermaid format
+test_files: []