strong_migrations 1.8.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6462f35144a092664bb7456db2a1ad402695c6b5b1ba7001c1f1f977ea88d3e
-  data.tar.gz: fc71c84ae237b8dbbd3413af7b47ab4fa9962dcbbdd6b3e99b9edd816d3ae009
+  metadata.gz: c963e6ef1e6a07f02f06e4a9838738df97014adaa3892bb8a8f11de2eb640455
+  data.tar.gz: f50bf92538e55ce8059340adc77ee4697656824b2ad2ca3f5a34a5b1ceb82bc5
 SHA512:
-  metadata.gz: 2c4e5bf21e4bb42046fc2d4a530e40d9fc5f843db7c630779789934ec1a47965398e6b637707dc6a7106eb339ef26231ecfea73c312fd9a04f66f96504fcdc6a
-  data.tar.gz: 542be70454fa38a8ad0c29e6bedcf670e54323ff8d9ae8f5eb59756476bbbaca6092a15f09c54163714e3db83261a8554e1fe51b00da8ad05ca7667a4612c3c8
+  metadata.gz: 04e219c413e77a0ac48465b9387f780d0c15e7e18871f9dfcddb6a8fb2a1cad990d0e612b22e141fdca2da8ead445d5fe8622fcf56648d1b3ff45bcdcfd18788
+  data.tar.gz: 95e7d2ef43b677e975f8ac1ee5ad81b165ea6e0558acbd60448addc085b1a96e39cbf37b288ffd92ae8862e2dbf53f0abb3f21de6f208b806b3c18c9d64977f0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.0.0 (2024-06-28)
+
+- Improved install generator for Trilogy
+- Fixed charset check for MariaDB 11.4
+- Dropped support for Ruby < 3.1 and Active Record < 6.1
+- Dropped support for Postgres < 12, MySQL < 8.0, and MariaDB < 10.5
+
 ## 1.8.0 (2024-03-11)
 
 - Added check for `add_column` with auto-incrementing columns

data/README.md

@@ -64,7 +64,7 @@ Potentially dangerous operations:
 - [renaming a column](#renaming-a-column)
 - [renaming a table](#renaming-a-table)
 - [creating a table with the force option](#creating-a-table-with-the-force-option)
-- [adding an auto-incrementing column](#adding-an-auto-incrementing-column) [unreleased]
+- [adding an auto-incrementing column](#adding-an-auto-incrementing-column)
 - [adding a stored generated column](#adding-a-stored-generated-column)
 - [adding a check constraint](#adding-a-check-constraint)
 - [executing SQL directly](#executing-SQL-directly)
@@ -79,7 +79,7 @@ Postgres-specific checks:
 - [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)
-- [adding a column with a default value](#adding-a-column-with-a-default-value)
+- [adding a column with a volatile default value](#adding-a-column-with-a-volatile-default-value)
 
 Config-specific checks:
 
@@ -506,7 +506,7 @@ end
 In Postgres, adding a unique constraint creates a unique index, which blocks reads and writes.
 
 ```ruby
-class AddUniqueContraint < ActiveRecord::Migration[7.1]
+class AddUniqueConstraint < ActiveRecord::Migration[7.1]
   def change
     add_unique_constraint :users, :some_column
   end
@@ -518,7 +518,7 @@ end
 Create a unique index concurrently, then use it for the constraint.
 
 ```ruby
-class AddUniqueContraint < ActiveRecord::Migration[7.1]
+class AddUniqueConstraint < ActiveRecord::Migration[7.1]
   disable_ddl_transaction!
 
   def up
@@ -539,7 +539,7 @@ end
 In Postgres, adding an exclusion constraint blocks reads and writes while every row is checked.
 
 ```ruby
-class AddExclusionContraint < ActiveRecord::Migration[7.1]
+class AddExclusionConstraint < ActiveRecord::Migration[7.1]
   def change
     add_exclusion_constraint :users, "number WITH =", using: :gist
   end
@@ -596,8 +596,6 @@ end
 
 Instead, add a check constraint.
 
-For Rails 6.1+, use:
-
 ```ruby
 class SetSomeColumnNotNull < ActiveRecord::Migration[7.1]
   def change
@@ -606,68 +604,32 @@ class SetSomeColumnNotNull < ActiveRecord::Migration[7.1]
 end
 ```
 
-For Rails < 6.1, use:
-
-```ruby
-class SetSomeColumnNotNull < ActiveRecord::Migration[6.0]
-  def change
-    safety_assured do
-      execute 'ALTER TABLE "users" ADD CONSTRAINT "users_some_column_null" CHECK ("some_column" IS NOT NULL) NOT VALID'
-    end
-  end
-end
-```
-
-Then validate it in a separate migration. A `NOT NULL` check constraint is [functionally equivalent](https://medium.com/doctolib/adding-a-not-null-constraint-on-pg-faster-with-minimal-locking-38b2c00c4d1c) to setting `NOT NULL` on the column (but it won’t show up in `schema.rb` in Rails < 6.1). In Postgres 12+, once the check constraint is validated, you can safely set `NOT NULL` on the column and drop the check constraint.
-
-For Rails 6.1+, use:
+Then validate it in a separate migration. Once the check constraint is validated, you can safely set `NOT NULL` on the column and drop the check constraint.
 
 ```ruby
 class ValidateSomeColumnNotNull < ActiveRecord::Migration[7.1]
   def change
     validate_check_constraint :users, name: "users_some_column_null"
-
-    # in Postgres 12+, you can then safely set NOT NULL on the column
     change_column_null :users, :some_column, false
     remove_check_constraint :users, name: "users_some_column_null"
   end
 end
 ```
 
-For Rails < 6.1, use:
-
-```ruby
-class ValidateSomeColumnNotNull < ActiveRecord::Migration[6.0]
-  def change
-    safety_assured do
-      execute 'ALTER TABLE "users" VALIDATE CONSTRAINT "users_some_column_null"'
-    end
-
-    # in Postgres 12+, you can then safely set NOT NULL on the column
-    change_column_null :users, :some_column, false
-    safety_assured do
-      execute 'ALTER TABLE "users" DROP CONSTRAINT "users_some_column_null"'
-    end
-  end
-end
-```
-
-### Adding a column with a default value
+### Adding a column with a volatile default value
 
 #### Bad
 
-In earlier versions of Postgres, adding a column with a default value to an existing table causes the entire table to be rewritten. During this time, reads and writes are blocked in Postgres.
+Adding a column with a volatile default value to an existing table causes the entire table to be rewritten. During this time, reads and writes are blocked.
 
 ```ruby
 class AddSomeColumnToUsers < ActiveRecord::Migration[7.1]
   def change
-    add_column :users, :some_column, :text, default: "default_value"
+    add_column :users, :some_column, :uuid, default: "gen_random_uuid()"
   end
 end
 ```
 
-In Postgres 11+, this no longer requires a table rewrite and is safe (except for volatile functions like `gen_random_uuid()`).
-
 #### Good
 
 Instead, add the column without a default value, then change the default.
@@ -675,8 +637,8 @@ Instead, add the column without a default value, then change the default.
 ```ruby
 class AddSomeColumnToUsers < ActiveRecord::Migration[7.1]
   def up
-    add_column :users, :some_column, :text
-    change_column_default :users, :some_column, "default_value"
+    add_column :users, :some_column, :uuid
+    change_column_default :users, :some_column, from: nil, to: "gen_random_uuid()"
   end
 
   def down
@@ -738,7 +700,7 @@ Instead, start an index with columns that narrow down the results the most.
 ```ruby
 class AddSomeIndexToUsers < ActiveRecord::Migration[7.1]
   def change
-    add_index :users, [:b, :d]
+    add_index :users, [:d, :b]
   end
 end
 ```
@@ -925,14 +887,14 @@ Use the version from your latest migration.
 If your development database version is different from production, you can specify the production version so the right checks run in development.
 
 ```ruby
-StrongMigrations.target_version = 10 # or "8.0.12", "10.3.2", etc
+StrongMigrations.target_version = 10 # or 8.0, 10.5, etc
 ```
 
-The major version works well for Postgres, while the full version is recommended for MySQL and MariaDB.
+The major version works well for Postgres, while the major and minor version is recommended for MySQL and MariaDB.
 
 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:
+If your app has multiple databases with different versions, you can use:
 
 ```ruby
 StrongMigrations.target_version = {primary: 13, catalog: 15}

data/lib/generators/strong_migrations/install_generator.rb

@@ -21,21 +21,17 @@ module StrongMigrations
 
       def target_version
         case adapter
-        when /mysql/
+        when /mysql|trilogy/
           # could try to connect to database and check for MariaDB
           # but this should be fine
-          '"8.0.12"'
+          "8.0"
         else
           "10"
         end
       end
 
       def adapter
-        if ActiveRecord::VERSION::STRING.to_f >= 6.1
-          ActiveRecord::Base.connection_db_config.adapter.to_s
-        else
-          ActiveRecord::Base.connection_config[:adapter].to_s
-        end
+        ActiveRecord::Base.connection_db_config.adapter.to_s
       end
 
       def postgresql?

data/lib/strong_migrations/adapters/abstract_adapter.rb

@@ -55,14 +55,6 @@ module StrongMigrations
         version =
           if target_version && StrongMigrations.developer_env?
             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

data/lib/strong_migrations/adapters/mariadb_adapter.rb

@@ -6,7 +6,7 @@ module StrongMigrations
       end
 
       def min_version
-        "10.2"
+        "10.5"
       end
 
       def server_version

data/lib/strong_migrations/adapters/mysql_adapter.rb

@@ -8,7 +8,7 @@ module StrongMigrations
       end
 
       def min_version
-        "5.7"
+        "8.0"
       end
 
       def server_version
@@ -65,9 +65,10 @@ module StrongMigrations
             sql = <<~SQL
               SELECT cs.MAXLEN
               FROM INFORMATION_SCHEMA.CHARACTER_SETS cs
-              INNER JOIN INFORMATION_SCHEMA.COLLATIONS c ON c.CHARACTER_SET_NAME = cs.CHARACTER_SET_NAME
-              INNER JOIN INFORMATION_SCHEMA.TABLES t ON t.TABLE_COLLATION = c.COLLATION_NAME
-              WHERE t.TABLE_SCHEMA = database() AND t.TABLE_NAME = #{connection.quote(table)}
+              INNER JOIN INFORMATION_SCHEMA.COLUMNS c ON c.CHARACTER_SET_NAME = cs.CHARACTER_SET_NAME
+              WHERE c.TABLE_SCHEMA = database() AND
+              c.TABLE_NAME = #{connection.quote(table)} AND
+              c.COLUMN_NAME = #{connection.quote(column)}
             SQL
             row = connection.select_all(sql).first
             if row

data/lib/strong_migrations/adapters/postgresql_adapter.rb

@@ -6,7 +6,7 @@ module StrongMigrations
       end
 
       def min_version
-        "10"
+        "12"
       end
 
       def server_version
@@ -42,7 +42,7 @@ module StrongMigrations
       end
 
       def add_column_default_safe?
-        server_version >= Gem::Version.new("11")
+        true
       end
 
       def change_type_safe?(table, column, type, options, existing_column, existing_type)
@@ -95,7 +95,7 @@ module StrongMigrations
             "timestamp" => "timestamp without time zone",
             "timestamptz" => "timestamp with time zone"
           }
-          maybe_safe = type_map.values.include?(existing_type) && precision >= existing_precision
+          maybe_safe = type_map.value?(existing_type) && precision >= existing_precision
 
           if maybe_safe
             new_type = type.to_s == "datetime" ? datetime_type : type.to_s
@@ -103,7 +103,7 @@ module StrongMigrations
             # resolve with fallback
             new_type = type_map[new_type] || new_type
 
-            safe = new_type == existing_type || (server_version >= Gem::Version.new("12") && time_zone == "UTC")
+            safe = new_type == existing_type || time_zone == "UTC"
           end
         when "time"
           precision = options[:precision] || options[:limit] || 6

data/lib/strong_migrations/checks.rb

@@ -39,27 +39,20 @@ module StrongMigrations
       #
       # Also, Active Record has special case for uuid columns that allows function default values
       # https://github.com/rails/rails/blob/v7.0.3.1/activerecord/lib/active_record/connection_adapters/postgresql/quoting.rb#L92-L93
-      if options.key?(:default) && (!adapter.add_column_default_safe? || (volatile = (postgresql? && type.to_s == "uuid" && default.to_s.include?("()") && adapter.default_volatile?(default))))
+      if !default.nil? && (!adapter.add_column_default_safe? || (volatile = (postgresql? && type.to_s == "uuid" && default.to_s.include?("()") && adapter.default_volatile?(default))))
         if options[:null] == false
           options = options.except(:null)
           append = "\n\nThen add the NOT NULL constraint in separate migrations."
         end
 
-        if default.nil?
-          raise_error :add_column_default_null,
-            command: command_str("add_column", [table, column, type, options.except(:default)]),
-            append: append,
-            rewrite_blocks: adapter.rewrite_blocks
-        else
-          raise_error :add_column_default,
-            add_command: command_str("add_column", [table, column, type, options.except(:default)]),
-            change_command: command_str("change_column_default", [table, column, default]),
-            remove_command: command_str("remove_column", [table, column]),
-            code: backfill_code(table, column, default, volatile),
-            append: append,
-            rewrite_blocks: adapter.rewrite_blocks,
-            default_type: (volatile ? "volatile" : "non-null")
-        end
+        raise_error :add_column_default,
+          add_command: command_str("add_column", [table, column, type, options.except(:default)]),
+          change_command: command_str("change_column_default", [table, column, default]),
+          remove_command: command_str("remove_column", [table, column]),
+          code: backfill_code(table, column, default, volatile),
+          append: append,
+          rewrite_blocks: adapter.rewrite_blocks,
+          default_type: (volatile ? "volatile" : "non-null")
       elsif default.is_a?(Proc) && postgresql?
         # adding a column with a VOLATILE default is not safe
         # https://www.postgresql.org/docs/current/sql-altertable.html#SQL-ALTERTABLE-NOTES
@@ -235,11 +228,7 @@ module StrongMigrations
       table, column, null, default = args
       if !null
         if postgresql?
-          safe = false
-          safe_with_check_constraint = adapter.server_version >= Gem::Version.new("12")
-          if safe_with_check_constraint
-            safe = adapter.constraints(table).any? { |c| c["def"] == "CHECK ((#{column} IS NOT NULL))" || c["def"] == "CHECK ((#{connection.quote_column_name(column)} IS NOT NULL))" }
-          end
+          safe = adapter.constraints(table).any? { |c| c["def"] == "CHECK ((#{column} IS NOT NULL))" || c["def"] == "CHECK ((#{connection.quote_column_name(column)} IS NOT NULL))" }
 
           unless safe
             # match https://github.com/nullobject/rein
@@ -249,46 +238,22 @@ module StrongMigrations
             validate_code = constraint_str("ALTER TABLE %s VALIDATE CONSTRAINT %s", [table, constraint_name])
             remove_code = constraint_str("ALTER TABLE %s DROP CONSTRAINT %s", [table, constraint_name])
 
-            constraint_methods = ar_version >= 6.1
-
-            validate_constraint_code =
-              if constraint_methods
-                String.new(command_str(:validate_check_constraint, [table, {name: constraint_name}]))
-              else
-                String.new(safety_assured_str(validate_code))
-              end
+            validate_constraint_code = String.new(command_str(:validate_check_constraint, [table, {name: constraint_name}]))
 
-            if safe_with_check_constraint
-              change_args = [table, column, null]
+            change_args = [table, column, null]
 
-              validate_constraint_code << "\n    #{command_str(:change_column_null, change_args)}"
-
-              if constraint_methods
-                validate_constraint_code << "\n    #{command_str(:remove_check_constraint, [table, {name: constraint_name}])}"
-              else
-                validate_constraint_code << "\n    #{safety_assured_str(remove_code)}"
-              end
-            end
+            validate_constraint_code << "\n    #{command_str(:change_column_null, change_args)}"
+            validate_constraint_code << "\n    #{command_str(:remove_check_constraint, [table, {name: constraint_name}])}"
 
             if StrongMigrations.safe_by_default
               safe_change_column_null(add_code, validate_code, change_args, remove_code, default)
               throw :safe
             end
 
-            add_constraint_code =
-              if constraint_methods
-                command_str(:add_check_constraint, [table, "#{quote_column_if_needed(column)} IS NOT NULL", {name: constraint_name, validate: false}])
-              else
-                safety_assured_str(add_code)
-              end
-
-            validate_constraint_code =
-              if safe_with_check_constraint
-                down_code = "#{add_constraint_code}\n    #{command_str(:change_column_null, [table, column, true])}"
-                "def up\n    #{validate_constraint_code}\n  end\n\n  def down\n    #{down_code}\n  end"
-              else
-                "def change\n    #{validate_constraint_code}\n  end"
-              end
+            add_constraint_code = command_str(:add_check_constraint, [table, "#{quote_column_if_needed(column)} IS NOT NULL", {name: constraint_name, validate: false}])
+
+            down_code = "#{add_constraint_code}\n    #{command_str(:change_column_null, [table, column, true])}"
+            validate_constraint_code = "def up\n    #{validate_constraint_code}\n  end\n\n  def down\n    #{down_code}\n  end"
 
             raise_error :change_column_null_postgresql,
               add_constraint_code: add_constraint_code,
@@ -373,12 +338,6 @@ module StrongMigrations
         # avoid suggesting extra (invalid) args
         args = args[0..1] unless StrongMigrations.safe_by_default
 
-        # Active Record < 6.1 only supports two arguments (including options)
-        if args.size == 2 && ar_version < 6.1
-          # arg takes precedence over option
-          options[:column] = args.pop
-        end
-
         if StrongMigrations.safe_by_default
           safe_remove_index(*args, **options)
           throw :safe
@@ -487,7 +446,7 @@ module StrongMigrations
     # only quote when needed
     # important! only use for display purposes
     def quote_column_if_needed(column)
-      column.to_s =~ /\A[a-z0-9_]+\z/ ? column : connection.quote_column_name(column)
+      /\A[a-z0-9_]+\z/.match?(column.to_s) ? column : connection.quote_column_name(column)
     end
 
     def new_table?(table)

data/lib/strong_migrations/error_messages.rb

@@ -25,16 +25,6 @@ class Backfill%{migration_name} < ActiveRecord::Migration%{migration_suffix}
   end
 end",
 
-    add_column_default_null:
-"Adding a column with a null default blocks %{rewrite_blocks} while the entire table is rewritten.
-Instead, add the column without a default value.
-
-class %{migration_name} < ActiveRecord::Migration%{migration_suffix}
-  def change
-    %{command}
-  end
-end",
-
     add_column_default_callable:
 "Strong Migrations does not support inspecting callable default values.
 Please make really sure you're not calling a VOLATILE function,

data/lib/strong_migrations/safe_methods.rb

@@ -50,19 +50,11 @@ module StrongMigrations
           @migration.add_foreign_key(from_table, to_table, *args, **options.merge(validate: false))
           disable_transaction
           validate_options = options.slice(:column, :name)
-          if ActiveRecord::VERSION::MAJOR >= 6
-            @migration.validate_foreign_key(from_table, to_table, **validate_options)
-          else
-            @migration.validate_foreign_key(from_table, validate_options.any? ? validate_options : to_table)
-          end
+          @migration.validate_foreign_key(from_table, to_table, **validate_options)
         end
         dir.down do
           remove_options = options.slice(:column, :name)
-          if ActiveRecord::VERSION::MAJOR >= 6
-            @migration.remove_foreign_key(from_table, to_table, **remove_options)
-          else
-            @migration.remove_foreign_key(from_table, remove_options.any? ? remove_options : to_table)
-          end
+          @migration.remove_foreign_key(from_table, to_table, **remove_options)
         end
       end
     end

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "1.8.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Andrew Kane
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-12 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 description:
 email:
 - andrew@ankane.org
@@ -68,14 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Catch unsafe migrations in development