Module: Sequel::Plugins::Dirty::InstanceMethods

Defined in:
lib/sequel/plugins/dirty.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#previous_changesObject (readonly)

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.


62
63
64
# File 'lib/sequel/plugins/dirty.rb', line 62

def previous_changes
  @previous_changes
end

Instance Method Details

#after_saveObject

Reset the initial values after saving.


65
66
67
68
# File 'lib/sequel/plugins/dirty.rb', line 65

def after_save
  super
  reset_initial_values
end

#after_updateObject

Save the current changes so they are available after updating. This happens before after_save resets them.


72
73
74
75
# File 'lib/sequel/plugins/dirty.rb', line 72

def after_update
  super
  @previous_changes = column_changes
end

#column_change(column) ⇒ Object

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']

82
83
84
# File 'lib/sequel/plugins/dirty.rb', line 82

def column_change(column)
  [initial_value(column), get_column_value(column)] if column_changed?(column)
end

#column_changed?(column) ⇒ Boolean

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

Returns:

  • (Boolean)

104
105
106
# File 'lib/sequel/plugins/dirty.rb', line 104

def column_changed?(column)
  initial_values.has_key?(column)
end

#column_changesObject

A hash with column symbol keys and pairs of initial and current values for all changed columns.

column_changes # => {:name => ['Initial', 'Current']}

90
91
92
93
94
95
96
# File 'lib/sequel/plugins/dirty.rb', line 90

def column_changes
  h = {}
  initial_values.each do |column, value|
    h[column] = [value, get_column_value(column)]
  end
  h
end

#freezeObject

Freeze internal data structures


109
110
111
112
113
114
# File 'lib/sequel/plugins/dirty.rb', line 109

def freeze
  initial_values.freeze
  missing_initial_values.freeze
  @previous_changes.freeze if @previous_changes
  super
end

#initial_value(column) ⇒ Object

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'

121
122
123
# File 'lib/sequel/plugins/dirty.rb', line 121

def initial_value(column)
  initial_values.fetch(column){get_column_value(column)}
end

#initial_valuesObject

A hash with column symbol keys and initial values.

initial_values # {:name => 'Initial'}

128
129
130
# File 'lib/sequel/plugins/dirty.rb', line 128

def initial_values
  @initial_values ||= {}
end

#reset_column(column) ⇒ Object

Reset the column to its initial value. If the column was not set initial, removes it from the values.

reset_column(:name)
name # => 'Initial'

137
138
139
140
141
142
143
144
# File 'lib/sequel/plugins/dirty.rb', line 137

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

#will_change_column(column) ⇒ Object

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']

152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/sequel/plugins/dirty.rb', line 152

def will_change_column(column)
  _add_changed_column(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