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.
# File lib/active_record/persistence.rb, line 96 96: def becomes(klass) 97: became = klass.new 98: became.instance_variable_set("@attributes", @attributes) 99: became.instance_variable_set("@attributes_cache", @attributes_cache) 100: became.instance_variable_set("@persisted", persisted?) 101: became.instance_variable_set("@destroyed", destroyed?) 102: became 103: end
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.
# File lib/active_record/persistence.rb, line 163 163: def decrement(attribute, by = 1) 164: self[attribute] ||= 0 165: self[attribute] -= by 166: self 167: end
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.
# File lib/active_record/persistence.rb, line 173 173: def decrement!(attribute, by = 1) 174: decrement(attribute, by).update_attribute(attribute, self[attribute]) 175: end
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 #.
# File lib/active_record/persistence.rb, line 69 69: def delete 70: self.class.delete(id) if persisted? 71: @destroyed = true 72: freeze 73: end
Deletes the record in the database and freezes this instance to reflect that no changes should be made (since they can’t be persisted).
# File lib/active_record/persistence.rb, line 77 77: def destroy 78: if persisted? 79: self.class.unscoped.where(self.class.arel_table[self.class.primary_key].eq(id)).delete_all 80: end 81: 82: @destroyed = true 83: freeze 84: end
Returns true if this object has been destroyed, otherwise returns false.
# File lib/active_record/persistence.rb, line 11 11: def destroyed? 12: @destroyed 13: end
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.
# File lib/active_record/persistence.rb, line 146 146: def increment(attribute, by = 1) 147: self[attribute] ||= 0 148: self[attribute] += by 149: self 150: end
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.
# File lib/active_record/persistence.rb, line 156 156: def increment!(attribute, by = 1) 157: increment(attribute, by).update_attribute(attribute, self[attribute]) 158: end
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.
# File lib/active_record/persistence.rb, line 6 6: def new_record? 7: !@persisted 8: end
Returns if the record is persisted, i.e. it’s not a new record and it was not destroyed.
# File lib/active_record/persistence.rb, line 17 17: def persisted? 18: @persisted && !destroyed? 19: end
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.
# File lib/active_record/persistence.rb, line 198 198: def reload(options = nil) 199: clear_aggregation_cache 200: clear_association_cache 201: @attributes.update(self.class.unscoped { self.class.find(self.id, options) }.instance_variable_get('@attributes')) 202: @attributes_cache = {} 203: self 204: end
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.
# File lib/active_record/persistence.rb, line 38 38: def save(*) 39: create_or_update 40: end
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.
# File lib/active_record/persistence.rb, line 55 55: def save!(*) 56: create_or_update || raise(RecordNotSaved) 57: end
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.
# File lib/active_record/persistence.rb, line 181 181: def toggle(attribute) 182: self[attribute] = !send("#{attribute}?") 183: self 184: end
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.
# File lib/active_record/persistence.rb, line 190 190: def toggle!(attribute) 191: toggle(attribute).update_attribute(attribute, self[attribute]) 192: end
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
# File lib/active_record/persistence.rb, line 226 226: def touch(name = nil) 227: attributes = timestamp_attributes_for_update_in_model 228: attributes << name if name 229: unless attributes.empty? 230: current_time = current_time_from_proper_timezone 231: changes = {} 232: 233: attributes.each do |column| 234: changes[column.to_s] = write_attribute(column.to_s, current_time) 235: end 236: 237: @changed_attributes.except!(*changes.keys) 238: primary_key = self.class.primary_key 239: self.class.update_all(changes, { primary_key => self[primary_key] }) == 1 240: end 241: end
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.
# File lib/active_record/persistence.rb, line 113 113: def update_attribute(name, value) 114: name = name.to_s 115: raise ActiveRecordError, "#{name} is marked as readonly" if self.class.readonly_attributes.include?(name) 116: send("#{name}=", value) 117: save(:validate => false) 118: end
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.
# File lib/active_record/persistence.rb, line 123 123: def update_attributes(attributes) 124: # The following transaction covers any possible database side-effects of the 125: # attributes assignment. For example, setting the IDs of a child collection. 126: with_transaction_returning_status do 127: self.attributes = attributes 128: save 129: end 130: end
Updates its receiver just like update_attributes but calls save! instead of save, so an exception is raised if the record is invalid.
# File lib/active_record/persistence.rb, line 134 134: def update_attributes!(attributes) 135: # The following transaction covers any possible database side-effects of the 136: # attributes assignment. For example, setting the IDs of a child collection. 137: with_transaction_returning_status do 138: self.attributes = attributes 139: save! 140: end 141: end
Initializes the attributes array with keys matching the columns from the linked table and the values matching the corresponding default value of that column, so that a new instance, or one populated from a passed-in Hash, still has all the attributes that instances loaded from the database would.
# File lib/active_record/persistence.rb, line 283 283: def attributes_from_column_definition 284: self.class.columns.inject({}) do |attributes, column| 285: attributes[column.name] = column.default unless column.name == self.class.primary_key 286: attributes 287: end 288: end
Creates a record with values matching those of the instance attributes and returns its id.
# File lib/active_record/persistence.rb, line 260 260: def create 261: if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name) 262: self.id = connection.next_sequence_value(self.class.sequence_name) 263: end 264: 265: attributes_values = arel_attributes_values 266: 267: new_id = if attributes_values.empty? 268: self.class.unscoped.insert connection.empty_insert_statement_value 269: else 270: self.class.unscoped.insert attributes_values 271: end 272: 273: self.id ||= new_id 274: 275: @persisted = true 276: id 277: end
# File lib/active_record/persistence.rb, line 244 244: def create_or_update 245: raise ReadOnlyRecord if readonly? 246: result = persisted? ? update : create 247: result != false 248: end
Updates the associated record with values matching those of the instance attributes. Returns the number of affected rows.
# File lib/active_record/persistence.rb, line 252 252: def update(attribute_names = @attributes.keys) 253: attributes_with_values = arel_attributes_values(false, false, attribute_names) 254: return 0 if attributes_with_values.empty? 255: self.class.unscoped.where(self.class.arel_table[self.class.primary_key].eq(id)).arel.update(attributes_with_values) 256: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.