arerd 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a3364c03a39be5bf9ac0727652516999efb340d3208fd87621556021c28de20
-  data.tar.gz: c84c46b6e3e2fec66857e74c087e5ba6f03b2fe4cc42c3ed99d9997dc5f69038
+  metadata.gz: ac4f8c25a6b90c5fd67ae251935edfaf44bdba168cf9057ba19d957996aac6b9
+  data.tar.gz: 905a00ce024e271515432af6b457e1ee661dc68f382172785ef5f3f577d44283
 SHA512:
-  metadata.gz: 8a634f01c34f49fe14acfcfc9e9d37407723852857b05ab16ecef35ac5f5dfb420a6eeaf5695e156d0ca44e998a8f8df7032d8e3f987ab7b51b77b66c4035dc4
-  data.tar.gz: 46d6acb3f3be56edb6630df0c97ff1a318d73b6aba02b2e009272ae0761bc616896040f6dd12ebc7beb8918845632274f7df9f70044f6ba8f4b5822f8305b1ee
+  metadata.gz: 63dad4d9eee0ce49073f2e3afc4d3fc6697b9d421d209d19db2fa6fe55cdc8e528251ee0c40ca9f0cee32adbb72a44e72d55192a68c142c97d8df7baa9404957
+  data.tar.gz: a07a13531800f47018a60ee69cbfcd31f4fb38b771d3b1b55060eefdb005268e2584313eddc3e2be0418df4569c14c0f6ae34e1a308e86de53e991931b9cef72

data/CLAUDE.md

@@ -0,0 +1,78 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Arerd is a Ruby gem that generates Entity-Relationship (ER) diagrams from ActiveRecord models in Mermaid format. It provides rake tasks (`db:erd:mermaid` and `db:erd:markdown`) that can be used in Rails applications.
+
+## Common Commands
+
+### Development Commands
+- `bundle exec rake test` - Run all tests (Minitest)
+- `bundle exec rake standard` - Run StandardRB linter
+- `bundle exec rake standard:fix` - Auto-fix StandardRB violations
+- `bundle exec rake` - Run both tests and linter (default task)
+
+### Testing in a Rails Application
+To test the gem in a Rails app during development:
+- `bin/rails db:erd:mermaid` - Generate Mermaid diagram to stdout
+- `bin/rails db:erd:markdown` - Generate Markdown-wrapped diagram to stdout
+
+### Running a Single Test
+```bash
+bundle exec ruby -Ilib:test test/test_association.rb
+```
+
+## Code Architecture
+
+### Core Components
+
+#### 1. **Association Model** ([lib/arerd/association.rb](lib/arerd/association.rb))
+The heart of the gem. Represents a bidirectional relationship between two ActiveRecord models. Key characteristics:
+- Stores left/right model pairs with their association names and multiplicities
+- `build` class method converts ActiveRecord reflection objects into Association instances
+- Filters out unsupported association types (`:through`, polymorphic)
+- **Important**: Only creates one Association object per bidirectional relationship by comparing model names lexicographically (line 85) to avoid duplicates in has_and_belongs_to_many
+
+#### 2. **ERD Generator** ([lib/arerd/erd_generator.rb](lib/arerd/erd_generator.rb))
+Orchestrates the diagram generation:
+- `collect_models_and_associations`: Eager loads Rails app, collects all ApplicationRecord descendants, builds Association objects
+- `generate_mermaid`/`generate_markdown`: Renders ERB templates with collected data
+- Templates use Rails I18n (`model_name.human`, `human_attribute_name`) for internationalization
+
+#### 3. **Templates** ([lib/arerd/templates/](lib/arerd/templates/))
+- `erd.mmd.erb`: Generates Mermaid erDiagram syntax
+  - Introspects database for index information to mark FK/UK columns
+  - Maps association multiplicities to Mermaid relationship symbols (||, |o, }o, o{)
+- `erd.md.erb`: Wraps Mermaid output in Markdown code fence
+
+#### 4. **Railtie Integration** ([lib/arerd/railtie.rb](lib/arerd/railtie.rb))
+Minimal Rails integration that loads rake tasks when Rails is present.
+
+### Association Building Logic
+
+The `Association.build` method handles different ActiveRecord association types:
+- **has_many/has_one**: Creates Association from the "owning" side, requires `inverse_of`
+- **has_and_belongs_to_many**: Creates only one Association per pair (avoids duplicates via name comparison)
+- **belongs_to**: Only validates `inverse_of` presence, doesn't create Association (parent association handles it)
+- **Filtered out**: `:through` associations, polymorphic associations
+
+### Test Structure
+
+Tests use Minitest with an in-memory SQLite database:
+- [test/test_helper.rb](test/test_helper.rb): Sets up ActiveRecord connection and I18n
+- [test/support/schema.rb](test/support/schema.rb): Defines test database schema
+- [test/support/models.rb](test/support/models.rb): Defines test ActiveRecord models
+- All test models must include `inverse_of` option per gem requirements
+
+## Important Constraints
+
+1. **All associations must specify `inverse_of` option** - The gem warns and skips associations without it
+2. **has_many :through associations are ignored** - They're considered "virtual" associations
+3. **Polymorphic associations are not supported** - The gem warns and skips them
+4. **ApplicationRecord descendants only** - The gem specifically looks for `ApplicationRecord.descendants`
+
+## StandardRB Linting
+
+This project uses StandardRB for code style. Configuration is minimal (see [.standard.yml](.standard.yml)). Follow StandardRB conventions for all code changes.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    arerd (0.1.0)
+    arerd (0.2.1)
       rails (>= 6.0)
 
 GEM

data/README.md

@@ -109,3 +109,7 @@ erDiagram
   User |o--o{ Notification : "sent_notifications / sender"
   Community }o--o{ User : "users / communities"
 ```
+
+## License
+
+Arerd is available as open source under the terms of the [MIT License](LICENSE).

data/lib/arerd/association.rb

@@ -2,6 +2,8 @@
 
 module Arerd
   class Association
+    include Comparable
+
     attr_reader :left_model, :left_key, :left_association_name,
       :right_model, :right_key, :right_association_name,
       :left_side_multiplicity, :right_side_multiplicity
@@ -26,6 +28,13 @@ module Arerd
       @right_side_multiplicity = right_side_multiplicity
     end
 
+    def <=>(other)
+      return nil unless other.is_a?(Association)
+
+      [left_model.name, right_model.name, left_association_name.to_s, right_association_name.to_s] <=>
+        [other.left_model.name, other.right_model.name, other.left_association_name.to_s, other.right_association_name.to_s]
+    end
+
     def self.build(association)
       case association.macro
       when :has_many

data/lib/arerd/erd_generator.rb

@@ -22,9 +22,11 @@ module Arerd
     def self.collect_models_and_associations
       Rails.application.eager_load!
 
-      models = ApplicationRecord.descendants
+      models = ApplicationRecord.descendants.sort_by(&:name)
 
-      associations = Arerd::Association.build_associations_from_models(models)
+      associations = Arerd::Association
+        .build_associations_from_models(models)
+        .sort
 
       {models:, associations:}
     end

data/lib/arerd/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arerd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Shuhei YOSHIDA
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-21 00:00:00.000000000 Z
+date: 2026-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,8 +38,8 @@ dependencies:
     - - ">="
       - !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.
+description: Provides a Rake task that extracts entity-relationship information from
+  ActiveRecord models and generates an ER diagram in Mermaid notation.
 email:
 - contact@yantene.net
 executables: []
@@ -55,6 +55,7 @@ files:
 - ".editorconfig"
 - ".standard.yml"
 - ".tool-versions"
+- CLAUDE.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -69,7 +70,8 @@ files:
 - lib/arerd/templates/erd.mmd.erb
 - lib/arerd/version.rb
 homepage: https://github.com/yantene/arerd
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/yantene/arerd
@@ -92,5 +94,5 @@ requirements: []
 rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
-summary: Rails gem for generating ERD from ActiveRecord in Mermaid format
+summary: A Rails gem for generating an ERD from ActiveRecord models in Mermaid format
 test_files: []