Repository navigation
Generate reset token finders for has_secure_password - #2750
Open
RaphaelFakhri wants to merge 1 commit into
Open
RaphaelFakhri wants to merge 1 commit into
RaphaelFakhri wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or 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
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
Since Rails 8.0,
has_secure_passwordon an Active Record model definesfind_by_<attribute>_reset_tokenandfind_by_<attribute>_reset_token!class methods. TheActiveModelSecurePasswordcompiler only reads theInstanceMethodsOnActivationmodules, so the finders are missing from the generated RBI, and calls likeUser.find_by_password_reset_token(token)fail with "Method does not exist" in Sorbet.Implementation
For every
<attribute>_reset_tokenmethod the compiler already finds, it checks whether the model responds tofind_by_<attribute>_reset_token. If it does, the compiler adds both finders as class methods:find_by_<attribute>_reset_token(token)returnsT.nilable(Model), backed byfind_by_token_for.find_by_<attribute>_reset_token!(token)returnsModel, backed byfind_by_token_for!.The
respond_to?check keeps plain Active Model classes and models withreset_token: falseunchanged, because Rails only defines the finders when the class supportsgenerates_token_for.Tests
Added a spec for an Active Record model with
has_secure_passwordthat asserts the finders are generated. The spec fails without the compiler change and passes with it. The existing specs for plain Active Model classes still pass unchanged.Fixes #2749