Fixes Rails/RelativeDateConstant offense #12601
Merged
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
- Cop: Rails/RelativeDateConstant - raises offense if Constant is relative data (ie: since, ago) - Reason: relative data will be evaluated only once - BUT here, Date should not be evaluated in a class method, and have a different - value for each call. But the data should be the same for an instance - Therefore: move the ago in init method - Cf. https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsrelativedateconstant - Since there is no constant to be called form a class, but a date from an instance, the spec has been modified accordingly. The RemoveTransientData.new.call had to be splitted.
23 tasks
chahmedejaz
approved these changes
Jun 21, 2024
| Spree::StateChange.where("created_at < ?", RETENTION_PERIOD).delete_all | ||
| Spree::LogEntry.where("created_at < ?", RETENTION_PERIOD).delete_all | ||
| Session.where("updated_at < ?", RETENTION_PERIOD).delete_all | ||
| Spree::StateChange.where("created_at < ?", @expiration_date).delete_all |
There was a problem hiding this comment.
It would be great if we could use the attr_reader for @expiration_date in this class as well i.e. expiration_date.
rioug
requested changes
Jun 24, 2024
There was a problem hiding this comment.
Good one, thanks @cyrillefr 🙏 , could you just address @chahmedejaz comment ?
- replace direct instance variable use by instance getter use
chahmedejaz
approved these changes
Jun 24, 2024
rioug
approved these changes
Jun 24, 2024
rioug
added
the
technical changes only
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.
What? Why?
Contributes to #11482
The: Rails/RelativeDateConstant Cop checks whether constant value isn’t relative date. Because the relative date will be evaluated only once.
Constant is relative date : Constant.since or Constant.ago.
However here, expiration date should stay the same for the same instance hence, in init.
Spec has been modified accordingly
What should we test?
Nothing.
Automatic specs should all pass.
Release notes
Changelog Category (reviewers may add a label for the release notes):
The title of the pull request will be included in the release notes.
Dependencies
Documentation updates