rubocop-rails 2.11.2 → 2.19.1

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,10 +3,14 @@
 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://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)
@@ -18,19 +22,23 @@ module RuboCop
       #   User.find_by(name: name, email: email)
       #   User.find_by!(email: email)
       #
-      # @example AllowedMethods: find_by_sql
+      # @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_sql(users_sql)
+      #   User.find_by_token_for(:password_reset, token)
       #
-      # @example AllowedReceivers: Gem::Specification
+      # @example AllowedReceivers: ['Gem::Specification', 'page'] (default)
       #   # bad
       #   Specification.find_by_name('backend').gem_dir
+      #   page.find_by_id('a_dom_id').click
       #
       #   # good
       #   Gem::Specification.find_by_name('backend').gem_dir
+      #   page.find_by_id('a_dom_id').click
       class DynamicFindBy < Base
         include ActiveRecordHelper
         extend AutoCorrector
@@ -40,12 +48,12 @@ module RuboCop
         IGNORED_ARGUMENT_TYPES = %i[hash splat].freeze
 
         def on_send(node)
-          return if node.receiver.nil? && !inherit_active_record_base?(node) || allowed_invocation?(node)
+          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 if node.arguments.any? { |argument| IGNORED_ARGUMENT_TYPES.include?(argument.type) }
+          return unless dynamic_find_by_arguments?(node)
 
           message = format(MSG, static_name: static_name, method: method_name)
           add_offense(node, message: message) do |corrector|
@@ -57,17 +65,12 @@ module RuboCop
         private
 
         def autocorrect(corrector, node)
-          keywords = column_keywords(node.method_name)
-
-          return if keywords.size != node.arguments.size
-
           autocorrect_method_name(corrector, node)
-          autocorrect_argument_keywords(corrector, node, keywords)
+          autocorrect_argument_keywords(corrector, node, column_keywords(node.method_name))
         end
 
         def allowed_invocation?(node)
-          allowed_method?(node) || allowed_receiver?(node) ||
-            whitelisted?(node)
+          allowed_method?(node) || allowed_receiver?(node) || whitelisted?(node)
         end
 
         def allowed_method?(node)
@@ -91,13 +94,12 @@ module RuboCop
         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
 
@@ -114,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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that blocks are used for interpolated strings passed to
+      # Checks that blocks are used for interpolated strings passed to
       # `Rails.logger.debug`.
       #
       # By default, Rails production environments use the `:info` log level.
@@ -37,6 +37,10 @@ module RuboCop
           )
         PATTERN
 
+        def self.autocorrect_incompatible_with
+          [Style::MethodCallWithArgsParentheses]
+        end
+
         def on_send(node)
           return if node.parent&.block_type?
 
@@ -55,7 +59,7 @@ module RuboCop
         private
 
         def replacement_range(node)
-          stop = node.loc.expression.end
+          stop = node.source_range.end
           start = node.loc.selector.end
 
           if node.parenthesized_call?

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for enums written with array syntax.
+      # Looks for enums written with array syntax.
       #
       # When using array syntax, adding an element in a
       # position other than the last causes all previous
@@ -20,8 +20,7 @@ module RuboCop
       class EnumHash < Base
         extend AutoCorrector
 
-        MSG = 'Enum defined as an array found in `%<enum>s` enum declaration. '\
-              'Use hash syntax instead.'
+        MSG = 'Enum defined as an array found in `%<enum>s` enum declaration. Use hash syntax instead.'
         RESTRICT_ON_SEND = %i[enum].freeze
 
         def_node_matcher :enum?, <<~PATTERN
@@ -43,7 +42,7 @@ module RuboCop
                   "#{source(elem)} => #{index}"
                 end.join(', ')
 
-                corrector.replace(array.loc.expression, "{#{hash}}")
+                corrector.replace(array, "{#{hash}}")
               end
             end
           end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for duplicate values in enum declarations.
+      # Looks for duplicate values in enum declarations.
       #
       # @example
       #   # bad
@@ -20,8 +20,7 @@ module RuboCop
       class EnumUniqueness < Base
         include Duplication
 
-        MSG = 'Duplicate value `%<value>s` found in `%<enum>s` ' \
-              'enum declaration.'
+        MSG = 'Duplicate value `%<value>s` found in `%<enum>s` enum declaration.'
         RESTRICT_ON_SEND = %i[enum].freeze
 
         def_node_matcher :enum?, <<~PATTERN
@@ -41,9 +40,7 @@ module RuboCop
                 next unless duplicates?(items)
 
                 consecutive_duplicates(items).each do |item|
-                  add_offense(item, message: format(
-                    MSG, value: item.source, enum: enum_name(key)
-                  ))
+                  add_offense(item, message: format(MSG, value: item.source, enum: enum_name(key)))
                 end
               end
             end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that Rails.env is compared using `.production?`-like
+      # Checks that Rails.env is compared using `.production?`-like
       # methods instead of equality against a string or symbol.
       #
       # @example
@@ -84,7 +84,7 @@ module RuboCop
         def autocorrect(corrector, node)
           replacement = build_predicate_method(node)
 
-          corrector.replace(node.source_range, replacement)
+          corrector.replace(node, replacement)
         end
 
         def build_predicate_method(node)
@@ -96,8 +96,7 @@ module RuboCop
         end
 
         def rails_env_on_lhs?(node)
-          comparing_str_env_with_rails_env_on_lhs?(node) ||
-            comparing_sym_env_with_rails_env_on_lhs?(node)
+          comparing_str_env_with_rails_env_on_lhs?(node) || comparing_sym_env_with_rails_env_on_lhs?(node)
         end
 
         def build_predicate_method_for_rails_env_on_lhs(node)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for direct access to environment variables through the
+      # Looks for direct access to environment variables through the
       # `ENV` variable within the application code. This can lead to runtime
       # errors due to misconfiguration that could have been discovered at boot
       # time if the environment variables were loaded as part of initialization

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces that `exit` calls are not used within a rails app.
+      # Enforces that `exit` calls are not used within a rails app.
       # Valid options are instead to raise an error, break, return, or some
       # other form of stopping execution of current request.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for expanded date range. It only compatible `..` range is targeted.
+      # Checks for expanded date range. It only compatible `..` range is targeted.
       # Incompatible `...` range is ignored.
       #
       # @example
@@ -29,14 +29,6 @@ module RuboCop
 
         minimum_target_rails_version 5.1
 
-        def_node_matcher :expanded_date_range, <<~PATTERN
-          (irange
-            (send
-              $_ {:beginning_of_day :beginning_of_week :beginning_of_month :beginning_of_quarter :beginning_of_year})
-            (send
-              $_ {:end_of_day :end_of_week :end_of_month :end_of_quarter :end_of_year}))
-        PATTERN
-
         PREFERRED_METHODS = {
           beginning_of_day: 'all_day',
           beginning_of_week: 'all_week',
@@ -54,31 +46,55 @@ module RuboCop
         }.freeze
 
         def on_irange(node)
-          return unless expanded_date_range(node)
-
           begin_node = node.begin
           end_node = node.end
-          return unless same_receiver?(begin_node, end_node)
-
-          beginning_method = begin_node.method_name
-          end_method = end_node.method_name
-          return unless use_mapped_methods?(beginning_method, end_method)
+          return if allow?(begin_node, end_node)
 
-          preferred_method = "#{begin_node.receiver.source}.#{PREFERRED_METHODS[beginning_method]}"
+          preferred_method = preferred_method(begin_node)
+          if begin_node.method?(:beginning_of_week) && begin_node.arguments.one?
+            return unless same_argument?(begin_node, end_node)
 
-          add_offense(node, message: format(MSG, preferred_method: preferred_method)) do |corrector|
-            corrector.replace(node, preferred_method)
+            preferred_method << "(#{begin_node.first_argument.source})"
+          elsif any_arguments?(begin_node, end_node)
+            return
           end
+
+          register_offense(node, preferred_method)
         end
 
         private
 
-        def same_receiver?(begin_node, end_node)
-          begin_node.receiver.source == end_node.receiver.source
+        def allow?(begin_node, end_node)
+          return true unless (begin_source = receiver_source(begin_node))
+          return true unless (end_source = receiver_source(end_node))
+
+          begin_source != end_source || MAPPED_DATE_RANGE_METHODS[begin_node.method_name] != end_node.method_name
+        end
+
+        def receiver_source(node)
+          return if !node&.send_type? || node.receiver.nil?
+
+          node.receiver.source
         end
 
-        def use_mapped_methods?(beginning_method, end_method)
-          MAPPED_DATE_RANGE_METHODS[beginning_method] == end_method
+        def same_argument?(begin_node, end_node)
+          begin_node.first_argument.source == end_node.first_argument.source
+        end
+
+        def preferred_method(begin_node)
+          +"#{begin_node.receiver.source}.#{PREFERRED_METHODS[begin_node.method_name]}"
+        end
+
+        def any_arguments?(begin_node, end_node)
+          begin_node.arguments.any? || end_node.arguments.any?
+        end
+
+        def register_offense(node, preferred_method)
+          message = format(MSG, preferred_method: preferred_method)
+
+          add_offense(node, message: message) do |corrector|
+            corrector.replace(node, preferred_method)
+          end
         end
       end
     end

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

@@ -3,55 +3,66 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop is used to identify usages of file path joining process
-      # to use `Rails.root.join` clause. It is used to add uniformity when
-      # joining paths.
+      # Identifies usages of file path joining process to use `Rails.root.join` clause.
+      # It is used to add uniformity when joining paths.
       #
-      # @example EnforcedStyle: arguments
+      # @example EnforcedStyle: slashes (default)
       #   # bad
+      #   Rails.root.join('app', 'models', 'goober')
+      #
+      #   # good
       #   Rails.root.join('app/models/goober')
+      #
+      #   # bad
       #   File.join(Rails.root, 'app/models/goober')
       #   "#{Rails.root}/app/models/goober"
       #
       #   # good
-      #   Rails.root.join('app', 'models', 'goober')
+      #   Rails.root.join('app/models/goober').to_s
       #
-      # @example EnforcedStyle: slashes (default)
+      # @example EnforcedStyle: arguments
       #   # bad
+      #   Rails.root.join('app/models/goober')
+      #
+      #   # good
       #   Rails.root.join('app', 'models', 'goober')
+      #
+      #   # bad
       #   File.join(Rails.root, 'app/models/goober')
       #   "#{Rails.root}/app/models/goober"
       #
       #   # good
-      #   Rails.root.join('app/models/goober')
+      #   Rails.root.join('app', 'models', 'goober').to_s
       #
       class FilePath < Base
         include ConfigurableEnforcedStyle
         include RangeHelp
 
-        MSG_SLASHES = 'Prefer `Rails.root.join(\'path/to\')`.'
-        MSG_ARGUMENTS = 'Prefer `Rails.root.join(\'path\', \'to\')`.'
+        MSG_SLASHES = 'Prefer `Rails.root.join(\'path/to\')%<to_s>s`.'
+        MSG_ARGUMENTS = 'Prefer `Rails.root.join(\'path\', \'to\')%<to_s>s`.'
         RESTRICT_ON_SEND = %i[join].freeze
 
         def_node_matcher :file_join_nodes?, <<~PATTERN
-          (send (const nil? :File) :join ...)
+          (send (const {nil? cbase} :File) :join ...)
         PATTERN
 
         def_node_search :rails_root_nodes?, <<~PATTERN
-          (send (const nil? :Rails) :root)
+          (send (const {nil? cbase} :Rails) :root)
         PATTERN
 
         def_node_matcher :rails_root_join_nodes?, <<~PATTERN
-          (send (send (const nil? :Rails) :root) :join ...)
+          (send #rails_root_nodes? :join ...)
         PATTERN
 
         def on_dstr(node)
           return unless rails_root_nodes?(node)
           return unless node.children.last.str_type?
-          return unless node.children.last.source.start_with?('.') ||
-                        node.children.last.source.include?(File::SEPARATOR)
 
-          register_offense(node)
+          last_child_source = node.children.last.source
+          return unless last_child_source.start_with?('.') || last_child_source.include?(File::SEPARATOR)
+          return if last_child_source.start_with?(':')
+
+          register_offense(node, require_to_s: true)
         end
 
         def on_send(node)
@@ -66,7 +77,7 @@ module RuboCop
           return unless file_join_nodes?(node)
           return unless node.arguments.any? { |e| rails_root_nodes?(e) }
 
-          register_offense(node)
+          register_offense(node, require_to_s: true)
         end
 
         def check_for_rails_root_join_with_string_arguments(node)
@@ -76,7 +87,7 @@ module RuboCop
           return unless node.arguments.size > 1
           return unless node.arguments.all?(&:str_type?)
 
-          register_offense(node)
+          register_offense(node, require_to_s: false)
         end
 
         def check_for_rails_root_join_with_slash_separated_path(node)
@@ -85,22 +96,28 @@ module RuboCop
           return unless rails_root_join_nodes?(node)
           return unless node.arguments.any? { |arg| string_with_slash?(arg) }
 
-          register_offense(node)
+          register_offense(node, require_to_s: false)
         end
 
         def string_with_slash?(node)
           node.str_type? && node.source.include?('/')
         end
 
-        def register_offense(node)
+        def register_offense(node, require_to_s:)
           line_range = node.loc.column...node.loc.last_column
-          source_range = source_range(processed_source.buffer, node.first_line,
-                                      line_range)
-          add_offense(source_range)
+          source_range = source_range(processed_source.buffer, node.first_line, line_range)
+          require_to_s = false if node.dstr_type?
+
+          message = build_message(require_to_s)
+
+          add_offense(source_range, message: message)
         end
 
-        def message(_range)
-          format(style == :arguments ? MSG_ARGUMENTS : MSG_SLASHES)
+        def build_message(require_to_s)
+          message_template = style == :arguments ? MSG_ARGUMENTS : MSG_SLASHES
+          to_s = require_to_s ? '.to_s' : ''
+
+          format(message_template, to_s: to_s)
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop is used to identify usages of `where.take` and change them to use `find_by` instead.
+      # Identifies usages of `where.take` and change them to use `find_by` instead.
       #
       # And `where(...).first` can return different results from `find_by`.
       # (They order records differently, so the "first" record can be different.)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces that `ActiveRecord#find` is used instead of
+      # Enforces that `ActiveRecord#find` is used instead of
       # `where.take!`, `find_by!`, and `find_by_id!` to retrieve a single record
       # by primary key when you expect it to be found.
       #
@@ -65,11 +65,11 @@ module RuboCop
         end
 
         def where_take_offense_range(node, where)
-          range_between(where.loc.selector.begin_pos, node.loc.expression.end_pos)
+          range_between(where.loc.selector.begin_pos, node.source_range.end_pos)
         end
 
         def find_by_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
 
         def build_good_method(id_value)