Module: CouchbaseOrm::Changeable

Extended by:
ActiveSupport::Concern
Included in:
Document
Defined in:
lib/couchbase-orm/changeable.rb

Overview

Defines behavior for dirty tracking.

Defined Under Namespace

Modules: ClassMethods Classes: Anything

Instance Method Summary collapse

Instance Method Details

#_children ⇒ Object 



30
31
32
 
# File 'lib/couchbase-orm/changeable.rb', line 30

def _children
  attributes.select { |name, _value| self.class.type_for_attribute(name) == CouchbaseOrm::NestedDocument }
end

#attribute_before_last_save(attr) ⇒ Object

Returns the original value of an attribute before the last save.

This method is useful in after callbacks to get the original value of

an attribute before the save that triggered the callbacks to run.

Parameters:

  • attr (Symbol | String) —

    The name of the attribute.

Returns:

  • (Object) —

    Value of the attribute before the last save.



140
141
142
 
# File 'lib/couchbase-orm/changeable.rb', line 140

def attribute_before_last_save(attr)
  attributes_before_last_save[attr]
end

#changed ⇒ Array<String>

Get the changed attributes for the document.

Examples:

Get the changed attributes.

model.changed

Returns:

  • (Array<String>) —

    The changed attributes.



16
17
18
 
# File 'lib/couchbase-orm/changeable.rb', line 16

def changed
  changed_attributes.keys.select { |attr| attribute_change(attr) }
end

#changed? ⇒ true | false

Has the document changed?

Examples:

Has the document changed?

model.changed?

Returns:

  • (true | false) —

    If the document is changed.



26
27
28
 
# File 'lib/couchbase-orm/changeable.rb', line 26

def changed?
  changes.values.any? { |val| val } || children_changed?
end

#changed_attributes ⇒ Hash<String, Object>

Get the attribute changes.

Examples:

Get the attribute changes.

model.changed_attributes

Returns:

  • (Hash<String, Object>) —

    The attribute changes.



49
50
51
 
# File 'lib/couchbase-orm/changeable.rb', line 49

def changed_attributes
  @changed_attributes ||= {}
end

#changes ⇒ Hash<String, Array<Object, Object> ] The changes.

Get all the changes for the document.

Examples:

Get all the changes.

model.changes

Returns:

  • (Hash<String, Array<Object, Object> ] The changes.) —

    Hash<String, Array<Object, Object> ] The changes.



59
60
61
62
63
64
 
# File 'lib/couchbase-orm/changeable.rb', line 59

def changes
  changed.each_with_object({}) do |attr, changes|
    change = attribute_change(attr)
    changes[attr] = change if change
  end.with_indifferent_access
end

#changes_applied ⇒ Object 



81
82
83
 
# File 'lib/couchbase-orm/changeable.rb', line 81

def changes_applied
  move_changes
end

#children_changed? ⇒ true | false

Note:

This intentionally only considers children and not descendants.

Have any children (embedded documents) of this document changed?

Returns:

  • (true | false) —

    If any children have changed.



39
40
41
 
# File 'lib/couchbase-orm/changeable.rb', line 39

def children_changed?
  _children.any?(&:changed?)
end

#move_changes ⇒ Object

Call this method after save, so the changes can be properly switched.

This will unset the memoized children array, set new record flag to false, set the document as validated, and move the dirty changes.

Examples:

Move the changes to previous.

person.move_changes



73
74
75
76
77
78
79
 
# File 'lib/couchbase-orm/changeable.rb', line 73

def move_changes
  @changes_before_last_save = @previous_changes
  @previous_changes = changes
  @attributes_before_last_save = @previous_attributes
  @previous_attributes = attributes.dup
  changed_attributes.clear
end

#previous_changes ⇒ Hash<String, Array<Object, Object> ] The previous changes.

Get the previous changes on the document.

Examples:

Get the previous changes.

model.previous_changes

Returns:

  • (Hash<String, Array<Object, Object> ] The previous changes.) —

    Hash<String, Array<Object, Object> ] The previous changes.



102
103
104
 
# File 'lib/couchbase-orm/changeable.rb', line 102

def previous_changes
  @previous_changes ||= {}
end

#reset_object! ⇒ Object Also known as: clear_changes_information 



85
86
87
88
89
90
91
 
# File 'lib/couchbase-orm/changeable.rb', line 85

def reset_object!
  # @attributes = attributes
  # @attributes_before_type_cast = @attributes.dup
  @changed_attributes = {}
  @previous_changes = {}
  @previous_attributes = {}
end

#saved_change_to_attribute(attr) ⇒ Array<Object> | nil

Returns the change to an attribute during the last save.

Parameters:

  • attr (Symbol | String) —

    The name of the attribute.

Returns:

  • (Array<Object> | nil) —

    If the attribute was changed, returns an array containing the original value and the saved value, otherwise nil.



150
151
152
 
# File 'lib/couchbase-orm/changeable.rb', line 150

def saved_change_to_attribute(attr)
  previous_changes[attr]
end

#saved_change_to_attribute?(attr, from: Utils::PLACEHOLDER, to: Utils::PLACEHOLDER) ⇒ true | false

Returns whether this attribute changed during the last save.

This method is useful in after callbacks, to see the change

in an attribute during the save that triggered the callbacks to run.

Parameters:

  • attr (String) —

    The name of the attribute.

  • from (Object) (defaults to: Utils::PLACEHOLDER) —

    The object the attribute was changed from (optional).

  • to (Object) (defaults to: Utils::PLACEHOLDER) —

    The object the attribute was changed to (optional).

Returns:

  • (true | false) —

    Whether the attribute has changed during the last save.



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/couchbase-orm/changeable.rb', line 164

def saved_change_to_attribute?(attr, from: Utils::PLACEHOLDER, to: Utils::PLACEHOLDER)
  changes = saved_change_to_attribute(attr)
  return false unless changes.is_a?(Array)

  return true if Utils.placeholder?(from) && Utils.placeholder?(to)
  return changes.first == from if Utils.placeholder?(to)
  return changes.last == to if Utils.placeholder?(from)

  changes.first == from && changes.last == to
end

#setters ⇒ Hash

Gets all the new values for each of the changed fields, to be passed to a CouchbaseOrm $set modifier.

Examples:

Get the setters for the atomic updates.

person = Person.new(:title => "Sir")
person.title = "Madam"
person.setters # returns { "title" => "Madam" }

Returns:

  • (Hash) —

    A Hash of atomic setters.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/couchbase-orm/changeable.rb', line 115

def setters
  mods = {}
  changes.each_pair do |name, changes|
    next unless changes

    old, new = changes
    field = fields[name]
    key = atomic_attribute_name(name)
    if field&.resizable?
      field.add_atomic_changes(self, name, key, mods, new, old)
    else
      mods[key] = new unless atomic_unsets.include?(key)
    end
  end
  mods
end

#will_save_change_to_attribute?(attr, **kwargs) ⇒ true | false

Returns whether this attribute change the next time we save.

This method is useful in validations and before callbacks to determine

if the next call to save will change a particular attribute.

Parameters:

  • attr (String) —

    The name of the attribute.

  • **kwargs —

    The optional keyword arguments.

Returns:

  • (true | false) —

    Whether the attribute change the next time we save.



187
188
189
 
# File 'lib/couchbase-orm/changeable.rb', line 187

def will_save_change_to_attribute?(attr, **kwargs)
  attribute_changed?(attr, **kwargs)
end