Sha256: b940bc6ce90c6ae9716a12d1f67660aeec7ccbb100961258f818aa6b5515ab80

Contents?: true

Size: 1.42 KB

Versions: 38

Compression:

Stored size: 1.42 KB

Contents

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

Version data entries

38 entries across 38 versions & 1 rubygems

Version Path
activemodel-3.0.8.rc4 lib/active_model/conversion.rb
activemodel-3.0.8.rc2 lib/active_model/conversion.rb
activemodel-3.0.8.rc1 lib/active_model/conversion.rb
activemodel-3.0.7 lib/active_model/conversion.rb
activemodel-3.0.7.rc2 lib/active_model/conversion.rb
activemodel-3.0.7.rc1 lib/active_model/conversion.rb
activemodel-3.0.6 lib/active_model/conversion.rb
activemodel-3.0.6.rc2 lib/active_model/conversion.rb
activemodel-3.0.6.rc1 lib/active_model/conversion.rb
activemodel-3.0.5 lib/active_model/conversion.rb
activemodel-3.0.5.rc1 lib/active_model/conversion.rb
activemodel-3.0.4 lib/active_model/conversion.rb
activemodel-3.0.4.rc1 lib/active_model/conversion.rb
activemodel-3.0.3 lib/active_model/conversion.rb
activemodel-3.0.2 lib/active_model/conversion.rb
activemodel-3.0.1 lib/active_model/conversion.rb
activemodel-3.0.0 lib/active_model/conversion.rb
activemodel-3.0.0.rc2 lib/active_model/conversion.rb