rubocop-rails 2.21.2 → 2.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e154e69d10b43226db08e454d992d724dc7504d54cac804e597156ee5cf13e5
-  data.tar.gz: 60d4697e076620a134f48eff2f81be7b2004fd824796b1a1b15f5822239e3ce3
+  metadata.gz: f90e14aba3397c0edacdc63f7dd9d5b83ed7d79382041f5f37e3201dea96c3db
+  data.tar.gz: 31ebefe705b4148901128b2b5feb5948b737acdd5fae210f8da6cec845f17023
 SHA512:
-  metadata.gz: f0aa0f69a7aa3b90d1e402ab26bdf5a4d03680080d9b06ba157cd92f3c5c290f821e81d4a99636009e17ec4ea2de0cfd405cea00134ebccd4323d424fb790ec8
-  data.tar.gz: 6b6ddbe47c1b112638cc3693464d9509f589a6683317b0bb30925a27788e39351a3a10853ecf286b419d3ec3b17e13aee9fd09ae07581d209635f0a56a44065b
+  metadata.gz: b90a96dae0688c93975260b480c2add1449c5ca21503a071453464f63ba030713501e1d20e2ea4fdf3385a58d1cf71003e2ede718ec9b6aa80e86e4a82be00a7
+  data.tar.gz: ad4ed3bbe86f2d1179766c512f347aaa21ea6e18e8af5a00f07eb20098c6c3c0103955ba4366bf952528773b7b2ff6a21af52369969227fd05233138a1060708

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,23 +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') }
-      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
 ```
 
-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

@@ -95,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
@@ -338,7 +339,6 @@ Rails/Date:
 
 Rails/DefaultScope:
   Description: 'Avoid use of `default_scope`.'
-  StyleGuide: 'https://rails.rubystyle.guide#avoid-default-scope'
   Enabled: false
   VersionAdded: '2.7'
 
@@ -430,6 +430,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
@@ -690,6 +695,9 @@ Rails/NotNullColumn:
   Enabled: true
   VersionAdded: '0.43'
   VersionChanged: '2.20'
+  Database: null
+  SupportedDatabases:
+    - mysql
   Include:
     - db/**/*.rb
 
@@ -894,7 +902,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'

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

@@ -98,8 +98,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/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/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

@@ -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` or `postgresql`,
+      # If the adapter is not `mysql2`, `trilogy`, `postgresql`, or `postgis`,
       # this Cop ignores offenses.
       #
       # @example
@@ -64,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
@@ -71,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[
@@ -175,55 +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 || database_from_env
-        end
-
-        def database_from_yaml
-          return nil unless database_yaml
-
-          case database_adapter
-          when 'mysql2'
-            MYSQL
-          when 'postgresql'
-            POSTGRESQL
-          end
-        end
-
-        def database_adapter
-          database_yaml['adapter'] || database_yaml.first.last['adapter']
-        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 database_from_env
-          url = ENV['DATABASE_URL'].presence
-          return nil unless url
-
-          case url
-          when %r{\Amysql2://}
-            MYSQL
-          when %r{\Apostgres(ql)?://}
-            POSTGRESQL
-          end
-        end
-
         def support_bulk_alter?
           case database
           when MYSQL
@@ -262,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)
@@ -284,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

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

@@ -31,10 +31,11 @@ module RuboCop
           time
         ].to_set.freeze
 
-        # Generated from `ActiveRecord::AttributeMethods.dangerous_attribute_methods` on activerecord 7.0.5.
+        # Generated from `ActiveRecord::AttributeMethods.dangerous_attribute_methods` on activerecord 7.1.0.
         # rubocop:disable Metrics/CollectionLiteralLength
         DANGEROUS_COLUMN_NAMES = %w[
           __callbacks
+          __id__
           _assign_attribute
           _assign_attributes
           _before_commit_callbacks
@@ -195,11 +196,13 @@ module RuboCop
           changes_to_save
           check_record_limit
           ciphertext_for
+          class
           clear_attribute_change
           clear_attribute_changes
           clear_changes_information
           clear_timestamp_attributes
           clear_transaction_record_state
+          clone
           collection_cache_versioning
           column_for_attribute
           committed
@@ -227,6 +230,7 @@ module RuboCop
           destroyed
           destroyed_by_association
           destroyed_by_association=
+          dup
           each_counter_cached_associations
           encode_with
           encrypt
@@ -243,7 +247,9 @@ module RuboCop
           find_parameter_position
           forget_attribute_assignments
           format_for_inspect
+          freeze
           from_json
+          frozen?
           halted_callback_hook
           has_attribute
           has_changes_to_save
@@ -252,6 +258,7 @@ module RuboCop
           has_encrypted_attributes
           has_encrypted_rich_texts
           has_transactional_callbacks
+          hash
           id
           id_before_type_cast
           id_for_database
@@ -283,6 +290,7 @@ module RuboCop
           new_record
           no_touching
           normalize_reflection_attribute
+          object_id
           partial_inserts
           partial_updates
           perform_validations
@@ -420,7 +428,7 @@ module RuboCop
           when :rename_column
             node.arguments[2]
           when *COLUMN_TYPE_METHOD_NAMES
-            node.arguments[0]
+            node.first_argument
           end
         end
 

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

@@ -20,6 +20,15 @@ module RuboCop
       #   belongs_to :bar
       #   has_one :foo
       #
+      #   # bad
+      #   has_many :foo, class_name: 'Foo'
+      #   has_many :bar, class_name: 'Foo'
+      #   has_one :baz
+      #
+      #   # good
+      #   has_many :bar, class_name: 'Foo'
+      #   has_one :foo
+      #
       class DuplicateAssociation < Base
         include RangeHelp
         extend AutoCorrector
@@ -27,31 +36,76 @@ module RuboCop
         include ActiveRecordHelper
 
         MSG = "Association `%<name>s` is defined multiple times. Don't repeat associations."
+        MSG_CLASS_NAME = "Association `class_name: %<name>s` is defined multiple times. Don't repeat associations."
 
         def_node_matcher :association, <<~PATTERN
-          (send nil? {:belongs_to :has_one :has_many :has_and_belongs_to_many} ({sym str} $_) ...)
+          (send nil? {:belongs_to :has_one :has_many :has_and_belongs_to_many} ({sym str} $_) $...)
+        PATTERN
+
+        def_node_matcher :class_name, <<~PATTERN
+          (hash (pair (sym :class_name) $_))
         PATTERN
 
         def on_class(class_node)
           return unless active_record?(class_node.parent_class)
 
-          offenses(class_node).each do |name, nodes|
-            nodes.each do |node|
-              add_offense(node, message: format(MSG, name: name)) do |corrector|
-                next if same_line?(nodes.last, node)
+          association_nodes = association_nodes(class_node)
 
-                corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
-              end
-            end
+          duplicated_association_name_nodes(association_nodes).each do |name, nodes|
+            register_offense(name, nodes, MSG)
+          end
+
+          duplicated_class_name_nodes(association_nodes).each do |class_name, nodes|
+            register_offense(class_name, nodes, MSG_CLASS_NAME)
           end
         end
 
         private
 
-        def offenses(class_node)
-          class_send_nodes(class_node).select { |node| association(node) }
-                                      .group_by { |node| association(node).to_sym }
-                                      .select { |_, nodes| nodes.length > 1 }
+        def register_offense(name, nodes, message_template)
+          nodes.each do |node|
+            add_offense(node, message: format(message_template, name: name)) do |corrector|
+              next if same_line?(nodes.last, node)
+
+              corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
+            end
+          end
+        end
+
+        def association_nodes(class_node)
+          class_send_nodes(class_node).select do |node|
+            association(node)&.first
+          end
+        end
+
+        def duplicated_association_name_nodes(association_nodes)
+          grouped_associations = association_nodes.group_by do |node|
+            association(node).first.to_sym
+          end
+
+          leave_duplicated_association(grouped_associations)
+        end
+
+        def duplicated_class_name_nodes(association_nodes)
+          filtered_nodes = association_nodes.reject { |node| node.method?(:belongs_to) }
+          grouped_associations = filtered_nodes.group_by do |node|
+            arguments = association(node).last
+            next unless arguments.count == 1
+
+            if (class_name = class_name(arguments.first))
+              class_name.source
+            end
+          end
+
+          grouped_associations.delete(nil)
+
+          leave_duplicated_association(grouped_associations)
+        end
+
+        def leave_duplicated_association(grouped_associations)
+          grouped_associations.select do |_, nodes|
+            nodes.length > 1
+          end
         end
       end
     end

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

@@ -14,10 +14,10 @@ module RuboCop
       # when no output would be produced anyway.
       #
       # @example
-      #   #bad
+      #   # bad
       #   Rails.logger.debug "The time is #{Time.zone.now}."
       #
-      #   #good
+      #   # good
       #   Rails.logger.debug { "The time is #{Time.zone.now}." }
       #
       class EagerEvaluationLogMessage < Base

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks for usage of `Rails.env.development? || Rails.env.test?` which
+      # can be replaced with `Rails.env.local?`, introduced in Rails 7.1.
+      #
+      # @example
+      #
+      #   # bad
+      #   Rails.env.development? || Rails.env.test?
+      #
+      #   # good
+      #   Rails.env.local?
+      #
+      class EnvLocal < Base
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        MSG = 'Use `Rails.env.local?` instead.'
+        LOCAL_ENVIRONMENTS = %i[development? test?].to_set.freeze
+
+        minimum_target_rails_version 7.1
+
+        # @!method rails_env_local_candidate?(node)
+        def_node_matcher :rails_env_local_candidate?, <<~PATTERN
+          (or
+            (send (send (const {cbase nil? } :Rails) :env) $%LOCAL_ENVIRONMENTS)
+            (send (send (const {cbase nil? } :Rails) :env) $%LOCAL_ENVIRONMENTS)
+          )
+        PATTERN
+
+        def on_or(node)
+          rails_env_local_candidate?(node) do |*environments|
+            next unless environments.to_set == LOCAL_ENVIRONMENTS
+
+            add_offense(node) do |corrector|
+              corrector.replace(node, 'Rails.env.local?')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -163,9 +163,9 @@ module RuboCop
 
         def autocorrect_extension_after_rails_root_join_in_dstr(corrector, node, rails_root_index, extension_node)
           rails_root_node = node.children[rails_root_index].children.first
-          return unless rails_root_node.arguments.last.str_type?
+          return unless rails_root_node.last_argument.str_type?
 
-          corrector.insert_before(rails_root_node.arguments.last.location.end, extension_node.source)
+          corrector.insert_before(rails_root_node.last_argument.location.end, extension_node.source)
           corrector.remove(extension_node)
         end
 
@@ -174,7 +174,7 @@ module RuboCop
           corrector.remove(
             range_with_surrounding_space(
               range_with_surrounding_comma(
-                node.arguments.first.source_range,
+                node.first_argument.source_range,
                 :right
               ),
               side: :right
@@ -187,7 +187,7 @@ module RuboCop
         end
 
         def autocorrect_rails_root_join_with_string_arguments(corrector, node)
-          corrector.replace(node.arguments.first, %("#{node.arguments.map(&:value).join('/')}"))
+          corrector.replace(node.first_argument, %("#{node.arguments.map(&:value).join('/')}"))
           node.arguments[1..].each do |argument|
             corrector.remove(
               range_with_surrounding_comma(
@@ -221,7 +221,7 @@ module RuboCop
         end
 
         def append_argument(corrector, node, argument_source)
-          corrector.insert_after(node.arguments.last, %(, "#{argument_source}"))
+          corrector.insert_after(node.last_argument, %(, "#{argument_source}"))
         end
 
         def replace_with_rails_root_join(corrector, node, 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