aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Kadwill <tomkadwill@gmail.com>2014-08-12 12:31:59 +0100
committerTom Kadwill <tomkadwill@gmail.com>2014-08-19 21:51:11 +0100
commit58557179f8b957f2e140e363c482082a37220ad1 (patch)
treeb324eb2fc954eee6dfdec43c3e41e7fb62d75b22
parent9424b48d39fc2f646f34ffb088568a148313c0e8 (diff)
downloadrails-58557179f8b957f2e140e363c482082a37220ad1.tar.gz
rails-58557179f8b957f2e140e363c482082a37220ad1.tar.bz2
rails-58557179f8b957f2e140e363c482082a37220ad1.zip
[ci skip] Added documentation for belongs_to scope parameter
-rw-r--r--activerecord/lib/active_record/associations.rb11
1 files changed, 11 insertions, 0 deletions
diff --git a/activerecord/lib/active_record/associations.rb b/activerecord/lib/active_record/associations.rb
index 1c5a737696..e73b855241 100644
--- a/activerecord/lib/active_record/associations.rb
+++ b/activerecord/lib/active_record/associations.rb
@@ -1366,6 +1366,17 @@ module ActiveRecord
# * <tt>Post#create_author!</tt> (similar to <tt>post.author = Author.new; post.author.save!; post.author</tt>)
# The declaration can also include an +options+ hash to specialize the behavior of the association.
#
+ # === Scopes
+ #
+ # You can pass a second argument +scope+ as a callable (i.e. proc or
+ # lambda) to retrieve a specific record or customize the generated query
+ # when you access the associated object.
+ #
+ # Scope examples:
+ # belongs_to :user, -> { where(id: 2) }
+ # belongs_to :user, -> { joins(:friends) }
+ # belongs_to :level, ->(level) { where("game_level > ?", level.current) }
+ #
# === Options
#
# [:class_name]