Merge pull request #6761 from freelancing-god/db-rake

Get logic out of db rake tasks, and into classes and objects

activerecord/lib/active_record.rb

@@ -137,6 +137,16 @@ module Scoping
     end
   end
 
+  module Tasks
+    extend ActiveSupport::Autoload
+
+    autoload :DatabaseTasks
+    autoload :SQLiteDatabaseTasks, 'active_record/tasks/sqlite_database_tasks'
+    autoload :MySQLDatabaseTasks,  'active_record/tasks/mysql_database_tasks'
+    autoload :PostgreSQLDatabaseTasks,
+      'active_record/tasks/postgresql_database_tasks'
+  end
+
   autoload :TestCase
   autoload :TestFixtures, 'active_record/fixtures'
 end

activerecord/lib/active_record/railties/databases.rake

@@ -14,138 +14,27 @@ db_namespace = namespace :db do
   end
 
   namespace :create do
-    # desc 'Create all the local databases defined in config/database.yml'
     task :all => :load_config do
-      ActiveRecord::Base.configurations.each_value do |config|
-        # Skip entries that don't have a database key, such as the first entry here:
-        #
-        #  defaults: &defaults
-        #    adapter: mysql
-        #    username: root
-        #    password:
-        #    host: localhost
-        #
-        #  development:
-        #    database: blog_development
-        #    *defaults
-        next unless config['database']
-        # Only connect to local databases
-        local_database?(config) { create_database(config) }
-      end
+      ActiveRecord::Tasks::DatabaseTasks.create_all
     end
   end
 
   desc 'Create the database from config/database.yml for the current Rails.env (use db:create:all to create all dbs in the config)'
   task :create => :load_config do
-    configs_for_environment.each { |config| create_database(config) }
-    ActiveRecord::Base.establish_connection(configs_for_environment.first)
-  end
-
-  def mysql_creation_options(config)
-    @charset   = ENV['CHARSET']   || 'utf8'
-    @collation = ENV['COLLATION'] || 'utf8_unicode_ci'
-    {:charset => (config['charset'] || @charset), :collation => (config['collation'] || @collation)}
-  end
-
-  def create_database(config)
-    begin
-      if config['adapter'] =~ /sqlite/
-        if File.exist?(config['database'])
-          $stderr.puts "#{config['database']} already exists"
-        else
-          begin
-            # Create the SQLite database
-            ActiveRecord::Base.establish_connection(config)
-            ActiveRecord::Base.connection
-          rescue Exception => e
-            $stderr.puts e, *(e.backtrace)
-            $stderr.puts "Couldn't create database for #{config.inspect}"
-          end
-        end
-        return # Skip the else clause of begin/rescue
-      else
-        ActiveRecord::Base.establish_connection(config)
-        ActiveRecord::Base.connection
-      end
-    rescue
-      case config['adapter']
-      when /mysql/
-        if config['adapter'] =~ /jdbc/
-          #FIXME After Jdbcmysql gives this class
-          require 'active_record/railties/jdbcmysql_error'
-          error_class = ArJdbcMySQL::Error
-        else
-          error_class = config['adapter'] =~ /mysql2/ ? Mysql2::Error : Mysql::Error
-        end
-        access_denied_error = 1045
-        begin
-          ActiveRecord::Base.establish_connection(config.merge('database' => nil))
-          ActiveRecord::Base.connection.create_database(config['database'], mysql_creation_options(config))
-          ActiveRecord::Base.establish_connection(config)
-        rescue error_class => sqlerr
-          if sqlerr.errno == access_denied_error
-            print "#{sqlerr.error}. \nPlease provide the root password for your mysql installation\n>"
-            root_password = $stdin.gets.strip
-            grant_statement = "GRANT ALL PRIVILEGES ON #{config['database']}.* " \
-              "TO '#{config['username']}'@'localhost' " \
-              "IDENTIFIED BY '#{config['password']}' WITH GRANT OPTION;"
-            ActiveRecord::Base.establish_connection(config.merge(
-                'database' => nil, 'username' => 'root', 'password' => root_password))
-            ActiveRecord::Base.connection.create_database(config['database'], mysql_creation_options(config))
-            ActiveRecord::Base.connection.execute grant_statement
-            ActiveRecord::Base.establish_connection(config)
-          else
-            $stderr.puts sqlerr.error
-            $stderr.puts "Couldn't create database for #{config.inspect}, charset: #{config['charset'] || @charset}, collation: #{config['collation'] || @collation}"
-            $stderr.puts "(if you set the charset manually, make sure you have a matching collation)" if config['charset']
-          end
-        end
-      when /postgresql/
-        @encoding = config['encoding'] || ENV['CHARSET'] || 'utf8'
-        begin
-          ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
-          ActiveRecord::Base.connection.create_database(config['database'], config.merge('encoding' => @encoding))
-          ActiveRecord::Base.establish_connection(config)
-        rescue Exception => e
-          $stderr.puts e, *(e.backtrace)
-          $stderr.puts "Couldn't create database for #{config.inspect}"
-        end
-      end
-    else
-      $stderr.puts "#{config['database']} already exists"
-    end
+    ActiveRecord::Tasks::DatabaseTasks.create_current
   end
 
   namespace :drop do
-    # desc 'Drops all the local databases defined in config/database.yml'
     task :all => :load_config do
-      ActiveRecord::Base.configurations.each_value do |config|
-        # Skip entries that don't have a database key
-        next unless config['database']
-        begin
-          # Only connect to local databases
-          local_database?(config) { drop_database(config) }
-        rescue Exception => e
-          $stderr.puts "Couldn't drop #{config['database']} : #{e.inspect}"
-        end
-      end
+      ActiveRecord::Tasks::DatabaseTasks.drop_all
     end
   end
 
   desc 'Drops the database for the current Rails.env (use db:drop:all to drop all databases)'
   task :drop => :load_config do
-    configs_for_environment.each { |config| drop_database_and_rescue(config) }
-  end
-
-  def local_database?(config, &block)
-    if config['host'].in?(['127.0.0.1', 'localhost']) || config['host'].blank?
-      yield
-    else
-      $stderr.puts "This task only modifies local databases. #{config['database']} is on a remote host."
-    end
+    ActiveRecord::Tasks::DatabaseTasks.drop_current
   end
 
-
   desc "Migrate the database (options: VERSION=x, VERBOSE=false)."
   task :migrate => [:environment, :load_config] do
     ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
@@ -509,16 +398,8 @@ db_namespace = namespace :db do
     task :purge => [:environment, :load_config] do
       abcs = ActiveRecord::Base.configurations
       case abcs['test']['adapter']
-      when /mysql/
-        ActiveRecord::Base.establish_connection(:test)
-        ActiveRecord::Base.connection.recreate_database(abcs['test']['database'], mysql_creation_options(abcs['test']))
-      when /postgresql/
-        ActiveRecord::Base.clear_active_connections!
-        drop_database(abcs['test'])
-        create_database(abcs['test'])
-      when /sqlite/
-        dbfile = abcs['test']['database']
-        File.delete(dbfile) if File.exist?(dbfile)
+      when /mysql/, /postgresql/, /sqlite/
+        ActiveRecord::Tasks::DatabaseTasks.purge abcs['test']
       when 'sqlserver'
         test = abcs.deep_dup['test']
         test_database = test['database']
@@ -592,37 +473,6 @@ end
 
 task 'test:prepare' => 'db:test:prepare'
 
-def drop_database(config)
-  case config['adapter']
-  when /mysql/
-    ActiveRecord::Base.establish_connection(config)
-    ActiveRecord::Base.connection.drop_database config['database']
-  when /sqlite/
-    require 'pathname'
-    path = Pathname.new(config['database'])
-    file = path.absolute? ? path.to_s : File.join(Rails.root, path)
-
-    FileUtils.rm(file)
-  when /postgresql/
-    ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
-    ActiveRecord::Base.connection.drop_database config['database']
-  end
-end
-
-def drop_database_and_rescue(config)
-  begin
-    drop_database(config)
-  rescue Exception => e
-    $stderr.puts "Couldn't drop #{config['database']} : #{e.inspect}"
-  end
-end
-
-def configs_for_environment
-  environments = [Rails.env]
-  environments << 'test' if Rails.env.development?
-  ActiveRecord::Base.configurations.values_at(*environments).compact.reject { |config| config['database'].blank? }
-end
-
 def session_table_name
   ActiveRecord::SessionStore::Session.table_name
 end

activerecord/lib/active_record/tasks/database_tasks.rb

@@ -0,0 +1,82 @@
+class ActiveRecord::Tasks::DatabaseTasks
+  TASKS_PATTERNS = {
+    /mysql/      => ActiveRecord::Tasks::MySQLDatabaseTasks,
+    /postgresql/ => ActiveRecord::Tasks::PostgreSQLDatabaseTasks,
+    /sqlite/     => ActiveRecord::Tasks::SQLiteDatabaseTasks
+  }
+  LOCAL_HOSTS    = ['127.0.0.1', 'localhost']
+
+  def self.create(*arguments)
+    configuration = arguments.first
+    class_for_adapter(configuration['adapter']).new(*arguments).create
+  rescue Exception => error
+    $stderr.puts error, *(error.backtrace)
+    $stderr.puts "Couldn't create database for #{configuration.inspect}"
+  end
+
+  def self.create_all
+    each_local_configuration { |configuration| create configuration }
+  end
+
+  def self.create_current(environment = Rails.env)
+    each_current_configuration(environment) { |configuration|
+      create configuration
+    }
+    ActiveRecord::Base.establish_connection environment
+  end
+
+  def self.drop(*arguments)
+    configuration = arguments.first
+    class_for_adapter(configuration['adapter']).new(*arguments).drop
+  rescue Exception => error
+    $stderr.puts error, *(error.backtrace)
+    $stderr.puts "Couldn't drop #{configuration['database']}"
+  end
+
+  def self.drop_all
+    each_local_configuration { |configuration| drop configuration }
+  end
+
+  def self.drop_current(environment = Rails.env)
+    each_current_configuration(environment) { |configuration|
+      drop configuration
+    }
+  end
+
+  def self.purge(configuration)
+    class_for_adapter(configuration['adapter']).new(configuration).purge
+  end
+
+  private
+
+  def self.class_for_adapter(adapter)
+    key = TASKS_PATTERNS.keys.detect { |pattern| adapter[pattern] }
+    TASKS_PATTERNS[key]
+  end
+
+  def self.each_current_configuration(environment)
+    environments = [environment]
+    environments << 'test' if environment.development?
+
+    configurations = ActiveRecord::Base.configurations.values_at(*environments)
+    configurations.compact.each do |configuration|
+      yield configuration unless configuration['database'].blank?
+    end
+  end
+
+  def self.each_local_configuration
+    ActiveRecord::Base.configurations.each_value do |configuration|
+      next unless configuration['database']
+
+      if local_database?(configuration)
+        yield configuration
+      else
+        $stderr.puts "This task only modifies local databases. #{configuration['database']} is on a remote host."
+      end
+    end
+  end
+
+  def self.local_database?(configuration)
+    configuration['host'].in?(LOCAL_HOSTS) || configuration['host'].blank?
+  end
+end

activerecord/lib/active_record/tasks/mysql_database_tasks.rb

@@ -0,0 +1,88 @@
+class ActiveRecord::Tasks::MySQLDatabaseTasks
+  DEFAULT_CHARSET     = ENV['CHARSET']   || 'utf8'
+  DEFAULT_COLLATION   = ENV['COLLATION'] || 'utf8_unicode_ci'
+  ACCESS_DENIED_ERROR = 1045
+
+  delegate :connection, :establish_connection, :to => ActiveRecord::Base
+
+  def initialize(configuration)
+    @configuration = configuration
+  end
+
+  def create
+    establish_connection configuration_without_database
+    connection.create_database configuration['database'], creation_options
+    establish_connection configuration
+  rescue error_class => error
+    raise error unless error.errno == ACCESS_DENIED_ERROR
+
+    $stdout.print error.error
+    establish_connection root_configuration_without_database
+    connection.create_database configuration['database'], creation_options
+    connection.execute grant_statement.gsub(/\s+/, ' ').strip
+    establish_connection configuration
+  rescue error_class => error
+    $stderr.puts error.error
+    $stderr.puts "Couldn't create database for #{configuration.inspect}, #{creation_options.inspect}"
+    $stderr.puts "(If you set the charset manually, make sure you have a matching collation)" if configuration['charset']
+  end
+
+  def drop
+    establish_connection configuration
+    connection.drop_database configuration['database']
+  end
+
+  def purge
+    establish_connection :test
+    connection.recreate_database configuration['database'], creation_options
+  end
+
+  private
+
+  def configuration
+    @configuration
+  end
+
+  def configuration_without_database
+    configuration.merge('database' => nil)
+  end
+
+  def creation_options
+    {
+      :charset   => (configuration['charset']   || DEFAULT_CHARSET),
+      :collation => (configuration['collation'] || DEFAULT_COLLATION)
+    }
+  end
+
+  def error_class
+    case configuration['adapter']
+    when /jdbc/
+      require 'active_record/railties/jdbcmysql_error'
+      ArJdbcMySQL::Error
+    when /mysql2/
+      Mysql2::Error
+    else
+      Mysql::Error
+    end
+  end
+
+  def grant_statement
+    <<-SQL
+GRANT ALL PRIVILEGES ON #{configuration['database']}.*
+  TO '#{configuration['username']}'@'localhost'
+IDENTIFIED BY '#{configuration['password']}' WITH GRANT OPTION;
+    SQL
+  end
+
+  def root_configuration_without_database
+    configuration_without_database.merge(
+      'username' => 'root',
+      'password' => root_password
+    )
+  end
+
+  def root_password
+    $stdout.print "Please provide the root password for your mysql installation\n>"
+    $stdin.gets.strip
+  end
+end