studio-engine 0.123.0 → 0.124.0

data/lib/studio.rb

@@ -34,6 +34,7 @@ require "studio/hold_button"
 require "studio/partial_block"
 require "studio/sidebar_sections"
 require "studio/site_footer"
+require "studio/marketing_kit"
 require "studio/booking"
 require "studio/navbar_links"
 require "studio/navbar_signed_out_cta"
@@ -159,6 +160,23 @@ module Studio
   # no-preview holds the old page until the fresh response arrives.
   mattr_accessor :smooth_load,          default: false
 
+  # ---- App-to-app page transitions -----------------------------------------
+  # One of :left, :right, :top, :bottom, or nil (the default: nothing changes).
+  # The way this app's pages move on every page change (docs/PAGE_TRANSITIONS.md).
+  # It is THE one switch: a set direction also turns smooth-load on, whatever
+  # Studio.smooth_load says, because the view transition is what it styles.
+  PAGE_TRANSITION_DIRECTIONS = %i[left right top bottom].freeze
+  mattr_reader :page_transition_direction, default: nil
+
+  def self.page_transition_direction=(value)
+    direction = value.presence&.to_sym
+    unless direction.nil? || PAGE_TRANSITION_DIRECTIONS.include?(direction)
+      raise ArgumentError, "Studio.page_transition_direction must be one of " \
+                           "#{PAGE_TRANSITION_DIRECTIONS.join(', ')} or nil (got #{value.inspect})"
+    end
+    @@page_transition_direction = direction
+  end
+
   # Minimum ms the nav spinner stays visible once shown (_head.html.erb).
   # Apps wrapping multi-second operations in the spinner (e.g. Solana RPC)
   # keep the high default to avoid flicker; smooth-load apps typically drop
@@ -1805,7 +1823,8 @@ module Studio
                                        booking_path: booking_path_for(view), address: site_footer_address,
                                        chat: SiteFooter.chat_row(view, path: site_footer_chat_path,
                                                                        label: site_footer_chat_label,
-                                                                       allowed: site_footer_chat_allowed.nil? ? agent_chat_allowed : site_footer_chat_allowed))
+                                                                       allowed: site_footer_chat_allowed.nil? ? agent_chat_allowed : site_footer_chat_allowed),
+                                       marketing_kit: MarketingKit.page_path(view, host_route_set))
   end
 
   # The host's route set, for the default footer's legal links. nil outside a
@@ -1816,6 +1835,65 @@ module Studio
     ::Rails.application.routes
   end
 
+  # The marketing kit: the public page at /marketing-kit (lib/studio/marketing_kit.rb,
+  # docs/SITE_FOOTER.md). A Hash, or a callable receiving the view. Unset, the logos
+  # and colours derive from the app's own brand artwork and the colours it paints,
+  # so a new app has a working page with no setup.
+  mattr_reader :marketing_kit, default: nil
+
+  def self.marketing_kit=(declared)
+    MarketingKit.validate!(declared)
+    @@marketing_kit = declared
+  end
+
+  # Whether Studio.routes draws /marketing-kit (Studio::MarketingKitController).
+  #
+  # ON BY DEFAULT: every app should have a kit. The helper is
+  # studio_marketing_kit_path, not marketing_kit_path, because the hub already
+  # owns that name, and a second claim on it raises `Invalid route name, already
+  # in use` and takes down the host's route set (see draw_admin_emails_routes).
+  # The PATH can be shared: a host's own /marketing-kit wins, whichever side of
+  # Studio.routes it is drawn on (Studio.marketing_kit_routes).
+  mattr_accessor :draw_marketing_kit_routes, default: true
+
+  # The kit for a view. `declared` lets a page render a kit other than the app's.
+  def self.marketing_kit_for(view, declared: marketing_kit)
+    colors = marketing_kit_colors
+    MarketingKit.resolve(declared, view, logos: theme_logos, theme: colors,
+                                         artwork: [["Navbar logo", navbar_wordmark], ["Footer logo", marketing_kit_lockup(view)]],
+                                         name: site_identity[:title], dark_ground: colors[:dark])
+  end
+
+  # What the app paints: an /admin/theme edit included, as studio_theme_css_tag
+  # reads it. An app with no database, or no table yet, paints its config.
+  def self.marketing_kit_colors
+    return theme_config unless active_record? && defined?(::ThemeSetting)
+
+    ::ThemeSetting.current.resolved_colors
+  rescue StandardError
+    theme_config
+  end
+
+  # The footer's lockup, already resolved for this request where the view is one.
+  def self.marketing_kit_lockup(view)
+    view.studio_site_footer_facts&.dig(:lockup) if view.respond_to?(:studio_site_footer_facts)
+  end
+
+  # Draws the page into `router`, unless the host's own /marketing-kit got there
+  # first: then this draws nothing, and the host's page is the only route. A host
+  # route drawn later is handled at request time, by the route's constraint.
+  #
+  # Studio.routes calls this. An app with no database cannot call Studio.routes
+  # (docs/SITE_FOOTER.md, "An app with no database") and calls this alone.
+  def self.marketing_kit_routes(router)
+    router.instance_exec do
+      next if MarketingKit.host_route?(@set)
+
+      get MarketingKit::PATH.delete_prefix("/"), to: "#{MarketingKit::CONTROLLER}#show", as: MarketingKit::ROUTE_NAME,
+          format: false, constraints: MarketingKit::YieldToHostRoute.new(@set)
+    end
+  end
+
   # Navbar links resolved for a view context (lib/studio/navbar_links.rb).
   def self.navbar_links_for(view)
     NavbarLinks.resolve(navbar_links, view)
@@ -2112,6 +2190,10 @@ module Studio
         get "schedule", to: "studio/bookings#show", as: :studio_booking
       end
 
+      # The marketing kit (/marketing-kit): public, ON by default. A host's own
+      # page of the same path wins. See Studio.marketing_kit_routes.
+      Studio.marketing_kit_routes(self) if Studio.draw_marketing_kit_routes
+
       # The living style guide (StyleController#index).
       get   "admin/style",            to: "style#index",               as: :admin_style
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: studio-engine
 version: !ruby/object:Gem::Version
-  version: 0.123.0
+  version: 0.124.0
 platform: ruby
 authors:
 - Alex McRitchie
@@ -466,6 +466,7 @@ files:
 - app/controllers/studio/links_controller.rb
 - app/controllers/studio/local_emails_controller.rb
 - app/controllers/studio/local_reviews_controller.rb
+- app/controllers/studio/marketing_kit_controller.rb
 - app/controllers/studio/models_controller.rb
 - app/controllers/studio/onboarding_controller.rb
 - app/controllers/studio/profiles_controller.rb
@@ -503,6 +504,7 @@ files:
 - app/javascript/studio/controllers/agent_chat_voice_controller.js
 - app/javascript/studio/controllers/board_controller.js
 - app/javascript/studio/controllers/booking_controller.js
+- app/javascript/studio/controllers/copy_text_controller.js
 - app/javascript/studio/controllers/email_banner_scale_controller.js
 - app/javascript/studio/controllers/footer_map_controller.js
 - app/javascript/studio/controllers/geo_settings_controller.js
@@ -514,6 +516,7 @@ files:
 - app/javascript/studio/controllers/microphone_chip_controller.js
 - app/javascript/studio/controllers/modal_host_controller.js
 - app/javascript/studio/controllers/nav_collapse_controller.js
+- app/javascript/studio/controllers/page_header_controller.js
 - app/javascript/studio/controllers/style_modals_controller.js
 - app/javascript/studio/controllers/style_section_nav_controller.js
 - app/javascript/studio/controllers/survey_controller.js
@@ -545,6 +548,8 @@ files:
 - app/javascript/studio/modal_host.js
 - app/javascript/studio/nav_collapse.js
 - app/javascript/studio/newsletter_modal.js
+- app/javascript/studio/page_header.js
+- app/javascript/studio/page_transitions.js
 - app/javascript/studio/pinned_stack.js
 - app/javascript/studio/profile_form.js
 - app/javascript/studio/sticky_table_header.js
@@ -635,6 +640,7 @@ files:
 - app/views/studio/_hold_button.html.erb
 - app/views/studio/_hold_button_guard.html.erb
 - app/views/studio/_leveling_activity_assets.html.erb
+- app/views/studio/_page_header.html.erb
 - app/views/studio/_session_stamp.html.erb
 - app/views/studio/admin_models/_arenas_table.html.erb
 - app/views/studio/admin_models/_sessions_table.html.erb
@@ -699,6 +705,9 @@ files:
 - app/views/studio/loader/_overlay.html.erb
 - app/views/studio/local_emails/index.html.erb
 - app/views/studio/mailers/_layered_banner.html.erb
+- app/views/studio/marketing_kit/_assets.html.erb
+- app/views/studio/marketing_kit/_kit.html.erb
+- app/views/studio/marketing_kit/show.html.erb
 - app/views/studio/modals/_crop_photo.html.erb
 - app/views/studio/modals/_host.html.erb
 - app/views/studio/modals/_image_upload.html.erb
@@ -871,6 +880,7 @@ files:
 - lib/studio/log_rotation.rb
 - lib/studio/mail_sender.rb
 - lib/studio/mail_transport.rb
+- lib/studio/marketing_kit.rb
 - lib/studio/name_parts.rb
 - lib/studio/navbar_account_sidebar.rb
 - lib/studio/navbar_brand.rb