active_support_on_load.rb

# frozen_string_literal: true

module RuboCop
  module Cop
    module Rails
      # Use Active Support lazy load hooks to patch Rails core classes, so they are not forcibly loaded early.
      #
      # @example
      #
      #   # bad
      #   ActiveRecord::Base.include(MyClass)
      #
      #   # good
      #   ActiveSupport.on_load(:active_record) { include MyClass }
      class ActiveSupportOnLoad < Base
        extend AutoCorrector

        AUTOCORRECTABLE_CLASSES = {
          'ActiveRecord::Base' => 'active_record',
          'ActionController::Base' => 'action_controller',
          'ActiveJob::Base' => 'active_job',
          'ActionView::Base' => 'action_view',
          'ActionMailer::Base' => 'action_mailer',
          'ActionController::TestCase' => 'action_controller_test_case',
          'ActiveSupport::TestCase' => 'active_support_test_case',
          'ActiveJob::TestCase' => 'active_job_test_case',
          'ActionDispatch::IntegrationTest' => 'action_dispatch_integration_test',
          'ActionMailer::TestCase' => 'action_mailer_test_case'
        }.freeze
        RESTRICT_ON_SEND = %i[prepend include extend].freeze
        MSG = 'Use `%<prefer>s` instead of `%<current>s`.'

        def on_send(node)
          receiver, method, arguments = *node # rubocop:disable InternalAffairs/NodeDestructuring
          return unless receiver && AUTOCORRECTABLE_CLASSES.key?(receiver.const_name)

          hook_name = AUTOCORRECTABLE_CLASSES[receiver.const_name]
          preferred = "ActiveSupport.on_load(:#{hook_name}) { #{method} #{arguments.source} }"

          add_offense(node, message: format(MSG, prefer: preferred, current: node.source)) do |corrector|
            corrector.replace(node, preferred)
          end
        end
      end
    end
  end
end