Module: ActiveRecord::Acts::Versioned::Behaviors::ClassMethods

Defined in:
lib/acts_as_versioned.rb

Instance Method Summary collapse

Instance Method Details

#create_versioned_table(create_table_options = {}) ⇒ Object

Rake migration task to create the versioned table using options passed to acts_as_versioned



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/acts_as_versioned.rb', line 414

def create_versioned_table(create_table_options = {})
  # create version column in main table if it does not exist
  if !self.content_columns.find { |c| [version_column.to_s, 'lock_version'].include? c.name }
    self.connection.add_column table_name, version_column, :integer
    self.reset_column_information
  end

  return if connection.table_exists?(versioned_table_name)

  self.connection.create_table(versioned_table_name, create_table_options) do |t|
    t.column versioned_foreign_key, :integer
    t.column version_column, :integer
  end

  self.versioned_columns.each do |col|
    limit = col.limit
    if col.limit == 10 and col.type == :integer
         # Avoid 'No integer type has byte size 10' under MySQL
         limit = 8
    end
    self.connection.add_column versioned_table_name, col.name, col.type,
                               :limit     => limit,
                               :default   => col.default,
                               :scale     => col.scale,
                               :precision => col.precision
  end

  if type_col = self.columns_hash[inheritance_column]
    self.connection.add_column versioned_table_name, versioned_inheritance_column, type_col.type,
                               :limit     => type_col.limit,
                               :default   => type_col.default,
                               :scale     => type_col.scale,
                               :precision => type_col.precision
  end

  # Make sure not to create an index that is too long (rails limits index names to 64 characters from version 3.0.3)
  name = 'index_' + versioned_table_name + '_on_' + versioned_foreign_key
  self.connection.add_index versioned_table_name, versioned_foreign_key, :name => name[0,63]
end

#drop_versioned_table ⇒ Object

Rake migration task to drop the versioned table



455
456
457
 
# File 'lib/acts_as_versioned.rb', line 455

def drop_versioned_table
  self.connection.drop_table versioned_table_name
end

#versioned_class ⇒ Object

Returns an instance of the dynamic versioned model



409
410
411
 
# File 'lib/acts_as_versioned.rb', line 409

def versioned_class
  const_get versioned_class_name
end

#versioned_columns ⇒ Object

Returns an array of columns that are versioned. See non_versioned_columns



404
405
406
 
# File 'lib/acts_as_versioned.rb', line 404

def versioned_columns
  @versioned_columns ||= columns.select { |c| !non_versioned_columns.include?(c.name) }
end

#without_locking(&block) ⇒ Object

Turns off optimistic locking for the duration of the block

Foo.without_locking do
  @foo.save
end



487
488
489
490
491
492
493
494
495
 
# File 'lib/acts_as_versioned.rb', line 487

def without_locking(&block)
  current = ActiveRecord::Base.lock_optimistically
  ActiveRecord::Base.lock_optimistically = false if current
  begin
    block.call
  ensure
    ActiveRecord::Base.lock_optimistically = true if current
  end
end

#without_revision(&block) ⇒ Object

Executes the block with the versioning callbacks disabled.

Foo.without_revision do
  @foo.save
end



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/acts_as_versioned.rb', line 465

def without_revision(&block)
  class_eval do
    CALLBACKS.each do |attr_name|
      alias_method "orig_#{attr_name}".to_sym, attr_name
      alias_method attr_name, :empty_callback
    end
  end
  block.call
ensure
  class_eval do
    CALLBACKS.each do |attr_name|
      alias_method attr_name, "orig_#{attr_name}".to_sym
    end
  end
end