omg-actionmailer 8.0.0.alpha2

data/lib/action_mailer/test_helper.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/array/extract_options"
+require "active_job"
+
+module ActionMailer
+  # Provides helper methods for testing Action Mailer, including #assert_emails
+  # and #assert_no_emails.
+  module TestHelper
+    include ActiveJob::TestHelper
+
+    # Asserts that the number of emails sent matches the given number.
+    #
+    #   def test_emails
+    #     assert_emails 0
+    #     ContactMailer.welcome.deliver_now
+    #     assert_emails 1
+    #     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.
+    #
+    #   def test_emails_again
+    #     assert_emails 1 do
+    #       ContactMailer.welcome.deliver_now
+    #     end
+    #
+    #     assert_emails 2 do
+    #       ContactMailer.welcome.deliver_now
+    #       ContactMailer.welcome.deliver_later
+    #     end
+    #   end
+    def assert_emails(number, &block)
+      if block_given?
+        diff = capture_emails(&block).length
+        assert_equal number, diff, "#{number} emails expected, but #{diff} were sent"
+      else
+        assert_equal number, ActionMailer::Base.deliveries.size
+      end
+    end
+
+    # Asserts that no emails have been sent.
+    #
+    #   def test_emails
+    #     assert_no_emails
+    #     ContactMailer.welcome.deliver_now
+    #     assert_emails 1
+    #   end
+    #
+    # If a block is passed, that block should not cause any emails to be sent.
+    #
+    #   def test_emails_again
+    #     assert_no_emails do
+    #       # No emails should be sent from this block
+    #     end
+    #   end
+    #
+    # Note: This assertion is simply a shortcut for:
+    #
+    #   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 and/or params.
+    #
+    #   def test_email
+    #     ContactMailer.welcome.deliver_later
+    #     assert_enqueued_email_with ContactMailer, :welcome
+    #   end
+    #
+    #   def test_email_with_parameters
+    #     ContactMailer.with(greeting: "Hello").welcome.deliver_later
+    #     assert_enqueued_email_with ContactMailer, :welcome, args: { greeting: "Hello" }
+    #   end
+    #
+    #   def test_email_with_arguments
+    #     ContactMailer.welcome("Hello", "Goodbye").deliver_later
+    #     assert_enqueued_email_with ContactMailer, :welcome, args: ["Hello", "Goodbye"]
+    #   end
+    #
+    #   def test_email_with_named_arguments
+    #     ContactMailer.welcome(greeting: "Hello", farewell: "Goodbye").deliver_later
+    #     assert_enqueued_email_with ContactMailer, :welcome, args: [{ greeting: "Hello", farewell: "Goodbye" }]
+    #   end
+    #
+    #   def test_email_with_parameters_and_arguments
+    #     ContactMailer.with(greeting: "Hello").welcome("Cheers", "Goodbye").deliver_later
+    #     assert_enqueued_email_with ContactMailer, :welcome, params: { greeting: "Hello" }, args: ["Cheers", "Goodbye"]
+    #   end
+    #
+    #   def test_email_with_parameters_and_named_arguments
+    #     ContactMailer.with(greeting: "Hello").welcome(farewell: "Goodbye").deliver_later
+    #     assert_enqueued_email_with ContactMailer, :welcome, params: { greeting: "Hello" }, args: [{farewell: "Goodbye"}]
+    #   end
+    #
+    #   def test_email_with_parameterized_mailer
+    #     ContactMailer.with(greeting: "Hello").welcome.deliver_later
+    #     assert_enqueued_email_with ContactMailer.with(greeting: "Hello"), :welcome
+    #   end
+    #
+    #   def test_email_with_matchers
+    #     ContactMailer.with(greeting: "Hello").welcome("Cheers", "Goodbye").deliver_later
+    #     assert_enqueued_email_with ContactMailer, :welcome,
+    #       params: ->(params) { /hello/i.match?(params[:greeting]) },
+    #       args: ->(args) { /cheers/i.match?(args[0]) }
+    #   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, params: nil, args: nil, queue: nil, &block)
+      if mailer.is_a? ActionMailer::Parameterized::Mailer
+        params = mailer.instance_variable_get(:@params)
+        mailer = mailer.instance_variable_get(:@mailer)
+      end
+
+      args = Array(args) unless args.is_a?(Proc)
+      queue ||= mailer.deliver_later_queue_name || ActiveJob::Base.default_queue_name
+
+      expected = ->(job_args) do
+        job_kwargs = job_args.extract_options!
+
+        [mailer.to_s, method.to_s, "deliver_now"] == job_args &&
+          params === job_kwargs[:params] && args === job_kwargs[:args]
+      end
+
+      assert_enqueued_with(job: mailer.delivery_job, args: expected, 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
+
+    # Delivers all enqueued emails. If a block is given, delivers all of the emails
+    # that were enqueued throughout the duration of the block. If a block is
+    # not given, delivers all the enqueued emails up to this point in the test.
+    #
+    #   def test_deliver_enqueued_emails
+    #     deliver_enqueued_emails do
+    #       ContactMailer.welcome.deliver_later
+    #     end
+    #
+    #     assert_emails 1
+    #   end
+    #
+    #   def test_deliver_enqueued_emails_without_block
+    #     ContactMailer.welcome.deliver_later
+    #
+    #     deliver_enqueued_emails
+    #
+    #     assert_emails 1
+    #   end
+    #
+    # If the +:queue+ option is specified,
+    # then only the emails(s) enqueued to a specific queue will be performed.
+    #
+    #   def test_deliver_enqueued_emails_with_queue
+    #     deliver_enqueued_emails queue: :external_mailers do
+    #       CustomerMailer.deliver_later_queue_name = :external_mailers
+    #       CustomerMailer.welcome.deliver_later # will be performed
+    #       EmployeeMailer.deliver_later_queue_name = :internal_mailers
+    #       EmployeeMailer.welcome.deliver_later # will not be performed
+    #     end
+    #
+    #     assert_emails 1
+    #   end
+    #
+    # If the +:at+ option is specified, then only delivers emails enqueued to deliver
+    # immediately or before the given time.
+    def deliver_enqueued_emails(queue: nil, at: nil, &block)
+      perform_enqueued_jobs(only: ->(job) { delivery_job_filter(job) }, queue: queue, at: at, &block)
+    end
+
+    # Returns any emails that are sent in the block.
+    #
+    #   def test_emails
+    #     emails = capture_emails do
+    #       ContactMailer.welcome.deliver_now
+    #     end
+    #     assert_equal "Hi there", emails.first.subject
+    #
+    #     emails = capture_emails do
+    #       ContactMailer.welcome.deliver_now
+    #       ContactMailer.welcome.deliver_later
+    #     end
+    #     assert_equal "Hi there", emails.first.subject
+    #   end
+    def capture_emails(&block)
+      original_count = ActionMailer::Base.deliveries.size
+      deliver_enqueued_emails(&block)
+      new_count = ActionMailer::Base.deliveries.size
+      diff = new_count - original_count
+      ActionMailer::Base.deliveries.last(diff)
+    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)
+      end
+  end
+end

data/lib/action_mailer/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "gem_version"
+
+module ActionMailer
+  # Returns the currently loaded version of Action Mailer as a
+  # +Gem::Version+.
+  def self.version
+    gem_version
+  end
+end

data/lib/action_mailer.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+#--
+# Copyright (c) David Heinemeier Hansson
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require "abstract_controller"
+require "action_mailer/version"
+require "action_mailer/deprecator"
+
+# Common Active Support usage in Action Mailer
+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"
+
+# :include: ../README.rdoc
+module ActionMailer
+  extend ::ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :Collector
+  end
+
+  autoload :Base
+  autoload :Callbacks
+  autoload :DeliveryMethods
+  autoload :InlinePreviewInterceptor
+  autoload :MailHelper
+  autoload :Parameterized
+  autoload :Preview
+  autoload :Previews, "action_mailer/preview"
+  autoload :TestCase
+  autoload :TestHelper
+  autoload :MessageDelivery
+  autoload :MailDeliveryJob
+  autoload :QueuedDelivery
+  autoload :FormBuilder
+
+  def self.eager_load!
+    super
+
+    require "mail"
+    Mail.eager_autoload!
+
+    Base.descendants.each do |mailer|
+      mailer.eager_load! unless mailer.abstract?
+    end
+  end
+end
+
+autoload :Mime, "action_dispatch/http/mime_type"
+
+ActiveSupport.on_load(:action_view) do
+  ActionView::Base.default_formats ||= Mime::SET.symbols
+  ActionView::Template.mime_types_implementation = Mime
+  ActionView::LookupContext::DetailsKey.clear
+end

data/lib/rails/generators/mailer/USAGE

@@ -0,0 +1,20 @@
+Description:
+    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
+    engine and test framework generators.
+
+Examples:
+    `bin/rails generate mailer sign_up`
+
+    creates a sign up mailer class, views, and test:
+        Mailer:     app/mailers/sign_up_mailer.rb
+        Views:      app/views/sign_up_mailer/signup.text.erb [...]
+        Test:       test/mailers/sign_up_mailer_test.rb
+
+    `bin/rails generate mailer notifications sign_up forgot_password invoice`
+
+    creates a notifications mailer with sign_up, forgot_password, and invoice actions.
+
+

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Rails
+  module Generators
+    class MailerGenerator < NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      argument :actions, type: :array, default: [], banner: "method method"
+
+      check_class_collision suffix: "Mailer"
+
+      def create_mailer_file
+        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.tt

@@ -0,0 +1,19 @@
+<% module_namespacing do -%>
+class <%= class_name %>Mailer < ApplicationMailer
+<% actions.each_with_index do |action, index| -%>
+<% if index != 0 -%>
+
+<% end -%>
+  # Subject can be set in your I18n file at config/locales/en.yml
+  # with the following lookup:
+  #
+  #   en.<%= file_path.tr("/",".") %>_mailer.<%= action %>.subject
+  #
+  def <%= action %>
+    @greeting = "Hi"
+
+    mail to: "to@example.org"
+  end
+<% end -%>
+end
+<% end -%>

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: omg-actionmailer
+version: !ruby/object:Gem::Version
+  version: 8.0.0.alpha2
+platform: ruby
+authors:
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omg-activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.0.0.alpha2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.0.0.alpha2
+- !ruby/object:Gem::Dependency
+  name: omg-actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.0.0.alpha2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.0.0.alpha2
+- !ruby/object:Gem::Dependency
+  name: omg-actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.0.0.alpha2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.0.0.alpha2
+- !ruby/object:Gem::Dependency
+  name: omg-activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.0.0.alpha2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 8.0.0.alpha2
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rails-dom-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+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
+- MIT-LICENSE
+- README.rdoc
+- lib/action_mailer.rb
+- lib/action_mailer/base.rb
+- lib/action_mailer/callbacks.rb
+- lib/action_mailer/collector.rb
+- lib/action_mailer/delivery_methods.rb
+- lib/action_mailer/deprecator.rb
+- lib/action_mailer/form_builder.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/message_delivery.rb
+- lib/action_mailer/parameterized.rb
+- lib/action_mailer/preview.rb
+- lib/action_mailer/queued_delivery.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/rails/generators/mailer/USAGE
+- 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/v8.0.0.alpha2/actionmailer/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v8.0.0.alpha2/
+  mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
+  source_code_uri: https://github.com/rails/rails/tree/v8.0.0.alpha2/actionmailer
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: Email composition and delivery framework (part of Rails).
+test_files: []