strong_migrations 2.3.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3538811c535186c2757c2e92a56ec753c77842a99728a727aabe323dd8852182
-  data.tar.gz: 6d33a69582e57e3035d7ef540894ce0020957aef8d4e081e693552615ac9af8b
+  metadata.gz: 971d5d1eabb91dc04c72cc99a24f8b92f1b0d31d8d28369577f48c283b8d8624
+  data.tar.gz: '08a413578f564ada7f9768aeaf469719ca051e4c37057be6324e593c73fb3144'
 SHA512:
-  metadata.gz: 50a4b8ea0d0677bc0d5a3fa740f9f2e8b00acee0e673abaf7197c0c89540165ecb0cad913ed4244b61e3ac23342d4c44b8209991dea3841ee6dd7d7fbef827e3
-  data.tar.gz: fd6d44273d6365ca9e33a246e072a24da93191bfc73b5d425df22c0b3b6523ce218d6aa6360dd6a8fcbcf88b5a06bf41c7221ccdceb69f26b734510cd38876f7
+  metadata.gz: b8ca27268e166609ec8253ce686c6fe9cbe6d7c4b298f8c80ce7f1690e76a2c997fad2806cce52c9765f6ee92e7e389fdf6c830d3ca8ebb0241574adc02c4b57
+  data.tar.gz: 18731d2b1bdd12698d6b860a470249a24ea12aaa0b5b74b6510d41527ef2126c46b27ef4aa7c7adb1437bd7a006d0bb7c46490d24ec15720009723e5b0d8eca4

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 2.5.0 (2025-07-27)
+
+- Added check for `rename_schema`
+- Made `auto_analyze` apply to `add_reference`
+
+## 2.4.0 (2025-06-23)
+
+- Added `remove_invalid_indexes` option to install generator
+- Added experimental `transaction_timeout` option
+- Dropped support for Ruby < 3.2 and Active Record < 7.1
+
 ## 2.3.0 (2025-04-03)
 
 - Added check for `change_column` for columns with check constraints with Postgres

data/README.md

@@ -80,6 +80,7 @@ Postgres-specific checks:
 - [adding a json column](#adding-a-json-column)
 - [setting NOT NULL on an existing column](#setting-not-null-on-an-existing-column)
 - [adding a column with a volatile default value](#adding-a-column-with-a-volatile-default-value)
+- [renaming a schema](#renaming-a-schema)
 
 Config-specific checks:
 
@@ -658,6 +659,31 @@ end
 
 Then [backfill the data](#backfilling-data).
 
+### Renaming a schema
+
+#### Bad
+
+Renaming a schema that’s in use will cause errors in your application.
+
+```ruby
+class RenameUsersToCustomers < ActiveRecord::Migration[8.1]
+  def change
+    rename_schema :users, :customers
+  end
+end
+```
+
+#### Good
+
+A safer approach is to:
+
+1. Create a new schema
+2. Write to both schemas
+3. Backfill data from the old schema to the new schema
+4. Move reads from the old schema to the new schema
+5. Stop writing to the old schema
+6. Drop the old schema
+
 ### Changing the default value of a column
 
 #### Bad
@@ -882,8 +908,6 @@ To automatically remove the invalid index when the migration runs again, use:
 StrongMigrations.remove_invalid_indexes = true
 ```
 
-Note: This feature is experimental.
-
 ## Lock Timeout Retries
 
 Note: This feature is experimental.

data/lib/generators/strong_migrations/templates/initializer.rb.tt

@@ -20,6 +20,9 @@ StrongMigrations.auto_analyze = true
 #   end
 # end<% if postgresql? %>
 
+# Remove invalid indexes when rerunning migrations
+# StrongMigrations.remove_invalid_indexes = true
+
 # Make some operations safe by default
 # See https://github.com/ankane/strong_migrations#safe-by-default
 # StrongMigrations.safe_by_default = true<% end %>

data/lib/strong_migrations/adapters/abstract_adapter.rb

@@ -16,6 +16,10 @@ module StrongMigrations
         # do nothing
       end
 
+      def set_transaction_timeout(timeout)
+        # do nothing
+      end
+
       def set_lock_timeout(timeout)
         # do nothing
       end

data/lib/strong_migrations/adapters/postgresql_adapter.rb

@@ -23,6 +23,11 @@ module StrongMigrations
         set_timeout("statement_timeout", timeout)
       end
 
+      def set_transaction_timeout(timeout)
+        # TODO make sure true version supports it as well?
+        set_timeout("transaction_timeout", timeout) if server_version >= Gem::Version.new("17")
+      end
+
       def set_lock_timeout(timeout)
         set_timeout("lock_timeout", timeout)
       end
@@ -127,21 +132,6 @@ module StrongMigrations
         safe
       end
 
-      # TODO remove when Active Record < 7.1 is no longer supported
-      def index_invalid?(table_name, index_name)
-        query = <<~SQL
-          SELECT
-            indisvalid
-          FROM
-            pg_index
-          WHERE
-            indrelid = to_regclass(#{connection.quote(connection.quote_table_name(table_name))}) AND
-            indexrelid = to_regclass(#{connection.quote(connection.quote_table_name(index_name))}) AND
-            indisvalid = false
-        SQL
-        select_all(query.squish).any?
-      end
-
       def writes_blocked?
         query = <<~SQL
           SELECT

data/lib/strong_migrations/checker.rb

@@ -79,6 +79,8 @@ module StrongMigrations
           check_remove_index(*args)
         when :rename_column
           check_rename_column
+        when :rename_schema
+          check_rename_schema
         when :rename_table
           check_rename_table
         when :validate_check_constraint
@@ -111,7 +113,7 @@ module StrongMigrations
         end
 
       # outdated statistics + a new index can hurt performance of existing queries
-      if StrongMigrations.auto_analyze && direction == :up && method == :add_index
+      if StrongMigrations.auto_analyze && direction == :up && adds_index?(method, *args)
         adapter.analyze_table(args[0])
       end
 
@@ -181,6 +183,9 @@ module StrongMigrations
       if StrongMigrations.statement_timeout
         adapter.set_statement_timeout(StrongMigrations.statement_timeout)
       end
+      if StrongMigrations.transaction_timeout
+        adapter.set_transaction_timeout(StrongMigrations.transaction_timeout)
+      end
       if StrongMigrations.lock_timeout
         adapter.set_lock_timeout(StrongMigrations.lock_timeout)
       end
@@ -253,6 +258,18 @@ module StrongMigrations
       end
     end
 
+    def adds_index?(method, *args)
+      case method
+      when :add_index
+        true
+      when :add_reference, :add_belongs_to
+        options = args.extract_options!
+        !!options.fetch(:index, true)
+      else
+        false
+      end
+    end
+
     # REINDEX INDEX CONCURRENTLY leaves a new invalid index if it fails, so use remove_index instead
     def remove_invalid_index_if_needed(*args)
       options = args.extract_options!
@@ -264,9 +281,6 @@ module StrongMigrations
       table, columns = args
       index_name = options.fetch(:name, connection.index_name(table, columns))
 
-      # valid option is ignored for Active Record < 7.1, so check name as well
-      return if ar_version < 7.1 && !adapter.index_invalid?(table, index_name)
-
       @migration.say("Attempting to remove invalid index")
       without_retries do
         # TODO pass index schema for extra safety?

data/lib/strong_migrations/checks.rb

@@ -384,6 +384,10 @@ module StrongMigrations
       raise_error :rename_column
     end
 
+    def check_rename_schema
+      raise_error :rename_schema
+    end
+
     def check_rename_table
       raise_error :rename_table
     end

data/lib/strong_migrations/error_messages.rb

@@ -102,6 +102,17 @@ in your application. A safer approach is to:
 5. Stop writing to the old column
 6. Drop the old column",
 
+    rename_schema:
+"Renaming a schema that's in use will cause errors
+in your application. A safer approach is to:
+
+1. Create a new schema
+2. Write to both schemas
+3. Backfill data from the old schema to the new schema
+4. Move reads from the old schema to the new schema
+5. Stop writing to the old schema
+6. Drop the old schema",
+
     rename_table:
 "Renaming a table that's in use will cause errors
 in your application. A safer approach is to:

data/lib/strong_migrations/migration.rb

@@ -7,10 +7,7 @@ module StrongMigrations
     end
 
     def method_missing(method, *args)
-      return super if is_a?(ActiveRecord::Schema)
-
-      # Active Record 7.0.2+ versioned schema
-      return super if defined?(ActiveRecord::Schema::Definition) && is_a?(ActiveRecord::Schema::Definition)
+      return super if is_a?(ActiveRecord::Schema) || is_a?(ActiveRecord::Schema::Definition)
 
       catch(:safe) do
         strong_migrations_checker.perform(method, *args) do

data/lib/strong_migrations/migrator.rb

@@ -4,7 +4,7 @@ module StrongMigrations
       return super unless StrongMigrations.lock_timeout_retries > 0 && use_transaction?(migration)
 
       # handle MigrationProxy class
-      migration = migration.send(:migration) if migration.respond_to?(:migration, true)
+      migration = migration.send(:migration) if !migration.is_a?(ActiveRecord::Migration) && migration.respond_to?(:migration, true)
 
       checker = migration.send(:strong_migrations_checker)
       return super if checker.skip?

data/lib/strong_migrations/safe_methods.rb

@@ -46,8 +46,6 @@ module StrongMigrations
     def safe_add_foreign_key(from_table, to_table, *args, **options)
       @migration.reversible do |dir|
         dir.up do
-          # validate option is unintentionally ignored for Active Record < 7.1
-          # https://github.com/rails/rails/pull/45896
           if !connection.foreign_key_exists?(from_table, to_table, **options.merge(validate: false))
             @migration.add_foreign_key(from_table, to_table, *args, **options.merge(validate: false))
           end

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "2.3.0"
+  VERSION = "2.5.0"
 end

data/lib/strong_migrations.rb

@@ -29,7 +29,7 @@ module StrongMigrations
       :target_postgresql_version, :target_mysql_version, :target_mariadb_version,
       :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
+      :alphabetize_schema, :skipped_databases, :remove_invalid_indexes, :transaction_timeout
     attr_writer :lock_timeout_limit
   end
   self.auto_analyze = false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Andrew Kane
@@ -9,7 +9,7 @@ authors:
 - David Waller
 bindir: bin
 cert_chain: []
-date: 2025-04-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
 email:
 - andrew@ankane.org
 - bob.remeika@gmail.com
@@ -65,14 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Catch unsafe migrations in development
 test_files: []