diff options
| author | Zachary Scott <e@zzak.io> | 2014-06-11 11:32:50 -0700 |
|---|---|---|
| committer | Zachary Scott <e@zzak.io> | 2014-06-11 11:32:50 -0700 |
| commit | eec571f99248e5eff42824fb3aa967fc2ac18f4a (patch) | |
| tree | a134d947bd63b67e0126f115d6fe55372d2fb527 /activemodel | |
| parent | 0a77b467b40d34d3cf70fa8ddc515fc33f51f43b (diff) | |
| parent | bb075e3839d9eea2be5cb0cbed50dafa2c14bb37 (diff) | |
| download | rails-eec571f99248e5eff42824fb3aa967fc2ac18f4a.tar.gz rails-eec571f99248e5eff42824fb3aa967fc2ac18f4a.tar.bz2 rails-eec571f99248e5eff42824fb3aa967fc2ac18f4a.zip | |
Merge pull request #15646 from aditya-kapoor/correct-conversion-docs
[ci skip] correct docs for conversion
Diffstat (limited to 'activemodel')
| -rw-r--r-- | activemodel/lib/active_model/conversion.rb | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/activemodel/lib/active_model/conversion.rb b/activemodel/lib/active_model/conversion.rb index 374265f0d8..9c9b6f4a77 100644 --- a/activemodel/lib/active_model/conversion.rb +++ b/activemodel/lib/active_model/conversion.rb @@ -40,13 +40,15 @@ module ActiveModel self end - # Returns an Enumerable of all key attributes if any is set, regardless if + # Returns an Array of all key attributes if any is set, regardless if # the object is persisted or not. Returns +nil+ if there are no key attributes. # - # class Person < ActiveRecord::Base + # class Person + # include ActiveModel::Conversion + # attr_accessor :id # end # - # person = Person.create + # person = Person.create(id: 1) # person.to_key # => [1] def to_key key = respond_to?(:id) && id @@ -56,10 +58,15 @@ module ActiveModel # Returns a +string+ representing the object's key suitable for use in URLs, # or +nil+ if <tt>persisted?</tt> is +false+. # - # class Person < ActiveRecord::Base + # class Person + # include ActiveModel::Conversion + # attr_accessor :id + # def persisted? + # true + # end # end # - # person = Person.create + # person = Person.create(id: 1) # person.to_param # => "1" def to_param (persisted? && key = to_key) ? key.join('-') : nil |