class ActiveRecord::Migration::CommandRecorder

Parent:: Объект
Included modules:: ActiveRecord::Migration::CommandRecorder::StraightReversions

ActiveRecord::Migration::CommandRecorder записывает команды, выполненные во время миграции, и знает, как отменить эти команды. Объект CommandRecorder знает, как инвертировать следующие команды:

add_column
add_index
add_timestamps
create_table
create_join_table
remove_timestamps
rename_column
rename_index
rename_table

Атрибуты

commands[RW]

delegate[RW]

reverting[RW]

Публичные методы класса

new(delegate = nil) Показать исходный код

# File activerecord/lib/active_record/migration/command_recorder.rb, line 21
def initialize(delegate = nil)
  @commands = []
  @delegate = delegate
  @reverting = false
end

Публичные методы экземпляра

inverse_of(command, args, &block) Показать исходный код

# File activerecord/lib/active_record/migration/command_recorder.rb, line 63
def inverse_of(command, args, &block)
  method = :"invert_#{command}"
  raise IrreversibleMigration unless respond_to?(method, true)
  send(method, args, &block)
end

Возвращает обратную операцию для заданной команды. Например:

recorder.inverse_of(:rename_table, [:old, :new])
# => [:rename_table, [:new, :old]]

Этот метод выбросит исключение IrreversibleMigration, если не сможет инвертировать command.

record(*command, &block) Показать исходный код

# File activerecord/lib/active_record/migration/command_recorder.rb, line 48
def record(*command, &block)
  if @reverting
    @commands << inverse_of(*command, &block)
  else
    @commands << (command << block)
  end
end

записывает command. command должно быть именем метода и аргументами. Например:

recorder.record(:method_name, [:arg1, :arg2])

revert() { || ... } Показать исходный код

# File activerecord/lib/active_record/migration/command_recorder.rb, line 34
def revert
  @reverting = !@reverting
  previous = @commands
  @commands = []
  yield
ensure
  @commands = previous.concat(@commands.reverse)
  @reverting = !@reverting
end

Во время выполнения данного блока, запись будет в режиме отмены. Все записанные команды будут записаны как отменённые и в обратном порядке. Например:

recorder.revert{ recorder.record(:rename_table, [:old, :new]) }
# same effect as recorder.record(:rename_table, [:new, :old])