Module: ActiveRecord::Acts::Versioned::ActMethods

Defined in:
lib/acts_as_versioned.rb

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



264
265
266
 
# File 'lib/acts_as_versioned.rb', line 264

def self.included(base) # :nodoc:
  base.extend ClassMethods
end

Instance Method Details

#altered? ⇒ Boolean

Returns:

  • (Boolean) 


324
325
326
 
# File 'lib/acts_as_versioned.rb', line 324

def altered?
  track_altered_attributes ? (version_if_changed - changed).length < version_if_changed.length : changed?
end

#clear_old_versions ⇒ Object

Clears old revisions if a limit is set with the :limit option in acts_as_versioned. Override this method to set your own criteria for clearing old versions.



282
283
284
285
286
287
288
 
# File 'lib/acts_as_versioned.rb', line 282

def clear_old_versions
  return if self.class.max_version_limit == 0
  excess_baggage = send(self.class.version_column).to_i - self.class.max_version_limit
  if excess_baggage > 0
    self.class.versioned_class.delete_all ["#{self.class.version_column} <= ? and #{self.class.versioned_foreign_key} = ?", excess_baggage, id]
  end
end

#clone_versioned_model(orig_model, new_model) ⇒ Object

Clones a model. Used when saving a new version or reverting a model’s version.



329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/acts_as_versioned.rb', line 329

def clone_versioned_model(orig_model, new_model)
  self.class.versioned_columns.each do |col|
    new_model.send("#{col.name}=", orig_model.send(col.name)) if orig_model.has_attribute?(col.name)
  end

  if orig_model.is_a?(self.class.versioned_class)
    new_model[new_model.class.inheritance_column] = orig_model[self.class.versioned_inheritance_column]
  elsif new_model.is_a?(self.class.versioned_class)
    new_model[self.class.versioned_inheritance_column] = orig_model[orig_model.class.inheritance_column]
  end
end

#empty_callback ⇒ Object

:nodoc:



379
 
# File 'lib/acts_as_versioned.rb', line 379

def empty_callback() end

#revert_to(version) ⇒ Object

Reverts a model to a given version. Takes either a version number or an instance of the versioned model



291
292
293
294
295
296
297
298
299
300
 
# File 'lib/acts_as_versioned.rb', line 291

def revert_to(version)
  if version.is_a?(self.class.versioned_class)
    return false unless version.send(self.class.versioned_foreign_key) == id and !version.new_record?
  else
    return false unless version = versions.send("find_by_#{self.class.version_column}", version)
  end
  self.clone_versioned_model(version, self)
  send("#{self.class.version_column}=", version.send(self.class.version_column))
  true
end

#revert_to!(version) ⇒ Object

Reverts a model to a given version and saves the model. Takes either a version number or an instance of the versioned model



304
305
306
 
# File 'lib/acts_as_versioned.rb', line 304

def revert_to!(version)
  revert_to(version) ? save_without_revision : false
end

#save_version ⇒ Object

Saves a version of the model in the versioned table. This is called in the after_save callback by default



269
270
271
272
273
274
275
276
277
278
 
# File 'lib/acts_as_versioned.rb', line 269

def save_version
  if @saving_version
    @saving_version = nil
    rev = self.class.versioned_class.new
    clone_versioned_model(self, rev)
    rev.send("#{self.class.version_column}=", send(self.class.version_column))
    rev.send("#{self.class.versioned_foreign_key}=", id)
    rev.save
  end
end

#save_version? ⇒ Boolean

Checks whether a new version shall be saved or not. Calls version_condition_met? and changed?.

Returns:

  • (Boolean) 


342
343
344
 
# File 'lib/acts_as_versioned.rb', line 342

def save_version?
  version_condition_met? && altered?
end

#save_without_revision ⇒ Object

Temporarily turns off Optimistic Locking while saving. Used when reverting so that a new version is not created.



309
310
311
312
313
314
 
# File 'lib/acts_as_versioned.rb', line 309

def save_without_revision
  save_without_revision!
  true
rescue
  false
end

#save_without_revision! ⇒ Object 



316
317
318
319
320
321
322
 
# File 'lib/acts_as_versioned.rb', line 316

def save_without_revision!
  without_locking do
    without_revision do
      save!
    end
  end
end

#version_condition_met? ⇒ Boolean

Checks condition set in the :if option to check whether a revision should be created or not. Override this for custom version condition checking.

Returns:

  • (Boolean) 


348
349
350
351
352
353
354
355
356
357
 
# File 'lib/acts_as_versioned.rb', line 348

def version_condition_met?
  case
  when version_condition.is_a?(Symbol)
    send(version_condition)
  when version_condition.respond_to?(:call) && (version_condition.arity == 1 || version_condition.arity == -1)
    version_condition.call(self)
  else
    version_condition
  end
end

#without_locking(&block) ⇒ Object

Turns off optimistic locking for the duration of the block

@foo.without_locking do
  @foo.save
end



375
376
377
 
# File 'lib/acts_as_versioned.rb', line 375

def without_locking(&block)
  self.class.without_locking(&block)
end

#without_revision(&block) ⇒ Object

Executes the block with the versioning callbacks disabled.

@foo.without_revision do
  @foo.save
end



365
366
367
 
# File 'lib/acts_as_versioned.rb', line 365

def without_revision(&block)
  self.class.without_revision(&block)
end