mermaid_erd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4173a04658fdd3df40665fad885d894fef4fa18360f6042957ab649af1f9a740
+  data.tar.gz: 83857a699138a58476968f44e221a9b268f0973e3fa11ae2709141397972e3b3
+SHA512:
+  metadata.gz: 68e1cc8ba51f13ac889c7e73f8850b4bf732245f3f6330b75bae224b69026b5f5e49bbc4357d20c0e7b963b0b0665446b1866b4398b8bedb53ee4a7a86b86876
+  data.tar.gz: 9b1bdfea5aa64c9053193bd374ee53971575278522c7e906b787073782233cc030a00a64354f037b3b7f8092281a2ce350ccb717b4331f0762647c3476edf9df

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-12-18
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Avin Hurry
+
+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,173 @@
+# MermaidErd
+
+Generate Mermaid-compatible Entity Relationship Diagrams (ERDs) from your Rails models, with support for excluding specific models. Designed for modern Rails apps using Active Record.
+
+## Features
+
+- Outputs a Mermaid `erDiagram` to `documentation/domain-model.md`
+- Includes all Active Record models with a database table
+- Excludes models listed in `config/mermaid_erd.yml` under `exclude`
+- Visualises `belongs_to` associations
+- Run via a Rake task (`rake erd:generate`)
+- Adds a post-migration reminder in development
+
+## Requirements
+
+- Ruby 3.4+
+- Rails 8+
+- PostgreSQL (uses array/enum column support)
+
+## Installation
+
+Add this line to the development section of your Gemfile:
+
+```ruby
+  gem "mermaid_erd"
+```
+
+Then install:
+
+```bash
+bundle install
+```
+
+Alternatively, install it directly:
+
+```bash
+gem install mermaid_erd
+```
+
+## Usage
+
+Run the following Rake task to generate the ERD:
+
+```bash
+bundle exec rake erd:generate
+```
+
+This will output a Mermaid diagram to:
+
+```
+documentation/domain-model.md
+```
+
+### Customization
+
+You can customize which models to exclude by creating a file at:
+
+```yaml
+# config/mermaid_erd.yml
+
+exclude:
+  - ActiveStorage::*
+  - SolidQueue::*
+  - Blazer::*
+```
+You can limit to specific models:
+
+```yaml
+# config/mermaid_erd.yml
+
+only:
+  - Order
+  - Customer
+  - Product
+```
+
+### Post-Migration Reminder
+
+To remind developers to regenerate the diagram after each migration, this gem automatically hooks into `db:migrate` and prints a message like:
+
+```
+[ℹ] If this migration added or modified database tables, consider:
+    • Updating the Mermaid ER diagram: bundle exec rake erd:generate
+    • Excluding models in: config/mermaid_erd.yml
+```
+
+> ⚠ This task only runs in the development environment.
+
+## Output Example
+
+Example output (`documentation/domain-model.md`):
+
+```mermaid
+erDiagram
+  Saiyan {
+    integer id
+    string name
+    enum rank
+    integer power_level
+    boolean tail
+    datetime born_at
+    datetime created_at
+    datetime updated_at
+  }
+
+  Planet {
+    integer id
+    string name
+    boolean destroyed
+    datetime created_at
+    datetime updated_at
+  }
+
+  Transformation {
+    integer id
+    integer saiyan_id
+    enum form
+    integer power_multiplier
+    datetime achieved_at
+    datetime created_at
+    datetime updated_at
+  }
+
+  Battle {
+    integer id
+    string location
+    enum outcome
+    datetime started_at
+    datetime finished_at
+    datetime created_at
+    datetime updated_at
+  }
+
+  BattleParticipation {
+    integer id
+    integer battle_id
+    integer fighter_id
+    enum fighter_type
+    integer damage_dealt
+    boolean defeated
+    datetime created_at
+    datetime updated_at
+  }
+
+  Sensei {
+    integer id
+    string name
+    string technique_speciality
+    datetime created_at
+    datetime updated_at
+  }
+
+  TrainingSession {
+    integer id
+    integer saiyan_id
+    integer sensei_id
+    integer planet_id
+    integer duration_days
+    integer power_gained
+    datetime started_at
+    datetime finished_at
+    datetime created_at
+    datetime updated_at
+  }
+
+  Saiyan }o--|| Planet : belongs_to
+  Transformation }o--|| Saiyan : belongs_to
+  TrainingSession }o--|| Saiyan : belongs_to
+  TrainingSession }o--|| Sensei : belongs_to
+  TrainingSession }o--|| Planet : belongs_to
+  BattleParticipation }o--|| Battle : belongs_to
+  BattleParticipation }o--|| Saiyan : belongs_to
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/mermaid_erd/generator.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Generates a Mermaid ERD to documentation/domain-model.md
+# Excludes models listed in config/mermaid_erd.yml under `exclude`
+
+module MermaidErd
+  class Generator
+    def initialize(config_path:, output_path:)
+      @config_path = config_path
+      @output_path = output_path
+      config = load_config(config_path)
+      @exclusions = config.fetch("exclude", [])
+      @inclusions = parse_inclusions(config)
+    end
+
+    def generate
+      raise "[⚠] Mermaid ERD generation is only allowed in development environment" unless Rails.env.development?
+
+      Rails.application.eager_load!
+      models = load_models
+      lines = [ "```mermaid", "erDiagram" ]
+
+      models.each do |model|
+        next unless model.table_exists?
+
+        sanitized_name = sanitize(model.name)
+        lines << "  #{sanitized_name} {"
+        model.columns.each do |column|
+          base_type = column.type.to_s
+          type = column.array ? "array[#{base_type}]" : base_type
+          lines << "    #{type} #{column.name}"
+        end
+
+        lines << "  }"
+
+        model.reflect_on_all_associations(:belongs_to).each do |assoc|
+          next if assoc.polymorphic?
+
+          klass_name = assoc.class_name.to_s.strip
+          next if klass_name.empty?
+
+          to = sanitize(klass_name)
+          next if excluded?(klass_name)
+          next unless included?(klass_name)
+
+          lines << "  #{sanitized_name} }o--|| #{to} : belongs_to"
+        end
+      end
+
+      lines << "```"
+      FileUtils.mkdir_p(@output_path.dirname)
+      File.write(@output_path, lines.join("\n"))
+    end
+
+    private
+
+    def sanitize(name)
+      name.gsub("::", "_")
+    end
+
+    def excluded?(model_name)
+      @exclusions.any? { |pattern| File.fnmatch(pattern, model_name) }
+    end
+
+    def included?(model_name)
+      return true if @inclusions.empty?
+
+      @inclusions.any? { |pattern| File.fnmatch(pattern, model_name) }
+    end
+
+    def load_models
+      ActiveRecord::Base.descendants.reject do |model|
+        model.abstract_class? ||
+          excluded?(model.name) ||
+          !included?(model.name) ||
+          model.name.start_with?("HABTM_")
+      end
+    end
+
+    def parse_inclusions(config)
+      only = config["only"]
+
+      case only
+      when String
+        only.split(",").map(&:strip).reject(&:empty?)
+      when Array
+        only.map(&:to_s).map(&:strip).reject(&:empty?)
+      else
+        []
+      end
+    end
+
+    def load_config(config_path)
+      return {} unless File.exist?(config_path)
+
+      YAML.safe_load_file(config_path, aliases: true) || {}
+    rescue Psych::SyntaxError => e
+      raise "YAML syntax error in #{config_path}: #{e.message}"
+    end
+  end
+end

data/lib/mermaid_erd/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MermaidErd
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path("../tasks/mermaid_erd.rake", __dir__)
+    end
+  end
+end

data/lib/mermaid_erd/version.rb

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

data/lib/mermaid_erd.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "mermaid_erd/version"
+require_relative "mermaid_erd/generator"
+require_relative "mermaid_erd/railtie" if defined?(Rails::Railtie)
+
+module MermaidErd
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/tasks/mermaid_erd.rake

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+namespace :erd do
+  desc "Generate Mermaid entity relationship diagram"
+  task generate: :environment do
+    unless Rails.env.development?
+      puts "[⚠] Mermaid ERD generation is only allowed in development environment"
+      next
+    end
+
+    require "mermaid_erd/generator"
+
+    config_path = Rails.root.join("config/mermaid_erd.yml")
+    output_path = Rails.root.join("documentation/domain-model.md")
+
+    MermaidErd::Generator.new(
+      config_path:,
+      output_path:
+    ).generate
+
+    puts "[✔] Mermaid ERD diagram added to: #{output_path.relative_path_from(Rails.root)}"
+  end
+
+  namespace :post_migrate do
+    desc "Show a reminder to update the Mermaid ER diagram after migrations"
+    task reminder: :environment do
+      if $stdout.tty?
+        cyan = "\e[36m"
+        bold = "\e[1m"
+        reset = "\e[0m"
+      else
+        cyan = bold = reset = ""
+      end
+
+      puts "\n#{bold}#{cyan}[ℹ] If this migration added or modified database tables, consider:#{reset}"
+      puts "    • Updating the Mermaid ER diagram: #{bold}bundle exec rake erd:generate#{reset}"
+      puts "    • Excluding models in: #{bold}config/mermaid_erd.yml#{reset}\n\n"
+    end
+  end
+end
+
+if Rails.env.development?
+  Rake::Task["db:migrate"].enhance do
+    Rake::Task["erd:post_migrate:reminder"].invoke
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: mermaid_erd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Avin Hurry
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: Generate Mermaid ER diagrams from Rails models as Markdown-friendly output
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mermaid_erd.rb
+- lib/mermaid_erd/generator.rb
+- lib/mermaid_erd/railtie.rb
+- lib/mermaid_erd/version.rb
+- lib/tasks/mermaid_erd.rake
+homepage: https://github.com/avinhurry/mermaid_erd
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/avinhurry/mermaid_erd
+  changelog_uri: https://github.com/avinhurry/mermaid_erd/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Generate Mermaid ER diagrams for Rails models in Markdown
+test_files: []