TEST_CODEOWNERS/rails
3
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Provide guidance for renaming classes in polymorphic associations [ci skip]

Browse Source 
Add guidance to the Association Basics and `.belongs_to` method
documentation to encourage the renaming of a model's Ruby class to
coincide with updates to the existing data in the database.

Since Action Text and Active Storage rely on polymorphic associations,
add similar warnings to their guides.

Co-authored-by: Petrik de Heus <petrik@deheus.net>
Co-authored-by: Stephen Hanson <s.hanson5@gmail.com>
Co-authored-by: zzak <zzakscott@gmail.com>
This commit is contained in:
Sean Doyle 2023-12-05 14:42:06 -05:00
parent f0d66d6c47
commit 0d8b3f09af
6 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
actiontext/lib/action_text/attribute.rb
View File

@ -34,6 +34,11 @@ module Attribute
# * <tt>:strict_loading</tt> - Pass true to force strict loading. When
# omitted, <tt>strict_loading:</tt> will be set to the value of the
# <tt>strict_loading_by_default</tt> class attribute (false by default).
#
# Note: Action Text relies on polymorphic associations, which in turn store class names in the database.
# When renaming classes that use <tt>has_rich_text</tt>, make sure to also update the class names in the
# <tt>action_text_rich_texts.record_type</tt> polymorphic type column of
# the corresponding rows.
def has_rich_text(name, encrypted: false, strict_loading: strict_loading_by_default)
class_eval <<-CODE, __FILE__, __LINE__ + 1
def #{name}

2
activerecord/lib/active_record/associations.rb
View File

@ -1825,6 +1825,8 @@ def has_one(name, scope = nil, **options)
# Specify this association is a polymorphic association by passing +true+.
# Note: If you've enabled the counter cache, then you may want to add the counter cache attribute
# to the +attr_readonly+ list in the associated classes (e.g. <tt>class Post; attr_readonly :comments_count; end</tt>).
# Note: Since polymorphic associations rely on storing class names in the database, make sure to update the class names in the
# <tt>*_type</tt> polymorphic type column of the corresponding rows.
# [+:validate+]
# When set to +true+, validates new objects added to association when saving the parent object. +false+ by default.
# If you want to ensure associated objects are revalidated on every update, use +validates_associated+.

8
activestorage/lib/active_storage/attached/model.rb
View File

@ -97,6 +97,10 @@ module Attached::Model
# has_one_attached :avatar, strict_loading: true
# end
#
# Note: Active Storage relies on polymorphic associations, which in turn store class names in the database.
# When renaming classes that use <tt>has_one_attached</tt>, make sure to also update the class names in the
# <tt>active_storage_attachments.record_type</tt> polymorphic type column of
# the corresponding rows.
def has_one_attached(name, dependent: :purge_later, service: nil, strict_loading: false)
ActiveStorage::Blob.validate_service_configuration(service, self, name) unless service.is_a?(Proc)
@ -188,6 +192,10 @@ def #{name}=(attachable)
# has_many_attached :photos, strict_loading: true
# end
#
# Note: Active Storage relies on polymorphic associations, which in turn store class names in the database.
# When renaming classes that use <tt>has_many</tt>, make sure to also update the class names in the
# <tt>active_storage_attachments.record_type</tt> polymorphic type column of
# the corresponding rows.
def has_many_attached(name, dependent: :purge_later, service: nil, strict_loading: false)
ActiveStorage::Blob.validate_service_configuration(service, self, name) unless service.is_a?(Proc)

2
guides/source/action_text_overview.md
View File

@ -106,6 +106,8 @@ class MessagesController < ApplicationController
end
```
NOTE: Since Action Text relies on polymorphic associations, and [polymorphic associations](./association_basics.html#polymorphic-associations) rely on storing class names in the database, that data must remain synchronized with the class name used by the Ruby code. When renaming classes that use `has_rich_text`, make sure to also update the class names in the `action_text_rich_texts.record_type` polymorphic type column of the corresponding rows.
[`rich_text_area`]: https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-rich_text_area
## Rendering Rich Text Content

3
guides/source/active_storage_overview.md
View File

@ -475,6 +475,8 @@ end
Rails will enqueue a job to generate the variant after the attachment is attached to the record.
NOTE: Since Active Storage relies on polymorphic associations, and [polymorphic associations](./association_basics.html#polymorphic-associations) rely on storing class names in the database, that data must remain synchronized with the class name used by the Ruby code. When renaming classes that use `has_one_attached`, make sure to also update the class names in the `active_storage_attachments.record_type` polymorphic type column of the corresponding rows.
[`has_one_attached`]: https://api.rubyonrails.org/classes/ActiveStorage/Attached/Model.html#method-i-has_one_attached
[Attached::One#attach]: https://api.rubyonrails.org/classes/ActiveStorage/Attached/One.html#method-i-attach
[Attached::One#attached?]: https://api.rubyonrails.org/classes/ActiveStorage/Attached/One.html#method-i-attached-3F
@ -549,6 +551,7 @@ end
[Attached::Many#attach]: https://api.rubyonrails.org/classes/ActiveStorage/Attached/Many.html#method-i-attach
[Attached::Many#attached?]: https://api.rubyonrails.org/classes/ActiveStorage/Attached/Many.html#method-i-attached-3F
NOTE: Since Active Storage relies on polymorphic associations, and [polymorphic associations](./association_basics.html#polymorphic-associations) rely on storing class names in the database, that data must remain synchronized with the class name used by the Ruby code. When renaming classes that use `has_many_attached`, make sure to also update the class names in the `active_storage_attachments.record_type` polymorphic type column of the corresponding rows.
### Attaching File/IO Objects

5
guides/source/association_basics.md
View File

@ -538,6 +538,11 @@ class CreatePictures < ActiveRecord::Migration[7.2]
end
```
NOTE: Since polymorphic associations rely on storing class names in the
database, that data must remain synchronized with the class name used by the
Ruby code. When renaming a class, make sure to update the data in the
polymorphic type column.
![Polymorphic Association Diagram](images/association_basics/polymorphic.png)
### Associations between Models with Composite Primary Keys