rubocop-asjer 0.4.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5ca85da8803a2b7cf65f61600adea61a52c32cd8c327b5e42d83b84a312035c
-  data.tar.gz: 82c413cfd54796c72251bfb67b53ac369a829e41ea64e91265de42dbebea1810
+  metadata.gz: 33824991e93fac5f0a6dc2ac7170e29f1f19ced20457f9ce1e3ce65fe1fb2073
+  data.tar.gz: 360f3e9dd1884e3f59325d639771ab7204c35a86fdb2ced78eadf14333d70dda
 SHA512:
-  metadata.gz: 78f2ca3c66f118973d282f8e1ce6ad7e79a47a2c8e4e627c7aa25c006bb914d80ff2c0afde079cb47e5ace29b191d4565fc87f028a6fdc362816103e4f271846
-  data.tar.gz: fb1910e981dca843eeb1b0425d098b7d4fed04c96d3ee1e6b2bf15dda990b4ff92ea30db3fadfde05d36ef1772ecfe3d255a4f750910af1d0117839f91e9b72a
+  metadata.gz: 81cb50c70f94b0a6ef221022971961b8939519f786e492a926e7fb5dff0b49dabad85c9f8ac9fd8490e55f68af32136667238b438679f4e0440c006279729398
+  data.tar.gz: fcd0440e6123b3f3e871de30276b62eea4bcd80e466f829e1ee97b49f6c6668ba709cc353aefb2045fc3260a111b88e501c821affae1d21f3092b40261aef964

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.4.5"
+  ".": "0.6.0"
 }

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.6.0](https://github.com/asjer/rubocop-asjer/compare/v0.5.0...v0.6.0) (2026-10-28)
+
+
+### Features
+
+* **cop:** flag bare login_as calls in system specs ([c4d99a4](https://github.com/asjer/rubocop-asjer/commit/c4d99a42f25072bfc55f5b381c3fe89ff303e391))
+
+## [0.5.0](https://github.com/asjer/rubocop-asjer/compare/v0.4.5...v0.5.0) (2026-10-15)
+
+
+### Features
+
+* add MigrationSchemaOnly and ExplicitMigrationVersionInSpec cops ([316938a](https://github.com/asjer/rubocop-asjer/commit/316938ae96076d82458186759c2f341b2a44849f)), closes [#54](https://github.com/asjer/rubocop-asjer/issues/54)
+
 ## [0.4.5](https://github.com/asjer/rubocop-asjer/compare/v0.4.4...v0.4.5) (2026-03-08)
 
 

data/README.md

@@ -96,6 +96,106 @@ Asjer/RailsClassOrder:
     - serialize
 ```
 
+### Asjer/MigrationSchemaOnly
+
+Allows only schema statements in Rails migrations. Raw SQL, model calls and other data changes skip validations and callbacks, are often irreversible, and belong in a maintenance task.
+
+The cop uses an allowlist rather than a list of forbidden methods, so new raw-SQL routes are rejected automatically. Inside an `ActiveRecord::Migration` class:
+
+- implicit-receiver calls must be schema statements (`AllowedMethods`) or methods the migration defines itself;
+- only `AllowedConstants` and constants the migration defines may be referenced;
+- calls on block variables such as `t.string` and `direction.up` are fine.
+- `send`, `public_send` and `eval`-style calls are rejected on any receiver except a block variable.
+- `self` may only be used as a direct receiver; assigning or passing it would hide calls from the check.
+
+The cop recognizes classes that inherit from `ActiveRecord::Migration[x.y]`, `ActiveRecord::Migration` or `ActiveRecord::Migration::Current`; migrations with a custom base class are not checked.
+
+Check constraints and expression indexes stay allowed: they keep the database consistent alongside model validations, which `update_all`, `update_column` and `insert_all` skip. `change_column` and `t.change` with `using:` are rejected because that is always a SQL cast, and so is the replacement value of `change_column_null`, which updates existing rows.
+
+```ruby
+# bad
+execute "UPDATE bookings SET source = 'web'"
+select_value('SELECT 1')
+connection.exec_query('SELECT 1')
+send(:execute, 'SELECT 1')
+Booking.where(source: nil).update_all(source: 'web')
+add_index :bookings, Arel.sql('lower(code)')
+change_column :bookings, :date, :date, using: 'date::date'
+
+# good
+create_table :examples do |t|
+  t.string :status, null: false
+end
+add_index :examples, 'lower(status)'
+add_index :examples, :status, using: :gin, opclass: :gin_trgm_ops
+add_check_constraint :examples, "status IN ('open', 'closed')", name: :examples_status
+```
+
+By default, this cop runs on `db/migrate/**/*.rb`. To adopt it in an existing project without rewriting migrations that have already run, set `StartAfter` to the version of the latest existing migration; migrations up to and including that version are skipped:
+
+```yaml
+Asjer/MigrationSchemaOnly:
+  StartAfter: 20261014120000
+  AllowedConstants:
+    - ActiveRecord::IrreversibleMigration
+    - Rails
+    - Pay::Adapter # e.g. for migrations generated by a gem
+```
+
+`AllowedMethods` replaces the default list of schema statements; see `config/default.yml`.
+
+### Asjer/ExplicitMigrationVersionInSpec
+
+Requires migration specs to run migrations to an explicit version. `rollback`, `forward` and `migrate` without a version (or with `nil`) move relative to the latest migration, so the spec breaks as soon as anyone adds an unrelated migration.
+
+```ruby
+# bad
+connection.pool.migration_context.rollback(1)
+migration_context.forward
+migration_context.migrate
+
+# good
+connection.pool.migration_context.run(:down, 20261012170000)
+migration_context.migrate(20261012170000)
+```
+
+By default, this cop runs on `spec/migrations/**/*_spec.rb`.
+
+### Asjer/SystemSpecLoginAs
+
+Requires unqualified `login_as` calls in system specs to be replaced with an application-provided helper such as `sign_in_and_visit(user, path)`. Warden's handoff applies to whichever request reaches the app server next, not necessarily the browser's intended visit.
+
+Every matching call is reported, including calls in `before` blocks, whether a `visit` follows immediately, later, or not at all. Calls with an explicit receiver, such as `foo.login_as(user)`, are outside this cop's scope.
+
+```ruby
+# bad
+login_as(user)
+visit dashboard_path
+
+before do
+  login_as(user)
+end
+
+# good
+sign_in_and_visit(user, dashboard_path)
+```
+
+By default, this cop only runs on `spec/system/**/*.rb` and is `Enabled: pending`. Opt in explicitly (or enable new cops with `AllCops/NewCops: enable`):
+
+```yaml
+Asjer/SystemSpecLoginAs:
+  Enabled: true
+  Include:
+    - 'spec/system/**/*.rb'
+  MethodNames:
+    - login_as
+  PreferredHelper: sign_in_and_visit
+```
+
+`MethodNames` replaces the default list of methods to flag; `PreferredHelper` changes the helper named in the offense message. Define that helper in your application's system-spec support; this gem does not provide it.
+
+**No autocorrect:** the cop cannot infer the destination path or safely move authentication out of a `before` block.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests.

data/config/default.yml

@@ -1,3 +1,86 @@
+Asjer/ExplicitMigrationVersionInSpec:
+  Description: Requires migration specs to run migrations to an explicit version.
+  Enabled: true
+  VersionAdded: "0.5.0"
+  Include:
+    - 'spec/migrations/**/*_spec.rb'
+
+Asjer/MigrationSchemaOnly:
+  Description: Allows only schema statements in Rails migrations; move data changes and raw SQL to a maintenance task.
+  Enabled: true
+  VersionAdded: "0.5.0"
+  Include:
+    - 'db/migrate/**/*.rb'
+  # Version of the last existing migration; earlier migrations are not checked.
+  StartAfter: ~
+  AllowedMethods:
+    - create_table
+    - create_join_table
+    - change_table
+    - rename_table
+    - drop_table
+    - drop_join_table
+    - add_column
+    - remove_column
+    - remove_columns
+    - rename_column
+    - change_column
+    - change_column_default
+    - change_column_null
+    - change_column_comment
+    - change_table_comment
+    - add_timestamps
+    - remove_timestamps
+    - add_index
+    - remove_index
+    - rename_index
+    - add_reference
+    - remove_reference
+    - add_belongs_to
+    - remove_belongs_to
+    - add_foreign_key
+    - remove_foreign_key
+    - add_check_constraint
+    - remove_check_constraint
+    - validate_check_constraint
+    - validate_foreign_key
+    - validate_constraint
+    - add_exclusion_constraint
+    - remove_exclusion_constraint
+    - add_unique_constraint
+    - remove_unique_constraint
+    - enable_extension
+    - disable_extension
+    - create_enum
+    - drop_enum
+    - rename_enum
+    - add_enum_value
+    - rename_enum_value
+    - create_schema
+    - drop_schema
+    - create_virtual_table
+    - drop_virtual_table
+    - table_exists?
+    - column_exists?
+    - index_exists?
+    - index_name_exists?
+    - foreign_key_exists?
+    - check_constraint_exists?
+    - extension_enabled?
+    - view_exists?
+    - reversible
+    - revert
+    - up_only
+    - say
+    - say_with_time
+    - suppress_messages
+    - disable_ddl_transaction!
+    - raise
+    - private
+  AllowedConstants:
+    - ActiveRecord::IrreversibleMigration
+    - Rails
+
 Asjer/NoDefaultTranslation:
   Description: Checks for use of the `default:` option in translation calls.
   Enabled: true
@@ -82,3 +165,13 @@ Asjer/RailsClassOrder:
     - has_secure_token
     - generates_token_for
     - composed_of
+
+Asjer/SystemSpecLoginAs:
+  Description: Requires system specs to use a helper that signs in and visits together instead of a bare Warden handoff.
+  Enabled: pending
+  VersionAdded: "0.6.0"
+  Include:
+    - 'spec/system/**/*.rb'
+  MethodNames:
+    - login_as
+  PreferredHelper: sign_in_and_visit

data/lib/rubocop/asjer/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Asjer
-    VERSION = '0.4.5'
+    VERSION = '0.6.0'
   end
 end

data/lib/rubocop/asjer.rb

@@ -5,7 +5,10 @@ require 'rubocop'
 require_relative 'asjer/version'
 require_relative 'asjer/plugin'
 require_relative 'cop/asjer/no_default_translation'
+require_relative 'cop/asjer/explicit_migration_version_in_spec'
+require_relative 'cop/asjer/migration_schema_only'
 require_relative 'cop/asjer/rails_class_order'
+require_relative 'cop/asjer/system_spec_login_as'
 
 module RuboCop
   module Asjer

data/lib/rubocop/cop/asjer/explicit_migration_version_in_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Asjer
+      # Requires migration specs to run migrations to an explicit version.
+      #
+      # `rollback`, `forward` and `migrate` without a version (or with `nil`) move relative to
+      # the latest migration, so the spec breaks as soon as anyone adds an
+      # unrelated migration. Name the version the spec is about instead.
+      #
+      # @example
+      #   # bad
+      #   connection.pool.migration_context.rollback(1)
+      #   migration_context.forward
+      #   migration_context.migrate
+      #
+      #   # good
+      #   connection.pool.migration_context.run(:down, 20261012170000)
+      #   migration_context.migrate(20261012170000)
+      #
+      class ExplicitMigrationVersionInSpec < Base
+        MSG = 'Run migrations to an explicit version, e.g. `migration_context.run(:down, VERSION)`; ' \
+              '`%<name>s` depends on the latest migration.'
+
+        RESTRICT_ON_SEND = %i[rollback forward migrate].freeze
+
+        def on_send(node)
+          return if node.method?(:migrate) && node.arguments? && !node.first_argument.nil_type?
+
+          add_offense(node.loc.selector, message: format(MSG, name: node.method_name))
+        end
+        alias on_csend on_send
+      end
+    end
+  end
+end

data/lib/rubocop/cop/asjer/migration_schema_only.rb

@@ -0,0 +1,242 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Asjer
+      # Default lists for MigrationSchemaOnly.
+      module MigrationSchemaOnlyDefaults
+        ALLOWED_METHODS = %w[
+          create_table create_join_table change_table rename_table drop_table drop_join_table
+          add_column remove_column remove_columns rename_column change_column
+          change_column_default change_column_null change_column_comment change_table_comment
+          add_timestamps remove_timestamps
+          add_index remove_index rename_index
+          add_reference remove_reference add_belongs_to remove_belongs_to
+          add_foreign_key remove_foreign_key
+          add_check_constraint remove_check_constraint validate_check_constraint
+          validate_foreign_key validate_constraint
+          add_exclusion_constraint remove_exclusion_constraint
+          add_unique_constraint remove_unique_constraint
+          enable_extension disable_extension
+          create_enum drop_enum rename_enum add_enum_value rename_enum_value
+          create_schema drop_schema
+          create_virtual_table drop_virtual_table
+          table_exists? column_exists? index_exists? index_name_exists?
+          foreign_key_exists? check_constraint_exists? extension_enabled? view_exists?
+          reversible revert up_only
+          say say_with_time suppress_messages
+          disable_ddl_transaction!
+          raise private
+        ].freeze
+
+        ALLOWED_CONSTANTS = %w[ActiveRecord::IrreversibleMigration Rails].freeze
+
+        # Calls that run code chosen at runtime; only block variables such as `t` may receive them.
+        DYNAMIC_CALLS = %i[
+          send public_send __send__ eval instance_eval instance_exec class_eval class_exec module_eval module_exec
+        ].freeze
+      end
+
+      # Checks the options of column changes for SQL casts and row updates.
+      module MigrationSchemaOnlyColumnChanges
+        CAST_MSG = '`change_column` with `using:` runs a SQL cast; add a new column and copy the data ' \
+                   'in a maintenance task.'
+        OPTIONS_MSG = 'Write out the `change_column` options so `using:` SQL casts can be checked.'
+        NULL_MSG = 'The `change_column_null` replacement value updates existing rows; ' \
+                   'backfill them in a maintenance task first.'
+
+        private
+
+        # `change_column`, or `t.change` inside a `change_table` block. Any local receiver counts,
+        # so an alias such as `table = t` is checked too.
+        def column_change?(node)
+          node.method?(:change_column) || (node.method?(:change) && node.receiver&.lvar_type?)
+        end
+
+        # The replacement value of `change_column_null`, or of `t.change_null` inside a `change_table` block.
+        def null_replacement(node)
+          if node.method?(:change_column_null)
+            node.arguments[3]
+          elsif node.method?(:change_null) && node.receiver&.lvar_type?
+            node.arguments[2]
+          end
+        end
+
+        def check_null_replacement(replacement)
+          add_offense(replacement, message: NULL_MSG) unless replacement.nil? || replacement.nil_type?
+        end
+
+        # Only the options themselves: `using:` inside a JSON default is data, not a cast.
+        def check_cast(node)
+          node.arguments.select(&:hash_type?).flat_map(&:children).each { |option| check_cast_option(option) }
+        end
+
+        def check_cast_option(option)
+          if option.kwsplat_type?
+            splatted = option.children.first
+            if splatted.hash_type?
+              splatted.children.each { |nested| check_cast_option(nested) }
+            else
+              add_offense(option, message: OPTIONS_MSG)
+            end
+          elsif option.key.sym_type? && option.key.value == :using
+            add_offense(option, message: CAST_MSG)
+          end
+        end
+      end
+
+      # Allows only schema statements in Rails migrations.
+      #
+      # Migrations change the schema. Raw SQL, model calls and other data
+      # changes skip validations and callbacks, are often irreversible, and
+      # belong in a maintenance task. This cop uses an allowlist: inside a
+      # migration class, implicit-receiver calls must be schema statements
+      # (`AllowedMethods`) or methods the migration defines itself, and only
+      # `AllowedConstants` and constants the migration defines may be
+      # referenced. Calls on block variables such as `t.string` and
+      # `direction.up` are fine. Anything else, including `execute`,
+      # `connection`, `send` and model constants, is an offense, so new
+      # raw-SQL routes are rejected without updating a denylist.
+      #
+      # Check constraints and expression indexes stay allowed: they keep the
+      # database consistent alongside model validations. `change_column` with
+      # `using:` is rejected because it is always a SQL cast.
+      #
+      # Set `StartAfter` to the version of the last existing migration to
+      # check only new migrations.
+      #
+      # @example
+      #   # bad
+      #   execute "UPDATE bookings SET source = 'web'"
+      #   select_value('SELECT 1')
+      #   connection.exec_query('SELECT 1')
+      #   Booking.where(source: nil).update_all(source: 'web')
+      #   add_index :bookings, Arel.sql('lower(code)')
+      #   change_column :bookings, :date, :date, using: 'date::date'
+      #
+      #   # good
+      #   create_table :examples do |t|
+      #     t.string :status, null: false
+      #   end
+      #   add_index :examples, 'lower(status)'
+      #   add_check_constraint :examples, "status IN ('open', 'closed')", name: :examples_status
+      #
+      class MigrationSchemaOnly < Base
+        include MigrationSchemaOnlyDefaults
+        include MigrationSchemaOnlyColumnChanges
+
+        CALL_MSG = 'Use only schema statements in migrations; move `%<name>s` and other data changes ' \
+                   'or raw SQL to a maintenance task.'
+        CONSTANT_MSG = 'Do not use `%<name>s` in migrations; move data changes and raw SQL to a maintenance task.'
+        SELF_MSG = 'Call schema statements on `self` directly; passing `self` around hides calls from this check.'
+
+        # @!method migration_class?(node)
+        def_node_matcher :migration_class?, <<~PATTERN
+          (class _ {
+            (send (const (const {nil? cbase} :ActiveRecord) :Migration) :[] ...)
+            (const (const {nil? cbase} :ActiveRecord) :Migration)
+            (const (const (const {nil? cbase} :ActiveRecord) :Migration) :Current)
+          } _)
+        PATTERN
+
+        def on_class(node)
+          return unless migration_class?(node) && node.body && checked_file?
+
+          @defined_methods = node.body.each_node(:def, :defs).map(&:method_name)
+          @defined_constants = defined_constants(node)
+          node.body.each_node(:send, :csend, :const, :self) { |child| check(child) }
+        end
+
+        private
+
+        def checked_file?
+          start_after = cop_config['StartAfter']
+          version = File.basename(processed_source.file_path.to_s)[/\A\d+/]
+          start_after.nil? || version.nil? || version.to_i > start_after.to_i
+        end
+
+        # Bare and class-qualified names, such as `CONSTRAINT_NAME` and `Example::CONSTRAINT_NAME`.
+        def defined_constants(node)
+          names = node.body.each_node(:casgn).filter_map { |casgn| casgn.name.to_s unless casgn.namespace }
+          names + names.map { |name| "#{node.identifier.source}::#{name}" }
+        end
+
+        def check(node)
+          case node.type
+          when :const then check_constant(node)
+          when :self then check_self(node)
+          else check_call(node)
+          end
+        end
+
+        def check_constant(node)
+          return if namespace?(node) || reverted_migration?(node) || allowed_constant?(node.source)
+
+          add_offense(node, message: format(CONSTANT_MSG, name: node.source))
+        end
+
+        # The `ActiveRecord` in `ActiveRecord::Base`; the full constant is checked instead.
+        def namespace?(node)
+          node.parent&.const_type? && node.parent.namespace.equal?(node)
+        end
+
+        def reverted_migration?(node)
+          node.parent&.send_type? && node.parent.method?(:revert)
+        end
+
+        def allowed_constant?(name)
+          allowed_constants.include?(name.delete_prefix('::')) || @defined_constants.include?(name)
+        end
+
+        def allowed_constants
+          cop_config.fetch('AllowedConstants', ALLOWED_CONSTANTS)
+        end
+
+        def check_self(node)
+          return if node.parent&.call_type? && node.parent.receiver.equal?(node)
+          # The target of `def self.name` or `class << self`; their bodies are still checked.
+          return if node.parent&.type?(:defs, :sclass) && node.parent.children.first.equal?(node)
+
+          add_offense(node, message: SELF_MSG)
+        end
+
+        def check_call(node)
+          if disallowed_call?(node)
+            add_offense(node, message: format(CALL_MSG, name: node.method_name))
+          elsif column_change?(node)
+            check_cast(node)
+          elsif (replacement = null_replacement(node))
+            check_null_replacement(replacement)
+          end
+        end
+
+        def disallowed_call?(node)
+          receiver = node.receiver
+          if receiver.nil? || receiver.self_type?
+            !allowed_call?(node.method_name)
+          elsif DYNAMIC_CALLS.include?(node.method_name)
+            !block_argument?(receiver)
+          else
+            receiver.variable? && !receiver.lvar_type?
+          end
+        end
+
+        def allowed_call?(name)
+          allowed_methods.include?(name.to_s) || @defined_methods.include?(name)
+        end
+
+        def allowed_methods
+          cop_config.fetch('AllowedMethods', ALLOWED_METHODS)
+        end
+
+        # A local declared by an enclosing block, such as `t` in `create_table :examples do |t|`.
+        # An ordinary local can hold any object, including the migration itself.
+        def block_argument?(node)
+          node&.lvar_type? && node.each_ancestor(:block).any? do |block|
+            block.argument_list.map(&:name).include?(node.children.first)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/asjer/system_spec_login_as.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Asjer
+      # Requires system specs to use a helper that signs in and visits together.
+      #
+      # Warden's handoff applies to the next request reaching the app server,
+      # which need not be the browser's intended visit. The application must
+      # provide the replacement helper.
+      #
+      # @example
+      #   # bad
+      #   login_as(user)
+      #   visit dashboard_path
+      #
+      #   # good
+      #   sign_in_and_visit(user, dashboard_path)
+      #
+      class SystemSpecLoginAs < Base
+        MSG = 'Use `%<helper>s` instead of `%<method>s` in system specs: ' \
+              'the Warden handoff applies to whichever request reaches the app server next, ' \
+              "not necessarily the browser's visit."
+
+        def on_send(node)
+          return unless node.receiver.nil?
+          return unless cop_config.fetch('MethodNames', ['login_as']).include?(node.method_name.to_s)
+
+          helper = cop_config.fetch('PreferredHelper', 'sign_in_and_visit')
+          add_offense(node.loc.selector, message: format(MSG, helper: helper, method: node.method_name))
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-asjer
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Asjer Querido
@@ -56,8 +56,11 @@ files:
 - lib/rubocop/asjer.rb
 - lib/rubocop/asjer/plugin.rb
 - lib/rubocop/asjer/version.rb
+- lib/rubocop/cop/asjer/explicit_migration_version_in_spec.rb
+- lib/rubocop/cop/asjer/migration_schema_only.rb
 - lib/rubocop/cop/asjer/no_default_translation.rb
 - lib/rubocop/cop/asjer/rails_class_order.rb
+- lib/rubocop/cop/asjer/system_spec_login_as.rb
 - mise.toml
 - release-please-config.json
 - sig/rubocop/i18n.rbs