Add Mailbox and MailboxTest generators

5 files changed, 76 insertions, 0 deletions

diff --git a/lib/rails/generators/mailbox/USAGE b/lib/rails/generators/mailbox/USAGE
new file mode 100644
index 0000000000..d679dd63ae
--- /dev/null
+++ b/lib/rails/generators/mailbox/USAGE
@@ -0,0 +1,12 @@
+Description:
+============
+    Stubs out a new mailbox class in app/mailboxes and invokes your template
+    engine and test framework generators.
+
+Example:
+========
+    rails generate mailbox inbox
+
+    creates a InboxMailbox class and test:
+        Mailbox:  app/mailboxes/inbox_mailbox.rb
+        Test:     test/mailboxes/inbox_mailbox_test.rb
diff --git a/lib/rails/generators/mailbox/mailbox_generator.rb b/lib/rails/generators/mailbox/mailbox_generator.rb
new file mode 100644
index 0000000000..7fcdfd3384
--- /dev/null
+++ b/lib/rails/generators/mailbox/mailbox_generator.rb
@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Rails
+  module Generators
+    class MailboxGenerator < NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      argument :actions, type: :array, default: [:process], banner: "method method"
+
+      def check_class_collision
+        class_collisions "#{class_name}Mailbox", "#{class_name}MailboxTest"
+      end
+
+      def create_mailbox_file
+        template "mailbox.rb", File.join("app/mailboxes", class_path, "#{file_name}_mailbox.rb")
+
+        in_root do
+          if behavior == :invoke && !File.exist?(application_mailbox_file_name)
+            template "application_mailbox.rb", application_mailbox_file_name
+          end
+        end
+
+        template "mailer_test.rb", File.join('test/mailboxes', class_path, "#{file_name}_mailbox_test.rb")
+      end
+
+      hook_for :test_framework
+
+      private
+        def file_name # :doc:
+          @_file_name ||= super.sub(/_mailbox\z/i, "")
+        end
+
+        def application_mailbox_file_name
+          "app/mailboxes/application_mailbox.rb"
+        end
+    end
+  end
+end
diff --git a/lib/rails/generators/mailbox/templates/application_mailbox.rb.tt b/lib/rails/generators/mailbox/templates/application_mailbox.rb.tt
new file mode 100644
index 0000000000..be51eb3639
--- /dev/null
+++ b/lib/rails/generators/mailbox/templates/application_mailbox.rb.tt
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationMailbox < ActionMailbox::Base
+  # routing /something/i => :somewhere
+end
diff --git a/lib/rails/generators/mailbox/templates/mailbox.rb.tt b/lib/rails/generators/mailbox/templates/mailbox.rb.tt
new file mode 100644
index 0000000000..9788bd9bb4
--- /dev/null
+++ b/lib/rails/generators/mailbox/templates/mailbox.rb.tt
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class <%= class_name %>Mailbox < ApplicationMailbox
+<% actions.each do |action| -%>
+  def <%= action %>
+  end
+<% end -%>
+end
diff --git a/lib/rails/generators/mailbox/templates/mailer_test.rb.tt b/lib/rails/generators/mailbox/templates/mailer_test.rb.tt
new file mode 100644
index 0000000000..41749808e3
--- /dev/null
+++ b/lib/rails/generators/mailbox/templates/mailer_test.rb.tt
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class <%= class_name %>MailboxTest < ActionMailbox::TestCase
+  # test "receive mail" do
+  #   receive_inbound_email_from_mail \
+  #     to: '"someone" <someone@example.com>,
+  #     from: '"else" <else@example.com>',
+  #     subject: "Hello world!",
+  #     body: "Hello?"
+  # end
+end