Module: ActiveRecord::Persistence

Defined in:
activerecord/lib/active_record/persistence.rb

Overview

Active Record Persistence

Instance Method Summary (collapse)

Instance Method Details

- (Object) becomes(klass)

Returns an instance of the specified klass with the attributes of the current record. This is mostly useful in relation to single-table inheritance structures where you want a subclass to appear as the superclass. This can be used along with record identification in Action Pack to allow, say, Client < Company to do something like render :partial => @client.becomes(Company) to render that instance using the companies/company partial instead of clients/client.

Note: The new instance will share a link to the same attributes as the original class. So any change to the attributes in either instance will affect the other.



96
97
98
99
100
101
102
103
 
# File 'activerecord/lib/active_record/persistence.rb', line 96

def becomes(klass)
  became = klass.new
  became.instance_variable_set("@attributes", @attributes)
  became.instance_variable_set("@attributes_cache", @attributes_cache)
  became.instance_variable_set("@new_record", new_record?)
  became.instance_variable_set("@destroyed", destroyed?)
  became
end

- (Object) decrement(attribute, by = 1)

Initializes attribute to zero if nil and subtracts the value passed as by (default is 1). The decrement is performed directly on the underlying attribute, no setter is invoked. Only makes sense for number-based attributes. Returns self.



163
164
165
166
167
 
# File 'activerecord/lib/active_record/persistence.rb', line 163

def decrement(attribute, by = 1)
  self[attribute] ||= 0
  self[attribute] -= by
  self
end

- (Object) decrement!(attribute, by = 1)

Wrapper around decrement that saves the record. This method differs from its non-bang version in that it passes through the attribute setter. Saving is not subjected to validation checks. Returns true if the record could be saved.



173
174
175
 
# File 'activerecord/lib/active_record/persistence.rb', line 173

def decrement!(attribute, by = 1)
  decrement(attribute, by).update_attribute(attribute, self[attribute])
end

- (Object) delete

Deletes the record in the database and freezes this instance to reflect that no changes should be made (since they can't be persisted). Returns the frozen instance.

The row is simply removed with an SQL DELETE statement on the record's primary key, and no callbacks are executed.

To enforce the object's before_destroy and after_destroy callbacks, Observer methods, or any :dependent association options, use #destroy.



69
70
71
72
73
 
# File 'activerecord/lib/active_record/persistence.rb', line 69

def delete
  self.class.delete(id) if persisted?
  @destroyed = true
  freeze
end

- (Object) destroy

Deletes the record in the database and freezes this instance to reflect that no changes should be made (since they can't be persisted).



77
78
79
80
81
82
83
84
 
# File 'activerecord/lib/active_record/persistence.rb', line 77

def destroy
  if persisted?
    self.class.unscoped.where(self.class.arel_table[self.class.primary_key].eq(id)).delete_all
  end

  @destroyed = true
  freeze
end

- (Boolean) destroyed?

Returns true if this object has been destroyed, otherwise returns false.

Returns:

  • (Boolean) 


11
12
13
 
# File 'activerecord/lib/active_record/persistence.rb', line 11

def destroyed?
  @destroyed
end

- (Object) increment(attribute, by = 1)

Initializes attribute to zero if nil and adds the value passed as by (default is 1). The increment is performed directly on the underlying attribute, no setter is invoked. Only makes sense for number-based attributes. Returns self.



146
147
148
149
150
 
# File 'activerecord/lib/active_record/persistence.rb', line 146

def increment(attribute, by = 1)
  self[attribute] ||= 0
  self[attribute] += by
  self
end

- (Object) increment!(attribute, by = 1)

Wrapper around increment that saves the record. This method differs from its non-bang version in that it passes through the attribute setter. Saving is not subjected to validation checks. Returns true if the record could be saved.



156
157
158
 
# File 'activerecord/lib/active_record/persistence.rb', line 156

def increment!(attribute, by = 1)
  increment(attribute, by).update_attribute(attribute, self[attribute])
end

- (Boolean) new_record?

Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist in the data store yet; otherwise, returns false.

Returns:

  • (Boolean) 


6
7
8
 
# File 'activerecord/lib/active_record/persistence.rb', line 6

def new_record?
  @new_record
end

- (Boolean) persisted?

Returns if the record is persisted, i.e. it's not a new record and it was not destroyed.

Returns:

  • (Boolean) 


17
18
19
 
# File 'activerecord/lib/active_record/persistence.rb', line 17

def persisted?
  !(new_record? || destroyed?)
end

- (Object) reload(options = nil)

Reloads the attributes of this object from the database. The optional options argument is passed to find when reloading so you may do e.g. record.reload(:lock => true) to reload the same record with an exclusive row lock.



198
199
200
201
202
203
204
 
# File 'activerecord/lib/active_record/persistence.rb', line 198

def reload(options = nil)
  clear_aggregation_cache
  clear_association_cache
  @attributes.update(self.class.unscoped { self.class.find(self.id, options) }.instance_variable_get('@attributes'))
  @attributes_cache = {}
  self
end

- (Object) save

:call-seq:

save(options)

Saves the model.

If the model is new a record gets created in the database, otherwise the existing record gets updated.

By default, save always run validations. If any of them fail the action is cancelled and save returns false. However, if you supply :validate => false, validations are bypassed altogether. See ActiveRecord::Validations for more information.

There's a series of callbacks associated with save. If any of the before_* callbacks return false the action is cancelled and save returns false. See ActiveRecord::Callbacks for further details.



38
39
40
 
# File 'activerecord/lib/active_record/persistence.rb', line 38

def save(*)
  create_or_update
end

- (Object) save!

Saves the model.

If the model is new a record gets created in the database, otherwise the existing record gets updated.

With save! validations always run. If any of them fail ActiveRecord::RecordInvalid gets raised. See ActiveRecord::Validations for more information.

There's a series of callbacks associated with save!. If any of the before_* callbacks return false the action is cancelled and save! raises ActiveRecord::RecordNotSaved. See ActiveRecord::Callbacks for further details.



55
56
57
 
# File 'activerecord/lib/active_record/persistence.rb', line 55

def save!(*)
  create_or_update || raise(RecordNotSaved)
end

- (Object) toggle(attribute)

Assigns to attribute the boolean opposite of attribute?. So if the predicate returns true the attribute will become false. This method toggles directly the underlying value without calling any setter. Returns self.



181
182
183
184
 
# File 'activerecord/lib/active_record/persistence.rb', line 181

def toggle(attribute)
  self[attribute] = !send("#{attribute}?")
  self
end

- (Object) toggle!(attribute)

Wrapper around toggle that saves the record. This method differs from its non-bang version in that it passes through the attribute setter. Saving is not subjected to validation checks. Returns true if the record could be saved.



190
191
192
 
# File 'activerecord/lib/active_record/persistence.rb', line 190

def toggle!(attribute)
  toggle(attribute).update_attribute(attribute, self[attribute])
end

- (Object) touch(name = nil)

Saves the record with the updated_at/on attributes set to the current time. Please note that no validation is performed and no callbacks are executed. If an attribute name is passed, that attribute is updated along with updated_at/on attributes.

product.touch               # updates updated_at/on
product.touch(:designed_at) # updates the designed_at attribute and updated_at/on

If used along with belongs_to then touch will invoke touch method on associated object.

class Brake < ActiveRecord::Base
  belongs_to :car, :touch => true
end

class Car < ActiveRecord::Base
  belongs_to :corporation, :touch => true
end

# triggers @brake.car.touch and @brake.car.corporation.touch
@brake.touch


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'activerecord/lib/active_record/persistence.rb', line 226

def touch(name = nil)
  attributes = timestamp_attributes_for_update_in_model
  unless attributes.blank?
    attributes << name if name

    current_time = current_time_from_proper_timezone
    changes = {}

    attributes.each do |column|
      changes[column.to_s] = write_attribute(column.to_s, current_time)
    end

    @changed_attributes.except!(*changes.keys)
    primary_key = self.class.primary_key
    self.class.update_all(changes, { primary_key => self[primary_key] }) == 1
  end
end

- (Object) update_attribute(name, value)

Updates a single attribute and saves the record. This is especially useful for boolean flags on existing records. Also note that

  • Validation is skipped.

  • Callbacks are invoked.

  • updated_at/updated_on column is updated if that column is available.

  • Updates all the attributes that are dirty in this object.

Raises:



113
114
115
116
117
118
 
# File 'activerecord/lib/active_record/persistence.rb', line 113

def update_attribute(name, value)
  name = name.to_s
  raise ActiveRecordError, "#{name} is marked as readonly" if self.class.readonly_attributes.include?(name)
  send("#{name}=", value)
  save(:validate => false)
end

- (Object) update_attributes(attributes)

Updates the attributes of the model from the passed-in hash and saves the record, all wrapped in a transaction. If the object is invalid, the saving will fail and false will be returned.



123
124
125
126
127
128
129
130
 
# File 'activerecord/lib/active_record/persistence.rb', line 123

def update_attributes(attributes)
  # The following transaction covers any possible database side-effects of the
  # attributes assignment. For example, setting the IDs of a child collection.
  with_transaction_returning_status do
    self.attributes = attributes
    save
  end
end

- (Object) update_attributes!(attributes)

Updates its receiver just like update_attributes but calls save! instead of save, so an exception is raised if the record is invalid.



134
135
136
137
138
139
140
141
 
# File 'activerecord/lib/active_record/persistence.rb', line 134

def update_attributes!(attributes)
  # The following transaction covers any possible database side-effects of the
  # attributes assignment. For example, setting the IDs of a child collection.
  with_transaction_returning_status do
    self.attributes = attributes
    save!
  end
end