Add foreign_key_exists? method.
#18662
Conversation
|
@estum thank you for your work. Would you mind sharing some use-cases where you can see this being useful? |
|
@senny I was missing a method like |
| # foreign_key_exists?(:accounts, name: "special_fk_name") | ||
| # | ||
| def foreign_key_exists?(from_table, options_or_to_table = {}) | ||
| return unless supports_foreign_keys? |
There was a problem hiding this comment.
We should probably return false instead of nil here to maintain convention with most Ruby .exist? functions.
There was a problem hiding this comment.
@ianks that's not necessary. Rails does not make the promise of returning real booleans from predicate methods.
There was a problem hiding this comment.
Is there a particular reason for now? I would consider it an anti-pattern to return nil from a predicate method as it makes it harder to reason about the function.
There was a problem hiding this comment.
@ianks there is a section on booleans in our API documentation guidelines.
Add `foreign_key_exists?` method.
|
@estum great work! 💛 I added a CHANGELOG entry and made some minor changes in the merge commit (removed trailing whitespace, replaced The extraction of |
| @@ -650,6 +658,10 @@ def remove_references(*args) | |||
| def foreign_key(*args) # :nodoc: | |||
| @base.add_foreign_key(name, *args) | |||
| end | |||
|
|
|||
| def foreign_key_exists?(*args) # :nodoc: | |||
There was a problem hiding this comment.
@senny Is this # :nodoc: intentional? Or should we make this method publicly documented?
There was a problem hiding this comment.
@claudiob I think it was due to the fact that foreign_key had a no-doc as well. It was previously only used by references. Should be fine to document them though.
No description provided.