rubocop-rails 2.22.2 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54ac592e4d6ccfd065a9f61d33b9305f0a54cc879af4963b7a0a5f13e34ef5f7
-  data.tar.gz: e7d9a2dc53b76a3b8308b4cb1c2023f1a18d133efd7e14ad0efd43733cb5ffe1
+  metadata.gz: cad5e6d0c6f188b6ff87adb04fbfb73c7c574b901de45256eb7fa6e50b7a136d
+  data.tar.gz: c8ab8f1d1c3284054af5847231dd996df24ee5441f638f95bc7e32420a3baf04
 SHA512:
-  metadata.gz: e5b230f2623f63afcdba2fd1fd5dc415538e47ab283bc78c40715c3e6d10c8b8af92bd3597c87aa7105aded11dde0ec66e79f857675e57ebff7a3455e59a102e
-  data.tar.gz: 27092e6dc744ce084d4b1eb8eb85c339bc389de861ab6f82cb2956a550921500d4eb012dc74ff702315c6a39dde7b71b7a43ebec70bd8834ba9314365c45b8ea
+  metadata.gz: ea0ebe45e988d115aa45d7bdba2b728b0583e1e2d996d43af424eb8abc17ced35b528741fcc47b8b258de52edd2fb7bc1c92dd609b49ddeeaaaf26bce123e783
+  data.tar.gz: 7eb06cfce19f2a4ba78c6d571c65cf386e211b48ca2c9b5b9ca436ec9055e49f9737cbb3f9ce1b44ab432de87121295439effc59f093446cea88199bd08ba8a4

data/README.md

@@ -66,17 +66,15 @@ end
 ## Rails configuration tip
 
 If you are using Rails 6.1 or newer, add the following `config.generators.after_generate` setting to
-your config/application.rb to apply RuboCop autocorrection to code generated by `bin/rails g`.
+your `config/environments/development.rb` to apply RuboCop autocorrection to code generated by `bin/rails g`.
 
 ```ruby
-# config/application.rb
-module YourCoolApp
-  class Application < Rails::Application
-    config.generators.after_generate do |files|
-      parsable_files = files.filter { |file| file.end_with?('.rb') }
-      unless parsable_files.empty?
-        system("bundle exec rubocop -A --fail-level=E #{parsable_files.shelljoin}", exception: true)
-      end
+# config/environments/development.rb
+Rails.application.configure do
+  config.generators.after_generate do |files|
+    parsable_files = files.filter { |file| file.end_with?('.rb') }
+    unless parsable_files.empty?
+      system("bundle exec rubocop -A --fail-level=E #{parsable_files.shelljoin}", exception: true)
     end
   end
 end

data/config/default.yml

@@ -165,6 +165,7 @@ Rails/ActiveSupportOnLoad:
     - 'https://guides.rubyonrails.org/engines.html#available-load-hooks'
   SafeAutoCorrect: false
   VersionAdded: '2.16'
+  VersionChanged: '2.24'
 
 Rails/AddColumnIndex:
   Description: >-
@@ -445,9 +446,10 @@ Rails/EnvironmentVariableAccess:
   # TODO: Set to `pending` status in RuboCop Rails 2 series when migration doc will be written.
   Enabled: false
   VersionAdded: '2.10'
-  VersionChanged: '2.11'
+  VersionChanged: '2.24'
   Include:
     - app/**/*.rb
+    - config/initializers/**/*.rb
     - lib/**/*.rb
   Exclude:
     - lib/**/*.rake
@@ -691,7 +693,7 @@ Rails/NegateInclude:
   VersionChanged: '2.9'
 
 Rails/NotNullColumn:
-  Description: 'Do not add a NOT NULL column without a default value.'
+  Description: 'Do not add a NOT NULL column without a default value to existing tables.'
   Enabled: true
   VersionAdded: '0.43'
   VersionChanged: '2.20'
@@ -902,7 +904,7 @@ Rails/RequireDependency:
   VersionAdded: '2.10'
 
 Rails/ResponseParsedBody:
-  Description: Prefer `response.parsed_body` to `JSON.parse(response.body)`.
+  Description: Prefer `response.parsed_body` to custom parsing logic for `response.body`.
   Enabled: pending
   Safe: false
   VersionAdded: '2.18'
@@ -1161,8 +1163,9 @@ Rails/UnknownEnv:
 
 Rails/UnusedIgnoredColumns:
   Description: 'Remove a column that does not exist from `ignored_columns`.'
-  Enabled: pending
+  Enabled: false
   VersionAdded: '2.11'
+  VersionChanged: '2.25'
   Include:
     - app/models/**/*.rb
 
@@ -1219,6 +1222,12 @@ Rails/WhereNotWithMultipleConditions:
   VersionAdded: '2.17'
   VersionChanged: '2.18'
 
+Rails/WhereRange:
+  Description: 'Use ranges in `where` instead of manually constructing SQL.'
+  StyleGuide: 'https://rails.rubystyle.guide/#where-ranges'
+  Enabled: pending
+  VersionAdded: '2.25'
+
 # Accept `redirect_to(...) and return` and similar cases.
 Style/AndOr:
   EnforcedStyle: conditionals

data/lib/rubocop/cop/mixin/active_record_helper.rb

@@ -39,7 +39,12 @@ module RuboCop
       end
 
       def schema
-        RuboCop::Rails::SchemaLoader.load(target_ruby_version)
+        # For compatibility with RuboCop 1.61.0 or lower.
+        if respond_to?(:parser_engine)
+          RuboCop::Rails::SchemaLoader.load(target_ruby_version, parser_engine)
+        else
+          RuboCop::Rails::SchemaLoader.load(target_ruby_version, :parser_whitequark)
+        end
       end
 
       def table_name(class_node)
@@ -98,8 +103,15 @@ module RuboCop
       end
 
       def in_where?(node)
-        send_node = node.each_ancestor(:send).first
-        send_node && WHERE_METHODS.include?(send_node.method_name)
+        send_node = node.each_ancestor(:send, :csend).first
+        return false unless send_node
+
+        return true if WHERE_METHODS.include?(send_node.method_name)
+
+        receiver = send_node.receiver
+        return false unless receiver&.send_type?
+
+        send_node.method?(:not) && WHERE_METHODS.include?(receiver.method_name)
       end
     end
   end

data/lib/rubocop/cop/mixin/database_type_resolvable.rb

@@ -23,7 +23,7 @@ module RuboCop
         case database_adapter
         when 'mysql2', 'trilogy'
           MYSQL
-        when 'postgresql'
+        when 'postgresql', 'postgis'
           POSTGRESQL
         end
       end

data/lib/rubocop/cop/mixin/target_rails_version.rb

@@ -4,13 +4,40 @@ module RuboCop
   module Cop
     # Common functionality for checking target rails version.
     module TargetRailsVersion
+      # Informs the base RuboCop gem that it the Rails version is checked via `requires_gem` API,
+      # without needing to call this `#support_target_rails_version` method.
+      USES_REQUIRES_GEM_API = true
+
       def minimum_target_rails_version(version)
-        @minimum_target_rails_version = version
+        if respond_to?(:requires_gem)
+          case version
+          when Integer, Float then requires_gem(TARGET_GEM_NAME, ">= #{version}")
+          when String then requires_gem(TARGET_GEM_NAME, version)
+          end
+        else
+          # Fallback path for previous versions of RuboCop which don't support the `requires_gem` API yet.
+          @minimum_target_rails_version = version
+        end
       end
 
       def support_target_rails_version?(version)
-        @minimum_target_rails_version <= version
+        if respond_to?(:requires_gem)
+          return false unless gem_requirements
+
+          gem_requirement = gem_requirements[TARGET_GEM_NAME]
+          return true unless gem_requirement # If we have no requirement, then we support all versions
+
+          gem_requirement.satisfied_by?(Gem::Version.new(version))
+        else
+          # Fallback path for previous versions of RuboCop which don't support the `requires_gem` API yet.
+          @minimum_target_rails_version <= version
+        end
       end
+
+      # Look for `railties` instead of `rails`, to support apps that only use a subset of `rails`
+      # See https://github.com/rubocop/rubocop/pull/11289
+      TARGET_GEM_NAME = 'railties'
+      private_constant :TARGET_GEM_NAME
     end
   end
 end

data/lib/rubocop/cop/rails/action_controller_flash_before_render.rb

@@ -99,6 +99,8 @@ module RuboCop
 
         def use_redirect_to?(context)
           context.right_siblings.compact.any? do |sibling|
+            # Unwrap `return redirect_to :index`
+            sibling = sibling.children.first if sibling.return_type? && sibling.children.one?
             sibling.send_type? && sibling.method?(:redirect_to)
           end
         end

data/lib/rubocop/cop/rails/active_support_aliases.rb

@@ -27,13 +27,13 @@ module RuboCop
 
         ALIASES = {
           starts_with?: {
-            original: :start_with?, matcher: '(send str :starts_with? _)'
+            original: :start_with?, matcher: '(call str :starts_with? _)'
           },
           ends_with?: {
-            original: :end_with?, matcher: '(send str :ends_with? _)'
+            original: :end_with?, matcher: '(call str :ends_with? _)'
           },
-          append: { original: :<<, matcher: '(send array :append _)' },
-          prepend: { original: :unshift, matcher: '(send array :prepend _)' }
+          append: { original: :<<, matcher: '(call array :append _)' },
+          prepend: { original: :unshift, matcher: '(call array :prepend _)' }
         }.freeze
 
         ALIASES.each do |aliased_method, options|
@@ -47,13 +47,14 @@ module RuboCop
             preferred_method = ALIASES[aliased_method][:original]
             message = format(MSG, prefer: preferred_method, current: aliased_method)
 
-            add_offense(node, message: message) do |corrector|
+            add_offense(node.loc.selector.join(node.source_range.end), message: message) do |corrector|
               next if append(node)
 
               corrector.replace(node.loc.selector, preferred_method)
             end
           end
         end
+        alias on_csend on_send
       end
     end
   end

data/lib/rubocop/cop/rails/active_support_on_load.rb

@@ -55,15 +55,35 @@ module RuboCop
           'ActiveSupport::TestCase' => 'active_support_test_case'
         }.freeze
 
+        RAILS_5_2_LOAD_HOOKS = {
+          'ActiveRecord::ConnectionAdapters::SQLite3Adapter' => 'active_record_sqlite3adapter'
+        }.freeze
+
+        RAILS_7_1_LOAD_HOOKS = {
+          'ActiveRecord::TestFixtures' => 'active_record_fixtures',
+          'ActiveModel::Model' => 'active_model',
+          'ActionText::EncryptedRichText' => 'action_text_encrypted_rich_text',
+          'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter' => 'active_record_postgresqladapter',
+          'ActiveRecord::ConnectionAdapters::Mysql2Adapter' => 'active_record_mysql2adapter',
+          'ActiveRecord::ConnectionAdapters::TrilogyAdapter' => 'active_record_trilogyadapter'
+        }.freeze
+
         def on_send(node)
           receiver, method, arguments = *node # rubocop:disable InternalAffairs/NodeDestructuring
-          return unless receiver && (hook = LOAD_HOOKS[receiver.const_name])
+          return unless arguments && (hook = hook_for_const(receiver&.const_name))
 
           preferred = "ActiveSupport.on_load(:#{hook}) { #{method} #{arguments.source} }"
           add_offense(node, message: format(MSG, prefer: preferred, current: node.source)) do |corrector|
             corrector.replace(node, preferred)
           end
         end
+
+        def hook_for_const(const_name)
+          hook = LOAD_HOOKS[const_name]
+          hook ||= RAILS_5_2_LOAD_HOOKS[const_name] if target_rails_version >= 5.2
+          hook ||= RAILS_7_1_LOAD_HOOKS[const_name] if target_rails_version >= 7.1
+          hook
+        end
       end
     end
   end

data/lib/rubocop/cop/rails/bulk_change_table.rb

@@ -14,7 +14,7 @@ module RuboCop
       # automatically detect an adapter from `development` environment
       # in `config/database.yml` or the environment variable `DATABASE_URL`
       # when the `Database` option is not set.
-      # If the adapter is not `mysql2`, `trilogy`, or `postgresql`,
+      # If the adapter is not `mysql2`, `trilogy`, `postgresql`, or `postgis`,
       # this Cop ignores offenses.
       #
       # @example

data/lib/rubocop/cop/rails/content_tag.rb

@@ -7,7 +7,7 @@ module RuboCop
       #
       # NOTE: Allow `tag` when the first argument is a variable because
       # `tag(name)` is simpler rather than `tag.public_send(name)`.
-      # And this cop will be renamed to something like `LegacyTag` in the future. (e.g. RuboCop Rails 2.0)
+      # And this cop will be renamed to something like `LegacyTag` in the future. (e.g. RuboCop Rails 3.0)
       #
       # @example
       #  # bad

data/lib/rubocop/cop/rails/dangerous_column_names.rb

@@ -31,7 +31,7 @@ module RuboCop
           time
         ].to_set.freeze
 
-        # Generated from `ActiveRecord::AttributeMethods.dangerous_attribute_methods` on activerecord 7.1.0.
+        # Generated from `ActiveRecord::AttributeMethods.dangerous_attribute_methods` on activerecord 7.1.3.
         # rubocop:disable Metrics/CollectionLiteralLength
         DANGEROUS_COLUMN_NAMES = %w[
           __callbacks
@@ -290,7 +290,6 @@ module RuboCop
           new_record
           no_touching
           normalize_reflection_attribute
-          object_id
           partial_inserts
           partial_updates
           perform_validations

data/lib/rubocop/cop/rails/expanded_date_range.rb

@@ -51,7 +51,7 @@ module RuboCop
           return if allow?(begin_node, end_node)
 
           preferred_method = preferred_method(begin_node)
-          if begin_node.method?(:beginning_of_week) && begin_node.arguments.one?
+          if begin_node.method?(:beginning_of_week) && begin_node.arguments.one? && end_node.arguments.one?
             return unless same_argument?(begin_node, end_node)
 
             preferred_method << "(#{begin_node.first_argument.source})"

data/lib/rubocop/cop/rails/find_by.rb

@@ -28,7 +28,7 @@ module RuboCop
         include RangeHelp
         extend AutoCorrector
 
-        MSG = 'Use `find_by` instead of `where.%<method>s`.'
+        MSG = 'Use `find_by` instead of `where%<dot>s%<method>s`.'
         RESTRICT_ON_SEND = %i[first take].freeze
 
         def on_send(node)
@@ -37,7 +37,7 @@ module RuboCop
 
           range = offense_range(node)
 
-          add_offense(range, message: format(MSG, method: node.method_name)) do |corrector|
+          add_offense(range, message: format(MSG, dot: node.loc.dot.source, method: node.method_name)) do |corrector|
             autocorrect(corrector, node)
           end
         end
@@ -59,7 +59,7 @@ module RuboCop
           return if node.method?(:first)
 
           where_loc = node.receiver.loc.selector
-          first_loc = range_between(node.loc.dot.begin_pos, node.loc.selector.end_pos)
+          first_loc = range_between(node.receiver.source_range.end_pos, node.loc.selector.end_pos)
 
           corrector.replace(where_loc, 'find_by')
           corrector.replace(first_loc, '')

data/lib/rubocop/cop/rails/find_by_id.rb

@@ -24,40 +24,39 @@ module RuboCop
         RESTRICT_ON_SEND = %i[take! find_by_id! find_by!].freeze
 
         def_node_matcher :where_take?, <<~PATTERN
-          (send
-            $(send _ :where
+          (call
+            $(call _ :where
               (hash
                 (pair (sym :id) $_))) :take!)
         PATTERN
 
         def_node_matcher :find_by?, <<~PATTERN
           {
-            (send _ :find_by_id! $_)
-            (send _ :find_by! (hash (pair (sym :id) $_)))
+            (call _ :find_by_id! $_)
+            (call _ :find_by! (hash (pair (sym :id) $_)))
           }
         PATTERN
 
         def on_send(node)
           where_take?(node) do |where, id_value|
             range = where_take_offense_range(node, where)
-            bad_method = build_where_take_bad_method(id_value)
 
-            register_offense(range, id_value, bad_method)
+            register_offense(range, id_value)
           end
 
           find_by?(node) do |id_value|
             range = find_by_offense_range(node)
-            bad_method = build_find_by_bad_method(node, id_value)
 
-            register_offense(range, id_value, bad_method)
+            register_offense(range, id_value)
           end
         end
+        alias on_csend on_send
 
         private
 
-        def register_offense(range, id_value, bad_method)
+        def register_offense(range, id_value)
           good_method = build_good_method(id_value)
-          message = format(MSG, good_method: good_method, bad_method: bad_method)
+          message = format(MSG, good_method: good_method, bad_method: range.source)
 
           add_offense(range, message: message) do |corrector|
             corrector.replace(range, good_method)
@@ -75,19 +74,6 @@ module RuboCop
         def build_good_method(id_value)
           "find(#{id_value.source})"
         end
-
-        def build_where_take_bad_method(id_value)
-          "where(id: #{id_value.source}).take!"
-        end
-
-        def build_find_by_bad_method(node, id_value)
-          case node.method_name
-          when :find_by_id!
-            "find_by_id!(#{id_value.source})"
-          when :find_by!
-            "find_by!(id: #{id_value.source})"
-          end
-        end
       end
     end
   end

data/lib/rubocop/cop/rails/http_status.rb

@@ -13,6 +13,8 @@ module RuboCop
       #   render plain: 'foo/bar', status: 304
       #   redirect_to root_url, status: 301
       #   head 200
+      #   assert_response 200
+      #   assert_redirected_to '/some/path', status: 301
       #
       #   # good
       #   render :foo, status: :ok
@@ -20,6 +22,8 @@ module RuboCop
       #   render plain: 'foo/bar', status: :not_modified
       #   redirect_to root_url, status: :moved_permanently
       #   head :ok
+      #   assert_response :ok
+      #   assert_redirected_to '/some/path', status: :moved_permanently
       #
       # @example EnforcedStyle: numeric
       #   # bad
@@ -28,6 +32,8 @@ module RuboCop
       #   render plain: 'foo/bar', status: :not_modified
       #   redirect_to root_url, status: :moved_permanently
       #   head :ok
+      #   assert_response :ok
+      #   assert_redirected_to '/some/path', status: :moved_permanently
       #
       #   # good
       #   render :foo, status: 200
@@ -35,18 +41,22 @@ module RuboCop
       #   render plain: 'foo/bar', status: 304
       #   redirect_to root_url, status: 301
       #   head 200
+      #   assert_response 200
+      #   assert_redirected_to '/some/path', status: 301
       #
       class HttpStatus < Base
         include ConfigurableEnforcedStyle
         extend AutoCorrector
 
-        RESTRICT_ON_SEND = %i[render redirect_to head].freeze
+        RESTRICT_ON_SEND = %i[render redirect_to head assert_response assert_redirected_to].freeze
 
         def_node_matcher :http_status, <<~PATTERN
           {
             (send nil? {:render :redirect_to} _ $hash)
             (send nil? {:render :redirect_to} $hash)
-            (send nil? :head ${int sym} ...)
+            (send nil? {:head :assert_response} ${int sym} ...)
+            (send nil? :assert_redirected_to _ $hash ...)
+            (send nil? :assert_redirected_to $hash ...)
           }
         PATTERN
 

data/lib/rubocop/cop/rails/inquiry.rb

@@ -33,6 +33,7 @@ module RuboCop
 
           add_offense(node.loc.selector)
         end
+        alias on_csend on_send
       end
     end
   end

data/lib/rubocop/cop/rails/not_null_column.rb

@@ -3,24 +3,42 @@
 module RuboCop
   module Cop
     module Rails
-      # Checks for add_column call with NOT NULL constraint in migration file.
+      # Checks for add_column calls with a NOT NULL constraint without a default
+      # value.
       #
-      # `TEXT` can have default values in PostgreSQL, but not in MySQL.
-      # It will automatically detect an adapter from `development` environment
-      # in `config/database.yml` or the environment variable `DATABASE_URL`
-      # when the `Database` option is not set. If the database is MySQL,
-      # this cop ignores offenses for the `TEXT`.
+      # This cop only applies when adding a column to an existing table, since
+      # existing records will not have a value for the new column. New tables
+      # can freely use NOT NULL columns without defaults, since there are no
+      # records that could violate the constraint.
+      #
+      # If you need to add a NOT NULL column to an existing table, you must add
+      # it as nullable first, back-fill the data, and then use
+      # `change_column_null`. Alternatively, you could add the column with a
+      # default first to have the database automatically backfill existing rows,
+      # and then use `change_column_default` to remove the default.
+      #
+      # `TEXT` cannot have a default value in MySQL.
+      # The cop will automatically detect an adapter from `development`
+      # environment in `config/database.yml` or the environment variable
+      # `DATABASE_URL` when the `Database` option is not set. If the database
+      # is MySQL, this cop ignores offenses for `TEXT` columns.
       #
       # @example
       #   # bad
       #   add_column :users, :name, :string, null: false
       #   add_reference :products, :category, null: false
+      #   change_table :users do |t|
+      #     t.string :name, null: false
+      #   end
       #
       #   # good
       #   add_column :users, :name, :string, null: true
       #   add_column :users, :name, :string, null: false, default: ''
+      #   change_table :users do |t|
+      #     t.string :name, null: false, default: ''
+      #   end
       #   add_reference :products, :category
-      #   add_reference :products, :category, null: false, default: 1
+      #   change_column_null :products, :category_id, false
       class NotNullColumn < Base
         include DatabaseTypeResolvable
 
@@ -35,6 +53,22 @@ module RuboCop
           (send nil? :add_reference _ _ (hash $...))
         PATTERN
 
+        def_node_matcher :change_table?, <<~PATTERN
+          (block (send nil? :change_table ...) (args (arg $_)) _)
+        PATTERN
+
+        def_node_matcher :add_not_null_column_in_change_table?, <<~PATTERN
+          (send (lvar $_) :column _ $_ (hash $...))
+        PATTERN
+
+        def_node_matcher :add_not_null_column_via_shortcut_in_change_table?, <<~PATTERN
+          (send (lvar $_) $_ _ (hash $...))
+        PATTERN
+
+        def_node_matcher :add_not_null_reference_in_change_table?, <<~PATTERN
+          (send (lvar $_) :add_reference _ _ (hash $...))
+        PATTERN
+
         def_node_matcher :null_false?, <<~PATTERN
           (pair (sym :null) (false))
         PATTERN
@@ -48,16 +82,25 @@ module RuboCop
           check_add_reference(node)
         end
 
+        def on_block(node)
+          check_change_table(node)
+        end
+        alias on_numblock on_block
+
         private
 
+        def check_column(type, pairs)
+          if type.respond_to?(:value)
+            return if type.value == :virtual || type.value == 'virtual'
+            return if (type.value == :text || type.value == 'text') && database == MYSQL
+          end
+
+          check_pairs(pairs)
+        end
+
         def check_add_column(node)
           add_not_null_column?(node) do |type, pairs|
-            if type.respond_to?(:value)
-              return if type.value == :virtual || type.value == 'virtual'
-              return if (type.value == :text || type.value == 'text') && database == MYSQL
-            end
-
-            check_pairs(pairs)
+            check_column(type, pairs)
           end
         end
 
@@ -67,6 +110,41 @@ module RuboCop
           end
         end
 
+        def check_add_column_in_change_table(node, table)
+          add_not_null_column_in_change_table?(node) do |receiver, type, pairs|
+            next unless receiver == table
+
+            check_column(type, pairs)
+          end
+        end
+
+        def check_add_column_via_shortcut_in_change_table(node, table)
+          add_not_null_column_via_shortcut_in_change_table?(node) do |receiver, type, pairs|
+            next unless receiver == table
+
+            check_column(type, pairs)
+          end
+        end
+
+        def check_add_reference_in_change_table(node, table)
+          add_not_null_reference_in_change_table?(node) do |receiver, pairs|
+            next unless receiver == table
+
+            check_pairs(pairs)
+          end
+        end
+
+        def check_change_table(node)
+          change_table?(node) do |table|
+            children = node.body.begin_type? ? node.body.children : [node.body]
+            children.each do |child|
+              check_add_column_in_change_table(child, table)
+              check_add_column_via_shortcut_in_change_table(child, table)
+              check_add_reference_in_change_table(child, table)
+            end
+          end
+        end
+
         def check_pairs(pairs)
           return if pairs.any? { |pair| default_option?(pair) }