rubocop-rails 2.20.2 → 2.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 227ce5b698e456412c24917c5644b2a938531440ab8c64e2b5036d6f2857a548
-  data.tar.gz: 41c6157da73215cca0b5d56ffa254711c2f9f4f5399c8aa3d85ac7c719958b28
+  metadata.gz: ee7d9bdd0fa7838d8bfecece133ccd92cc308603bcdf120c14224c5f2e312344
+  data.tar.gz: 7d740b495ffa368d26a73808af9adff990bb9c1d317d905f877b4f3e2025487c
 SHA512:
-  metadata.gz: afafd2f9293f4592cc914fdb42c6742900681574d5d0a27dc2031eddb3446b419ac04a77a149e0169ab89a0bb7afe4e0481b3ff889631345a0227b0d24a2c185
-  data.tar.gz: a90108eed94c1cedbe1b9a059b60cae51465cffd5a8612f56a0548182b6f992e3e626125e4a4f2f74ceda491a91cdcacb0bd8206ebf94d7d245841572639b556
+  metadata.gz: 98172f41e7b1aab55931f351757425815850809edd6fc4f5bc55c59271d9f12459ac51c2002e409534b623f321ab27798c32aaccb2d15d60c7bf309a9c044d58
+  data.tar.gz: c78e9a0d9e53e5203a2dd1846a79c3e9c7a16af69e98d94e6b7ae6358ae6a29b71c2ac3f09ddb2a9be06dc64097a736c3379730f50b9309c0e2ae084267aee70

data/README.md

@@ -56,6 +56,8 @@ Note: `--rails` option is required while `rubocop` command supports `--rails` op
 ### Rake task
 
 ```ruby
+require 'rubocop/rake_task'
+
 RuboCop::RakeTask.new do |task|
   task.requires << 'rubocop-rails'
 end
@@ -64,21 +66,21 @@ 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') }
+# 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
 ```
 
-It uses `rubocop -A` to apply `Style/FrozenStringLiteralComment` and other unsafe autocorretion cops.
+It uses `rubocop -A` to apply `Style/FrozenStringLiteralComment` and other unsafe autocorrection cops.
 `rubocop -A` is unsafe autocorrection, but code generated by default is simple and less likely to
 be incompatible with `rubocop -A`. If you have problems you can replace it with `rubocop -a` instead.
 

data/config/default.yml

@@ -61,6 +61,18 @@ Lint/RedundantSafeNavigation:
     - presence
     - present?
 
+Lint/SafeNavigationChain:
+  # Add `presence_in` method to the default of the RuboCop core:
+  # https://github.com/rubocop/rubocop/blob/v1.56.0/config/default.yml#L2265-L2271
+  AllowedMethods:
+    - present?
+    - blank?
+    - presence
+    - presence_in
+    - try
+    - try!
+    - in?
+
 Rails:
   Enabled: true
   DocumentationBaseURL: https://docs.rubocop.org/rubocop-rails
@@ -83,8 +95,9 @@ Rails/ActionControllerTestCase:
 
 Rails/ActionFilter:
   Description: 'Enforces consistent use of action filter methods.'
-  Enabled: true
+  Enabled: false
   VersionAdded: '0.19'
+  VersionChanged: '2.22'
   EnforcedStyle: action
   SupportedStyles:
     - action
@@ -152,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: >-
@@ -296,6 +310,15 @@ Rails/CreateTableWithTimestamps:
     - db/**/*_create_active_storage_tables.active_storage.rb
     - db/**/*_create_active_storage_variant_records.active_storage.rb
 
+Rails/DangerousColumnNames:
+  Description: >-
+                  Avoid dangerous column names.
+  Enabled: pending
+  Severity: warning
+  VersionAdded: '2.21'
+  Include:
+    - 'db/**/*.rb'
+
 Rails/Date:
   Description: >-
                   Checks the correct usage of date aware methods,
@@ -317,7 +340,6 @@ Rails/Date:
 
 Rails/DefaultScope:
   Description: 'Avoid use of `default_scope`.'
-  StyleGuide: 'https://rails.rubystyle.guide#avoid-default-scope'
   Enabled: false
   VersionAdded: '2.7'
 
@@ -409,6 +431,11 @@ Rails/EnumUniqueness:
   Include:
     - app/models/**/*.rb
 
+Rails/EnvLocal:
+  Description: 'Use `Rails.env.local?` instead of `Rails.env.development? || Rails.env.test?`.'
+  Enabled: pending
+  VersionAdded: '2.22'
+
 Rails/EnvironmentComparison:
   Description: "Favor `Rails.env.production?` over `Rails.env == 'production'`."
   Enabled: true
@@ -419,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
@@ -463,10 +491,8 @@ Rails/FindBy:
   StyleGuide: 'https://rails.rubystyle.guide#find_by'
   Enabled: true
   VersionAdded: '0.30'
-  VersionChanged: '2.11'
+  VersionChanged: '2.21'
   IgnoreWhereFirst: true
-  Include:
-    - app/models/**/*.rb
 
 Rails/FindById:
   Description: >-
@@ -482,9 +508,7 @@ Rails/FindEach:
   Enabled: true
   Safe: false
   VersionAdded: '0.30'
-  VersionChanged: '2.19'
-  Include:
-    - app/models/**/*.rb
+  VersionChanged: '2.21'
   AllowedMethods:
     # Methods that don't work well with `find_each`.
     - order
@@ -547,6 +571,10 @@ Rails/I18nLazyLookup:
   Reference: 'https://guides.rubyonrails.org/i18n.html#lazy-lookup'
   Enabled: pending
   VersionAdded: '2.14'
+  EnforcedStyle: lazy
+  SupportedStyles:
+    - lazy
+    - explicit
   Include:
     - 'app/controllers/**/*.rb'
 
@@ -669,6 +697,9 @@ Rails/NotNullColumn:
   Enabled: true
   VersionAdded: '0.43'
   VersionChanged: '2.20'
+  Database: null
+  SupportedDatabases:
+    - mysql
   Include:
     - db/**/*.rb
 
@@ -775,6 +806,16 @@ Rails/ReadWriteAttribute:
   Include:
     - app/models/**/*.rb
 
+Rails/RedundantActiveRecordAllMethod:
+  Description: Detect redundant `all` used as a receiver for Active Record query methods.
+  StyleGuide: 'https://rails.rubystyle.guide/#redundant-all'
+  Enabled: pending
+  Safe: false
+  AllowedReceivers:
+    - ActionMailer::Preview
+    - ActiveSupport::TimeZone
+  VersionAdded: '2.21'
+
 Rails/RedundantAllowNil:
   Description: >-
                  Finds redundant use of `allow_nil` when `allow_blank` is set to
@@ -863,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'
@@ -955,6 +996,12 @@ Rails/ScopeArgs:
   Include:
     - app/models/**/*.rb
 
+Rails/SelectMap:
+  Description: 'Checks for uses of `select(:column_name)` with `map(&:column_name)`.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '2.21'
+
 Rails/ShortI18n:
   Description: 'Use the short form of the I18n methods: `t` instead of `translate` and `l` instead of `localize`.'
   StyleGuide: 'https://rails.rubystyle.guide/#short-i18n'
@@ -1083,6 +1130,7 @@ Rails/TransactionExitStatement:
     - https://github.com/rails/rails/commit/15aa4200e083
   Enabled: pending
   VersionAdded: '2.14'
+  TransactionMethods: []
 
 Rails/UniqBeforePluck:
   Description: 'Prefer the use of uniq or distinct before pluck.'
@@ -1120,6 +1168,12 @@ Rails/UnusedIgnoredColumns:
   Include:
     - app/models/**/*.rb
 
+Rails/UnusedRenderContent:
+  Description: 'Do not specify body content for a response with a non-content status code.'
+  Enabled: pending
+  Severity: warning
+  VersionAdded: '2.21'
+
 Rails/Validation:
   Description: 'Use validates :attribute, hash of validations.'
   Enabled: true
@@ -1175,6 +1229,14 @@ Style/FormatStringToken:
   AllowedMethods:
     - redirect
 
+Style/InvertibleUnlessCondition:
+  InverseMethods:
+    # Active Support defines some common inverse methods. They are listed below:
+    :present?: :blank?
+    :blank?: :present?
+    :include?: :exclude?
+    :exclude?: :include?
+
 Style/SymbolProc:
   AllowedMethods:
     - define_method

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # A mixin to extend cops in order to determine the database type.
+    #
+    # This module automatically detect an adapter from `development` environment
+    # in `config/database.yml` or the environment variable `DATABASE_URL`
+    # when the `Database` option is not set.
+    module DatabaseTypeResolvable
+      MYSQL = 'mysql'
+      POSTGRESQL = 'postgresql'
+
+      def database
+        cop_config['Database'] || database_from_yaml || database_from_env
+      end
+
+      private
+
+      def database_from_yaml
+        return unless database_yaml
+
+        case database_adapter
+        when 'mysql2', 'trilogy'
+          MYSQL
+        when 'postgresql', 'postgis'
+          POSTGRESQL
+        end
+      end
+
+      def database_from_env
+        url = ENV['DATABASE_URL'].presence
+        return unless url
+
+        case url
+        when %r{\A(mysql2|trilogy)://}
+          MYSQL
+        when %r{\Apostgres(ql)?://}
+          POSTGRESQL
+        end
+      end
+
+      def database_yaml
+        return unless File.exist?('config/database.yml')
+
+        yaml = if YAML.respond_to?(:unsafe_load_file)
+                 YAML.unsafe_load_file('config/database.yml')
+               else
+                 YAML.load_file('config/database.yml')
+               end
+        return unless yaml.is_a? Hash
+
+        config = yaml['development']
+        return unless config.is_a?(Hash)
+
+        config
+      rescue Psych::SyntaxError
+        # noop
+      end
+
+      def database_adapter
+        database_yaml['adapter'] || database_yaml.first.last['adapter']
+      end
+    end
+  end
+end

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

@@ -102,7 +102,7 @@ module RuboCop
       end
 
       # Internal helper class to hold match data
-      Captures = Struct.new(
+      Captures = ::Struct.new(
         :transformed_argname,
         :transforming_body_expr
       ) do
@@ -112,7 +112,7 @@ module RuboCop
       end
 
       # Internal helper class to hold autocorrect data
-      Autocorrection = Struct.new(:match, :block_node, :leading, :trailing) do
+      Autocorrection = ::Struct.new(:match, :block_node, :leading, :trailing) do
         def self.from_each_with_object(node, match)
           new(match, node, 0, 0)
         end

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

@@ -85,7 +85,7 @@ module RuboCop
 
         def inherit_action_controller_base?(node)
           class_node = find_ancestor(node, type: :class)
-          return unless class_node
+          return false unless class_node
 
           action_controller?(class_node)
         end
@@ -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/action_controller_test_case.rb

@@ -3,8 +3,8 @@
 module RuboCop
   module Cop
     module Rails
-      # Using `ActionController::TestCase`` is discouraged and should be replaced by
-      # `ActionDispatch::IntegrationTest``. Controller tests are too close to the
+      # Using `ActionController::TestCase` is discouraged and should be replaced by
+      # `ActionDispatch::IntegrationTest`. Controller tests are too close to the
       # internals of a controller whereas integration tests mimic the browser/user.
       #
       # @safety

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

@@ -8,6 +8,9 @@ module RuboCop
       # The cop is configurable and can enforce the use of the older
       # something_filter methods or the newer something_action methods.
       #
+      # IMPORTANT: This cop is deprecated. Because the `*_filter` methods were removed in Rails 4.2,
+      # and that Rails version is no longer supported by RuboCop Rails. This cop will be removed in RuboCop Rails 3.0.
+      #
       # @example EnforcedStyle: action (default)
       #   # bad
       #   after_filter :do_stuff

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

@@ -11,10 +11,10 @@ module RuboCop
       #   `update` but the method name remained same in the method definition.
       #
       # @example
-      #   #bad
+      #   # bad
       #   book.update_attributes!(author: 'Alice')
       #
-      #   #good
+      #   # good
       #   book.update!(author: 'Alice')
       class ActiveRecordAliases < Base
         extend AutoCorrector

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

@@ -48,7 +48,7 @@ module RuboCop
           seen_callback_names = {}
 
           each_after_commit_callback(class_node) do |node|
-            callback_name = node.arguments[0].value
+            callback_name = node.first_argument.value
             if seen_callback_names.key?(callback_name)
               add_offense(node, message: format(MSG, name: callback_name))
             else

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

@@ -12,8 +12,9 @@ module RuboCop
       # The `bulk` option is only supported on the MySQL and
       # the PostgreSQL (5.2 later) adapter; thus it will
       # automatically detect an adapter from `development` environment
-      # in `config/database.yml` when the `Database` option is not set.
-      # If the adapter is not `mysql2` or `postgresql`,
+      # in `config/database.yml` or the environment variable `DATABASE_URL`
+      # when the `Database` option is not set.
+      # If the adapter is not `mysql2`, `trilogy`, `postgresql`, or `postgis`,
       # this Cop ignores offenses.
       #
       # @example
@@ -63,6 +64,8 @@ module RuboCop
       #     end
       #   end
       class BulkChangeTable < Base
+        include DatabaseTypeResolvable
+
         MSG_FOR_CHANGE_TABLE = <<~MSG.chomp
           You can combine alter queries using `bulk: true` options.
         MSG
@@ -70,9 +73,6 @@ module RuboCop
           You can use `change_table :%<table>s, bulk: true` to combine alter queries.
         MSG
 
-        MYSQL = 'mysql'
-        POSTGRESQL = 'postgresql'
-
         MIGRATION_METHODS = %i[change up down].freeze
 
         COMBINABLE_TRANSFORMATIONS = %i[
@@ -174,39 +174,6 @@ module RuboCop
           options.hash_type? && options.keys.any? { |key| key.sym_type? && key.value == :bulk }
         end
 
-        def database
-          cop_config['Database'] || database_from_yaml
-        end
-
-        def database_from_yaml
-          return nil unless database_yaml
-
-          case database_yaml['adapter']
-          when 'mysql2'
-            MYSQL
-          when 'postgresql'
-            POSTGRESQL
-          end
-        end
-
-        def database_yaml
-          return nil unless File.exist?('config/database.yml')
-
-          yaml = if YAML.respond_to?(:unsafe_load_file)
-                   YAML.unsafe_load_file('config/database.yml')
-                 else
-                   YAML.load_file('config/database.yml')
-                 end
-          return nil unless yaml.is_a? Hash
-
-          config = yaml['development']
-          return nil unless config.is_a?(Hash)
-
-          config
-        rescue Psych::SyntaxError
-          nil
-        end
-
         def support_bulk_alter?
           case database
           when MYSQL
@@ -245,7 +212,7 @@ module RuboCop
         # @param node [RuboCop::AST::SendNode]
         def add_offense_for_alter_methods(node)
           # arguments: [{(sym :table)(str "table")} ...]
-          table_node = node.arguments[0]
+          table_node = node.first_argument
           return unless table_node.is_a? RuboCop::AST::BasicLiteralNode
 
           message = format(MSG_FOR_ALTER_METHODS, table: table_node.value)
@@ -267,10 +234,10 @@ module RuboCop
           # @param new_node [RuboCop::AST::SendNode]
           def process(new_node)
             # arguments: [{(sym :table)(str "table")} ...]
-            table_node = new_node.arguments[0]
+            table_node = new_node.first_argument
             if table_node.is_a? RuboCop::AST::BasicLiteralNode
               flush unless @nodes.all? do |node|
-                node.arguments[0].value.to_s == table_node.value.to_s
+                node.first_argument.value.to_s == table_node.value.to_s
               end
               @nodes << new_node
             else

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