studio-engine 0.51.0 → 0.52.1

data/lib/studio/newsletter.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# The newsletter subscription's rules. Pure Ruby and duck-typed, like
+# Studio::OauthIdentity and Studio::ProfileImage — it loads without Rails, takes
+# any object that answers the readers, and the unit suite exercises it without
+# booting the dummy app.
+#
+# TWO TIMESTAMPS, NOT A BOOLEAN, and this is the decision the rest of the file
+# follows from. `joined_email_list_at` and `left_email_list_at` are lifted from
+# turf-monster, which has run this shape in production, and the pair carries
+# three states a boolean cannot:
+#
+#   never asked   both nil            — distinct from "unsubscribed"
+#   subscribed    joined after left   — including a REJOIN, where both are set
+#   unsubscribed  left after joined   — and the leave date survives the rejoin
+#
+# The third row is why turf keeps them: its 25-seed welcome bonus is once-ever,
+# guarded on-chain, and "have they EVER joined" is a different question from "are
+# they on the list today". A boolean answers neither. None of turf's seed
+# machinery belongs in the engine — but the state shape does, because a consumer
+# that adopts this and later wants that rule must not have to migrate away from a
+# flag first.
+module Studio
+  module Newsletter
+    module_function
+
+    # The columns a host must have for any of this to mean anything. The profile
+    # row declares the same pair in `requires:`, so a host without them silently
+    # gets no newsletter card rather than a NoMethodError on every page load.
+    COLUMNS = %i[joined_email_list_at left_email_list_at].freeze
+
+    def serves?(user)
+      return false if user.nil?
+
+      COLUMNS.all? { |column| user.respond_to?(column) }
+    end
+
+    # On the list right now.
+    #
+    # `joined > left` rather than `left.nil?`, because a REJOIN leaves both set
+    # and the later date wins. Reading only `left_email_list_at.nil?` would call
+    # every rejoined account unsubscribed forever.
+    def subscribed?(user)
+      return false unless serves?(user)
+
+      joined = user.joined_email_list_at
+      return false if joined.nil?
+
+      left = user.left_email_list_at
+      left.nil? || joined > left
+    end
+
+    # Has this account EVER been on the list? Distinct from `subscribed?`, and the
+    # question a once-ever welcome bonus asks. The engine does not pay bonuses; it
+    # answers the question so a consumer that does never has to reach past this
+    # module into the columns.
+    def ever_joined?(user)
+      serves?(user) && !user.joined_email_list_at.nil?
+    end
+
+    # A newsletter needs somewhere to send. An account with no address on file —
+    # a wallet-only sign-in, which turf-monster has plenty of — has to supply one
+    # before it can subscribe, so the UI asks rather than failing the submit.
+    def needs_email?(user)
+      return false unless serves?(user)
+
+      !user.respond_to?(:email) || user.email.to_s.strip.empty?
+    end
+  end
+end

data/lib/studio/profile_sections.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+# REQUIRED HERE, not left to lib/studio.rb's ordering. DEFAULTS names
+# Studio::Newsletter::COLUMNS at LOAD time, and profile_sections is required
+# BEFORE newsletter in that file — so without this line the constant is undefined
+# and the engine fails to boot. Declaring the dependency where it is used makes
+# the pair immune to a future reorder of that require list.
+require_relative "newsletter"
+
 # Resolves Studio.profile_sections — the rows that make up the shared /profile
 # page — for a given view context. Pure Ruby (no Rails dependency) so the unit
 # suite exercises the resolution rules without booting the dummy app.
@@ -33,12 +40,19 @@
 #              AND `auth_methods = %i[magic_link]` with no omniauth gem at all,
 #              so it would have rendered a "Link Google Account" button leading
 #              nowhere. Having a column is not the same as offering the feature.
-#   modals   — the row opens the shared crop/saving modals. The PAGE mounts them
-#              once (studio/modals/_scoped_host on a "profileModals" store) when
-#              any resolved row asks for them, so a row never has to know whether
-#              the host app renders a modal host of its own. Two of the five
-#              consumers render none at all, and the two that do ship a FORK of
-#              the engine's shared host that would shadow it.
+#   modals   — a partial of modal registrations this row needs, or nil. The PAGE
+#              mounts studio/modals/_scoped_host on a "profileModals" store when
+#              ANY resolved row declares one, and renders each declared partial
+#              inside it — so a row never has to know whether the host app renders
+#              a modal host of its own. Two of the five consumers render none at
+#              all, and the two that do ship a FORK of the engine's shared host
+#              that would shadow it.
+#
+#              A PATH, not a boolean, and not derived from `key`. A host row
+#              declaring modals keeps its partial in the host's own app, so any
+#              convention like "studio/profiles/#{key}_modals" would resolve to a
+#              path that does not exist there. Saying it outright costs one string
+#              and works for everyone.
 #
 # ON `requires` — this is the whole reason the registry exists rather than a
 # hardcoded page. The consuming apps do NOT agree on their users table:
@@ -73,6 +87,19 @@ module Studio
         partial: "studio/profiles/google_section", requires: %i[provider uid],
         if: -> { Studio.auth_method?(:google) } },
 
+      # The mailing list. READ-level for the same reason Google is: it is a state
+      # you look at and occasionally flip, not a field you type into.
+      #
+      # `modals: true` is what makes the page mount a host — leaving asks for
+      # confirmation, and an account with no address on file is asked for one.
+      # This is the FIRST row to declare the flag, which the registry has
+      # documented since it shipped; before this the read page mounted no host at
+      # all, correctly, because nothing asked.
+      { key: :newsletter, title: "Newsletter", page: :show,
+        partial: "studio/profiles/newsletter_section",
+        requires: Studio::Newsletter::COLUMNS,
+        modals: "studio/profiles/newsletter_modals" },
+
       # --- the edit page ------------------------------------------------------
       # These are FIELDS in one form with one Save, so they carry no buttons of
       # their own. Email included: it needed a separate action only while it was

data/lib/studio/version.rb

@@ -1,3 +1,3 @@
 module Studio
-  VERSION = "0.51.0"
+  VERSION = "0.52.1"
 end

data/lib/studio.rb

@@ -10,6 +10,7 @@ require "studio/sidebar_sections"
 require "studio/profile_sections"
 require "studio/profile_image"
 require "studio/oauth_identity"
+require "studio/newsletter"
 require "studio/username_generator"
 require "studio/s3"
 require "studio/image_cache"
@@ -690,6 +691,14 @@ module Studio
         # here: it is OmniAuth's own /auth/:provider, which the middleware owns.
         delete "profile/google", to: "studio/profiles#unlink_google",
                as: :profile_unlink_google
+
+        # POST joins, DELETE leaves — the verbs the two actions actually are, on
+        # one path. Not a PATCH on the profile: subscribing is its own decision
+        # with its own confirmation, and folding it into the bulk field save would
+        # mean every name change re-asserted a mailing-list preference.
+        post   "profile/newsletter", to: "studio/profiles#subscribe_newsletter",
+               as: :profile_newsletter
+        delete "profile/newsletter", to: "studio/profiles#unsubscribe_newsletter"
       end
 
       resources :error_logs, only: [:index, :show]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: studio-engine
 version: !ruby/object:Gem::Version
-  version: 0.51.0
+  version: 0.52.1
 platform: ruby
 authors:
 - Alex McRitchie
@@ -175,6 +175,7 @@ files:
 - app/assets/images/emails/newsletter-subscribed-background.gif
 - app/assets/images/resend-favicon.png
 - app/assets/images/ses-favicon.png
+- app/assets/javascripts/studio/alpine.js
 - app/assets/javascripts/studio/canvas_confetti.js
 - app/assets/javascripts/studio/sortable.js
 - app/assets/javascripts/studio/sticky_table_header.js
@@ -339,6 +340,7 @@ files:
 - app/views/studio/profile_mailer/email_change_notification.html.erb
 - app/views/studio/profile_mailer/email_change_notification.text.erb
 - app/views/studio/profiles/_birthday_fields.html.erb
+- app/views/studio/profiles/_birthday_picker_script.html.erb
 - app/views/studio/profiles/_editable_identity.html.erb
 - app/views/studio/profiles/_email_fields.html.erb
 - app/views/studio/profiles/_form_script.html.erb
@@ -348,6 +350,8 @@ files:
 - app/views/studio/profiles/_identity_mini.html.erb
 - app/views/studio/profiles/_identity_styles.html.erb
 - app/views/studio/profiles/_name_fields.html.erb
+- app/views/studio/profiles/_newsletter_modals.html.erb
+- app/views/studio/profiles/_newsletter_section.html.erb
 - app/views/studio/profiles/_pencil_icon.html.erb
 - app/views/studio/profiles/_save_bar.html.erb
 - app/views/studio/profiles/edit.html.erb
@@ -392,6 +396,7 @@ files:
 - lib/studio/link_token.rb
 - lib/studio/log_rotation.rb
 - lib/studio/mail_transport.rb
+- lib/studio/newsletter.rb
 - lib/studio/oauth_identity.rb
 - lib/studio/profile_image.rb
 - lib/studio/profile_sections.rb