after_migrate 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a13db746f7bfcbcb7367f028493efd2b464e564b32f09be5debb62da1326f8bf
-  data.tar.gz: b1f0db683bb9b12ed407f14f3f1b1c0baba0a80cfd445c6182b9bd5ad7378821
+  metadata.gz: 19aeb8ce5d84227e4ea467f7e0d14ff8ccdb34f49214f9201b7550ede7ffbbf3
+  data.tar.gz: 2c52a7d680cb37bc2536be8ccd822fee3b92fc6e2b91a5587fa7da1826d14993
 SHA512:
-  metadata.gz: '085b3be36d4031981294d5a5ddc929aae3d781c9d1c3d8446f4508f7c7c526064c8b6529b68237e3e3517885f22251b3db071839dae1bcdf8df654d1e79b2e70'
-  data.tar.gz: 212614cb1145bbe3f22d9b005e6524af133b5d50f659ca8da2efff0d6416efd7ff90fccf39575719d4237df08029a5dcab6b8ef8dfd5072027bce902bc2b3bd8
+  metadata.gz: f8f671d511d7dc8cecc9a33e8bd90752cd0bb5b5ccb50a485dd7215c50ee68d76ec9ce626850d18717bb507a50e0bfe31e71425d24975607144b3749da1d9345
+  data.tar.gz: 80e42d103e33f52644366ebd660a0d5252c55934386830c68f33c9418b37ffbb92310c1c2dc2dd033d9a62204f0bd8d8c78f222852796d5838c4526ae313809e

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+.idea/
+/Gemfile.lock

data/.rubocop.yml

@@ -1,2 +1,14 @@
 AllCops:
   NewCops: enable
+  SuggestExtensions: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'after_migrate.gemspec'
+    - 'spec/**/*.rb'

data/CLAUDE.md

@@ -0,0 +1,74 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+```bash
+bundle install          # install dependencies
+bundle exec rspec       # run all tests
+bundle exec rspec spec/after_migrate_spec.rb  # run a single spec file
+bundle exec rake        # default task (runs spec)
+bundle exec rubocop     # lint
+bundle exec rubocop -a  # lint with auto-fix
+rake release            # build and push gem to RubyGems
+```
+
+## Architecture
+
+This is a Rails gem that automatically runs database maintenance (`ANALYZE`, `VACUUM`, `PRAGMA optimize`) after `db:migrate` tasks. The core flow is:
+
+1. **`Railtie`** (`lib/after_migrate/railtie.rb`) — the entry point. On Rails init, it subscribes to `sql.active_record` notifications so every SQL statement during a migration is intercepted. It enhances `db:migrate`, `db:migrate:up`, and `db:migrate:redo` to call `AfterMigrate.run!` when they complete — unless `defer: true` (the default), in which case the rake task only collects. It also registers the `after_migrate:run` task.
+
+2. **`Collector`** (`lib/after_migrate/collector.rb`) — receives every SQL notification, filters to DDL/DML statements (CREATE/ALTER/DROP/INSERT/UPDATE/DELETE), calls the adapter-specific parser, and accumulates table names into `AfterMigrate.affected_tables` (a `Concurrent::Map<schema, Concurrent::Set<table_name>>`).
+
+3. **`AfterMigrate.affected_tables`** (module-level store in `lib/after_migrate.rb`) — a `Concurrent::Map` that persists across multiple rake task invocations. Only cleared when `AfterMigrate.run!` (or `AfterMigrate.reset!`) is called. This replaces the old `Current` (`ActiveSupport::CurrentAttributes`) which was reset after every migration.
+
+4. **`Executor`** (`lib/after_migrate/executor.rb`) — iterates `AfterMigrate.affected_tables` and calls the correct adapter's `optimize_tables`. Respects the `analyze` config option (`only_affected_tables` / `all_tables` / `none`). Always calls `AfterMigrate.reset!` in its `ensure` block.
+
+5. **Adapters** (`lib/after_migrate/adapters/`) — one module per database:
+   - `Sql` — shared regex-based table parser (used by MySQL and SQLite, which can't use pg_query)
+   - `Postgresql` — uses `pg_query` gem for accurate SQL parsing; runs `VACUUM` (checking `pg_stat_all_tables` for dead tuples) then `ANALYZE VERBOSE` per table
+   - `Mysql` — runs `ANALYZE TABLE` per table; lists tables from `information_schema`
+   - `Sqlite` — runs `PRAGMA optimize` (SQLite ≥ 3.35.0) or `VACUUM; ANALYZE;`
+
+## Key design decisions
+
+- PostgreSQL uses `pg_query` (the actual Postgres parser) for table extraction, which avoids false positives from regex. MySQL and SQLite fall back to the shared `Sql` regex patterns.
+- `pg_query` is a hard runtime dependency (listed in gemspec), not optional — even though it's only used for PostgreSQL.
+- Table collection uses `Concurrent::Map` + `Concurrent::Set` (from `concurrent-ruby`) for thread-safe accumulation across parallel migration workers.
+- The gem does **not** monkey-patch ActiveRecord. It only uses public `ActiveSupport::Notifications` and `Rake::Task#enhance` APIs.
+- `defer: true` (the default) is the multi-tenant-friendly mode: rake tasks only collect, never execute. Call `AfterMigrate.run!` (or `rake after_migrate:run`) once after all tenant migrations complete.
+- The `app.executor.to_run` unsubscription in `Railtie` ensures the SQL subscription is dropped before the app starts serving web requests, so normal traffic is never collected.
+
+## Configuration
+
+Config values are in `AfterMigrate::Configuration` (initialized in `lib/after_migrate.rb`):
+
+| Option                | Default                  | Values                                             |
+|-----------------------|--------------------------|----------------------------------------------------|
+| `enabled`             | `true`                   | bool                                               |
+| `verbose`             | `true`                   | bool                                               |
+| `vacuum`              | `true`                   | bool (PostgreSQL only)                             |
+| `analyze`             | `"only_affected_tables"` | `"only_affected_tables"`, `"all_tables"`, `"none"` |
+| `rake_tasks_enhanced` | `true`                   | bool                                               |
+| `defer`               | `true`                   | bool — skip auto-run; call `AfterMigrate.run!` manually |
+
+## Multi-tenant usage
+
+```ruby
+# In your tenant migration runner:
+Tenant.each do |tenant|
+  tenant.switch { ActiveRecord::MigrationContext.new(...).migrate }
+end
+# Tables are now accumulated per schema in AfterMigrate.affected_tables
+AfterMigrate.run!           # or: Rake::Task['after_migrate:run'].invoke
+```
+
+Set `defer: false` to restore the v0.1 behaviour of running after each `db:migrate`.
+
+## Dependencies
+
+- Ruby ≥ 3.2, Rails ≥ 7.0
+- `pg_query ≥ 6.1` (required even for non-Postgres installs)
+- Dev: `rspec ~> 3.0`, `rubocop ~> 1.81`, `bundler ~> 4`

data/README.md

@@ -83,6 +83,30 @@ end
 ```
 ---
 
+## 🚢 Releasing
+
+Use the guarded helper to make sure git is pushed before RubyGems publish:
+
+```bash
+bin/release
+```
+
+What it does:
+- requires a clean git worktree
+- ensures you are on the default branch (`origin/HEAD` fallback)
+- checks branch sync status vs `origin`
+- runs `bundle exec rspec` and `bundle exec rubocop`
+- pushes the branch first
+- runs `bundle exec rake release` (build/tag/push/publish)
+
+Optional:
+
+```bash
+bin/release --skip-checks
+```
+
+---
+
 ## 🤝 Contributing
 
 Bug reports, feature requests, and pull requests are very welcome!

data/bin/release

@@ -0,0 +1,85 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+root_dir=$(cd "$(dirname "$0")/.." && pwd)
+cd "$root_dir"
+
+if [[ "${1:-}" == "--help" || "${1:-}" == "-h" ]]; then
+  cat <<'USAGE'
+Usage: bin/release [--skip-checks]
+
+Runs guardrails before releasing:
+1. Requires a clean git worktree
+2. Requires current branch to match origin/HEAD (or local HEAD fallback)
+3. Requires branch to be in sync with origin
+4. Runs test + lint checks (unless --skip-checks)
+5. Pushes the branch, then runs `bundle exec rake release`
+USAGE
+  exit 0
+fi
+
+skip_checks=false
+if [[ "${1:-}" == "--skip-checks" ]]; then
+  skip_checks=true
+elif [[ $# -gt 0 ]]; then
+  echo "Unknown option: $1" >&2
+  exit 1
+fi
+
+if [[ -n "$(git status --porcelain)" ]]; then
+  echo "Working tree is not clean. Commit or stash changes before releasing." >&2
+  exit 1
+fi
+
+current_branch=$(git rev-parse --abbrev-ref HEAD)
+default_branch=$(git symbolic-ref --quiet --short refs/remotes/origin/HEAD 2>/dev/null | sed 's|^origin/||')
+default_branch=${default_branch:-$current_branch}
+
+if [[ "$current_branch" != "$default_branch" ]]; then
+  echo "Release must run from '$default_branch' (current: '$current_branch')." >&2
+  exit 1
+fi
+
+echo "Fetching latest refs from origin..."
+git fetch origin
+
+local_sha=$(git rev-parse @)
+remote_sha=$(git rev-parse "origin/$default_branch")
+base_sha=$(git merge-base @ "origin/$default_branch")
+
+if [[ "$local_sha" == "$remote_sha" ]]; then
+  echo "Branch is in sync with origin/$default_branch."
+elif [[ "$local_sha" == "$base_sha" ]]; then
+  echo "Local branch is behind origin/$default_branch. Pull/rebase first." >&2
+  exit 1
+elif [[ "$remote_sha" == "$base_sha" ]]; then
+  echo "Local branch is ahead of origin/$default_branch and will be pushed."
+else
+  echo "Local and origin/$default_branch have diverged. Rebase/merge first." >&2
+  exit 1
+fi
+
+version=$(ruby -e 'require_relative "lib/after_migrate/version"; puts AfterMigrate::VERSION')
+tag="v$version"
+
+if git rev-parse "$tag" >/dev/null 2>&1 || git ls-remote --tags origin "$tag" | grep -q "$tag"; then
+  echo "Tag '$tag' already exists locally or on origin. Bump version first." >&2
+  exit 1
+fi
+
+if [[ "$skip_checks" == "false" ]]; then
+  echo "Running specs..."
+  bundle exec rspec
+
+  echo "Running RuboCop..."
+  bundle exec rubocop
+fi
+
+echo "Pushing branch '$default_branch' first..."
+git push origin "$default_branch"
+
+echo "Releasing gem with rake task..."
+bundle exec rake release
+
+echo "Release complete: $tag"

data/lib/after_migrate/adapters/postgresql.rb

@@ -9,7 +9,8 @@ module AfterMigrate
     module_function
 
     def vacuum(table_name, schema: nil, verbose: true)
-      table = ActiveRecord::Base.connection.quote_table_name("#{schema}.#{table_name}")
+      qualified = schema.present? ? "#{schema}.#{table_name}" : table_name
+      table = ActiveRecord::Base.connection.quote_table_name(qualified)
       query = <<~SQL.squish
         VACUUM (#{'VERBOSE, ' if verbose}ANALYZE, INDEX_CLEANUP ON) #{table};
       SQL
@@ -41,10 +42,11 @@ module AfterMigrate
       ActiveRecord::Base.connection.execute(query)
     end
 
-    def run_vacuum(schema:)
+    def run_vacuum(schema:, table_names: nil)
       tables_with_dead_tuples = dead_tuples(schema:).pluck('relname')
+      tables_with_dead_tuples &= Array(table_names) if table_names
       AfterMigrate.log("Vacuuming #{tables_with_dead_tuples.size} tables in schema #{schema}...")
-      tables_with_dead_tuples.each { |t| vacuum(t) }
+      tables_with_dead_tuples.each { |t| vacuum(t, schema:, verbose: AfterMigrate.configuration.verbose) }
       tables_with_dead_tuples
     end
 
@@ -63,7 +65,9 @@ module AfterMigrate
 
     def optimize_tables(table_names:, schema:, **)
       cleaned_tables = []
-      cleaned_tables = run_vacuum(schema:) if AfterMigrate.configuration.vacuum
+      cleaned_tables = run_vacuum(schema:, table_names:) if AfterMigrate.configuration.vacuum
+
+      return if AfterMigrate.configuration.analyze == 'none'
 
       tables = table_names - cleaned_tables
       run_analyze(schema:, tables:)

data/lib/after_migrate/adapters/sql.rb

@@ -3,8 +3,8 @@
 module AfterMigrate
   module Sql
     IDENT = /
-      (?:"[\w]+"|\w+)
-      (?:\.(?:"[\w]+"|\w+))*
+      (?:"\w+"|\w+)
+      (?:\.(?:"\w+"|\w+))*
     /x
 
     PATTERNS = {

data/lib/after_migrate/executor.rb

@@ -12,6 +12,8 @@ module AfterMigrate
     module_function
 
     def call(schema: nil)
+      return unless AfterMigrate.configuration.vacuum || AfterMigrate.configuration.analyze != 'none'
+
       tables = target_tables
       return if tables.blank?
 
@@ -32,7 +34,8 @@ module AfterMigrate
       table_names = tables.to_a.sort
       return if table_names.empty?
 
-      AfterMigrate.log("Migration touched #{table_names.size} table(s) in schema #{schema.inspect}: #{table_names.join(', ')}")
+      message = "Migration touched #{table_names.size} table(s) in schema #{schema.inspect}: #{table_names.join(', ')}"
+      AfterMigrate.log(message)
       optimize_tables(schema:, table_names:)
     end
 
@@ -56,10 +59,9 @@ module AfterMigrate
         AfterMigrate.affected_tables.keys.each_with_object({}) do |schema, hash|
           hash[schema] = all_tables(schema:)
         end
-      when 'only_affected_tables'
-        AfterMigrate.affected_tables
       else
-        {}
+        # 'only_affected_tables' or 'none' — vacuum still needs the affected list
+        AfterMigrate.affected_tables
       end
     end
 

data/lib/after_migrate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AfterMigrate
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: after_migrate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Nikolay Moskvin
@@ -53,11 +53,13 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CLAUDE.md
 - Gemfile
 - README.md
 - Rakefile
 - after_migrate.gemspec
 - bin/console
+- bin/release
 - bin/setup
 - lib/after_migrate.rb
 - lib/after_migrate/adapters/mysql.rb