Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Include email previews in gems directly
Damian Legawiec85fec6468c44
diff --git a/docs/developer/customization/emails.mdx b/docs/developer/customization/emails.mdxindex 546bc2c8d9..52f9e34685 100644--- a/docs/developer/customization/emails.mdx+++ b/docs/developer/customization/emails.mdx@@ -13,20 +13,8 @@ Spree uses [postmark templates](https://github.com/wildbit/postmark-templates),## Email previews-Spree offers an emails preview generator for development purposes. To generate them, use the command:+Spree bundles [ActionMailer previews](https://guides.rubyonrails.org/action_mailer_basics.html#previewing-and-testing-mailers) for all of its transactional emails. They are served automatically in development — there is nothing to install.-<CodeGroup>+Start the rails server locally and go to: `localhost:3000/rails/mailers`-```bash Spree CLI (Docker)-spree generate spree:emails:install-```--```bash Without Spree CLI-bin/rails g spree:emails:install-```--</CodeGroup>--After that, start the rails server locally and go to: `localhost:3000/rails/mailers`--(it requires a seeded development database in order to work properly)+(it requires a seeded development database in order to work properly, as the previews render real records)diff --git a/spree/core/app/views/spree/export_mailer/export_done.html.erb b/spree/core/app/views/spree/export_mailer/export_done.html.erbindex 5d46243921..103b873e4e 100644--- a/spree/core/app/views/spree/export_mailer/export_done.html.erb+++ b/spree/core/app/views/spree/export_mailer/export_done.html.erb@@ -11,15 +11,3 @@</td></tr></table>--<table class="signoff" width="100%" cellpadding="0" cellspacing="0" role="presentation">- <tr>- <td align="center">- <p class="f-fallback">- <%= Spree.t('export_mailer.thanks') %>- <br />- <%= current_store.name %>- </p>- </td>- </tr>-</table>diff --git a/spree/core/app/views/spree/invitation_mailer/invitation_accepted.html.erb b/spree/core/app/views/spree/invitation_mailer/invitation_accepted.html.erbindex b473456c6b..d4fab36da2 100644--- a/spree/core/app/views/spree/invitation_mailer/invitation_accepted.html.erb+++ b/spree/core/app/views/spree/invitation_mailer/invitation_accepted.html.erb@@ -8,15 +8,3 @@</td></tr></table>--<table class="signoff" width="100%" cellpadding="0" cellspacing="0" role="presentation">- <tr>- <td align="center">- <p class="f-fallback">- <%= Spree.t('invitation_mailer.thanks') %>- <br />- <%= current_store.name %>- </p>- </td>- </tr>-</table>diff --git a/spree/core/app/views/spree/invitation_mailer/invitation_email.html.erb b/spree/core/app/views/spree/invitation_mailer/invitation_email.html.erbindex 2ff2d84cd7..bb93f93b76 100644--- a/spree/core/app/views/spree/invitation_mailer/invitation_email.html.erb+++ b/spree/core/app/views/spree/invitation_mailer/invitation_email.html.erb@@ -16,15 +16,3 @@</td></tr></table>--<table class="signoff" width="100%" cellpadding="0" cellspacing="0" role="presentation">- <tr>- <td align="center">- <p class="f-fallback">- <%= Spree.t('invitation_mailer.thanks') %>- <br />- <%= current_store.name %>- </p>- </td>- </tr>-</table>diff --git a/spree/core/app/views/spree/report_mailer/report_done.html.erb b/spree/core/app/views/spree/report_mailer/report_done.html.erbindex 5a37cf6aad..e496a5ac7a 100644--- a/spree/core/app/views/spree/report_mailer/report_done.html.erb+++ b/spree/core/app/views/spree/report_mailer/report_done.html.erb@@ -11,15 +11,3 @@</td></tr></table>--<table class="signoff" width="100%" cellpadding="0" cellspacing="0" role="presentation">- <tr>- <td align="center">- <p class="f-fallback">- <%= Spree.t('report_mailer.thanks') %>- <br />- <%= current_store.name %>- </p>- </td>- </tr>-</table>diff --git a/spree/core/app/views/spree/shared/_base_mailer_stylesheets.html.erb b/spree/core/app/views/spree/shared/_base_mailer_stylesheets.html.erbindex 5ce4d3fb3d..4760b47dfd 100644--- a/spree/core/app/views/spree/shared/_base_mailer_stylesheets.html.erb+++ b/spree/core/app/views/spree/shared/_base_mailer_stylesheets.html.erb@@ -257,16 +257,6 @@margin: 16px 0 0;}- .signoff {- width: 100%;- margin: 40px 0 0;- text-align: center;- }-- .signoff p {- margin: 0;- }-/* Structure ------------------------------ */.email-wrapper {diff --git a/spree/core/app/views/spree/webhook_mailer/endpoint_disabled.html.erb b/spree/core/app/views/spree/webhook_mailer/endpoint_disabled.html.erbindex 8a9b1d2e4e..2ef7fefc3a 100644--- a/spree/core/app/views/spree/webhook_mailer/endpoint_disabled.html.erb+++ b/spree/core/app/views/spree/webhook_mailer/endpoint_disabled.html.erb@@ -47,11 +47,3 @@</td></tr></table>--<table class="signoff" width="100%" cellpadding="0" cellspacing="0" role="presentation">- <tr>- <td align="center">- <p class="f-fallback"><%= Spree.t('webhook_mailer.endpoint_disabled.instructions') %></p>- </td>- </tr>-</table>diff --git a/spree/core/lib/spree/core/engine.rb b/spree/core/lib/spree/core/engine.rbindex 5d09a3e696..7659288fef 100644--- a/spree/core/lib/spree/core/engine.rb+++ b/spree/core/lib/spree/core/engine.rb@@ -46,6 +46,14 @@ module Spree# Add app/subscribers to autoload pathsconfig.paths.add 'app/subscribers', eager_load: true+ # Register bundled ActionMailer previews so they show up at /rails/mailers+ # without the host app having to copy any files.+ initializer 'spree.mailer_previews' do |app|+ if app.config.action_mailer.show_previews+ app.config.action_mailer.preview_paths << File.expand_path('previews', __dir__)+ end+ end+initializer 'spree.environment', before: :load_config_initializers do |app|app.config.spree = Environment.new(SpreeCalculators.new, SpreeValidators.new, Spree::Core::Configuration.new, Spree::Core::Dependencies.new)diff --git a/spree/core/lib/spree/core/previews/export_preview.rb b/spree/core/lib/spree/core/previews/export_preview.rbnew file mode 100644index 0000000000..07b42e5574--- /dev/null+++ b/spree/core/lib/spree/core/previews/export_preview.rb@@ -0,0 +1,28 @@+# Preview Spree export emails at /rails/mailers/spree/export+class Spree::ExportPreview < ActionMailer::Preview+ def export_done+ Spree::ExportMailer.export_done(export)+ end++ private++ # Reuse the most recent export, or build a renderable one on the fly so the+ # preview works on a database that has never run an export.+ def export+ Spree::Export.last || create_example_export+ end++ def create_example_export+ export = Spree::Exports::Products.create!(+ store: Spree::Store.default,+ user: Spree.admin_user_class.first,+ format: :csv+ )+ export.attachment.attach(+ io: StringIO.new("id,name,price\n1,Example Product,19.99\n"),+ filename: 'products-export.csv',+ content_type: 'text/csv'+ )+ export+ end+enddiff --git a/spree/core/lib/spree/core/previews/invitation_preview.rb b/spree/core/lib/spree/core/previews/invitation_preview.rbnew file mode 100644index 0000000000..b60435cb43--- /dev/null+++ b/spree/core/lib/spree/core/previews/invitation_preview.rb@@ -0,0 +1,10 @@+# Preview Spree invitation emails at /rails/mailers/spree/invitation+class Spree::InvitationPreview < ActionMailer::Preview+ def invitation_email+ Spree::InvitationMailer.invitation_email(Spree::Invitation.pending.last || Spree::Invitation.last)+ end++ def invitation_accepted+ Spree::InvitationMailer.invitation_accepted(Spree::Invitation.accepted.last || Spree::Invitation.last)+ end+enddiff --git a/spree/core/lib/spree/core/previews/report_preview.rb b/spree/core/lib/spree/core/previews/report_preview.rbnew file mode 100644index 0000000000..db8edf9ece--- /dev/null+++ b/spree/core/lib/spree/core/previews/report_preview.rb@@ -0,0 +1,31 @@+# Preview Spree report emails at /rails/mailers/spree/report+class Spree::ReportPreview < ActionMailer::Preview+ def report_done+ Spree::ReportMailer.report_done(report)+ end++ private++ # Reuse the most recent report, or build a renderable one on the fly so the+ # preview works on a database that has never run a report.+ def report+ Spree::Report.last || create_example_report+ end++ def create_example_report+ store = Spree::Store.default+ report = Spree::Reports::SalesTotal.create!(+ store: store,+ user: Spree.admin_user_class.first,+ date_from: 30.days.ago.to_date,+ date_to: Date.current,+ currency: store.default_currency+ )+ report.attachment.attach(+ io: StringIO.new("date,total\n2026-01-01,1234.56\n"),+ filename: 'sales-total.csv',+ content_type: 'text/csv'+ )+ report+ end+enddiff --git a/spree/core/lib/spree/core/previews/webhook_preview.rb b/spree/core/lib/spree/core/previews/webhook_preview.rbnew file mode 100644index 0000000000..48c71eda13--- /dev/null+++ b/spree/core/lib/spree/core/previews/webhook_preview.rb@@ -0,0 +1,26 @@+# Preview Spree webhook notification emails at /rails/mailers/spree/webhook+class Spree::WebhookPreview < ActionMailer::Preview+ def endpoint_disabled+ Spree::WebhookMailer.endpoint_disabled(webhook_endpoint)+ end++ private++ # Reuse the most recent endpoint, or build a renderable disabled one on the+ # fly so the preview works on a database that has no webhook endpoints.+ def webhook_endpoint+ Spree::WebhookEndpoint.last || create_example_endpoint+ end++ def create_example_endpoint+ Spree::WebhookEndpoint.create!(+ store: Spree::Store.default,+ name: 'Example endpoint',+ url: 'https://example.com/webhooks/spree',+ active: false,+ disabled_reason: 'Too many failed delivery attempts',+ disabled_at: Time.current,+ subscriptions: ['order.completed']+ )+ end+enddiff --git a/spree/emails/README.md b/spree/emails/README.mdindex 7a6d74760a..4c8d68e081 100644--- a/spree/emails/README.md+++ b/spree/emails/README.md@@ -188,23 +188,15 @@ bundle remove spree_emailsIf you prefer to use a third-party email service like Klaviyo for transactional emails, you can use the [spree_klaviyo](https://github.com/spree/spree_klaviyo) extension. This allows you to leverage Klaviyo's email marketing platform for order confirmations, shipment notifications, and other transactional emails.-## Testing+## Previewing emails-Preview emails in development:+[ActionMailer previews](https://guides.rubyonrails.org/action_mailer_basics.html#previewing-and-testing-mailers) for every transactional email ship with this gem and are served automatically in development — no setup required. With a seeded development database, start the server and visit:-```ruby-# test/mailers/previews/spree/order_mailer_preview.rb-module Spree- class OrderMailerPreview < ActionMailer::Preview- def confirm_email- order = Spree::Order.complete.last- Spree::OrderMailer.confirm_email(order)- end- end-end-```+`http://localhost:3000/rails/mailers`-Visit `http://localhost:3000/rails/mailers/spree/order_mailer/confirm_email`+for example `http://localhost:3000/rails/mailers/spree/order/confirm_email`.++## TestingRun the test suite:diff --git a/spree/emails/app/views/spree/newsletter_mailer/email_confirmation.html.erb b/spree/emails/app/views/spree/newsletter_mailer/email_confirmation.html.erbindex 624139234b..5c3e79378c 100644--- a/spree/emails/app/views/spree/newsletter_mailer/email_confirmation.html.erb+++ b/spree/emails/app/views/spree/newsletter_mailer/email_confirmation.html.erb@@ -16,15 +16,3 @@</td></tr></table>--<table class="signoff" width="100%" cellpadding="0" cellspacing="0" role="presentation">- <tr>- <td align="center">- <p class="f-fallback">- <%= Spree.t('newsletter_mailer.email_confirmation.thanks') %>- <br />- <%= Spree.t('newsletter_mailer.email_confirmation.store_team', store_name: current_store.name) %>- </p>- </td>- </tr>-</table>diff --git a/spree/emails/app/views/spree/order_mailer/cancel_email.html.erb b/spree/emails/app/views/spree/order_mailer/cancel_email.html.erbindex 040dc77cc3..5f79ecba5d 100644--- a/spree/emails/app/views/spree/order_mailer/cancel_email.html.erb+++ b/spree/emails/app/views/spree/order_mailer/cancel_email.html.erb@@ -20,15 +20,3 @@</td></tr></table>--<table class="signoff" width="100%" cellpadding="0" cellspacing="0" role="presentation">- <tr>- <td align="center">- <p class="f-fallback">- <%= Spree.t('order_mailer.cancel_email.thanks') %>- <br />- <%= Spree.t('order_mailer.store_team', store_name: current_store.name) %>- </p>- </td>- </tr>-</table>diff --git a/spree/emails/app/views/spree/order_mailer/confirm_email.html.erb b/spree/emails/app/views/spree/order_mailer/confirm_email.html.erbindex 6c9f06d94f..e46dab73cc 100644--- a/spree/emails/app/views/spree/order_mailer/confirm_email.html.erb+++ b/spree/emails/app/views/spree/order_mailer/confirm_email.html.erb@@ -20,15 +20,3 @@</td></tr></table>--<table class="signoff" width="100%" cellpadding="0" cellspacing="0" role="presentation">- <tr>- <td align="center">- <p class="f-fallback">- <%= Spree.t('order_mailer.confirm_email.thanks') %>- <br />- <%= Spree.t('order_mailer.store_team', store_name: current_store.name) %>- </p>- </td>- </tr>-</table>diff --git a/spree/emails/app/views/spree/order_mailer/store_owner_notification_email.html.erb b/spree/emails/app/views/spree/order_mailer/store_owner_notification_email.html.erbindex 2536ffac83..0751cc04ca 100644--- a/spree/emails/app/views/spree/order_mailer/store_owner_notification_email.html.erb+++ b/spree/emails/app/views/spree/order_mailer/store_owner_notification_email.html.erb@@ -19,15 +19,3 @@</td></tr></table>--<table class="signoff" width="100%" cellpadding="0" cellspacing="0" role="presentation">- <tr>- <td align="center">- <p class="f-fallback">- <%= Spree.t('order_mailer.store_owner_notification_email.thanks') %>- <br />- <%= Spree.t('order_mailer.store_team', store_name: current_store.name) %>- </p>- </td>- </tr>-</table>diff --git a/spree/emails/app/views/spree/reimbursement_mailer/reimbursement_email.html.erb b/spree/emails/app/views/spree/reimbursement_mailer/reimbursement_email.html.erbindex 303660e9d4..29c60f0ae9 100644--- a/spree/emails/app/views/spree/reimbursement_mailer/reimbursement_email.html.erb+++ b/spree/emails/app/views/spree/reimbursement_mailer/reimbursement_email.html.erb@@ -54,15 +54,3 @@</tr></table><% end %>--<table class="signoff" width="100%" cellpadding="0" cellspacing="0" role="presentation">- <tr>- <td align="center">- <p class="f-fallback">- <%= Spree.t('reimbursement_mailer.reimbursement_email.thanks') %>- <br />- <%= Spree.t('reimbursement_mailer.reimbursement_email.store_team', store_name: current_store.name) %>- </p>- </td>- </tr>-</table>diff --git a/spree/emails/app/views/spree/shipment_mailer/shipped_email.html.erb b/spree/emails/app/views/spree/shipment_mailer/shipped_email.html.erbindex c86619a70c..4d4237941d 100644--- a/spree/emails/app/views/spree/shipment_mailer/shipped_email.html.erb+++ b/spree/emails/app/views/spree/shipment_mailer/shipped_email.html.erb@@ -27,15 +27,3 @@</td></tr></table>--<table class="signoff" width="100%" cellpadding="0" cellspacing="0" role="presentation">- <tr>- <td align="center">- <p class="f-fallback">- <%= Spree.t('shipment_mailer.shipped_email.thanks') %>- <br />- <%= Spree.t('shipment_mailer.shipped_email.store_team', store_name: current_store.name) %>- </p>- </td>- </tr>-</table>diff --git a/spree/emails/lib/generators/spree/emails/install/install_generator.rb b/spree/emails/lib/generators/spree/emails/install/install_generator.rbindex efd63a33d7..69422c5d17 100644--- a/spree/emails/lib/generators/spree/emails/install/install_generator.rb+++ b/spree/emails/lib/generators/spree/emails/install/install_generator.rb@@ -4,22 +4,14 @@ require 'spree/core'module Spreemodule Emailsmodule Generators+ # Kept as a no-op so `rake test_app` and any existing `rails g spree:emails:install`+ # invocations keep working. Mailer previews now ship inside the gem and are served+ # automatically at /rails/mailers — there is nothing left to copy into the host app.class InstallGenerator < Rails::Generators::Base- desc 'Installs mailers previews for Spree transactional emails'+ desc 'No-op. Spree email previews are now bundled and served automatically at /rails/mailers.'- def self.source_paths- [- File.expand_path('templates', __dir__)- ]- end-- def copy_mailers_previews- preview_path = Rails.application&.config&.action_mailer&.preview_path.presence || 'test/mailers/previews'-- template 'mailers/previews/order_preview.rb', "#{preview_path}/order_preview.rb"- template 'mailers/previews/shipment_preview.rb', "#{preview_path}/shipment_preview.rb"- template 'mailers/previews/reimbursement_preview.rb', "#{preview_path}/reimbursement_preview.rb"- template 'mailers/previews/user_preview.rb', "#{preview_path}/user_preview.rb"+ def notify_previews_are_bundled+ say 'Spree email previews are bundled with spree_emails and served automatically at /rails/mailers — nothing to install.'endendenddiff --git a/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/order_preview.rb b/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/order_preview.rbdeleted file mode 100644index 1785f5c77d..0000000000--- a/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/order_preview.rb+++ /dev/null@@ -1,13 +0,0 @@-class OrderPreview < ActionMailer::Preview- def confirm_email- Spree::OrderMailer.confirm_email(Spree::Order.complete.first)- end-- def cancel_email- Spree::OrderMailer.cancel_email(Spree::Order.complete.first)- end-- def store_owner_notification_email- Spree::OrderMailer.store_owner_notification_email(Spree::Order.complete.first)- end-enddiff --git a/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/reimbursement_preview.rb b/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/reimbursement_preview.rbdeleted file mode 100644index 1bc556a86e..0000000000--- a/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/reimbursement_preview.rb+++ /dev/null@@ -1,5 +0,0 @@-class ReimbursementPreview < ActionMailer::Preview- def reimbursement_email- Spree::ReimbursementMailer.reimbursement_email(Spree::Reimbursement.first)- end-enddiff --git a/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/shipment_preview.rb b/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/shipment_preview.rbdeleted file mode 100644index 4b07fae75c..0000000000--- a/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/shipment_preview.rb+++ /dev/null@@ -1,7 +0,0 @@-class ShipmentPreview < ActionMailer::Preview- helper Spree::ShipmentHelper-- def shipped_email- Spree::ShipmentMailer.shipped_email(Spree::Shipment.shipped.first)- end-enddiff --git a/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/user_preview.rb b/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/user_preview.rbdeleted file mode 100644index c70e110117..0000000000--- a/spree/emails/lib/generators/spree/emails/install/templates/mailers/previews/user_preview.rb+++ /dev/null@@ -1,11 +0,0 @@-class UserPreview < ActionMailer::Preview- def reset_password_instructions- Spree::UserMailer.reset_password_instructions(Spree.user_class.first, 'your_token', { current_store_id: Spree::Store.default.id })- end-- if Spree::Auth::Config[:confirmable]- def confirmation_instructions- Spree::UserMailer.confirmation_instructions(Spree.user_class.first, 'your_token')- end- end-enddiff --git a/spree/emails/lib/spree/emails/engine.rb b/spree/emails/lib/spree/emails/engine.rbindex cbfa7ac59f..fbe68523fb 100644--- a/spree/emails/lib/spree/emails/engine.rb+++ b/spree/emails/lib/spree/emails/engine.rb@@ -9,6 +9,14 @@ module Spree# Add app/subscribers to autoload pathsconfig.paths.add 'app/subscribers', eager_load: true+ # Register bundled ActionMailer previews so they show up at /rails/mailers+ # without the host app having to copy any files.+ initializer 'spree_emails.mailer_previews' do |app|+ if app.config.action_mailer.show_previews+ app.config.action_mailer.preview_paths << File.expand_path('previews', __dir__)+ end+ end+# Add email event subscribersconfig.after_initialize doSpree.subscribers.concat [diff --git a/spree/emails/lib/spree/emails/previews/newsletter_preview.rb b/spree/emails/lib/spree/emails/previews/newsletter_preview.rbnew file mode 100644index 0000000000..a887df6c3b--- /dev/null+++ b/spree/emails/lib/spree/emails/previews/newsletter_preview.rb@@ -0,0 +1,7 @@+# Preview Spree newsletter emails at /rails/mailers/spree/newsletter+class Spree::NewsletterPreview < ActionMailer::Preview+ def email_confirmation+ subscriber = Spree::NewsletterSubscriber.unverified.last || Spree::NewsletterSubscriber.last+ Spree::NewsletterMailer.email_confirmation(subscriber)+ end+enddiff --git a/spree/emails/lib/spree/emails/previews/order_preview.rb b/spree/emails/lib/spree/emails/previews/order_preview.rbnew file mode 100644index 0000000000..cffe4468ab--- /dev/null+++ b/spree/emails/lib/spree/emails/previews/order_preview.rb@@ -0,0 +1,14 @@+# Preview Spree order emails at /rails/mailers/spree/order+class Spree::OrderPreview < ActionMailer::Preview+ def confirm_email+ Spree::OrderMailer.confirm_email(Spree::Order.complete.last)+ end++ def cancel_email+ Spree::OrderMailer.cancel_email(Spree::Order.complete.last)+ end++ def store_owner_notification_email+ Spree::OrderMailer.store_owner_notification_email(Spree::Order.complete.last)+ end+enddiff --git a/spree/emails/lib/spree/emails/previews/reimbursement_preview.rb b/spree/emails/lib/spree/emails/previews/reimbursement_preview.rbnew file mode 100644index 0000000000..edbc03aeb0--- /dev/null+++ b/spree/emails/lib/spree/emails/previews/reimbursement_preview.rb@@ -0,0 +1,6 @@+# Preview Spree reimbursement emails at /rails/mailers/spree/reimbursement+class Spree::ReimbursementPreview < ActionMailer::Preview+ def reimbursement_email+ Spree::ReimbursementMailer.reimbursement_email(Spree::Reimbursement.last)+ end+enddiff --git a/spree/emails/lib/spree/emails/previews/shipment_preview.rb b/spree/emails/lib/spree/emails/previews/shipment_preview.rbnew file mode 100644index 0000000000..f06eb301a0--- /dev/null+++ b/spree/emails/lib/spree/emails/previews/shipment_preview.rb@@ -0,0 +1,6 @@+# Preview Spree shipment emails at /rails/mailers/spree/shipment+class Spree::ShipmentPreview < ActionMailer::Preview+ def shipped_email+ Spree::ShipmentMailer.shipped_email(Spree::Shipment.shipped.last)+ end+end