studio-engine 0.44.0 → 0.44.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a0bd2a31039b41d7b5f7fe70a6865308d2fec97e6bfeae301f254b173352dc2
-  data.tar.gz: 14e41f376424c34cd73c92eae84310eb18b24dc2165ac727948d7d9cbed9379a
+  metadata.gz: 6b902bc40b9fcd804ebcd5512e291a092056246fa399a5eac8753c40ee194f0d
+  data.tar.gz: a23566b993e7bb62201be4a428414e6e9f6ffdcc1789248ad6a255031738a2cb
 SHA512:
-  metadata.gz: '097bd2947f0e2c0a02a21b76cb01ed7816fd1c7ff1cc077576a15b8e125ef3e13ce81ac7a0c8500de367c37f663cd8d1cdfb4599511f760efe6a9e2994fdbaeb'
-  data.tar.gz: 72b9f3066838d5494036601d29a0de70a6c33d69e84ccfcd788e459e493f16d5a9b1c130a7b3c36c8604081823ddb8fa9274e5b61eef97da0246ace104e70392
+  metadata.gz: f7a3d8f2116ed244a3f9efaa01284f61a173f4df3ad3fdf38f42e8fe64c33601042975427888c841e69e7142b4d847af5619ec5946a08bbfe2feea8be5bd72c9
+  data.tar.gz: 4a0a21442d7b0b313755fa28fe62101f08408410eabf7278e50b74b8753451776d4b6508686f3db8dd3b78ffafcbe2f2f37e4e4e9f24395524ddd86c332bdee5

data/CHANGELOG.md

@@ -89,6 +89,38 @@ The format is [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). This pro
 
 ### Fixed
 
+- **The newsletter's seed lent every host the McRitchie Studio wordmark.**
+  `STANDARD`'s `newsletter_subscribed` entry seeded
+  `logo: "emails/logo-horizontal.png"`, and `EmailCatalog.register` merges on
+  `logo.presence` — so an omitted `logo:` INHERITS. A host registering that email
+  for any ordinary reason (a relabel, its own preview builder) would have sent its
+  branded newsletter under Studio's mark, and the alt text could not warn anyone:
+  `Studio::Banner` sets it from `Studio.app_name`, so it always agrees with the
+  host and never with the pixels. turf-monster hit the same mechanism on
+  `magic_link`.
+
+  **No consumer was exposed.** No app registers `newsletter_subscribed` or sends
+  it — turf's own `NewsletterMailer` sends its flat `newsletter_welcome` — so this
+  was visible only on the `/admin/emails` preview. It was seeded identically in
+  0.42 and 0.43; nothing changed it recently.
+
+  The seed now carries no logo. **Artwork still rides the gem** — a background is
+  a picture any app can send, and inheriting one is what gives a new app
+  good-looking mail on day one. A wordmark is somebody's identity, and the line is
+  drawn there. An app that wants a mark registers a path IT ships
+  (`register("newsletter_subscribed", logo: "emails/our-mark.png")`) or sets one
+  on /admin/emails. Guards render the mail and resolve every `<img>` back to a
+  file on the engine's own asset load path, comparing the wordmark by its BYTES,
+  so renaming the file and re-seeding it is caught too.
+
+  **`magic_link` is unchanged and still seeds the wordmark.** A host that
+  registers no mark of its own inherits it on the sign-in email. That is an
+  **upgrade trap** rather than a live leak — the apps with no email initializer
+  are pinned before this registry existed, so they inherit nothing today, but the
+  bump that brings one forward would hand it another brand's mark with no code
+  change of its own. Tracked separately, with the design question of whether
+  `STANDARD` should seed a logo at all.
+
 - **The manager reported artwork that was not being sent.** A layered-native email
   (no flat `default_asset`) drew an empty box and a "sends without a banner" badge
   while it was sending one, and an email with BOTH assets previewed the flat one —

data/README.md

@@ -417,10 +417,39 @@ Register the artwork once and every app inherits it:
 ```ruby
 Studio::EmailCatalog.register("magic_link",
   background: "emails/magic-link-background.gif",
-  logo: "emails/logo-horizontal.png",
+  logo: "emails/our-own-mark.png",   # a path THIS app ships — see below
   scrim: 0.40)
 ```
 
+**A background is shareable; a logo is not.** Artwork rides the gem on purpose,
+so a brand-new app sends good-looking mail on day one. A wordmark is somebody's
+identity, so `logo:` must name a file **your app** ships. Two traps make getting
+this wrong silent:
+
+- **A logical path that your app does not ship resolves to the ENGINE's copy.**
+  turf-monster registered `"emails/logo-horizontal.png"`, shipped no such file,
+  and Sprockets served studio-engine's — its sign-in email went out carrying the
+  McRITCHIE STUDIO wordmark. Nothing raised.
+- **The alt text agrees with you, not with the pixels.** `Studio::Banner` sets it
+  from `Studio.app_name`, so it reads as your app's name over whatever picture
+  actually loaded.
+
+`logo:` merges three ways: omitted or `nil` **inherits** whatever the entry
+already had, `""` **clears** it, and a path **sets** it. So deleting a `logo: ""`
+line does not remove the logo — it restores the inherited one.
+
+What each `STANDARD` entry lends today:
+
+| Entry | Seeds a logo? |
+|---|---|
+| `newsletter_subscribed` | **No.** A host that names none sends none. |
+| `magic_link` | **Yes** — `emails/logo-horizontal.png`, the Studio wordmark. A host that has not registered its own mark inherits it. |
+
+If you are **bumping this gem** into an app that registers no email entries, that
+second row is an upgrade trap: the app gains a Studio wordmark on its sign-in
+email without changing a line of its own. Register a `magic_link` logo your app
+ships — or `logo: ""` — in the same bump.
+
 **Why layered rather than composited.** Drawing the text into the image gives
 pixel-exact brand typography everywhere, but it cannot have an ANIMATED
 background AND per-recipient text — composing a greeting into sixty frames means

data/app/services/studio/email_catalog.rb

@@ -166,7 +166,12 @@ module Studio
         # layer since the day it was written, so a baked-in copy of the same
         # picture would be a second thing to keep in sync and never be shown.
         background: "emails/newsletter-subscribed-background.gif",
-        logo: "emails/logo-horizontal.png",
+        # NO logo: KEY, and adding one back is the bug. It seeded
+        # "emails/logo-horizontal.png" — the McRITCHIE STUDIO wordmark — into
+        # every host that registers this email without naming a logo of its own,
+        # because register() merges on `logo.presence` and an omitted key
+        # inherits. Full reasoning under NO DEFAULT LOGO below; the guards are in
+        # test/integration/newsletter_email_test.rb.
         header: "Welcome {name}!",
         header_fallback: "You're subscribed!",
         subtext: "you're on the list",
@@ -194,19 +199,62 @@ module Studio
     ASPECT_RATIO = 2.0
     MAX_WIDTH = 1200
 
-    # NO DEFAULT LOGO, deliberately.
+    # NO DEFAULT LOGO, deliberately — on any route.
+    #
+    # There is no DEFAULT_LOGO constant here, and newsletter_subscribed above
+    # seeds no logo either. Same rule, learned twice, on two different routes.
     #
-    # It was emails/logo-horizontal.png — the white "McRITCHIE STUDIO" wordmark —
-    # and every consumer inherits this layout without defining its own. That put
-    # Studio branding into turf-monster's entire player-facing mail set, which
-    # today carries none, plus moms-app, mcritchie-industries, acquisition-studio
-    # and rolio, with no opt-in and no host-side change.
+    # The constant went first (DEFAULT_FOOTER_LOGO). It was
+    # emails/logo-horizontal.png — the white "McRITCHIE STUDIO" wordmark —
+    # inherited by every consumer that defines none of its own, with no opt-in and
+    # no host-side change. It reached the apps actually RUNNING that engine:
+    # turf-monster's entire player-facing mail set, which today carries none.
+    # It did NOT reach moms-app, mcritchie-industries or acquisition-studio — they
+    # pin 0.32.1 / 0.32.2 / 0.13.1 and the wordmark first shipped at v0.42.0 — and
+    # rolio is not a consumer at all. Reachability at the PIN, as below.
     #
-    # It also contradicted the rule at the top of this file: the url / resolved_url
+    # The SEED went second, and it is the subtler half: newsletter_subscribed
+    # carried the same file as its banner logo, and register() merges on
+    # `logo.presence` — omitting the key INHERITS. A host registering that email
+    # to relabel it or attach a preview would have inherited the wordmark without
+    # naming it. turf-monster had already been bitten by this on magic_link, where
+    # the sign-in banner sent the Studio wordmark under an alt of "Turf Monster".
+    #
+    # Both contradict the rule at the top of this file: the url / resolved_url
     # split exists so the engine cannot swap a host's artwork for the engine's in
-    # live email. A footer logo is the same swap by another route.
+    # live email. A logo is the same swap by another route — and the ALT TEXT
+    # cannot warn anyone, because Studio::Banner sets it from Studio.app_name, so
+    # it always agrees with the host and never with the pixels.
+    #
+    # ARTWORK still rides the gem, and should: a background is a picture any app
+    # can send, and inheriting one is what gives a new app good-looking mail on
+    # day one. A wordmark is somebody's identity. The line is there, not at
+    # "engine assets are bad".
+    #
+    # Each app opts in with its own mark — in an initializer
+    # (`Studio::EmailCatalog.register("newsletter_subscribed", logo: "emails/our-mark.png")`,
+    # a path THAT APP ships) or on /admin/emails.
+    #
+    # STILL OUTSTANDING, stated so nobody reads this as swept: magic_link above
+    # DOES still seed the wordmark, so a host that registers no mark of its own
+    # inherits it on the sign-in email. turf-monster registers emails/turf-logo.png
+    # and the Studio hub owns the mark, so both are covered.
+    #
+    # It is an UPGRADE TRAP rather than a live leak, which is the sharper shape.
+    # The apps carrying no email initializer are pinned far enough back that this
+    # file does not exist in the gem they run, so they inherit nothing today — but
+    # the routine dependency bump that brings one forward would put another
+    # brand's mark in its most-sent email, with no code change of its own and
+    # nobody looking for it.
+    #
+    # CHECK REACHABILITY AT THE PIN, never from main: `git ls-tree` at the tag the
+    # app resolves, or read the installed gem. "HEAD seeds it" plus "the app
+    # registers nothing" are both true and together say nothing about what that
+    # app RUNS — a wrong conclusion this very comment was first drafted with.
     #
-    # Each app opts in on /admin/emails by pasting its own mark.
+    # Tracked, with the design question it raises — should STANDARD seed a logo at
+    # all, or should hosts opt in? — at /tasks/guard-wordmark-on-engine-bump.
+    # Fixing magic_link alone leaves the next entry free to repeat this.
 
     # The footer band. Dark on purpose: it closes the white card, and a light
     # sign-off floating under body copy reads as part of the message rather than

data/lib/studio/version.rb

@@ -1,3 +1,3 @@
 module Studio
-  VERSION = "0.44.0"
+  VERSION = "0.44.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: studio-engine
 version: !ruby/object:Gem::Version
-  version: 0.44.0
+  version: 0.44.1
 platform: ruby
 authors:
 - Alex McRitchie