support_table_data 1.3.1 → 1.5.0

data/lib/tasks/support_table_data.rake

@@ -3,18 +3,9 @@
 namespace :support_table_data do
   desc "Syncronize data for all models that include SupportTableData."
   task sync: :environment do
-    # Eager load models if we are in a Rails enviroment with eager loading turned off.
-    if defined?(Rails.application)
-      unless Rails.application.config.eager_load
-        if defined?(Rails.application.eager_load!)
-          Rails.application.eager_load!
-        elsif defined?(Rails.autoloaders.zeitwerk_enabled?) && Rails.autoloaders.zeitwerk_enabled?
-          Rails.autoloaders.each(&:eager_load)
-        else
-          warn "Could not eager load models; some support table data may not load"
-        end
-      end
-    end
+    require_relative "utils"
+
+    SupportTableData::Tasks::Utils.eager_load!
 
     logger_callback = lambda do |name, started, finished, unique_id, payload|
       klass = payload[:class]
@@ -31,4 +22,56 @@ namespace :support_table_data do
       SupportTableData.sync_all!
     end
   end
+
+  namespace :yard_docs do
+    desc "Adds YARD documentation comments to models to document the named instance methods."
+    task add: :environment do
+      require_relative "../support_table_data/documentation"
+      require_relative "utils"
+
+      SupportTableData::Tasks::Utils.eager_load!
+      SupportTableData::Tasks::Utils.support_table_sources.each do |source_file|
+        next if source_file.yard_docs_up_to_date?
+
+        source_file.path.write(source_file.source_with_yard_docs)
+        puts "Added YARD documentation to #{source_file.klass.name}."
+      end
+    end
+
+    desc "Removes YARD documentation comments added by support_table_data from models."
+    task remove: :environment do
+      require_relative "../support_table_data/documentation"
+      require_relative "utils"
+
+      SupportTableData::Tasks::Utils.eager_load!
+      SupportTableData::Tasks::Utils.support_table_sources.each do |source_file|
+        next unless source_file.has_yard_docs?
+
+        source_file.path.write(source_file.source_without_yard_docs)
+        puts "Removed YARD documentation from #{source_file.klass.name}."
+      end
+    end
+
+    desc "Verify that all the support table models have up to date YARD documentation for named instance methods."
+    task verify: :environment do
+      require_relative "../support_table_data/documentation"
+      require_relative "utils"
+
+      SupportTableData::Tasks::Utils.eager_load!
+
+      all_up_to_date = true
+      SupportTableData::Tasks::Utils.support_table_sources.each do |source_file|
+        unless source_file.yard_docs_up_to_date?
+          puts "YARD documentation is not up to date for #{source_file.klass.name}."
+          all_up_to_date = false
+        end
+      end
+
+      if all_up_to_date
+        puts "All support table models have up to date YARD documentation."
+      else
+        raise "Run bundle exec rails support_table_data:yard_docs:add to update the documentation."
+      end
+    end
+  end
 end

data/lib/tasks/utils.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module SupportTableData
+  module Tasks
+    module Utils
+      class << self
+        # Helper for eager loading a Rails application.
+        def eager_load!
+          return unless defined?(Rails.application.config.eager_load)
+          return if Rails.application.config.eager_load
+
+          if defined?(Rails.application.eager_load!)
+            Rails.application.eager_load!
+          elsif defined?(Rails.autoloaders.zeitwerk_enabled?) && Rails.autoloaders.zeitwerk_enabled?
+            Rails.autoloaders.each(&:eager_load)
+          else
+            raise "Failed to eager load application."
+          end
+        end
+
+        # Return a hash mapping all models that include SupportTableData to their source file paths.
+        #
+        # @return [Array<SupportTableData::Documentation::SourceFile>]
+        def support_table_sources
+          sources = []
+
+          ActiveRecord::Base.descendants.each do |klass|
+            next unless klass.included_modules.include?(SupportTableData)
+
+            begin
+              next if klass.instance_names.empty?
+            rescue NoMethodError
+              # Skip models where instance_names is not properly initialized
+              next
+            end
+
+            file_path = SupportTableData::Tasks::Utils.model_file_path(klass)
+            next unless file_path&.file? && file_path.readable?
+
+            sources << Documentation::SourceFile.new(klass, file_path)
+          end
+
+          sources
+        end
+
+        def model_file_path(klass)
+          file_path = "#{klass.name.underscore}.rb"
+          model_path = nil
+
+          Rails.application.config.paths["app/models"].each do |path_prefix|
+            path = Pathname.new(path_prefix.to_s).join(file_path)
+            if path&.file? && path.readable?
+              model_path = path
+              break
+            end
+          end
+
+          model_path
+        end
+      end
+    end
+  end
+end

data/support_table_data.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     "homepage_uri" => spec.homepage,
     "source_code_uri" => spec.homepage,
-    "changelog_uri" => "#{spec.homepage}/blob/master/CHANGELOG.md"
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
   }
 
   # Specify which files should be added to the gem when it is released.
@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.5"
 
-  spec.add_dependency "activerecord"
+  spec.add_dependency "activerecord", ">= 6"
 
   spec.add_development_dependency "bundler"
 end

data/test_app/.gitignore

@@ -0,0 +1,4 @@
+log/*.log
+tmp/
+doc/
+db/*.sqlite3

data/test_app/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 8.1.1"
+
+gem "sqlite3", "~> 2.9.0"
+
+gem "support_table_data", path: ".."

data/test_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/test_app/app/models/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/test_app/app/models/secondary_application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class SecondaryApplicationRecord < ApplicationRecord
+  self.abstract_class = true
+
+  connects_to database: {writing: :secondary, reading: :secondary}
+end

data/test_app/app/models/status.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Status < ApplicationRecord
+  include SupportTableData
+
+  self.support_table_key_attribute = :code
+  add_support_table_data "statuses.yml"
+  named_instance_attribute_helpers :name
+
+  validates :code, presence: true, uniqueness: true
+end

data/test_app/app/models/thing.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Thing < SecondaryApplicationRecord
+  include SupportTableData
+
+  self.support_table_key_attribute = :id
+  add_support_table_data "things.yml"
+
+  validates :name, presence: true, uniqueness: true
+end

data/test_app/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/test_app/config/application.rb

@@ -0,0 +1,42 @@
+require_relative "boot"
+
+require "rails"
+# Pick the frameworks you want:
+# require "active_model/railtie"
+# require "active_job/railtie"
+require "active_record/railtie"
+# require "active_storage/engine"
+# require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "action_mailbox/engine"
+# require "action_text/engine"
+# require "action_view/railtie"
+# require "action_cable/engine"
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module TestApp
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 8.1
+
+    # Please, add to the `ignore` list any other `lib` subdirectories that do
+    # not contain `.rb` files, or that should not be reloaded or eager loaded.
+    # Common ones are `templates`, `generators`, or `middleware`, for example.
+    config.autoload_lib(ignore: %w[assets tasks])
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    config.eager_load_paths << Rails.root.join("app", "configurations")
+
+    # Don't generate system test files.
+    config.generators.system_tests = nil
+  end
+end

data/test_app/config/boot.rb

@@ -0,0 +1,3 @@
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "bundler/setup" # Set up gems listed in the Gemfile.

data/test_app/config/database.yml

@@ -0,0 +1,17 @@
+development:
+  primary:
+    adapter: sqlite3
+    database: db/development.sqlite3
+  secondary:
+    adapter: sqlite3
+    database: db/secondary_development.sqlite3
+    migrations_paths: db/secondary_migrate
+
+test:
+  primary:
+    adapter: sqlite3
+    database: db/test.sqlite3
+  secondary:
+    adapter: sqlite3
+    database: db/secondary_test.sqlite3
+    migrations_paths: db/secondary_migrate

data/test_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test_app/config/environments/development.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Make code changes take effect immediately without server restart.
+  config.enable_reloading = true
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+end

data/test_app/config/environments/test.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Make code changes take effect immediately without server restart.
+  config.enable_reloading = true
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+end

data/test_app/config.ru

@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+# run Rails.application
+# Rails.application.load_server

data/test_app/db/migrate/20260103060951_create_status.rb

@@ -0,0 +1,8 @@
+class CreateStatus < ActiveRecord::Migration[8.1]
+  def change
+    create_table :statuses do |t|
+      t.string :code, null: false, index: {unique: true}
+      t.string :name, null: false, index: {unique: true}
+    end
+  end
+end

data/test_app/db/schema.rb

@@ -0,0 +1,20 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[8.1].define(version: 2026_01_03_060951) do
+  create_table "statuses", force: :cascade do |t|
+    t.string "code", null: false
+    t.string "name", null: false
+    t.index ["code"], name: "index_statuses_on_code", unique: true
+    t.index ["name"], name: "index_statuses_on_name", unique: true
+  end
+end

data/test_app/db/secondary_migrate/20260104000001_create_things.rb

@@ -0,0 +1,7 @@
+class CreateThings < ActiveRecord::Migration[8.1]
+  def change
+    create_table :things do |t|
+      t.string :name, null: false, index: {unique: true}
+    end
+  end
+end

data/test_app/db/secondary_schema.rb

@@ -0,0 +1,25 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[8.1].define(version: 2026_01_04_000001) do
+  create_table "statuses", force: :cascade do |t|
+    t.string "code", null: false
+    t.string "name", null: false
+    t.index ["code"], name: "index_statuses_on_code", unique: true
+    t.index ["name"], name: "index_statuses_on_name", unique: true
+  end
+
+  create_table "things", force: :cascade do |t|
+    t.string "name", null: false
+    t.index ["name"], name: "index_things_on_name", unique: true
+  end
+end

data/test_app/db/support_tables/statuses.yml

@@ -0,0 +1,19 @@
+pending:
+  code: pending
+  name: Pending
+
+active:
+  code: active
+  name: Active
+
+completed:
+  code: completed
+  name: Completed
+
+canceled:
+  code: canceled
+  name: Canceled
+
+failed:
+  code: failed
+  name: Failed

data/test_app/db/support_tables/things.yml

@@ -0,0 +1,5 @@
+- id: 1
+  name: Thing One
+
+- id: 2
+  name: Thing Two

data/test_app/lib/tasks/database.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+if Rake::Task.task_defined?("db:migrate")
+  Rake::Task["db:migrate"].enhance do
+    # The main database connection may have artifacts from the migration, so re-establish it
+    # to get a clean connection before syncing support table data.
+    ActiveRecord::Base.establish_connection
+
+    Rake::Task["support_table_data:sync"].invoke
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: support_table_data
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,29 +37,57 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - bbdurand@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- AGENTS.md
+- ARCHITECTURE.md
 - CHANGELOG.md
 - MIT-LICENSE.txt
 - README.md
 - VERSION
 - lib/support_table_data.rb
+- lib/support_table_data/documentation.rb
+- lib/support_table_data/documentation/source_file.rb
+- lib/support_table_data/documentation/yard_doc.rb
 - lib/support_table_data/railtie.rb
+- lib/support_table_data/validation_error.rb
 - lib/tasks/support_table_data.rake
+- lib/tasks/utils.rb
 - support_table_data.gemspec
+- test_app/.gitignore
+- test_app/Gemfile
+- test_app/Rakefile
+- test_app/app/models/application_record.rb
+- test_app/app/models/secondary_application_record.rb
+- test_app/app/models/status.rb
+- test_app/app/models/thing.rb
+- test_app/bin/rails
+- test_app/config.ru
+- test_app/config/application.rb
+- test_app/config/boot.rb
+- test_app/config/database.yml
+- test_app/config/environment.rb
+- test_app/config/environments/development.rb
+- test_app/config/environments/test.rb
+- test_app/db/migrate/20260103060951_create_status.rb
+- test_app/db/schema.rb
+- test_app/db/secondary_migrate/20260104000001_create_things.rb
+- test_app/db/secondary_schema.rb
+- test_app/db/support_tables/statuses.yml
+- test_app/db/support_tables/things.yml
+- test_app/lib/tasks/database.rake
+- test_app/log/.keep
 homepage: https://github.com/bdurand/support_table_data
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/bdurand/support_table_data
   source_code_uri: https://github.com/bdurand/support_table_data
-  changelog_uri: https://github.com/bdurand/support_table_data/blob/master/CHANGELOG.md
-post_install_message:
+  changelog_uri: https://github.com/bdurand/support_table_data/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Extension for ActiveRecord models to manage synchronizing data in support/lookup
   tables across environments. Also provides the ability to directly reference and