rubocop-rails 2.13.1 → 2.14.1

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks for places where I18n "lazy" lookup can be used.
+      #
+      # @example
+      #   # en.yml
+      #   # en:
+      #   #   books:
+      #   #     create:
+      #   #       success: Book created!
+      #
+      #   # bad
+      #   class BooksController < ApplicationController
+      #     def create
+      #       # ...
+      #       redirect_to books_url, notice: t('books.create.success')
+      #     end
+      #   end
+      #
+      #   # good
+      #   class BooksController < ApplicationController
+      #     def create
+      #       # ...
+      #       redirect_to books_url, notice: t('.success')
+      #     end
+      #   end
+      #
+      class I18nLazyLookup < Base
+        include VisibilityHelp
+        extend AutoCorrector
+
+        MSG = 'Use "lazy" lookup for the text used in controllers.'
+
+        def_node_matcher :translate_call?, <<~PATTERN
+          (send nil? {:translate :t} ${sym_type? str_type?} ...)
+        PATTERN
+
+        def on_send(node)
+          translate_call?(node) do |key_node|
+            key = key_node.value
+            return if key.to_s.start_with?('.')
+
+            controller, action = controller_and_action(node)
+            return unless controller && action
+
+            scoped_key = get_scoped_key(key_node, controller, action)
+            return unless key == scoped_key
+
+            add_offense(key_node) do |corrector|
+              unscoped_key = key_node.value.to_s.split('.').last
+              corrector.replace(key_node, "'.#{unscoped_key}'")
+            end
+          end
+        end
+
+        private
+
+        def controller_and_action(node)
+          action_node = node.each_ancestor(:def).first
+          return unless action_node && node_visibility(action_node) == :public
+
+          controller_node = node.each_ancestor(:class).first
+          return unless controller_node && controller_node.identifier.source.end_with?('Controller')
+
+          [controller_node, action_node]
+        end
+
+        def get_scoped_key(key_node, controller, action)
+          path = controller_path(controller).tr('/', '.')
+          action_name = action.method_name
+          key = key_node.value.to_s.split('.').last
+
+          "#{path}.#{action_name}.#{key}"
+        end
+
+        def controller_path(controller)
+          module_name = controller.parent_module_name
+          controller_name = controller.identifier.source
+
+          path = if module_name == 'Object'
+                   controller_name
+                 else
+                   "#{module_name}::#{controller_name}"
+                 end
+
+          path.delete_suffix('Controller').underscore
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Enforces use of I18n and locale files instead of locale specific strings.
+      #
+      # @example
+      #   # bad
+      #   class User < ApplicationRecord
+      #     validates :email, presence: { message: "must be present" }
+      #   end
+      #
+      #   # good
+      #   # config/locales/en.yml
+      #   # en:
+      #   #   activerecord:
+      #   #     errors:
+      #   #       models:
+      #   #         user:
+      #   #           blank: "must be present"
+      #
+      #   class User < ApplicationRecord
+      #     validates :email, presence: true
+      #   end
+      #
+      #   # bad
+      #   class PostsController < ApplicationController
+      #     def create
+      #       # ...
+      #       redirect_to root_path, notice: "Post created!"
+      #     end
+      #   end
+      #
+      #   # good
+      #   # config/locales/en.yml
+      #   # en:
+      #   #   posts:
+      #   #     create:
+      #   #       success: "Post created!"
+      #
+      #   class PostsController < ApplicationController
+      #     def create
+      #       # ...
+      #       redirect_to root_path, notice: t(".success")
+      #     end
+      #   end
+      #
+      #   # bad
+      #   class UserMailer < ApplicationMailer
+      #     def welcome(user)
+      #       mail(to: user.email, subject: "Welcome to My Awesome Site")
+      #     end
+      #   end
+      #
+      #   # good
+      #   # config/locales/en.yml
+      #   # en:
+      #   #   user_mailer:
+      #   #     welcome:
+      #   #       subject: "Welcome to My Awesome Site"
+      #
+      #   class UserMailer < ApplicationMailer
+      #     def welcome(user)
+      #       mail(to: user.email)
+      #     end
+      #   end
+      #
+      class I18nLocaleTexts < Base
+        MSG = 'Move locale texts to the locale files in the `config/locales` directory.'
+
+        RESTRICT_ON_SEND = %i[validates redirect_to []= mail].freeze
+
+        def_node_search :validation_message, <<~PATTERN
+          (pair (sym :message) $str)
+        PATTERN
+
+        def_node_search :redirect_to_flash, <<~PATTERN
+          (pair (sym {:notice :alert}) $str)
+        PATTERN
+
+        def_node_matcher :flash_assignment?, <<~PATTERN
+          (send (send nil? :flash) :[]= _ $str)
+        PATTERN
+
+        def_node_search :mail_subject, <<~PATTERN
+          (pair (sym :subject) $str)
+        PATTERN
+
+        def on_send(node)
+          case node.method_name
+          when :validates
+            validation_message(node) do |text_node|
+              add_offense(text_node)
+            end
+            return
+          when :redirect_to
+            text_node = redirect_to_flash(node).to_a.last
+          when :[]=
+            text_node = flash_assignment?(node)
+          when :mail
+            text_node = mail_subject(node).to_a.last
+          end
+
+          add_offense(text_node) if text_node
+        end
+      end
+    end
+  end
+end

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

@@ -126,6 +126,18 @@ module RuboCop
       #     has_many :physicians, through: :appointments
       #   end
       #
+      # @example IgnoreScopes: false (default)
+      #   # bad
+      #   class Blog < ApplicationRecord
+      #     has_many :posts, -> { order(published_at: :desc) }
+      #   end
+      #
+      # @example IgnoreScopes: true
+      #   # good
+      #   class Blog < ApplicationRecord
+      #     has_many :posts, -> { order(published_at: :desc) }
+      #   end
+      #
       # @see https://guides.rubyonrails.org/association_basics.html#bi-directional-associations
       # @see https://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#module-ActiveRecord::Associations::ClassMethods-label-Setting+Inverses
       class InverseOf < Base
@@ -189,7 +201,7 @@ module RuboCop
         end
 
         def scope?(arguments)
-          arguments.any?(&:block_type?)
+          !ignore_scopes? && arguments.any?(&:block_type?)
         end
 
         def options_requiring_inverse_of?(options)
@@ -236,6 +248,10 @@ module RuboCop
             SPECIFY_MSG
           end
         end
+
+        def ignore_scopes?
+          cop_config['IgnoreScopes'] == true
+        end
       end
     end
   end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop makes sure that each migration file defines a migration class
+      # whose name matches the file name.
+      # (e.g. `20220224111111_create_users.rb` should define `CreateUsers` class.)
+      #
+      # @example
+      #   # db/migrate/20220224111111_create_users.rb
+      #
+      #   # bad
+      #   class SellBooks < ActiveRecord::Migration[7.0]
+      #   end
+      #
+      #   # good
+      #   class CreateUsers < ActiveRecord::Migration[7.0]
+      #   end
+      #
+      class MigrationClassName < Base
+        extend AutoCorrector
+        include MigrationsHelper
+
+        MSG = 'Replace with `%<corrected_class_name>s` that matches the file name.'
+
+        def on_class(node)
+          return if in_migration?(node)
+
+          snake_class_name = to_snakecase(node.identifier.source)
+
+          basename = basename_without_timestamp_and_suffix
+          return if snake_class_name == basename
+
+          corrected_class_name = to_camelcase(basename)
+          message = format(MSG, corrected_class_name: corrected_class_name)
+
+          add_offense(node.identifier, message: message) do |corrector|
+            corrector.replace(node.identifier, corrected_class_name)
+          end
+        end
+
+        private
+
+        def basename_without_timestamp_and_suffix
+          filepath = processed_source.file_path
+          basename = File.basename(filepath, '.rb')
+          basename = remove_gem_suffix(basename)
+          basename.sub(/\A\d+_/, '')
+        end
+
+        # e.g.: from `add_blobs.active_storage` to `add_blobs`.
+        def remove_gem_suffix(file_name)
+          file_name.sub(/\..+\z/, '')
+        end
+
+        def to_camelcase(word)
+          word.split('_').map(&:capitalize).join
+        end
+
+        def to_snakecase(word)
+          word
+            .gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr('-', '_')
+            .downcase
+        end
+      end
+    end
+  end
+end

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

@@ -21,25 +21,31 @@ module RuboCop
         extend AutoCorrector
         extend TargetRailsVersion
 
-        MSG = 'Prefer `pluck(:%<value>s)` over `%<method>s { |%<argument>s| %<element>s[:%<value>s] }`.'
+        MSG = 'Prefer `pluck(:%<value>s)` over `%<current>s`.'
 
         minimum_target_rails_version 5.0
 
         def_node_matcher :pluck_candidate?, <<~PATTERN
-          (block (send _ ${:map :collect}) (args (arg $_argument)) (send (lvar $_element) :[] (sym $_value)))
+          ({block numblock} (send _ {:map :collect}) $_argument (send (lvar $_element) :[] (sym $_value)))
         PATTERN
 
         def on_block(node)
-          pluck_candidate?(node) do |method, argument, element, value|
-            next unless argument == element
+          pluck_candidate?(node) do |argument, element, value|
+            match = if node.block_type?
+                      argument.children.first.source.to_sym == element
+                    else # numblock
+                      argument == 1 && element == :_1
+                    end
+            next unless match
 
-            message = message(method, argument, element, value)
+            message = message(value, node)
 
             add_offense(offense_range(node), message: message) do |corrector|
               corrector.replace(offense_range(node), "pluck(:#{value})")
             end
           end
         end
+        alias on_numblock on_block
 
         private
 
@@ -47,8 +53,10 @@ module RuboCop
           node.send_node.loc.selector.join(node.loc.end)
         end
 
-        def message(method, argument, element, value)
-          format(MSG, method: method, argument: argument, element: element, value: value)
+        def message(value, node)
+          current = offense_range(node).source
+
+          format(MSG, value: value, current: current)
         end
       end
     end

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

@@ -37,7 +37,7 @@ module RuboCop
       class ReadWriteAttribute < Base
         extend AutoCorrector
 
-        MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
+        MSG = 'Prefer `%<prefer>s`.'
         RESTRICT_ON_SEND = %i[read_attribute write_attribute].freeze
 
         def_node_matcher :read_write_attribute?, <<~PATTERN
@@ -51,35 +51,51 @@ module RuboCop
           return unless read_write_attribute?(node)
           return if within_shadowing_method?(node)
 
-          add_offense(node.loc.selector, message: message(node)) do |corrector|
-            case node.method_name
-            when :read_attribute
-              replacement = read_attribute_replacement(node)
-            when :write_attribute
-              replacement = write_attribute_replacement(node)
-            end
-
-            corrector.replace(node.source_range, replacement)
+          add_offense(node, message: build_message(node)) do |corrector|
+            corrector.replace(node.source_range, node_replacement(node))
           end
         end
 
         private
 
         def within_shadowing_method?(node)
-          node.each_ancestor(:def).any? do |enclosing_method|
-            shadowing_method_name = node.first_argument.value.to_s
-            shadowing_method_name << '=' if node.method?(:write_attribute)
+          first_arg = node.first_argument
+          return false unless first_arg.respond_to?(:value)
+
+          enclosing_method = node.each_ancestor(:def).first
+          return false unless enclosing_method
 
-            enclosing_method.method_name.to_s == shadowing_method_name
+          shadowing_method_name = first_arg.value.to_s
+          shadowing_method_name << '=' if node.method?(:write_attribute)
+          enclosing_method.method?(shadowing_method_name)
+        end
+
+        def build_message(node)
+          if node.single_line?
+            single_line_message(node)
+          else
+            multi_line_message(node)
           end
         end
 
-        def message(node)
+        def single_line_message(node)
+          format(MSG, prefer: node_replacement(node))
+        end
+
+        def multi_line_message(node)
           if node.method?(:read_attribute)
-            format(MSG, prefer: 'self[:attr]', current: 'read_attribute(:attr)')
+            format(MSG, prefer: 'self[:attr]')
           else
-            format(MSG, prefer: 'self[:attr] = val',
-                        current: 'write_attribute(:attr, val)')
+            format(MSG, prefer: 'self[:attr] = val')
+          end
+        end
+
+        def node_replacement(node)
+          case node.method_name
+          when :read_attribute
+            read_attribute_replacement(node)
+          when :write_attribute
+            write_attribute_replacement(node)
           end
         end
 

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
@@ -46,9 +50,6 @@ module RuboCop
         #   @example source that matches - by association
         #     validates :name, :user, presence: true
         #
-        #   @example source that matches - with presence options
-        #     validates :user, presence: { message: 'duplicate' }
-        #
         #   @example source that matches - by a foreign key
         #     validates :user_id, presence: true
         #
@@ -62,7 +63,7 @@ module RuboCop
             send nil? :validates
             (sym $_)+
             $[
-              (hash <$(pair (sym :presence) {true hash}) ...>)  # presence: true
+              (hash <$(pair (sym :presence) true) ...>)         # presence: true
               !(hash <$(pair (sym :strict) {true const}) ...>)  # strict: true
             ]
           )

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

@@ -176,6 +176,8 @@ 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
@@ -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