module Sequel::Plugins::Dirty::InstanceMethods
Attributes
A hash of previous changes before the object was saved, in the same format as column_changes. Note that this is not necessarily the same as the columns that were used in the update statement.
Public Instance Methods
An array with the initial value and the current value of the column, if the column has been changed. If the column has not been changed, returns nil.
column_change(:name) # => ['Initial', 'Current']
# File lib/sequel/plugins/dirty.rb, line 69 def column_change(column) [initial_value(column), get_column_value(column)] if column_changed?(column) end
Either true or false depending on whether the column has changed. Note that this is not exactly the same as checking if the column is in changed_columns, if the column was not set initially.
column_changed?(:name) # => true
# File lib/sequel/plugins/dirty.rb, line 91 def column_changed?(column) initial_values.has_key?(column) end
A hash with column symbol keys and pairs of initial and current values for all changed columns.
column_changes # => {:name => ['Initial', 'Current']}
# File lib/sequel/plugins/dirty.rb, line 77 def column_changes h = {} initial_values.each do |column, value| h[column] = [value, get_column_value(column)] end h end
Freeze internal data structures
# File lib/sequel/plugins/dirty.rb, line 96 def freeze initial_values.freeze missing_initial_values.freeze @previous_changes.freeze if @previous_changes super end
The initial value of the given column. If the column value has not changed, this will be the same as the current value of the column.
initial_value(:name) # => 'Initial'
# File lib/sequel/plugins/dirty.rb, line 108 def initial_value(column) initial_values.fetch(column){get_column_value(column)} end
A hash with column symbol keys and initial values.
initial_values # {:name => 'Initial'}
# File lib/sequel/plugins/dirty.rb, line 115 def initial_values @initial_values ||= {} end
Reset the column to its initial value. If the column was not set initial, removes it from the values.
reset_column(:name) name # => 'Initial'
# File lib/sequel/plugins/dirty.rb, line 124 def reset_column(column) if initial_values.has_key?(column) set_column_value(:"#{column}=", initial_values[column]) end if missing_initial_values.include?(column) values.delete(column) end end
Manually specify that a column will change. This should only be used if you plan to modify a column value in place, which is not recommended.
will_change_column(:name) name.gsub(/i/i, 'o') column_change(:name) # => ['Initial', 'onotoal']
# File lib/sequel/plugins/dirty.rb, line 139 def will_change_column(column) changed_columns << column unless changed_columns.include?(column) check_missing_initial_value(column) value = if initial_values.has_key?(column) initial_values[column] else get_column_value(column) end initial_values[column] = if value && value != true && value.respond_to?(:clone) begin value.clone rescue TypeError value end else value end end
Private Instance Methods
Reset the initial values when setting values.
# File lib/sequel/plugins/dirty.rb, line 163 def _refresh_set_values(hash) reset_initial_values super end
Reset the initial values after saving.
# File lib/sequel/plugins/dirty.rb, line 169 def after_save super reset_initial_values end
Save the current changes so they are available after updating. This happens before #after_save resets them.
# File lib/sequel/plugins/dirty.rb, line 176 def after_update super @previous_changes = column_changes end
When changing the column value, save the initial column value. If the column value is changed back to the initial value, update changed columns to remove the column.
# File lib/sequel/plugins/dirty.rb, line 184 def change_column_value(column, value) if (iv = initial_values).has_key?(column) initial = iv[column] super if value == initial changed_columns.delete(column) unless missing_initial_values.include?(column) iv.delete(column) end else check_missing_initial_value(column) iv[column] = get_column_value(column) super end end
If the values hash does not contain the column, make sure #missing_initial_values does so that it doesn't get deleted from changed_columns if changed back, and so that resetting the column value can be handled correctly.
# File lib/sequel/plugins/dirty.rb, line 202 def check_missing_initial_value(column) unless values.has_key?(column) || (miv = missing_initial_values).include?(column) miv << column end end
Duplicate internal data structures
# File lib/sequel/plugins/dirty.rb, line 209 def initialize_copy(other) super @initial_values = Hash[other.initial_values] @missing_initial_values = other.send(:missing_initial_values).dup @previous_changes = Hash[other.previous_changes] if other.previous_changes self end
Reset the initial values when initializing.
# File lib/sequel/plugins/dirty.rb, line 218 def initialize_set(h) super reset_initial_values end
Array holding column symbols that were not present initially. This is necessary to differentiate between values that were not present and values that were present but equal to nil.
# File lib/sequel/plugins/dirty.rb, line 226 def missing_initial_values @missing_initial_values ||= [] end
Clear the data structures that store the initial values.
# File lib/sequel/plugins/dirty.rb, line 231 def reset_initial_values @initial_values.clear if @initial_values @missing_initial_values.clear if @missing_initial_values end