Skip to content

Enhance BulkChangeTable to support block wrappers #1496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

thukim
Copy link

@thukim thukim commented Jun 26, 2025

Previously, the BulkChangeTable RuboCop would fail to detect consecutive combinable operations if they were wrapped inside blocks like safety_assured, reversible, or other custom methods. This meant that we could miss opportunities to optimize our database migrations with bulk ALTER statements.
For example, the following code would not trigger an offense, even though the add_column calls could be combined:

def change
  safety_assured do
    add_column :users, :name, :string
    add_column :users, :email, :string
  end
end

This PR introduces a recursive AST traversal logic that efficiently navigates through nested block structures while preserving the operational context. The BulkChangeTable RuboCop now correctly identifies sequential combinable operations within a wide range of block patterns.

def change
  safety_assured do
    add_column :users, :name, :string
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You can use `change_table :users, bulk: true` to combine alter queries.
    add_column :users, :email, :string
  end
end

Improvements:

  • Rails Block Wrappers: Enhanced to support standard migration blocks, including: reversible (with dir.up and dir.down), up_only
  • strong_migration support: Now correctly handles operations inside safety_assured blocks, a key feature of strong_migrations.
  • Nested and Custom Blocks: The logic now correctly handles deeply nested blocks and custom wrapper methods (e.g., with_lock_retries). It is now more accurate in complex migrations, reducing the chances of missing bulkable operations.

Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant