online_migrations 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ac8a2eb2657fcc3536a9b56d16298f90f8e1a5e626ba52a6e9703b5bcaa7df0
-  data.tar.gz: c5357f94854fb43d1b8404ed9dcfafc2178430aeb9c6d69555f50629a94da3bd
+  metadata.gz: 974e87c3442a03f1a954a338678589549ed5c91fd293a7b4b5a8bad5ba807f32
+  data.tar.gz: 1b1dacee542413f623d74e947f704f57fa93a032f5b26c06d3ffc3dec105cc99
 SHA512:
-  metadata.gz: 4ccbc274c76ab01f8ece559b3fee27c1c5c0c495225b393c3a4afb7941f0b61d3aab9ef2885195be78ed00f29bd5e6b18e3fe0cb044b745cd791aacf34283492
-  data.tar.gz: 04fb250e30e7620ac1bd06fddf24a5fdfe616f285422e47e19423e23be0c8117e57d45e45029a2e1212cc5e6ad9baf3605fac8b038152fdc73b2d9a818ba211c
+  metadata.gz: 2b4f245c656915711ffb2cb9c1a79f0a4a5a52374c38f01b0cd97a6a0bc06e803b5772ecb4cad36aef6f2dc5b97f543f66c35bcb1b195792c301746fc80c888c
+  data.tar.gz: 908f3c213a86b4e7fd48e9120c603c80f68facaa210827fd6ff60637a2b2e62241171f17706fe60cfecc324b318b227575d777a3d988299277f137ecdde0b48f

data/BACKGROUND_MIGRATIONS.md

@@ -120,7 +120,7 @@ enqueue_background_migration("MyMigrationWithArgs", arg1, arg2, ...)
 * `CopyColumn` - copies data from one column(s) to other(s) (enqueue using `copy_column_in_background`)
 * `DeleteAssociatedRecords` - deletes records associated with a parent object (enqueue using `delete_associated_records_in_background`)
 * `DeleteOrphanedRecords` - deletes records with one or more missing relations (enqueue using `delete_orphaned_records_in_background`)
-* `PerformActionOnRelation` - performs specific action on a relation or indvidual records (enqueue using `perform_action_on_relation_in_background`)
+* `PerformActionOnRelation` - performs specific action on a relation or individual records (enqueue using `perform_action_on_relation_in_background`)
 * `ResetCounters` - resets one or more counter caches to their correct value (enqueue using `reset_counters_in_background`)
 
 ## Testing
@@ -240,7 +240,7 @@ Specify the throttle condition as a block:
 ```ruby
 # config/initializers/online_migrations.rb
 
-OnlineMigrations.config.backround_migrations.throttler = -> { DatabaseStatus.unhealthy? }
+OnlineMigrations.config.background_migrations.throttler = -> { DatabaseStatus.unhealthy? }
 ```
 
 Note that it's up to you to define a throttling condition that makes sense for your app. For example, you can check various PostgreSQL metrics such as replication lag, DB threads, whether DB writes are available, etc.
@@ -254,7 +254,7 @@ If you want to integrate with an exception monitoring service (e.g. Bugsnag), yo
 ```ruby
 # config/initializers/online_migrations.rb
 
-OnlineMigrations.config.backround_migrations.error_handler = ->(error, errored_job) do
+OnlineMigrations.config.background_migrations.error_handler = ->(error, errored_job) do
   Bugsnag.notify(error) do |notification|
     notification.add_metadata(:background_migration, { name: errored_job.migration_name })
   end

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## master (unreleased)
 
+## 0.5.4 (2022-01-03)
+
+- Support ruby 3.2.0
+
 ## 0.5.3 (2022-11-10)
 
 - Fix removing index by name

data/README.md

@@ -69,7 +69,7 @@ class AddAdminToUsers < ActiveRecord::Migration[7.0]
   # Do not wrap the migration in a transaction so that locks are held for a shorter time.
   disable_ddl_transaction!
 
-  def change
+  def up
     # Lower PostgreSQL's lock timeout to avoid statement queueing.
     execute "SET lock_timeout TO '5s'" # The lock_timeout duration is customizable.
 
@@ -88,6 +88,10 @@ class AddAdminToUsers < ActiveRecord::Migration[7.0]
     execute "SET statement_timeout TO '5s'"
     change_column_null :users, :admin, false
   end
+  
+  def down
+    remove_column :users, :admin
+  end
 end
 ```
 

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

@@ -38,7 +38,7 @@ OnlineMigrations.configure do |config|
   # migration failure in production. This is also useful in development to get
   # a better grasp of what is going on for high-level statements like add_column_with_default.
   #
-  # Note: It can be overriden by `ONLINE_MIGRATIONS_VERBOSE_SQL_LOGS` environment variable.
+  # Note: It can be overridden by `ONLINE_MIGRATIONS_VERBOSE_SQL_LOGS` environment variable.
   config.verbose_sql_logs = defined?(Rails) && Rails.env.production?
 
   # Lock retries.
@@ -67,25 +67,25 @@ OnlineMigrations.configure do |config|
 
   # ==> Background migrations configuration
   # The number of rows to process in a single background migration run.
-  # config.backround_migrations.batch_size = 20_000
+  # config.background_migrations.batch_size = 20_000
 
   # The smaller batches size that the batches will be divided into.
-  # config.backround_migrations.sub_batch_size = 1000
+  # config.background_migrations.sub_batch_size = 1000
 
   # The pause interval between each background migration job's execution (in seconds).
-  # config.backround_migrations.batch_pause = 0.seconds
+  # config.background_migrations.batch_pause = 0.seconds
 
   # The number of milliseconds to sleep between each sub_batch execution.
-  # config.backround_migrations.sub_batch_pause_ms = 100
+  # config.background_migrations.sub_batch_pause_ms = 100
 
   # Maximum number of batch run attempts.
   # When attempts are exhausted, the individual batch is marked as failed.
-  # config.backround_migrations.batch_max_attempts = 5
+  # config.background_migrations.batch_max_attempts = 5
 
   # Configure custom throttler for background migrations.
   # It will be called before each batch run.
   # If throttled, the current run will be retried next time.
-  # config.backround_migrations.throttler = -> { DatabaseStatus.unhealthy? }
+  # config.background_migrations.throttler = -> { DatabaseStatus.unhealthy? }
 
   # The number of seconds that must pass before the running job is considered stuck.
   # config.background_migrations.stuck_jobs_timeout = 1.hour
@@ -95,7 +95,7 @@ OnlineMigrations.configure do |config|
   config.background_migrations.backtrace_cleaner = Rails.backtrace_cleaner
 
   # The callback to perform when an error occurs in the migration job.
-  # config.backround_migrations.error_handler = ->(error, errored_job) do
+  # config.background_migrations.error_handler = ->(error, errored_job) do
   #   Bugsnag.notify(error) do |notification|
   #     notification.add_metadata(:background_migration, { name: errored_job.migration_name })
   #   end

data/lib/online_migrations/background_migrations/config.rb

@@ -43,7 +43,7 @@ module OnlineMigrations
       # @return [Proc]
       #
       # @example
-      #   OnlineMigrations.config.backround_migrations.throttler = -> { DatabaseStatus.unhealthy? }
+      #   OnlineMigrations.config.background_migrations.throttler = -> { DatabaseStatus.unhealthy? }
       #
       attr_reader :throttler
 
@@ -64,7 +64,7 @@ module OnlineMigrations
       # The callback to perform when an error occurs in the migration job.
       #
       # @example
-      #   OnlineMigrations.config.backround_migrations.error_handler = ->(error, errored_job) do
+      #   OnlineMigrations.config.background_migrations.error_handler = ->(error, errored_job) do
       #     Bugsnag.notify(error) do |notification|
       #       notification.add_metadata(:background_migration, { name: errored_job.migration_name })
       #     end

data/lib/online_migrations/command_checker.rb

@@ -42,6 +42,7 @@ module OnlineMigrations
 
       true
     end
+    ruby2_keywords(:check) if respond_to?(:ruby2_keywords, true)
 
     private
       def check_database_version
@@ -271,7 +272,7 @@ module OnlineMigrations
                 !options[:limit] || (existing_column.limit && options[:limit] >= existing_column.limit)
               end
             when :numeric, :decimal
-              # numeric and decimal are equivalent and can be used interchangably
+              # numeric and decimal are equivalent and can be used interchangeably
               [:numeric, :decimal].include?(existing_type) &&
               (
                 (

data/lib/online_migrations/config.rb

@@ -153,7 +153,7 @@ module OnlineMigrations
     # This feature is enabled by default in a production Rails environment.
     # @return [Boolean]
     #
-    # @note: It can be overriden by `ONLINE_MIGRATIONS_VERBOSE_SQL_LOGS` environment variable.
+    # @note: It can be overridden by `ONLINE_MIGRATIONS_VERBOSE_SQL_LOGS` environment variable.
     #
     attr_accessor :verbose_sql_logs
 

data/lib/online_migrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OnlineMigrations
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-10 00:00:00.000000000 Z
+date: 2023-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord