studio-engine 0.82.1 → 0.84.0

data/lib/studio.rb

@@ -13,6 +13,8 @@ require "studio/js_literal"
 require "studio/js_identifier"
 require "studio/partial_block"
 require "studio/sidebar_sections"
+require "studio/site_footer"
+require "studio/booking"
 require "studio/navbar_links"
 require "studio/navbar_identity"
 require "studio/profile_sections"
@@ -558,6 +560,119 @@ module Studio
   #   config.draw_public_user_routes = true
   mattr_accessor :draw_public_user_routes, default: false
 
+  # ---- Site footer and booking (Studio::SiteFooter, Studio::Booking) -------
+  #
+  # The public site's footer: brand and social profiles, link columns, an
+  # optional Location band with a live map, and a legal line. And the booking
+  # primitives: Google Calendar's appointment page inline, in a popup, and on a
+  # page. See docs/SITE_FOOTER.md and docs/BOOKING.md.
+
+  # The footer's facts: a Hash, or a callable receiving the view. nil (the
+  # default) means this app has no footer, and `studio_site_footer` renders
+  # nothing, so a layout can call it before the app declares one. Every key is
+  # optional; shape and rules: lib/studio/site_footer.rb.
+  #
+  #   config.site_footer = ->(view) {
+  #     { tagline: "Everything, by example",
+  #       address: { street: "123 Example St", city_line: "Washington, DC 20024",
+  #                  lat: 38.8894, lng: -77.0352 },
+  #       columns: [ [ "Company", [ [ "Home", view.root_path ], [ "Career", nil ] ] ] ],
+  #       legal:   [ [ "Privacy Policy", view.privacy_path ] ] }
+  #   }
+  mattr_reader :site_footer, default: nil
+
+  def self.site_footer=(declared)
+    SiteFooter.validate!(declared)
+    @@site_footer = declared
+  end
+
+  # Controllers whose pages keep the footer for a SIGNED-IN viewer, by
+  # controller name ("landing") or path ("admin/reports"). A visitor gets the
+  # footer on every page; a signed-in viewer gets it only here, because every
+  # other signed-in page is a working surface (a board, a queue, an editor) and
+  # stays full height. The booking page (the engine's, or the app's own at
+  # Studio.booking_path) is always included.
+  #
+  #   config.site_footer_controllers = %w[landing packages contact_submissions]
+  mattr_accessor :site_footer_controllers, default: []
+
+  # THE WHOLE RULE for where the footer shows, as one callable receiving the
+  # view. The default is the rule above: every page for a visitor, the listed
+  # controllers for a signed-in viewer. That default shows the footer on ANY page
+  # a signed-out visitor can reach, an app page included, so an app with public
+  # working pages narrows it here. Compose with the default rather than
+  # restating it:
+  #
+  #   config.site_footer_visible = ->(view) {
+  #     Studio::SiteFooter.default_visible?(view) && !view.controller_path.start_with?("games/")
+  #   }
+  mattr_reader :site_footer_visible, default: ->(view) { Studio::SiteFooter.default_visible?(view) }
+
+  def self.site_footer_visible=(rule)
+    SiteFooter.validate_visible!(rule)
+    @@site_footer_visible = rule
+  end
+
+  # The app's Google Calendar appointment schedule: the public link Google gives
+  # you to share, WITHOUT `?gv=true` (the frame and the popup add it). nil (the
+  # default) means no booking: `studio_booking_frame` and `studio_booking_popup`
+  # render nothing and no link opens a popup.
+  #
+  #   config.booking_url = "https://calendar.google.com/calendar/appointments/schedules/EXAMPLE-SCHEDULE-ID"
+  mattr_reader :booking_url, default: nil
+
+  def self.booking_url=(url)
+    Booking.validate!(url)
+    @@booking_url = url.to_s.strip.empty? ? nil : Booking.page_url(url)
+  end
+
+  # Draw the booking page, GET /schedule (Studio::BookingsController, route
+  # helper studio_booking_path). OFF by default, like every route surface a
+  # consumer might already own: mcritchie-studio draws its own /schedule today,
+  # and its adoption turns this on as it deletes that route. With the flag on and
+  # no booking_url the page answers 404.
+  #
+  #   config.draw_booking_routes = true
+  mattr_accessor :draw_booking_routes, default: false
+
+  # WHERE THE APP'S OWN BOOKING PAGE LIVES, for an app that renders
+  # `studio_booking_frame` in a view of its own instead of drawing the engine's
+  # /schedule: a path ("/schedule"), or a callable receiving the view
+  # (`->(view) { view.schedule_path }`). nil (the default) leaves the engine's
+  # page, when drawn, as the booking page. With it set, the page is treated as
+  # the engine's own is: a footer link to it opens the popup, `studio_booking_link`
+  # falls back to it, and it keeps the footer for a signed-in viewer. It wins
+  # over the engine's page when both are declared. It is written into hrefs, so
+  # it must be a local path (one leading "/"); see Studio::Booking.local_path?.
+  #
+  #   config.booking_path = "/schedule"
+  mattr_reader :booking_path, default: nil
+
+  def self.booking_path=(declared)
+    @@booking_path = Booking.normalize_path(declared)
+  end
+
+  # The booking page's path for a view: Studio.booking_path, else the engine's
+  # /schedule when it is drawn, else nil.
+  def self.booking_path_for(view)
+    Booking.path_for(booking_path, view, drawn: draw_booking_routes)
+  end
+
+  # THE FRAME'S CROP AT REST: nil or false (the default) shows Google's whole
+  # page; a Hash of the schedule's measured box crops the frame to the slot
+  # picker until it is used. The numbers belong to ONE schedule, so there is no
+  # default crop: measure with `bin/booking-crop-measure <booking url>` and paste
+  # what it prints. Keys and derivation: lib/studio/booking.rb.
+  #
+  #   config.booking_crop = { top: 200, bottom: 600, frame_height: 720 }
+  mattr_reader :booking_crop, default: nil
+
+  def self.booking_crop=(declared)
+    Booking.validate_crop!(declared)
+    Booking.crop(declared) # reports a crop that cannot be one, at boot
+    @@booking_crop = declared || nil
+  end
+
   # THE APP'S IDENTITY COPY, resolved: { title:, description:, image_url: }.
   # The operator's saved value (Studio::SiteIdentity, edited at
   # /admin/link_preview) wins, then the drafted Studio.site_title /
@@ -1057,6 +1172,17 @@ module Studio
     SidebarSections.resolve(sidebar_sections, view)
   end
 
+  # The site footer's facts resolved for a view (lib/studio/site_footer.rb), or
+  # nil when the app declared none. The name defaults to the site identity's
+  # title and the logo to the navbar logo, so an app that has set those up says
+  # them once.
+  def self.site_footer_for(view)
+    return nil if site_footer.nil?
+
+    SiteFooter.resolve(site_footer, view, name: site_identity[:title], logo: logo_for("Footer Logo"),
+                                          booking_path: booking_path_for(view))
+  end
+
   # Navbar links resolved for a view context (lib/studio/navbar_links.rb).
   def self.navbar_links_for(view)
     NavbarLinks.resolve(navbar_links, view)
@@ -1261,6 +1387,12 @@ module Studio
             format: false, constraints: { username: %r{[^/]+} }
       end
 
+      # The booking page (/schedule): Google Calendar's appointment page inline,
+      # with the site footer. OPT-IN — see Studio.draw_booking_routes.
+      if Studio.draw_booking_routes
+        get "schedule", to: "studio/bookings#show", as: :studio_booking
+      end
+
       # The living style guide. Canonical at /admin/style (StyleController#index);
       # /admin/design_system redirects here but KEEPS its admin_design_system_path
       # helper so a shipped host sidebar link on the old helper still resolves.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: studio-engine
 version: !ruby/object:Gem::Version
-  version: 0.82.1
+  version: 0.84.0
 platform: ruby
 authors:
 - Alex McRitchie
@@ -309,10 +309,12 @@ files:
 - app/assets/images/state-flags/wy.svg
 - app/assets/javascripts/studio/alpine.js
 - app/assets/javascripts/studio/canvas_confetti.js
+- app/assets/javascripts/studio/leaflet.js
 - app/assets/javascripts/studio/session.js
 - app/assets/javascripts/studio/sortable.js
 - app/assets/javascripts/studio/sticky_table_header.js
 - app/assets/javascripts/studio/studio_confetti.js
+- app/assets/stylesheets/studio/leaflet.css
 - app/assets/stylesheets/studio/sticky_table_header.css
 - app/assets/tailwind/studio_engine/engine-motion.css
 - app/assets/tailwind/studio_engine/engine.css
@@ -334,6 +336,7 @@ files:
 - app/controllers/schema_controller.rb
 - app/controllers/sessions_controller.rb
 - app/controllers/solana_sessions_controller.rb
+- app/controllers/studio/bookings_controller.rb
 - app/controllers/studio/email_images_controller.rb
 - app/controllers/studio/emails_controller.rb
 - app/controllers/studio/geo_settings_controller.rb
@@ -355,6 +358,7 @@ files:
 - app/helpers/studio/geo_helper.rb
 - app/helpers/studio/link_preview_helper.rb
 - app/helpers/studio/public_user_helper.rb
+- app/helpers/studio/site_footer_helper.rb
 - app/helpers/studio_email_delivery_helper.rb
 - app/helpers/studio_navbar_helper.rb
 - app/helpers/studio_sidebar_helper.rb
@@ -445,6 +449,10 @@ files:
 - app/views/studio/board/_board.html.erb
 - app/views/studio/board/_card_shell.html.erb
 - app/views/studio/board/_column.html.erb
+- app/views/studio/booking/_assets.html.erb
+- app/views/studio/booking/_frame.html.erb
+- app/views/studio/booking/_popup.html.erb
+- app/views/studio/bookings/show.html.erb
 - app/views/studio/email_images/index.html.erb
 - app/views/studio/emails/_banner_editor.html.erb
 - app/views/studio/emails/_banner_preview.html.erb
@@ -529,10 +537,16 @@ files:
 - app/views/studio/profiles/show.html.erb
 - app/views/studio/public_users/not_found.html.erb
 - app/views/studio/public_users/show.html.erb
+- app/views/studio/site_footer/_assets.html.erb
+- app/views/studio/site_footer/_footer.html.erb
+- app/views/studio/site_footer/_link.html.erb
+- app/views/studio/site_footer/_map.html.erb
+- app/views/studio/site_footer/_social_icon.html.erb
 - app/views/studio/site_identities/edit.html.erb
 - app/views/style/_host.html.erb
 - app/views/style/_modal_specimen.html.erb
 - app/views/style/_modals.html.erb
+- app/views/style/_site_footer.html.erb
 - app/views/style/_specimen.html.erb
 - app/views/style/_tasks.html.erb
 - app/views/style/_theme.html.erb
@@ -573,6 +587,7 @@ files:
 - lib/generators/studio/site_identity/site_identity_generator.rb
 - lib/studio-engine.rb
 - lib/studio.rb
+- lib/studio/booking.rb
 - lib/studio/cable.rb
 - lib/studio/color_scale.rb
 - lib/studio/email.rb
@@ -605,6 +620,7 @@ files:
 - lib/studio/session_fingerprint.rb
 - lib/studio/session_state.rb
 - lib/studio/sidebar_sections.rb
+- lib/studio/site_footer.rb
 - lib/studio/theme_resolver.rb
 - lib/studio/ui_primitives.rb
 - lib/studio/username_generator.rb