Permalink
Browse files

Adding first example with no arguments to AR::Relation#first_or_creat…

…e and removing examples that create several users at the same time (this is confusing and not really helpful).
  • Loading branch information...
1 parent ee822f2 commit d03aff7f645bdc16eae35264bb0e95a0ab814d15 @andmej andmej committed Sep 6, 2011
Showing with 15 additions and 15 deletions.
  1. +15 −15 activerecord/lib/active_record/relation.rb
@@ -99,32 +99,32 @@ def create!(*args, &block)
# Expects arguments in the same format as <tt>Base.create</tt>.
#
# ==== Examples
- # # Find the first user named Scarlett or create a new one.
+ # # Find the first user named Penélope or create a new one.
+ # User.where(:first_name => 'Penélope').first_or_create
+ # # => <User id: 1, first_name: 'Penélope', last_name: nil>
+ #
+ # # Find the first user named Penélope or create a new one.
+ # # We already have one so the existing record will be returned.
+ # User.where(:first_name => 'Penélope').first_or_create
+ # # => <User id: 1, first_name: 'Penélope', last_name: nil>
+ #
+ # # Find the first user named Scarlett or create a new one with a particular last name.
# User.where(:first_name => 'Scarlett').first_or_create(:last_name => 'Johansson')
- # # => <User id: 1, first_name: 'Scarlett', last_name: 'Johansson'>
+ # # => <User id: 2, first_name: 'Scarlett', last_name: 'Johansson'>
#
- # # Find the first user named Scarlett or create one with a different last name.
- # # We already have one Scarlett, so she'll be returned.
+ # # Find the first user named Scarlett or create a new one with a different last name.
+ # # We already have one so the existing record will be returned.
# User.where(:first_name => 'Scarlett').first_or_create do |user|
# user.last_name = "O'Hara"
# end
- # # => <User id: 1, first_name: 'Scarlett', last_name: 'Johansson'>
- #
- # # Find the first user named Andy or create several at a time.
- # User.where(:first_name => 'Andy').first_or_create([{:last_name => 'García'}, {:last_name => 'Mejía'}])
- # # => [#<User id: 2, first_name: 'Andy', last_name: 'García'>,
- # #<User id: 3, first_name: 'Andy', last_name: 'Mejía'>]
- #
- # # Find the first user with last name García or create several at a time.
- # User.where(:last_name => 'García').first_or_create([{:first_name => 'Jorge'}, {:first_name => 'Andy'}])
- # # => <User id: 2, first_name: 'Andy', last_name: 'García'>
+ # # => <User id: 2, first_name: 'Scarlett', last_name: 'Johansson'>
def first_or_create(*args, &block)
first || create(*args, &block)
end
# Like <tt>first_or_create</tt> but calls <tt>create!</tt> so an exception is raised if the created record is invalid.
#
- # Expects arguments in the same format as <tt>Base.create</tt>.
+ # Expects arguments in the same format as <tt>Base.create!</tt>.
def first_or_create!(*args, &block)
first || create!(*args, &block)
end

0 comments on commit d03aff7

Please sign in to comment.