Document the real meaning of checkout#set_state_if_present #3406
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
The fact that is intended to stop customers from skipping ahead is not easily drawn out by the method name or the contents. Renaming & refactoring both have risks, so, for now, I'll content myself with a comment.
kennyadsl
approved these changes
Oct 26, 2019
| # Allow the customer to only go back or stay on the current state | ||
| # when trying to change it via params[:state]. It's not allowed to | ||
| # jump forward and skip states (unless #skip_state_validation? is | ||
| # truthy). | ||
| def set_state_if_present |
There was a problem hiding this comment.
What about also changing this method name? We could keep this one so that it only prints the deprecation message and call the new one, WDYT?
There was a problem hiding this comment.
I'd be very much in favor of doing so! I'll make a note to do another PR with the full deprecation work.
kennyadsl
changed the title
elia
added a commit
to nebulab/solidus
that referenced
this pull request
Jan 29, 2020
The original name was quite detached from what the method is doing. Ref: solidusio#3406 (comment)
5 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.
Description
The fact that this method intended to stop customers from skipping ahead is not
easily drawn out by the method name or the contents.
Renaming & refactoring both have risks, so, for now, I'll content
myself with a comment.
Checklist: