Class: ActiveRecord::Migrator

Inherits:
Object
  • Object
show all
Defined in:
lib/active_record/migration.rb

Overview

:nodoc:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(direction, migrations_path, target_version = nil) ⇒ Migrator

Returns a new instance of Migrator.

Raises:

  • (StandardError) 


487
488
489
490
491
 
# File 'lib/active_record/migration.rb', line 487

def initialize(direction, migrations_path, target_version = nil)
  raise StandardError.new("This database does not yet support migrations") unless Base.connection.supports_migrations?
  Base.connection.initialize_schema_migrations_table
  @direction, @migrations_path, @target_version = direction, migrations_path, target_version
end

Class Method Details

.current_version ⇒ Object 



459
460
461
462
463
464
465
466
 
# File 'lib/active_record/migration.rb', line 459

def current_version
  sm_table = schema_migrations_table_name
  if Base.connection.table_exists?(sm_table)
    get_all_versions.max || 0
  else
    0
  end
end

.down(migrations_path, target_version = nil) ⇒ Object 



438
439
440
 
# File 'lib/active_record/migration.rb', line 438

def down(migrations_path, target_version = nil)
  self.new(:down, migrations_path, target_version).migrate
end

.forward(migrations_path, steps = 1) ⇒ Object 



430
431
432
 
# File 'lib/active_record/migration.rb', line 430

def forward(migrations_path, steps=1)
  move(:up, migrations_path, steps)
end

.get_all_versions ⇒ Object 



454
455
456
457
 
# File 'lib/active_record/migration.rb', line 454

def get_all_versions
  table = Arel::Table.new(schema_migrations_table_name)
  Base.connection.select_values(table.project(table['version']).to_sql).map{ |v| v.to_i }.sort
end

.migrate(migrations_path, target_version = nil) ⇒ Object 



414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/active_record/migration.rb', line 414

def migrate(migrations_path, target_version = nil)
  case
    when target_version.nil?
      up(migrations_path, target_version)
    when current_version == 0 && target_version == 0
    when current_version > target_version
      down(migrations_path, target_version)
    else
      up(migrations_path, target_version)
  end
end

.migrations_path ⇒ Object 



446
447
448
 
# File 'lib/active_record/migration.rb', line 446

def migrations_path
  'db/migrate'
end

.proper_table_name(name) ⇒ Object 



468
469
470
471
 
# File 'lib/active_record/migration.rb', line 468

def proper_table_name(name)
  # Use the Active Record objects own table_name, or pre/suffix from ActiveRecord::Base if name is a symbol/string
  name.table_name rescue "#{ActiveRecord::Base.table_name_prefix}#{name}#{ActiveRecord::Base.table_name_suffix}"
end

.rollback(migrations_path, steps = 1) ⇒ Object 



426
427
428
 
# File 'lib/active_record/migration.rb', line 426

def rollback(migrations_path, steps=1)
  move(:down, migrations_path, steps)
end

.run(direction, migrations_path, target_version) ⇒ Object 



442
443
444
 
# File 'lib/active_record/migration.rb', line 442

def run(direction, migrations_path, target_version)
  self.new(direction, migrations_path, target_version).run
end

.schema_migrations_table_name ⇒ Object 



450
451
452
 
# File 'lib/active_record/migration.rb', line 450

def schema_migrations_table_name
  Base.table_name_prefix + 'schema_migrations' + Base.table_name_suffix
end

.up(migrations_path, target_version = nil) ⇒ Object 



434
435
436
 
# File 'lib/active_record/migration.rb', line 434

def up(migrations_path, target_version = nil)
  self.new(:up, migrations_path, target_version).migrate
end

Instance Method Details

#current_migration ⇒ Object 



497
498
499
 
# File 'lib/active_record/migration.rb', line 497

def current_migration
  migrations.detect { |m| m.version == current_version }
end

#current_version ⇒ Object 



493
494
495
 
# File 'lib/active_record/migration.rb', line 493

def current_version
  migrated.last || 0
end

#migrate ⇒ Object 



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/active_record/migration.rb', line 510

def migrate
  current = migrations.detect { |m| m.version == current_version }
  target = migrations.detect { |m| m.version == @target_version }

  if target.nil? && !@target_version.nil? && @target_version > 0
    raise UnknownMigrationVersionError.new(@target_version)
  end

  start = up? ? 0 : (migrations.index(current) || 0)
  finish = migrations.index(target) || migrations.size - 1
  runnable = migrations[start..finish]

  # skip the last migration if we're headed down, but not ALL the way down
  runnable.pop if down? && !target.nil?

  runnable.each do |migration|
    Base.logger.info "Migrating to #{migration.name} (#{migration.version})" if Base.logger

    # On our way up, we skip migrating the ones we've already migrated
    next if up? && migrated.include?(migration.version.to_i)

    # On our way down, we skip reverting the ones we've never migrated
    if down? && !migrated.include?(migration.version.to_i)
      migration.announce 'never migrated, skipping'; migration.write
      next
    end

    begin
      ddl_transaction do
        migration.migrate(@direction)
        record_version_state_after_migrating(migration.version)
      end
    rescue => e
      canceled_msg = Base.connection.supports_ddl_transactions? ? "this and " : ""
      raise StandardError, "An error has occurred, #{canceled_msg}all later migrations canceled:\n\n#{e}", e.backtrace
    end
  end
end

#migrated ⇒ Object 



584
585
586
 
# File 'lib/active_record/migration.rb', line 584

def migrated
  @migrated_versions ||= self.class.get_all_versions
end

#migrations ⇒ Object 



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/active_record/migration.rb', line 549

def migrations
  @migrations ||= begin
    files = Dir["#{@migrations_path}/[0-9]*_*.rb"]

    migrations = files.inject([]) do |klasses, file|
      version, name = file.scan(/([0-9]+)_([_a-z0-9]*).rb/).first

      raise IllegalMigrationNameError.new(file) unless version
      version = version.to_i

      if klasses.detect { |m| m.version == version }
        raise DuplicateMigrationVersionError.new(version)
      end

      if klasses.detect { |m| m.name == name.camelize }
        raise DuplicateMigrationNameError.new(name.camelize)
      end

      migration = MigrationProxy.new
      migration.name     = name.camelize
      migration.version  = version
      migration.filename = file
      klasses << migration
    end

    migrations = migrations.sort_by { |m| m.version }
    down? ? migrations.reverse : migrations
  end
end

#pending_migrations ⇒ Object 



579
580
581
582
 
# File 'lib/active_record/migration.rb', line 579

def pending_migrations
  already_migrated = migrated
  migrations.reject { |m| already_migrated.include?(m.version.to_i) }
end

#run ⇒ Object

Raises:



501
502
503
504
505
506
507
508
 
# File 'lib/active_record/migration.rb', line 501

def run
  target = migrations.detect { |m| m.version == @target_version }
  raise UnknownMigrationVersionError.new(@target_version) if target.nil?
  unless (up? && migrated.include?(target.version.to_i)) || (down? && !migrated.include?(target.version.to_i))
    target.migrate(@direction)
    record_version_state_after_migrating(target.version)
  end
end