modern_queue_dashboard 0.3.1

data/app/views/modern_queue_dashboard/queues/index.html.erb

@@ -0,0 +1,35 @@
+<div class="container mx-auto p-6 space-y-6">
+  <h1 class="text-3xl font-semibold">Modern Queue Dashboard</h1>
+
+  <h2 class="text-2xl font-semibold">Queues</h2>
+
+  <!-- Queue Table -->
+  <div class="bg-white shadow rounded">
+    <table class="min-w-full divide-y divide-gray-200">
+      <thead class="bg-gray-50">
+        <tr>
+          <th class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">Queue</th>
+          <th class="px-6 py-3 text-right text-xs font-medium text-gray-500 uppercase tracking-wider">Pending</th>
+          <th class="px-6 py-3 text-right text-xs font-medium text-gray-500 uppercase tracking-wider">Scheduled</th>
+          <th class="px-6 py-3 text-right text-xs font-medium text-gray-500 uppercase tracking-wider">Running</th>
+          <th class="px-6 py-3 text-right text-xs font-medium text-gray-500 uppercase tracking-wider">Failed</th>
+          <th class="px-6 py-3 text-right text-xs font-medium text-gray-500 uppercase tracking-wider">Latency</th>
+        </tr>
+      </thead>
+      <tbody class="bg-white divide-y divide-gray-200">
+        <% @queues.each do |queue| %>
+          <tr>
+            <td class="px-6 py-4 whitespace-nowrap font-medium text-sky-500">
+              <%= link_to queue.name, queue_path(queue.name), data: { turbo_frame: "_top" } %>
+            </td>
+            <td class="px-6 py-4 text-right"><%= queue.pending %></td>
+            <td class="px-6 py-4 text-right"><%= queue.scheduled %></td>
+            <td class="px-6 py-4 text-right"><%= queue.running %></td>
+            <td class="px-6 py-4 text-right"><%= queue.failed %></td>
+            <td class="px-6 py-4 text-right"><%= queue.latency %> ms</td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div> 

data/app/views/modern_queue_dashboard/queues/show.html.erb

@@ -0,0 +1,51 @@
+<div class="container mx-auto p-6 space-y-6">
+  <h1 class="text-3xl font-semibold">Modern Queue Dashboard</h1>
+
+  <div class="flex items-center space-x-2 mb-4">
+    <%= link_to "← Back to Queues", queues_path, class: "text-sky-500" %>
+  </div>
+
+  <h2 class="text-2xl font-semibold">Queue: <%= @queue_name %></h2>
+
+  <% if @queue %>
+    <!-- Queue Stats -->
+    <div class="grid grid-cols-2 md:grid-cols-4 gap-4">
+      <div class="bg-white shadow-sm rounded p-4">
+        <p class="text-sm text-gray-500">Pending Jobs</p>
+        <p class="text-2xl font-bold text-sky-500"><%= @queue.pending %></p>
+      </div>
+      <div class="bg-white shadow-sm rounded p-4">
+        <p class="text-sm text-gray-500">Scheduled Jobs</p>
+        <p class="text-2xl font-bold text-sky-500"><%= @queue.scheduled %></p>
+      </div>
+      <div class="bg-white shadow-sm rounded p-4">
+        <p class="text-sm text-gray-500">Running Jobs</p>
+        <p class="text-2xl font-bold text-sky-500"><%= @queue.running %></p>
+      </div>
+      <div class="bg-white shadow-sm rounded p-4">
+        <p class="text-sm text-gray-500">Failed Jobs</p>
+        <p class="text-2xl font-bold text-sky-500"><%= @queue.failed %></p>
+      </div>
+    </div>
+
+    <!-- Queue Details -->
+    <div class="bg-white shadow rounded p-6">
+      <h3 class="text-xl font-semibold mb-4">Queue Details</h3>
+      
+      <div class="grid grid-cols-1 md:grid-cols-2 gap-4">
+        <div>
+          <p class="text-sm text-gray-500">Queue Name</p>
+          <p class="font-semibold"><%= @queue.name %></p>
+        </div>
+        <div>
+          <p class="text-sm text-gray-500">Average Latency</p>
+          <p class="font-semibold"><%= @queue.latency %> ms</p>
+        </div>
+      </div>
+    </div>
+  <% else %>
+    <div class="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded">
+      Queue not found.
+    </div>
+  <% end %>
+</div> 

data/config/routes.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+ModernQueueDashboard::Engine.routes.draw do
+  root to: "dashboard#index"
+
+  resources :queues, only: %i[index show]
+end

data/docs/PLAN.md

@@ -0,0 +1,201 @@
+# Modern Queue Dashboard – Implementation Plan
+
+## 1. Purpose
+Create a mountable Rails engine (`modern_queue_dashboard`) that provides a Hotwire-powered, Tailwind-styled dashboard for monitoring Solid Queue job activity. The gem should be install-and-mount with zero configuration, MIT-licensed, Rails 8+ compatible.
+
+---
+
+## 2. Feature Scope
+1. **High-level metrics**
+   * Total jobs per state: pending, scheduled, running, completed, discarded, failed.
+   * Per-queue counts and latency (oldest `run_at` vs now).
+2. **Queue list** – table of all queues with counts & oldest job age.
+3. **Job list** – paginated view for a selected queue or global list.
+4. **Job detail** – arguments, id, state transitions, timestamps, error details for failed jobs.
+5. **Semi-real-time updates** – Turbo Stream polling every *n* seconds (configurable).
+6. **No job actions** (read-only).
+7. **Authentication left to host app** – README shows Devise/warden examples.
+
+---
+
+## 3. Data Sources & Queries
+Solid Queue tables (≥ v1.1):
+* `solid_queue_jobs`
+* `solid_queue_executions`
+* `solid_queue_queues`
+* `solid_queue_failed_jobs`
+* `solid_queue_scheduled_jobs`
+* `solid_queue_workers` (for running jobs)
+
+Create PORO query objects under `app/models/modern_queue_dashboard/` to encapsulate:
+* `Metrics.summary` – returns counts/latency.
+* `Queue.with_stats` – returns per-queue stats.
+* `JobFinder` – fetches jobs by queue / state with eager-loaded execution & failure.
+* `JobPresenter` – formats metadata for the UI.
+
+---
+
+## 4. Gem/Engine Skeleton
+```
+modern_queue_dashboard/
+├── app/
+│   ├── controllers/modern_queue_dashboard/
+│   ├── views/modern_queue_dashboard/
+│   ├── models/modern_queue_dashboard/
+│   ├── components/modern_queue_dashboard/ (ViewComponent or Phlex?)
+│   ├── assets/
+│   │   ├── stylesheets/modern_queue_dashboard.css
+│   │   └── javascript/modern_queue_dashboard.js
+│   └── helpers/modern_queue_dashboard/
+├── config/
+│   ├── routes.rb (Engine)
+│   └── initializers/assets.rb (precompile dashboard assets)
+├── lib/
+│   ├── modern_queue_dashboard.rb (engine loader)
+│   ├── modern_queue_dashboard/engine.rb
+│   └── modern_queue_dashboard/version.rb
+├── test/
+│   ├── dummy/ (rails new --minimal --edge)
+│   └── ... unit tests (Minitest)
+├── Rakefile
+└── modern_queue_dashboard.gemspec
+```
+
+---
+
+## 5. Dependencies
+* `rails ">= 8.0.0"`
+* `turbo-rails`, `stimulus-rails` (already bundled with Rails 8)
+* `tailwindcss-rails`
+* `view_component` (optional – decide in §8)
+* `solid_queue` (runtime, same version constraint as host)
+* Development: `standard`/`rubocop`, `minitest-reporters`, `pry`.
+
+---
+
+## 6. Routes
+Within the engine (`config/routes.rb`):
+```ruby
+ModernQueueDashboard::Engine.routes.draw do
+  root to: "dashboard#index"
+  resources :queues, only: [:index, :show] do
+    resources :jobs, only: [:index]
+  end
+  resources :jobs, only: [:show]
+  get "metrics", to: "metrics#show"  # JSON for Turbo polling
+end
+```
+
+---
+
+## 7. Controllers
+* `DashboardController#index` – loads Metrics & queues.
+* `QueuesController#index` – list with stats.
+* `QueuesController#show` – queue overview & first page of jobs.
+* `JobsController#index` – filtered list by queue/state.
+* `JobsController#show` – job detail.
+* `MetricsController#show` – returns partial/stream fragment for live refresh.
+
+All inherit from `ModernQueueDashboard::ApplicationController`, which defines layout & before_actions.
+
+---
+
+## 8. Views & Components
+* Use **Turbo Frames** to update sections without full-page reload.
+* Tailwind classes for styling; minimal custom CSS.
+* Consider **ViewComponent** (optional) for reusable pieces (metric card, table row).
+
+Pages:
+1. **Dashboard** – metric cards + table of top 10 queues.
+2. **Queue show** – header (stats) + jobs table.
+3. **Job show** – read-only details with collapsible JSON args & error.
+
+---
+
+## 9. Hotwire Behaviour
+* Stimulus controller `refresh_controller.js` fetches `/metrics` every N seconds (default 5) and updates via Turbo.
+* Jobs/queue pages optionally auto-refresh lists.
+* Configurable via `ModernQueueDashboard.configuration.refresh_interval`.
+
+---
+
+## 10. Styling / Assets
+* `tailwindcss-rails` build task generates `modern_queue_dashboard.css`.
+* Color palette close to Active Storage Dashboard (gray/indigo).
+* Provide a helper to override Tailwind config via initializer if host app precompiles their own CSS.
+* Ship minified CSS/JS in the gem (`app/assets/builds`).
+
+---
+
+## 11. Configuration API
+```ruby
+# config/initializers/modern_queue_dashboard.rb
+ModernQueueDashboard.configure do |config|
+  config.refresh_interval = 5
+  config.time_zone = "UTC"
+end
+```
+
+Defaults live in `ModernQueueDashboard::Configuration`.
+
+---
+
+## 12. Authentication Guidance (README)
+```ruby
+# config/routes.rb in host app
+authenticate :user, -> { _1.admin? } do
+  mount ModernQueueDashboard::Engine, at: "/modern-queue-dashboard"
+end
+```
+Or rack basic auth example.
+
+---
+
+## 13. Testing Strategy (Minitest)
+* **Models/Queries**: unit tests.
+* **Controllers**: request specs.
+* **Components**: view/component tests.
+* Dummy app under `test/dummy` for engine isolation.
+* No system tests; rely on controller tests + minimal Turbo response assertions.
+
+---
+
+## 14. CI
+* GitHub Actions: run `bundle exec rake test`, Rubocop, `rails test:dummy` against sqlite3.
+* Matrix for latest stable Ruby & JRuby.
+
+---
+
+## 15. Release & Versioning
+* Semantic versioning starting at `0.1.0`.
+* Publish to RubyGems when dashboard feature-complete.
+
+---
+
+## 16. Future Enhancements (out-of-scope for 0.1.0)
+* Job actions (retry, discard, delete).
+* Prometheus/JSON metrics.
+* Live WebSocket updates instead of polling.
+* Scheduler/Recurring task visualizer.
+* Dark mode theme.
+* System tests (Turbo-flavored).
+
+---
+
+## 17. Implementation Roadmap
+1. **Bootstrap gem** – `bundle gem modern_queue_dashboard --mit --coc --test=minitest`.
+2. **Create engine, routes, layout**.
+3. **Add Tailwind & Turbo assets**.
+4. **Implement Metrics query object**.
+5. **Build DashboardController & dashboard view**.
+6. **Queue stats & pages**.
+7. **Job finder & details page**.
+8. **Stimulus polling**.
+9. **Configuration DSL**.
+10. **Dummy app + tests**.
+11. **README & screenshots**.
+12. **Precompile assets & ship builds**.
+13. **Set up CI**.
+14. **Tag `v0.1.0` and release.**
+
+---

data/lib/modern_queue_dashboard/engine.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails/engine"
+require "tailwindcss-rails" if defined?(TailwindCss)
+
+module ModernQueueDashboard
+  class Engine < ::Rails::Engine
+    isolate_namespace ModernQueueDashboard
+
+    # Precompile CSS & JS builds that ship with the gem
+    initializer "modern_queue_dashboard.assets" do |app|
+      # Check if the app uses the asset pipeline that requires explicit precompilation
+      if app.config.respond_to?(:assets) && app.config.assets.respond_to?(:precompile)
+        app.config.assets.precompile += %w[modern_queue_dashboard.css modern_queue_dashboard.js]
+      end
+
+      # Configure paths for Tailwind CSS if available
+      if defined?(TailwindCss) && app.config.respond_to?(:tailwindcss)
+        app.config.tailwindcss.content_root = root.join("app").to_s
+        app.config.tailwindcss.content_includes = [ "./views/**/*.html.erb", "./helpers/**/*.rb" ]
+      end
+    end
+  end
+end

data/lib/modern_queue_dashboard/metrics.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ModernQueueDashboard
+  Metric = Struct.new(:key, :label, :value, keyword_init: true)
+
+  class Metrics
+    def self.summary
+      [
+        Metric.new(key: :pending, label: "Pending", value: count_pending_jobs),
+        Metric.new(key: :scheduled, label: "Scheduled", value: count_scheduled_jobs),
+        Metric.new(key: :running, label: "Running", value: count_running_jobs),
+        Metric.new(key: :failed, label: "Failed", value: count_failed_jobs),
+        Metric.new(key: :completed, label: "Completed", value: count_completed_jobs),
+        Metric.new(key: :latency, label: "Latency", value: calculate_latency)
+      ]
+    end
+
+    # These methods are placeholders and will need to be implemented using the SolidQueue models
+    def self.count_pending_jobs
+      0
+    end
+
+    def self.count_scheduled_jobs
+      0
+    end
+
+    def self.count_running_jobs
+      0
+    end
+
+    def self.count_failed_jobs
+      0
+    end
+
+    def self.count_completed_jobs
+      0
+    end
+
+    def self.calculate_latency
+      0
+    end
+  end
+end

data/lib/modern_queue_dashboard/queue_summary.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ModernQueueDashboard
+  QueueStat = Struct.new(:name, :pending, :scheduled, :running, :failed, :latency, keyword_init: true)
+
+  class QueueSummary
+    def self.with_stats
+      # This is a placeholder and will need actual implementation using SolidQueue
+      results = [
+        QueueStat.new(
+          name: "default",
+          pending: 0,
+          scheduled: 0,
+          running: 0,
+          failed: 0,
+          latency: 0
+        )
+      ]
+      QueueStatCollection.new(results)
+    end
+  end
+
+  class QueueStatCollection
+    include Enumerable
+
+    def initialize(stats)
+      @stats = stats
+    end
+
+    def each(&)
+      @stats.each(&)
+    end
+
+    def limit(num)
+      QueueStatCollection.new(@stats.take(num))
+    end
+  end
+end

data/lib/modern_queue_dashboard/version.rb

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

data/lib/modern_queue_dashboard.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "rails"
+require "action_controller/railtie"
+require "active_support/dependencies"
+require_relative "modern_queue_dashboard/version"
+require_relative "modern_queue_dashboard/engine"
+require_relative "modern_queue_dashboard/metrics"
+require_relative "modern_queue_dashboard/queue_summary"
+
+module ModernQueueDashboard
+  class Error < StandardError; end
+
+  class Configuration
+    attr_accessor :refresh_interval, :time_zone
+
+    def initialize
+      @refresh_interval = 5
+      @time_zone = "UTC"
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+  # Your code goes here...
+end