solid_web_ui 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 733e4f6cdd63c6b22b5e3ca4166576ebfe2db2a482d6b2fa7e25035e0a12c7a9
-  data.tar.gz: e1b1e0755169b3ba6f74d576f155bcce21bf029f5d1a2de3e833be7713d806e5
+  metadata.gz: 71e641147c603c1191aefc81cd3cf538ce2ba6efb861bbf3e8f83c648abcce9c
+  data.tar.gz: 2c3ba40caa7d3c98c9d7af92f42bdc40e01fd4ff2a2634ea8577946212a688af
 SHA512:
-  metadata.gz: 66d72bca337446f1df7ae48b7faebe2c760c56e1079eba0a280deb1047bd6ef0a0719bcd64137609a0df7207bc7632239eff6920aa30f16fb28775f7d4b97fa9
-  data.tar.gz: ae241b3d25a1108b038b88a92e81e36da9137c5c3af126a1abd4c6767ca135e46b9f3200641239cc162a74c690bb73eaa3ad6145450a6b61231e60717afb5348
+  metadata.gz: 199f01433b9facbcb155570bdc8e3724985f6b7c4cd5013db94e2067ad2c97c3e6634e5b86cfc54f09808c2600ffd835bf9ab54802fb7dd4df2493ecd83d813d
+  data.tar.gz: 923d50e464295107a7fbd2139d3971b19683a3ee4bd31e939c58c4eb9a7e4540ffd67f458394e229e7657b31baa6d7eab106248b3f060b881bcac667015423e3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Anton Radushev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,5 +1,10 @@
 # solid_web_ui
 
+[![Gem Version](https://img.shields.io/gem/v/solid_web_ui)](https://rubygems.org/gems/solid_web_ui)
+[![Downloads](https://img.shields.io/gem/dt/solid_web_ui)](https://rubygems.org/gems/solid_web_ui)
+[![CI](https://github.com/doromones/solid-web/actions/workflows/ci.yml/badge.svg)](https://github.com/doromones/solid-web/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
+
 Web dashboards for Rails' **Solid Queue**, **Solid Cache** and **Solid Cable** — one gem
 (`solid_web_ui`) with three independently mountable Rails engines sharing one design system.
 

data/app/components/solid_web_ui/ui/page_component.html.erb

@@ -1,15 +1,19 @@
-<div class="swui-page">
-  <header class="swui-page__header">
-    <h1 class="swui-page__title"><%= title %></h1>
-    <% if nav.any? %>
-      <nav class="swui-nav">
-        <% nav.each do |item| %>
-          <%= link_to item[:label], item[:href], class: nav_link_class(item) %>
-        <% end %>
-      </nav>
-    <% end %>
-  </header>
-  <main class="swui-page__body">
-    <%= content %>
-  </main>
+<%# Self-scoping under .solid-web-ui so the dashboard is themed correctly whether %>
+<%# it renders in the gem's standalone layout or inside a host layout. %>
+<div class="solid-web-ui" data-color-scheme="<%= SolidWebUi.config.color_scheme %>">
+  <div class="swui-page">
+    <header class="swui-page__header">
+      <h1 class="swui-page__title"><%= title %></h1>
+      <% if nav.any? %>
+        <nav class="swui-nav">
+          <% nav.each do |item| %>
+            <%= link_to item[:label], item[:href], class: nav_link_class(item) %>
+          <% end %>
+        </nav>
+      <% end %>
+    </header>
+    <main class="swui-page__body">
+      <%= content %>
+    </main>
+  </div>
 </div>

data/app/controllers/solid_web_ui/cable/application_controller.rb

@@ -2,7 +2,7 @@
 
 module SolidWebUi::Cable
   class ApplicationController < SolidWebUi.resolve_base_controller(SolidWebUi::Cable.config.base_controller_class)
-    layout "solid_web_ui"
+    layout -> { SolidWebUi::Cable.config.layout }
     helper SolidWebUi::ComponentHelper
 
     private

data/app/controllers/solid_web_ui/cache/application_controller.rb

@@ -2,7 +2,7 @@
 
 module SolidWebUi::Cache
   class ApplicationController < SolidWebUi.resolve_base_controller(SolidWebUi::Cache.config.base_controller_class)
-    layout "solid_web_ui"
+    layout -> { SolidWebUi::Cache.config.layout }
     helper SolidWebUi::ComponentHelper
 
     private

data/app/controllers/solid_web_ui/queue/application_controller.rb

@@ -5,7 +5,7 @@ module SolidWebUi::Queue
   # so host authentication/authorization applies. Resolved lazily at autoload
   # time, after host initializers have set `base_controller_class`.
   class ApplicationController < SolidWebUi.resolve_base_controller(SolidWebUi::Queue.config.base_controller_class)
-    layout "solid_web_ui"
+    layout -> { SolidWebUi::Queue.config.layout }
     helper SolidWebUi::ComponentHelper
 
     private

data/app/views/layouts/solid_web_ui.html.erb

@@ -5,29 +5,9 @@
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title><%= content_for?(:title) ? yield(:title) : "Solid Web" %></title>
   <%= csrf_meta_tags %>
-
-  <% if SolidWebUi.config.stylesheet %>
-    <%= stylesheet_link_tag "solid_web_ui", "data-turbo-track": "reload" %>
-  <% end %>
-  <% Array(SolidWebUi.config.extra_stylesheets).each do |sheet| %>
-    <%= stylesheet_link_tag sheet, "data-turbo-track": "reload" %>
-  <% end %>
-
-  <%# Theme tokens (host re-themes by overriding these values, never the stylesheet). %>
-  <style>
-    .solid-web-ui { <%= SolidWebUi::Theme.css_vars(SolidWebUi.config.theme).html_safe %> }
-    <% if SolidWebUi.config.color_scheme.to_s == "dark" %>
-      .solid-web-ui { <%= SolidWebUi::Theme.dark_css_vars(SolidWebUi.config.theme).html_safe %> }
-    <% elsif SolidWebUi.config.color_scheme.to_s == "auto" %>
-      @media (prefers-color-scheme: dark) {
-        .solid-web-ui { <%= SolidWebUi::Theme.dark_css_vars(SolidWebUi.config.theme).html_safe %> }
-      }
-    <% end %>
-  </style>
+  <%= solid_web_ui_head_tags %>
 </head>
 <body>
-  <div class="solid-web-ui" data-color-scheme="<%= SolidWebUi.config.color_scheme %>">
-    <%= yield %>
-  </div>
+  <%= yield %>
 </body>
 </html>

data/lib/solid_web_ui/configurable.rb

@@ -15,6 +15,12 @@ module SolidWebUi
       base.setting :per_page, default: 25
       base.setting :time_zone, default: "UTC"
       base.setting :page_title, default: base.respond_to?(:name) ? base.name : "Solid Web"
+      # Which layout the dashboards render in. Default is the gem's standalone,
+      # full-page layout. Point it at a host layout (e.g. "admin") to render the
+      # dashboards inside the host's chrome (sidebar/header). The host layout must
+      # then include `<%= solid_web_ui_head_tags %>` and reference its own routes
+      # via `main_app.` (so they resolve from the isolated engine's context).
+      base.setting :layout, default: "solid_web_ui"
     end
   end
 end

data/lib/solid_web_ui/engine.rb

@@ -9,5 +9,12 @@ module SolidWebUi
   # three web engines (queue/cache/cable) resolve the shared layout, components
   # and the single precompiled stylesheet without any manual view-path wiring.
   class Engine < ::Rails::Engine
+    # Expose solid_web_ui_head_tags to every host view, so a host layout can pull
+    # in the dashboards' stylesheet + theme tokens when embedding them.
+    initializer "solid_web_ui.head_helper" do
+      ActiveSupport.on_load(:action_view) do
+        include SolidWebUi::HeadHelper
+      end
+    end
   end
 end

data/lib/solid_web_ui/head_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module SolidWebUi
+  # Emits the dashboards' stylesheet + theme tokens. Included into ActionView
+  # app-wide (see SolidWebUi::Engine) so a host layout can drop
+  # `<%= solid_web_ui_head_tags %>` into its <head> when rendering the dashboards
+  # inside its own chrome (config.layout = "your_layout").
+  #
+  # Defined in lib/ (not app/helpers) because it is mixed into ActionView during
+  # boot, before the engine's autoload paths are ready.
+  module HeadHelper
+    def solid_web_ui_head_tags
+      tags = []
+      if SolidWebUi.config.stylesheet
+        tags << stylesheet_link_tag("solid_web_ui", "data-turbo-track": "reload")
+      end
+      Array(SolidWebUi.config.extra_stylesheets).each do |sheet|
+        tags << stylesheet_link_tag(sheet, "data-turbo-track": "reload")
+      end
+      tags << solid_web_ui_theme_style_tag
+      safe_join(tags)
+    end
+
+    private
+
+    def solid_web_ui_theme_style_tag
+      theme = SolidWebUi.config.theme
+      css = +".solid-web-ui { #{SolidWebUi::Theme.css_vars(theme)} }"
+      case SolidWebUi.config.color_scheme.to_s
+      when "dark"
+        css << " .solid-web-ui { #{SolidWebUi::Theme.dark_css_vars(theme)} }"
+      when "auto"
+        css << " @media (prefers-color-scheme: dark) { .solid-web-ui { #{SolidWebUi::Theme.dark_css_vars(theme)} } }"
+      end
+      content_tag(:style, css.html_safe) # rubocop:disable Rails/OutputSafety
+    end
+  end
+end

data/lib/solid_web_ui/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidWebUi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/solid_web_ui.rb

@@ -6,6 +6,7 @@ require "solid_web_ui/version"
 require "solid_web_ui/configurable"
 require "solid_web_ui/theme"
 require "solid_web_ui/paginator"
+require "solid_web_ui/head_helper"
 require "solid_web_ui/engine"
 
 module SolidWebUi

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_web_ui
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anton Radushev
@@ -114,6 +114,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - app/assets/stylesheets/solid_web_ui.css
 - app/components/solid_web_ui/ui/page_component.html.erb
@@ -163,6 +164,7 @@ files:
 - lib/solid_web_ui/cache/routes.rb
 - lib/solid_web_ui/configurable.rb
 - lib/solid_web_ui/engine.rb
+- lib/solid_web_ui/head_helper.rb
 - lib/solid_web_ui/paginator.rb
 - lib/solid_web_ui/queue.rb
 - lib/solid_web_ui/queue/engine.rb