Be able to feature test action mailbox against our example app

File are generated by the feature test itself

Add missing newline at the end of file

Avoid too long line for Relish doc

Author: benoittgt

example_app_generator/generate_stuff.rb

@@ -104,6 +104,12 @@ def using_source_path(path)
   copy_file 'spec/features/model_mocks_integration_spec.rb'
 end
 
+begin
+  require 'action_mailbox'
+  run('rails action_mailbox:install')
+rescue LoadError
+end
+
 begin
   require 'active_job'
   generate('job upload_backups')

features/mailbox_specs/mailbox_spec.feature

@@ -0,0 +1,86 @@
+@rails_post_6
+Feature: action mailbox spec
+
+  Mailbox specs provide alternative assertions to those available in `ActiveMailbox::TestHelper` and help assert behaviour of how the email
+  are routed, delivered, bounced or failed.
+
+  Mailbox specs are marked by `type: :mailbox` or if you have set
+  `config.infer_spec_type_from_file_location!` by placing them in `spec/mailboxes`.
+
+  With mailbox specs you can:
+  * `process(mail_or_attributes)` - send mail directly to the mailbox under test for `process`ing.
+  * `receive_inbound_email(mail_or_attributes)` - matcher for asserting whether incoming email would route to the mailbox under test.
+  * `have_been_delivered` - matcher for asserting whether an incoming email object was delivered.
+  * `have_bounced` - matcher for asserting whether an incoming email object has bounced.
+  * `have_failed` - matcher for asserting whether an incoming email object has failed.
+
+  Background:
+    Given action mailbox is available
+
+  Scenario: Simple testing mail properly routed
+    Given a file named "app/mailboxes/application_mailbox.rb" with:
+      """ruby
+      class ApplicationMailbox < ActionMailbox::Base
+        routing (/^replies@/i) => :inbox
+      end
+      """
+    And a file named "app/maiboxes/inbox_mailbox.rb" with:
+      """ruby
+      class InboxMailbox < ApplicationMailbox
+        def process
+          case mail.subject
+          when (/^\[\d*\]/i)
+            # ok
+          when (/^\[\w*\]/i)
+            bounced!
+          else
+            raise "Invalid email subject"
+          end
+        end
+      end
+      """
+    And a file named "spec/mailboxes/inbox_mailbox_spec.rb" with:
+      """ruby
+      require 'rails_helper'
+
+      RSpec.describe InboxMailbox, type: :mailbox do
+        it "route email to properly mailbox" do
+          expect(InboxMailbox)
+            .to receive_inbound_email(to: "[email protected]")
+        end
+
+        it "marks email as bounced when number tag in subject is valid" do
+          mail = Mail.new(
+            from: "[email protected]",
+            subject: "[141982763] support ticket"
+          )
+          mail_processed = process(mail)
+
+          expect(mail_processed).to have_been_delivered
+        end
+
+        it "marks email as bounced when number tag in subject is invalid" do
+          mail = Mail.new(
+            from: "[email protected]",
+            subject: "[111X] support ticket"
+          )
+          mail_processed = process(mail)
+
+          expect(mail_processed).to have_bounced
+        end
+
+        it "marks email as failed when subject is invalid" do
+          mail = Mail.new(
+            from: "[email protected]",
+            subject: "INVALID"
+          )
+
+          expect {
+            expect(process(mail)).to have_failed
+          }.to raise_error(/Invalid email subject/)
+        end
+      end
+      """
+
+    When I run `rspec spec/mailboxes/inbox_mailbox_spec.rb`
+    Then the example should pass

features/step_definitions/additional_cli_steps.rb

@@ -6,6 +6,11 @@
   require "action_cable"
 rescue LoadError # rubocop:disable Lint/SuppressedException
 end
+begin
+  require "active_storage"
+  require "action_mailbox"
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end
 
 require "rails/version"
 
@@ -32,3 +37,9 @@
     pending "Action Cable testing is not available"
   end
 end
+
+Given /action mailbox is available/ do
+  unless RSpec::Rails::FeatureCheck.has_action_mailbox?
+    pending "Action Mailbox is not available"
+  end
+end