actionmailer 3.2.9 → 6.1.7.6

data/lib/action_mailer/test_helper.rb

@@ -1,45 +1,52 @@
+# frozen_string_literal: true
+
+require "active_job"
+
 module ActionMailer
+  # Provides helper methods for testing Action Mailer, including #assert_emails
+  # and #assert_no_emails.
   module TestHelper
-    extend ActiveSupport::Concern
+    include ActiveJob::TestHelper
 
     # Asserts that the number of emails sent matches the given number.
     #
     #   def test_emails
     #     assert_emails 0
-    #     ContactMailer.deliver_contact
+    #     ContactMailer.welcome.deliver_now
     #     assert_emails 1
-    #     ContactMailer.deliver_contact
+    #     ContactMailer.welcome.deliver_now
     #     assert_emails 2
     #   end
     #
-    # If a block is passed, that block should cause the specified number of emails to be sent.
+    # If a block is passed, that block should cause the specified number of
+    # emails to be sent.
     #
     #   def test_emails_again
     #     assert_emails 1 do
-    #       ContactMailer.deliver_contact
+    #       ContactMailer.welcome.deliver_now
     #     end
     #
     #     assert_emails 2 do
-    #       ContactMailer.deliver_contact
-    #       ContactMailer.deliver_contact
+    #       ContactMailer.welcome.deliver_now
+    #       ContactMailer.welcome.deliver_later
     #     end
     #   end
-    def assert_emails(number)
+    def assert_emails(number, &block)
       if block_given?
         original_count = ActionMailer::Base.deliveries.size
-        yield
+        perform_enqueued_jobs(only: ->(job) { delivery_job_filter(job) }, &block)
         new_count = ActionMailer::Base.deliveries.size
-        assert_equal original_count + number, new_count, "#{number} emails expected, but #{new_count - original_count} were sent"
+        assert_equal number, new_count - original_count, "#{number} emails expected, but #{new_count - original_count} were sent"
       else
         assert_equal number, ActionMailer::Base.deliveries.size
       end
     end
 
-    # Assert that no emails have been sent.
+    # Asserts that no emails have been sent.
     #
     #   def test_emails
     #     assert_no_emails
-    #     ContactMailer.deliver_contact
+    #     ContactMailer.welcome.deliver_now
     #     assert_emails 1
     #   end
     #
@@ -53,9 +60,103 @@ module ActionMailer
     #
     # Note: This assertion is simply a shortcut for:
     #
-    #   assert_emails 0
+    #   assert_emails 0, &block
     def assert_no_emails(&block)
       assert_emails 0, &block
     end
+
+    # Asserts that the number of emails enqueued for later delivery matches
+    # the given number.
+    #
+    #   def test_emails
+    #     assert_enqueued_emails 0
+    #     ContactMailer.welcome.deliver_later
+    #     assert_enqueued_emails 1
+    #     ContactMailer.welcome.deliver_later
+    #     assert_enqueued_emails 2
+    #   end
+    #
+    # If a block is passed, that block should cause the specified number of
+    # emails to be enqueued.
+    #
+    #   def test_emails_again
+    #     assert_enqueued_emails 1 do
+    #       ContactMailer.welcome.deliver_later
+    #     end
+    #
+    #     assert_enqueued_emails 2 do
+    #       ContactMailer.welcome.deliver_later
+    #       ContactMailer.welcome.deliver_later
+    #     end
+    #   end
+    def assert_enqueued_emails(number, &block)
+      assert_enqueued_jobs(number, only: ->(job) { delivery_job_filter(job) }, &block)
+    end
+
+    # Asserts that a specific email has been enqueued, optionally
+    # matching arguments.
+    #
+    #   def test_email
+    #     ContactMailer.welcome.deliver_later
+    #     assert_enqueued_email_with ContactMailer, :welcome
+    #   end
+    #
+    #   def test_email_with_arguments
+    #     ContactMailer.welcome("Hello", "Goodbye").deliver_later
+    #     assert_enqueued_email_with ContactMailer, :welcome, args: ["Hello", "Goodbye"]
+    #   end
+    #
+    # If a block is passed, that block should cause the specified email
+    # to be enqueued.
+    #
+    #   def test_email_in_block
+    #     assert_enqueued_email_with ContactMailer, :welcome do
+    #       ContactMailer.welcome.deliver_later
+    #     end
+    #   end
+    #
+    # If +args+ is provided as a Hash, a parameterized email is matched.
+    #
+    #   def test_parameterized_email
+    #     assert_enqueued_email_with ContactMailer, :welcome,
+    #       args: {email: 'user@example.com'} do
+    #       ContactMailer.with(email: 'user@example.com').welcome.deliver_later
+    #     end
+    #   end
+    def assert_enqueued_email_with(mailer, method, args: nil, queue: ActionMailer::Base.deliver_later_queue_name || "default", &block)
+      args = if args.is_a?(Hash)
+        [mailer.to_s, method.to_s, "deliver_now", params: args, args: []]
+      else
+        [mailer.to_s, method.to_s, "deliver_now", args: Array(args)]
+      end
+      assert_enqueued_with(job: mailer.delivery_job, args: args, queue: queue.to_s, &block)
+    end
+
+    # Asserts that no emails are enqueued for later delivery.
+    #
+    #   def test_no_emails
+    #     assert_no_enqueued_emails
+    #     ContactMailer.welcome.deliver_later
+    #     assert_enqueued_emails 1
+    #   end
+    #
+    # If a block is provided, it should not cause any emails to be enqueued.
+    #
+    #   def test_no_emails
+    #     assert_no_enqueued_emails do
+    #       # No emails should be enqueued from this block
+    #     end
+    #   end
+    def assert_no_enqueued_emails(&block)
+      assert_enqueued_emails 0, &block
+    end
+
+    private
+      def delivery_job_filter(job)
+        job_class = job.is_a?(Hash) ? job.fetch(:job) : job.class
+
+        Base.descendants.map(&:delivery_job).include?(job_class) ||
+          ActionMailer::Parameterized::DeliveryJob == job_class
+      end
   end
 end

data/lib/action_mailer/version.rb

@@ -1,10 +1,11 @@
-module ActionMailer
-  module VERSION #:nodoc:
-    MAJOR = 3
-    MINOR = 2
-    TINY  = 9
-    PRE   = nil
+# frozen_string_literal: true
+
+require_relative "gem_version"
 
-    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+module ActionMailer
+  # Returns the version of the currently loaded Action Mailer as a
+  # <tt>Gem::Version</tt>.
+  def self.version
+    gem_version
   end
 end

data/lib/action_mailer.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #--
-# Copyright (c) 2004-2011 David Heinemeier Hansson
+# Copyright (c) 2004-2022 David Heinemeier Hansson
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,29 +23,49 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-actionpack_path = File.expand_path('../../../actionpack/lib', __FILE__)
-$:.unshift(actionpack_path) if File.directory?(actionpack_path) && !$:.include?(actionpack_path)
-
-require 'abstract_controller'
-require 'action_view'
-require 'action_mailer/version'
+require "abstract_controller"
+require "action_mailer/version"
 
 # Common Active Support usage in Action Mailer
-require 'active_support/core_ext/class'
-require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/array/uniq_by'
-require 'active_support/core_ext/module/attr_internal'
-require 'active_support/core_ext/module/delegation'
-require 'active_support/core_ext/string/inflections'
-require 'active_support/lazy_load_hooks'
+require "active_support"
+require "active_support/rails"
+require "active_support/core_ext/class"
+require "active_support/core_ext/module/attr_internal"
+require "active_support/core_ext/string/inflections"
+require "active_support/lazy_load_hooks"
 
 module ActionMailer
   extend ::ActiveSupport::Autoload
 
-  autoload :Collector
+  eager_autoload do
+    autoload :Collector
+  end
+
   autoload :Base
   autoload :DeliveryMethods
+  autoload :InlinePreviewInterceptor
   autoload :MailHelper
+  autoload :Parameterized
+  autoload :Preview
+  autoload :Previews, "action_mailer/preview"
   autoload :TestCase
   autoload :TestHelper
+  autoload :MessageDelivery
+  autoload :DeliveryJob
+  autoload :MailDeliveryJob
+
+  def self.eager_load!
+    super
+
+    require "action_mailer/mail_with_error_handling"
+    Mail.eager_autoload!
+  end
+end
+
+autoload :Mime, "action_dispatch/http/mime_type"
+
+ActiveSupport.on_load(:action_view) do
+  ActionView::Base.default_formats ||= Mime::SET.symbols
+  ActionView::Template::Types.delegate_to Mime
+  ActionView::LookupContext::DetailsKey.clear
 end

data/lib/rails/generators/mailer/USAGE

@@ -1,6 +1,6 @@
 Description:
 ============
-    Stubs out a new mailer and its views. Pass the mailer name, either
+    Generates a new mailer and its views. Passes the mailer name, either
     CamelCased or under_scored, and an optional list of emails as arguments.
 
     This generates a mailer class in app/mailers and invokes your template
@@ -8,11 +8,9 @@ Description:
 
 Example:
 ========
-    rails generate mailer Notifications signup forgot_password invoice
-
-    creates a Notifications mailer class, views, test, and fixtures:
-        Mailer:     app/mailers/notifications.rb
-        Views:      app/views/notifications/signup.erb [...]
-        Test:       test/functional/notifications_test.rb
-        Fixtures:   test/fixtures/notifications/signup [...]
+    bin/rails generate mailer Notifications signup forgot_password invoice
 
+    creates a Notifications mailer class, views, and test:
+        Mailer:     app/mailers/notifications_mailer.rb
+        Views:      app/views/notifications_mailer/signup.text.erb [...]
+        Test:       test/mailers/notifications_mailer_test.rb

data/lib/rails/generators/mailer/mailer_generator.rb

@@ -1,16 +1,38 @@
+# frozen_string_literal: true
+
 module Rails
   module Generators
     class MailerGenerator < NamedBase
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
+
+      argument :actions, type: :array, default: [], banner: "method method"
 
-      argument :actions, :type => :array, :default => [], :banner => "method method"
-      check_class_collision
+      check_class_collision suffix: "Mailer"
 
       def create_mailer_file
-        template "mailer.rb", File.join('app/mailers', class_path, "#{file_name}.rb")
+        template "mailer.rb", File.join("app/mailers", class_path, "#{file_name}_mailer.rb")
+
+        in_root do
+          if behavior == :invoke && !File.exist?(application_mailer_file_name)
+            template "application_mailer.rb", application_mailer_file_name
+          end
+        end
       end
 
       hook_for :template_engine, :test_framework
+
+      private
+        def file_name # :doc:
+          @_file_name ||= super.sub(/_mailer\z/i, "")
+        end
+
+        def application_mailer_file_name
+          @_application_mailer_file_name ||= if mountable_engine?
+            "app/mailers/#{namespaced_path}/application_mailer.rb"
+          else
+            "app/mailers/application_mailer.rb"
+          end
+        end
     end
   end
 end

data/lib/rails/generators/mailer/templates/application_mailer.rb.tt

@@ -0,0 +1,6 @@
+<% module_namespacing do -%>
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end
+<% end %>

data/lib/rails/generators/mailer/templates/{mailer.rb → mailer.rb.tt}

@@ -1,17 +1,16 @@
 <% module_namespacing do -%>
-class <%= class_name %> < ActionMailer::Base
-  default <%= key_value :from, '"from@example.com"' %>
+class <%= class_name %>Mailer < ApplicationMailer
 <% actions.each do |action| -%>
 
   # Subject can be set in your I18n file at config/locales/en.yml
   # with the following lookup:
   #
-  #   en.<%= file_path.gsub("/",".") %>.<%= action %>.subject
+  #   en.<%= file_path.tr("/",".") %>_mailer.<%= action %>.subject
   #
   def <%= action %>
     @greeting = "Hi"
 
-    mail <%= key_value :to, '"to@example.org"' %>
+    mail to: "to@example.org"
   end
 <% end -%>
 end

metadata

@@ -1,97 +1,166 @@
 --- !ruby/object:Gem::Specification
 name: actionmailer
 version: !ruby/object:Gem::Version
-  version: 3.2.9
-  prerelease: 
+  version: 6.1.7.6
 platform: ruby
 authors:
 - David Heinemeier Hansson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2023-08-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.7.6
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.9
+        version: 6.1.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.7.6
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.7.6
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.9
+        version: 6.1.7.6
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.4
+        version: 2.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.4
-description: Email on Rails. Compose, deliver, receive, and test emails using the
-  familiar controller/view pattern. First-class support for multipart email and attachments.
+        version: 2.5.4
+- !ruby/object:Gem::Dependency
+  name: rails-dom-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Email on Rails. Compose, deliver, and test emails using the familiar
+  controller/view pattern. First-class support for multipart email and attachments.
 email: david@loudthinking.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- README.rdoc
 - MIT-LICENSE
+- README.rdoc
+- lib/action_mailer.rb
 - lib/action_mailer/base.rb
 - lib/action_mailer/collector.rb
+- lib/action_mailer/delivery_job.rb
 - lib/action_mailer/delivery_methods.rb
+- lib/action_mailer/gem_version.rb
+- lib/action_mailer/inline_preview_interceptor.rb
 - lib/action_mailer/log_subscriber.rb
+- lib/action_mailer/mail_delivery_job.rb
 - lib/action_mailer/mail_helper.rb
+- lib/action_mailer/mail_with_error_handling.rb
+- lib/action_mailer/message_delivery.rb
+- lib/action_mailer/parameterized.rb
+- lib/action_mailer/preview.rb
 - lib/action_mailer/railtie.rb
+- lib/action_mailer/rescuable.rb
 - lib/action_mailer/test_case.rb
 - lib/action_mailer/test_helper.rb
 - lib/action_mailer/version.rb
-- lib/action_mailer.rb
-- lib/rails/generators/mailer/mailer_generator.rb
-- lib/rails/generators/mailer/templates/mailer.rb
 - lib/rails/generators/mailer/USAGE
-homepage: http://www.rubyonrails.org
-licenses: []
-post_install_message: 
+- lib/rails/generators/mailer/mailer_generator.rb
+- lib/rails/generators/mailer/templates/application_mailer.rb.tt
+- lib/rails/generators/mailer/templates/mailer.rb.tt
+homepage: https://rubyonrails.org
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/rails/rails/issues
+  changelog_uri: https://github.com/rails/rails/blob/v6.1.7.6/actionmailer/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v6.1.7.6/
+  mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
+  source_code_uri: https://github.com/rails/rails/tree/v6.1.7.6/actionmailer
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 125340086147061464
 requirements:
 - none
-rubyforge_project: 
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
-summary: Email composition, delivery, and receiving framework (part of Rails).
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Email composition and delivery framework (part of Rails).
 test_files: []