rubocop-rails 2.0.1 → 2.19.1

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

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks direct manipulation of ActiveModel#errors as hash.
+      # These operations are deprecated in Rails 6.1 and will not work in Rails 7.
+      #
+      # @safety
+      #   This cop is unsafe because it can report `errors` manipulation on non-ActiveModel,
+      #   which is obviously valid.
+      #   The cop has no way of knowing whether a variable is an ActiveModel or not.
+      #
+      # @example
+      #   # bad
+      #   user.errors[:name] << 'msg'
+      #   user.errors.messages[:name] << 'msg'
+      #
+      #   # good
+      #   user.errors.add(:name, 'msg')
+      #
+      #   # bad
+      #   user.errors[:name].clear
+      #   user.errors.messages[:name].clear
+      #
+      #   # good
+      #   user.errors.delete(:name)
+      #
+      #   # bad
+      #   user.errors.keys.include?(:attr)
+      #
+      #   # good
+      #   user.errors.attribute_names.include?(:attr)
+      #
+      class DeprecatedActiveModelErrorsMethods < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Avoid manipulating ActiveModel errors as hash directly.'
+        AUTOCORRECTABLE_METHODS = %i[<< clear keys].freeze
+        INCOMPATIBLE_METHODS = %i[keys values to_h to_xml].freeze
+
+        MANIPULATIVE_METHODS = Set[
+          *%i[
+            << append clear collect! compact! concat
+            delete delete_at delete_if drop drop_while fill filter! keep_if
+            flatten! insert map! pop prepend push reject! replace reverse!
+            rotate! select! shift shuffle! slice! sort! sort_by! uniq! unshift
+          ]
+        ].freeze
+
+        def_node_matcher :receiver_matcher_outside_model, '{send ivar lvar}'
+        def_node_matcher :receiver_matcher_inside_model, '{nil? send ivar lvar}'
+
+        def_node_matcher :any_manipulation?, <<~PATTERN
+          {
+            #root_manipulation?
+            #root_assignment?
+            #errors_deprecated?
+            #messages_details_manipulation?
+            #messages_details_assignment?
+          }
+        PATTERN
+
+        def_node_matcher :root_manipulation?, <<~PATTERN
+          (send
+            (send
+              (send #receiver_matcher :errors) :[] ...)
+            MANIPULATIVE_METHODS
+            ...
+          )
+        PATTERN
+
+        def_node_matcher :root_assignment?, <<~PATTERN
+          (send
+            (send #receiver_matcher :errors)
+            :[]=
+            ...)
+        PATTERN
+
+        def_node_matcher :errors_deprecated?, <<~PATTERN
+          (send
+            (send #receiver_matcher :errors)
+            {:keys :values :to_h :to_xml})
+        PATTERN
+
+        def_node_matcher :messages_details_manipulation?, <<~PATTERN
+          (send
+            (send
+              (send
+                (send #receiver_matcher :errors)
+                {:messages :details})
+                :[]
+                ...)
+              MANIPULATIVE_METHODS
+            ...)
+        PATTERN
+
+        def_node_matcher :messages_details_assignment?, <<~PATTERN
+          (send
+            (send
+              (send #receiver_matcher :errors)
+              {:messages :details})
+            :[]=
+            ...)
+        PATTERN
+
+        def on_send(node)
+          any_manipulation?(node) do
+            next if target_rails_version <= 6.0 && INCOMPATIBLE_METHODS.include?(node.method_name)
+
+            add_offense(node) do |corrector|
+              next if skip_autocorrect?(node)
+
+              autocorrect(corrector, node)
+            end
+          end
+        end
+
+        private
+
+        def skip_autocorrect?(node)
+          return true unless AUTOCORRECTABLE_METHODS.include?(node.method_name)
+          return false unless (receiver = node.receiver.receiver)
+
+          receiver.send_type? && receiver.method?(:details) && node.method?(:<<)
+        end
+
+        def autocorrect(corrector, node)
+          receiver = node.receiver
+
+          range = offense_range(node, receiver)
+          replacement = replacement(node, receiver)
+
+          corrector.replace(range, replacement)
+        end
+
+        def offense_range(node, receiver)
+          receiver = receiver.receiver while receiver.send_type? && !receiver.method?(:errors) && receiver.receiver
+          range_between(receiver.source_range.end_pos, node.source_range.end_pos)
+        end
+
+        def replacement(node, receiver)
+          return '.attribute_names' if node.method?(:keys)
+
+          key = receiver.first_argument.source
+
+          case node.method_name
+          when :<<
+            value = node.first_argument.source
+
+            ".add(#{key}, #{value})"
+          when :clear
+            ".delete(#{key})"
+          end
+        end
+
+        def receiver_matcher(node)
+          model_file? ? receiver_matcher_inside_model(node) : receiver_matcher_outside_model(node)
+        end
+
+        def model_file?
+          processed_source.file_path.include?('/models/')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Enforces the use of dot-separated locale keys instead of specifying the `:scope` option
+      # with an array or a single symbol in `I18n` translation methods.
+      # Dot-separated notation is easier to read and trace the hierarchy.
+      #
+      # @example
+      #   # bad
+      #   I18n.t :record_invalid, scope: [:activerecord, :errors, :messages]
+      #   I18n.t :title, scope: :invitation
+      #
+      #   # good
+      #   I18n.t 'activerecord.errors.messages.record_invalid'
+      #   I18n.t :record_invalid, scope: 'activerecord.errors.messages'
+      #
+      class DotSeparatedKeys < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Use the dot-separated keys instead of specifying the `:scope` option.'
+        TRANSLATE_METHODS = %i[translate t].freeze
+
+        def_node_matcher :translate_with_scope?, <<~PATTERN
+          (send {nil? (const {nil? cbase} :I18n)} {:translate :t} ${sym_type? str_type?}
+            (hash <$(pair (sym :scope) ${array_type? sym_type?}) ...>)
+          )
+        PATTERN
+
+        def on_send(node)
+          return unless TRANSLATE_METHODS.include?(node.method_name)
+
+          translate_with_scope?(node) do |key_node, scope_node|
+            return unless should_convert_scope?(scope_node)
+
+            add_offense(scope_node) do |corrector|
+              # Eat the comma on the left.
+              range = range_with_surrounding_space(scope_node.source_range, side: :left)
+              range = range_with_surrounding_comma(range, :left)
+              corrector.remove(range)
+
+              corrector.replace(key_node, new_key(key_node, scope_node))
+            end
+          end
+        end
+
+        private
+
+        def should_convert_scope?(scope_node)
+          scopes(scope_node).all?(&:basic_literal?)
+        end
+
+        def new_key(key_node, scope_node)
+          "'#{scopes(scope_node).map(&:value).join('.')}.#{key_node.value}'".squeeze('.')
+        end
+
+        def scopes(scope_node)
+          value = scope_node.value
+
+          if value.array_type?
+            value.values
+          else
+            [value]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Looks for associations that have been defined multiple times in the same file.
+      #
+      # When an association is defined multiple times on a model, Active Record overrides the
+      # previously defined association with the new one. Because of this, this cop's autocorrection
+      # simply keeps the last of any duplicates and discards the rest.
+      #
+      # @example
+      #
+      #   # bad
+      #   belongs_to :foo
+      #   belongs_to :bar
+      #   has_one :foo
+      #
+      #   # good
+      #   belongs_to :bar
+      #   has_one :foo
+      #
+      class DuplicateAssociation < Base
+        include RangeHelp
+        extend AutoCorrector
+        include ClassSendNodeHelper
+
+        MSG = "Association `%<name>s` is defined multiple times. Don't repeat associations."
+
+        def_node_matcher :association, <<~PATTERN
+          (send nil? {:belongs_to :has_one :has_many :has_and_belongs_to_many} ({sym str} $_) ...)
+        PATTERN
+
+        def on_class(class_node)
+          offenses(class_node).each do |name, nodes|
+            nodes.each do |node|
+              add_offense(node, message: format(MSG, name: name)) do |corrector|
+                next if same_line?(nodes.last, node)
+
+                corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
+              end
+            end
+          end
+        end
+
+        private
+
+        def offenses(class_node)
+          class_send_nodes(class_node).select { |node| association(node) }
+                                      .group_by { |node| association(node).to_sym }
+                                      .select { |_, nodes| nodes.length > 1 }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks for multiple scopes in a model that have the same `where` clause. This
+      # often means you copy/pasted a scope, updated the name, and forgot to change the condition.
+      #
+      # @example
+      #
+      #   # bad
+      #   scope :visible, -> { where(visible: true) }
+      #   scope :hidden, -> { where(visible: true) }
+      #
+      #   # good
+      #   scope :visible, -> { where(visible: true) }
+      #   scope :hidden, -> { where(visible: false) }
+      #
+      class DuplicateScope < Base
+        include ClassSendNodeHelper
+
+        MSG = 'Multiple scopes share this same where clause.'
+
+        def_node_matcher :scope, <<~PATTERN
+          (send nil? :scope _ $...)
+        PATTERN
+
+        def on_class(class_node)
+          offenses(class_node).each do |node|
+            add_offense(node)
+          end
+        end
+
+        private
+
+        def offenses(class_node)
+          class_send_nodes(class_node).select { |node| scope(node) }
+                                      .group_by { |node| scope(node) }
+                                      .select { |_, nodes| nodes.length > 1 }
+                                      .values
+                                      .flatten
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks if a duration is added to or subtracted from `Time.current`.
+      #
+      # @example
+      #   # bad
+      #   Time.current - 1.minute
+      #   Time.current + 2.days
+      #
+      #   # good - using relative would make it harder to express and read
+      #   Date.yesterday + 3.days
+      #   created_at - 1.minute
+      #   3.days - 1.hour
+      #
+      #   # good
+      #   1.minute.ago
+      #   2.days.from_now
+      class DurationArithmetic < Base
+        extend AutoCorrector
+
+        MSG = 'Do not add or subtract duration.'
+
+        RESTRICT_ON_SEND = %i[+ -].freeze
+
+        DURATIONS = Set[:second, :seconds, :minute, :minutes, :hour, :hours,
+                        :day, :days, :week, :weeks, :fortnight, :fortnights,
+                        :month, :months, :year, :years]
+
+        # @!method duration_arithmetic_argument?(node)
+        #   Match duration subtraction or addition with current time.
+        #
+        #   @example source that matches
+        #     Time.current - 1.hour
+        #
+        #   @example source that matches
+        #     ::Time.zone.now + 1.hour
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @yield operator and duration
+        def_node_matcher :duration_arithmetic_argument?, <<~PATTERN
+          (send #time_current? ${ :+ :- } $#duration?)
+        PATTERN
+
+        # @!method duration?(node)
+        #   Match a literal Duration
+        #
+        #   @example source that matches
+        #     1.hour
+        #
+        #   @example source that matches
+        #     9.5.weeks
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Boolean] true if matches
+        def_node_matcher :duration?, '(send { int float (send nil _) } DURATIONS)'
+
+        # @!method time_current?(node)
+        #   Match Time.current
+        #
+        #   @example source that matches
+        #     Time.current
+        #
+        #   @example source that matches
+        #     ::Time.zone.now
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Boolean] true if matches
+        def_node_matcher :time_current?, <<~PATTERN
+          {
+            (send (const {nil? cbase} :Time) :current)
+            (send (send (const {nil? cbase} :Time) :zone) :now)
+          }
+        PATTERN
+
+        def on_send(node)
+          duration_arithmetic_argument?(node) do |*operation|
+            add_offense(node) do |corrector|
+              corrector.replace(node, corrected_source(*operation))
+            end
+          end
+        end
+
+        private
+
+        def corrected_source(operator, duration)
+          if operator == :-
+            "#{duration.source}.ago"
+          else
+            "#{duration.source}.from_now"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,75 +3,106 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks dynamic `find_by_*` methods.
+      # Checks dynamic `find_by_*` methods.
       # Use `find_by` instead of dynamic method.
-      # See. https://github.com/rubocop-hq/rails-style-guide#find_by
+      # See. https://rails.rubystyle.guide#find_by
+      #
+      # @safety
+      #   It is certainly unsafe when not configured properly, i.e. user-defined `find_by_xxx`
+      #   method is not added to cop's `AllowedMethods`.
       #
       # @example
       #   # bad
       #   User.find_by_name(name)
-      #
-      #   # bad
       #   User.find_by_name_and_email(name)
-      #
-      #   # bad
       #   User.find_by_email!(name)
       #
       #   # good
       #   User.find_by(name: name)
+      #   User.find_by(name: name, email: email)
+      #   User.find_by!(email: email)
+      #
+      # @example AllowedMethods: ['find_by_sql', 'find_by_token_for'] (default)
+      #   # bad
+      #   User.find_by_query(users_query)
+      #   User.find_by_token_for(:password_reset, token)
       #
       #   # good
-      #   User.find_by(name: name, email: email)
+      #   User.find_by_sql(users_sql)
+      #   User.find_by_token_for(:password_reset, token)
+      #
+      # @example AllowedReceivers: ['Gem::Specification', 'page'] (default)
+      #   # bad
+      #   Specification.find_by_name('backend').gem_dir
+      #   page.find_by_id('a_dom_id').click
       #
       #   # good
-      #   User.find_by!(email: email)
-      class DynamicFindBy < Cop
+      #   Gem::Specification.find_by_name('backend').gem_dir
+      #   page.find_by_id('a_dom_id').click
+      class DynamicFindBy < Base
+        include ActiveRecordHelper
+        extend AutoCorrector
+
         MSG = 'Use `%<static_name>s` instead of dynamic `%<method>s`.'
         METHOD_PATTERN = /^find_by_(.+?)(!)?$/.freeze
+        IGNORED_ARGUMENT_TYPES = %i[hash splat].freeze
 
         def on_send(node)
-          method_name = node.method_name.to_s
-
-          return if whitelist.include?(method_name)
+          return if (node.receiver.nil? && !inherit_active_record_base?(node)) || allowed_invocation?(node)
 
+          method_name = node.method_name
           static_name = static_method_name(method_name)
-
           return unless static_name
+          return unless dynamic_find_by_arguments?(node)
 
-          add_offense(node,
-                      message: format(MSG, static_name: static_name,
-                                           method: node.method_name))
+          message = format(MSG, static_name: static_name, method: method_name)
+          add_offense(node, message: message) do |corrector|
+            autocorrect(corrector, node)
+          end
         end
         alias on_csend on_send
 
-        def autocorrect(node)
-          keywords = column_keywords(node.method_name)
+        private
+
+        def autocorrect(corrector, node)
+          autocorrect_method_name(corrector, node)
+          autocorrect_argument_keywords(corrector, node, column_keywords(node.method_name))
+        end
 
-          return if keywords.size != node.arguments.size
+        def allowed_invocation?(node)
+          allowed_method?(node) || allowed_receiver?(node) || whitelisted?(node)
+        end
 
-          lambda do |corrector|
-            autocorrect_method_name(corrector, node)
-            autocorrect_argument_keywords(corrector, node, keywords)
-          end
+        def allowed_method?(node)
+          return unless cop_config['AllowedMethods']
+
+          cop_config['AllowedMethods'].include?(node.method_name.to_s)
         end
 
-        private
+        def allowed_receiver?(node)
+          return unless cop_config['AllowedReceivers'] && node.receiver
+
+          cop_config['AllowedReceivers'].include?(node.receiver.source)
+        end
+
+        # config option `WhiteList` will be deprecated soon
+        def whitelisted?(node)
+          whitelist_config = cop_config['Whitelist']
+          return unless whitelist_config
+
+          whitelist_config.include?(node.method_name.to_s)
+        end
 
         def autocorrect_method_name(corrector, node)
-          corrector.replace(node.loc.selector,
-                            static_method_name(node.method_name.to_s))
+          corrector.replace(node.loc.selector, static_method_name(node.method_name.to_s))
         end
 
         def autocorrect_argument_keywords(corrector, node, keywords)
           keywords.each.with_index do |keyword, idx|
-            corrector.insert_before(node.arguments[idx].loc.expression, keyword)
+            corrector.insert_before(node.arguments[idx], keyword)
           end
         end
 
-        def whitelist
-          cop_config['Whitelist']
-        end
-
         def column_keywords(method)
           keyword_string = method.to_s[METHOD_PATTERN, 1]
           keyword_string.split('_and_').map { |keyword| "#{keyword}: " }
@@ -85,6 +116,20 @@ module RuboCop
 
           match[2] ? 'find_by!' : 'find_by'
         end
+
+        def dynamic_find_by_arguments?(node)
+          dynamic_find_by_arguments_count?(node) && dynamic_find_by_arguments_type?(node)
+        end
+
+        def dynamic_find_by_arguments_count?(node)
+          column_keywords(node.method_name).size == node.arguments.size
+        end
+
+        def dynamic_find_by_arguments_type?(node)
+          node.arguments.none? do |argument|
+            IGNORED_ARGUMENT_TYPES.include?(argument.type)
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks that blocks are used for interpolated strings passed to
+      # `Rails.logger.debug`.
+      #
+      # By default, Rails production environments use the `:info` log level.
+      # At the `:info` log level, `Rails.logger.debug` statements do not result
+      # in log output. However, Ruby must eagerly evaluate interpolated string
+      # arguments passed as method arguments. Passing a block to
+      # `Rails.logger.debug` prevents costly evaluation of interpolated strings
+      # when no output would be produced anyway.
+      #
+      # @example
+      #   #bad
+      #   Rails.logger.debug "The time is #{Time.zone.now}."
+      #
+      #   #good
+      #   Rails.logger.debug { "The time is #{Time.zone.now}." }
+      #
+      class EagerEvaluationLogMessage < Base
+        extend AutoCorrector
+
+        MSG = 'Pass a block to `Rails.logger.debug`.'
+        RESTRICT_ON_SEND = %i[debug].freeze
+
+        def_node_matcher :interpolated_string_passed_to_debug, <<~PATTERN
+          (send
+            (send
+              (const {cbase nil?} :Rails)
+              :logger
+            )
+            :debug
+            $(dstr ...)
+          )
+        PATTERN
+
+        def self.autocorrect_incompatible_with
+          [Style::MethodCallWithArgsParentheses]
+        end
+
+        def on_send(node)
+          return if node.parent&.block_type?
+
+          interpolated_string_passed_to_debug(node) do |arguments|
+            message = format(MSG)
+
+            range = replacement_range(node)
+            replacement = replacement_source(node, arguments)
+
+            add_offense(range, message: message) do |corrector|
+              corrector.replace(range, replacement)
+            end
+          end
+        end
+
+        private
+
+        def replacement_range(node)
+          stop = node.source_range.end
+          start = node.loc.selector.end
+
+          if node.parenthesized_call?
+            stop.with(begin_pos: start.begin_pos)
+          else
+            stop.with(begin_pos: start.begin_pos + 1)
+          end
+        end
+
+        def replacement_source(node, arguments)
+          if node.parenthesized_call?
+            " { #{arguments.source} }"
+          else
+            "{ #{arguments.source} }"
+          end
+        end
+      end
+    end
+  end
+end