rubocop-rails 2.19.1 → 2.30.3

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

@@ -36,7 +36,7 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return unless node.first_argument.sym_type?
+          return unless node.first_argument&.sym_type?
 
           root_receiver = root_receiver(node)
           where_node_and_argument(root_receiver) do |where_node, where_argument|
@@ -89,16 +89,20 @@ module RuboCop
           end
         end
 
+        # rubocop:disable Metrics/AbcSize
         def remove_where_method(corrector, node, where_node)
           range = range_between(where_node.loc.selector.begin_pos, where_node.loc.end.end_pos)
           if node.multiline? && !same_line?(node, where_node)
             range = range_by_whole_lines(range, include_final_newline: true)
-          else
+          elsif where_node.receiver
             corrector.remove(where_node.loc.dot)
+          else
+            corrector.remove(node.loc.dot)
           end
 
           corrector.remove(range)
         end
+        # rubocop:enable Metrics/AbcSize
 
         def same_line?(left_joins_node, where_node)
           left_joins_node.loc.selector.line == where_node.loc.selector.line

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

@@ -32,8 +32,8 @@ module RuboCop
 
         def_node_matcher :where_method_call?, <<~PATTERN
           {
-            (send _ :where (array $str_type? $_ ?))
-            (send _ :where $str_type? $_ ?)
+            (call _ :where (array $str_type? $_ ?))
+            (call _ :where $str_type? $_ ?)
           }
         PATTERN
 
@@ -43,10 +43,10 @@ module RuboCop
 
             range = offense_range(node)
 
-            column_and_value = extract_column_and_value(template_node, value_node)
-            return unless column_and_value
+            column, value = extract_column_and_value(template_node, value_node)
+            return unless value
 
-            good_method = build_good_method(*column_and_value)
+            good_method = build_good_method(node.loc.dot&.source, column, value)
             message = format(MSG, good_method: good_method)
 
             add_offense(range, message: message) do |corrector|
@@ -54,6 +54,7 @@ module RuboCop
             end
           end
         end
+        alias on_csend on_send
 
         NOT_EQ_ANONYMOUS_RE = /\A([\w.]+)\s+(?:!=|<>)\s+\?\z/.freeze           # column != ?, column <> ?
         NOT_IN_ANONYMOUS_RE = /\A([\w.]+)\s+NOT\s+IN\s+\(\?\)\z/i.freeze       # column NOT IN (?)
@@ -67,13 +68,14 @@ module RuboCop
           range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
         end
 
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
         def extract_column_and_value(template_node, value_node)
           value =
             case template_node.value
             when NOT_EQ_ANONYMOUS_RE, NOT_IN_ANONYMOUS_RE
-              value_node.source
+              value_node&.source
             when NOT_EQ_NAMED_RE, NOT_IN_NAMED_RE
-              return unless value_node.hash_type?
+              return unless value_node&.hash_type?
 
               pair = value_node.pairs.find { |p| p.key.value.to_sym == Regexp.last_match(2).to_sym }
               pair.value.source
@@ -83,16 +85,21 @@ module RuboCop
               return
             end
 
-          [Regexp.last_match(1), value]
+          column_qualifier = Regexp.last_match(1)
+          return if column_qualifier.count('.') > 1
+
+          [column_qualifier, value]
         end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
-        def build_good_method(column, value)
+        def build_good_method(dot, column, value)
+          dot ||= '.'
           if column.include?('.')
             table, column = column.split('.')
 
-            "where.not(#{table}: { #{column}: #{value} })"
+            "where#{dot}not(#{table}: { #{column}: #{value} })"
           else
-            "where.not(#{column}: #{value})"
+            "where#{dot}not(#{column}: #{value})"
           end
         end
       end

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

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Identifies places where manually constructed SQL
+      # in `where` can be replaced with ranges.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because it can change the query
+      #   by explicitly attaching the column to the wrong table.
+      #   For example, `Booking.joins(:events).where('end_at < ?', Time.current)` will correctly
+      #   implicitly attach the `end_at` column to the `events` table. But when autocorrected to
+      #   `Booking.joins(:events).where(end_at: ...Time.current)`, it will now be incorrectly
+      #   explicitly attached to the `bookings` table.
+      #
+      # @example
+      #   # bad
+      #   User.where('age >= ?', 18)
+      #   User.where.not('age >= ?', 18)
+      #   User.where('age < ?', 18)
+      #   User.where('age >= ? AND age < ?', 18, 21)
+      #   User.where('age >= :start', start: 18)
+      #   User.where('users.age >= ?', 18)
+      #
+      #   # good
+      #   User.where(age: 18..)
+      #   User.where.not(age: 18..)
+      #   User.where(age: ...18)
+      #   User.where(age: 18...21)
+      #   User.where(users: { age: 18.. })
+      #
+      #   # good
+      #   # There are no beginless ranges in ruby.
+      #   User.where('age > ?', 18)
+      #
+      class WhereRange < Base
+        include RangeHelp
+        extend AutoCorrector
+        extend TargetRubyVersion
+        extend TargetRailsVersion
+
+        MSG = 'Use `%<good_method>s` instead of manually constructing SQL.'
+
+        RESTRICT_ON_SEND = %i[where not].freeze
+
+        # column >= ?
+        GTEQ_ANONYMOUS_RE   = /\A\s*([\w.]+)\s+>=\s+\?\s*\z/.freeze
+        # column <[=] ?
+        LTEQ_ANONYMOUS_RE   = /\A\s*([\w.]+)\s+(<=?)\s+\?\s*\z/.freeze
+        # column >= ? AND column <[=] ?
+        RANGE_ANONYMOUS_RE  = /\A\s*([\w.]+)\s+>=\s+\?\s+AND\s+\1\s+(<=?)\s+\?\s*\z/i.freeze
+        # column >= :value
+        GTEQ_NAMED_RE       = /\A\s*([\w.]+)\s+>=\s+:(\w+)\s*\z/.freeze
+        # column <[=] :value
+        LTEQ_NAMED_RE       = /\A\s*([\w.]+)\s+(<=?)\s+:(\w+)\s*\z/.freeze
+        # column >= :value1 AND column <[=] :value2
+        RANGE_NAMED_RE      = /\A\s*([\w.]+)\s+>=\s+:(\w+)\s+AND\s+\1\s+(<=?)\s+:(\w+)\s*\z/i.freeze
+
+        minimum_target_ruby_version 2.6
+        minimum_target_rails_version 6.0
+
+        def_node_matcher :where_range_call?, <<~PATTERN
+          {
+            (call _ {:where :not} (array $str_type? $_ +))
+            (call _ {:where :not} $str_type? $_ +)
+          }
+        PATTERN
+
+        def on_send(node)
+          return if node.method?(:not) && !where_not?(node)
+
+          where_range_call?(node) do |template_node, values_node|
+            column, value = extract_column_and_value(template_node, values_node)
+
+            return unless column
+
+            range = offense_range(node)
+            good_method = build_good_method(node.method_name, column, value)
+            message = format(MSG, good_method: good_method)
+
+            add_offense(range, message: message) do |corrector|
+              corrector.replace(range, good_method)
+            end
+          end
+        end
+
+        private
+
+        def where_not?(node)
+          receiver = node.receiver
+          receiver&.send_type? && receiver.method?(:where)
+        end
+
+        # rubocop:disable Metrics
+        def extract_column_and_value(template_node, values_node)
+          case template_node.value
+          when GTEQ_ANONYMOUS_RE
+            lhs = values_node[0]
+            operator = '..'
+          when LTEQ_ANONYMOUS_RE
+            if target_ruby_version >= 2.7
+              operator = range_operator(Regexp.last_match(2))
+              rhs = values_node[0]
+            end
+          when RANGE_ANONYMOUS_RE
+            if values_node.size >= 2
+              lhs = values_node[0]
+              operator = range_operator(Regexp.last_match(2))
+              rhs = values_node[1]
+            end
+          when GTEQ_NAMED_RE
+            value_node = values_node[0]
+
+            if value_node.hash_type?
+              pair = find_pair(value_node, Regexp.last_match(2))
+              lhs = pair.value
+              operator = '..'
+            end
+          when LTEQ_NAMED_RE
+            value_node = values_node[0]
+
+            if value_node.hash_type?
+              pair = find_pair(value_node, Regexp.last_match(2))
+              if pair && target_ruby_version >= 2.7
+                operator = range_operator(Regexp.last_match(2))
+                rhs = pair.value
+              end
+            end
+          when RANGE_NAMED_RE
+            value_node = values_node[0]
+
+            if value_node.hash_type?
+              pair1 = find_pair(value_node, Regexp.last_match(2))
+              pair2 = find_pair(value_node, Regexp.last_match(4))
+
+              if pair1 && pair2
+                lhs = pair1.value
+                operator = range_operator(Regexp.last_match(3))
+                rhs = pair2.value
+              end
+            end
+          else
+            return
+          end
+
+          if lhs
+            lhs_source = parentheses_needed?(lhs) ? "(#{lhs.source})" : lhs.source
+          end
+
+          if rhs
+            rhs_source = parentheses_needed?(rhs) ? "(#{rhs.source})" : rhs.source
+          end
+
+          column_qualifier = Regexp.last_match(1)
+          return if column_qualifier.count('.') > 1
+
+          [column_qualifier, "#{lhs_source}#{operator}#{rhs_source}"] if operator
+        end
+        # rubocop:enable Metrics
+
+        def range_operator(comparison_operator)
+          comparison_operator == '<' ? '...' : '..'
+        end
+
+        def find_pair(hash_node, value)
+          hash_node.pairs.find { |pair| pair.key.value.to_sym == value.to_sym }
+        end
+
+        def offense_range(node)
+          range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
+        end
+
+        def build_good_method(method_name, column, value)
+          if column.include?('.')
+            table, column = column.split('.')
+
+            "#{method_name}(#{table}: { #{column}: #{value} })"
+          else
+            "#{method_name}(#{column}: #{value})"
+          end
+        end
+
+        def parentheses_needed?(node)
+          !parentheses_not_needed?(node)
+        end
+
+        def parentheses_not_needed?(node)
+          node.variable? ||
+            node.literal? ||
+            node.reference? ||
+            node.const_type? ||
+            node.begin_type? ||
+            parenthesized_call_node?(node)
+        end
+
+        def parenthesized_call_node?(node)
+          node.call_type? && (node.arguments.empty? || node.parenthesized_call?)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails_cops.rb

@@ -3,12 +3,15 @@
 require_relative 'mixin/active_record_helper'
 require_relative 'mixin/active_record_migrations_helper'
 require_relative 'mixin/class_send_node_helper'
+require_relative 'mixin/database_type_resolvable'
 require_relative 'mixin/enforce_superclass'
 require_relative 'mixin/index_method'
 require_relative 'mixin/migrations_helper'
+require_relative 'mixin/routes_helper'
 require_relative 'mixin/target_rails_version'
 
 require_relative 'rails/action_controller_flash_before_render'
+require_relative 'rails/strong_parameters_expect'
 require_relative 'rails/action_controller_test_case'
 require_relative 'rails/action_filter'
 require_relative 'rails/action_order'
@@ -32,6 +35,7 @@ require_relative 'rails/bulk_change_table'
 require_relative 'rails/compact_blank'
 require_relative 'rails/content_tag'
 require_relative 'rails/create_table_with_timestamps'
+require_relative 'rails/dangerous_column_names'
 require_relative 'rails/date'
 require_relative 'rails/default_scope'
 require_relative 'rails/delegate'
@@ -44,7 +48,9 @@ require_relative 'rails/duration_arithmetic'
 require_relative 'rails/dynamic_find_by'
 require_relative 'rails/eager_evaluation_log_message'
 require_relative 'rails/enum_hash'
+require_relative 'rails/enum_syntax'
 require_relative 'rails/enum_uniqueness'
+require_relative 'rails/env_local'
 require_relative 'rails/environment_comparison'
 require_relative 'rails/environment_variable_access'
 require_relative 'rails/exit'
@@ -73,6 +79,7 @@ require_relative 'rails/link_to_blank'
 require_relative 'rails/mailer_name'
 require_relative 'rails/match_route'
 require_relative 'rails/migration_class_name'
+require_relative 'rails/multiple_route_paths'
 require_relative 'rails/negate_include'
 require_relative 'rails/not_null_column'
 require_relative 'rails/order_by_id'
@@ -87,6 +94,7 @@ require_relative 'rails/presence'
 require_relative 'rails/present'
 require_relative 'rails/rake_environment'
 require_relative 'rails/read_write_attribute'
+require_relative 'rails/redundant_active_record_all_method'
 require_relative 'rails/redundant_allow_nil'
 require_relative 'rails/redundant_foreign_key'
 require_relative 'rails/redundant_presence_validation_on_belongs_to'
@@ -110,6 +118,7 @@ require_relative 'rails/safe_navigation_with_blank'
 require_relative 'rails/save_bang'
 require_relative 'rails/schema_comment'
 require_relative 'rails/scope_args'
+require_relative 'rails/select_map'
 require_relative 'rails/short_i18n'
 require_relative 'rails/skips_model_validations'
 require_relative 'rails/squished_sql_heredocs'
@@ -126,9 +135,11 @@ require_relative 'rails/uniq_before_pluck'
 require_relative 'rails/unique_validation_without_index'
 require_relative 'rails/unknown_env'
 require_relative 'rails/unused_ignored_columns'
+require_relative 'rails/unused_render_content'
 require_relative 'rails/validation'
 require_relative 'rails/where_equals'
 require_relative 'rails/where_exists'
 require_relative 'rails/where_missing'
 require_relative 'rails/where_not'
 require_relative 'rails/where_not_with_multiple_conditions'
+require_relative 'rails/where_range'

data/lib/rubocop/rails/migration_file_skippable.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Rails
+    # This module allows cops to detect and ignore files that have already been migrated
+    # by leveraging the `AllCops: MigratedSchemaVersion` configuration.
+    #
+    # [source,yaml]
+    # -----
+    # AllCops:
+    #   MigratedSchemaVersion: '20241225000000'
+    # -----
+    #
+    # When applied to cops, it overrides the `add_global_offense` and `add_offense` methods,
+    # ensuring that cops skip processing if the file is determined to be a migrated file
+    # based on the schema version.
+    #
+    # @api private
+    module MigrationFileSkippable
+      def add_global_offense(message = nil, severity: nil)
+        return if already_migrated_file?
+
+        super if method(__method__).super_method
+      end
+
+      def add_offense(node_or_range, message: nil, severity: nil, &block)
+        return if already_migrated_file?
+
+        super if method(__method__).super_method
+      end
+
+      def self.apply_to_cops!
+        RuboCop::Cop::Registry.all.each { |cop| cop.prepend(MigrationFileSkippable) }
+      end
+
+      private
+
+      def already_migrated_file?
+        return false unless migrated_schema_version
+
+        match_data = File.basename(processed_source.file_path).match(/(?<timestamp>\d{14})/)
+        schema_version = match_data['timestamp'] if match_data
+
+        return false unless schema_version
+
+        schema_version <= migrated_schema_version.to_s # Ignore applied migration files.
+      end
+
+      def migrated_schema_version
+        @migrated_schema_version ||= config.for_all_cops.fetch('MigratedSchemaVersion', nil)
+      end
+    end
+  end
+end

data/lib/rubocop/rails/plugin.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Rails
+    # A plugin that integrates RuboCop Rails with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-rails',
+          version: Version::STRING,
+          homepage: 'https://github.com/rubocop/rubocop-rails',
+          description: 'A RuboCop extension focused on enforcing Rails best practices and coding conventions.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        ConfigObsoletion.files << project_root.join('config', 'obsoletion.yml')
+
+        # FIXME: This is a dirty hack relying on a private constant to prevent
+        # "Warning: AllCops does not support TargetRailsVersion parameter".
+        # It should be updated to a better design in the future.
+        without_warnings do
+          ConfigValidator.const_set(:COMMON_PARAMS, ConfigValidator::COMMON_PARAMS.dup << 'TargetRailsVersion')
+        end
+
+        LintRoller::Rules.new(type: :path, config_format: :rubocop, value: project_root.join('config', 'default.yml'))
+      end
+
+      private
+
+      def without_warnings
+        original_verbose = $VERBOSE
+        $VERBOSE = nil
+        yield
+      ensure
+        $VERBOSE = original_verbose
+      end
+    end
+  end
+end

data/lib/rubocop/rails/schema_loader/schema.rb

@@ -30,6 +30,7 @@ module RuboCop
 
         def build!(ast)
           raise "Unexpected type: #{ast.type}" unless ast.block_type?
+          return unless ast.body
 
           each_table(ast) do |table_def|
             next unless table_def.method?(:create_table)
@@ -83,21 +84,21 @@ module RuboCop
         private
 
         def build_columns(node)
-          each_content(node).map do |child|
+          each_content(node).filter_map do |child|
             next unless child&.send_type?
             next if child.method?(:index)
 
             Column.new(child)
-          end.compact
+          end
         end
 
         def build_indices(node)
-          each_content(node).map do |child|
+          each_content(node).filter_map do |child|
             next unless child&.send_type?
             next unless child.method?(:index)
 
             Index.new(child)
-          end.compact
+          end
         end
 
         def each_content(node, &block)
@@ -127,7 +128,7 @@ module RuboCop
         private
 
         def analyze_keywords!(node)
-          pairs = node.arguments.last
+          pairs = node.last_argument
           return unless pairs.hash_type?
 
           pairs.each_pair do |k, v|
@@ -158,7 +159,7 @@ module RuboCop
         end
 
         def analyze_keywords!(node)
-          pairs = node.arguments.last
+          pairs = node.last_argument
           return unless pairs.hash_type?
 
           pairs.each_pair do |k, v|
@@ -177,7 +178,7 @@ module RuboCop
         attr_reader :table_name
 
         def initialize(node)
-          super(node)
+          super
 
           @table_name = node.first_argument.value
           @columns, @expression = build_columns_or_expr(node.arguments[1])

data/lib/rubocop/rails/schema_loader.rb

@@ -12,10 +12,10 @@ module RuboCop
       # So a cop that uses the loader should handle `nil` properly.
       #
       # @return [Schema, nil]
-      def load(target_ruby_version)
+      def load(target_ruby_version, parser_engine)
         return @load if defined?(@load)
 
-        @load = load!(target_ruby_version)
+        @load = load!(target_ruby_version, parser_engine)
       end
 
       def reset!
@@ -38,23 +38,13 @@ module RuboCop
 
       private
 
-      def load!(target_ruby_version)
+      def load!(target_ruby_version, parser_engine)
         path = db_schema_path
         return unless path
 
-        ast = parse(path, target_ruby_version)
-        Schema.new(ast)
-      end
-
-      def parse(path, target_ruby_version)
-        klass_name = :"Ruby#{target_ruby_version.to_s.sub('.', '')}"
-        klass = ::Parser.const_get(klass_name)
-        parser = klass.new(RuboCop::AST::Builder.new)
-
-        buffer = Parser::Source::Buffer.new(path, 1)
-        buffer.source = path.read
+        ast = RuboCop::ProcessedSource.new(File.read(path), target_ruby_version, path, parser_engine: parser_engine).ast
 
-        parser.parse(buffer)
+        Schema.new(ast) if ast
       end
     end
   end

data/lib/rubocop/rails/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Rails
     # This module holds the RuboCop Rails version information.
     module Version
-      STRING = '2.19.1'
+      STRING = '2.30.3'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

data/lib/rubocop/rails.rb

@@ -1,14 +1,7 @@
 # frozen_string_literal: true
 
 module RuboCop
-  # RuboCop Rails project namespace
+  # RuboCop Rails project namespace.
   module Rails
-    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read, permitted_classes: [Regexp, Symbol]).freeze
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
-
-    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config', 'obsoletion.yml')
   end
 end

data/lib/rubocop-rails.rb

@@ -7,16 +7,24 @@ require 'active_support/core_ext/object/blank'
 
 require_relative 'rubocop/rails'
 require_relative 'rubocop/rails/version'
-require_relative 'rubocop/rails/inject'
 require_relative 'rubocop/rails/schema_loader'
 require_relative 'rubocop/rails/schema_loader/schema'
-
-RuboCop::Rails::Inject.defaults!
-
+require_relative 'rubocop/rails/plugin'
 require_relative 'rubocop/cop/rails_cops'
 
+require_relative 'rubocop/rails/migration_file_skippable'
+RuboCop::Rails::MigrationFileSkippable.apply_to_cops!
+
 RuboCop::Cop::Style::HashExcept.minimum_target_ruby_version(2.0)
 
+RuboCop::Cop::Style::InverseMethods.singleton_class.prepend(
+  Module.new do
+    def autocorrect_incompatible_with
+      super.push(RuboCop::Cop::Rails::NegateInclude)
+    end
+  end
+)
+
 RuboCop::Cop::Style::MethodCallWithArgsParentheses.singleton_class.prepend(
   Module.new do
     def autocorrect_incompatible_with