rubocop-rails 2.13.0 → 2.14.0

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

@@ -8,6 +8,10 @@ module RuboCop
       # explicitly set to `false`. The presence validator is added
       # automatically, and explicit presence validation is redundant.
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because it changes the default error message
+      #   from "can't be blank" to "must exist".
+      #
       # @example
       #   # bad
       #   belongs_to :user
@@ -32,7 +36,7 @@ module RuboCop
         extend AutoCorrector
         extend TargetRailsVersion
 
-        MSG = 'Remove explicit presence validation for `%<association>s`.'
+        MSG = 'Remove explicit presence validation for %<association>s.'
         RESTRICT_ON_SEND = %i[validates].freeze
 
         minimum_target_rails_version 5.0
@@ -43,28 +47,36 @@ module RuboCop
         #   @example source that matches - by association
         #     validates :user, presence: true
         #
-        #   @example source that matches - with presence options
-        #     validates :user, presence: { message: 'duplicate' }
+        #   @example source that matches - by association
+        #     validates :name, :user, presence: true
         #
         #   @example source that matches - by a foreign key
         #     validates :user_id, presence: true
+        #
+        #   @example source that DOES NOT match - strict validation
+        #     validates :user_id, presence: true, strict: true
+        #
+        #   @example source that DOES NOT match - custom strict validation
+        #     validates :user_id, presence: true, strict: MissingUserError
         def_node_matcher :presence_validation?, <<~PATTERN
-          $(
+          (
             send nil? :validates
-            (sym $_)
-            ...
-            $(hash <$(pair (sym :presence) {true hash}) ...>)
+            (sym $_)+
+            $[
+              (hash <$(pair (sym :presence) true) ...>)         # presence: true
+              !(hash <$(pair (sym :strict) {true const}) ...>)  # strict: true
+            ]
           )
         PATTERN
 
-        # @!method optional_option?(node)
-        #  Match a `belongs_to` association with an optional option in a hash
+        # @!method optional?(node)
+        #   Match a `belongs_to` association with an optional option in a hash
         def_node_matcher :optional?, <<~PATTERN
           (send nil? :belongs_to _ ... #optional_option?)
         PATTERN
 
         # @!method optional_option?(node)
-        #  Match an optional option in a hash
+        #   Match an optional option in a hash
         def_node_matcher :optional_option?, <<~PATTERN
           {
             (hash <(pair (sym :optional) true) ...>)   # optional: true
@@ -122,7 +134,7 @@ module RuboCop
           )
         PATTERN
 
-        # @!method belongs_to_without_fk?(node, fk)
+        # @!method belongs_to_without_fk?(node, key)
         #   Match a matching `belongs_to` association, without an explicit `foreign_key` option
         #
         #   @param node [RuboCop::AST::Node]
@@ -150,21 +162,43 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          validation, key, options, presence = presence_validation?(node)
-          return unless validation
+          presence_validation?(node) do |all_keys, options, presence|
+            keys = non_optional_belongs_to(node.parent, all_keys)
+            return if keys.none?
 
-          belongs_to = belongs_to_for(node.parent, key)
-          return unless belongs_to
-          return if optional?(belongs_to)
+            add_offense_and_correct(node, all_keys, keys, options, presence)
+          end
+        end
 
-          message = format(MSG, association: key.to_s)
+        private
 
-          add_offense(presence, message: message) do |corrector|
-            remove_presence_validation(corrector, node, options, presence)
+        def add_offense_and_correct(node, all_keys, keys, options, presence)
+          add_offense(presence, message: message_for(keys)) do |corrector|
+            if options.children.one? # `presence: true` is the only option
+              if keys == all_keys
+                remove_validation(corrector, node)
+              else
+                remove_keys_from_validation(corrector, node, keys)
+              end
+            elsif keys == all_keys
+              remove_presence_option(corrector, presence)
+            else
+              extract_validation_for_keys(corrector, node, keys, options)
+            end
           end
         end
 
-        private
+        def message_for(keys)
+          display_keys = keys.map { |key| "`#{key}`" }.join('/')
+          format(MSG, association: display_keys)
+        end
+
+        def non_optional_belongs_to(node, keys)
+          keys.select do |key|
+            belongs_to = belongs_to_for(node, key)
+            belongs_to && !optional?(belongs_to)
+          end
+        end
 
         def belongs_to_for(model_class_node, key)
           if key.to_s.end_with?('_id')
@@ -175,17 +209,48 @@ module RuboCop
           end
         end
 
-        def remove_presence_validation(corrector, node, options, presence)
-          if options.children.one?
-            corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
-          else
-            range = range_with_surrounding_comma(
-              range_with_surrounding_space(range: presence.source_range, side: :left),
-              :left
+        def remove_validation(corrector, node)
+          corrector.remove(validation_range(node))
+        end
+
+        def remove_keys_from_validation(corrector, node, keys)
+          keys.each do |key|
+            key_node = node.arguments.find { |arg| arg.value == key }
+            key_range = range_with_surrounding_space(
+              range: range_with_surrounding_comma(key_node.source_range, :right),
+              side: :right
             )
-            corrector.remove(range)
+            corrector.remove(key_range)
           end
         end
+
+        def remove_presence_option(corrector, presence)
+          range = range_with_surrounding_comma(
+            range_with_surrounding_space(range: presence.source_range, side: :left),
+            :left
+          )
+          corrector.remove(range)
+        end
+
+        def extract_validation_for_keys(corrector, node, keys, options)
+          indentation = ' ' * node.source_range.column
+          options_without_presence = options.children.reject { |pair| pair.key.value == :presence }
+          source = [
+            indentation,
+            'validates ',
+            keys.map(&:inspect).join(', '),
+            ', ',
+            options_without_presence.map(&:source).join(', '),
+            "\n"
+          ].join
+
+          remove_keys_from_validation(corrector, node, keys)
+          corrector.insert_after(validation_range(node), source)
+        end
+
+        def validation_range(node)
+          range_by_whole_lines(node.source_range, include_final_newline: true)
+        end
       end
     end
   end

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

@@ -176,10 +176,12 @@ module RuboCop
       #
       # @see https://api.rubyonrails.org/classes/ActiveRecord/Migration/CommandRecorder.html
       class ReversibleMigration < Base
+        include MigrationsHelper
+
         MSG = '%<action>s is not reversible.'
 
         def_node_matcher :irreversible_schema_statement_call, <<~PATTERN
-          (send nil? ${:change_column :execute :remove_belongs_to :remove_reference} ...)
+          (send nil? ${:change_column :execute} ...)
         PATTERN
 
         def_node_matcher :drop_table_call, <<~PATTERN
@@ -207,7 +209,7 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return unless within_change_method?(node)
+          return unless in_migration?(node) && within_change_method?(node)
           return if within_reversible_or_up_only_block?(node)
 
           check_irreversible_schema_statement_node(node)
@@ -220,7 +222,7 @@ module RuboCop
         end
 
         def on_block(node)
-          return unless within_change_method?(node)
+          return unless in_migration?(node) && within_change_method?(node)
           return if within_reversible_or_up_only_block?(node)
           return if node.body.nil?
 

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

@@ -43,19 +43,11 @@ module RuboCop
       #     end
       #   end
       class ReversibleMigrationMethodDefinition < Base
+        include MigrationsHelper
+
         MSG = 'Migrations must contain either a `change` method, or ' \
               'both an `up` and a `down` method.'
 
-        def_node_matcher :migration_class?, <<~PATTERN
-          (class
-            (const nil? _)
-            (send
-              (const (const {nil? cbase} :ActiveRecord) :Migration)
-              :[]
-              (float _))
-            _)
-        PATTERN
-
         def_node_matcher :change_method?, <<~PATTERN
           [ #migration_class? `(def :change (args) _) ]
         PATTERN

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop enforces the absence of explicit table name assignment.
+      #
+      # `self.table_name=` should only be used for very good reasons,
+      # such as not having control over the database, or working
+      # on a legacy project.
+      #
+      # If you need to change how your model's name is translated to
+      # a table name, you may want to look at Inflections:
+      # https://api.rubyonrails.org/classes/ActiveSupport/Inflector/Inflections.html
+      #
+      # If you wish to add a prefix in front of your model, or wish to change
+      # the default prefix, `self.table_name_prefix` might better suit your needs:
+      # https://api.rubyonrails.org/classes/ActiveRecord/ModelSchema.html#method-c-table_name_prefix-3D
+      #
+      # STI base classes named `Base` are ignored by this cop.
+      # For more information: https://api.rubyonrails.org/classes/ActiveRecord/Inheritance.html
+      #
+      # @example
+      #   # bad
+      #   self.table_name = 'some_table_name'
+      #   self.table_name = :some_other_name
+      class TableNameAssignment < Base
+        include ActiveRecordHelper
+
+        MSG = 'Do not use `self.table_name =`.'
+
+        def_node_matcher :base_class?, <<~PATTERN
+          (class (const ... :Base) ...)
+        PATTERN
+
+        def on_class(class_node)
+          return if base_class?(class_node)
+
+          find_set_table_name(class_node).each { |node| add_offense(node) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks for the use of exit statements (namely `return`,
+      # `break` and `throw`) in transactions. This is due to the eventual
+      # unexpected behavior when using ActiveRecord >= 7, where transactions
+      # exitted using these statements are being rollbacked rather than
+      # committed (pre ActiveRecord 7 behavior).
+      #
+      # As alternatives, it would be more intuitive to explicitly raise an
+      # error when rollback is desired, and to use `next` when commit is
+      # desired.
+      #
+      # @example
+      #   # bad
+      #   ApplicationRecord.transaction do
+      #     return if user.active?
+      #   end
+      #
+      #   # bad
+      #   ApplicationRecord.transaction do
+      #     break if user.active?
+      #   end
+      #
+      #   # bad
+      #   ApplicationRecord.transaction do
+      #     throw if user.active?
+      #   end
+      #
+      #   # good
+      #   ApplicationRecord.transaction do
+      #     # Rollback
+      #     raise "User is active" if user.active?
+      #   end
+      #
+      #   # good
+      #   ApplicationRecord.transaction do
+      #     # Commit
+      #     next if user.active?
+      #   end
+      #
+      # @see https://github.com/rails/rails/commit/15aa4200e083
+      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].freeze
+
+        def_node_search :exit_statements, <<~PATTERN
+          ({return | break | send nil? :throw} ...)
+        PATTERN
+
+        def on_send(node)
+          parent = node.parent
+
+          return unless parent&.block_type?
+
+          exit_statements(parent.body).each do |statement_node|
+            statement = if statement_node.return_type?
+                          'return'
+                        elsif statement_node.break_type?
+                          'break'
+                        else
+                          statement_node.method_name
+                        end
+            message = format(MSG, statement: statement)
+
+            add_offense(statement_node, message: message)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -61,6 +61,8 @@ module RuboCop
 
         def table(node)
           klass = class_node(node)
+          return unless klass
+
           schema.table_by(name: table_name(klass))
         end
       end

data/lib/rubocop/cop/rails_cops.rb

@@ -2,10 +2,13 @@
 
 require_relative 'mixin/active_record_helper'
 require_relative 'mixin/active_record_migrations_helper'
+require_relative 'mixin/class_send_node_helper'
 require_relative 'mixin/enforce_superclass'
 require_relative 'mixin/index_method'
+require_relative 'mixin/migrations_helper'
 require_relative 'mixin/target_rails_version'
 
+require_relative 'rails/action_controller_test_case'
 require_relative 'rails/action_filter'
 require_relative 'rails/active_record_aliases'
 require_relative 'rails/active_record_callbacks_order'
@@ -30,6 +33,9 @@ require_relative 'rails/date'
 require_relative 'rails/default_scope'
 require_relative 'rails/delegate'
 require_relative 'rails/delegate_allow_blank'
+require_relative 'rails/deprecated_active_model_errors_methods'
+require_relative 'rails/duplicate_association'
+require_relative 'rails/duplicate_scope'
 require_relative 'rails/duration_arithmetic'
 require_relative 'rails/dynamic_find_by'
 require_relative 'rails/eager_evaluation_log_message'
@@ -48,7 +54,9 @@ require_relative 'rails/has_many_or_has_one_dependent'
 require_relative 'rails/helper_instance_variable'
 require_relative 'rails/http_positional_arguments'
 require_relative 'rails/http_status'
+require_relative 'rails/i18n_lazy_lookup'
 require_relative 'rails/i18n_locale_assignment'
+require_relative 'rails/i18n_locale_texts'
 require_relative 'rails/ignored_skip_action_filter_option'
 require_relative 'rails/index_by'
 require_relative 'rails/index_with'
@@ -58,6 +66,7 @@ require_relative 'rails/lexically_scoped_action_filter'
 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/negate_include'
 require_relative 'rails/not_null_column'
 require_relative 'rails/order_by_id'
@@ -95,8 +104,10 @@ require_relative 'rails/scope_args'
 require_relative 'rails/short_i18n'
 require_relative 'rails/skips_model_validations'
 require_relative 'rails/squished_sql_heredocs'
+require_relative 'rails/table_name_assignment'
 require_relative 'rails/time_zone'
 require_relative 'rails/time_zone_assignment'
+require_relative 'rails/transaction_exit_statement'
 require_relative 'rails/uniq_before_pluck'
 require_relative 'rails/unique_validation_without_index'
 require_relative 'rails/unknown_env'

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.13.0'
+      STRING = '2.14.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.13.0
+  version: 2.14.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-25 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -79,9 +79,12 @@ files:
 - lib/rubocop-rails.rb
 - 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/enforce_superclass.rb
 - lib/rubocop/cop/mixin/index_method.rb
+- lib/rubocop/cop/mixin/migrations_helper.rb
 - lib/rubocop/cop/mixin/target_rails_version.rb
+- lib/rubocop/cop/rails/action_controller_test_case.rb
 - lib/rubocop/cop/rails/action_filter.rb
 - lib/rubocop/cop/rails/active_record_aliases.rb
 - lib/rubocop/cop/rails/active_record_callbacks_order.rb
@@ -106,6 +109,9 @@ files:
 - lib/rubocop/cop/rails/default_scope.rb
 - lib/rubocop/cop/rails/delegate.rb
 - lib/rubocop/cop/rails/delegate_allow_blank.rb
+- lib/rubocop/cop/rails/deprecated_active_model_errors_methods.rb
+- lib/rubocop/cop/rails/duplicate_association.rb
+- lib/rubocop/cop/rails/duplicate_scope.rb
 - lib/rubocop/cop/rails/duration_arithmetic.rb
 - lib/rubocop/cop/rails/dynamic_find_by.rb
 - lib/rubocop/cop/rails/eager_evaluation_log_message.rb
@@ -124,7 +130,9 @@ files:
 - lib/rubocop/cop/rails/helper_instance_variable.rb
 - lib/rubocop/cop/rails/http_positional_arguments.rb
 - lib/rubocop/cop/rails/http_status.rb
+- lib/rubocop/cop/rails/i18n_lazy_lookup.rb
 - lib/rubocop/cop/rails/i18n_locale_assignment.rb
+- lib/rubocop/cop/rails/i18n_locale_texts.rb
 - lib/rubocop/cop/rails/ignored_skip_action_filter_option.rb
 - lib/rubocop/cop/rails/index_by.rb
 - lib/rubocop/cop/rails/index_with.rb
@@ -134,6 +142,7 @@ files:
 - lib/rubocop/cop/rails/link_to_blank.rb
 - lib/rubocop/cop/rails/mailer_name.rb
 - lib/rubocop/cop/rails/match_route.rb
+- lib/rubocop/cop/rails/migration_class_name.rb
 - lib/rubocop/cop/rails/negate_include.rb
 - lib/rubocop/cop/rails/not_null_column.rb
 - lib/rubocop/cop/rails/order_by_id.rb
@@ -171,8 +180,10 @@ files:
 - lib/rubocop/cop/rails/short_i18n.rb
 - lib/rubocop/cop/rails/skips_model_validations.rb
 - lib/rubocop/cop/rails/squished_sql_heredocs.rb
+- lib/rubocop/cop/rails/table_name_assignment.rb
 - lib/rubocop/cop/rails/time_zone.rb
 - lib/rubocop/cop/rails/time_zone_assignment.rb
+- lib/rubocop/cop/rails/transaction_exit_statement.rb
 - lib/rubocop/cop/rails/uniq_before_pluck.rb
 - lib/rubocop/cop/rails/unique_validation_without_index.rb
 - lib/rubocop/cop/rails/unknown_env.rb
@@ -194,7 +205,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.13/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.14/
   bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -212,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Automatic Rails code style checking tool.