rubocop-rails 2.15.2 → 2.20.2

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

@@ -35,19 +35,16 @@ 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
+        extend AutoCorrector
+
+        include RangeHelp
+
         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 +64,13 @@ 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)) do |corrector|
+              remove_node_with_left_space_and_comma(corrector, options[:if])
+            end
           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)) do |corrector|
+              remove_node_with_left_space_and_comma(corrector, options[:except])
+            end
           end
         end
 
@@ -90,6 +89,18 @@ module RuboCop
         def if_and_except?(options)
           options.key?(:if) && options.key?(:except)
         end
+
+        def remove_node_with_left_space_and_comma(corrector, node)
+          corrector.remove(
+            range_with_surrounding_comma(
+              range_with_surrounding_space(
+                node.source_range,
+                side: :left
+              ),
+              :left
+            )
+          )
+        end
       end
     end
   end

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

@@ -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

@@ -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/inverse_of.rb

@@ -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

@@ -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
@@ -166,14 +176,14 @@ module RuboCop
           when :sym
             [node.value]
           when :array
-            node.values.map do |v|
+            node.values.filter_map do |v|
               case v.type
               when :str
                 v.str_content.to_sym
               when :sym
                 v.value
               end
-            end.compact
+            end
           else
             []
           end
@@ -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

@@ -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

@@ -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/migration_class_name.rb

@@ -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

@@ -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)

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

@@ -21,7 +21,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[add_column add_reference].freeze
 
         def_node_matcher :add_not_null_column?, <<~PATTERN
-          (send nil? :add_column _ _ _ (hash $...))
+          (send nil? :add_column _ _ $_ (hash $...))
         PATTERN
 
         def_node_matcher :add_not_null_reference?, <<~PATTERN
@@ -44,17 +44,20 @@ module RuboCop
         private
 
         def check_add_column(node)
-          pairs = add_not_null_column?(node)
-          check_pairs(pairs)
+          add_not_null_column?(node) do |type, pairs|
+            return if type.respond_to?(:value) && (type.value == :virtual || type.value == 'virtual')
+
+            check_pairs(pairs)
+          end
         end
 
         def check_add_reference(node)
-          pairs = add_not_null_reference?(node)
-          check_pairs(pairs)
+          add_not_null_reference?(node) do |pairs|
+            check_pairs(pairs)
+          end
         end
 
         def check_pairs(pairs)
-          return unless pairs
           return if pairs.any? { |pair| default_option?(pair) }
 
           null_false = pairs.find { |pair| null_false?(pair) }

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

@@ -21,11 +21,8 @@ module RuboCop
         include RangeHelp
         extend AutoCorrector
 
-        MSG = 'Do not write to stdout. ' \
-              "Use Rails's logger if you want to log."
-        RESTRICT_ON_SEND = %i[
-          ap p pp pretty_print print puts binwrite syswrite write write_nonblock
-        ].freeze
+        MSG = "Do not write to stdout. Use Rails's logger if you want to log."
+        RESTRICT_ON_SEND = %i[ap p pp pretty_print print puts binwrite syswrite write write_nonblock].freeze
 
         def_node_matcher :output?, <<~PATTERN
           (send nil? {:ap :p :pp :pretty_print :print :puts} ...)
@@ -35,14 +32,15 @@ module RuboCop
           (send
             {
               (gvar #match_gvar?)
-              {(const nil? :STDOUT) (const nil? :STDERR)}
+              (const {nil? cbase} {:STDOUT :STDERR})
             }
             {:binwrite :syswrite :write :write_nonblock}
             ...)
         PATTERN
 
         def on_send(node)
-          return unless (output?(node) || io_output?(node)) && node.arguments?
+          return if node.parent&.call_type?
+          return unless output?(node) || io_output?(node)
 
           range = offense_range(node)
 
@@ -59,7 +57,7 @@ module RuboCop
 
         def offense_range(node)
           if node.receiver
-            range_between(node.loc.expression.begin_pos, node.loc.selector.end_pos)
+            range_between(node.source_range.begin_pos, node.loc.selector.end_pos)
           else
             node.loc.selector
           end

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

@@ -66,8 +66,12 @@ module RuboCop
         MSG = 'Tagging a string as html safe may be a security risk.'
         RESTRICT_ON_SEND = %i[html_safe raw safe_concat].freeze
 
+        def_node_search :i18n_method?, <<~PATTERN
+          (send {nil? (const {nil? cbase} :I18n)} {:t :translate :l :localize} ...)
+        PATTERN
+
         def on_send(node)
-          return if non_interpolated_string?(node)
+          return if non_interpolated_string?(node) || i18n_method?(node)
 
           return unless looks_like_rails_html_safe?(node) ||
                         looks_like_rails_raw?(node) ||

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

@@ -9,6 +9,18 @@ module RuboCop
       # element in an enumerable. When called on an Active Record relation, it
       # results in a more efficient query that only selects the necessary key.
       #
+      # @safety
+      #   This cop is unsafe because model can use column aliases.
+      #
+      #   [source,ruby]
+      #   ----
+      #   # Original code
+      #   User.select('name AS nickname').map { |user| user[:nickname] } # => array of nicknames
+      #
+      #   # After autocorrection
+      #   User.select('name AS nickname').pluck(:nickname) # => raises ActiveRecord::StatementInvalid
+      #   ----
+      #
       # @example
       #   # bad
       #   Post.published.map { |post| post[:title] }
@@ -21,42 +33,62 @@ module RuboCop
         extend AutoCorrector
         extend TargetRailsVersion
 
-        MSG = 'Prefer `pluck(:%<value>s)` over `%<current>s`.'
+        MSG = 'Prefer `%<replacement>s` over `%<current>s`.'
 
         minimum_target_rails_version 5.0
 
         def_node_matcher :pluck_candidate?, <<~PATTERN
-          ({block numblock} (send _ {:map :collect}) $_argument (send (lvar $_element) :[] (sym $_value)))
+          ({block numblock} (send _ {:map :collect}) $_argument (send lvar :[] $_key))
         PATTERN
 
         def on_block(node)
-          pluck_candidate?(node) do |argument, element, value|
+          pluck_candidate?(node) do |argument, key|
+            next if key.regexp_type? || !use_one_block_argument?(argument)
+
             match = if node.block_type?
-                      argument.children.first.source.to_sym == element
+                      block_argument = argument.children.first.source
+                      use_block_argument_in_key?(block_argument, key)
                     else # numblock
-                      argument == 1 && element == :_1
+                      argument == 1 && use_block_argument_in_key?('_1', key)
                     end
             next unless match
 
-            message = message(value, node)
-
-            add_offense(offense_range(node), message: message) do |corrector|
-              corrector.replace(offense_range(node), "pluck(:#{value})")
-            end
+            register_offense(node, key)
           end
         end
         alias on_numblock on_block
 
         private
 
+        def use_one_block_argument?(argument)
+          return true if argument == 1 # Checks for numbered argument `_1`.
+
+          argument.respond_to?(:one?) && argument.one?
+        end
+
+        def use_block_argument_in_key?(block_argument, key)
+          return false if block_argument == key.source
+
+          key.each_descendant(:lvar).none? { |lvar| block_argument == lvar.source }
+        end
+
         def offense_range(node)
           node.send_node.loc.selector.join(node.loc.end)
         end
 
-        def message(value, node)
+        def register_offense(node, key)
+          replacement = "pluck(#{key.source})"
+          message = message(replacement, node)
+
+          add_offense(offense_range(node), message: message) do |corrector|
+            corrector.replace(offense_range(node), replacement)
+          end
+        end
+
+        def message(replacement, node)
           current = offense_range(node).source
 
-          format(MSG, value: value, current: current)
+          format(MSG, replacement: replacement, current: current)
         end
       end
     end

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

@@ -51,7 +51,7 @@ module RuboCop
         private
 
         def offense_range(node)
-          range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos)
+          range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
         end
       end
     end

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

@@ -94,8 +94,7 @@ module RuboCop
         end
 
         def duration_method?(method_name)
-          SINGULAR_DURATION_METHODS.key?(method_name) ||
-            PLURAL_DURATION_METHODS.key?(method_name)
+          SINGULAR_DURATION_METHODS.key?(method_name) || PLURAL_DURATION_METHODS.key?(method_name)
         end
       end
     end

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

@@ -93,7 +93,7 @@ module RuboCop
 
         def register_offense(node, receiver, other)
           add_offense(node, message: message(node, receiver, other)) do |corrector|
-            corrector.replace(node.source_range, replacement(receiver, other))
+            corrector.replace(node, replacement(receiver, other, node.left_sibling))
           end
         end
 
@@ -106,12 +106,20 @@ module RuboCop
         end
 
         def message(node, receiver, other)
-          format(MSG,
-                 prefer: replacement(receiver, other),
-                 current: node.source)
+          prefer = replacement(receiver, other, node.left_sibling).gsub(/^\s*|\n/, '')
+          current = current(node).gsub(/^\s*|\n/, '')
+          format(MSG, prefer: prefer, current: current)
         end
 
-        def replacement(receiver, other)
+        def current(node)
+          if !node.ternary? && node.source.include?("\n")
+            "#{node.loc.keyword.with(end_pos: node.condition.loc.selector.end_pos).source} ... end"
+          else
+            node.source.gsub(/\n\s*/, ' ')
+          end
+        end
+
+        def replacement(receiver, other, left_sibling)
           or_source = if other&.send_type?
                         build_source_for_or_method(other)
                       elsif other.nil? || other.nil_type?
@@ -120,23 +128,24 @@ module RuboCop
                         " || #{other.source}"
                       end
 
-          "#{receiver.source}.presence" + or_source
+          replaced = "#{receiver.source}.presence#{or_source}"
+          left_sibling ? "(#{replaced})" : replaced
         end
 
         def build_source_for_or_method(other)
-          if other.parenthesized? || other.method?('[]') || !other.arguments?
+          if other.parenthesized? || other.method?('[]') || other.arithmetic_operation? || !other.arguments?
             " || #{other.source}"
           else
-            method = range_between(
-              other.source_range.begin_pos,
-              other.first_argument.source_range.begin_pos - 1
-            ).source
-
+            method = method_range(other).source
             arguments = other.arguments.map(&:source).join(', ')
 
             " || #{method}(#{arguments})"
           end
         end
+
+        def method_range(node)
+          range_between(node.source_range.begin_pos, node.first_argument.source_range.begin_pos - 1)
+        end
       end
     end
   end

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

@@ -8,7 +8,7 @@ module RuboCop
       #
       # Interaction with `Style/UnlessElse`:
       # The configuration of `NotBlank` will not produce an offense in the
-      # context of `unless else` if `Style/UnlessElse` is inabled. This is
+      # context of `unless else` if `Style/UnlessElse` is enabled. This is
       # to prevent interference between the autocorrection of the two cops.
       #
       # @example NotNilAndNotEmpty: true (default)
@@ -47,10 +47,8 @@ module RuboCop
         extend AutoCorrector
 
         MSG_NOT_BLANK = 'Use `%<prefer>s` instead of `%<current>s`.'
-        MSG_EXISTS_AND_NOT_EMPTY = 'Use `%<prefer>s` instead of ' \
-                                   '`%<current>s`.'
-        MSG_UNLESS_BLANK = 'Use `if %<prefer>s` instead of ' \
-                           '`%<current>s`.'
+        MSG_EXISTS_AND_NOT_EMPTY = 'Use `%<prefer>s` instead of `%<current>s`.'
+        MSG_UNLESS_BLANK = 'Use `if %<prefer>s` instead of `%<current>s`.'
         RESTRICT_ON_SEND = %i[!].freeze
 
         def_node_matcher :exists_and_not_empty?, <<~PATTERN
@@ -118,8 +116,7 @@ module RuboCop
 
           unless_blank?(node) do |method_call, receiver|
             range = unless_condition(node, method_call)
-            msg = format(MSG_UNLESS_BLANK, prefer: replacement(receiver),
-                                           current: range.source)
+            msg = format(MSG_UNLESS_BLANK, prefer: replacement(receiver), current: range.source)
             add_offense(range, message: msg) do |corrector|
               autocorrect(corrector, node)
             end
@@ -131,10 +128,10 @@ module RuboCop
 
           if method_call
             corrector.replace(node.loc.keyword, 'if')
-            range = method_call.loc.expression
+            range = method_call.source_range
           else
             variable1, _variable2 = exists_and_not_empty?(node) || not_blank?(node)
-            range = node.loc.expression
+            range = node.source_range
           end
 
           corrector.replace(range, replacement(variable1))
@@ -144,9 +141,9 @@ module RuboCop
 
         def unless_condition(node, method_call)
           if node.modifier_form?
-            node.loc.keyword.join(node.loc.expression.end)
+            node.loc.keyword.join(node.source_range.end)
           else
-            node.loc.expression.begin.join(method_call.loc.expression)
+            node.source_range.begin.join(method_call.source_range)
           end
         end
 

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

@@ -39,7 +39,7 @@ module RuboCop
           (block $(send nil? :task ...) ...)
         PATTERN
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           task_definition?(node) do |task_method|
             return if task_name(task_method) == :default
             return if with_dependencies?(task_method)
@@ -48,7 +48,7 @@ module RuboCop
               task_name = task_method.arguments[0]
               task_dependency = correct_task_dependency(task_name)
 
-              corrector.replace(task_name.loc.expression, task_dependency)
+              corrector.replace(task_name, task_dependency)
             end
           end
         end

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

@@ -52,7 +52,7 @@ module RuboCop
           return if within_shadowing_method?(node)
 
           add_offense(node, message: build_message(node)) do |corrector|
-            corrector.replace(node.source_range, node_replacement(node))
+            corrector.replace(node, node_replacement(node))
           end
         end
 

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

@@ -30,11 +30,9 @@ module RuboCop
         include RangeHelp
         extend AutoCorrector
 
-        MSG_SAME =
-          '`allow_nil` is redundant when `allow_blank` has the same value.'
+        MSG_SAME = '`allow_nil` is redundant when `allow_blank` has the same value.'
 
-        MSG_ALLOW_NIL_FALSE =
-          '`allow_nil: false` is redundant when `allow_blank` is true.'
+        MSG_ALLOW_NIL_FALSE = '`allow_nil: false` is redundant when `allow_blank` is true.'
 
         RESTRICT_ON_SEND = %i[validates].freeze
 
@@ -64,7 +62,7 @@ module RuboCop
             elsif prv_sib
               corrector.remove(range_between(node_end(prv_sib), node_end(allow_nil)))
             else
-              corrector.remove(allow_nil.loc.expression)
+              corrector.remove(allow_nil)
             end
           end
         end
@@ -89,11 +87,11 @@ module RuboCop
         end
 
         def node_beg(node)
-          node.loc.expression.begin_pos
+          node.source_range.begin_pos
         end
 
         def node_end(node)
-          node.loc.expression.end_pos
+          node.source_range.end_pos
         end
       end
     end

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

@@ -40,8 +40,8 @@ module RuboCop
         def on_send(node)
           association_with_foreign_key(node) do |type, name, options, foreign_key_pair, foreign_key|
             if redundant?(node, type, name, options, foreign_key)
-              add_offense(foreign_key_pair.loc.expression) do |corrector|
-                range = range_with_surrounding_space(range: foreign_key_pair.source_range, side: :left)
+              add_offense(foreign_key_pair.source_range) do |corrector|
+                range = range_with_surrounding_space(foreign_key_pair.source_range, side: :left)
                 range = range_with_surrounding_comma(range, :left)
 
                 corrector.remove(range)