Fix doc: set_callback also accepts an array of if: #19595
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
| # callback will be called only when it returns a +false+ value. | ||
| # * <tt>:if</tt> - A symbol, a string or an array of symbols and strings, | ||
| # each naming an instance method or a proc; the callback will be called | ||
| # only when they all return a +true+ value. |
There was a problem hiding this comment.
I think we should not quote true as we are referring to Ruby's definition of a "true value" and not the exact value true.
There was a problem hiding this comment.
I totally agree! I had the same thought when I reviewed my PR 🎀
When Active Record calls `set_callback` inside `after_commit`, [these lines of code](https://github.com/rails/rails/blob/master/activerecord/lib/active_record/transactions.rb#L276) pass an **array** of methods as the `:if` condition: ```ruby options[:if] = Array(options[:if]) options[:if] << "transaction_include_any_action?(#{fire_on})" ``` That made me realize that anyone could pass an **array** of `:if` and `:unless` conditions to `set_callback`, since Active Support transforms these conditions into an array anyways in [these lines of code](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/callbacks.rb#L365): ```ruby @if = Array(options[:if]) @unless = Array(options[:unless]) ``` Long story short, this commit updates the documentation of the `set_callback` method to explain that arrays are also accepted. It also replaces +false+ and +true+ with false and true, since any _falsey_ or _truthy_ value will work. [ci skip]
claudiob
force-pushed
the
fix-docs-set-callback
branch
from
b4e7cb4
to
89389c7
Compare
senny
added a commit
that referenced
this pull request
Mar 31, 2015
Fix doc: set_callback also accepts an array of if:
|
@claudiob thanks man! 💛 |
senny
added a commit
that referenced
this pull request
Mar 31, 2015
Fix doc: set_callback also accepts an array of if:
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.
When Active Record calls
set_callbackinsideafter_commit, these lines of code pass an array of methods as the:ifcondition:That made me realize that anyone could pass an array of
:ifand:unlessconditions toset_callback, since Active Support transforms these conditions into an array anyways in these lines of code:Long story short, this commit updates the documentation of the
set_callbackmethod to explain that arrays are also accepted.It also replaces
+false+and+true+withfalseandtrue, since any falsey or truthy value will work.[ci skip]