Fix defect where aliased attribute methods on abstract classes were not being defined #48991
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…eing not defined rails/rails@a88f47d fixed an issue where subclasses were regenerating aliased attribute methods defined on parent classes. Part of the solution was to call #generate_alias_attributes recursively on a class's superclass to generate all the alias attributes in the inheritance hierarchy. However, the implementation relies on #base_class to determine if we should call #generate_alias_attributes on the superclass. Since all models that inherit from abstract classes are base classes, this means that #generate_alias_attributes will never be called on abstract classes, meaning no method will be generated for any alias attributes defined on them. To fix this issue, we should always call #generate_alias_attributes on the superclass unless the superclass is ActiveRecord::Base.
nvasilevski
reviewed
Aug 21, 2023
| @@ -65,7 +65,7 @@ def eagerly_generate_alias_attribute_methods(_new_name, _old_name) # :nodoc: | |||
| end | |||
|
|
|||
| def generate_alias_attributes # :nodoc: | |||
| superclass.generate_alias_attributes unless base_class? | |||
| superclass.generate_alias_attributes unless superclass == Base | |||
There was a problem hiding this comment.
cc: @ipc103
Sorry I was the one suggesting to use base_class? in #48913 (comment) but I had wrong understanding of its behavior so superclass compared to AR::Base is the more correct check here, as you initially did!
There was a problem hiding this comment.
I definitely missed that as well! Thank you @andrewn617 for the quick fix ❤️
4 tasks
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation / Background
This Pull Request has been created because of a defect where no methods for alias attributes defined on an abstract class are being generated.
Detail
a88f47d fixed an issue where subclasses were regenerating aliased attribute methods defined on parent classes. Part of the solution was to call
#generate_alias_attributesrecursively on a class's superclass to generate all the alias attributes in the inheritance hierarchy. However, the implementation relies on#base_classto determine if we should call#generate_alias_attributeson the superclass. Since all models that inherit from abstract classes are base classes, this means that#generate_alias_attributeswill never be called on abstract classes, meaning no method will be generated for any alias attributes defined on them.To fix this issue, we should always call
#generate_alias_attributeson the superclass unless the superclass isActiveRecord::Base.Additional information
The docs about how
base_classwork are somewhat unclear. I plan to open a separate PR to try to improve them.Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]