Skip to content
This repository
tag: v3.0.9.rc3
Fetching contributors…

Cannot retrieve contributors at this time

file 51 lines (49 sloc) 1.455 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
module ActiveModel
  # == Active Model Conversions
  #
  # Handles default conversions: to_model, to_key and to_param.
  #
  # == Example
  #
  # Let's take for example this non persisted object.
  #
  # class ContactMessage
  # include ActiveModel::Conversion
  #
  # # ContactMessage are never persisted in the DB
  # def persisted?
  # false
  # end
  # end
  #
  # cm = ContactMessage.new
  # cm.to_model == self # => true
  # cm.to_key # => nil
  # cm.to_param # => nil
  #
  module Conversion
    # If your object is already designed to implement all of the Active Model
    # you can use the default to_model implementation, which simply returns
    # self.
    #
    # If your model does not act like an Active Model object, then you should
    # define <tt>:to_model</tt> yourself returning a proxy object that wraps
    # your object with Active Model compliant methods.
    def to_model
      self
    end

    # Returns an Enumerable of all key attributes if any is set, regardless
    # if the object is persisted or not.
    #
    # Note the default implementation uses persisted? just because all objects
    # in Ruby 1.8.x responds to :id.
    def to_key
      persisted? ? [id] : nil
    end

    # Returns a string representing the object's key suitable for use in URLs,
    # or nil if persisted? is false
    def to_param
      persisted? ? to_key.join('-') : nil
    end
  end
end
Something went wrong with that request. Please try again.