rubocop-rails 2.14.2 → 2.19.1

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for `has_many` or `has_one` associations that don't
+      # Looks for `has_many` or `has_one` associations that don't
       # specify a `:dependent` option.
       #
       # It doesn't register an offense if `:through` or `dependent: nil`
@@ -37,15 +37,15 @@ module RuboCop
         RESTRICT_ON_SEND = %i[has_many has_one].freeze
 
         def_node_search :active_resource_class?, <<~PATTERN
-          (const (const nil? :ActiveResource) :Base)
+          (const (const {nil? cbase} :ActiveResource) :Base)
         PATTERN
 
         def_node_matcher :association_without_options?, <<~PATTERN
-          (send nil? {:has_many :has_one} _)
+          (send _ {:has_many :has_one} _)
         PATTERN
 
         def_node_matcher :association_with_options?, <<~PATTERN
-          (send nil? {:has_many :has_one} ... (hash $...))
+          (send _ {:has_many :has_one} ... (hash $...))
         PATTERN
 
         def_node_matcher :dependent_option?, <<~PATTERN
@@ -105,9 +105,7 @@ module RuboCop
 
             return false unless node.parent
 
-            return true if contain_valid_options_in_with_options_block?(
-              node.parent.parent
-            )
+            return true if contain_valid_options_in_with_options_block?(node.parent.parent)
           end
 
           false
@@ -116,7 +114,7 @@ module RuboCop
         def valid_options?(options)
           return false if options.nil?
 
-          options = options.first.children.first.pairs if options.first.kwsplat_type?
+          options = extract_option_if_kwsplat(options)
 
           return true unless options
           return true if options.any? do |o|
@@ -126,6 +124,14 @@ module RuboCop
           false
         end
 
+        def extract_option_if_kwsplat(options)
+          if options.first.kwsplat_type? && options.first.children.first.hash_type?
+            return options.first.children.first.pairs
+          end
+
+          options
+        end
+
         def active_resource?(node)
           return false if node.nil?
 

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

@@ -3,14 +3,14 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for use of the helper methods which reference
+      # Checks for use of the helper methods which reference
       # instance variables.
       #
       # Relying on instance variables makes it difficult to re-use helper
       # methods.
       #
       # If it seems awkward to explicitly pass in each dependent
-      # variable, consider moving the behaviour elsewhere, for
+      # variable, consider moving the behavior elsewhere, for
       # example to a model, decorator or presenter.
       #
       # Provided that a class inherits `ActionView::Helpers::FormBuilder`,
@@ -37,7 +37,7 @@ module RuboCop
         def_node_matcher :form_builder_class?, <<~PATTERN
           (const
             (const
-               (const nil? :ActionView) :Helpers) :FormBuilder)
+               (const {nil? cbase} :ActionView) :Helpers) :FormBuilder)
         PATTERN
 
         def on_ivar(node)

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

@@ -3,13 +3,16 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop is used to identify usages of http methods like `get`, `post`,
+      # Identifies usages of http methods like `get`, `post`,
       # `put`, `patch` without the usage of keyword arguments in your tests and
       # change them to use keyword args. This cop only applies to Rails >= 5.
       # If you are running Rails < 5 you should disable the
       # Rails/HttpPositionalArguments cop or set your TargetRailsVersion in your
       # .rubocop.yml file to 4.2.
       #
+      # NOTE: It does not detect any cases where `include Rack::Test::Methods` is used
+      # which makes the http methods incompatible behavior.
+      #
       # @example
       #   # bad
       #   get :new, { user_id: 1}
@@ -22,11 +25,8 @@ module RuboCop
         extend AutoCorrector
         extend TargetRailsVersion
 
-        MSG = 'Use keyword arguments instead of ' \
-              'positional arguments for http call: `%<verb>s`.'
-        KEYWORD_ARGS = %i[
-          method params session body flash xhr as headers env to
-        ].freeze
+        MSG = 'Use keyword arguments instead of positional arguments for http call: `%<verb>s`.'
+        KEYWORD_ARGS = %i[method params session body flash xhr as headers env to].freeze
         ROUTING_METHODS = %i[draw routes].freeze
         RESTRICT_ON_SEND = %i[get post put patch delete head].freeze
 
@@ -40,8 +40,15 @@ module RuboCop
           (hash (kwsplat _))
         PATTERN
 
+        def_node_matcher :include_rack_test_methods?, <<~PATTERN
+          (send nil? :include
+            (const
+              (const
+                (const {nil? cbase} :Rack) :Test) :Methods))
+        PATTERN
+
         def on_send(node)
-          return if in_routing_block?(node)
+          return if in_routing_block?(node) || use_rack_test_methods?
 
           http_request?(node) do |data|
             return unless needs_conversion?(data)
@@ -59,7 +66,7 @@ module RuboCop
               # that represents the path/action on the Rails controller
               # the data is the http parameters and environment sent in
               # the Rails 5 http call
-              corrector.replace(node.loc.expression, correction(node))
+              corrector.replace(node, correction(node))
             end
           end
         end
@@ -70,13 +77,18 @@ module RuboCop
           !!node.each_ancestor(:block).detect { |block| ROUTING_METHODS.include?(block.method_name) }
         end
 
+        def use_rack_test_methods?
+          processed_source.ast.each_descendant(:send).any? do |node|
+            include_rack_test_methods?(node)
+          end
+        end
+
         def needs_conversion?(data)
           return true unless data.hash_type?
           return false if kwsplat_hash?(data)
 
           data.each_pair.none? do |pair|
-            special_keyword_arg?(pair.key) ||
-              (format_arg?(pair.key) && data.pairs.one?)
+            special_keyword_arg?(pair.key) || (format_arg?(pair.key) && data.pairs.one?)
           end
         end
 
@@ -98,8 +110,7 @@ module RuboCop
           return '' if data.hash_type? && data.empty?
 
           hash_data = if data.hash_type?
-                        format('{ %<data>s }',
-                               data: data.pairs.map(&:source).join(', '))
+                        format('{ %<data>s }', data: data.pairs.map(&:source).join(', '))
                       else
                         # user supplies an object,
                         # no need to surround with braces

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

@@ -66,7 +66,7 @@ module RuboCop
             return unless checker.offensive?
 
             add_offense(checker.node, message: checker.message) do |corrector|
-              corrector.replace(checker.node.loc.expression, checker.preferred_style)
+              corrector.replace(checker.node, checker.preferred_style)
             end
           end
         end
@@ -84,10 +84,8 @@ module RuboCop
 
         # :nodoc:
         class SymbolicStyleChecker
-          MSG = 'Prefer `%<prefer>s` over `%<current>s` ' \
-                'to define HTTP status code.'
-          DEFAULT_MSG = 'Prefer `symbolic` over `numeric` ' \
-                        'to define HTTP status code.'
+          MSG = 'Prefer `%<prefer>s` over `%<current>s` to define HTTP status code.'
+          DEFAULT_MSG = 'Prefer `symbolic` over `numeric` to define HTTP status code.'
 
           attr_reader :node
 
@@ -118,17 +116,14 @@ module RuboCop
           end
 
           def custom_http_status_code?
-            node.int_type? &&
-              !::Rack::Utils::SYMBOL_TO_STATUS_CODE.value?(number)
+            node.int_type? && !::Rack::Utils::SYMBOL_TO_STATUS_CODE.value?(number)
           end
         end
 
         # :nodoc:
         class NumericStyleChecker
-          MSG = 'Prefer `%<prefer>s` over `%<current>s` ' \
-                'to define HTTP status code.'
-          DEFAULT_MSG = 'Prefer `numeric` over `symbolic` ' \
-                        'to define HTTP status code.'
+          MSG = 'Prefer `%<prefer>s` over `%<current>s` to define HTTP status code.'
+          DEFAULT_MSG = 'Prefer `numeric` over `symbolic` to define HTTP status code.'
           PERMITTED_STATUS = %i[error success missing redirect].freeze
 
           attr_reader :node

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for places where I18n "lazy" lookup can be used.
+      # Checks for places where I18n "lazy" lookup can be used.
       #
       # @example
       #   # en.yml
@@ -34,6 +34,8 @@ module RuboCop
 
         MSG = 'Use "lazy" lookup for the text used in controllers.'
 
+        RESTRICT_ON_SEND = %i[translate t].freeze
+
         def_node_matcher :translate_call?, <<~PATTERN
           (send nil? {:translate :t} ${sym_type? str_type?} ...)
         PATTERN

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of `I18n.locale=` method.
+      # Checks for the use of `I18n.locale=` method.
       #
       # The `locale` attribute persists for the rest of the Ruby runtime, potentially causing
       # unexpected behavior at a later time.

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

@@ -69,7 +69,7 @@ module RuboCop
       class I18nLocaleTexts < Base
         MSG = 'Move locale texts to the locale files in the `config/locales` directory.'
 
-        RESTRICT_ON_SEND = %i[validates redirect_to []= mail].freeze
+        RESTRICT_ON_SEND = %i[validates redirect_to redirect_back []= mail].freeze
 
         def_node_search :validation_message, <<~PATTERN
           (pair (sym :message) $str)
@@ -94,7 +94,7 @@ module RuboCop
               add_offense(text_node)
             end
             return
-          when :redirect_to
+          when :redirect_to, :redirect_back
             text_node = redirect_to_flash(node).to_a.last
           when :[]=
             text_node = flash_assignment?(node)

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Looks for assignments of `ignored_columns` that may override previous
+      # assignments.
+      #
+      # Overwriting previous assignments is usually a mistake, since it will
+      # un-ignore the first set of columns. Since duplicate column names is not
+      # a problem, it is better to simply append to the list.
+      #
+      # @example
+      #
+      #   # bad
+      #   class User < ActiveRecord::Base
+      #     self.ignored_columns = [:one]
+      #   end
+      #
+      #   # bad
+      #   class User < ActiveRecord::Base
+      #     self.ignored_columns = [:one, :two]
+      #   end
+      #
+      #   # good
+      #   class User < ActiveRecord::Base
+      #     self.ignored_columns += [:one, :two]
+      #   end
+      #
+      #   # good
+      #   class User < ActiveRecord::Base
+      #     self.ignored_columns += [:one]
+      #     self.ignored_columns += [:two]
+      #   end
+      #
+      class IgnoredColumnsAssignment < Base
+        extend AutoCorrector
+
+        MSG = 'Use `+=` instead of `=`.'
+        RESTRICT_ON_SEND = %i[ignored_columns=].freeze
+
+        def on_send(node)
+          add_offense(node.loc.operator) do |corrector|
+            corrector.replace(node.loc.operator, '+=')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that `if` and `only` (or `except`) are not used together
+      # Checks that `if` and `only` (or `except`) are not used together
       # as options of `skip_*` action filter.
       #
       # The `if` option will be ignored when `if` and `only` are used together.
@@ -35,19 +35,12 @@ module RuboCop
       #     skip_before_action :login_required,
       #       if: -> { trusted_origin? && action_name != "admin" }
       #   end
-      #
-      # @see https://api.rubyonrails.org/classes/AbstractController/Callbacks/ClassMethods.html#method-i-_normalize_callback_options
       class IgnoredSkipActionFilterOption < Base
         MSG = <<~MSG.chomp.freeze
           `%<ignore>s` option will be ignored when `%<prefer>s` and `%<ignore>s` are used together.
         MSG
 
-        RESTRICT_ON_SEND = %i[
-          skip_after_action
-          skip_around_action
-          skip_before_action
-          skip_action_callback
-        ].freeze
+        RESTRICT_ON_SEND = %i[skip_after_action skip_around_action skip_before_action skip_action_callback].freeze
 
         FILTERS = RESTRICT_ON_SEND.map { |method_name| ":#{method_name}" }
 
@@ -67,11 +60,9 @@ module RuboCop
           options = options_hash(options)
 
           if if_and_only?(options)
-            add_offense(options[:if],
-                        message: format(MSG, prefer: :only, ignore: :if))
+            add_offense(options[:if], message: format(MSG, prefer: :only, ignore: :if))
           elsif if_and_except?(options)
-            add_offense(options[:except],
-                        message: format(MSG, prefer: :if, ignore: :except))
+            add_offense(options[:except], message: format(MSG, prefer: :if, ignore: :except))
           end
         end
 
@@ -80,7 +71,7 @@ module RuboCop
         def options_hash(options)
           options.pairs
                  .select { |pair| pair.key.sym_type? }
-                 .map { |pair| [pair.key.value, pair] }.to_h
+                 .to_h { |pair| [pair.key.value, pair] }
         end
 
         def if_and_only?(options)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for uses of `each_with_object({}) { ... }`,
+      # Looks for uses of `each_with_object({}) { ... }`,
       # `map { ... }.to_h`, and `Hash[map { ... }]` that are transforming
       # an enumerable into a hash where the values are the original elements.
       # Rails provides the `index_by` method for this purpose.
@@ -46,7 +46,7 @@ module RuboCop
 
         def_node_matcher :on_bad_hash_brackets_map, <<~PATTERN
           (send
-            (const _ :Hash)
+            (const {nil? cbase} :Hash)
             :[]
             (block
               (call _ {:map :collect})

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for uses of `each_with_object({}) { ... }`,
+      # Looks for uses of `each_with_object({}) { ... }`,
       # `map { ... }.to_h`, and `Hash[map { ... }]` that are transforming
       # an enumerable into a hash where the keys are the original elements.
       # Rails provides the `index_with` method for this purpose.
@@ -49,7 +49,7 @@ module RuboCop
 
         def_node_matcher :on_bad_hash_brackets_map, <<~PATTERN
           (send
-            (const _ :Hash)
+            (const {nil? cbase} :Hash)
             :[]
             (block
               (call _ {:map :collect})

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that Active Support's `inquiry` method is not used.
+      # Checks that Active Support's `inquiry` method is not used.
       #
       # @example
       #   # bad - String#inquiry

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for has_(one|many) and belongs_to associations where
+      # Looks for has_(one|many) and belongs_to associations where
       # Active Record can't automatically determine the inverse association
       # because of a scope or the options used. Using the blog with order scope
       # example below, traversing the a Blog's association in both directions
@@ -137,9 +137,6 @@ module RuboCop
       #   class Blog < ApplicationRecord
       #     has_many :posts, -> { order(published_at: :desc) }
       #   end
-      #
-      # @see https://guides.rubyonrails.org/association_basics.html#bi-directional-associations
-      # @see https://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#module-ActiveRecord::Associations::ClassMethods-label-Setting+Inverses
       class InverseOf < Base
         SPECIFY_MSG = 'Specify an `:inverse_of` option.'
         NIL_MSG = 'You specified `inverse_of: nil`, you probably meant to use `inverse_of: false`.'
@@ -192,8 +189,7 @@ module RuboCop
           end
           return if options_ignoring_inverse_of?(options)
 
-          return unless scope?(arguments) ||
-                        options_requiring_inverse_of?(options)
+          return unless scope?(arguments) || options_requiring_inverse_of?(options)
 
           return if options_contain_inverse_of?(options)
 
@@ -206,8 +202,7 @@ module RuboCop
 
         def options_requiring_inverse_of?(options)
           required = options.any? do |opt|
-            conditions_option?(opt) ||
-              foreign_key_option?(opt)
+            conditions_option?(opt) || foreign_key_option?(opt)
           end
 
           return required if target_rails_version >= 5.2
@@ -227,8 +222,7 @@ module RuboCop
 
         def with_options_arguments(recv, node)
           blocks = node.each_ancestor(:block).select do |block|
-            block.send_node.command?(:with_options) &&
-              same_context_in_with_options?(block.arguments.first, recv)
+            block.send_node.command?(:with_options) && same_context_in_with_options?(block.arguments.first, recv)
           end
           blocks.flat_map { |n| n.send_node.arguments }
         end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that methods specified in the filter's `only` or
+      # Checks that methods specified in the filter's `only` or
       # `except` options are defined within the same class or module.
       #
       # @safety
@@ -12,7 +12,7 @@ module RuboCop
       #   methods that are defined in other classes or modules, you should
       #   define the filter in that class or module.
       #
-      #   If you rely on behaviour defined in the superclass actions, you must
+      #   If you rely on behavior defined in the superclass actions, you must
       #   remember to invoke `super` in the subclass actions.
       #
       # @example
@@ -71,7 +71,7 @@ module RuboCop
       #   class ArticlesController < ContentController
       #     before_action :load_article, only: [:update]
       #
-      #     # the cop requires this method, but it relies on behaviour defined
+      #     # the cop requires this method, but it relies on behavior defined
       #     # in the superclass, so needs to invoke `super`
       #     def update
       #       super
@@ -144,19 +144,29 @@ module RuboCop
         end
 
         def aliased_action_methods(node, defined_methods)
-          alias_methods = node.each_child_node(:send).select { |send_node| send_node.method?(:alias_method) }
-
-          hash_of_alias_methods = alias_methods.each_with_object({}) do |alias_method, result|
-            result[alias_method.last_argument.value] = alias_method.first_argument.value
-          end
-
+          alias_methods = alias_methods(node)
           defined_methods.each_with_object([]) do |defined_method, aliased_method|
-            if (new_method_name = hash_of_alias_methods[defined_method])
+            if (new_method_name = alias_methods[defined_method])
               aliased_method << new_method_name
             end
           end
         end
 
+        def alias_methods(node)
+          result = {}
+          node.each_child_node(:send, :alias) do |child_node|
+            case child_node.type
+            when :send
+              if child_node.method?(:alias_method)
+                result[child_node.last_argument.value] = child_node.first_argument.value
+              end
+            when :alias
+              result[child_node.old_identifier.value] = child_node.new_identifier.value
+            end
+          end
+          result
+        end
+
         # @param node [RuboCop::AST::Node]
         # @return [Array<Symbol>]
         def array_values(node) # rubocop:disable Metrics/MethodLength
@@ -184,13 +194,9 @@ module RuboCop
         # @return [String]
         def message(methods, parent)
           if methods.size == 1
-            format(MSG,
-                   action: "`#{methods[0]}` is",
-                   type: parent.type)
+            format(MSG, action: "`#{methods[0]}` is", type: parent.type)
           else
-            format(MSG,
-                   action: "`#{methods.join('`, `')}` are",
-                   type: parent.type)
+            format(MSG, action: "`#{methods.join('`, `')}` are", type: parent.type)
           end
         end
       end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for calls to `link_to` that contain a
+      # Checks for calls to `link_to` that contain a
       # `target: '_blank'` but no `rel: 'noopener'`. This can be a security
       # risk as the loaded page will have control over the previous page
       # and could change its location for phishing purposes.
@@ -68,10 +68,7 @@ module RuboCop
 
         def append_to_rel(rel_node, corrector)
           existing_rel = rel_node.children.last.value
-          str_range = rel_node.children.last.loc.expression.adjust(
-            begin_pos: 1,
-            end_pos: -1
-          )
+          str_range = rel_node.children.last.source_range.adjust(begin_pos: 1, end_pos: -1)
           corrector.replace(str_range, "#{existing_rel} noopener")
         end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces that mailer names end with `Mailer` suffix.
+      # Enforces that mailer names end with `Mailer` suffix.
       #
       # Without the `Mailer` suffix it isn't immediately apparent what's a mailer
       # and which views are related to the mailer.
@@ -34,8 +34,8 @@ module RuboCop
 
         def_node_matcher :mailer_base_class?, <<~PATTERN
           {
-            (const (const nil? :ActionMailer) :Base)
-            (const nil? :ApplicationMailer)
+            (const (const {nil? cbase} :ActionMailer) :Base)
+            (const {nil? cbase} :ApplicationMailer)
           }
         PATTERN
 
@@ -44,7 +44,7 @@ module RuboCop
         PATTERN
 
         def_node_matcher :class_new_definition?, <<~PATTERN
-          (send (const nil? :Class) :new #mailer_base_class?)
+          (send (const {nil? cbase} :Class) :new #mailer_base_class?)
         PATTERN
 
         def on_class(node)
@@ -77,7 +77,7 @@ module RuboCop
             corrector.replace(node.loc.name, "#{name}Mailer")
           else
             name = node.children.last
-            corrector.replace(node.source_range, "#{name}Mailer")
+            corrector.replace(node, "#{name}Mailer")
           end
         end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop identifies places where defining routes with `match`
+      # Identifies places where defining routes with `match`
       # can be replaced with a specific HTTP method.
       #
       # Don't use `match` to define any routes unless there is a need to map multiple request types

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop makes sure that each migration file defines a migration class
+      # Makes sure that each migration file defines a migration class
       # whose name matches the file name.
       # (e.g. `20220224111111_create_users.rb` should define `CreateUsers` class.)
       #
@@ -29,7 +29,7 @@ module RuboCop
 
           basename = basename_without_timestamp_and_suffix(processed_source.file_path)
 
-          class_identifier = node.identifier
+          class_identifier = node.identifier.location.name
           camelized_basename = camelize(basename)
           return if class_identifier.source.casecmp(camelized_basename).zero?
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the use of `collection.exclude?(obj)`
+      # Enforces the use of `collection.exclude?(obj)`
       # over `!collection.include?(obj)`.
       #
       # @safety
@@ -26,7 +26,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[!].freeze
 
         def_node_matcher :negate_include_call?, <<~PATTERN
-          (send (send $_ :include? $_) :!)
+          (send (send $!nil? :include? $_) :!)
         PATTERN
 
         def on_send(node)