diagrammer 0.1.0

data/lib/diagrammer/model_introspector.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module Diagrammer
+  class ModelIntrospector
+    ASSOCIATION_MACROS = %i[belongs_to has_one has_many has_and_belongs_to_many].freeze
+
+    def initialize(models: nil)
+      @models = models
+    end
+
+    def call
+      eager_load_rails_application
+
+      models = selected_models.sort_by(&:name)
+      {
+        tables: unique_tables(models),
+        relationships: relationships_for(models)
+      }
+    end
+
+    private
+
+    # Several models can share one database table (STI subclasses, gem base
+    # classes such as I18n's Translation, multi-schema rpush models). Emit a
+    # single card per table; associations from every model still merge onto it
+    # via relationships_for, which is keyed by table name.
+    def unique_tables(models)
+      models.each_with_object({}) do |model, by_table|
+        by_table[model.table_name] ||= table_for(model)
+      end.values
+    end
+
+    def eager_load_rails_application
+      return unless defined?(Rails) && Rails.respond_to?(:application)
+
+      Rails.application.eager_load!
+    end
+
+    def selected_models
+      models = @models || active_record_models
+      models.select { |model| concrete_model?(model) }
+    end
+
+    def active_record_models
+      return [] unless defined?(ActiveRecord::Base)
+
+      ActiveRecord::Base.descendants
+    end
+
+    def concrete_model?(model)
+      model.respond_to?(:table_name) &&
+        model.respond_to?(:columns) &&
+        !model.abstract_class? &&
+        model.table_exists?
+    rescue StandardError
+      false
+    end
+
+    def table_for(model)
+      {
+        model_name: model.name,
+        table_name: model.table_name,
+        columns: columns_for(model)
+      }
+    end
+
+    def columns_for(model)
+      primary_key = model.primary_key.to_s
+
+      model.columns.map do |column|
+        {
+          name: column.name,
+          type: column.type.to_s,
+          primary_key: column.name == primary_key,
+          foreign_key: column.name.end_with?('_id')
+        }
+      end
+    end
+
+    def relationships_for(models)
+      table_names = models.to_set(&:table_name)
+      models.flat_map { |model| model_relationships(model, table_names) }.uniq
+    end
+
+    def model_relationships(model, table_names)
+      model.reflect_on_all_associations.filter_map do |association|
+        relationship_for(model, association, table_names)
+      end
+    end
+
+    def relationship_for(model, association, table_names)
+      return unless ASSOCIATION_MACROS.include?(association.macro)
+
+      target_table = association_table_name(association)
+      return unless target_table && table_names.include?(target_table)
+
+      {
+        from: model.table_name,
+        to: target_table,
+        name: association.name.to_s,
+        macro: association.macro
+      }
+    end
+
+    def association_table_name(association)
+      association.klass.table_name
+    rescue StandardError
+      nil
+    end
+  end
+end

data/lib/diagrammer/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Diagrammer
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path('tasks/diagrammer.rake', __dir__)
+    end
+  end
+end

data/lib/diagrammer/tasks/diagrammer.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+namespace :diagrammer do
+  desc 'Generate a standalone HTML database diagram'
+  task :generate, [:output] => :environment do |_task, args|
+    output = args[:output] || Rails.root.join('dbdiagram.html')
+    path = Diagrammer.generate(output: output)
+
+    puts "Generated #{path}"
+  end
+end

data/lib/diagrammer/version.rb

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

data/lib/diagrammer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'diagrammer/version'
+require_relative 'diagrammer/model_introspector'
+require_relative 'diagrammer/html_renderer'
+require_relative 'diagrammer/generator'
+require_relative 'diagrammer/railtie' if defined?(Rails::Railtie)
+
+module Diagrammer
+  class Error < StandardError; end
+
+  def self.generate(output:, models: nil)
+    Generator.new(output: output, models: models).call
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: diagrammer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Andreiev
+bindir: bin
+cert_chain: []
+date: 2026-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.75'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.75'
+description: Diagrammer introspects ActiveRecord models and renders an interactive,
+  fully offline ER diagram as a standalone HTML file, without Graphviz.
+email:
+- andreyev0204@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/diagrammer.rb
+- lib/diagrammer/generator.rb
+- lib/diagrammer/html_renderer.rb
+- lib/diagrammer/model_introspector.rb
+- lib/diagrammer/railtie.rb
+- lib/diagrammer/tasks/diagrammer.rake
+- lib/diagrammer/version.rb
+homepage: https://github.com/alex-andreiev/diagrammer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alex-andreiev/diagrammer
+  source_code_uri: https://github.com/alex-andreiev/diagrammer
+  changelog_uri: https://github.com/alex-andreiev/diagrammer/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.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Generate Rails database relationship diagrams as standalone HTML.
+test_files: []