rubocop-rails 2.11.2 → 2.19.1

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

@@ -3,12 +3,19 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the use of `pick` over `pluck(...).first`.
+      # Enforces the use of `pick` over `pluck(...).first`.
       #
       # Using `pluck` followed by `first` creates an intermediate array, which
       # `pick` avoids. When called on an Active Record relation, `pick` adds a
       # limit to the query so that only one value is fetched from the database.
       #
+      # @safety
+      #   This cop is unsafe because `pluck` is defined on both `ActiveRecord::Relation` and `Enumerable`,
+      #   whereas `pick` is only defined on `ActiveRecord::Relation` in Rails 6.0. This was addressed
+      #   in Rails 6.1 via rails/rails#38760, at which point the cop is safe.
+      #
+      #   See: https://github.com/rubocop/rubocop-rails/pull/249
+      #
       # @example
       #   # bad
       #   Model.pluck(:a).first

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

@@ -3,12 +3,24 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the use of `pluck` over `map`.
+      # Enforces the use of `pluck` over `map`.
       #
       # `pluck` can be used instead of `map` to extract a single key from each
       # 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,34 +33,62 @@ module RuboCop
         extend AutoCorrector
         extend TargetRailsVersion
 
-        MSG = 'Prefer `pluck(:%<value>s)` over `%<method>s { |%<argument>s| %<element>s[:%<value>s] }`.'
+        MSG = 'Prefer `%<replacement>s` over `%<current>s`.'
 
         minimum_target_rails_version 5.0
 
         def_node_matcher :pluck_candidate?, <<~PATTERN
-          (block (send _ ${:map :collect}) (args (arg $_argument)) (send (lvar $_element) :[] (sym $_value)))
+          ({block numblock} (send _ {:map :collect}) $_argument (send lvar :[] $_key))
         PATTERN
 
         def on_block(node)
-          pluck_candidate?(node) do |method, argument, element, value|
-            next unless argument == element
+          pluck_candidate?(node) do |argument, key|
+            next if key.regexp_type? || !use_one_block_argument?(argument)
 
-            message = message(method, argument, element, value)
+            match = if node.block_type?
+                      block_argument = argument.children.first.source
+                      use_block_argument_in_key?(block_argument, key)
+                    else # numblock
+                      argument == 1 && use_block_argument_in_key?('_1', key)
+                    end
+            next unless match
 
-            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(method, argument, element, value)
-          format(MSG, method: method, argument: argument, element: element, value: value)
+        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, replacement: replacement, current: current)
         end
       end
     end

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

@@ -3,7 +3,10 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the use of `ids` over `pluck(:id)` and `pluck(primary_key)`.
+      # Enforces the use of `ids` over `pluck(:id)` and `pluck(primary_key)`.
+      #
+      # @safety
+      #   This cop is unsafe if the receiver object is not an Active Record object.
       #
       # @example
       #   # bad
@@ -48,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/pluck_in_where.rb

@@ -3,20 +3,21 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop identifies places where `pluck` is used in `where` query methods
+      # Identifies places where `pluck` is used in `where` query methods
       # and can be replaced with `select`.
       #
       # Since `pluck` is an eager method and hits the database immediately,
       # using `select` helps to avoid additional database queries.
       #
-      # This cop has two different enforcement modes. When the EnforcedStyle
-      # is conservative (the default) then only calls to `pluck` on a constant
+      # This cop has two different enforcement modes. When the `EnforcedStyle`
+      # is `conservative` (the default) then only calls to `pluck` on a constant
       # (i.e. a model class) in the `where` is used as offenses.
       #
-      # When the EnforcedStyle is aggressive then all calls to `pluck` in the
-      # `where` is used as offenses. This may lead to false positives
-      # as the cop cannot replace to `select` between calls to `pluck` on an
-      # `ActiveRecord::Relation` instance vs a call to `pluck` on an `Array` instance.
+      # @safety
+      #   When the `EnforcedStyle` is `aggressive` then all calls to `pluck` in the
+      #   `where` is used as offenses. This may lead to false positives
+      #   as the cop cannot replace to `select` between calls to `pluck` on an
+      #   `ActiveRecord::Relation` instance vs a call to `pluck` on an `Array` instance.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for correct grammar when using ActiveSupport's
+      # Checks for correct grammar when using ActiveSupport's
       # core extensions to the numeric classes.
       #
       # @example
@@ -61,8 +61,8 @@ module RuboCop
         def offense?(node)
           number, = *node.receiver
 
-          singular_receiver?(number) && plural_method?(node.method_name) ||
-            plural_receiver?(number) && singular_method?(node.method_name)
+          (singular_receiver?(number) && plural_method?(node.method_name)) ||
+            (plural_receiver?(number) && singular_method?(node.method_name))
         end
 
         def plural_method?(method_name)
@@ -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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks code that can be written more easily using
+      # Checks code that can be written more easily using
       # `Object#presence` defined by Active Support.
       #
       # @example
@@ -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

@@ -3,13 +3,13 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for code that can be written with simpler conditionals
+      # Checks for code that can be written with simpler conditionals
       # using `Object#present?` defined by Active Support.
       #
       # 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
-      # to prevent interference between the auto-correction of the two cops.
+      # 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)
       #   # Converts usages of `!nil? && !empty?` to `present?`
@@ -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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for Rake tasks without the `:environment` task
+      # Checks for Rake tasks without the `:environment` task
       # dependency. The `:environment` task loads application code for other
       # Rake tasks. Without it, tasks cannot make use of application code like
       # models.
@@ -14,6 +14,11 @@ module RuboCop
       # * The task does not need application code.
       # * The task invokes the `:environment` task.
       #
+      # @safety
+      #   Probably not a problem in most cases, but it is possible that calling `:environment` task
+      #   will break a behavior. It's also slower. E.g. some task that only needs one gem to be
+      #   loaded to run will run significantly faster without loading the whole application.
+      #
       # @example
       #   # bad
       #   task :foo do
@@ -34,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)
@@ -43,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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of the `read_attribute` or `write_attribute`
+      # Checks for the use of the `read_attribute` or `write_attribute`
       # methods and recommends square brackets instead.
       #
       # If an attribute is missing from the instance (for example, when
@@ -23,10 +23,21 @@ module RuboCop
       #   # good
       #   x = self[:attr]
       #   self[:attr] = val
+      #
+      # When called from within a method with the same name as the attribute,
+      # `read_attribute` and `write_attribute` must be used to prevent an
+      # infinite loop:
+      #
+      # @example
+      #
+      #   # good
+      #   def foo
+      #     bar || read_attribute(:foo)
+      #   end
       class ReadWriteAttribute < Base
         extend AutoCorrector
 
-        MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
+        MSG = 'Prefer `%<prefer>s`.'
         RESTRICT_ON_SEND = %i[read_attribute write_attribute].freeze
 
         def_node_matcher :read_write_attribute?, <<~PATTERN
@@ -38,27 +49,53 @@ module RuboCop
 
         def on_send(node)
           return unless read_write_attribute?(node)
+          return if within_shadowing_method?(node)
 
-          add_offense(node.loc.selector, message: message(node)) do |corrector|
-            case node.method_name
-            when :read_attribute
-              replacement = read_attribute_replacement(node)
-            when :write_attribute
-              replacement = write_attribute_replacement(node)
-            end
-
-            corrector.replace(node.source_range, replacement)
+          add_offense(node, message: build_message(node)) do |corrector|
+            corrector.replace(node, node_replacement(node))
           end
         end
 
         private
 
-        def message(node)
+        def within_shadowing_method?(node)
+          first_arg = node.first_argument
+          return false unless first_arg.respond_to?(:value)
+
+          enclosing_method = node.each_ancestor(:def).first
+          return false unless enclosing_method
+
+          shadowing_method_name = first_arg.value.to_s
+          shadowing_method_name << '=' if node.method?(:write_attribute)
+          enclosing_method.method?(shadowing_method_name)
+        end
+
+        def build_message(node)
+          if node.single_line?
+            single_line_message(node)
+          else
+            multi_line_message(node)
+          end
+        end
+
+        def single_line_message(node)
+          format(MSG, prefer: node_replacement(node))
+        end
+
+        def multi_line_message(node)
           if node.method?(:read_attribute)
-            format(MSG, prefer: 'self[:attr]', current: 'read_attribute(:attr)')
+            format(MSG, prefer: 'self[:attr]')
           else
-            format(MSG, prefer: 'self[:attr] = val',
-                        current: 'write_attribute(:attr, val)')
+            format(MSG, prefer: 'self[:attr] = val')
+          end
+        end
+
+        def node_replacement(node)
+          case node.method_name
+          when :read_attribute
+            read_attribute_replacement(node)
+          when :write_attribute
+            write_attribute_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
 
@@ -56,15 +54,15 @@ module RuboCop
 
         def register_offense(allow_nil, message)
           add_offense(allow_nil, message: message) do |corrector|
-            prv_sib = previous_sibling(allow_nil)
-            nxt_sib = next_sibling(allow_nil)
+            prv_sib = allow_nil.left_sibling
+            nxt_sib = allow_nil.right_sibling
 
             if nxt_sib
               corrector.remove(range_between(node_beg(allow_nil), node_beg(nxt_sib)))
             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
@@ -88,20 +86,12 @@ module RuboCop
           nil
         end
 
-        def previous_sibling(node)
-          node.parent.children[node.sibling_index - 1]
-        end
-
-        def next_sibling(node)
-          node.parent.children[node.sibling_index + 1]
-        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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop detects cases where the `:foreign_key` option on associations
+      # Detects cases where the `:foreign_key` option on associations
       # is redundant.
       #
       # @example
@@ -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)