rubocop-rails 2.20.2 → 2.24.1

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

@@ -13,6 +13,8 @@ module RuboCop
       # error when rollback is desired, and to use `next` when commit is
       # desired.
       #
+      # If you are defining custom transaction methods, you can configure it with `TransactionMethods`.
+      #
       # @example
       #   # bad
       #   ApplicationRecord.transaction do
@@ -50,12 +52,16 @@ module RuboCop
       #     # Commit
       #     next if user.active?
       #   end
+      #
+      # @example TransactionMethods: ["custom_transaction"]
+      #   # bad
+      #   CustomModel.custom_transaction do
+      #     return if user.active?
+      #   end
+      #
       class TransactionExitStatement < Base
-        MSG = <<~MSG.chomp
-          Exit statement `%<statement>s` is not allowed. Use `raise` (rollback) or `next` (commit).
-        MSG
-
-        RESTRICT_ON_SEND = %i[transaction with_lock].freeze
+        MSG = 'Exit statement `%<statement>s` is not allowed. Use `raise` (rollback) or `next` (commit).'
+        BUILT_IN_TRANSACTION_METHODS = %i[transaction with_lock].freeze
 
         def_node_search :exit_statements, <<~PATTERN
           ({return | break | send nil? :throw} ...)
@@ -70,10 +76,9 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return unless (parent = node.parent)
-          return unless parent.block_type? && parent.body
+          return unless in_transaction_block?(node)
 
-          exit_statements(parent.body).each do |statement_node|
+          exit_statements(node.parent.body).each do |statement_node|
             next if statement_node.break_type? && nested_block?(statement_node)
 
             statement = statement(statement_node)
@@ -85,6 +90,13 @@ module RuboCop
 
         private
 
+        def in_transaction_block?(node)
+          return false unless transaction_method_name?(node.method_name)
+          return false unless (parent = node.parent)
+
+          parent.block_type? && parent.body
+        end
+
         def statement(statement_node)
           if statement_node.return_type?
             'return'
@@ -96,9 +108,16 @@ module RuboCop
         end
 
         def nested_block?(statement_node)
-          block_node = statement_node.ancestors.find(&:block_type?)
+          name = statement_node.ancestors.find(&:block_type?).children.first.method_name
+          !transaction_method_name?(name)
+        end
+
+        def transaction_method_name?(method_name)
+          BUILT_IN_TRANSACTION_METHODS.include?(method_name) || transaction_method?(method_name)
+        end
 
-          RESTRICT_ON_SEND.none? { |name| block_node.method?(name) }
+        def transaction_method?(method_name)
+          cop_config.fetch('TransactionMethods', []).include?(method_name.to_s)
         end
       end
     end

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

@@ -68,15 +68,23 @@ module RuboCop
           return unless uniq
 
           add_offense(node.loc.selector) do |corrector|
-            method = node.method_name
-
-            corrector.remove(dot_method_with_whitespace(method, node))
-            corrector.insert_before(node.receiver.loc.dot.begin, '.distinct')
+            autocorrect(corrector, node)
           end
         end
 
         private
 
+        def autocorrect(corrector, node)
+          method = node.method_name
+
+          corrector.remove(dot_method_with_whitespace(method, node))
+          if (dot = node.receiver.loc.dot)
+            corrector.insert_before(dot.begin, '.distinct')
+          else
+            corrector.insert_before(node.receiver, 'distinct.')
+          end
+        end
+
         def dot_method_with_whitespace(method, node)
           range_between(dot_method_begin_pos(method, node), node.loc.selector.end_pos)
         end

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

@@ -124,8 +124,8 @@ module RuboCop
         end
 
         def uniqueness_part(node)
-          pairs = node.arguments.last
-          return unless pairs.hash_type?
+          pairs = node.last_argument
+          return unless pairs&.hash_type?
 
           pairs.each_pair.find do |pair|
             next unless pair.key.sym_type? && pair.key.value == :uniqueness

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

@@ -86,7 +86,11 @@ module RuboCop
         end
 
         def environments
-          cop_config['Environments']
+          @environments ||= begin
+            environments = cop_config['Environments'] || []
+            environments << 'local' if target_rails_version >= 7.1
+            environments
+          end
         end
       end
     end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # If you try to render content along with a non-content status code (100-199, 204, 205, or 304),
+      # it will be dropped from the response.
+      #
+      # This cop checks for uses of `render` which specify both body content and a non-content status.
+      #
+      # @example
+      #   # bad
+      #   render 'foo', status: :continue
+      #   render status: 100, plain: 'Ruby!'
+      #
+      #   # good
+      #   head :continue
+      #   head 100
+      class UnusedRenderContent < Base
+        include RangeHelp
+
+        MSG = 'Do not specify body content for a response with a non-content status code'
+        RESTRICT_ON_SEND = %i[render].freeze
+        NON_CONTENT_STATUS_CODES = Set[*100..199, 204, 205, 304] & ::Rack::Utils::SYMBOL_TO_STATUS_CODE.values
+        NON_CONTENT_STATUSES = Set[
+          *::Rack::Utils::SYMBOL_TO_STATUS_CODE.invert.fetch_values(*NON_CONTENT_STATUS_CODES)
+        ]
+        BODY_OPTIONS = Set[
+          :action,
+          :body,
+          :content_type,
+          :file,
+          :html,
+          :inline,
+          :json,
+          :js,
+          :layout,
+          :plain,
+          :raw,
+          :template,
+          :text,
+          :xml
+        ]
+
+        def_node_matcher :non_content_status?, <<~PATTERN
+          (pair
+            (sym :status)
+            {(sym NON_CONTENT_STATUSES) (int NON_CONTENT_STATUS_CODES)}
+          )
+        PATTERN
+
+        def_node_matcher :unused_render_content?, <<~PATTERN
+          (send nil? :render {
+            (hash <#non_content_status? $(pair (sym BODY_OPTIONS) _) ...>) |
+            $({str sym} _) (hash <#non_content_status? ...>)
+          })
+        PATTERN
+
+        def on_send(node)
+          unused_render_content?(node) do |unused_content_node|
+            add_offense(unused_content_node)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -51,7 +51,7 @@ module RuboCop
           uniqueness
         ].freeze
 
-        RESTRICT_ON_SEND = TYPES.map { |p| "validates_#{p}_of".to_sym }.freeze
+        RESTRICT_ON_SEND = TYPES.map { |p| :"validates_#{p}_of" }.freeze
         ALLOWLIST = TYPES.map { |p| "validates :column, #{p}: value" }.freeze
 
         def on_send(node)
@@ -60,7 +60,7 @@ module RuboCop
           range = node.loc.selector
 
           add_offense(range, message: message(node)) do |corrector|
-            last_argument = node.arguments.last
+            last_argument = node.last_argument
             return if !last_argument.literal? && !last_argument.splat_type? && !frozen_array_argument?(last_argument)
 
             corrector.replace(range, 'validates')

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

@@ -33,8 +33,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
 
@@ -55,6 +55,7 @@ module RuboCop
             end
           end
         end
+        alias on_csend on_send
 
         EQ_ANONYMOUS_RE = /\A([\w.]+)\s+=\s+\?\z/.freeze             # column = ?
         IN_ANONYMOUS_RE = /\A([\w.]+)\s+IN\s+\(\?\)\z/i.freeze       # column IN (?)

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

@@ -39,7 +39,6 @@ module RuboCop
       #   # bad
       #   User.exists?(name: 'john')
       #   User.exists?(['name = ?', 'john'])
-      #   User.exists?('name = ?', 'john')
       #   user.posts.exists?(published: true)
       #
       #   # good
@@ -56,11 +55,11 @@ module RuboCop
         RESTRICT_ON_SEND = %i[exists?].freeze
 
         def_node_matcher :where_exists_call?, <<~PATTERN
-          (send (send _ :where $...) :exists?)
+          (call (call _ :where $...) :exists?)
         PATTERN
 
         def_node_matcher :exists_with_args?, <<~PATTERN
-          (send _ :exists? $...)
+          (call _ :exists? $...)
         PATTERN
 
         def on_send(node)
@@ -68,7 +67,7 @@ module RuboCop
             return unless convertable_args?(args)
 
             range = correction_range(node)
-            good_method = build_good_method(args)
+            good_method = build_good_method(args, dot: node.loc.dot)
             message = format(MSG, good_method: good_method, bad_method: range.source)
 
             add_offense(range, message: message) do |corrector|
@@ -76,6 +75,7 @@ module RuboCop
             end
           end
         end
+        alias on_csend on_send
 
         private
 
@@ -109,11 +109,11 @@ module RuboCop
           end
         end
 
-        def build_good_method(args)
+        def build_good_method(args, dot:)
           if exists_style?
             build_good_method_exists(args)
           elsif where_style?
-            build_good_method_where(args)
+            build_good_method_where(args, dot&.source || '.')
           end
         end
 
@@ -125,11 +125,11 @@ module RuboCop
           end
         end
 
-        def build_good_method_where(args)
+        def build_good_method_where(args, dot_source)
           if args.size > 1
-            "where(#{args.map(&:source).join(', ')}).exists?"
+            "where(#{args.map(&:source).join(', ')})#{dot_source}exists?"
           else
-            "where(#{args[0].source}).exists?"
+            "where(#{args[0].source})#{dot_source}exists?"
           end
         end
       end

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
 
@@ -46,7 +46,7 @@ module RuboCop
             column_and_value = extract_column_and_value(template_node, value_node)
             return unless column_and_value
 
-            good_method = build_good_method(*column_and_value)
+            good_method = build_good_method(node.loc.dot&.source, *column_and_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 (?)
@@ -86,13 +87,14 @@ module RuboCop
           [Regexp.last_match(1), value]
         end
 
-        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_cops.rb

@@ -3,6 +3,7 @@
 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'
@@ -32,6 +33,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'
@@ -45,6 +47,7 @@ require_relative 'rails/dynamic_find_by'
 require_relative 'rails/eager_evaluation_log_message'
 require_relative 'rails/enum_hash'
 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'
@@ -87,6 +90,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 +114,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,6 +131,7 @@ 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'

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)
@@ -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|

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.20.2'
+      STRING = '2.24.1'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

data/lib/rubocop-rails.rb

@@ -17,6 +17,14 @@ require_relative 'rubocop/cop/rails_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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.20.2
+  version: 2.24.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -60,6 +60,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.31.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.31.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: |
   Automatic Rails code style checking tool.
   A RuboCop extension focused on enforcing Rails best practices and coding conventions.
@@ -78,6 +98,7 @@ files:
 - lib/rubocop/cop/mixin/active_record_helper.rb
 - lib/rubocop/cop/mixin/active_record_migrations_helper.rb
 - lib/rubocop/cop/mixin/class_send_node_helper.rb
+- lib/rubocop/cop/mixin/database_type_resolvable.rb
 - lib/rubocop/cop/mixin/enforce_superclass.rb
 - lib/rubocop/cop/mixin/index_method.rb
 - lib/rubocop/cop/mixin/migrations_helper.rb
@@ -106,6 +127,7 @@ files:
 - lib/rubocop/cop/rails/compact_blank.rb
 - lib/rubocop/cop/rails/content_tag.rb
 - lib/rubocop/cop/rails/create_table_with_timestamps.rb
+- lib/rubocop/cop/rails/dangerous_column_names.rb
 - lib/rubocop/cop/rails/date.rb
 - lib/rubocop/cop/rails/default_scope.rb
 - lib/rubocop/cop/rails/delegate.rb
@@ -119,6 +141,7 @@ files:
 - lib/rubocop/cop/rails/eager_evaluation_log_message.rb
 - lib/rubocop/cop/rails/enum_hash.rb
 - lib/rubocop/cop/rails/enum_uniqueness.rb
+- lib/rubocop/cop/rails/env_local.rb
 - lib/rubocop/cop/rails/environment_comparison.rb
 - lib/rubocop/cop/rails/environment_variable_access.rb
 - lib/rubocop/cop/rails/exit.rb
@@ -161,6 +184,7 @@ files:
 - lib/rubocop/cop/rails/present.rb
 - lib/rubocop/cop/rails/rake_environment.rb
 - lib/rubocop/cop/rails/read_write_attribute.rb
+- lib/rubocop/cop/rails/redundant_active_record_all_method.rb
 - lib/rubocop/cop/rails/redundant_allow_nil.rb
 - lib/rubocop/cop/rails/redundant_foreign_key.rb
 - lib/rubocop/cop/rails/redundant_presence_validation_on_belongs_to.rb
@@ -184,6 +208,7 @@ files:
 - lib/rubocop/cop/rails/save_bang.rb
 - lib/rubocop/cop/rails/schema_comment.rb
 - lib/rubocop/cop/rails/scope_args.rb
+- lib/rubocop/cop/rails/select_map.rb
 - lib/rubocop/cop/rails/short_i18n.rb
 - lib/rubocop/cop/rails/skips_model_validations.rb
 - lib/rubocop/cop/rails/squished_sql_heredocs.rb
@@ -200,6 +225,7 @@ files:
 - lib/rubocop/cop/rails/unique_validation_without_index.rb
 - lib/rubocop/cop/rails/unknown_env.rb
 - lib/rubocop/cop/rails/unused_ignored_columns.rb
+- lib/rubocop/cop/rails/unused_render_content.rb
 - lib/rubocop/cop/rails/validation.rb
 - lib/rubocop/cop/rails/where_equals.rb
 - lib/rubocop/cop/rails/where_exists.rb
@@ -219,7 +245,7 @@ metadata:
   homepage_uri: https://docs.rubocop.org/rubocop-rails/
   changelog_uri: https://github.com/rubocop/rubocop-rails/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop-rails/
-  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.20/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.24/
   bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -237,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.0.dev
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Automatic Rails code style checking tool.