verbose_migrations 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad7f17b9ff82b8e574b88002acbf340b8195a4aa34a50729bd836c2dde8fc1d8
-  data.tar.gz: 558746287b7911ae80562b1a2408ca15bfbe46fbe8533bd9d8abef259790c82e
+  metadata.gz: 46016287293e9f2266c8b54d6a517502c5574aef77538f1a1fd40328b91566eb
+  data.tar.gz: 3c73fac2184feaa70d1fc86697bddba6e7b86143943152ea55dadc9b1ed5f4db
 SHA512:
-  metadata.gz: fcedca9580af8e1e09cc40baeb63957a6441711f3e443b06de46d5c126c0cc9e39361b7a08a2b7fe8fc65a63931f73cb510b225c3255df97f7d902f4d41f0deb
-  data.tar.gz: d386a64316f74ddee8596a21775db48a027e8254c9eae606b8942f71c83f218ce3a7e2aea31d97a2fe3ad22f1bd19a3264e9ffc308033679b68b89f510483c5c
+  metadata.gz: 83c379ae1c1fc8cc7cb1163253ce09740b627b10700a75997d242d0a7e11874e17fbff95ac6075d1646754904cef83727dbded3f636623bb0dbc4b268338b6f5
+  data.tar.gz: 8c4e5eb736d08ad411de79d987e7f4333a90070b3e5c138b23aaa6422d195323ef5bb6c3bc089f618073b80a47cb522a9d8e117b5b7355cf0bfff3fa087d2ede

data/CHANGELOG.md

@@ -1,3 +1,11 @@
 # Changelog
 
 ## [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

@@ -1,31 +1,118 @@
-# VerboseMigrations
+# verbose_migrations
 
-TODO: Delete this and the text below, and describe your gem
+[![CI](https://github.com/keygen-sh/verbose_migrations/actions/workflows/test.yml/badge.svg)](https://github.com/keygen-sh/verbose_migrations/actions)
+[![Gem Version](https://badge.fury.io/rb/verbose_migrations.svg)](https://badge.fury.io/rb/verbose_migrations)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/verbose_migrations`. To experiment with that code, run `bin/console` for an interactive prompt.
+Enable verbose logging for Active Record migrations, regardless of configured
+log level. Monitor query speed, query execution, and overall progress when
+executing long running or otherwise risky migrations.
+
+This gem was extracted from [Keygen](https://keygen.sh).
+
+Sponsored by:
+
+<a href="https://keygen.sh?ref=verbose_migrations">
+  <div>
+    <img src="https://keygen.sh/images/logo-pill.png" width="200" alt="Keygen">
+  </div>
+</a>
+
+_A fair source software licensing and distribution API._
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's `Gemfile`:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem 'verbose_migrations'
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+And then execute:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+$ bundle
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Or install it yourself as:
+
+```bash
+$ gem install verbose_migrations
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Use the `verbose!` class method to enable debug logging. It accepts an optional log
+`level:` and `logger:`.
+
+```ruby
+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
 
-## Development
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Before, you have a black box:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```
+== 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
+
+**`verbose_migrations` supports Ruby 3.1 and above.** We encourage you to upgrade
+if you're on an older version. Ruby 3 provides a lot of great features, like
+better pattern matching and a new shorthand hash syntax.
+
+## Is it any good?
+
+Yes.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/verbose_migrations.
+If you have an idea, or have discovered a bug, please open an issue or create a
+pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/railtie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module VerboseMigrations
+  ActiveSupport.on_load :active_record do
+    ActiveRecord::Migration.prepend(MigrationExtension)
+  end
+end
+

data/lib/verbose_migrations/version.rb

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

data/lib/verbose_migrations.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
+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
-end
+module VerboseMigrations; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verbose_migrations
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Zeke Gabrielse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-20 00:00:00.000000000 Z
+date: 2024-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,9 +38,51 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Override Active Record logger to DEBUG mode during Active Record migrations
-  to easily follow along and spot blocking queries in a migration, even when the logger
-  is set to e.g. WARN.
+- !ruby/object:Gem::Dependency
+  name: transition_through
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: prism
+  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: Enable verbose logging for Active Record migrations, regardless of configured
+  log level. Monitor query speed, query execution, and overall progress when executing
+  long running or otherwise risky migrations.
 email:
 - oss@keygen.sh
 executables: []
@@ -53,6 +95,8 @@ 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
 licenses:
@@ -76,5 +120,6 @@ requirements: []
 rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
-summary: Set Active Record logger to DEBUG mode during Active Record migrations.
+summary: Enable verbose logging for Active Record migrations, regardless of configured
+  log level, to monitor query speed and execution.
 test_files: []