Skip to content

Conversation

@bdurand
Copy link
Owner

@bdurand bdurand commented Jan 3, 2026

Added

  • The default data directory for support table data in Rails applications will be set to db/support_tables. This can also be overridden by setting the config.support_table_data_directory configuration option in the Rails application.
  • Added rake task support_table_data:add_yard_docs for Rails applications that will add YARD documentation to support table models for the named instance helpers.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a rake task for generating YARD documentation for support table model helper methods and establishes a configurable default data directory for Rails applications.

Key Changes

  • Introduces support_table_data:add_yard_docs rake task that automatically generates YARD documentation comments for named instance helper methods
  • Sets the default data directory to db/support_tables via a configurable Rails option (config.support_table_data_directory)
  • Refactors test models from inline definitions to separate files using autoload for better organization

Reviewed changes

Copilot reviewed 41 out of 43 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
lib/support_table_data/documentation/yard_doc.rb Generates YARD documentation strings for named instance methods, predicates, and attribute helpers
lib/support_table_data/documentation/source_file.rb Manages source file reading/writing and intelligently inserts/updates YARD docs with marker comments
lib/support_table_data/documentation.rb Module entry point that requires documentation components
lib/tasks/support_table_data.rake Adds new add_yard_docs task and refactors eager loading logic
lib/tasks/utils.rb Utility methods for Rails eager loading and finding support table models with their file paths
lib/support_table_data/railtie.rb Configures default data directory via Rails config initializer
spec/support_table_data/documentation/yard_doc_spec.rb Comprehensive tests for YARD documentation generation
spec/support_table_data/documentation/source_file_spec.rb Tests for source file manipulation and YARD doc insertion/updating
spec/models/*.rb Refactored model definitions into separate files
spec/models.rb Converted to use autoload for lazy loading test models
test_app/ Complete test Rails application to validate rake task functionality
README.md Documents the new YARD documentation feature and config option
CHANGELOG.md Records changes for version 1.4.1
.github/workflows/continuous_integration.yml Adds ActiveRecord 8.1 compatibility testing

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

bdurand and others added 8 commits January 3, 2026 17:30
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@bdurand bdurand merged commit cb6c77c into main Jan 5, 2026
7 checks passed
@bdurand bdurand deleted the yard-generation branch January 5, 2026 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants