Class: ActiveRecord::Migration::CommandRecorder

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 61

attr_accessor :commands, :delegate, :reverting

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 61

attr_accessor :commands, :delegate, :reverting

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 132

def change_table(table_name, **options) # :nodoc:
  if delegate.supports_bulk_alter? && options[:bulk]
    recorder = self.class.new(self.delegate)
    recorder.reverting = @reverting
    yield recorder.delegate.update_table_definition(table_name, recorder)
    commands = recorder.commands
    @commands << [:change_table, [table_name], -> t { bulk_change_table(table_name, commands) }]
  else
    yield delegate.update_table_definition(table_name, self)
  end
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 110

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

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 256

alias :invert_add_belongs_to :invert_add_reference

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 313

def invert_add_check_constraint(args)
  if (options = args.last).is_a?(Hash)
    options.delete(:validate)
    options[:if_exists] = options.delete(:if_not_exists) if options.key?(:if_not_exists)
  end
  super
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 274

def invert_add_foreign_key(args)
  args.last.delete(:validate) if args.last.is_a?(Hash)
  super
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 335

def invert_add_unique_constraint(args)
  options = args.dup.extract_options!

  raise ActiveRecord::IrreversibleMigration, "add_unique_constraint is not reversible if given an using_index." if options[:using_index]
  super
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 293

def invert_change_column_comment(args)
  table, column, options = args

  unless options.is_a?(Hash) && options.has_key?(:from) && options.has_key?(:to)
    raise ActiveRecord::IrreversibleMigration, "change_column_comment is only reversible if given a :from and :to option."
  end

  [:change_column_comment, [table, column, from: options[:to], to: options[:from]]]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 259

def invert_change_column_default(args)
  table, column, options = args

  unless options.is_a?(Hash) && options.has_key?(:from) && options.has_key?(:to)
    raise ActiveRecord::IrreversibleMigration, "change_column_default is only reversible if given a :from and :to option."
  end

  [:change_column_default, [table, column, from: options[:to], to: options[:from]]]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 269

def invert_change_column_null(args)
  args[2] = !args[2]
  [:change_column_null, args]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 303

def invert_change_table_comment(args)
  table, options = args

  unless options.is_a?(Hash) && options.has_key?(:from) && options.has_key?(:to)
    raise ActiveRecord::IrreversibleMigration, "change_table_comment is only reversible if given a :from and :to option."
  end

  [:change_table_comment, [table, from: options[:to], to: options[:from]]]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 191

def invert_create_table(args, &block)
  if args.last.is_a?(Hash)
    args.last.delete(:if_not_exists)
  end
  super
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 349

def invert_drop_enum(args)
  _enum, values = args.dup.tap(&:extract_options!)
  raise ActiveRecord::IrreversibleMigration, "drop_enum is only reversible if given a list of enum values." unless values
  super
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 198

def invert_drop_table(args, &block)
  if args.last.is_a?(Hash)
    args.last.delete(:if_exists)
  end
  if args.size == 1 && block == nil
    raise ActiveRecord::IrreversibleMigration, "To avoid mistakes, drop_table is only reversible if given options or a block (can be empty)."
  end
  super
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 257

alias :invert_remove_belongs_to :invert_remove_reference

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 321

def invert_remove_check_constraint(args)
  raise ActiveRecord::IrreversibleMigration, "remove_check_constraint is only reversible if given an expression." if args.size < 2

  if (options = args.last).is_a?(Hash)
    options[:if_not_exists] = options.delete(:if_exists) if options.key?(:if_exists)
  end
  super
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 215

def invert_remove_column(args)
  raise ActiveRecord::IrreversibleMigration, "remove_column is only reversible if given a type." if args.size <= 2
  super
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 220

def invert_remove_columns(args)
  unless args[-1].is_a?(Hash) && args[-1].has_key?(:type)
    raise ActiveRecord::IrreversibleMigration, "remove_columns is only reversible if given a type."
  end

  [:add_columns, args]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 330

def invert_remove_exclusion_constraint(args)
  raise ActiveRecord::IrreversibleMigration, "remove_exclusion_constraint is only reversible if given an expression." if args.size < 2
  super
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 279

def invert_remove_foreign_key(args)
  options = args.extract_options!
  from_table, to_table = args

  to_table ||= options.delete(:to_table)

  raise ActiveRecord::IrreversibleMigration, "remove_foreign_key is only reversible if given a second table" if to_table.nil?

  reversed_args = [from_table, to_table]
  reversed_args << options unless options.empty?

  [:add_foreign_key, reversed_args]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 238

def invert_remove_index(args)
  options = args.extract_options!
  table, columns = args

  columns ||= options.delete(:column)

  unless columns
    raise ActiveRecord::IrreversibleMigration, "remove_index is only reversible if given a :column option."
  end

  options.delete(:if_exists)

  args = [table, columns]
  args << options unless options.empty?

  [:add_index, args]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 342

def invert_remove_unique_constraint(args)
  _table, columns = args.dup.tap(&:extract_options!)

  raise ActiveRecord::IrreversibleMigration, "remove_unique_constraint is only reversible if given an column_name." if columns.blank?
  super
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 233

def invert_rename_column(args)
  table_name, old_name, new_name = args
  [:rename_column, [table_name, new_name, old_name]]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 355

def invert_rename_enum(args)
  name, options = args

  unless options.is_a?(Hash) && options.has_key?(:to)
    raise ActiveRecord::IrreversibleMigration, "rename_enum is only reversible if given a :to option."
  end

  [:rename_enum, [options[:to], to: name]]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 365

def invert_rename_enum_value(args)
  type_name, options = args

  unless options.is_a?(Hash) && options.has_key?(:from) && options.has_key?(:to)
    raise ActiveRecord::IrreversibleMigration, "rename_enum_value is only reversible if given a :from and :to option."
  end

  [:rename_enum_value, [type_name, from: options[:to], to: options[:from]]]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 228

def invert_rename_index(args)
  table_name, old_name, new_name = args
  [:rename_index, [table_name, new_name, old_name]]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 208

def invert_rename_table(args)
  old_name, new_name, options = args
  args = [new_name, old_name]
  args << options if options
  [:rename_table, args]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 180

def invert_transaction(args, &block)
  sub_recorder = CommandRecorder.new(delegate)
  sub_recorder.revert(&block)

  invertions_proc = proc {
    sub_recorder.replay(self)
  }

  [:transaction, args, invertions_proc]
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 90

def record(*command, &block)
  if @reverting
    @commands << inverse_of(*command, &block)
  else
    @commands << (command << block)
  end
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 130

alias :remove_belongs_to :remove_reference

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 144

def replay(migration)
  commands.each do |cmd, args, block|
    migration.send(cmd, *args, &block)
  end
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 375

def respond_to_missing?(method, _)
  super || delegate.respond_to?(method)
end

# File 'activerecord/lib/active_record/migration/command_recorder.rb', line 76

def revert
  @reverting = !@reverting
  previous = @commands
  @commands = []
  yield
ensure
  @commands = previous.concat(@commands.reverse)
  @reverting = !@reverting
end