Module Sequel::Plugins::Dirty::InstanceMethods
In: lib/sequel/plugins/dirty.rb

Methods

Attributes

previous_changes  [R]  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']

[Source]

    # File lib/sequel/plugins/dirty.rb, line 62
62:         def column_change(column)
63:           [initial_value(column), get_column_value(column)] if column_changed?(column)
64:         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

[Source]

    # File lib/sequel/plugins/dirty.rb, line 84
84:         def column_changed?(column)
85:           initial_values.has_key?(column)
86:         end

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

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

[Source]

    # File lib/sequel/plugins/dirty.rb, line 70
70:         def column_changes
71:           h = {}
72:           initial_values.each do |column, value|
73:             h[column] = [value, get_column_value(column)]
74:           end
75:           h
76:         end

Freeze internal data structures

[Source]

    # File lib/sequel/plugins/dirty.rb, line 89
89:         def freeze
90:           initial_values.freeze
91:           missing_initial_values.freeze
92:           @previous_changes.freeze if @previous_changes
93:           super
94:         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'

[Source]

     # File lib/sequel/plugins/dirty.rb, line 101
101:         def initial_value(column)
102:           initial_values.fetch(column){get_column_value(column)}
103:         end

A hash with column symbol keys and initial values.

  initial_values # {:name => 'Initial'}

[Source]

     # File lib/sequel/plugins/dirty.rb, line 108
108:         def initial_values
109:           @initial_values ||= {}
110:         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'

[Source]

     # File lib/sequel/plugins/dirty.rb, line 117
117:         def reset_column(column)
118:           if initial_values.has_key?(column)
119:             set_column_value("#{column}=""#{column}=", initial_values[column])
120:           end
121:           if missing_initial_values.include?(column)
122:             values.delete(column)
123:           end
124:         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']

[Source]

     # File lib/sequel/plugins/dirty.rb, line 132
132:         def will_change_column(column)
133:           changed_columns << column unless changed_columns.include?(column)
134:           check_missing_initial_value(column)
135: 
136:           value = if initial_values.has_key?(column)
137:             initial_values[column]
138:           else
139:             get_column_value(column)
140:           end
141: 
142:           initial_values[column] = if value && value != true && value.respond_to?(:clone)
143:             begin
144:               value.clone
145:             rescue TypeError
146:               value
147:             end
148:           else
149:             value
150:           end
151:         end

[Validate]