rubocop-rails 2.19.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 327dd4bed957b6be1d52e47a9087f43abf7f7361ddaf8b0c3b13dbb0bf7bbb52
-  data.tar.gz: cf2c5747f8abab6e65ff8ffc9d31693c42c0515e8751a1d5b0651c12c7ceb93a
+  metadata.gz: 22c95e775f271cb0f160d1e57cb8582ce3f57cabef1afd860c88a3d57fe6b248
+  data.tar.gz: c9471d33b16523be2e193ac789bf98ad9cde3b299e496e42d26f6e15ff6b24fc
 SHA512:
-  metadata.gz: 4114a576ae595944cd0ec1b673e8f706fa975a643fb9d56e25b5498b7964f5141e2724aeb2dc24c6b63f6d501c7e1a85469a32333be69862e054fdb10874f09c
-  data.tar.gz: c87e88b3de8ea166a68a0be6a08e70e387790b3d705648145a8d769978f1c92e03ea18fe510b1ce5543c6f1fefe59be1f0fd583ba392dd2274b1dde58a21ca61
+  metadata.gz: a123680bab27b5926384dcc4a245bdbb96fd8112c8a152cde44ada0bedb732ab35765665a5db8630aaa559f072060e78eda1077e82899b0ffc1808851229825f
+  data.tar.gz: be271e0fadfd44c7dfc7c6547e1793b40da9521eed8466d4ff8ee69de9eed41f681c03e3431faf24c121bc0b979fe3939b6c948ffdc172895e6808174f126691

data/README.md

@@ -71,7 +71,8 @@ your config/application.rb to apply RuboCop autocorrection to code generated by
 module YourCoolApp
   class Application < Rails::Application
     config.generators.after_generate do |files|
-      system("bundle exec rubocop -A --fail-level=E #{files.shelljoin}", exception: true)
+      parsable_files = files.filter { |file| file.end_with?('.rb') }
+      system("bundle exec rubocop -A --fail-level=E #{parsable_files.shelljoin}", exception: true)
     end
   end
 end

data/config/default.yml

@@ -6,6 +6,7 @@ inherit_mode:
 
 AllCops:
   Exclude:
+    - app/assets/**/*
     - bin/*
     # Exclude db/schema.rb and db/[CONFIGURATION_NAMESPACE]_schema.rb by default.
     # See: https://guides.rubyonrails.org/active_record_multiple_databases.html#setting-up-your-application
@@ -47,6 +48,19 @@ Lint/NumberConversion:
     - in_milliseconds
   AllowedPatterns: []
 
+Lint/RedundantSafeNavigation:
+  # Add `presence` and `present?` methods to the default of the RuboCop core.
+  # https://github.com/rubocop/rubocop/blob/v1.51.0/config/default.yml#L2148-L2159
+  AllowedMethods:
+    - instance_of?
+    - kind_of?
+    - is_a?
+    - eql?
+    - respond_to?
+    - equal?
+    - presence
+    - present?
+
 Rails:
   Enabled: true
   DocumentationBaseURL: https://docs.rubocop.org/rubocop-rails
@@ -146,8 +160,9 @@ Rails/AddColumnIndex:
     index might be used.
   Enabled: pending
   VersionAdded: '2.11'
+  VersionChanged: '2.20'
   Include:
-    - db/migrate/*.rb
+    - db/**/*.rb
 
 Rails/AfterCommitOverride:
   Description: >-
@@ -235,12 +250,13 @@ Rails/BulkChangeTable:
     - https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/Table.html
   Enabled: true
   VersionAdded: '0.57'
+  VersionChanged: '2.20'
   Database: null
   SupportedDatabases:
     - mysql
     - postgresql
   Include:
-    - db/migrate/*.rb
+    - db/**/*.rb
 
 Rails/CompactBlank:
   Description: 'Checks if collection can be blank-compacted with `compact_blank`.'
@@ -270,18 +286,22 @@ Rails/CreateTableWithTimestamps:
                   when creating a new table.
   Enabled: true
   VersionAdded: '0.52'
+  VersionChanged: '2.20'
   Include:
-    - db/migrate/*.rb
+    - db/**/*.rb
   Exclude:
     # Respect the `active_storage_variant_records` table of `*_create_active_storage_tables.active_storage.rb`
+    # and `*_create_active_storage_variant_records.active_storage.rb`
     # auto-generated by `bin/rails active_storage:install` even if `created_at` is not specified.
-    - db/migrate/*_create_active_storage_tables.active_storage.rb
+    - db/**/*_create_active_storage_tables.active_storage.rb
+    - db/**/*_create_active_storage_variant_records.active_storage.rb
 
 Rails/Date:
   Description: >-
                   Checks the correct usage of date aware methods,
                   such as Date.today, Date.current etc.
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.30'
   VersionChanged: '2.11'
   # The value `strict` disallows usage of `Date.today`, `Date.current`,
@@ -632,8 +652,9 @@ Rails/MigrationClassName:
   Description: 'The class name of the migration should match its file name.'
   Enabled: pending
   VersionAdded: '2.14'
+  VersionChanged: '2.20'
   Include:
-    - db/migrate/*.rb
+    - db/**/*.rb
 
 Rails/NegateInclude:
   Description: 'Prefer `collection.exclude?(obj)` over `!collection.include?(obj)`.'
@@ -647,8 +668,9 @@ Rails/NotNullColumn:
   Description: 'Do not add a NOT NULL column without a default value.'
   Enabled: true
   VersionAdded: '0.43'
+  VersionChanged: '2.20'
   Include:
-    - db/migrate/*.rb
+    - db/**/*.rb
 
 Rails/OrderById:
   Description: >-
@@ -1139,6 +1161,7 @@ Rails/WhereNot:
 
 Rails/WhereNotWithMultipleConditions:
   Description: 'Do not use `where.not(...)` with multiple conditions.'
+  StyleGuide: 'https://rails.rubystyle.guide/#where-not-with-multiple-attributes'
   Enabled: 'pending'
   Severity: warning
   VersionAdded: '2.17'

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

@@ -3,7 +3,6 @@
 module RuboCop
   module Cop
     module Rails
-      #
       # Use `assert_not` instead of `assert !`.
       #
       # @example

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

@@ -22,6 +22,9 @@ module RuboCop
       # And you can set a warning for `to_time` with `AllowToTime: false`.
       # `AllowToTime` is `true` by default to prevent false positive on `DateTime` object.
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because it may change handling time.
+      #
       # @example EnforcedStyle: flexible (default)
       #   # bad
       #   Date.today
@@ -51,6 +54,8 @@ module RuboCop
       #   # bad
       #   date.to_time
       class Date < Base
+        extend AutoCorrector
+
         include ConfigurableEnforcedStyle
 
         MSG = 'Do not use `Date.%<method_called>s` without zone. Use `Time.zone.%<day>s` instead.'
@@ -92,7 +97,9 @@ module RuboCop
 
             message = format(DEPRECATED_MSG, deprecated: method[:deprecated], relevant: method[:relevant])
 
-            add_offense(node.loc.selector, message: message)
+            add_offense(node.loc.selector, message: message) do |corrector|
+              corrector.replace(node.loc.selector, method[:relevant].to_s)
+            end
           end
         end
 
@@ -108,7 +115,9 @@ module RuboCop
 
           message = format(MSG, method_called: method_name, day: day)
 
-          add_offense(node.loc.selector, message: message)
+          add_offense(node.loc.selector, message: message) do |corrector|
+            corrector.replace(node.receiver.loc.name, 'Time.zone')
+          end
         end
 
         def extract_method_chain(node)

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

@@ -35,6 +35,8 @@ module RuboCop
       #   Rails.root.join('app', 'models', 'goober').to_s
       #
       class FilePath < Base
+        extend AutoCorrector
+
         include ConfigurableEnforcedStyle
         include RangeHelp
 
@@ -56,13 +58,10 @@ module RuboCop
 
         def on_dstr(node)
           return unless rails_root_nodes?(node)
-          return unless node.children.last.str_type?
-
-          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?(':')
+          return if dstr_separated_by_colon?(node)
 
-          register_offense(node, require_to_s: true)
+          check_for_slash_after_rails_root_in_dstr(node)
+          check_for_extension_after_rails_root_join_in_dstr(node)
         end
 
         def on_send(node)
@@ -73,11 +72,33 @@ module RuboCop
 
         private
 
+        def check_for_slash_after_rails_root_in_dstr(node)
+          rails_root_index = find_rails_root_index(node)
+          slash_node = node.children[rails_root_index + 1]
+          return unless slash_node&.str_type? && slash_node.source.start_with?(File::SEPARATOR)
+
+          register_offense(node, require_to_s: false) do |corrector|
+            autocorrect_slash_after_rails_root_in_dstr(corrector, node, rails_root_index)
+          end
+        end
+
+        def check_for_extension_after_rails_root_join_in_dstr(node)
+          rails_root_index = find_rails_root_index(node)
+          extension_node = node.children[rails_root_index + 1]
+          return unless extension_node?(extension_node)
+
+          register_offense(node, require_to_s: false) do |corrector|
+            autocorrect_extension_after_rails_root_join_in_dstr(corrector, node, rails_root_index, extension_node)
+          end
+        end
+
         def check_for_file_join_with_rails_root(node)
           return unless file_join_nodes?(node)
           return unless node.arguments.any? { |e| rails_root_nodes?(e) }
 
-          register_offense(node, require_to_s: true)
+          register_offense(node, require_to_s: true) do |corrector|
+            autocorrect_file_join(corrector, node)
+          end
         end
 
         def check_for_rails_root_join_with_string_arguments(node)
@@ -87,7 +108,9 @@ module RuboCop
           return unless node.arguments.size > 1
           return unless node.arguments.all?(&:str_type?)
 
-          register_offense(node, require_to_s: false)
+          register_offense(node, require_to_s: false) do |corrector|
+            autocorrect_rails_root_join_with_string_arguments(corrector, node)
+          end
         end
 
         def check_for_rails_root_join_with_slash_separated_path(node)
@@ -96,21 +119,22 @@ module RuboCop
           return unless rails_root_join_nodes?(node)
           return unless node.arguments.any? { |arg| string_with_slash?(arg) }
 
-          register_offense(node, require_to_s: false)
+          register_offense(node, require_to_s: false) do |corrector|
+            autocorrect_rails_root_join_with_slash_separated_path(corrector, node)
+          end
         end
 
         def string_with_slash?(node)
-          node.str_type? && node.source.include?('/')
+          node.str_type? && node.source.include?(File::SEPARATOR)
         end
 
-        def register_offense(node, require_to_s:)
+        def register_offense(node, require_to_s:, &block)
           line_range = node.loc.column...node.loc.last_column
           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)
+          add_offense(source_range, message: message, &block)
         end
 
         def build_message(require_to_s)
@@ -119,6 +143,95 @@ module RuboCop
 
           format(message_template, to_s: to_s)
         end
+
+        def dstr_separated_by_colon?(node)
+          node.children[1..].any? do |child|
+            child.str_type? && child.source.start_with?(':')
+          end
+        end
+
+        def autocorrect_slash_after_rails_root_in_dstr(corrector, node, rails_root_index)
+          rails_root_node = node.children[rails_root_index].children.first
+          argument_source = extract_rails_root_join_argument_source(node, rails_root_index)
+          if rails_root_node.method?(:join)
+            append_argument(corrector, rails_root_node, argument_source)
+          else
+            replace_with_rails_root_join(corrector, rails_root_node, argument_source)
+          end
+          node.children[rails_root_index + 1..].each { |child| corrector.remove(child) }
+        end
+
+        def autocorrect_extension_after_rails_root_join_in_dstr(corrector, node, rails_root_index, extension_node)
+          rails_root_node = node.children[rails_root_index].children.first
+          return unless rails_root_node.arguments.last.str_type?
+
+          corrector.insert_before(rails_root_node.arguments.last.location.end, extension_node.source)
+          corrector.remove(extension_node)
+        end
+
+        def autocorrect_file_join(corrector, node)
+          corrector.replace(node.receiver, 'Rails.root')
+          corrector.remove(
+            range_with_surrounding_space(
+              range_with_surrounding_comma(
+                node.arguments.first.source_range,
+                :right
+              ),
+              side: :right
+            )
+          )
+          corrector.insert_after(node, '.to_s')
+        end
+
+        def autocorrect_rails_root_join_with_string_arguments(corrector, node)
+          corrector.replace(node.arguments.first, %("#{node.arguments.map(&:value).join('/')}"))
+          node.arguments[1..].each do |argument|
+            corrector.remove(
+              range_with_surrounding_comma(
+                range_with_surrounding_space(
+                  argument.source_range,
+                  side: :left
+                ),
+                :left
+              )
+            )
+          end
+        end
+
+        def autocorrect_rails_root_join_with_slash_separated_path(corrector, node)
+          node.arguments.each do |argument|
+            next unless string_with_slash?(argument)
+
+            index = argument.source.index(File::SEPARATOR)
+            rest = inner_range_of(argument).adjust(begin_pos: index - 1)
+            corrector.remove(rest)
+            corrector.insert_after(argument, %(, "#{rest.source.delete_prefix(File::SEPARATOR)}"))
+          end
+        end
+
+        def inner_range_of(node)
+          node.location.end.with(begin_pos: node.location.begin.end_pos).adjust(end_pos: -1)
+        end
+
+        def find_rails_root_index(node)
+          node.children.index { |child| rails_root_nodes?(child) }
+        end
+
+        def append_argument(corrector, node, argument_source)
+          corrector.insert_after(node.arguments.last, %(, "#{argument_source}"))
+        end
+
+        def replace_with_rails_root_join(corrector, node, argument_source)
+          corrector.replace(node, %<Rails.root.join("#{argument_source}")>)
+        end
+
+        def extract_rails_root_join_argument_source(node, rails_root_index)
+          node.children[rails_root_index + 1..].map(&:source).join.delete_prefix(File::SEPARATOR)
+        end
+
+        def extension_node?(node)
+          node&.str_type? && node.source.start_with?('.')
+        end
       end
     end
   end

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

@@ -34,7 +34,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[each].freeze
 
         SCOPE_METHODS = %i[
-          all eager_load includes joins left_joins left_outer_joins not preload
+          all eager_load includes joins left_joins left_outer_joins not or preload
           references unscoped where
         ].freeze
 

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

@@ -80,7 +80,11 @@ module RuboCop
         PATTERN
 
         def_node_matcher :flash_assignment?, <<~PATTERN
-          (send (send nil? :flash) :[]= _ $str)
+          (send
+            {
+              (send nil? :flash)
+              (send (send nil? :flash) :now)
+            } :[]= _ $str)
         PATTERN
 
         def_node_search :mail_subject, <<~PATTERN

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

@@ -36,6 +36,10 @@ module RuboCop
       #       if: -> { trusted_origin? && action_name != "admin" }
       #   end
       class IgnoredSkipActionFilterOption < Base
+        extend AutoCorrector
+
+        include RangeHelp
+
         MSG = <<~MSG.chomp.freeze
           `%<ignore>s` option will be ignored when `%<prefer>s` and `%<ignore>s` are used together.
         MSG
@@ -60,9 +64,13 @@ module RuboCop
           options = options_hash(options)
 
           if if_and_only?(options)
-            add_offense(options[:if], message: format(MSG, prefer: :only, ignore: :if))
+            add_offense(options[:if], message: format(MSG, prefer: :only, ignore: :if)) do |corrector|
+              remove_node_with_left_space_and_comma(corrector, options[:if])
+            end
           elsif if_and_except?(options)
-            add_offense(options[:except], message: format(MSG, prefer: :if, ignore: :except))
+            add_offense(options[:except], message: format(MSG, prefer: :if, ignore: :except)) do |corrector|
+              remove_node_with_left_space_and_comma(corrector, options[:except])
+            end
           end
         end
 
@@ -81,6 +89,18 @@ module RuboCop
         def if_and_except?(options)
           options.key?(:if) && options.key?(:except)
         end
+
+        def remove_node_with_left_space_and_comma(corrector, node)
+          corrector.remove(
+            range_with_surrounding_comma(
+              range_with_surrounding_space(
+                node.source_range,
+                side: :left
+              ),
+              :left
+            )
+          )
+        end
       end
     end
   end

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

@@ -176,14 +176,14 @@ module RuboCop
           when :sym
             [node.value]
           when :array
-            node.values.map do |v|
+            node.values.filter_map do |v|
               case v.type
               when :str
                 v.str_content.to_sym
               when :sym
                 v.value
               end
-            end.compact
+            end
           else
             []
           end

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

@@ -45,7 +45,7 @@ module RuboCop
 
         def check_add_column(node)
           add_not_null_column?(node) do |type, pairs|
-            return if type.value == :virtual || type.value == 'virtual'
+            return if type.respond_to?(:value) && (type.value == :virtual || type.value == 'virtual')
 
             check_pairs(pairs)
           end

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

@@ -3,7 +3,6 @@
 module RuboCop
   module Cop
     module Rails
-      #
       # Use `assert_not` methods instead of `refute` methods.
       #
       # @example EnforcedStyle: assert_not (default)

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

@@ -3,7 +3,6 @@
 module RuboCop
   module Cop
     module Rails
-      #
       # Checks SQL heredocs to use `.squish`.
       #
       # @safety

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

@@ -35,7 +35,7 @@ module RuboCop
         PATTERN
 
         def_node_search :change_column_null?, <<~PATTERN
-          (send nil? :change_column_null {(sym %1) (str %1)} {(sym %2) (str %2)} false)
+          (send nil? :change_column_null %1 %2 false)
         PATTERN
 
         def on_send(node)
@@ -46,7 +46,7 @@ module RuboCop
 
             def_node = node.each_ancestor(:def, :defs).first
             table_node = table_node(node)
-            return if def_node && change_column_null?(def_node, table_node.value, column_node.value)
+            return if def_node && (table_node.nil? || change_column_null?(def_node, table_node, column_node))
 
             add_offense(node)
           end

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

@@ -34,6 +34,11 @@ module RuboCop
       #     throw if user.active?
       #   end
       #
+      #   # bad, as `with_lock` implicitly opens a transaction too
+      #   ApplicationRecord.with_lock do
+      #     break if user.active?
+      #   end
+      #
       #   # good
       #   ApplicationRecord.transaction do
       #     # Rollback
@@ -91,7 +96,9 @@ module RuboCop
         end
 
         def nested_block?(statement_node)
-          !statement_node.ancestors.find(&:block_type?).method?(:transaction)
+          block_node = statement_node.ancestors.find(&:block_type?)
+
+          RESTRICT_ON_SEND.none? { |name| block_node.method?(name) }
         end
       end
     end

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

@@ -31,7 +31,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[validates].freeze
 
         def on_send(node)
-          return unless uniqueness_part(node)
+          return if uniqueness_part(node).falsey_literal?
           return if condition_part?(node)
           return unless schema
 

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

@@ -83,21 +83,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)

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.19.0
+  version: 2.20.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-07 00:00:00.000000000 Z
+date: 2023-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -219,7 +219,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.19/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.20/
   bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -230,7 +230,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="