studio-engine 0.48.0 → 0.50.0

data/lib/studio/profile_sections.rb

@@ -12,8 +12,8 @@
 #
 # What a section looks like:
 #
-#   { key: :avatar, title: "Profile photo", partial: "studio/profiles/avatar_section",
-#     locals: { ... }, requires: :avatar, admin: false }
+#   { key: :name, title: "Name", page: :edit, partial: "studio/profiles/name_fields",
+#     locals: { ... }, requires: :first_name, admin: false }
 #
 #   key      — stable identifier. A host removes or replaces a default by key,
 #              so reordering the defaults never breaks a host's override.
@@ -48,27 +48,44 @@
 # Studio.first_name_outstanding? already guards against with respond_to?.
 #
 # So a row DECLARES what it needs and is dropped when the host cannot serve it.
-# mcritchie-industries gets a working profile page with an avatar row and no name
-# row until it installs the standard-profile-columns migration, at which point
-# the row appears with no code change. Silence, not a 500.
+# mcritchie-industries gets a working edit page with an email field and no name
+# or birthday fields until it installs the standard-profile-columns migration, at
+# which point they appear with no code change. Silence, not a 500.
 module Studio
   module ProfileSections
-    # The page every consumer gets for free. Iteration one is deliberately two
-    # rows: the picture and the name. Everything else the account-standardization
-    # program lifts (email change, identities, preferences) arrives as further
-    # defaults, and a host that has declared its own list keeps working because
-    # it composes against `Studio.default_profile_sections` rather than a literal.
+    # Which page a row belongs to. `:show` is the read page (/profile) — things
+    # you look at and occasionally act on; `:edit` is the form (/profile/edit).
+    PAGES = %i[show edit].freeze
+
+    # The rows every consumer gets for free.
+    #
+    # THE AVATAR IS NOT HERE, and that is a change rather than an omission: it
+    # moved into the identity header both pages render, where it sits with the
+    # display name and the address. It stopped being a row when it stopped
+    # looking like one.
     DEFAULTS = [
-      { key: :avatar, title: "Profile photo",
-        partial: "studio/profiles/avatar_section", requires: :avatar, modals: true },
-      { key: :first_name, title: "Your name",
-        partial: "studio/profiles/first_name_section", requires: :first_name },
-      # Gated on the app OFFERING Google, not merely on having the columns —
-      # the same question app/views/sessions/new.html.erb:79 already asks before
-      # drawing this identical button on the login page.
-      { key: :google, title: "Google account",
+      # --- the read page ------------------------------------------------------
+      # Google is an identity you CONNECT, not a field you type, which is why it
+      # reads rather than edits. Gated on the app OFFERING Google, not merely on
+      # having the columns — the same question app/views/sessions/new.html.erb
+      # already asks before drawing this identical button on the login page.
+      { key: :google, title: "Google account", page: :show,
         partial: "studio/profiles/google_section", requires: %i[provider uid],
-        if: -> { Studio.auth_method?(:google) } }
+        if: -> { Studio.auth_method?(:google) } },
+
+      # --- 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
+      # out-of-band, and now that it applies directly there is no reason for a
+      # second mechanism on the same page. Its side effects — the Google lock,
+      # notifying the old address, invalidating other sessions — are the server's
+      # business, not the form's.
+      { key: :name, title: "Name", page: :edit,
+        partial: "studio/profiles/name_fields", requires: :first_name },
+      { key: :email, title: "Email", page: :edit,
+        partial: "studio/profiles/email_fields", requires: :email },
+      { key: :birthday, title: "Birthday", page: :edit,
+        partial: "studio/profiles/birthday_fields", requires: %i[birth_day birth_month birth_year] }
     ].freeze
 
     module_function
@@ -86,7 +103,9 @@ module Studio
     # `nil` meaning "the defaults" rather than "no sections" is the load-bearing
     # choice here: it is what makes a brand-new app's profile page work with an
     # empty initializer, which is the entire point of standardizing this.
-    def resolve(declared, view)
+    # `page:` selects a subset. nil means every page, which is what the pre-split
+    # callers passed and what a host asking "all of them" wants.
+    def resolve(declared, view, page: nil)
       sections = declared.respond_to?(:call) ? declared.call(view) : declared
       sections = defaults if sections.nil?
 
@@ -95,6 +114,7 @@ module Studio
 
       Array(sections)
         .map { |section| symbolize(section) }
+        .reject { |section| page && page_of(section) != page.to_sym }
         .reject { |section| section[:admin] && !admin }
         .select { |section| enabled?(section[:if], view) }
         .select { |section| served_by?(user, section[:requires]) }
@@ -116,9 +136,21 @@ module Studio
       # that silently does nothing, in the same permissive direction as the bug
       # this whole `if:` key was added to fix. A host would have had no signal.
       if condition.is_a?(Symbol) || condition.is_a?(String)
-        return false unless view.respond_to?(condition)
+        unless view.respond_to?(condition)
+          # SILENT would repeat the bug this key was added to fix. The old
+          # coercion gave the host no signal; dropping the row without one only
+          # moves the silence somewhere safer. A typo'd gate now says so.
+          warn_gate("profile_sections: `if: #{condition.inspect}` names a method the view " \
+                    "does not answer — the row was dropped. Check the spelling.")
+          return false
+        end
 
-        return !!view.public_send(condition)
+        # Arity-aware, matching the lambda branch below: a predicate written as
+        # `def visible?(view)` is as natural as one written without an argument,
+        # and calling it wrong raises ArgumentError — which surfaces as a 500 on
+        # /profile rather than as a dropped row.
+        method = view.method(condition)
+        return !!(method.arity.zero? ? view.public_send(condition) : view.public_send(condition, view))
       end
 
       return !!condition unless condition.respond_to?(:call)
@@ -129,6 +161,12 @@ module Studio
     # Can this host's user model serve the row? No requirement means yes — a row
     # that reads nothing off the user (a static explainer, a link out) is always
     # served. A nil user means we are rendering for nobody, and nothing is served.
+    # A row that never says defaults to :edit — someone adding a row is usually
+    # adding a field, and the read page is a deliberate, curated surface.
+    def page_of(section)
+      (section[:page] || :edit).to_sym
+    end
+
     def served_by?(user, requires)
       needed = Array(requires).compact
       return true if needed.empty?
@@ -137,6 +175,15 @@ module Studio
       needed.all? { |attribute| user.respond_to?(attribute) }
     end
 
+    # Pure Ruby: this file loads without Rails, so it cannot assume a logger.
+    def warn_gate(message)
+      if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+        Rails.logger.warn(message)
+      else
+        Kernel.warn(message)
+      end
+    end
+
     def symbolize(hash)
       out = hash.to_h.each_with_object({}) { |(key, value), acc| acc[key.to_sym] = value }
 

data/lib/studio/sidebar_sections.rb

@@ -15,6 +15,11 @@
 # Sections flagged admin: true resolve only for admin? viewers, so the
 # trigger and panel stay invisible to everyone else even when the host
 # declares nothing but admin links.
+#
+# THE ENGINE PREPENDS ONE SECTION OF ITS OWN — "You", linking to /profile. The
+# engine ships that page, so it ships the way in rather than asking five apps to
+# declare the same entry and watch them drift. See `standard` below for the two
+# gates it carries.
 module Studio
   module SidebarSections
     module_function
@@ -22,9 +27,48 @@ module Studio
     def resolve(declared, view)
       sections = declared.respond_to?(:call) ? declared.call(view) : declared
       admin = view.respond_to?(:admin?) && view.admin?
-      Array(sections).map { |section| symbolize(section) }
-                     .reject { |section| section[:admin] && !admin }
-                     .map { |section| section.merge(links: Array(section[:links]).map { |link| symbolize(link) }) }
+      (standard(view) + Array(sections))
+        .map { |section| symbolize(section) }
+        .reject { |section| section[:admin] && !admin }
+        .map { |section| section.merge(links: Array(section[:links]).map { |link| symbolize(link) }) }
+    end
+
+    # What the ENGINE puts in every app's sidebar, ahead of whatever the host
+    # declared. The engine ships /profile, so it ships the way in — otherwise
+    # every consumer writes the same entry and they drift in wording and emoji.
+    #
+    # PREPENDED, not appended: it is the viewer's own account, the thing nearest
+    # to them, and the operator asked for it at the top.
+    #
+    # TWO GATES, and both are load-bearing:
+    #
+    #   * the route must be drawn. An app that set draw_profile_routes = false
+    #     would otherwise be handed a menu item pointing at a route that does not
+    #     exist — a 404 from its own navigation.
+    #   * the viewer must be signed in. /profile requires authentication, so
+    #     offering it to a signed-out visitor bounces them to the login page from
+    #     something that looked like navigation. Same shape as the `admin:` rule
+    #     below, which already drops sections a viewer may not see.
+    #
+    # A view that answers neither predicate (a bare context in a unit test) gets
+    # nothing, which is the safe direction: a missing link is visible and
+    # fixable, a link to nowhere is the bug.
+    def standard(view)
+      return [] unless profile_link?(view)
+
+      [{ title: "You", links: [
+        { label: "Profile", href: view.profile_path, emoji: "👤",
+          desc: "Your name, email and photo" }
+      ] }]
+    end
+
+    def profile_link?(view)
+      return false unless defined?(Studio) && Studio.respond_to?(:draw_profile_routes)
+      return false unless Studio.draw_profile_routes
+      return false unless view.respond_to?(:profile_path)
+      return false unless view.respond_to?(:logged_in?) && view.logged_in?
+
+      true
     end
 
     def symbolize(hash)

data/lib/studio/version.rb

@@ -1,3 +1,3 @@
 module Studio
-  VERSION = "0.48.0"
+  VERSION = "0.50.0"
 end

data/lib/studio.rb

@@ -613,8 +613,8 @@ module Studio
   # the view, keys symbolize, admin-only rows drop for non-admin viewers, and
   # rows this host's user model cannot serve drop entirely. `nil` config resolves
   # to the standard page.
-  def self.profile_sections_for(view)
-    ProfileSections.resolve(profile_sections, view)
+  def self.profile_sections_for(view, page: nil)
+    ProfileSections.resolve(profile_sections, view, page: page)
   end
 
   def self.env_truthy?(value)
@@ -683,6 +683,7 @@ module Studio
       # both would delete someone's photo every time they edited their name.
       if Studio.draw_profile_routes
         get    "profile",        to: "studio/profiles#show",   as: :profile
+        get    "profile/edit",   to: "studio/profiles#edit",   as: :edit_profile
         patch  "profile",        to: "studio/profiles#update"
         patch  "profile/avatar", to: "studio/profiles#avatar", as: :profile_avatar
         # DELETE, because unlinking removes an identity. Linking is not drawn

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: studio-engine
 version: !ruby/object:Gem::Version
-  version: 0.48.0
+  version: 0.50.0
 platform: ruby
 authors:
 - Alex McRitchie
@@ -216,6 +216,7 @@ files:
 - app/jobs/studio/email_delivery_job.rb
 - app/mailers/application_mailer.rb
 - app/mailers/studio/newsletter_mailer.rb
+- app/mailers/studio/profile_mailer.rb
 - app/mailers/user_mailer.rb
 - app/models/concerns/sluggable.rb
 - app/models/concerns/studio/board/rankable.rb
@@ -335,9 +336,21 @@ files:
 - app/views/studio/models/show.html.erb
 - app/views/studio/newsletter_mailer/subscribed.html.erb
 - app/views/studio/newsletter_mailer/subscribed.text.erb
-- app/views/studio/profiles/_avatar_section.html.erb
-- app/views/studio/profiles/_first_name_section.html.erb
+- 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/_editable_identity.html.erb
+- app/views/studio/profiles/_email_fields.html.erb
+- app/views/studio/profiles/_form_script.html.erb
 - app/views/studio/profiles/_google_section.html.erb
+- app/views/studio/profiles/_identity.html.erb
+- app/views/studio/profiles/_identity_body.html.erb
+- 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/_pencil_icon.html.erb
+- app/views/studio/profiles/_save_bar.html.erb
+- app/views/studio/profiles/edit.html.erb
 - app/views/studio/profiles/show.html.erb
 - app/views/style/_modal_specimen.html.erb
 - app/views/style/_modals.html.erb

data/app/views/studio/profiles/_avatar_section.html.erb

@@ -1,93 +0,0 @@
-<%# Profile photo row — lifted from turf-monster's /account, which is the
-    interaction the operator wants standardized: click the avatar, hover reveals
-    an "Update" cap, pick a file, crop it square, and it saves immediately. No
-    Save button, no visible file field.
-
-    Locals: user (required).
-
-    HOW IT HANGS TOGETHER
-      imageUploadHost()      the engine's crop-then-immediate-save x-data factory
-                             (studio/modals/_image_upload). onFileSelected() reads
-                             the picked file and opens the crop modal; the modal
-                             dispatches the cropped Blob back on
-                             'crop-photo-confirmed'; applyCrop() drops it into the
-                             hidden form's file input and submits with a saving
-                             card.
-      profileModals          the PAGE-SCOPED Alpine store mounted by show.html.erb.
-                             Not the shared "modals" store — see below.
-      profile_avatar_path    its own endpoint, because an attachment param
-                             submitted empty PURGES the attachment.
-
-    WHY THE PAGE-SCOPED STORE AND NOT `modals`. turf's copy opens on
-    Alpine.store('modals') — the app's shared modal host — which works there
-    because turf's layout mounts one and registers crop-photo in it. Two of the
-    five consumers (mcritchie-industries, moms-app) render NO shared host at all,
-    and the two that do would each have to add a crop-photo registration to their
-    layout before this row worked. An engine page cannot ask that. show.html.erb
-    mounts studio/modals/_scoped_host instead, so the page brings its own modals
-    and this row behaves identically in every app. /admin/emails already does
-    exactly this.
-
-    WHY onCropConfirmed AND NOT applyCrop DIRECTLY. turf's call site binds
-    `applyCrop($event.detail.blob)`, which predates the owner guard. Every
-    imageUploadHost on a page hears the same window event, so a page that later
-    grows a second uploader (a host row with its own image) would have both
-    hosts save the same crop. onCropConfirmed() checks the owner token first and
-    is a strict improvement at the same call cost.
-
-    ON THE INLINE PIXEL SIZES. Same reason turf gives: the exact circle geometry
-    is expressed inline rather than through w-24/h-24, because a size utility
-    only exists if something already emitted it into the compiled bundle. The
-    classes used here (group-hover:opacity-100, rounded-full, object-cover,
-    absolute inset-0) already ship in other engine partials.
-%>
-<div x-data="imageUploadHost({
-       store: 'profileModals',
-       aspectRatio: 1,
-       filename: 'avatar.png',
-       saving: 'Saving photo…',
-       toast: false
-     })"
-     @crop-photo-confirmed.window="onCropConfirmed($event.detail)"
-     class="flex flex-col items-center">
-
-  <%# Auto-submitted once a crop is confirmed. Hidden because the person never
-      touches it — applyCrop() writes the cropped File onto fileInput and calls
-      submitFormWithProgress on form. %>
-  <%= form_with url: profile_avatar_path, method: :patch, scope: :profile,
-                html: { multipart: true, "x-ref": "form", class: "hidden" } do %>
-    <input type="file" name="profile[avatar]" x-ref="fileInput">
-  <% end %>
-
-  <%# The real picker. Opened by the avatar button; never shown. %>
-  <input type="file" x-ref="filePicker" @change="onFileSelected($event)"
-         accept="<%= Studio::ProfileImage::ALLOWED_CONTENT_TYPES.join(",") %>" class="hidden">
-
-  <%# The clickable avatar. A BUTTON rather than turf's <div @click>: a div is
-      unreachable by keyboard and invisible to a screen reader, so the only way
-      to change your photo would be a mouse. Same visual, and it focuses. %>
-  <button type="button"
-          @click="$refs.filePicker.click()"
-          aria-label="Change your profile photo"
-          style="width: 96px; height: 96px;"
-          class="relative rounded-full cursor-pointer group overflow-hidden mb-3 flex-shrink-0 p-0 border-0 bg-transparent">
-    <% if user.avatar.attached? %>
-      <%= image_tag user.avatar, class: "rounded-full object-cover",
-                    style: "width: 96px; height: 96px;", alt: user.display_name %>
-    <% else %>
-      <div class="rounded-full flex items-center justify-center font-bold text-white text-3xl"
-           style="width: 96px; height: 96px; background-color: <%= user.avatar_color %>">
-        <%= user.avatar_initials %>
-      </div>
-    <% end %>
-
-    <%# The hover cap. group-hover reveals it on pointer; focus-within is the
-        keyboard equivalent, so a tabbing user sees the same affordance. %>
-    <span class="absolute inset-0 rounded-full flex items-center justify-center opacity-0 group-hover:opacity-100 group-focus:opacity-100 transition-opacity duration-200"
-          style="background: rgba(0,0,0,0.5)">
-      <span class="text-white text-xs font-bold">Update</span>
-    </span>
-  </button>
-
-  <div class="text-xl font-bold text-heading"><%= user.display_name %></div>
-</div>

data/app/views/studio/profiles/_first_name_section.html.erb

@@ -1,26 +0,0 @@
-<%# First-name row.
-
-    Locals: user (required).
-
-    This row only renders when the host's user model actually answers
-    `first_name` — Studio::ProfileSections drops it otherwise, so an app that has
-    not installed the standard profile columns gets a page without this row
-    rather than a NoMethodError on every visit. Nothing here needs to re-check.
-
-    The same column is written by the onboarding step
-    (Studio::OnboardingController#first_name); this is the surface for changing it
-    later.
-%>
-<%= form_with url: profile_path, method: :patch, scope: :profile,
-              data: { turbo: false }, class: "flex flex-wrap items-end gap-3" do |form| %>
-  <div class="flex-1 min-w-0" style="min-width: 12rem;">
-    <label class="block text-sm text-secondary mb-2 font-medium" for="profile_first_name">First name</label>
-    <%= form.text_field :first_name,
-                        value: user.first_name,
-                        maxlength: Studio::FIRST_NAME_MAX_LENGTH,
-                        autocomplete: "given-name",
-                        placeholder: "What should we call you?",
-                        class: "input-field" %>
-  </div>
-  <%= form.submit "Save", class: "btn btn-primary" %>
-<% end %>