verbose_migrations 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d2c1d35a9c0ebcba2ea106766e8ed501397b3c24941c5f54c74ca028bdfa776
-  data.tar.gz: 03ea6cc33ac78bbffc2b69c0908abe59798227dcb237a97705a957e859485e93
+  metadata.gz: 46016287293e9f2266c8b54d6a517502c5574aef77538f1a1fd40328b91566eb
+  data.tar.gz: 3c73fac2184feaa70d1fc86697bddba6e7b86143943152ea55dadc9b1ed5f4db
 SHA512:
-  metadata.gz: 386bc10f3b9baba1a5468fc825105900223970127c6a62991fda5431cb588c614d5569dd5d78752bebe655848ee53687fd038f05b9b3feda891d4dde1bc5c436
-  data.tar.gz: f293b5b9faf86c3965cf0487144d53a54a533ca2921a740977a23aed44a66065895f4f134ff670594e493d3a536699b2d0c7319125a83bf3576c22e9bdcc8666
+  metadata.gz: 83c379ae1c1fc8cc7cb1163253ce09740b627b10700a75997d242d0a7e11874e17fbff95ac6075d1646754904cef83727dbded3f636623bb0dbc4b268338b6f5
+  data.tar.gz: 8c4e5eb736d08ad411de79d987e7f4333a90070b3e5c138b23aaa6422d195323ef5bb6c3bc089f618073b80a47cb522a9d8e117b5b7355cf0bfff3fa087d2ede

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+## v1.0.1
+
+Fix load order: [#1](https://github.com/keygen-sh/verbose_migrations/issues/1).
+
 ## v1.0.0
 
 Initial release.

data/README.md

@@ -41,14 +41,61 @@ $ gem install verbose_migrations
 
 ## Usage
 
+Use the `verbose!` class method to enable debug logging. It accepts an optional log
+`level:` and `logger:`.
+
 ```ruby
-class SeedTagsFromPosts < ActiveRecord::Migration[7.1]
+class SeedTagsFromPosts < ActiveRecord::Migration[7.2]
+  disable_ddl_transaction!
   verbose!
 
   def up
-    # ...
+    update_count = nil
+    batch_count  = 0
+
+    until update_count == 0
+      batch_count  += 1
+      update_count  = exec_update(<<~SQL.squish, batch_count:, batch_size: 10_000)
+        WITH batch AS (
+          SELECT id, unnest(tags) AS tag_name
+          FROM posts
+          WHERE tags IS NOT NULL
+          LIMIT :batch_size
+        ), inserted_tags AS (
+          INSERT INTO tags (name)
+          SELECT DISTINCT tag_name
+          FROM batch
+          ON CONFLICT (name) DO NOTHING
+          RETURNING id, name
+        )
+        INSERT INTO post_tags (post_id, tag_id)
+        SELECT batch.id, tags.id
+        FROM batch
+        JOIN tags ON tags.name = batch.tag_name
+        /* batch=:batch_count */
+      SQL
+    end
   end
 end
+
+```
+
+Before, you have a black box:
+
+```
+== 20240817010101 SeedTagsFromPosts: migrating ================================
+== 20240817010101 SeedTagsFromPosts: migrated (42.0312s) =======================
+```
+
+After, you see progress:
+
+```
+== 20240817010101 SeedTagsFromPosts: migrating ================================
+==> DEBUG -- : (2.2ms) WITH batch AS ( SELECT id, unnest(tags) AS tag_name FROM posts WHERE tags IS NOT NULL LIMIT 10000 ), inserted_tags AS ( INSERT INTO tags (name) SELECT DISTINCT tag_name FROM batch ON CONFLICT (name) DO NOTHING RETURNING id, name ) INSERT INTO post_tags (post_id, tag_id) SELECT batch.id, tags.id FROM batch JOIN tags ON tags.name = batch.tag_name /* batch=1 */
+==> DEBUG -- : (1.1ms) WITH batch AS ( SELECT id, unnest(tags) AS tag_name FROM posts WHERE tags IS NOT NULL LIMIT 10000 ), inserted_tags AS ( INSERT INTO tags (name) SELECT DISTINCT tag_name FROM batch ON CONFLICT (name) DO NOTHING RETURNING id, name ) INSERT INTO post_tags (post_id, tag_id) SELECT batch.id, tags.id FROM batch JOIN tags ON tags.name = batch.tag_name /* batch=2 */
+==> DEBUG -- : (1.3ms) WITH batch AS ( SELECT id, unnest(tags) AS tag_name FROM posts WHERE tags IS NOT NULL LIMIT 10000 ), inserted_tags AS ( INSERT INTO tags (name) SELECT DISTINCT tag_name FROM batch ON CONFLICT (name) DO NOTHING RETURNING id, name ) INSERT INTO post_tags (post_id, tag_id) SELECT batch.id, tags.id FROM batch JOIN tags ON tags.name = batch.tag_name /* batch=3 */
+==> DEBUG -- : (1.7ms) ...
+== 20240817010101 SeedTagsFromPosts: migrated (42.0312s) =======================
 ```
 
 ## Supported Rubies

data/lib/verbose_migrations/ext.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module VerboseMigrations
+  module MigrationExtension
+    cattr_accessor :verbose_logger, default: nil
+    cattr_accessor :verbosity,      default: nil
+
+    def verbose? = verbosity.present? && verbose_logger.present?
+    def verbose!(logger: ActiveRecord::Base.logger, level: Logger::DEBUG)
+      self.verbose_logger = logger
+      self.verbosity      = level
+    end
+
+    def migrate(...)
+      verbosity_was, verbose_logger.level = verbose_logger.level, verbosity if verbose?
+
+      super
+    ensure
+      verbose_logger.level = verbosity_was if verbose?
+    end
+  end
+end

data/lib/verbose_migrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VerboseMigrations
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/verbose_migrations.rb

@@ -4,26 +4,8 @@ require 'active_support'
 require 'active_record'
 require 'logger'
 
+require_relative 'verbose_migrations/ext'
 require_relative 'verbose_migrations/version'
 require_relative 'verbose_migrations/railtie'
 
-module VerboseMigrations
-  module MigrationExtension
-    cattr_accessor :verbose_logger, default: nil
-    cattr_accessor :verbosity,      default: nil
-
-    def verbose? = verbosity.present? && verbose_logger.present?
-    def verbose!(logger: ActiveRecord::Base.logger, level: Logger::DEBUG)
-      self.verbose_logger = logger
-      self.verbosity      = level
-    end
-
-    def migrate(...)
-      verbosity_was, verbose_logger.level = verbose_logger.level, verbosity if verbose?
-
-      super
-    ensure
-      verbose_logger.level = verbosity_was if verbose?
-    end
-  end
-end
+module VerboseMigrations; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verbose_migrations
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Zeke Gabrielse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 2024-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -95,6 +95,7 @@ files:
 - README.md
 - SECURITY.md
 - lib/verbose_migrations.rb
+- lib/verbose_migrations/ext.rb
 - lib/verbose_migrations/railtie.rb
 - lib/verbose_migrations/version.rb
 homepage: https://github.com/keygen-sh/verbose_migrations