Module: CouchPotato::Persistence

Defined in:
lib/couch_potato/persistence.rb,
lib/couch_potato/persistence/json.rb,
lib/couch_potato/persistence/callbacks.rb,
lib/couch_potato/persistence/properties.rb,
lib/couch_potato/persistence/type_caster.rb,
lib/couch_potato/persistence/simple_property.rb,
lib/couch_potato/persistence/dirty_attributes.rb,
lib/couch_potato/persistence/active_model_compliance.rb

Defined Under Namespace

Modules: ActiveModelCompliance, Callbacks, DirtyAttributes, Json, Properties Classes: SimpleProperty, TypeCaster

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/couch_potato/persistence.rb', line 20

def self.included(base) #:nodoc:
  base.send :include, Properties, Callbacks, Json, CouchPotato::View::CustomViews, CouchPotato::View::Lists
  base.send :include, DirtyAttributes, GhostAttributes, Attachments
  base.send :include, MagicTimestamps, ActiveModelCompliance
  base.send :include, Validation
  base.class_eval do
    attr_accessor :_id, :_rev, :_deleted, :database
    alias_method :id, :_id
    alias_method :id=, :_id=
  end
end

Instance Method Details

#==(other) ⇒ Object

:nodoc:



97
98
99
 
# File 'lib/couch_potato/persistence.rb', line 97

def ==(other) #:nodoc:
  other.class == self.class && self.to_json == other.to_json
end

#attributes ⇒ Object

returns all of a model’s attributes that have been defined using the #property method as a Hash

example:

class Book
  include CouchPotato::Persistence
  property :title
  property :year
end
book = Book.new :year => 2009
book.attributes # => {:title => nil, :year => 2009}



77
78
79
80
81
82
 
# File 'lib/couch_potato/persistence.rb', line 77

def attributes
  self.class.properties.inject({}) do |res, property|
    property.value(res, self)
    res
  end
end

#attributes=(hash) ⇒ Object

assign multiple attributes at once. the attributes have to be declared using the #property method

example:

class Book
  include CouchPotato::Persistence
  property :title
  property :year
end
book = Book.new
book.attributes = {:title => 'Time to Relax', :year => 2009}
book.title # => 'Time to Relax'
book.year # => 2009



61
62
63
64
65
 
# File 'lib/couch_potato/persistence.rb', line 61

def attributes=(hash)
  hash.each do |attribute, value|
    self.send "#{attribute}=", value
  end
end

#initialize(attributes = {}) ⇒ Object

initialize a new instance of the model optionally passing it a hash of attributes. the attributes have to be declared using the #property method

example: 

class Book
  include CouchPotato::Persistence
  property :title
end
book = Book.new :title => 'Time to Relax'
book.title # => 'Time to Relax'



42
43
44
45
46
 
# File 'lib/couch_potato/persistence.rb', line 42

def initialize(attributes = {})
  attributes.each do |name, value|
    self.send("#{name}=", value)
  end if attributes
end

#inspect ⇒ Object 



101
102
103
104
 
# File 'lib/couch_potato/persistence.rb', line 101

def inspect
  attributes_as_string = attributes.map {|attribute, value| "#{attribute}: #{value.inspect}"}.join(", ")
  %Q{#<#{self.class} _id: "#{_id}", _rev: "#{_rev}", #{attributes_as_string}>}
end

#new? ⇒ Boolean Also known as: new_record?

returns true if a model hasn’t been saved yet, false otherwise

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/couch_potato/persistence.rb', line 85

def new?
  _rev.nil?
end

#to_param ⇒ Object

returns the document id this is used by rails to construct URLs can be overridden to for example use slugs for URLs instead if ids



93
94
95
 
# File 'lib/couch_potato/persistence.rb', line 93

def to_param
  _id
end