Module: Dynamoid::Document

Extended by:
ActiveSupport::Concern
Includes:
Components
Defined in:
lib/dynamoid/document.rb

Overview

This is the base module for all domain objects that need to be persisted to the database as documents.

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary

Attributes included from Persistence

#new_record

Attributes included from Fields

#attributes

Instance Method Summary collapse

Methods included from Dirty

#clear_changes, #save, #write_attribute

Methods included from IdentityMap

clear, #delete, #identity_map, #identity_map_key, models, #save

Methods included from Validations

#save, #save!, #valid?

Methods included from Persistence

#delete, #destroy, #dump, #persisted?, #save, #touch, #update, #update!

Methods included from Indexes

#delete_indexes, #save_indexes

Methods included from Fields

#read_attribute, #update_attribute, #update_attributes, #write_attribute

Instance Method Details

#==(other) ⇒ Object

An object is equal to another object if their ids are equal.

Since:

  • 0.2.0



124
125
126
127
128
129
130
131
 
# File 'lib/dynamoid/document.rb', line 124

def ==(other)
  if self.class.identity_map_on?
    super
  else
    return false if other.nil?
    other.respond_to?(:hash_key) && other.hash_key == self.hash_key
  end
end

#hash_key ⇒ Object

Return an object’s hash key, regardless of what it might be called to the object.

Since:

  • 0.4.0



148
149
150
 
# File 'lib/dynamoid/document.rb', line 148

def hash_key
  self.send(self.class.hash_key)
end

#hash_key=(value) ⇒ Object

Assign an object’s hash key, regardless of what it might be called to the object.

Since:

  • 0.4.0



155
156
157
 
# File 'lib/dynamoid/document.rb', line 155

def hash_key=(value)
  self.send("#{self.class.hash_key}=", value)
end

#initialize(attrs = {}) ⇒ Dynamoid::Document

Initialize a new object.

Parameters:

  • attrs (Hash) (defaults to: {}) —

    Attributes with which to create the object.

Returns:

Since:

  • 0.2.0



105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/dynamoid/document.rb', line 105

def initialize(attrs = {})
  run_callbacks :initialize do
    self.class.send(:field, self.class.hash_key) unless self.respond_to?(self.class.hash_key)

    @new_record = true
    @attributes ||= {}
    @associations ||= {}

    load(attrs)
  end
end

#load(attrs) ⇒ Object 



117
118
119
 
# File 'lib/dynamoid/document.rb', line 117

def load(attrs)
  self.class.undump(attrs).each {|key, value| send "#{key}=", value }
end

#range_value ⇒ Object 



159
160
161
162
163
 
# File 'lib/dynamoid/document.rb', line 159

def range_value
  if range_key = self.class.range_key
    self.send(range_key)
  end
end

#range_value=(value) ⇒ Object 



165
166
167
 
# File 'lib/dynamoid/document.rb', line 165

def range_value=(value)
  self.send("#{self.class.range_key}=", value)
end

#reload ⇒ Dynamoid::Document

Reload an object from the database – if you suspect the object has changed in the datastore and you need those changes to be reflected immediately, you would call this method.

Returns:

Since:

  • 0.2.0



139
140
141
142
143
 
# File 'lib/dynamoid/document.rb', line 139

def reload
  self.attributes = self.class.find(hash_key, :range_key => range_value).attributes
  @associations.values.each(&:reset)
  self
end