Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Fix: third-round review findings on the email template editor

Damian Legawiecdef595b6e51f
diff --git a/packages/dashboard/src/locales/ar.json b/packages/dashboard/src/locales/ar.json
index 218867cbab..f10ecd457e 100644
--- a/packages/dashboard/src/locales/ar.json
+++ b/packages/dashboard/src/locales/ar.json
@@ -6195,6 +6195,7 @@
"customized": "مخصص",
"default": "افتراضي",
"draft": "مسودة",
+ "other_languages": "مخصص أيضًا: {{languages}}",
"default_updated": "حدّثه Spree",
"unsaved": "تغييرات غير محفوظة",
"showing_draft": "مسودة — يتلقى العملاء النسخة المنشورة",
diff --git a/packages/dashboard/src/locales/de.json b/packages/dashboard/src/locales/de.json
index 13238804fe..a81adcd4a0 100644
--- a/packages/dashboard/src/locales/de.json
+++ b/packages/dashboard/src/locales/de.json
@@ -6155,6 +6155,7 @@
"customized": "Angepasst",
"default": "Standard",
"draft": "Entwurf",
+ "other_languages": "Auch angepasst: {{languages}}",
"default_updated": "Von Spree aktualisiert",
"unsaved": "Ungespeicherte Änderungen",
"showing_draft": "Entwurf – Kunden erhalten die veröffentlichte Version",
diff --git a/packages/dashboard/src/locales/en.json b/packages/dashboard/src/locales/en.json
index 80348b11b0..98debccf49 100644
--- a/packages/dashboard/src/locales/en.json
+++ b/packages/dashboard/src/locales/en.json
@@ -6155,6 +6155,7 @@
"customized": "Customized",
"default": "Default",
"draft": "Draft",
+ "other_languages": "Also customized: {{languages}}",
"default_updated": "Updated by Spree",
"unsaved": "Unsaved changes",
"showing_draft": "Draft — customers receive the published version",
diff --git a/packages/dashboard/src/locales/es.json b/packages/dashboard/src/locales/es.json
index 689f08252b..5b994a8219 100644
--- a/packages/dashboard/src/locales/es.json
+++ b/packages/dashboard/src/locales/es.json
@@ -6155,6 +6155,7 @@
"customized": "Personalizada",
"default": "Predeterminada",
"draft": "Borrador",
+ "other_languages": "También personalizada: {{languages}}",
"default_updated": "Actualizada por Spree",
"unsaved": "Cambios sin guardar",
"showing_draft": "Borrador: los clientes reciben la versión publicada",
diff --git a/packages/dashboard/src/locales/fr.json b/packages/dashboard/src/locales/fr.json
index 57f2a29ad1..1b46ed4fb9 100644
--- a/packages/dashboard/src/locales/fr.json
+++ b/packages/dashboard/src/locales/fr.json
@@ -6155,6 +6155,7 @@
"customized": "Personnalisé",
"default": "Par défaut",
"draft": "Brouillon",
+ "other_languages": "Aussi personnalisé : {{languages}}",
"default_updated": "Mis à jour par Spree",
"unsaved": "Modifications non enregistrées",
"showing_draft": "Brouillon – les clients reçoivent la version publiée",
diff --git a/packages/dashboard/src/locales/pl.json b/packages/dashboard/src/locales/pl.json
index 08eb22dddb..a600fe4d11 100644
--- a/packages/dashboard/src/locales/pl.json
+++ b/packages/dashboard/src/locales/pl.json
@@ -6223,6 +6223,7 @@
"customized": "Dostosowany",
"default": "Domyślny",
"draft": "Szkic",
+ "other_languages": "Dostosowano też: {{languages}}",
"default_updated": "Zaktualizowany przez Spree",
"unsaved": "Niezapisane zmiany",
"showing_draft": "Szkic – klienci otrzymują opublikowaną wersję",
diff --git a/packages/dashboard/src/locales/zh-CN.json b/packages/dashboard/src/locales/zh-CN.json
index 8d198fe26b..4e8bd551d2 100644
--- a/packages/dashboard/src/locales/zh-CN.json
+++ b/packages/dashboard/src/locales/zh-CN.json
@@ -6142,6 +6142,7 @@
"customized": "已自定义",
"default": "默认",
"draft": "草稿",
+ "other_languages": "其他已自定义语言:{{languages}}",
"default_updated": "Spree 已更新",
"unsaved": "未保存的更改",
"showing_draft": "草稿 — 客户收到的是已发布版本",
diff --git a/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/index.tsx b/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/index.tsx
index 2dbd9feef7..e2aff10aae 100644
--- a/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/index.tsx
+++ b/packages/dashboard/src/routes/_authenticated/$storeId/settings/emails/templates/index.tsx
@@ -1,5 +1,11 @@
import type { EmailTemplate } from '@spree/admin-sdk'
-import { PageHeader, Subject, usePermissions, useStore } from '@spree/dashboard-core'
+import {
+ PageHeader,
+ Subject,
+ useDisplayName,
+ usePermissions,
+ useStore,
+} from '@spree/dashboard-core'
import {
Badge,
Card,
@@ -124,6 +130,12 @@ function TemplateGroup({
function TemplateBadges({ template }: { template: EmailTemplate }) {
const { t } = useTranslation()
+ const { defaultLocale: language } = useStore()
+ const languageName = useDisplayName('language')
+ // The list reads one language; versions in the others would otherwise look missing.
+ const otherLanguages = template.customized_languages
+ .filter((code) => code !== language && code !== 'any')
+ .map((code) => languageName(code) ?? code)
return (
<div className="flex flex-wrap justify-end gap-1">
@@ -131,6 +143,13 @@ function TemplateBadges({ template }: { template: EmailTemplate }) {
<Badge variant="warning">{t('admin.email_templates.badges.default_updated')}</Badge>
)}
{template.draft && <Badge variant="info">{t('admin.email_templates.badges.draft')}</Badge>}
+ {otherLanguages.length > 0 && (
+ <Badge variant="outline">
+ {t('admin.email_templates.badges.other_languages', {
+ languages: otherLanguages.join(', '),
+ })}
+ </Badge>
+ )}
{template.customized ? (
<Badge variant="success">{t('admin.email_templates.badges.customized')}</Badge>
) : (
diff --git a/spree/core/app/services/spree/email_templates/preview.rb b/spree/core/app/services/spree/email_templates/preview.rb
index ccfe6f9d2c..9bba4373f2 100644
--- a/spree/core/app/services/spree/email_templates/preview.rb
+++ b/spree/core/app/services/spree/email_templates/preview.rb
@@ -70,12 +70,15 @@ module Spree
@resolver ||= Spree::Emails::TemplateResolver.for_mailers(store: @store, locale: language, drafts: drafts)
end
+ # An unsaved subject or body sent alone is previewed with the other half
+ # customers currently get.
def drafts
- return {} if @body.nil?
+ return {} if @subject.nil? && @body.nil?
- # A body sent alone keeps the subject customers currently get.
- subject = @subject.nil? ? Spree::Emails::TemplateResolver.for_mailers(store: @store, locale: language).find(@key)&.subject : @subject
- { @key => Spree::Emails::Template.new(key: @key, subject: subject, body: @body) }
+ current = Spree::Emails::TemplateResolver.for_mailers(store: @store, locale: language).find(@key)
+ subject = @subject.nil? ? current&.subject : @subject
+ body = @body.nil? ? current&.body : @body
+ { @key => Spree::Emails::Template.new(key: @key, subject: subject, body: body) }
end
def language
diff --git a/spree/core/app/services/spree/emails/translation_inliner.rb b/spree/core/app/services/spree/emails/translation_inliner.rb
index bb9b54b851..f0857b41d4 100644
--- a/spree/core/app/services/spree/emails/translation_inliner.rb
+++ b/spree/core/app/services/spree/emails/translation_inliner.rb
@@ -13,10 +13,12 @@ module Spree
# translation, a value it does not recognize) is left as it was, so the
# template still renders the same.
class TranslationInliner
- KEY = /'([a-z0-9_.]+)'/
- ARGUMENTS = /(?:\s*:\s*([^|}%]+?))?/
- OUTPUT = /\{\{-?\s*#{KEY}\s*\|\s*t#{ARGUMENTS}\s*(\|[^}]*?)?\s*-?\}\}/
- ASSIGN = /\{%-?\s*assign\s+(\w+)\s*=\s*#{KEY}\s*\|\s*t#{ARGUMENTS}\s*-?%\}/
+ # Tags are found with simple patterns and read with string handling, so
+ # matching stays linear on any input a merchant pastes in.
+ OUTPUT_TAG = /\{\{([^{}]*)\}\}/
+ ASSIGN_TAG = /\{%([^{}%]*)%\}/
+ TRANSLATED = /\A'([a-z0-9_.]+)'\s*\|\s*t\b/
+ ASSIGNED = /\Aassign\s+(\w+)\s*=\s*/
INTERPOLATION = /%\{(\w+)\}/
# @param source [String, nil] a template's subject or body
@@ -37,29 +39,55 @@ module Spree
return source if source.blank?
source.
- gsub(ASSIGN) { inline_assign(Regexp.last_match) || Regexp.last_match[0] }.
- gsub(OUTPUT) { inline_output(Regexp.last_match) || Regexp.last_match[0] }
+ gsub(ASSIGN_TAG) { |tag| inline_assign(markup(Regexp.last_match[1])) || tag }.
+ gsub(OUTPUT_TAG) { |tag| inline_output(markup(Regexp.last_match[1])) || tag }
end
private
- def inline_output(match)
- _, key, arguments, filters = match.to_a
- text = translation(key)
+ # A tag's content without whitespace control dashes or padding.
+ def markup(content)
+ content.delete_prefix('-').delete_suffix('-').strip
+ end
+
+ # `'key' | t`, `'key' | t: name: value` and `'key' | t | filter`, split into
+ # the key, its arguments and the filters after it.
+ def translation_call(markup)
+ match = TRANSLATED.match(markup)
+ return unless match
+
+ rest = match.post_match.strip
+ if rest.start_with?(':')
+ arguments, filters = rest.delete_prefix(':').split('|', 2)
+ [match[1], arguments.strip, filters&.strip]
+ elsif rest.start_with?('|')
+ [match[1], nil, rest.delete_prefix('|').strip]
+ elsif rest.empty?
+ [match[1], nil, nil]
+ end
+ end
+
+ def inline_output(markup)
+ key, arguments, filters = translation_call(markup)
+ text = key && translation(key)
return unless text
if filters.present?
return if arguments.present? || text.include?("'")
- "{{ '#{text}' #{filters.strip} }}"
+ "{{ '#{text}' | #{filters} }}"
else
interpolate(text, arguments) { |literal| literal_text(literal) }
end
end
- def inline_assign(match)
- _, variable, key, arguments = match.to_a
- text = translation(key)
+ def inline_assign(markup)
+ assigned = ASSIGNED.match(markup)
+ return unless assigned
+
+ variable = assigned[1]
+ key, arguments, filters = translation_call(assigned.post_match)
+ text = key && filters.nil? && translation(key)
return unless text
if arguments.blank? && text.exclude?("'") && text !~ INTERPOLATION
diff --git a/spree/core/spec/services/spree/email_templates/preview_spec.rb b/spree/core/spec/services/spree/email_templates/preview_spec.rb
index fe816f5c9a..e15d6148fe 100644
--- a/spree/core/spec/services/spree/email_templates/preview_spec.rb
+++ b/spree/core/spec/services/spree/email_templates/preview_spec.rb
@@ -30,4 +30,11 @@ describe Spree::EmailTemplates::Preview do
expect(email.subject).to be_present
end
+
+ it 'previews an unsaved subject sent alone, with the current body' do
+ email = described_class.new(store: store, key: editable_key, subject: 'Only the subject changed').call
+
+ expect(email.subject).to eq('Only the subject changed')
+ expect(email.html).to include(store.name)
+ end
end