rubocop-rails 2.32.0 → 2.35.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '009a04a87f7692e278ce16b061ff93814ada6644691ce2fdd4ac4c7659e68c4d'
-  data.tar.gz: 313e26b30279cf9ebba24f5f99bc78b2b44433b24bc3522a6d4261de1cf72282
+  metadata.gz: 409bf447cc0d5a3b6529407611f53ad1331a5c1bd908e35b7f50193e53bb2c95
+  data.tar.gz: 5d3b83383d138616bcfbbe292413f6ddd6f49b60be33dbe57fdcd481bb7d1c1c
 SHA512:
-  metadata.gz: 1f7397609be46c75da8ff050ed1325db850c39df7d097d9faeb6984162b706ed92e203f151a30a68aa41b3af8fcdd63b7e76c51ebdcfe31980129a853d7cd8a3
-  data.tar.gz: 46006ebeb148838e1ae7f3dc56614b261fc90779c5e3772e163c9431034a89dbc614ef1cb1b913d5236fbc2b04708643fc27b593d8c0c4147898271c045cb4c7
+  metadata.gz: ea50f3fad3d83f62ec110dd0a5b32688f92fcd0963d486714e4a71867343316b67842476f67dd64a5c6d7ccde5f43aeca5c1980ec20e96f097703fdf6ad7c15c
+  data.tar.gz: eb75cb4c5b5a21562ff42dd194fea691e2feec9563095a1a1509b3263a41693ce072a075a269e1416c8f150cf201a602e2301ac1d993dc7a237c3bbe19083d04

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-25 Bozhidar Batsov
+Copyright (c) 2012-26 Bozhidar Batsov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/config/default.yml

@@ -91,6 +91,12 @@ Lint/UselessAccessModifier:
     - concern
     - concerning
 
+Lint/UselessMethodDefinition:
+  # Avoids conflict with `Rails/LexicallyScopedActionFilter` cop.
+  Exclude:
+    - '**/app/controllers/**/*.rb'
+    - '**/app/mailers/**/*.rb'
+
 Rails:
   Enabled: true
   DocumentationBaseURL: https://docs.rubocop.org/rubocop-rails
@@ -402,7 +408,7 @@ Rails/DuplicateAssociation:
   VersionChanged: '2.18'
 
 Rails/DuplicateScope:
-  Description: 'Multiple scopes share this same where clause.'
+  Description: 'Multiple scopes share this same expression.'
   Enabled: pending
   Severity: warning
   VersionAdded: '2.14'
@@ -453,6 +459,7 @@ Rails/EnumSyntax:
   VersionAdded: '2.26'
   Include:
     - '**/app/models/**/*.rb'
+    - '**/lib/**/*.rb'
 
 Rails/EnumUniqueness:
   Description: 'Avoid duplicate integers in hash-syntax `enum` declaration.'
@@ -461,6 +468,11 @@ Rails/EnumUniqueness:
   Include:
     - '**/app/models/**/*.rb'
 
+Rails/Env:
+  Description: 'Use Feature Flags or config instead of `Rails.env`.'
+  Enabled: false
+  VersionAdded: '2.34'
+
 Rails/EnvLocal:
   Description: 'Use `Rails.env.local?` instead of `Rails.env.development? || Rails.env.test?`.'
   Enabled: pending
@@ -532,6 +544,13 @@ Rails/FindById:
   Enabled: 'pending'
   VersionAdded: '2.7'
 
+Rails/FindByOrAssignmentMemoization:
+  Description: 'Avoid memoizing `find_by` results with `||=`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#find-by-memoization'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '2.33'
+
 Rails/FindEach:
   Description: 'Prefer all.find_each over all.each.'
   StyleGuide: 'https://rails.rubystyle.guide#find-each'
@@ -582,8 +601,8 @@ Rails/HttpPositionalArguments:
   Enabled: true
   VersionAdded: '0.44'
   Include:
-    - 'spec/**/*'
-    - 'test/**/*'
+    - '**/spec/**/*'
+    - '**/test/**/*'
 
 Rails/HttpStatus:
   Description: 'Enforces use of symbolic or numeric value to define HTTP status.'
@@ -595,6 +614,14 @@ Rails/HttpStatus:
     - numeric
     - symbolic
 
+Rails/HttpStatusNameConsistency:
+  Description: 'Enforces consistency by using the current HTTP status names.'
+  Enabled: pending
+  Severity: warning
+  VersionAdded: '2.34'
+  Include:
+    - '**/app/controllers/**/*.rb'
+
 Rails/I18nLazyLookup:
   Description: 'Checks for places where I18n "lazy" lookup can be used.'
   StyleGuide: 'https://rails.rubystyle.guide/#lazy-lookup'
@@ -613,8 +640,8 @@ Rails/I18nLocaleAssignment:
   Enabled: 'pending'
   VersionAdded: '2.11'
   Include:
-    - spec/**/*.rb
-    - test/**/*.rb
+    - '**/spec/**/*.rb'
+    - '**/test/**/*.rb'
 
 Rails/I18nLocaleTexts:
   Description: 'Enforces use of I18n and locale files instead of locale specific strings.'
@@ -647,8 +674,9 @@ Rails/IndexBy:
 Rails/IndexWith:
   Description: 'Prefer `index_with` over `each_with_object`, `to_h`, or `map`.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '2.5'
-  VersionChanged: '2.8'
+  VersionChanged: '2.33'
 
 Rails/Inquiry:
   Description: "Prefer Ruby's comparison operators over Active Support's `Array#inquiry` and `String#inquiry`."
@@ -742,6 +770,13 @@ Rails/NotNullColumn:
   Include:
     - db/**/*.rb
 
+Rails/OrderArguments:
+  Description: 'Prefer symbol arguments over strings in `order` method.'
+  StyleGuide: 'https://rails.rubystyle.guide/#order-arguments'
+  Enabled: pending
+  VersionAdded: '2.33'
+  Safe: false
+
 Rails/OrderById:
   Description: >-
                   Do not use the `id` column for ordering.
@@ -809,6 +844,7 @@ Rails/Presence:
   Description: 'Checks code that can be written more easily using `Object#presence` defined by Active Support.'
   Enabled: true
   VersionAdded: '0.52'
+  VersionChanged: '2.34'
 
 Rails/Present:
   Description: 'Enforces use of `present?`.'
@@ -845,6 +881,14 @@ Rails/ReadWriteAttribute:
   Include:
     - '**/app/models/**/*.rb'
 
+Rails/RedirectBackOrTo:
+  Description: >-
+                  Use `redirect_back_or_to` instead of `redirect_back` with
+                  `fallback_location` option.
+  Enabled: pending
+  Severity: warning
+  VersionAdded: '2.34'
+
 Rails/RedundantActiveRecordAllMethod:
   Description: Detect redundant `all` used as a receiver for Active Record query methods.
   StyleGuide: 'https://rails.rubystyle.guide/#redundant-all'
@@ -885,8 +929,8 @@ Rails/RedundantTravelBack:
   Enabled: pending
   VersionAdded: '2.12'
   Include:
-    - spec/**/*.rb
-    - test/**/*.rb
+    - '**/spec/**/*.rb'
+    - '**/test/**/*.rb'
 
 Rails/ReflectionClassName:
   Description: 'Use a string for `class_name` option value in the definition of a reflection.'
@@ -949,10 +993,10 @@ Rails/ResponseParsedBody:
   VersionAdded: '2.18'
   VersionChanged: '2.19'
   Include:
-    - spec/controllers/**/*.rb
-    - spec/requests/**/*.rb
-    - test/controllers/**/*.rb
-    - test/integration/**/*.rb
+    - '**/spec/controllers/**/*.rb'
+    - '**/spec/requests/**/*.rb'
+    - '**/test/controllers/**/*.rb'
+    - '**/test/integration/**/*.rb'
 
 Rails/ReversibleMigration:
   Description: 'Checks whether the change method of the migration file is reversible.'
@@ -1126,7 +1170,7 @@ Rails/ThreeStateBooleanColumn:
 Rails/TimeZone:
   Description: 'Checks the correct usage of time zone aware methods.'
   StyleGuide: 'https://rails.rubystyle.guide#time'
-  Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
+  Reference: 'https://danilenko.org/2012/7/6/rails_timezones'
   Enabled: true
   SafeAutoCorrect: false
   VersionAdded: '0.30'
@@ -1146,8 +1190,8 @@ Rails/TimeZoneAssignment:
   Enabled: 'pending'
   VersionAdded: '2.10'
   Include:
-    - spec/**/*.rb
-    - test/**/*.rb
+    - '**/spec/**/*.rb'
+    - '**/test/**/*.rb'
 
 Rails/ToFormattedS:
   Description: 'Checks for consistent uses of `to_fs` or `to_formatted_s`.'

data/lib/rubocop/cop/mixin/active_record_helper.rb

@@ -106,7 +106,7 @@ module RuboCop
         send_node = node.each_ancestor(:call).first
         return false unless send_node
 
-        return true if WHERE_METHODS.include?(send_node.method_name)
+        return true if WHERE_METHODS.include?(send_node.method_name) && send_node.receiver != node
 
         receiver = send_node.receiver
         return false unless receiver&.send_type?

data/lib/rubocop/cop/mixin/database_type_resolvable.rb

@@ -40,7 +40,7 @@ module RuboCop
         end
       end
 
-      def database_yaml
+      def database_yaml(environment = 'development')
         return unless File.exist?('config/database.yml')
 
         yaml = if YAML.respond_to?(:unsafe_load_file)
@@ -50,7 +50,7 @@ module RuboCop
                end
         return unless yaml.is_a? Hash
 
-        config = yaml['development']
+        config = yaml[environment]
         return unless config.is_a?(Hash)
 
         config
@@ -59,7 +59,7 @@ module RuboCop
       end
 
       def database_adapter
-        database_yaml['adapter'] || database_yaml.first.last['adapter']
+        database_yaml['adapter'] || database_yaml('shared')&.dig('adapter') || database_yaml.first.last['adapter']
       end
     end
   end

data/lib/rubocop/cop/mixin/index_method.rb

@@ -132,9 +132,13 @@ module RuboCop
         add_offense(
           node, message: "Prefer `#{new_method_name}` over `#{match_desc}`."
         ) do |corrector|
+          next if part_of_ignored_node?(node)
+
           correction = prepare_correction(node)
           execute_correction(corrector, node, correction)
         end
+
+        ignore_node(node)
       end
 
       def extract_captures(match)

data/lib/rubocop/cop/mixin/target_rails_version.rb

@@ -12,29 +12,19 @@ module RuboCop
       TARGET_GEM_NAME = 'railties' # :nodoc:
 
       def minimum_target_rails_version(version)
-        if respond_to?(:requires_gem)
-          case version
-          when Integer, Float then requires_gem(TARGET_GEM_NAME, ">= #{version}")
-          when String then requires_gem(TARGET_GEM_NAME, version)
-          end
-        else
-          # Fallback path for previous versions of RuboCop which don't support the `requires_gem` API yet.
-          @minimum_target_rails_version = version
+        case version
+        when Integer, Float then requires_gem(TARGET_GEM_NAME, ">= #{version}")
+        when String then requires_gem(TARGET_GEM_NAME, version)
         end
       end
 
       def support_target_rails_version?(version)
-        if respond_to?(:requires_gem)
-          return false unless gem_requirements
+        return false unless gem_requirements
 
-          gem_requirement = gem_requirements[TARGET_GEM_NAME]
-          return true unless gem_requirement # If we have no requirement, then we support all versions
+        gem_requirement = gem_requirements[TARGET_GEM_NAME]
+        return true unless gem_requirement # If we have no requirement, then we support all versions
 
-          gem_requirement.satisfied_by?(Gem::Version.new(version))
-        else
-          # Fallback path for previous versions of RuboCop which don't support the `requires_gem` API yet.
-          @minimum_target_rails_version <= version
-        end
+        gem_requirement.satisfied_by?(Gem::Version.new(version))
       end
     end
   end

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

@@ -73,7 +73,7 @@ module RuboCop
             return false if use_redirect_to?(context)
 
             context = node
-          elsif context.right_siblings.empty?
+          elsif context.right_siblings.empty? && !use_redirect_to?(context.parent)
             return true
           end
           context = context.right_siblings
@@ -98,7 +98,9 @@ module RuboCop
         end
 
         def use_redirect_to?(context)
-          context.right_siblings.compact.any? do |sibling|
+          context.right_siblings.any? do |sibling|
+            next unless sibling.is_a?(AST::Node)
+
             # Unwrap `return redirect_to :index`
             sibling = sibling.children.first if sibling.return_type? && sibling.children.one?
             sibling.send_type? && sibling.method?(:redirect_to)

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

@@ -72,7 +72,7 @@ module RuboCop
 
         RESTRICT_ON_SEND = FILTER_METHODS + ACTION_METHODS
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           check_method_node(node.send_node)
         end
 

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

@@ -76,7 +76,7 @@ module RuboCop
 
         def on_def(node)
           return unless trivial_delegate?(node)
-          return if private_or_protected_delegation(node)
+          return if private_or_protected_delegation?(node)
           return if module_function_declared?(node)
 
           register_offense(node)
@@ -163,8 +163,8 @@ module RuboCop
           end
         end
 
-        def private_or_protected_delegation(node)
-          private_or_protected_inline(node) || node_visibility(node) != :public
+        def private_or_protected_delegation?(node)
+          private_or_protected_inline?(node) || node_visibility(node) != :public
         end
 
         def module_function_declared?(node)
@@ -173,7 +173,7 @@ module RuboCop
           end
         end
 
-        def private_or_protected_inline(node)
+        def private_or_protected_inline?(node)
           processed_source[node.first_line - 1].strip.match?(/\A(private )|(protected )/)
         end
       end

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

@@ -94,7 +94,7 @@ module RuboCop
           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
+            next unless arguments.one?
 
             if (class_name = class_name(arguments.first))
               class_name.source

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # Checks for multiple scopes in a model that have the same `where` clause. This
+      # Checks for multiple scopes in a model that have the same expression. This
       # often means you copy/pasted a scope, updated the name, and forgot to change the condition.
       #
       # @example
@@ -19,7 +19,7 @@ module RuboCop
       class DuplicateScope < Base
         include ClassSendNodeHelper
 
-        MSG = 'Multiple scopes share this same where clause.'
+        MSG = 'Multiple scopes share this same expression.'
 
         def_node_matcher :scope, <<~PATTERN
           (send nil? :scope _ $...)

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks for usage of `Rails.env` which can be replaced with Feature Flags
+      #
+      # @example
+      #
+      #   # bad
+      #   Rails.env.production? || Rails.env.local?
+      #
+      #   # good
+      #   if FeatureFlag.enabled?(:new_feature)
+      #     # new feature code
+      #   end
+      #
+      class Env < Base
+        MSG = 'Use Feature Flags or config instead of `Rails.env`.'
+        RESTRICT_ON_SEND = %i[env].freeze
+        # This allow list is derived from:
+        # (Rails.env.methods - Object.instance_methods).select { |m| m.to_s.end_with?('?') }
+        # and then removing the environment specific methods like development?, test?, production?, local?
+        ALLOWED_LIST = Set.new(
+          %i[
+            unicode_normalized?
+            exclude?
+            empty?
+            acts_like_string?
+            include?
+            is_utf8?
+            casecmp?
+            match?
+            starts_with?
+            ends_with?
+            start_with?
+            end_with?
+            valid_encoding?
+            ascii_only?
+            between?
+          ]
+        ).freeze
+
+        def on_send(node)
+          return unless node.receiver&.const_name == 'Rails'
+
+          parent = node.parent
+          return unless parent.respond_to?(:predicate_method?) && parent.predicate_method?
+
+          return if ALLOWED_LIST.include?(parent.method_name)
+
+          add_offense(parent)
+        end
+      end
+    end
+  end
+end

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

@@ -24,45 +24,69 @@ module RuboCop
 
         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)
-          )
+        # @!method rails_env_local?(node)
+        def_node_matcher :rails_env_local?, <<~PATTERN
+          (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)
-              :!)
-          )
+        # @!method not_rails_env_local?(node)
+        def_node_matcher :not_rails_env_local?, <<~PATTERN
+          (send #rails_env_local? :!)
         PATTERN
 
         def on_or(node)
-          rails_env_local_or?(node) do |*environments|
-            next unless environments.to_set == LOCAL_ENVIRONMENTS
+          lhs, rhs = *node.children
+          return unless rails_env_local?(rhs)
 
-            add_offense(node) do |corrector|
-              corrector.replace(node, 'Rails.env.local?')
-            end
+          nodes = [rhs]
+
+          if rails_env_local?(lhs)
+            nodes << lhs
+          elsif lhs.or_type? && rails_env_local?(lhs.rhs)
+            nodes << lhs.rhs
+          end
+
+          return unless environments(nodes).to_set == LOCAL_ENVIRONMENTS
+
+          range = offense_range(nodes)
+          add_offense(range) do |corrector|
+            corrector.replace(range, 'Rails.env.local?')
           end
         end
 
         def on_and(node)
-          rails_env_local_and?(node) do |*environments|
-            next unless environments.to_set == LOCAL_ENVIRONMENTS
+          lhs, rhs = *node.children
+          return unless not_rails_env_local?(rhs)
+
+          nodes = [rhs]
+
+          if not_rails_env_local?(lhs)
+            nodes << lhs
+          elsif lhs.operator_keyword? && not_rails_env_local?(lhs.rhs)
+            nodes << lhs.rhs
+          end
 
-            add_offense(node, message: MSG_NEGATED) do |corrector|
-              corrector.replace(node, '!Rails.env.local?')
-            end
+          return unless environments(nodes).to_set == LOCAL_ENVIRONMENTS
+
+          range = offense_range(nodes)
+          add_offense(range, message: MSG_NEGATED) do |corrector|
+            corrector.replace(range, '!Rails.env.local?')
           end
         end
+
+        private
+
+        def environments(nodes)
+          if nodes[0].method?(:!)
+            nodes.map { |node| node.receiver.method_name }
+          else
+            nodes.map(&:method_name)
+          end
+        end
+
+        def offense_range(nodes)
+          nodes[1].source_range.begin.join(nodes[0].source_range.end)
+        end
       end
     end
   end