Improve PaymentMethod docs and add some deprecations #2650
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
houndci-bot
reviewed
Mar 26, 2018
| def find_with_destroyed(*args) | ||
| Spree::Deprecation.warn "#{to_s}.find_with_destroyed is deprecated. Use #{to_s}.with_deleted.find instead" |
There was a problem hiding this comment.
Use self instead of Object#to_s in interpolation.
| def active? | ||
| Spree::Deprecation.warn "#{to_s}.active? is deprecated. Use #{to_s}.active.any? instead" |
There was a problem hiding this comment.
Use self instead of Object#to_s in interpolation.
We were only using it from a helper, which is unnecessary now that the payment.payment_method association includes deleted payment methods.
jhawthorn
force-pushed
the
payment_methods_docs
branch
from
e2e6901 to
aaed1ec
Compare
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.
This deprecates some things that I don't think should be used:
PaymentMethod::DISPLAY(shouldn't be useful anymore).active?, which we weren't using and I think is more readable as.active.any?find_with_destroyed, which we weren't using and I think is more readable as.with_deleted.findThis fixes the yard syntax and properly marks the deprecated methods as deprecated