activerecord 5.0.7 → 5.1.7

data/lib/active_record/tasks/database_tasks.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext/string/filters'
-
 module ActiveRecord
   module Tasks # :nodoc:
     class DatabaseAlreadyExists < StandardError; end # :nodoc:
@@ -35,15 +33,25 @@ module ActiveRecord
     #
     #   DatabaseTasks.create_current('production')
     module DatabaseTasks
+      ##
+      # :singleton-method:
+      # Extra flags passed to database CLI tool (mysqldump/pg_dump) when calling db:structure:dump
+      mattr_accessor :structure_dump_flags, instance_accessor: false
+
+      ##
+      # :singleton-method:
+      # Extra flags passed to database CLI tool when calling db:structure:load
+      mattr_accessor :structure_load_flags, instance_accessor: false
+
       extend self
 
       attr_writer :current_config, :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader
       attr_accessor :database_configuration
 
-      LOCAL_HOSTS    = ['127.0.0.1', 'localhost']
+      LOCAL_HOSTS = ["127.0.0.1", "localhost"]
 
       def check_protected_environments!
-        unless ENV['DISABLE_DATABASE_ENVIRONMENT_CHECK']
+        unless ENV["DISABLE_DATABASE_ENVIRONMENT_CHECK"]
           current = ActiveRecord::Migrator.current_environment
           stored  = ActiveRecord::Migrator.last_stored_environment
 
@@ -72,15 +80,15 @@ module ActiveRecord
       end
 
       def migrations_paths
-        @migrations_paths ||= Rails.application.paths['db/migrate'].to_a
+        @migrations_paths ||= Rails.application.paths["db/migrate"].to_a
       end
 
       def fixtures_path
-        @fixtures_path ||= if ENV['FIXTURES_PATH']
-                             File.join(root, ENV['FIXTURES_PATH'])
-                           else
-                             File.join(root, 'test', 'fixtures')
-                           end
+        @fixtures_path ||= if ENV["FIXTURES_PATH"]
+          File.join(root, ENV["FIXTURES_PATH"])
+        else
+          File.join(root, "test", "fixtures")
+        end
       end
 
       def root
@@ -96,7 +104,7 @@ module ActiveRecord
       end
 
       def current_config(options = {})
-        options.reverse_merge! :env => env
+        options.reverse_merge! env: env
         if options.has_key?(:config)
           @current_config = options[:config]
         else
@@ -106,13 +114,13 @@ module ActiveRecord
 
       def create(*arguments)
         configuration = arguments.first
-        class_for_adapter(configuration['adapter']).new(*arguments).create
+        class_for_adapter(configuration["adapter"]).new(*arguments).create
         $stdout.puts "Created database '#{configuration['database']}'"
       rescue DatabaseAlreadyExists
         $stderr.puts "Database '#{configuration['database']}' already exists"
       rescue Exception => error
         $stderr.puts error
-        $stderr.puts "Couldn't create database for #{configuration.inspect}"
+        $stderr.puts "Couldn't create '#{configuration['database']}' database. Please check your configuration."
         raise
       end
 
@@ -120,7 +128,7 @@ module ActiveRecord
         old_pool = ActiveRecord::Base.connection_handler.retrieve_connection_pool(ActiveRecord::Base.connection_specification_name)
         each_local_configuration { |configuration| create configuration }
         if old_pool
-          ActiveRecord::Base.connection_handler.establish_connection(old_pool.spec)
+          ActiveRecord::Base.connection_handler.establish_connection(old_pool.spec.to_hash)
         end
       end
 
@@ -133,7 +141,7 @@ module ActiveRecord
 
       def drop(*arguments)
         configuration = arguments.first
-        class_for_adapter(configuration['adapter']).new(*arguments).drop
+        class_for_adapter(configuration["adapter"]).new(*arguments).drop
         $stdout.puts "Dropped database '#{configuration['database']}'"
       rescue ActiveRecord::NoDatabaseError
         $stderr.puts "Database '#{configuration['database']}' does not exist"
@@ -158,7 +166,7 @@ module ActiveRecord
 
         verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
         version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
-        scope   = ENV['SCOPE']
+        scope = ENV["SCOPE"]
         verbose_was, Migration.verbose = Migration.verbose, verbose
         Migrator.migrate(migrations_paths, version) do |migration|
           scope.blank? || scope == migration.scope
@@ -174,7 +182,7 @@ module ActiveRecord
 
       def charset(*arguments)
         configuration = arguments.first
-        class_for_adapter(configuration['adapter']).new(*arguments).charset
+        class_for_adapter(configuration["adapter"]).new(*arguments).charset
       end
 
       def collation_current(environment = env)
@@ -183,11 +191,11 @@ module ActiveRecord
 
       def collation(*arguments)
         configuration = arguments.first
-        class_for_adapter(configuration['adapter']).new(*arguments).collation
+        class_for_adapter(configuration["adapter"]).new(*arguments).collation
       end
 
       def purge(configuration)
-        class_for_adapter(configuration['adapter']).new(configuration).purge
+        class_for_adapter(configuration["adapter"]).new(configuration).purge
       end
 
       def purge_all
@@ -206,13 +214,13 @@ module ActiveRecord
       def structure_dump(*arguments)
         configuration = arguments.first
         filename = arguments.delete_at 1
-        class_for_adapter(configuration['adapter']).new(*arguments).structure_dump(filename)
+        class_for_adapter(configuration["adapter"]).new(*arguments).structure_dump(filename, structure_dump_flags)
       end
 
       def structure_load(*arguments)
         configuration = arguments.first
         filename = arguments.delete_at 1
-        class_for_adapter(configuration['adapter']).new(*arguments).structure_load(filename)
+        class_for_adapter(configuration["adapter"]).new(*arguments).structure_load(filename, structure_load_flags)
       end
 
       def load_schema(configuration, format = ActiveRecord::Base.schema_format, file = nil, environment = env) # :nodoc:
@@ -233,14 +241,6 @@ module ActiveRecord
         ActiveRecord::InternalMetadata[:environment] = environment
       end
 
-      def load_schema_for(*args)
-        ActiveSupport::Deprecation.warn(<<-MSG.squish)
-          This method was renamed to `#load_schema` and will be removed in the future.
-          Use `#load_schema` instead.
-        MSG
-        load_schema(*args)
-      end
-
       def schema_file(format = ActiveRecord::Base.schema_format)
         case format
         when :ruby
@@ -269,48 +269,58 @@ module ActiveRecord
         if seed_loader
           seed_loader.load_seed
         else
-          raise "You tried to load seed data, but no seed loader is specified. Please specify seed " +
-                "loader with ActiveRecord::Tasks::DatabaseTasks.seed_loader = your_seed_loader\n" +
+          raise "You tried to load seed data, but no seed loader is specified. Please specify seed " \
+                "loader with ActiveRecord::Tasks::DatabaseTasks.seed_loader = your_seed_loader\n" \
                 "Seed loader should respond to load_seed method"
         end
       end
 
+      # Dumps the schema cache in YAML format for the connection into the file
+      #
+      # ==== Examples:
+      #   ActiveRecord::Tasks::DatabaseTasks.dump_schema_cache(ActiveRecord::Base.connection, "tmp/schema_dump.yaml")
+      def dump_schema_cache(conn, filename)
+        conn.schema_cache.clear!
+        conn.data_sources.each { |table| conn.schema_cache.add(table) }
+        open(filename, "wb") { |f| f.write(YAML.dump(conn.schema_cache)) }
+      end
+
       private
 
-      def class_for_adapter(adapter)
-        key = @tasks.keys.detect { |pattern| adapter[pattern] }
-        unless key
-          raise DatabaseNotSupported, "Rake tasks not supported by '#{adapter}' adapter"
+        def class_for_adapter(adapter)
+          key = @tasks.keys.detect { |pattern| adapter[pattern] }
+          unless key
+            raise DatabaseNotSupported, "Rake tasks not supported by '#{adapter}' adapter"
+          end
+          @tasks[key]
         end
-        @tasks[key]
-      end
 
-      def each_current_configuration(environment)
-        environments = [environment]
-        environments << 'test' if environment == 'development'
+        def each_current_configuration(environment)
+          environments = [environment]
+          environments << "test" if environment == "development"
 
-        ActiveRecord::Base.configurations.slice(*environments).each do |configuration_environment, configuration|
-          next unless configuration["database"]
+          ActiveRecord::Base.configurations.slice(*environments).each do |configuration_environment, configuration|
+            next unless configuration["database"]
 
-          yield configuration, configuration_environment
+            yield configuration, configuration_environment
+          end
         end
-      end
 
-      def each_local_configuration
-        ActiveRecord::Base.configurations.each_value do |configuration|
-          next unless configuration['database']
+        def 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."
+            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
-      end
 
-      def local_database?(configuration)
-        configuration['host'].blank? || LOCAL_HOSTS.include?(configuration['host'])
-      end
+        def local_database?(configuration)
+          configuration["host"].blank? || LOCAL_HOSTS.include?(configuration["host"])
+        end
     end
   end
 end

data/lib/active_record/tasks/mysql_database_tasks.rb

@@ -11,10 +11,10 @@ module ActiveRecord
 
       def create
         establish_connection configuration_without_database
-        connection.create_database configuration['database'], creation_options
+        connection.create_database configuration["database"], creation_options
         establish_connection configuration
       rescue ActiveRecord::StatementInvalid => error
-        if /database exists/ === error.message
+        if error.message.include?("database exists")
           raise DatabaseAlreadyExists
         else
           raise
@@ -23,26 +23,26 @@ module ActiveRecord
         if error.respond_to?(:errno) && error.errno == ACCESS_DENIED_ERROR
           $stdout.print error.message
           establish_connection root_configuration_without_database
-          connection.create_database configuration['database'], creation_options
-          if configuration['username'] != 'root'
-            connection.execute grant_statement.gsub(/\s+/, ' ').strip
+          connection.create_database configuration["database"], creation_options
+          if configuration["username"] != "root"
+            connection.execute grant_statement.gsub(/\s+/, " ").strip
           end
           establish_connection configuration
         else
           $stderr.puts error.inspect
           $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['encoding']
+          $stderr.puts "(If you set the charset manually, make sure you have a matching collation)" if configuration["encoding"]
         end
       end
 
       def drop
         establish_connection configuration
-        connection.drop_database configuration['database']
+        connection.drop_database configuration["database"]
       end
 
       def purge
         establish_connection configuration
-        connection.recreate_database configuration['database'], creation_options
+        connection.recreate_database configuration["database"], creation_options
       end
 
       def charset
@@ -53,99 +53,102 @@ module ActiveRecord
         connection.collation
       end
 
-      def structure_dump(filename)
+      def structure_dump(filename, extra_flags)
         args = prepare_command_options
         args.concat(["--result-file", "#{filename}"])
         args.concat(["--no-data"])
         args.concat(["--routines"])
+        args.concat(["--skip-comments"])
         args.concat(["#{configuration['database']}"])
+        args.unshift(*extra_flags) if extra_flags
 
-        run_cmd('mysqldump', args, 'dumping')
+        run_cmd("mysqldump", args, "dumping")
       end
 
-      def structure_load(filename)
+      def structure_load(filename, extra_flags)
         args = prepare_command_options
-        args.concat(['--execute', %{SET FOREIGN_KEY_CHECKS = 0; SOURCE #{filename}; SET FOREIGN_KEY_CHECKS = 1}])
+        args.concat(["--execute", %{SET FOREIGN_KEY_CHECKS = 0; SOURCE #{filename}; SET FOREIGN_KEY_CHECKS = 1}])
         args.concat(["--database", "#{configuration['database']}"])
+        args.unshift(*extra_flags) if extra_flags
 
-        run_cmd('mysql', args, 'loading')
+        run_cmd("mysql", args, "loading")
       end
 
       private
 
-      def configuration
-        @configuration
-      end
+        def configuration
+          @configuration
+        end
 
-      def configuration_without_database
-        configuration.merge('database' => nil)
-      end
+        def configuration_without_database
+          configuration.merge("database" => nil)
+        end
 
-      def creation_options
-        Hash.new.tap do |options|
-          options[:charset]     = configuration['encoding']   if configuration.include? 'encoding'
-          options[:collation]   = configuration['collation']  if configuration.include? 'collation'
+        def creation_options
+          Hash.new.tap do |options|
+            options[:charset]     = configuration["encoding"]   if configuration.include? "encoding"
+            options[:collation]   = configuration["collation"]  if configuration.include? "collation"
+          end
         end
-      end
 
-      def error_class
-        if configuration['adapter'] =~ /jdbc/
-          require 'active_record/railties/jdbcmysql_error'
-          ArJdbcMySQL::Error
-        elsif defined?(Mysql2)
-          Mysql2::Error
-        else
-          StandardError
+        def error_class
+          if configuration["adapter"].include?("jdbc")
+            require "active_record/railties/jdbcmysql_error"
+            ArJdbcMySQL::Error
+          elsif defined?(Mysql2)
+            Mysql2::Error
+          else
+            StandardError
+          end
         end
-      end
 
-      def grant_statement
-        <<-SQL
-GRANT ALL PRIVILEGES ON #{configuration['database']}.*
+        def grant_statement
+          <<-SQL
+GRANT ALL PRIVILEGES ON `#{configuration['database']}`.*
   TO '#{configuration['username']}'@'localhost'
 IDENTIFIED BY '#{configuration['password']}' WITH GRANT OPTION;
-        SQL
-      end
+          SQL
+        end
 
-      def root_configuration_without_database
-        configuration_without_database.merge(
-          'username' => 'root',
-          'password' => root_password
-        )
-      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
+        def root_password
+          $stdout.print "Please provide the root password for your MySQL installation\n>"
+          $stdin.gets.strip
+        end
 
-      def prepare_command_options
-        args = {
-          'host'      => '--host',
-          'port'      => '--port',
-          'socket'    => '--socket',
-          'username'  => '--user',
-          'password'  => '--password',
-          'encoding'  => '--default-character-set',
-          'sslca'     => '--ssl-ca',
-          'sslcert'   => '--ssl-cert',
-          'sslcapath' => '--ssl-capath',
-          'sslcipher' => '--ssl-cipher',
-          'sslkey'    => '--ssl-key'
-        }.map { |opt, arg| "#{arg}=#{configuration[opt]}" if configuration[opt] }.compact
-
-        args
-      end
+        def prepare_command_options
+          args = {
+            "host"      => "--host",
+            "port"      => "--port",
+            "socket"    => "--socket",
+            "username"  => "--user",
+            "password"  => "--password",
+            "encoding"  => "--default-character-set",
+            "sslca"     => "--ssl-ca",
+            "sslcert"   => "--ssl-cert",
+            "sslcapath" => "--ssl-capath",
+            "sslcipher" => "--ssl-cipher",
+            "sslkey"    => "--ssl-key"
+          }.map { |opt, arg| "#{arg}=#{configuration[opt]}" if configuration[opt] }.compact
+
+          args
+        end
 
-      def run_cmd(cmd, args, action)
-        fail run_cmd_error(cmd, args, action) unless Kernel.system(cmd, *args)
-      end
+        def run_cmd(cmd, args, action)
+          fail run_cmd_error(cmd, args, action) unless Kernel.system(cmd, *args)
+        end
 
-      def run_cmd_error(cmd, args, action)
-        msg = "failed to execute: `#{cmd}`\n"
-        msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
-        msg
-      end
+        def run_cmd_error(cmd, args, action)
+          msg = "failed to execute: `#{cmd}`\n"
+          msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
+          msg
+        end
     end
   end
 end

data/lib/active_record/tasks/postgresql_database_tasks.rb

@@ -1,7 +1,11 @@
+require "tempfile"
+
 module ActiveRecord
   module Tasks # :nodoc:
     class PostgreSQLDatabaseTasks # :nodoc:
-      DEFAULT_ENCODING = ENV['CHARSET'] || 'utf8'
+      DEFAULT_ENCODING = ENV["CHARSET"] || "utf8"
+      ON_ERROR_STOP_1 = "ON_ERROR_STOP=1".freeze
+      SQL_COMMENT_BEGIN = "--".freeze
 
       delegate :connection, :establish_connection, :clear_active_connections!,
         to: ActiveRecord::Base
@@ -12,8 +16,8 @@ module ActiveRecord
 
       def create(master_established = false)
         establish_master_connection unless master_established
-        connection.create_database configuration['database'],
-          configuration.merge('encoding' => encoding)
+        connection.create_database configuration["database"],
+          configuration.merge("encoding" => encoding)
         establish_connection configuration
       rescue ActiveRecord::StatementInvalid => error
         if error.cause.is_a?(PG::DuplicateDatabase)
@@ -25,7 +29,7 @@ module ActiveRecord
 
       def drop
         establish_master_connection
-        connection.drop_database configuration['database']
+        connection.drop_database configuration["database"]
       end
 
       def charset
@@ -42,69 +46,90 @@ module ActiveRecord
         create true
       end
 
-      def structure_dump(filename)
+      def structure_dump(filename, extra_flags)
         set_psql_env
 
-        search_path = case ActiveRecord::Base.dump_schemas
-        when :schema_search_path
-          configuration['schema_search_path']
-        when :all
-          nil
-        when String
-          ActiveRecord::Base.dump_schemas
-        end
+        search_path = \
+          case ActiveRecord::Base.dump_schemas
+          when :schema_search_path
+            configuration["schema_search_path"]
+          when :all
+            nil
+          when String
+            ActiveRecord::Base.dump_schemas
+          end
 
-        args = ['-s', '-x', '-O', '-f', filename]
+        args = ["-s", "-x", "-O", "-f", filename]
+        args.concat(Array(extra_flags)) if extra_flags
         unless search_path.blank?
-          args += search_path.split(',').map do |part|
+          args += search_path.split(",").map do |part|
             "--schema=#{part.strip}"
           end
         end
-        args << configuration['database']
-        run_cmd('pg_dump', args, 'dumping')
+        args << configuration["database"]
+        run_cmd("pg_dump", args, "dumping")
+        remove_sql_header_comments(filename)
         File.open(filename, "a") { |f| f << "SET search_path TO #{connection.schema_search_path};\n\n" }
       end
 
-      def structure_load(filename)
+      def structure_load(filename, extra_flags)
         set_psql_env
-        args = [ '-q', '-f', filename, configuration['database'] ]
-        run_cmd('psql', args, 'loading' )
+        args = ["-v", ON_ERROR_STOP_1, "-q", "-f", filename]
+        args.concat(Array(extra_flags)) if extra_flags
+        args << configuration["database"]
+        run_cmd("psql", args, "loading")
       end
 
       private
 
-      def configuration
-        @configuration
-      end
+        def configuration
+          @configuration
+        end
 
-      def encoding
-        configuration['encoding'] || DEFAULT_ENCODING
-      end
+        def encoding
+          configuration["encoding"] || DEFAULT_ENCODING
+        end
 
-      def establish_master_connection
-        establish_connection configuration.merge(
-          'database'           => 'postgres',
-          'schema_search_path' => 'public'
-        )
-      end
+        def establish_master_connection
+          establish_connection configuration.merge(
+            "database"           => "postgres",
+            "schema_search_path" => "public"
+          )
+        end
 
-      def set_psql_env
-        ENV['PGHOST']     = configuration['host']          if configuration['host']
-        ENV['PGPORT']     = configuration['port'].to_s     if configuration['port']
-        ENV['PGPASSWORD'] = configuration['password'].to_s if configuration['password']
-        ENV['PGUSER']     = configuration['username'].to_s if configuration['username']
-      end
+        def set_psql_env
+          ENV["PGHOST"]     = configuration["host"]          if configuration["host"]
+          ENV["PGPORT"]     = configuration["port"].to_s     if configuration["port"]
+          ENV["PGPASSWORD"] = configuration["password"].to_s if configuration["password"]
+          ENV["PGUSER"]     = configuration["username"].to_s if configuration["username"]
+        end
 
-      def run_cmd(cmd, args, action)
-        fail run_cmd_error(cmd, args, action) unless Kernel.system(cmd, *args)
-      end
+        def run_cmd(cmd, args, action)
+          fail run_cmd_error(cmd, args, action) unless Kernel.system(cmd, *args)
+        end
 
-      def run_cmd_error(cmd, args, action)
-        msg = "failed to execute:\n"
-        msg << "#{cmd} #{args.join(' ')}\n\n"
-        msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
-        msg
-      end
+        def run_cmd_error(cmd, args, action)
+          msg = "failed to execute:\n"
+          msg << "#{cmd} #{args.join(' ')}\n\n"
+          msg << "Please check the output above for any errors and make sure that `#{cmd}` is installed in your PATH and has proper permissions.\n\n"
+          msg
+        end
+
+        def remove_sql_header_comments(filename)
+          removing_comments = true
+          tempfile = Tempfile.open("uncommented_structure.sql")
+          begin
+            File.foreach(filename) do |line|
+              unless removing_comments && (line.start_with?(SQL_COMMENT_BEGIN) || line.blank?)
+                tempfile << line
+                removing_comments = false
+              end
+            end
+          ensure
+            tempfile.close
+          end
+          FileUtils.mv(tempfile.path, filename)
+        end
     end
   end
 end