application_mailer.rb

# frozen_string_literal: true

module RuboCop
  module Cop
    module Rails
      # Checks that mailers subclass `ApplicationMailer` with Rails 5.0.
      #
      # @safety
      #   This cop's autocorrection is unsafe because it may let the logic from `ApplicationMailer`
      #   sneak into a mailer that is not purposed to inherit logic common among other mailers.
      #
      # @example
      #
      #  # good
      #  class MyMailer < ApplicationMailer
      #    # ...
      #  end
      #
      #  # bad
      #  class MyMailer < ActionMailer::Base
      #    # ...
      #  end
      class ApplicationMailer < Base
        extend AutoCorrector
        extend TargetRailsVersion

        minimum_target_rails_version 5.0

        MSG = 'Mailers should subclass `ApplicationMailer`.'
        SUPERCLASS = 'ApplicationMailer'
        BASE_PATTERN = '(const (const {nil? cbase} :ActionMailer) :Base)'

        # rubocop:disable Layout/ClassStructure
        include RuboCop::Cop::EnforceSuperclass
        # rubocop:enable Layout/ClassStructure
      end
    end
  end
end