solid_web_ui 0.1.0

data/lib/solid_web_ui/queue/routes.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+SolidWebUi::Queue::Engine.routes.draw do
+  root to: "dashboard#index"
+
+  get "queues", to: "queues#index", as: :queues
+  post "queues/:name/pause", to: "queues#pause", as: :pause_queue, constraints: { name: %r{[^/]+} }
+  post "queues/:name/resume", to: "queues#resume", as: :resume_queue, constraints: { name: %r{[^/]+} }
+
+  get "jobs", to: "jobs#index", as: :jobs
+
+  get "failed", to: "failed_executions#index", as: :failed_executions
+  post "failed/:id/retry", to: "failed_executions#retry", as: :retry_failed_execution
+  delete "failed/:id", to: "failed_executions#discard", as: :failed_execution
+
+  get "processes", to: "processes#index", as: :processes
+  get "recurring_tasks", to: "recurring_tasks#index", as: :recurring_tasks
+end

data/lib/solid_web_ui/queue.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "solid_queue"
+
+module SolidWebUi
+  # Mountable dashboard for Solid Queue. Part of the solid_web_ui gem; mount its
+  # engine independently: `mount SolidWebUi::Queue::Engine => "/admin/queue"`.
+  module Queue
+    extend SolidWebUi::Configurable
+
+    config.page_title = "Solid Queue"
+
+    setting :enable_retry, default: true
+    setting :enable_discard, default: true
+    setting :enable_pause, default: true
+  end
+end
+
+require "solid_web_ui/queue/engine"

data/lib/solid_web_ui/theme.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module SolidWebUi
+  # Design-token contract. Every visual value the components use is a CSS custom
+  # property `--swui-*` scoped under `.solid-web-ui`. Hosts re-theme by overriding
+  # token *values* (Ruby `config.theme`, or their own CSS) — the precompiled
+  # stylesheet never needs to be rebuilt because only the values change, not the
+  # utilities. Defaults read common host variables first (auto-inheritance) and
+  # fall back to a neutral built-in palette.
+  module Theme
+    # token key => [ css var name, default value ]
+    LIGHT = {
+      color_primary: [ "--swui-color-primary", "var(--color-primary, #4f46e5)" ],
+      color_primary_contrast: [ "--swui-color-primary-contrast", "var(--color-primary-contrast, #ffffff)" ],
+      color_bg: [ "--swui-color-bg", "var(--color-bg, #f8fafc)" ],
+      color_surface: [ "--swui-color-surface", "var(--color-surface, #ffffff)" ],
+      color_text: [ "--swui-color-text", "var(--color-text, #0f172a)" ],
+      color_muted: [ "--swui-color-muted", "var(--color-muted, #64748b)" ],
+      color_border: [ "--swui-color-border", "var(--color-border, #e2e8f0)" ],
+      color_success: [ "--swui-color-success", "var(--color-success, #16a34a)" ],
+      color_warning: [ "--swui-color-warning", "var(--color-warning, #d97706)" ],
+      color_danger: [ "--swui-color-danger", "var(--color-danger, #dc2626)" ],
+      font: [ "--swui-font", "var(--swui-host-font, ui-sans-serif, system-ui, sans-serif)" ],
+      radius: [ "--swui-radius", "0.5rem" ]
+    }.freeze
+
+    # Dark scheme only re-points the surface/text family; brand color stays.
+    DARK = {
+      color_bg: [ "--swui-color-bg", "var(--color-bg, #0b0f19)" ],
+      color_surface: [ "--swui-color-surface", "var(--color-surface, #151a26)" ],
+      color_text: [ "--swui-color-text", "var(--color-text, #e2e8f0)" ],
+      color_muted: [ "--swui-color-muted", "var(--color-muted, #94a3b8)" ],
+      color_border: [ "--swui-color-border", "var(--color-border, #273043)" ]
+    }.freeze
+
+    module_function
+
+    # Serialize the default token contract, with `overrides` (a theme hash) applied.
+    def css_vars(overrides = {})
+      build(LIGHT, overrides)
+    end
+
+    # Dark-scheme token overrides, used inside a dark selector / media query.
+    def dark_css_vars(overrides = {})
+      build(DARK, overrides)
+    end
+
+    def build(table, overrides)
+      overrides = (overrides || {}).transform_keys(&:to_sym)
+      table.filter_map do |key, (var_name, default)|
+        value = overrides.key?(key) ? sanitize(overrides[key]) : default
+        value = default if value.nil? || value.empty? # reject unsafe overrides → fall back
+        next if value.nil? || value.empty?
+
+        "#{var_name}: #{value};"
+      end.join(" ")
+    end
+
+    # Allowlist of characters valid in a CSS value (colors, lengths, var()/calc(),
+    # font stacks). Anything outside it means a malformed or hostile value, so we
+    # reject it entirely (returns nil) rather than trying to scrub it — the token
+    # then falls back to its safe default. This makes breaking out of
+    # `<style>.solid-web-ui{ … }` impossible.
+    SAFE_VALUE = %r{\A[\w\s#%.,()'"/-]*\z}
+
+    def sanitize(value)
+      str = value.to_s.strip
+      str.match?(SAFE_VALUE) ? str : nil
+    end
+  end
+end

data/lib/solid_web_ui/version.rb

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

data/lib/solid_web_ui.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "dry/configurable"
+
+require "solid_web_ui/version"
+require "solid_web_ui/configurable"
+require "solid_web_ui/theme"
+require "solid_web_ui/paginator"
+require "solid_web_ui/engine"
+
+module SolidWebUi
+  extend Dry::Configurable
+
+  # Theming / asset settings shared across all three dashboards.
+  setting :theme, default: {}             # token overrides, e.g. { color_primary: "#7c3aed" }
+  setting :color_scheme, default: "auto"  # "auto" | "light" | "dark"
+  setting :stylesheet, default: true      # false → don't link the bundled CSS (host takes over)
+  setting :extra_stylesheets, default: [] # extra Propshaft stylesheet names to link after ours
+
+  # Resolve a configured controller class name to a class. Called lazily when a
+  # web engine's ApplicationController is autoloaded, so host initializers have
+  # already run and `base_controller_class` points at the host's auth controller.
+  def self.resolve_base_controller(class_name)
+    class_name.to_s.constantize
+  end
+end
+
+# Mountable dashboard parts. Each defines its own isolated engine
+# (SolidWebUi::Queue::Engine, ::Cache::Engine, ::Cable::Engine) that the host
+# mounts independently.
+require "solid_web_ui/queue"
+require "solid_web_ui/cache"
+require "solid_web_ui/cable"

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: solid_web_ui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Radushev
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: propshaft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: solid_queue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: solid_cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: solid_cable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'A single gem with three independently mountable Rails engines (SolidWebUi::Queue/Cache/Cable::Engine)
+  sharing one design system: ViewComponents, a layout, design-token theming and a
+  dry-configurable base.'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/assets/stylesheets/solid_web_ui.css
+- app/components/solid_web_ui/ui/page_component.html.erb
+- app/components/solid_web_ui/ui/page_component.rb
+- app/components/solid_web_ui/ui/paginator_component.html.erb
+- app/components/solid_web_ui/ui/paginator_component.rb
+- app/components/solid_web_ui/ui/stat_card_component.html.erb
+- app/components/solid_web_ui/ui/stat_card_component.rb
+- app/components/solid_web_ui/ui/status_badge_component.rb
+- app/components/solid_web_ui/ui/table_component.html.erb
+- app/components/solid_web_ui/ui/table_component.rb
+- app/controllers/solid_web_ui/cable/application_controller.rb
+- app/controllers/solid_web_ui/cable/channels_controller.rb
+- app/controllers/solid_web_ui/cable/dashboard_controller.rb
+- app/controllers/solid_web_ui/cable/messages_controller.rb
+- app/controllers/solid_web_ui/cache/application_controller.rb
+- app/controllers/solid_web_ui/cache/dashboard_controller.rb
+- app/controllers/solid_web_ui/cache/entries_controller.rb
+- app/controllers/solid_web_ui/queue/application_controller.rb
+- app/controllers/solid_web_ui/queue/dashboard_controller.rb
+- app/controllers/solid_web_ui/queue/failed_executions_controller.rb
+- app/controllers/solid_web_ui/queue/jobs_controller.rb
+- app/controllers/solid_web_ui/queue/processes_controller.rb
+- app/controllers/solid_web_ui/queue/queues_controller.rb
+- app/controllers/solid_web_ui/queue/recurring_tasks_controller.rb
+- app/helpers/solid_web_ui/cable/application_helper.rb
+- app/helpers/solid_web_ui/cache/application_helper.rb
+- app/helpers/solid_web_ui/component_helper.rb
+- app/helpers/solid_web_ui/queue/application_helper.rb
+- app/views/layouts/solid_web_ui.html.erb
+- app/views/solid_web_ui/cable/channels/index.html.erb
+- app/views/solid_web_ui/cable/dashboard/index.html.erb
+- app/views/solid_web_ui/cache/dashboard/index.html.erb
+- app/views/solid_web_ui/cache/entries/index.html.erb
+- app/views/solid_web_ui/queue/dashboard/index.html.erb
+- app/views/solid_web_ui/queue/failed_executions/index.html.erb
+- app/views/solid_web_ui/queue/jobs/index.html.erb
+- app/views/solid_web_ui/queue/processes/index.html.erb
+- app/views/solid_web_ui/queue/queues/index.html.erb
+- app/views/solid_web_ui/queue/recurring_tasks/index.html.erb
+- lib/solid_web_ui.rb
+- lib/solid_web_ui/cable.rb
+- lib/solid_web_ui/cable/engine.rb
+- lib/solid_web_ui/cable/routes.rb
+- lib/solid_web_ui/cache.rb
+- lib/solid_web_ui/cache/engine.rb
+- lib/solid_web_ui/cache/routes.rb
+- lib/solid_web_ui/configurable.rb
+- lib/solid_web_ui/engine.rb
+- lib/solid_web_ui/paginator.rb
+- lib/solid_web_ui/queue.rb
+- lib/solid_web_ui/queue/engine.rb
+- lib/solid_web_ui/queue/routes.rb
+- lib/solid_web_ui/theme.rb
+- lib/solid_web_ui/version.rb
+homepage: https://github.com/doromones/solid-web
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Web dashboards for Solid Queue, Solid Cache and Solid Cable.
+test_files: []