класс ActiveRecord::Migration::CommandRecorder

Родитель:: Объект

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

add_column
add_foreign_key
add_index
add_reference
add_timestamps
change_column
change_column_default (обязательно указать опции :from и :to)
change_column_null
change_column_comment (обязательно указать опции :from и :to)
change_table_comment (обязательно указать опции :from и :to)
create_join_table
create_table
disable_extension
drop_join_table
drop_table (обязательно указать блок)
enable_extension
remove_column (обязательно указать тип)
remove_columns (обязательно указать хотя бы одно имя столбца или несколько)
remove_foreign_key (обязательно указать вторую таблицу)
remove_index
remove_reference
remove_timestamps
rename_column
rename_index
rename_table

Константы

ReversibleAndIrreversibleMethods

Атрибуты

commands[RW]

delegate[RW]

reverting[RW]

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

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

# File activerecord/lib/active_record/migration/command_recorder.rb, line 47
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 89
      def inverse_of(command, args, &block)
        method = :"invert_#{command}"
        raise IrreversibleMigration, <<~MSG unless respond_to?(method, true)
          This migration uses #{command}, which is not automatically reversible.
          To make the migration reversible you can either:
          1. Define #up and #down methods in place of the #change method.
          2. Use the #reversible method to define reversible behavior.
        MSG
        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 74
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])

replay(migration) Показать исходный код

# File activerecord/lib/active_record/migration/command_recorder.rb, line 114
def replay(migration)
  commands.each do |cmd, args, block|
    migration.send(cmd, *args, &block)
  end
end

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

# File activerecord/lib/active_record/migration/command_recorder.rb, line 60
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])