Class: MigrationTools::Tasks

Inherits:
Rake::TaskLib
  • Object
show all
Defined in:
lib/migration_tools/tasks.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Tasks

Returns a new instance of Tasks.



6
7
8
9
10
 
# File 'lib/migration_tools/tasks.rb', line 6

def initialize
  define_migrate_list
  define_migrate_group
  define_convenience_tasks
end

Instance Method Details

#define_convenience_tasks ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/migration_tools/tasks.rb', line 78

def define_convenience_tasks
  namespace :db do
    namespace :migrate do
      [ :list, :group ].each do |ns|
        namespace ns do
          MigrationTools::MIGRATION_GROUPS.each do |migration_group|
            desc "#{ns == :list ? 'Lists' : 'Executes' } the migrations for group #{migration_group}"
            task migration_group => :environment do
              self.group = migration_group.to_s
              Rake::Task["db:migrate:#{ns}"].invoke
              Rake::Task["db:migrate:#{ns}"].reenable
            end
          end
        end
      end
    end

    namespace :abort_if_pending_migrations do
      MigrationTools::MIGRATION_GROUPS.each do |migration_group|
        desc "Raises an error if there are pending #{migration_group} migrations"
        task migration_group do
          self.group = migration_group.to_s
          Rake::Task["db:migrate:list"].invoke
          Rake::Task["db:migrate:list"].reenable
          if pending_migrations.any?
            abort "Run \"rake db:migrate\" to update your database then try again."
          end
        end
      end
    end
  end
end

#define_migrate_group ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/migration_tools/tasks.rb', line 56

def define_migrate_group
  namespace :db do
    namespace :migrate do
      desc 'Runs pending migrations for a given group'
      task :group => :environment do
        if group.empty?
          notify "Please specify a migration group"
        elsif pending_migrations.empty?
          notify "Your database schema is up to date"
        else
          pending_migrations.each do |migration|
            ActiveRecord::Migrator.run(:up, 'db/migrate', migration.version)
          end

          Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
          Rake::Task["db:structure:dump"].invoke if ActiveRecord::Base.schema_format == :sql
        end
      end
    end
  end
end

#define_migrate_list ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/migration_tools/tasks.rb', line 38

def define_migrate_list
  namespace :db do
    namespace :migrate do
      desc 'Lists pending migrations'
      task :list => :environment do
        if pending_migrations.empty?
          notify "Your database schema is up to date", group
        else
          notify "You have #{pending_migrations.size} pending migrations", group
          pending_migrations.each do |migration|
            notify '  %4d %s %s' % [ migration.version, migration.migration_group.to_s[0..5].center(6), migration.name ]
          end
        end
      end
    end
  end
end

#group ⇒ Object 



12
13
14
15
16
17
18
 
# File 'lib/migration_tools/tasks.rb', line 12

def group
  return @group if @group

  @group = ENV['GROUP'].to_s
  raise "Invalid group \"#{@group}\"" if !@group.empty? && !MIGRATION_GROUPS.member?(@group)
  @group
end

#group=(group) ⇒ Object 



20
21
22
23
24
 
# File 'lib/migration_tools/tasks.rb', line 20

def group=(group)
  @group = nil
  @pending_migrations = nil
  ENV['GROUP'] = group
end

#migrator ⇒ Object 



26
27
28
 
# File 'lib/migration_tools/tasks.rb', line 26

def migrator
  @migrator ||= ActiveRecord::Migrator.new(:up, 'db/migrate')
end

#notify(string, group = "") ⇒ Object 



111
112
113
114
115
116
117
 
# File 'lib/migration_tools/tasks.rb', line 111

def notify(string, group = "")
  if group.empty?
    puts string
  else
    puts string + " for group \""+group+"\""
  end
end

#pending_migrations ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/migration_tools/tasks.rb', line 30

def pending_migrations
  return @pending_migrations if @pending_migrations
  @pending_migrations = migrator.pending_migrations
  @pending_migrations = @pending_migrations.select { |proxy| group.empty? || proxy.migration_group == group }

  @pending_migrations
end