janela 0.3.0 → 0.4.1

data/lib/janela/engine.rb

@@ -24,7 +24,16 @@ module Janela
     # Janela's own layout links janela.css, and a host on Sprockets serves it
     # in production only if something declared it.
     initializer "janela.assets" do |app|
-      app.config.assets.precompile << "janela.css" if app.config.respond_to?(:assets) && app.config.assets.respond_to?(:precompile)
+      if app.config.respond_to?(:assets) && app.config.assets.respond_to?(:precompile)
+        app.config.assets.precompile << "janela.css"
+        app.config.assets.precompile << "vitral.css"
+      end
+    end
+
+    # A host's route names are only known once its routes are drawn, which is
+    # lazy and happens again on every reload in development.
+    initializer "janela.host_routes" do |app|
+      app.config.after_routes_loaded { Janela::HostRoutes.define! }
     end
 
     initializer "janela.importmap", before: "importmap" do |app|

data/lib/janela/host_routes.rb

@@ -0,0 +1,37 @@
+module Janela
+  # Route helpers the host application has and the engine does not, forwarded
+  # to the host.
+  #
+  # isolate_namespace points every route helper inside Janela's controllers at
+  # the engine's own routes, and a host's ApplicationController runs there,
+  # because Janela's controllers inherit it. So an authentication redirect, a
+  # rescue_from or an after_action that names one of the host's own routes
+  # raises where it would work anywhere else in the application (ADR 022).
+  #
+  # Only names the engine does not define are forwarded, so the engine's own
+  # routes can never be shadowed by a host's. main_app stays the unambiguous
+  # way to say either.
+  module HostRoutes
+    def self.define!(host: Rails.application.routes, engine: Janela::Engine.routes)
+      # Routes reload in development, so a name that has gone is removed
+      # rather than left behind pointing at nothing.
+      instance_methods(false).each { |method| remove_method(method) }
+
+      forwarded(host: host, engine: engine).each do |name|
+        define_method(name) do |*args, **options, &block|
+          main_app.public_send(name, *args, **options, &block)
+        end
+      end
+    end
+
+    def self.forwarded(host: Rails.application.routes, engine: Janela::Engine.routes)
+      # Route loading is lazy, so a call before anything else has drawn the
+      # host's routes would otherwise see an empty set rather than an error
+      # (issue #37). This does not recurse: define! runs from
+      # after_routes_loaded, by which point the reloader has already marked
+      # itself loaded.
+      Rails.application.reload_routes_unless_loaded
+      host.named_routes.helper_names - engine.named_routes.helper_names
+    end
+  end
+end

data/lib/janela/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Janela
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

data/lib/janela.rb

@@ -10,6 +10,7 @@ require "janela/definition"
 require "janela/measure"
 require "janela/dimension"
 require "janela/doctor"
+require "janela/host_routes"
 
 module Janela
   class Error < StandardError; end
@@ -24,6 +25,12 @@ module Janela
   # and authorisation apply to dashboards with no configuration.
   mattr_accessor :parent_controller, default: "ApplicationController"
 
+  # The stylesheet Janela's own pages load on top of janela.css. Nil means the
+  # structural one only, which is what a host that has its own look wants. The
+  # gem ships "vitral". A host's own pages are untouched either way: they load
+  # whatever that host's layout says (ADR 023).
+  mattr_accessor :theme, default: nil
+
   # Checks janela:doctor should not report, by the name it prints beside each
   # finding. A check that is a false alarm for one application stays a false
   # alarm, and that is a judgement made once at boot, which is what a setting

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: janela
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jay Killeen
@@ -99,7 +99,9 @@ files:
 - app/assets/javascripts/janela/chart_controller.js
 - app/assets/javascripts/janela/frame_controller.js
 - app/assets/javascripts/janela/vendor/chart.js
+- app/assets/javascripts/janela/vitral_controller.js
 - app/assets/stylesheets/janela.css
+- app/assets/stylesheets/vitral.css
 - app/controllers/janela/application_controller.rb
 - app/controllers/janela/frames_controller.rb
 - app/controllers/janela/panes_controller.rb
@@ -155,13 +157,19 @@ files:
 - docs/decisions/019-a-created-frame-asks-the-host-who-owns-it.md
 - docs/decisions/020-formatting-belongs-to-the-measure.md
 - docs/decisions/021-a-check-has-a-name-a-host-can-silence.md
+- docs/decisions/022-host-route-helpers-work-inside-the-engine.md
+- docs/decisions/023-vitral-is-a-theme-not-the-stylesheet.md
+- docs/decisions/024-selecting-more-than-one-value.md
+- docs/decisions/025-janela-bounds-what-a-filter-can-ask-for.md
 - docs/decisions/INDEX.md
 - docs/multi-tenancy.md
+- docs/naming.md
 - lib/janela.rb
 - lib/janela/definition.rb
 - lib/janela/dimension.rb
 - lib/janela/doctor.rb
 - lib/janela/engine.rb
+- lib/janela/host_routes.rb
 - lib/janela/measure.rb
 - lib/janela/model.rb
 - lib/janela/version.rb
@@ -175,19 +183,6 @@ metadata:
   changelog_uri: https://github.com/retail-tasker/janela/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/retail-tasker/janela/issues
   rubygems_mfa_required: 'true'
-post_install_message: |
-  Janela 0.3.0 needs two things from you. Run the migrations, because the
-  mount root now serves an index of frames:
-
-    bin/rails janela:install:migrations && bin/rails db:migrate
-
-  Then rename the Stimulus controller you register, the helper that wraps
-  your panes, and a few constants.
-
-  Steps: UPGRADING.md in this gem, or
-  https://github.com/retail-tasker/janela/blob/main/UPGRADING.md
-
-  Then run: bin/rails janela:doctor
 rdoc_options: []
 require_paths:
 - lib