strong_migrations 0.6.0 → 2.3.0

data/lib/strong_migrations.rb

@@ -1,234 +1,69 @@
 # dependencies
 require "active_support"
 
+# adapters
+require_relative "strong_migrations/adapters/abstract_adapter"
+require_relative "strong_migrations/adapters/mysql_adapter"
+require_relative "strong_migrations/adapters/mariadb_adapter"
+require_relative "strong_migrations/adapters/postgresql_adapter"
+
 # modules
-require "strong_migrations/checker"
-require "strong_migrations/database_tasks"
-require "strong_migrations/migration"
-require "strong_migrations/migration_helpers"
-require "strong_migrations/version"
+require_relative "strong_migrations/checks"
+require_relative "strong_migrations/safe_methods"
+require_relative "strong_migrations/checker"
+require_relative "strong_migrations/migration"
+require_relative "strong_migrations/migration_context"
+require_relative "strong_migrations/migrator"
+require_relative "strong_migrations/version"
 
 # integrations
-require "strong_migrations/railtie" if defined?(Rails)
+require_relative "strong_migrations/railtie" if defined?(Rails)
 
 module StrongMigrations
   class Error < StandardError; end
   class UnsafeMigration < Error; end
+  class UnsupportedVersion < Error; end
 
   class << self
     attr_accessor :auto_analyze, :start_after, :checks, :error_messages,
       :target_postgresql_version, :target_mysql_version, :target_mariadb_version,
-      :enabled_checks, :lock_timeout, :statement_timeout, :helpers
+      :enabled_checks, :lock_timeout, :statement_timeout, :check_down, :target_version,
+      :safe_by_default, :target_sql_mode, :lock_timeout_retries, :lock_timeout_retry_delay,
+      :alphabetize_schema, :skipped_databases, :remove_invalid_indexes
+    attr_writer :lock_timeout_limit
   end
   self.auto_analyze = false
   self.start_after = 0
+  self.lock_timeout_retries = 0
+  self.lock_timeout_retry_delay = 10 # seconds
   self.checks = []
-  self.error_messages = {
-    add_column_default:
-"Adding a column with a non-null default causes the entire table to be rewritten.
-Instead, add the column without a default value, then change the default.
-
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  def up
-    %{add_command}
-    %{change_command}
-  end
-
-  def down
-    %{remove_command}
-  end
-end
-
-Then backfill the existing rows in the Rails console or a separate migration with disable_ddl_transaction!.
-
-class Backfill%{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  disable_ddl_transaction!
-
-  def up
-    %{code}
-  end
-end%{append}",
-
-    add_column_json:
-"There's no equality operator for the json column type, which can
-cause errors for existing SELECT DISTINCT queries. Use jsonb instead.",
-
-    change_column:
-"Changing the type of an existing column requires the entire
-table and indexes to be rewritten. A safer approach is to:
-
-1. Create a new column
-2. Write to both columns
-3. Backfill data from the old column to the new column
-4. Move reads from the old column to the new column
-5. Stop writing to the old column
-6. Drop the old column",
-
-    remove_column: "Active Record caches attributes which causes problems
-when removing columns. Be sure to ignore the column%{column_suffix}:
-
-class %{model} < %{base_model}
-  %{code}
-end
-
-Deploy the code, then wrap this step in a safety_assured { ... } block.
-
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  def change
-    safety_assured { %{command} }
-  end
-end",
-
-    rename_column:
-"Renaming a column is dangerous. A safer approach is to:
-
-1. Create a new column
-2. Write to both columns
-3. Backfill data from the old column to new column
-4. Move reads from the old column to the new column
-5. Stop writing to the old column
-6. Drop the old column",
-
-    rename_table:
-"Renaming a table is dangerous. A safer approach is to:
-
-1. Create a new table. Don't forget to recreate indexes from the old table
-2. Write to both tables
-3. Backfill data from the old table to new table
-4. Move reads from the old table to the new table
-5. Stop writing to the old table
-6. Drop the old table",
-
-    add_reference:
-"Adding an index non-concurrently locks the table. Instead, use:
-
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  disable_ddl_transaction!
-
-  def change
-    %{command}
-  end
-end",
-
-    add_index:
-"Adding an index non-concurrently locks the table. Instead, use:
-
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  disable_ddl_transaction!
-
-  def change
-    %{command}
-  end
-end",
-
-    remove_index:
-"Removing an index non-concurrently locks the table. Instead, use:
+  self.safe_by_default = false
+  self.check_down = false
+  self.alphabetize_schema = false
+  self.skipped_databases = []
+  self.remove_invalid_indexes = false
 
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  disable_ddl_transaction!
-
-  def change
-    %{command}
-  end
-end",
-
-    add_index_columns:
-"Adding a non-unique index with more than three columns rarely improves performance.
-Instead, start an index with columns that narrow down the results the most.",
-
-    change_table:
-"Strong Migrations does not support inspecting what happens inside a
-change_table block, so cannot help you here. Please make really sure that what
-you're doing is safe before proceeding, then wrap it in a safety_assured { ... } block.",
-
-    create_table:
-"The force option will destroy existing tables.
-If this is intended, drop the existing table first.
-Otherwise, remove the force option.",
-
-    execute:
-"Strong Migrations does not support inspecting what happens inside an
-execute call, so cannot help you here. Please make really sure that what
-you're doing is safe before proceeding, then wrap it in a safety_assured { ... } block.",
-
-    change_column_null:
-"Passing a default value to change_column_null runs a single UPDATE query,
-which can cause downtime. Instead, backfill the existing rows in the
-Rails console or a separate migration with disable_ddl_transaction!.
-
-class Backfill%{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  disable_ddl_transaction!
-
-  def up
-    %{code}
-  end
-end",
-
-    change_column_null_postgresql:
-"Setting NOT NULL on a column requires an AccessExclusiveLock,
-which is expensive on large tables. Instead, use a constraint and
-validate it in a separate migration with a more agreeable RowShareLock.
-
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  def change
-    %{add_constraint_code}
-  end
-end
-
-class Validate%{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  def change
-    %{validate_constraint_code}
-  end
-end",
-
-    change_column_null_postgresql_helper:
-"Setting NOT NULL on a column requires an AccessExclusiveLock,
-which is expensive on large tables. Instead, we can use a constraint and
-validate it in a separate step with a more agreeable RowShareLock.
-
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  disable_ddl_transaction!
-
-  def change
-    %{command}
-  end
-end",
-
-    change_column_null_mysql:
-"Setting NOT NULL on an existing column is not safe with your database engine.",
-
-    add_foreign_key:
-"New foreign keys are validated by default. This acquires an AccessExclusiveLock,
-which is expensive on large tables. Instead, validate it in a separate migration
-with a more agreeable RowShareLock.
-
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  def change
-    %{add_foreign_key_code}
+  # private
+  def self.developer_env?
+    env == "development" || env == "test"
   end
-end
 
-class Validate%{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  def change
-    %{validate_foreign_key_code}
+  # private
+  def self.env
+    if defined?(Rails.env)
+      Rails.env
+    else
+      # default to production for safety
+      ENV["RACK_ENV"] || "production"
+    end
   end
-end",
-
-    add_foreign_key_helper:
-"New foreign keys are validated by default. This acquires an AccessExclusiveLock,
-which is expensive on large tables. Instead, we can validate it in a separate step
-with a more agreeable RowShareLock.
-
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  disable_ddl_transaction!
 
-  def change
-    %{command}
+  def self.lock_timeout_limit
+    unless defined?(@lock_timeout_limit)
+      @lock_timeout_limit = developer_env? ? false : 10
+    end
+    @lock_timeout_limit
   end
-end",
-  }
-  self.enabled_checks = (error_messages.keys - [:remove_index]).map { |k| [k, {}] }.to_h
-  self.helpers = false
 
   def self.add_check(&block)
     checks << block
@@ -251,18 +86,19 @@ end",
     end
   end
 
-  # def self.enable_helpers
-  #   unless helpers
-  #     ActiveRecord::Migration.include(StrongMigrations::MigrationHelpers)
-  #     self.helpers = true
-  #   end
-  # end
+  def self.skip_database(database)
+    self.skipped_databases << database
+  end
 end
 
+# load error messages
+require_relative "strong_migrations/error_messages"
+
 ActiveSupport.on_load(:active_record) do
   ActiveRecord::Migration.prepend(StrongMigrations::Migration)
+  ActiveRecord::MigrationContext.prepend(StrongMigrations::MigrationContext)
+  ActiveRecord::Migrator.prepend(StrongMigrations::Migrator)
 
-  if defined?(ActiveRecord::Tasks::DatabaseTasks)
-    ActiveRecord::Tasks::DatabaseTasks.singleton_class.prepend(StrongMigrations::DatabaseTasks)
-  end
+  require_relative "strong_migrations/schema_dumper"
+  ActiveRecord::SchemaDumper.prepend(StrongMigrations::SchemaDumper)
 end

data/lib/tasks/strong_migrations.rake

@@ -1,20 +1,9 @@
-# https://nithinbekal.com/posts/safe-rake-tasks
-
 namespace :strong_migrations do
-  task safety_assured: :environment do
-    raise "Set SAFETY_ASSURED=1 to run this task in production" if Rails.env.production? && !ENV["SAFETY_ASSURED"]
-  end
-
-  # https://www.pgrs.net/2008/03/13/alphabetize-schema-rb-columns/
+  # https://www.pgrs.net/2008/03/12/alphabetize-schema-rb-columns/
   task :alphabetize_columns do
     $stderr.puts "Dumping schema"
     ActiveRecord::Base.logger.level = Logger::INFO
 
-    require "strong_migrations/alphabetize_columns"
-    ActiveRecord::Base.connection.class.prepend StrongMigrations::AlphabetizeColumns
-    if ActiveRecord::ConnectionAdapters.const_defined?('PostGISAdapter')
-      ActiveRecord::ConnectionAdapters::PostGISAdapter.prepend StrongMigrations::AlphabetizeColumns
-    end
-    ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend StrongMigrations::AlphabetizeColumns
+    StrongMigrations.alphabetize_schema = true
   end
 end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Andrew Kane
 - Bob Remeika
 - David Waller
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-24 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,73 +17,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '7'
 email:
-- andrew@chartkick.com
+- andrew@ankane.org
 - bob.remeika@gmail.com
 executables: []
 extensions: []
@@ -94,20 +36,28 @@ files:
 - CONTRIBUTING.md
 - LICENSE.txt
 - README.md
+- lib/generators/strong_migrations/install_generator.rb
+- lib/generators/strong_migrations/templates/initializer.rb.tt
 - lib/strong_migrations.rb
-- lib/strong_migrations/alphabetize_columns.rb
+- lib/strong_migrations/adapters/abstract_adapter.rb
+- lib/strong_migrations/adapters/mariadb_adapter.rb
+- lib/strong_migrations/adapters/mysql_adapter.rb
+- lib/strong_migrations/adapters/postgresql_adapter.rb
 - lib/strong_migrations/checker.rb
-- lib/strong_migrations/database_tasks.rb
+- lib/strong_migrations/checks.rb
+- lib/strong_migrations/error_messages.rb
 - lib/strong_migrations/migration.rb
-- lib/strong_migrations/migration_helpers.rb
+- lib/strong_migrations/migration_context.rb
+- lib/strong_migrations/migrator.rb
 - lib/strong_migrations/railtie.rb
+- lib/strong_migrations/safe_methods.rb
+- lib/strong_migrations/schema_dumper.rb
 - lib/strong_migrations/version.rb
 - lib/tasks/strong_migrations.rake
 homepage: https://github.com/ankane/strong_migrations
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -115,15 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Catch unsafe migrations in development
 test_files: []

data/lib/strong_migrations/alphabetize_columns.rb

@@ -1,11 +0,0 @@
-module StrongMigrations
-  module AlphabetizeColumns
-    def columns(*args)
-      super.sort_by(&:name)
-    end
-
-    def extensions(*args)
-      super.sort
-    end
-  end
-end

data/lib/strong_migrations/migration_helpers.rb

@@ -1,117 +0,0 @@
-module StrongMigrations
-  module MigrationHelpers
-    def add_foreign_key_safely(from_table, to_table, **options)
-      ensure_postgresql(__method__)
-      ensure_not_in_transaction(__method__)
-
-      reversible do |dir|
-        dir.up do
-          if ActiveRecord::VERSION::STRING >= "5.2"
-            add_foreign_key(from_table, to_table, options.merge(validate: false))
-            validate_foreign_key(from_table, to_table)
-          else
-            options = connection.foreign_key_options(from_table, to_table, options)
-            fk_name, column, primary_key = options.values_at(:name, :column, :primary_key)
-            primary_key ||= "id"
-
-            statement = ["ALTER TABLE %s ADD CONSTRAINT %s FOREIGN KEY (%s) REFERENCES %s (%s)"]
-            statement << on_delete_update_statement(:delete, options[:on_delete]) if options[:on_delete]
-            statement << on_delete_update_statement(:update, options[:on_update]) if options[:on_update]
-            statement << "NOT VALID"
-
-            safety_assured do
-              execute quote_identifiers(statement.join(" "), [from_table, fk_name, column, to_table, primary_key])
-              execute quote_identifiers("ALTER TABLE %s VALIDATE CONSTRAINT %s", [from_table, fk_name])
-            end
-          end
-        end
-
-        dir.down do
-          remove_foreign_key(from_table, to_table)
-        end
-      end
-    end
-
-    def add_null_constraint_safely(table_name, column_name, name: nil)
-      ensure_postgresql(__method__)
-      ensure_not_in_transaction(__method__)
-
-      reversible do |dir|
-        dir.up do
-          name ||= null_constraint_name(table_name, column_name)
-
-          safety_assured do
-            execute quote_identifiers("ALTER TABLE %s ADD CONSTRAINT %s CHECK (%s IS NOT NULL) NOT VALID", [table_name, name, column_name])
-            execute quote_identifiers("ALTER TABLE %s VALIDATE CONSTRAINT %s", [table_name, name])
-          end
-        end
-
-        dir.down do
-          remove_null_constraint_safely(table_name, column_name)
-        end
-      end
-    end
-
-    # removing constraints is safe, but this method is safe to reverse as well
-    def remove_null_constraint_safely(table_name, column_name, name: nil)
-      # could also ensure in transaction so it can be reversed
-      # but that's more of a concern for a reversible migrations check
-      ensure_postgresql(__method__)
-
-      reversible do |dir|
-        dir.up do
-          name ||= null_constraint_name(table_name, column_name)
-
-          safety_assured do
-            execute quote_identifiers("ALTER TABLE %s DROP CONSTRAINT %s", [table_name, name])
-          end
-        end
-
-        dir.down do
-          add_null_constraint_safely(table_name, column_name)
-        end
-      end
-    end
-
-    private
-
-    def ensure_postgresql(method_name)
-      raise StrongMigrations::Error, "`#{method_name}` is intended for Postgres only" unless postgresql?
-    end
-
-    def postgresql?
-      %w(PostgreSQL PostGIS).include?(connection.adapter_name)
-    end
-
-    def ensure_not_in_transaction(method_name)
-      if connection.transaction_open?
-        raise StrongMigrations::Error, "Cannot run `#{method_name}` inside a transaction. Use `disable_ddl_transaction` to disable the transaction."
-      end
-    end
-
-    # match https://github.com/nullobject/rein
-    def null_constraint_name(table_name, column_name)
-      "#{table_name}_#{column_name}_null"
-    end
-
-    def on_delete_update_statement(delete_or_update, action)
-      on = delete_or_update.to_s.upcase
-
-      case action
-      when :nullify
-        "ON #{on} SET NULL"
-      when :cascade
-        "ON #{on} CASCADE"
-      when :restrict
-        "ON #{on} RESTRICT"
-      else
-        # same error message as Active Record
-        raise "'#{action}' is not supported for :on_update or :on_delete.\nSupported values are: :nullify, :cascade, :restrict"
-      end
-    end
-
-    def quote_identifiers(statement, identifiers)
-      statement % identifiers.map { |v| connection.quote_table_name(v) }
-    end
-  end
-end