studio-engine 0.85.0 → 0.87.0

data/lib/studio.rb

@@ -1,3 +1,16 @@
+# What this file and lib/studio/* call at REQUIRE time, required here rather
+# than left to the host. `15.minutes` and `24.hours` below are evaluated the
+# moment `require "studio"` runs, which is Bundler.require in the host's
+# config/application.rb, BEFORE Rails' :load_active_support initializer pulls in
+# any core extension. A host on `rails/all` happens to have them already (the
+# ActiveRecord and ActiveJob railties load them); a host with no ActiveRecord
+# does not, and its boot died on `Integer#minutes` until it required
+# active_support/core_ext/integer/time itself. A gem requires what it uses.
+# test/integration/footer_only_consumer_test.rb boots that host.
+require "active_support"
+require "active_support/core_ext/module/attribute_accessors"
+require "active_support/core_ext/numeric/time"
+require "active_support/core_ext/integer/time"
 require "studio/version"
 require "studio/log_rotation"
 require "studio/ip_locations"
@@ -569,10 +582,16 @@ module Studio
   # 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.
+  # The footer's facts. THE FOOTER IS ON BY DEFAULT: left unset (nil), the
+  # layout line `studio_site_footer` renders the DEFAULT footer, built from what
+  # the engine already knows (the site name, the footer or navbar logo, and a
+  # legal line linking the host's `privacy` and `terms` routes when it has
+  # them). No address, no map, no email, no link columns.
+  #
+  #   nil (unset)   the default footer
+  #   false         NO footer: the one opt-out
+  #   a Hash, or a callable receiving the view: the app's own facts. Every key
+  #   is optional; shape and rules: lib/studio/site_footer.rb.
   #
   #   config.site_footer = ->(view) {
   #     { tagline: "Everything, by example",
@@ -588,6 +607,35 @@ module Studio
     @@site_footer = declared
   end
 
+  # True unless the app turned the footer off (`config.site_footer = false`).
+  def self.site_footer_enabled?
+    site_footer != false
+  end
+
+  # True when the app wrote its own facts, as against taking the default footer
+  # (unset) or none (false).
+  def self.site_footer_declared?
+    !site_footer.nil? && site_footer != false
+  end
+
+  # THE LOCATION, AS ONE SETTING: the address the footer prints in its Location
+  # band, and maps when it carries lat: and lng:. nil (the default) is no
+  # location. It is how an app on the default footer adds one without writing
+  # the facts callable:
+  #
+  #   config.site_footer_address = { street: "123 Example St", city_line: "Washington, DC 20024",
+  #                                  lat: 38.8894, lng: -77.0352 }
+  #
+  # The keys are the facts' `address:` keys (docs/SITE_FOOTER.md). An app's own
+  # facts WIN: when they carry an address this is not read, and `address: false`
+  # there shows none.
+  mattr_reader :site_footer_address, default: nil
+
+  def self.site_footer_address=(declared)
+    SiteFooter.validate_address!(declared)
+    @@site_footer_address = declared || nil
+  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
@@ -952,6 +1000,25 @@ module Studio
   # that intentionally break the contract).
   mattr_accessor :validate_user_contract, default: true
 
+  # Does the host load ActiveRecord at all? True for every app that requires
+  # `rails/all` or `active_record/railtie` (all the engine's database-backed
+  # consumers); false for a FOOTER-ONLY consumer, an app with no database that
+  # takes the engine for its site footer and nothing else (docs/SITE_FOOTER.md,
+  # "An app with no database").
+  #
+  # The RAILTIE, not ActiveRecord::Base: the railtie is what an app chooses in
+  # config/application.rb, it is defined at require time (before any engine
+  # initializer runs), and asking for it autoloads nothing.
+  #
+  # Three things key off it, each only when it reads false (Studio::Engine):
+  # the user-contract check is skipped, the engine's ActiveRecord-dependent
+  # app/ roots are kept out of eager loading, and
+  # `studio_engine:install:migrations` is a no-op that exits 0. An app WITH
+  # ActiveRecord sees none of them change.
+  def self.active_record?
+    defined?(::ActiveRecord::Railtie) ? true : false
+  end
+
   # Only methods that consumers must explicitly define are checked here.
   # Column accessors (#email, #name, #role) are NOT validated because
   # ActiveRecord defines them lazily — they don't appear on `.instance_methods`
@@ -1175,14 +1242,25 @@ module Studio
   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.
+  # nil when the app turned the footer off (or its own callable answered nil).
+  # Unset, the facts are the default footer's. 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; Studio.site_footer_address is the address of any
+  # facts that carry none.
   def self.site_footer_for(view)
-    return nil if site_footer.nil?
+    return nil unless site_footer_enabled?
+
+    declared = site_footer.nil? ? SiteFooter.default_facts(view, routes: host_route_set) : site_footer
+    SiteFooter.resolve(declared, view, name: site_identity[:title], logo: logo_for("Footer Logo"),
+                                       booking_path: booking_path_for(view), address: site_footer_address)
+  end
+
+  # The host's route set, for the default footer's legal links. nil outside a
+  # booted Rails app.
+  def self.host_route_set
+    return nil unless defined?(::Rails) && ::Rails.respond_to?(:application) && ::Rails.application
 
-    SiteFooter.resolve(site_footer, view, name: site_identity[:title], logo: logo_for("Footer Logo"),
-                                          booking_path: booking_path_for(view))
+    ::Rails.application.routes
   end
 
   # Navbar links resolved for a view context (lib/studio/navbar_links.rb).

data/studio-engine.gemspec

@@ -22,7 +22,14 @@ Gem::Specification.new do |spec|
   # read by bin/e2e-executed-set-check and test/lib/e2e_lane_contract_test.rb. It is
   # the only thing under config/, and it has no meaning in a consuming app, so it is
   # excluded rather than shipped. (e2e/, bin/ and test/ were never in this list.)
-  spec.files = Dir["lib/**/*", "app/**/*", "config/**/*", "db/**/*", "tailwind/**/*", "Gemfile", "studio-engine.gemspec", "README.md", "CHANGELOG.md", "LICENSE"] - ["config/e2e_lane.yml"]
+  #
+  # docs/SITE_FOOTER.md and docs/BOOKING.md ship because consumers cite them from
+  # their own initializers ("docs/SITE_FOOTER.md is the contract"), and a
+  # citation should resolve in the installed gem, not only on GitHub. The rest of
+  # docs/ is the engine's own operating material. Guarded by
+  # test/lib/gemspec_ships_footer_docs_test.rb.
+  spec.files = Dir["lib/**/*", "app/**/*", "config/**/*", "db/**/*", "tailwind/**/*", "Gemfile", "studio-engine.gemspec", "README.md", "CHANGELOG.md", "LICENSE",
+                   "docs/SITE_FOOTER.md", "docs/BOOKING.md"] - ["config/e2e_lane.yml"]
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", ">= 7.2", "< 8.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: studio-engine
 version: !ruby/object:Gem::Version
-  version: 0.85.0
+  version: 0.87.0
 platform: ruby
 authors:
 - Alex McRitchie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-03 00:00:00.000000000 Z
+date: 2026-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -541,6 +541,7 @@ files:
 - 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/_map_assets.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
@@ -584,6 +585,8 @@ files:
 - db/migrate/20260902000001_create_studio_knowledge_expectations.rb
 - db/migrate/20260902000002_add_expectation_to_studio_knowledge_docs.rb
 - db/migrate/20260930120000_create_studio_site_identities.rb
+- docs/BOOKING.md
+- docs/SITE_FOOTER.md
 - lib/active_storage/service/studio_trash_s3_service.rb
 - lib/generators/studio/site_identity/site_identity_generator.rb
 - lib/studio-engine.rb