strong_migrations 0.7.5 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2361d565fefd198370b908622526d01c4b5052f5361947c6410d1176b21b20a9
-  data.tar.gz: c9ee9a7b444980b957f60dbb09290a5296a94e9f121af6b1d83756b2645ab54e
+  metadata.gz: c2fb3fbcc5caf98759ebe2ef05a4ef011eca91924e479647d36e2b261baf2c8e
+  data.tar.gz: '0118bd4e05814f2d531a659a724237080763843bd6cb3ff0b880447348004585'
 SHA512:
-  metadata.gz: ca57e53122e37d7674143a48a5699bacf07f07f3c638abbf71331a3c4686a1e08f4f1fa02160e99ea0e21ed3a811aa43dc11581143b0229f5201ddc335fd792b
-  data.tar.gz: 4b760e24cda9a14efed64300992645ec9e4b207bbafb5210bdfd2195764980cc0ab08ebbd6693aac6518d5302da918a74e20d5d282d654700efe89e4a8418a63
+  metadata.gz: 7a04ea74876b44c645c9cba04c2f7b4932fcc0637eedd78b544dadf40272c84fb0461420e66c49c991c214f5d36b53acbface0347af25cb65c1e9c1251375886
+  data.tar.gz: 8e97437c5eae3b3aa6508e08c21aa8caf648a03989e621d37c165d1a2412a3cc67784d0923d47e7f814475bb000c6e68e93bf5ce6ef5dbd83f03fc399bb85b4c

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.7.9 (2021-12-15)
+
+- Fixed error with multiple databases with Active Record 7
+
+## 0.7.8 (2021-08-03)
+
+- Fixed issue with `add_reference ..., foreign_key: {to_table: ...}` with `safe_by_default`
+
+## 0.7.7 (2021-06-07)
+
+- Removed timeouts and `auto_analyze` from schema load
+
+## 0.7.6 (2021-01-17)
+
+- Fixed `NOT NULL` constraint check for quoted columns
+- Fixed deprecation warning with Active Record 6.1
+
 ## 0.7.5 (2021-01-12)
 
 - Added checks for `add_check_constraint` and `validate_check_constraint`

data/README.md

@@ -43,7 +43,7 @@ end
 
 Deploy the code, then wrap this step in a safety_assured { ... } block.
 
-class RemoveColumn < ActiveRecord::Migration[6.1]
+class RemoveColumn < ActiveRecord::Migration[7.0]
   def change
     safety_assured { remove_column :users, :name }
   end
@@ -90,7 +90,7 @@ You can also add [custom checks](#custom-checks) or [disable specific checks](#d
 Active Record caches database columns at runtime, so if you drop a column, it can cause exceptions until your app reboots.
 
 ```ruby
-class RemoveSomeColumnFromUsers < ActiveRecord::Migration[6.1]
+class RemoveSomeColumnFromUsers < ActiveRecord::Migration[7.0]
   def change
     remove_column :users, :some_column
   end
@@ -111,7 +111,7 @@ end
 3. Write a migration to remove the column (wrap in `safety_assured` block)
 
   ```ruby
-  class RemoveSomeColumnFromUsers < ActiveRecord::Migration[6.1]
+  class RemoveSomeColumnFromUsers < ActiveRecord::Migration[7.0]
     def change
       safety_assured { remove_column :users, :some_column }
     end
@@ -127,7 +127,7 @@ end
 In earlier versions of Postgres, MySQL, and MariaDB, 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, and writes are blocked in MySQL and MariaDB.
 
 ```ruby
-class AddSomeColumnToUsers < ActiveRecord::Migration[6.1]
+class AddSomeColumnToUsers < ActiveRecord::Migration[7.0]
   def change
     add_column :users, :some_column, :text, default: "default_value"
   end
@@ -141,7 +141,7 @@ In Postgres 11+, MySQL 8.0.12+, and MariaDB 10.3.2+, this no longer requires a t
 Instead, add the column without a default value, then change the default.
 
 ```ruby
-class AddSomeColumnToUsers < ActiveRecord::Migration[6.1]
+class AddSomeColumnToUsers < ActiveRecord::Migration[7.0]
   def up
     add_column :users, :some_column, :text
     change_column_default :users, :some_column, "default_value"
@@ -162,7 +162,7 @@ See the next section for how to backfill.
 Active Record creates a transaction around each migration, and backfilling in the same transaction that alters a table keeps the table locked for the [duration of the backfill](https://wework.github.io/data/2015/11/05/add-columns-with-default-values-to-large-tables-in-rails-postgres/).
 
 ```ruby
-class AddSomeColumnToUsers < ActiveRecord::Migration[6.1]
+class AddSomeColumnToUsers < ActiveRecord::Migration[7.0]
   def change
     add_column :users, :some_column, :text
     User.update_all some_column: "default_value"
@@ -177,7 +177,7 @@ Also, running a single query to update data can cause issues for large tables.
 There are three keys to backfilling safely: batching, throttling, and running it outside a transaction. Use the Rails console or a separate migration with `disable_ddl_transaction!`.
 
 ```ruby
-class BackfillSomeColumn < ActiveRecord::Migration[6.1]
+class BackfillSomeColumn < ActiveRecord::Migration[7.0]
   disable_ddl_transaction!
 
   def up
@@ -196,7 +196,7 @@ end
 Changing the type of a column causes the entire table to be rewritten. During this time, reads and writes are blocked in Postgres, and writes are blocked in MySQL and MariaDB.
 
 ```ruby
-class ChangeSomeColumnType < ActiveRecord::Migration[6.1]
+class ChangeSomeColumnType < ActiveRecord::Migration[7.0]
   def change
     change_column :users, :some_column, :new_type
   end
@@ -235,7 +235,7 @@ A safer approach is to:
 Renaming a column that’s in use will cause errors in your application.
 
 ```ruby
-class RenameSomeColumn < ActiveRecord::Migration[6.1]
+class RenameSomeColumn < ActiveRecord::Migration[7.0]
   def change
     rename_column :users, :some_column, :new_name
   end
@@ -260,7 +260,7 @@ A safer approach is to:
 Renaming a table that’s in use will cause errors in your application.
 
 ```ruby
-class RenameUsersToCustomers < ActiveRecord::Migration[6.1]
+class RenameUsersToCustomers < ActiveRecord::Migration[7.0]
   def change
     rename_table :users, :customers
   end
@@ -285,7 +285,7 @@ A safer approach is to:
 The `force` option can drop an existing table.
 
 ```ruby
-class CreateUsers < ActiveRecord::Migration[6.1]
+class CreateUsers < ActiveRecord::Migration[7.0]
   def change
     create_table :users, force: true do |t|
       # ...
@@ -299,7 +299,7 @@ end
 Create tables without the `force` option.
 
 ```ruby
-class CreateUsers < ActiveRecord::Migration[6.1]
+class CreateUsers < ActiveRecord::Migration[7.0]
   def change
     create_table :users do |t|
       # ...
@@ -319,7 +319,7 @@ If you intend to drop an existing table, run `drop_table` first.
 Adding a check constraint blocks reads and writes in Postgres and blocks writes in MySQL and MariaDB while every row is checked.
 
 ```ruby
-class AddCheckConstraint < ActiveRecord::Migration[6.1]
+class AddCheckConstraint < ActiveRecord::Migration[7.0]
   def change
     add_check_constraint :users, "price > 0", name: "price_check"
   end
@@ -331,7 +331,7 @@ end
 Add the check constraint without validating existing rows:
 
 ```ruby
-class AddCheckConstraint < ActiveRecord::Migration[6.1]
+class AddCheckConstraint < ActiveRecord::Migration[7.0]
   def change
     add_check_constraint :users, "price > 0", name: "price_check", validate: false
   end
@@ -341,7 +341,7 @@ end
 Then validate them in a separate migration.
 
 ```ruby
-class ValidateCheckConstraint < ActiveRecord::Migration[6.1]
+class ValidateCheckConstraint < ActiveRecord::Migration[7.0]
   def change
     validate_check_constraint :users, name: "price_check"
   end
@@ -361,7 +361,7 @@ end
 Setting `NOT NULL` on an existing column blocks reads and writes while every row is checked.
 
 ```ruby
-class SetSomeColumnNotNull < ActiveRecord::Migration[6.1]
+class SetSomeColumnNotNull < ActiveRecord::Migration[7.0]
   def change
     change_column_null :users, :some_column, false
   end
@@ -375,7 +375,7 @@ Instead, add a check constraint.
 For Rails 6.1, use:
 
 ```ruby
-class SetSomeColumnNotNull < ActiveRecord::Migration[6.1]
+class SetSomeColumnNotNull < ActiveRecord::Migration[7.0]
   def change
     add_check_constraint :users, "some_column IS NOT NULL", name: "users_some_column_null", validate: false
   end
@@ -399,7 +399,7 @@ Then validate it in a separate migration. A `NOT NULL` check constraint is [func
 For Rails 6.1, use:
 
 ```ruby
-class ValidateSomeColumnNotNull < ActiveRecord::Migration[6.1]
+class ValidateSomeColumnNotNull < ActiveRecord::Migration[7.0]
   def change
     validate_check_constraint :users, name: "users_some_column_null"
 
@@ -437,7 +437,7 @@ end
 Strong Migrations can’t ensure safety for raw SQL statements. Make really sure that what you’re doing is safe, then use:
 
 ```ruby
-class ExecuteSQL < ActiveRecord::Migration[6.1]
+class ExecuteSQL < ActiveRecord::Migration[7.0]
   def change
     safety_assured { execute "..." }
   end
@@ -453,7 +453,7 @@ end
 In Postgres, adding an index non-concurrently blocks writes.
 
 ```ruby
-class AddSomeIndexToUsers < ActiveRecord::Migration[6.1]
+class AddSomeIndexToUsers < ActiveRecord::Migration[7.0]
   def change
     add_index :users, :some_column
   end
@@ -465,7 +465,7 @@ end
 Add indexes concurrently.
 
 ```ruby
-class AddSomeIndexToUsers < ActiveRecord::Migration[6.1]
+class AddSomeIndexToUsers < ActiveRecord::Migration[7.0]
   disable_ddl_transaction!
 
   def change
@@ -491,7 +491,7 @@ rails g index table column
 Rails adds an index non-concurrently to references by default, which blocks writes in Postgres.
 
 ```ruby
-class AddReferenceToUsers < ActiveRecord::Migration[6.1]
+class AddReferenceToUsers < ActiveRecord::Migration[7.0]
   def change
     add_reference :users, :city
   end
@@ -503,7 +503,7 @@ end
 Make sure the index is added concurrently.
 
 ```ruby
-class AddReferenceToUsers < ActiveRecord::Migration[6.1]
+class AddReferenceToUsers < ActiveRecord::Migration[7.0]
   disable_ddl_transaction!
 
   def change
@@ -521,7 +521,7 @@ end
 In Postgres, adding a foreign key blocks writes on both tables.
 
 ```ruby
-class AddForeignKeyOnUsers < ActiveRecord::Migration[6.1]
+class AddForeignKeyOnUsers < ActiveRecord::Migration[7.0]
   def change
     add_foreign_key :users, :orders
   end
@@ -531,7 +531,7 @@ end
 or
 
 ```ruby
-class AddReferenceToUsers < ActiveRecord::Migration[6.1]
+class AddReferenceToUsers < ActiveRecord::Migration[7.0]
   def change
     add_reference :users, :order, foreign_key: true
   end
@@ -545,7 +545,7 @@ Add the foreign key without validating existing rows, then validate them in a se
 For Rails 5.2+, use:
 
 ```ruby
-class AddForeignKeyOnUsers < ActiveRecord::Migration[6.1]
+class AddForeignKeyOnUsers < ActiveRecord::Migration[7.0]
   def change
     add_foreign_key :users, :orders, validate: false
   end
@@ -555,7 +555,7 @@ end
 Then:
 
 ```ruby
-class ValidateForeignKeyOnUsers < ActiveRecord::Migration[6.1]
+class ValidateForeignKeyOnUsers < ActiveRecord::Migration[7.0]
   def change
     validate_foreign_key :users, :orders
   end
@@ -593,7 +593,7 @@ end
 In Postgres, there’s no equality operator for the `json` column type, which can cause errors for existing `SELECT DISTINCT` queries in your application.
 
 ```ruby
-class AddPropertiesToUsers < ActiveRecord::Migration[6.1]
+class AddPropertiesToUsers < ActiveRecord::Migration[7.0]
   def change
     add_column :users, :properties, :json
   end
@@ -605,7 +605,7 @@ end
 Use `jsonb` instead.
 
 ```ruby
-class AddPropertiesToUsers < ActiveRecord::Migration[6.1]
+class AddPropertiesToUsers < ActiveRecord::Migration[7.0]
   def change
     add_column :users, :properties, :jsonb
   end
@@ -619,7 +619,7 @@ end
 Adding a non-unique index with more than three columns rarely improves performance.
 
 ```ruby
-class AddSomeIndexToUsers < ActiveRecord::Migration[6.1]
+class AddSomeIndexToUsers < ActiveRecord::Migration[7.0]
   def change
     add_index :users, [:a, :b, :c, :d]
   end
@@ -631,7 +631,7 @@ end
 Instead, start an index with columns that narrow down the results the most.
 
 ```ruby
-class AddSomeIndexToUsers < ActiveRecord::Migration[6.1]
+class AddSomeIndexToUsers < ActiveRecord::Migration[7.0]
   def change
     add_index :users, [:b, :d]
   end
@@ -645,7 +645,7 @@ For Postgres, be sure to add them concurrently.
 To mark a step in the migration as safe, despite using a method that might otherwise be dangerous, wrap it in a `safety_assured` block.
 
 ```ruby
-class MySafeMigration < ActiveRecord::Migration[6.1]
+class MySafeMigration < ActiveRecord::Migration[7.0]
   def change
     safety_assured { remove_column :users, :some_column }
   end
@@ -656,8 +656,6 @@ Certain methods like `execute` and `change_table` cannot be inspected and are pr
 
 ## Safe by Default
 
-*Experimental*
-
 Make operations safe by default.
 
 - adding and removing an index
@@ -820,11 +818,15 @@ StrongMigrations.auto_analyze = true
 
 ## Faster Migrations
 
-Only dump the schema when adding a new migration. If you use Git, create an initializer with:
+Only dump the schema when adding a new migration. If you use Git, add to the end of your `Rakefile`:
 
-```ruby
-ActiveRecord::Base.dump_schema_after_migration = Rails.env.development? &&
-  `git status db/migrate/ --porcelain`.present?
+```rb
+task :faster_migrations do
+  ActiveRecord::Base.dump_schema_after_migration = Rails.env.development? &&
+    `git status db/migrate/ --porcelain`.present?
+end
+
+task "db:migrate": "faster_migrations"
 ```
 
 ## Schema Sanity

data/lib/generators/strong_migrations/install_generator.rb

@@ -31,7 +31,11 @@ module StrongMigrations
       end
 
       def adapter
-        ActiveRecord::Base.connection_config[:adapter].to_s
+        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
       end
 
       def postgresql?

data/lib/strong_migrations/checker.rb

@@ -219,8 +219,7 @@ Then add the foreign key in separate migrations."
             if postgresql?
               safe = false
               if postgresql_version >= Gem::Version.new("12")
-                # TODO likely need to quote the column in some situations
-                safe = constraints(table).any? { |c| c["def"] == "CHECK ((#{column} IS NOT NULL))" }
+                safe = constraints(table).any? { |c| c["def"] == "CHECK ((#{column} IS NOT NULL))" || c["def"] == "CHECK ((#{connection.quote_column_name(column)} IS NOT NULL))" }
               end
 
               unless safe
@@ -341,11 +340,7 @@ Then add the foreign key in separate migrations."
 
       # outdated statistics + a new index can hurt performance of existing queries
       if StrongMigrations.auto_analyze && direction == :up && method == :add_index
-        if postgresql?
-          connection.execute "ANALYZE #{connection.quote_table_name(args[0].to_s)}"
-        elsif mariadb? || mysql?
-          connection.execute "ANALYZE TABLE #{connection.quote_table_name(args[0].to_s)}"
-        end
+        analyze_table(args[0])
       end
 
       result
@@ -397,8 +392,7 @@ Then add the foreign key in separate migrations."
     end
 
     def safe?
-      @safe || ENV["SAFETY_ASSURED"] || @migration.is_a?(ActiveRecord::Schema) ||
-        (direction == :down && !StrongMigrations.check_down) || version_safe?
+      @safe || ENV["SAFETY_ASSURED"] || (direction == :down && !StrongMigrations.check_down) || version_safe?
     end
 
     def version_safe?
@@ -509,6 +503,14 @@ Then add the foreign key in separate migrations."
       end
     end
 
+    def analyze_table(table)
+      if postgresql?
+        connection.execute "ANALYZE #{connection.quote_table_name(table.to_s)}"
+      elsif mariadb? || mysql?
+        connection.execute "ANALYZE TABLE #{connection.quote_table_name(table.to_s)}"
+      end
+    end
+
     def constraints(table_name)
       query = <<~SQL
         SELECT

data/lib/strong_migrations/database_tasks.rb

@@ -1,6 +1,7 @@
 module StrongMigrations
   module DatabaseTasks
-    def migrate
+    # Active Record 7 adds version argument
+    def migrate(*args)
       super
     rescue => e
       if e.cause.is_a?(StrongMigrations::Error)

data/lib/strong_migrations/migration.rb

@@ -7,6 +7,8 @@ module StrongMigrations
     end
 
     def method_missing(method, *args)
+      return super if is_a?(ActiveRecord::Schema)
+
       strong_migrations_checker.perform(method, *args) do
         super
       end

data/lib/strong_migrations/safe_methods.rb

@@ -30,7 +30,11 @@ module StrongMigrations
                 (ActiveRecord::Base.pluralize_table_names ? reference.to_s.pluralize : reference).to_sym
               end
 
-            @migration.add_foreign_key(table, name)
+            if reference
+              @migration.add_foreign_key(table, name, column: "#{reference}_id")
+            else
+              @migration.add_foreign_key(table, name)
+            end
           end
         end
         dir.down do

data/lib/strong_migrations/version.rb

@@ -1,3 +1,3 @@
 module StrongMigrations
-  VERSION = "0.7.5"
+  VERSION = "0.7.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strong_migrations
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.9
 platform: ruby
 authors:
 - Andrew Kane
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -26,79 +26,9 @@ dependencies:
     - - ">="
       - !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'
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  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:
 email:
-- andrew@chartkick.com
+- andrew@ankane.org
 - bob.remeika@gmail.com
 executables: []
 extensions: []
@@ -138,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Catch unsafe migrations in development