rubocop-rails 2.14.2 → 2.19.1

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for add_column call with NOT NULL constraint
+      # Checks for add_column call with NOT NULL constraint
       # in migration file.
       #
       # @example
@@ -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.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/order_by_id.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for places where ordering by `id` column is used.
+      # Checks for places where ordering by `id` column is used.
       #
       # Don't use the `id` column for ordering. The sequence of ids is not guaranteed
       # to be in any particular order, despite often (incidentally) being chronological.
@@ -23,8 +23,7 @@ module RuboCop
       class OrderById < Base
         include RangeHelp
 
-        MSG = 'Do not use the `id` column for ordering. '\
-              'Use a timestamp column to order chronologically.'
+        MSG = 'Do not use the `id` column for ordering. Use a timestamp column to order chronologically.'
         RESTRICT_ON_SEND = %i[order].freeze
 
         def_node_matcher :order_by_id?, <<~PATTERN

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of output calls like puts and print
+      # Checks for the use of output calls like puts and print
       #
       # @safety
       #   This cop's autocorrection is unsafe because depending on the Rails log level configuration,
@@ -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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of output safety calls like `html_safe`,
+      # Checks for the use of output safety calls like `html_safe`,
       # `raw`, and `safe_concat`. These methods do not escape content. They
       # simply return a SafeBuffer containing the content as is. Instead,
       # use `safe_join` to join content and escape it and concat to
@@ -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/pick.rb

@@ -3,7 +3,7 @@
 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

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

@@ -3,7 +3,7 @@
 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.
@@ -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/pluck_in_where.rb

@@ -3,7 +3,7 @@
 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,

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

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

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

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

@@ -143,7 +143,7 @@ module RuboCop
         def_node_matcher :belongs_to_without_fk?, <<~PATTERN
           {
             (send nil? :belongs_to (sym %1))        # belongs_to :user
-            (send nil? :belongs_to (sym %1) !hash)  # belongs_to :user, -> { not_deleted }
+            (send nil? :belongs_to (sym %1) !hash ...)  # belongs_to :user, -> { not_deleted }
             (send nil? :belongs_to (sym %1) !(hash <(pair (sym :foreign_key) _) ...>))
           }
         PATTERN
@@ -217,7 +217,7 @@ module RuboCop
           keys.each do |key|
             key_node = node.arguments.find { |arg| arg.value == key }
             key_range = range_with_surrounding_space(
-              range: range_with_surrounding_comma(key_node.source_range, :right),
+              range_with_surrounding_comma(key_node.source_range, :right),
               side: :right
             )
             corrector.remove(key_range)
@@ -226,7 +226,7 @@ module RuboCop
 
         def remove_presence_option(corrector, presence)
           range = range_with_surrounding_comma(
-            range_with_surrounding_space(range: presence.source_range, side: :left),
+            range_with_surrounding_space(presence.source_range, side: :left),
             :left
           )
           corrector.remove(range)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for redundant receiver in `with_options`.
+      # Checks for redundant receiver in `with_options`.
       # Receiver is implicit from Rails 4.2 or higher.
       #
       # @example
@@ -60,15 +60,6 @@ module RuboCop
 
         MSG = 'Redundant receiver in `with_options`.'
 
-        def_node_matcher :with_options?, <<~PATTERN
-          (block
-            (send nil? :with_options
-              (...))
-            (args
-              $_arg)
-            $_body)
-        PATTERN
-
         def_node_search :all_block_nodes_in, <<~PATTERN
           (block ...)
         PATTERN
@@ -78,29 +69,42 @@ module RuboCop
         PATTERN
 
         def on_block(node)
-          with_options?(node) do |arg, body|
-            return if body.nil?
-            return unless all_block_nodes_in(body).count.zero?
-
-            send_nodes = all_send_nodes_in(body)
-
-            if send_nodes.all? { |n| same_value?(arg, n.receiver) }
-              send_nodes.each do |send_node|
-                receiver = send_node.receiver
-                add_offense(receiver.source_range) do |corrector|
-                  autocorrect(corrector, send_node)
-                end
-              end
+          return unless node.method?(:with_options)
+          return unless (body = node.body)
+          return unless all_block_nodes_in(body).count.zero?
+
+          send_nodes = all_send_nodes_in(body)
+          return unless redundant_receiver?(send_nodes, node)
+
+          send_nodes.each do |send_node|
+            receiver = send_node.receiver
+            add_offense(receiver.source_range) do |corrector|
+              autocorrect(corrector, send_node, node)
             end
           end
         end
 
+        alias on_numblock on_block
+
         private
 
-        def autocorrect(corrector, node)
-          corrector.remove(node.receiver.source_range)
-          corrector.remove(node.loc.dot)
-          corrector.remove(block_argument_range(node))
+        def autocorrect(corrector, send_node, node)
+          corrector.remove(send_node.receiver)
+          corrector.remove(send_node.loc.dot)
+          corrector.remove(block_argument_range(send_node)) unless node.numblock_type?
+        end
+
+        def redundant_receiver?(send_nodes, node)
+          proc = if node.numblock_type?
+                   ->(n) { n.receiver.lvar_type? && n.receiver.source == '_1' }
+                 else
+                   return false if node.arguments.empty?
+
+                   arg = node.arguments.first
+                   ->(n) { same_value?(arg, n.receiver) }
+                 end
+
+          send_nodes.all?(&proc)
         end
 
         def block_argument_range(node)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for redundant `travel_back` calls.
+      # Checks for redundant `travel_back` calls.
       # Since Rails 5.2, `travel_back` is automatically called at the end of the test.
       #
       # @example