rubocop-rails 2.19.1 → 2.30.3

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

@@ -15,6 +15,9 @@ module RuboCop
       # without using the `delegate` method will be a violation.
       # When set to `false`, this case is legal.
       #
+      # It is disabled for controllers in order to keep controller actions
+      # explicitly defined.
+      #
       # @example
       #   # bad
       #   def bar
@@ -68,12 +71,13 @@ module RuboCop
 
         def_node_matcher :delegate?, <<~PATTERN
           (def _method_name _args
-            (send {(send nil? _) (self)} _ ...))
+            (send {(send nil? _) (self) (send (self) :class) ({cvar gvar ivar} _) (const _ _)} _ ...))
         PATTERN
 
         def on_def(node)
           return unless trivial_delegate?(node)
           return if private_or_protected_delegation(node)
+          return if module_function_declared?(node)
 
           register_offense(node)
         end
@@ -82,15 +86,40 @@ module RuboCop
 
         def register_offense(node)
           add_offense(node.loc.keyword) do |corrector|
-            body = node.body
+            receiver = determine_register_offense_receiver(node.body.receiver)
+            delegation = build_delegation(node, receiver)
 
-            receiver = body.receiver.self_type? ? 'self' : ":#{body.receiver.method_name}"
+            corrector.replace(node, delegation)
+          end
+        end
 
-            delegation = ["delegate :#{body.method_name}", "to: #{receiver}"]
-            delegation << ['prefix: true'] if node.method?(prefixed_method_name(node.body))
+        def determine_register_offense_receiver(receiver)
+          case receiver.type
+          when :self
+            'self'
+          when :const
+            full_name = full_const_name(receiver)
+            full_name.include?('::') ? ":'#{full_name}'" : ":#{full_name}"
+          when :cvar, :gvar, :ivar
+            ":#{receiver.source}"
+          else
+            ":#{receiver.method_name}"
+          end
+        end
+
+        def build_delegation(node, receiver)
+          delegation = ["delegate :#{node.body.method_name}", "to: #{receiver}"]
+          delegation << ['prefix: true'] if node.method?(prefixed_method_name(node.body))
+          delegation.join(', ')
+        end
 
-            corrector.replace(node, delegation.join(', '))
+        def full_const_name(node)
+          return unless node.const_type?
+          unless node.namespace
+            return node.absolute? ? "::#{node.source}" : node.source
           end
+
+          "#{full_const_name(node.namespace)}::#{node.short_name}"
         end
 
         def trivial_delegate?(def_node)
@@ -120,13 +149,30 @@ module RuboCop
         def prefixed_method_name(body)
           return '' if body.receiver.self_type?
 
-          [body.receiver.method_name, body.method_name].join('_').to_sym
+          [determine_prefixed_method_receiver_name(body.receiver), body.method_name].join('_').to_sym
+        end
+
+        def determine_prefixed_method_receiver_name(receiver)
+          case receiver.type
+          when :cvar, :gvar, :ivar
+            receiver.source
+          when :const
+            full_const_name(receiver)
+          else
+            receiver.method_name.to_s
+          end
         end
 
         def private_or_protected_delegation(node)
           private_or_protected_inline(node) || node_visibility(node) != :public
         end
 
+        def module_function_declared?(node)
+          node.each_ancestor(:module, :begin).any? do |ancestor|
+            ancestor.children.any? { |child| child.send_type? && child.method?(:module_function) }
+          end
+        end
+
         def private_or_protected_inline(node)
           processed_source[node.first_line - 1].strip.match?(/\A(private )|(protected )/)
         end

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

@@ -20,35 +20,96 @@ module RuboCop
       #   belongs_to :bar
       #   has_one :foo
       #
+      #   # bad
+      #   has_many :foo, class_name: 'Foo'
+      #   has_many :bar, class_name: 'Foo'
+      #   has_one :baz
+      #
+      #   # good
+      #   has_many :bar, class_name: 'Foo'
+      #   has_one :foo
+      #
       class DuplicateAssociation < Base
         include RangeHelp
         extend AutoCorrector
         include ClassSendNodeHelper
+        include ActiveRecordHelper
 
         MSG = "Association `%<name>s` is defined multiple times. Don't repeat associations."
+        MSG_CLASS_NAME = "Association `class_name: %<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} $_) ...)
+          (send nil? {:belongs_to :has_one :has_many :has_and_belongs_to_many} ({sym str} $_) $...)
+        PATTERN
+
+        def_node_matcher :class_name, <<~PATTERN
+          (hash (pair (sym :class_name) $_))
         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)
+          return unless active_record?(class_node.parent_class)
+
+          association_nodes = association_nodes(class_node)
+
+          duplicated_association_name_nodes(association_nodes).each do |name, nodes|
+            register_offense(name, nodes, MSG)
+          end
+
+          duplicated_class_name_nodes(association_nodes).each do |class_name, nodes|
+            register_offense(class_name, nodes, MSG_CLASS_NAME)
+          end
+        end
+
+        private
+
+        def register_offense(name, nodes, message_template)
+          last_node = nodes.last
 
+          nodes.each_with_index do |node, index|
+            add_offense(node, message: format(message_template, name: name)) do |corrector|
+              if index.zero?
+                corrector.replace(node, last_node.source)
+              else
                 corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
               end
             end
           end
         end
 
-        private
+        def association_nodes(class_node)
+          class_send_nodes(class_node).select do |node|
+            association(node)&.first
+          end
+        end
+
+        def duplicated_association_name_nodes(association_nodes)
+          grouped_associations = association_nodes.group_by do |node|
+            association(node).first.to_sym
+          end
+
+          leave_duplicated_association(grouped_associations)
+        end
+
+        def duplicated_class_name_nodes(association_nodes)
+          filtered_nodes = association_nodes.reject { |node| node.method?(:belongs_to) }
+          grouped_associations = filtered_nodes.group_by do |node|
+            arguments = association(node).last
+            next unless arguments.count == 1
 
-        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 }
+            if (class_name = class_name(arguments.first))
+              class_name.source
+            end
+          end
+
+          grouped_associations.delete(nil)
+
+          leave_duplicated_association(grouped_associations)
+        end
+
+        def leave_duplicated_association(grouped_associations)
+          grouped_associations.select do |_, nodes|
+            nodes.length > 1
+          end
         end
       end
     end

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

@@ -74,13 +74,13 @@ module RuboCop
         end
 
         def allowed_method?(node)
-          return unless cop_config['AllowedMethods']
+          return false unless cop_config['AllowedMethods']
 
           cop_config['AllowedMethods'].include?(node.method_name.to_s)
         end
 
         def allowed_receiver?(node)
-          return unless cop_config['AllowedReceivers'] && node.receiver
+          return false unless cop_config['AllowedReceivers'] && node.receiver
 
           cop_config['AllowedReceivers'].include?(node.receiver.source)
         end
@@ -88,7 +88,7 @@ module RuboCop
         # config option `WhiteList` will be deprecated soon
         def whitelisted?(node)
           whitelist_config = cop_config['Whitelist']
-          return unless whitelist_config
+          return false unless whitelist_config
 
           whitelist_config.include?(node.method_name.to_s)
         end

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

@@ -14,10 +14,10 @@ module RuboCop
       # when no output would be produced anyway.
       #
       # @example
-      #   #bad
+      #   # bad
       #   Rails.logger.debug "The time is #{Time.zone.now}."
       #
-      #   #good
+      #   # good
       #   Rails.logger.debug { "The time is #{Time.zone.now}." }
       #
       class EagerEvaluationLogMessage < Base

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

@@ -12,6 +12,12 @@ module RuboCop
       #
       # @example
       #   # bad
+      #   enum :status, [:active, :archived]
+      #
+      #   # good
+      #   enum :status, { active: 0, archived: 1 }
+      #
+      #   # bad
       #   enum status: [:active, :archived]
       #
       #   # good
@@ -23,7 +29,11 @@ module RuboCop
         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
+        def_node_matcher :enum_with_array?, <<~PATTERN
+          (send nil? :enum $_ ${array} ...)
+        PATTERN
+
+        def_node_matcher :enum_with_old_syntax?, <<~PATTERN
           (send nil? :enum (hash $...))
         PATTERN
 
@@ -32,17 +42,19 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          enum?(node) do |pairs|
+          target_rails_version >= 7.0 && enum_with_array?(node) do |key, array|
+            add_offense(array, message: message(key)) do |corrector|
+              corrector.replace(array, build_hash(array))
+            end
+          end
+
+          enum_with_old_syntax?(node) do |pairs|
             pairs.each do |pair|
               key, array = array_pair?(pair)
               next unless key
 
-              add_offense(array, message: format(MSG, enum: enum_name(key))) do |corrector|
-                hash = array.children.each_with_index.map do |elem, index|
-                  "#{source(elem)} => #{index}"
-                end.join(', ')
-
-                corrector.replace(array, "{#{hash}}")
+              add_offense(array, message: message(key)) do |corrector|
+                corrector.replace(array, build_hash(array))
               end
             end
           end
@@ -50,6 +62,10 @@ module RuboCop
 
         private
 
+        def message(key)
+          format(MSG, enum: enum_name(key))
+        end
+
         def enum_name(key)
           case key.type
           when :sym, :str
@@ -69,6 +85,13 @@ module RuboCop
             elem.source
           end
         end
+
+        def build_hash(array)
+          hash = array.children.each_with_index.map do |elem, index|
+            "#{source(elem)} => #{index}"
+          end.join(', ')
+          "{#{hash}}"
+        end
       end
     end
   end

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

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Looks for enums written with keyword arguments syntax.
+      #
+      # Defining enums with keyword arguments syntax is deprecated and will be removed in Rails 8.0.
+      # Positional arguments should be used instead:
+      #
+      # @example
+      #   # bad
+      #   enum status: { active: 0, archived: 1 }, _prefix: true
+      #
+      #   # good
+      #   enum :status, { active: 0, archived: 1 }, prefix: true
+      #
+      class EnumSyntax < Base
+        extend AutoCorrector
+        extend TargetRubyVersion
+        extend TargetRailsVersion
+
+        minimum_target_ruby_version 3.0
+        minimum_target_rails_version 7.0
+
+        MSG = 'Enum defined with keyword arguments in `%<enum>s` enum declaration. Use positional arguments instead.'
+        MSG_OPTIONS = 'Enum defined with deprecated options in `%<enum>s` enum declaration. Remove the `_` prefix.'
+        RESTRICT_ON_SEND = %i[enum].freeze
+
+        # From https://github.com/rails/rails/blob/v7.2.1/activerecord/lib/active_record/enum.rb#L231
+        OPTION_NAMES = %w[prefix suffix scopes default instance_methods].freeze
+        UNDERSCORED_OPTION_NAMES = OPTION_NAMES.map { |option| "_#{option}" }.freeze
+
+        def_node_matcher :enum?, <<~PATTERN
+          (send nil? :enum (hash $...))
+        PATTERN
+
+        def_node_matcher :enum_with_options?, <<~PATTERN
+          (send nil? :enum $_ ${array hash} $_)
+        PATTERN
+
+        def on_send(node)
+          check_and_correct_keyword_args(node)
+          check_enum_options(node)
+        end
+
+        private
+
+        def check_and_correct_keyword_args(node)
+          enum?(node) do |pairs|
+            pairs.each do |pair|
+              next if option_key?(pair)
+
+              correct_keyword_args(node, pair.key, pair.value, pairs[1..])
+            end
+          end
+        end
+
+        def check_enum_options(node)
+          enum_with_options?(node) do |key, _, options|
+            options.children.each do |option|
+              next unless option_key?(option)
+
+              add_offense(option.key, message: format(MSG_OPTIONS, enum: enum_name_value(key))) do |corrector|
+                corrector.replace(option.key, option.key.source.delete_prefix('_'))
+              end
+            end
+          end
+        end
+
+        def correct_keyword_args(node, key, values, options)
+          add_offense(values, message: format(MSG, enum: enum_name_value(key))) do |corrector|
+            # TODO: Multi-line autocorrect could be implemented in the future.
+            next if multiple_enum_definitions?(node)
+
+            preferred_syntax = "enum #{enum_name(key)}, #{values.source}#{correct_options(options)}"
+
+            corrector.replace(node, preferred_syntax)
+          end
+        end
+
+        def multiple_enum_definitions?(node)
+          keys = node.first_argument.keys.map { |key| key.source.delete_prefix('_') }
+          filterred_keys = keys.filter { |key| !OPTION_NAMES.include?(key) }
+          filterred_keys.size >= 2
+        end
+
+        def enum_name_value(key)
+          case key.type
+          when :sym, :str
+            key.value
+          else
+            key.source
+          end
+        end
+
+        def enum_name(elem)
+          case elem.type
+          when :str
+            elem.value.dump
+          when :sym
+            elem.value.inspect
+          else
+            elem.source
+          end
+        end
+
+        def option_key?(pair)
+          return false unless pair.respond_to?(:key)
+
+          UNDERSCORED_OPTION_NAMES.include?(pair.key.source)
+        end
+
+        def correct_options(options)
+          corrected_options = options.map do |pair|
+            name = if pair.key.source[0] == '_'
+                     pair.key.source[1..]
+                   else
+                     pair.key.source
+                   end
+
+            "#{name}: #{pair.value.source}"
+          end.join(', ')
+
+          ", #{corrected_options}" unless corrected_options.empty?
+        end
+      end
+    end
+  end
+end

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

@@ -7,6 +7,18 @@ module RuboCop
       #
       # @example
       #   # bad
+      #   enum :status, { active: 0, archived: 0 }
+      #
+      #   # good
+      #   enum :status, { active: 0, archived: 1 }
+      #
+      #   # bad
+      #   enum :status, [:active, :archived, :active]
+      #
+      #   # good
+      #   enum :status, [:active, :archived]
+      #
+      #   # bad
       #   enum status: { active: 0, archived: 0 }
       #
       #   # good
@@ -24,6 +36,10 @@ module RuboCop
         RESTRICT_ON_SEND = %i[enum].freeze
 
         def_node_matcher :enum?, <<~PATTERN
+          (send nil? :enum $_ ${array hash} ...)
+        PATTERN
+
+        def_node_matcher :enum_with_old_syntax?, <<~PATTERN
           (send nil? :enum (hash $...))
         PATTERN
 
@@ -32,15 +48,17 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          enum?(node) do |pairs|
+          enum?(node) do |key, args|
+            consecutive_duplicates(args.values).each do |item|
+              add_offense(item, message: message(key, item))
+            end
+          end
+
+          enum_with_old_syntax?(node) do |pairs|
             pairs.each do |pair|
               enum_values(pair) do |key, args|
-                items = args.values
-
-                next unless duplicates?(items)
-
-                consecutive_duplicates(items).each do |item|
-                  add_offense(item, message: format(MSG, value: item.source, enum: enum_name(key)))
+                consecutive_duplicates(args.values).each do |item|
+                  add_offense(item, message: message(key, item))
                 end
               end
             end
@@ -57,6 +75,10 @@ module RuboCop
             key.source
           end
         end
+
+        def message(key, item)
+          format(MSG, value: item.source, enum: enum_name(key))
+        end
       end
     end
   end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks for usage of `Rails.env.development? || Rails.env.test?` which
+      # can be replaced with `Rails.env.local?`, introduced in Rails 7.1.
+      #
+      # @example
+      #
+      #   # bad
+      #   Rails.env.development? || Rails.env.test?
+      #
+      #   # good
+      #   Rails.env.local?
+      #
+      class EnvLocal < Base
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        MSG = 'Use `Rails.env.local?` instead.'
+        MSG_NEGATED = 'Use `!Rails.env.local?` instead.'
+        LOCAL_ENVIRONMENTS = %i[development? test?].to_set.freeze
+
+        minimum_target_rails_version 7.1
+
+        # @!method rails_env_local_or?(node)
+        def_node_matcher :rails_env_local_or?, <<~PATTERN
+          (or
+            (send (send (const {cbase nil? } :Rails) :env) $%LOCAL_ENVIRONMENTS)
+            (send (send (const {cbase nil? } :Rails) :env) $%LOCAL_ENVIRONMENTS)
+          )
+        PATTERN
+
+        # @!method rails_env_local_and?(node)
+        def_node_matcher :rails_env_local_and?, <<~PATTERN
+          (and
+            (send
+              (send (send (const {cbase nil? } :Rails) :env) $%LOCAL_ENVIRONMENTS)
+              :!)
+            (send
+              (send (send (const {cbase nil? } :Rails) :env) $%LOCAL_ENVIRONMENTS)
+              :!)
+          )
+        PATTERN
+
+        def on_or(node)
+          rails_env_local_or?(node) do |*environments|
+            next unless environments.to_set == LOCAL_ENVIRONMENTS
+
+            add_offense(node) do |corrector|
+              corrector.replace(node, 'Rails.env.local?')
+            end
+          end
+        end
+
+        def on_and(node)
+          rails_env_local_and?(node) do |*environments|
+            next unless environments.to_set == LOCAL_ENVIRONMENTS
+
+            add_offense(node, message: MSG_NEGATED) do |corrector|
+              corrector.replace(node, '!Rails.env.local?')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -51,7 +51,7 @@ module RuboCop
           return if allow?(begin_node, end_node)
 
           preferred_method = preferred_method(begin_node)
-          if begin_node.method?(:beginning_of_week) && begin_node.arguments.one?
+          if begin_node.method?(:beginning_of_week) && begin_node.arguments.one? && end_node.arguments.one?
             return unless same_argument?(begin_node, end_node)
 
             preferred_method << "(#{begin_node.first_argument.source})"