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

Constant Summary

Constants included from Finders

Finders::RANGE_MAP

Constants included from Persistence

Persistence::UNIX_EPOCH_DATE

Constants included from Fields

Fields::PERMITTED_KEY_TYPES

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, #update!, #write_attribute

Methods included from IdentityMap

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

Methods included from Validations

#save, #save!, #valid?

Methods included from Persistence

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

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



228
229
230
231
232
233
234
235
 
# File 'lib/dynamoid/document.rb', line 228

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

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


237
238
239
 
# File 'lib/dynamoid/document.rb', line 237

def eql?(other)
  self == other
end

#hash ⇒ Object 



241
242
243
 
# File 'lib/dynamoid/document.rb', line 241

def hash
  hash_key.hash ^ range_value.hash
end

#hash_key ⇒ Object

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

Since:

  • 0.4.0



261
262
263
 
# File 'lib/dynamoid/document.rb', line 261

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



268
269
270
 
# File 'lib/dynamoid/document.rb', line 268

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



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/dynamoid/document.rb', line 205

def initialize(attrs = {})
  # we need this hack for Rails 4.0 only
  # because `run_callbacks` calls `attributes` getter while it is still nil
  @attributes = {}

  run_callbacks :initialize do
    @new_record = true
    @attributes ||= {}
    @associations ||= {}

    load(attrs)
  end
end

#load(attrs) ⇒ Object 



219
220
221
222
223
 
# File 'lib/dynamoid/document.rb', line 219

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

#range_value ⇒ Object 



272
273
274
275
276
 
# File 'lib/dynamoid/document.rb', line 272

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

#range_value=(value) ⇒ Object 



278
279
280
 
# File 'lib/dynamoid/document.rb', line 278

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. This is a consistent read.

Returns:

Since:

  • 0.2.0



251
252
253
254
255
256
 
# File 'lib/dynamoid/document.rb', line 251

def reload
  range_key_value = range_value ? dumped_range_value : nil
  self.attributes = self.class.find(hash_key, range_key: range_key_value, consistent_read: true).attributes
  @associations.values.each(&:reset)
  self
end