strong_migrations 1.3.2 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 227ddfd8f939d855d93232f5d30d02a0c219f46c6393d98e2be5d8756c445e33
-  data.tar.gz: bde562f14e23d1fc7a1209e075efffad03454594b842bcde3c7b1ec6fa3046b4
+  metadata.gz: a296161cd1d5cdd070c94c34bd250feb2d62cb7b5274205007bab92e50dc7d0a
+  data.tar.gz: e95730e625ed31bb3745c0c55fddf4aa2cd6d7d99607add097d23ae1181a8b50
 SHA512:
-  metadata.gz: 972103d956c2a8cdff88e478401f18459eabe93d7260107b5c19908cc76bef9451b19e99852511d8a8675639b076107d79d26a6046308d4627afc88f580afc76
-  data.tar.gz: 3bf1e422cf0d5cd4297bf63a6121570e5afa9acddccf42c4fa7a21eac40fa0cc6d5fca04e2227a45132d7efde0b7f702bb90f3be916097079f9b569cdd04ba50
+  metadata.gz: '03479a3996622262cad8eab0843f6fdd266e041d854ab49ced8dd334e6c9709556f6887f7708d1eeab87f98524bb558e813457f5f0cbb4c16323557353438680'
+  data.tar.gz: 263a6238d3cc34d1211f7f6c6410248f8ee104e475f04f5e3687efb8602389ab26b12ec9155a6e782fc828e733af85b9315e9a282b5589d39f5891b46a5a83e6

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.4.1 (2023-01-05)
+
+- Added support for multiple databases to `target_version`
+
+## 1.4.0 (2022-10-31)
+
+- Added check for `add_exclusion_constraint`
+- Added support for `RACK_ENV`
+- Fixed error when `Rails` defined without `Rails.env`
+- Fixed error with `change_column_null` when table does not exist
+
 ## 1.3.2 (2022-10-09)
 
 - Improved error message for `add_column` with `default: nil` with Postgres 10

data/README.md

@@ -74,6 +74,7 @@ Postgres-specific checks:
 - [adding an index non-concurrently](#adding-an-index-non-concurrently)
 - [adding a reference](#adding-a-reference)
 - [adding a foreign key](#adding-a-foreign-key)
+- [adding an exclusion constraint](#adding-an-exclusion-constraint)
 - [adding a json column](#adding-a-json-column)
 - [setting NOT NULL on an existing column](#setting-not-null-on-an-existing-column)
 
@@ -107,7 +108,7 @@ end
   end
   ```
 
-2. Deploy code
+2. Deploy the code
 3. Write a migration to remove the column (wrap in `safety_assured` block)
 
   ```ruby
@@ -118,7 +119,7 @@ end
   end
   ```
 
-4. Deploy and run migration
+4. Deploy and run the migration
 5. Remove the line added in step 1
 
 ### Adding a column with a default value
@@ -488,6 +489,24 @@ class ValidateForeignKeyOnUsers < ActiveRecord::Migration[7.0]
 end
 ```
 
+### Adding an exclusion constraint
+
+#### Bad
+
+In Postgres, adding an exclusion constraint blocks reads and writes while every row is checked.
+
+```ruby
+class AddExclusionContraint < ActiveRecord::Migration[7.1]
+  def change
+    add_exclusion_constraint :users, "number WITH =", using: :gist
+  end
+end
+```
+
+#### Good
+
+[Let us know](https://github.com/ankane/strong_migrations/issues/new) if you have a safe way to do this (exclusion constraints cannot be marked `NOT VALID`).
+
 ### Adding a json column
 
 #### Bad
@@ -805,6 +824,12 @@ The major version works well for Postgres, while the full version is recommended
 
 For safety, this option only affects development and test environments. In other environments, the actual server version is always used.
 
+If your app has multiple databases with different versions, with Rails 6.1+, you can use:
+
+```ruby
+StrongMigrations.target_version = {primary: 13, catalog: 15}
+```
+
 ## Analyze Tables
 
 Analyze tables automatically (to update planner statistics) after an index is added. Create an initializer with:

data/lib/strong_migrations/adapters/abstract_adapter.rb

@@ -50,7 +50,23 @@ module StrongMigrations
         target_version ||= StrongMigrations.target_version
         version =
           if target_version && StrongMigrations.developer_env?
-            target_version.to_s
+            if target_version.is_a?(Hash)
+              # Active Record 6.0 supports multiple databases
+              # but connection.pool.spec.name always returns "primary"
+              # in migrations with rails db:migrate
+              if ActiveRecord::VERSION::STRING.to_f < 6.1
+                # error class is not shown in db:migrate output so ensure message is descriptive
+                raise StrongMigrations::Error, "StrongMigrations.target_version does not support multiple databases for Active Record < 6.1"
+              end
+
+              db_config_name = connection.pool.db_config.name
+              target_version.stringify_keys.fetch(db_config_name) do
+                # error class is not shown in db:migrate output so ensure message is descriptive
+                raise StrongMigrations::Error, "StrongMigrations.target_version is not configured for :#{db_config_name} database"
+              end.to_s
+            else
+              target_version.to_s
+            end
           else
             yield
           end

data/lib/strong_migrations/adapters/mariadb_adapter.rb

@@ -18,6 +18,9 @@ module StrongMigrations
       end
 
       def set_statement_timeout(timeout)
+        # fix deprecation warning with Active Record 7.1
+        timeout = timeout.value if timeout.is_a?(ActiveSupport::Duration)
+
         select_all("SET max_statement_time = #{connection.quote(timeout)}")
       end
 

data/lib/strong_migrations/adapters/mysql_adapter.rb

@@ -25,6 +25,9 @@ module StrongMigrations
       end
 
       def set_lock_timeout(timeout)
+        # fix deprecation warning with Active Record 7.1
+        timeout = timeout.value if timeout.is_a?(ActiveSupport::Duration)
+
         select_all("SET lock_wait_timeout = #{connection.quote(timeout)}")
       end
 

data/lib/strong_migrations/checker.rb

@@ -36,6 +36,8 @@ module StrongMigrations
           check_add_check_constraint(*args)
         when :add_column
           check_add_column(*args)
+        when :add_exclusion_constraint
+          check_add_exclusion_constraint(*args)
         when :add_foreign_key
           check_add_foreign_key(*args)
         when :add_index

data/lib/strong_migrations/checks.rb

@@ -73,6 +73,14 @@ Then add the NOT NULL constraint in separate migrations."
       end
     end
 
+    def check_add_exclusion_constraint(*args)
+      table = args[0]
+
+      unless new_table?(table)
+        raise_error :add_exclusion_constraint
+      end
+    end
+
     # unlike add_index, we don't make an exception here for new tables
     #
     # with add_index, it's fine to lock a new table even after inserting data
@@ -170,7 +178,8 @@ Then add the foreign key in separate migrations."
       table, column, type = args
 
       safe = false
-      existing_column = connection.columns(table).find { |c| c.name.to_s == column.to_s }
+      table_columns = connection.columns(table) rescue []
+      existing_column = table_columns.find { |c| c.name.to_s == column.to_s }
       if existing_column
         existing_type = existing_column.sql_type.sub(/\(\d+(,\d+)?\)/, "")
         safe = adapter.change_type_safe?(table, column, type, options, existing_column, existing_type)

data/lib/strong_migrations/error_messages.rb

@@ -231,7 +231,10 @@ end",
 
     validate_check_constraint:
 "Validating a check constraint while writes are blocked is dangerous.
-Use disable_ddl_transaction! or a separate migration."
+Use disable_ddl_transaction! or a separate migration.",
+
+    add_exclusion_constraint:
+"Adding an exclusion constraint blocks reads and writes while every row is checked."
   }
   self.enabled_checks = (error_messages.keys - [:remove_index]).map { |k| [k, {}] }.to_h
 end

data/lib/strong_migrations/safe_methods.rb

@@ -64,7 +64,7 @@ module StrongMigrations
           @migration.validate_check_constraint(table, **validate_options)
         end
         dir.down do
-          @migration.remove_check_constraint(table, expression, **add_options)
+          @migration.remove_check_constraint(table, expression, **add_options.except(:validate))
         end
       end
     end

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "1.3.2"
+  VERSION = "1.4.1"
 end

data/lib/strong_migrations.rb

@@ -41,7 +41,17 @@ module StrongMigrations
 
   # private
   def self.developer_env?
-    defined?(Rails) && (Rails.env.development? || Rails.env.test?)
+    env == "development" || env == "test"
+  end
+
+  # private
+  def self.env
+    if defined?(Rails.env)
+      Rails.env
+    else
+      # default to production for safety
+      ENV["RACK_ENV"] || "production"
+    end
   end
 
   def self.lock_timeout_limit

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.1
 platform: ruby
 authors:
 - Andrew Kane
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-10 00:00:00.000000000 Z
+date: 2023-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Catch unsafe migrations in development