panoptic 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92d310e17406ea0681469b5f4f4ff1d456b9d24ad4c89d4498adc87643f9ed8c
-  data.tar.gz: 9e2faccbac6daf2820c63202adc28292918934e596462443b046be5d4b874c72
+  metadata.gz: 7765d548dafa03735d2dc25e0319bb04857aeaff9b4b8394eec1f1f524674eee
+  data.tar.gz: a2aa9f24af59985caff5c0d4650f474f727819d247964d54175da407fd5fd3dd
 SHA512:
-  metadata.gz: b596a1d4224631ffb6f1e619958bbed94c20c4bfcb6c64fd967045efd40d785be72d2393b1317dc239866be6ba35952eebbf3eeac22e02cc270626475f325328
-  data.tar.gz: b07d2227e30e712aedaeb5d1213991fba6cb5e467f67466795c3b1fd8d10a92e9fa5c9a98e86f6afc2a71bd2ac4de963c3a5de2a49a3f74494973c666227d4ba
+  metadata.gz: 0e65e09ed7d09a7e3543e03b04f7c6fb12536b37fab220ce4c5e9170cdcd94093f6dd8105c0f998ee9333817b6ea11372627708c412c9f088e22e1278a14a546
+  data.tar.gz: a5ad871749df301daf5e13561cfafe05ae5d1bc8f1a67030560f027c92c4ba4d962beb386ce44a2716411673100ff8c2c6f821b4d9be5d66c20ba932a72aa183

data/README.md

@@ -1,8 +1,12 @@
 # Panoptic
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+[![Gem Version](https://badge.fury.io/rb/panoptic.svg)](https://badge.fury.io/rb/panoptic)
+
+Panoptic is a web interface for the [SolidQueue](https://github.com/basecamp/solid_queue) queuing backend.
+
+![](./images/demo.png)
+
+While MissionControl is getting ready for release, this gem offers a visual interface for testing purposes with SolidQueue. 
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -11,18 +15,23 @@ Add this line to your application's Gemfile:
 gem "panoptic"
 ```
 
-And then execute:
-```bash
-$ bundle
-```
+Then mount the engine in your `config/routes.rb` file 
 
-Or install it yourself as:
-```bash
-$ gem install panoptic
+```ruby
+mount Panoptic::Engine => "/panoptic"
 ```
 
-## Contributing
-Contribution directions go here.
+## Usage 
+
+Once the gem is installed and the Engine mounted, visit your engine route to access Panoptic. For now, it offers three views: 
+- Processes 
+- Queues 
+- A first version of the jobs view 
+
+In the near future, the following features could be implemented: 
+- Pause and clear queues 
+- Advanced jobs view, with filters for executed, failed and scheduled jobs
+- Search and retries
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/panoptic/application_controller.rb

@@ -1,4 +1,5 @@
 module Panoptic
   class ApplicationController < ActionController::Base
+    include Pagy::Backend
   end
 end

data/app/controllers/panoptic/jobs/failed_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Panoptic
+  class Jobs::FailedController < ApplicationController
+    def index
+      # TODO: use the `failed` scope available in SolidQueue next release
+      @pagy, @jobs = pagy(
+        SolidQueue::Job.joins(:failed_execution).order(created_at: :asc)
+      )
+
+      render "panoptic/jobs/index"
+    end
+  end
+end

data/app/controllers/panoptic/jobs/scheduled_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Panoptic
+  class Jobs::ScheduledController < ApplicationController
+    def index
+      # TODO: use the `scheduled` scope available in SolidQueue next release
+      @pagy, @jobs = pagy(
+        SolidQueue::Job.joins(:scheduled_execution).order(created_at: :asc)
+      )
+
+      render "panoptic/jobs/index"
+    end
+  end
+end

data/app/controllers/panoptic/jobs_controller.rb

@@ -2,8 +2,6 @@
 
 module Panoptic
   class JobsController < ApplicationController
-    include Pagy::Backend
-
     def index
       @pagy, @jobs = pagy(SolidQueue::Job.order(created_at: :asc))
     end

data/app/helpers/panoptic/application_helper.rb

@@ -1,5 +1,6 @@
 module Panoptic
   module ApplicationHelper
     include Pagy::Frontend
+    include DateTimeHelper
   end
 end

data/app/helpers/panoptic/date_time_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Panoptic
+  module DateTimeHelper
+    def safe_time_tag(date_or_time, *args, &block)
+      return "-" unless date_or_time
+
+      time_tag(date_or_time, *args, &block)
+    end
+  end
+end

data/app/views/panoptic/jobs/_job.html.erb

@@ -2,7 +2,6 @@
   <th scope="row"><%= job.id %></th>
   <td scope="col"><%= job.class_name %></td>
   <td scope="col"><%= job.queue_name %></td>
-  <td scope="col"><%= job.arguments %></td>
-  <td scope="col"><% job.scheduled_at %></td>
-  <td scope="col"><% job.finished_at %></td>
+  <td scope="col"><%= safe_time_tag job.scheduled_at %></td>
+  <td scope="col"><%= safe_time_tag job.finished_at %></td>
 </tr>

data/app/views/panoptic/jobs/index.html.erb

@@ -1,5 +1,17 @@
 <h1>Jobs</h1>
 
+<ul class="nav nav-underline">
+  <li class="nav-item">
+    <%= link_to "All", jobs_path, class: class_names("nav-link", "active": current_page?(jobs_path)) %>
+  </li>
+  <li class="nav-item">
+    <%= link_to "Scheduled", scheduled_jobs_path, class: class_names("nav-link", "active": current_page?(scheduled_jobs_path)) %>
+  </li>
+  <li class="nav-item">
+    <%= link_to "Failed", failed_jobs_path, class: class_names("nav-link", "active": current_page?(failed_jobs_path)) %>
+  </li>
+</ul>
+
 <div class="d-flex justify-content-end">
   <%== pagy_info(@pagy)  %> 
 </div>
@@ -10,14 +22,13 @@
       <th scope="col">#</th>
       <th scope="col">Class</th>
       <th scope="col">Queue</th>
-      <th scope="col">Arguments</th>
-      <th scope="col">Scheduled at</th>
-      <th scope="col">Finished at</th>
+      <th scope="col">Scheduled</th>
+      <th scope="col">Finished</th>
     </tr>
   </thead>
 
   <tbody>
-    <%= render partial: "job", collection: @jobs %>  
+    <%= render partial: "panoptic/jobs/job", collection: @jobs %>  
   </tbody>
 </table>
 

data/config/routes.rb

@@ -2,5 +2,13 @@ Panoptic::Engine.routes.draw do
   root to: "processes#index"
 
   resources :queues, only: [:index]
-  resources :jobs, only: [:index]
+
+  scope "jobs" do
+    get "all", to: "jobs#index", as: "jobs"
+
+    scope module: "jobs" do
+      resources :scheduled, only: :index, as: :scheduled_jobs
+      resources :failed, only: :index, as: :failed_jobs
+    end
+  end
 end

data/lib/panoptic/version.rb

@@ -1,3 +1,3 @@
 module Panoptic
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panoptic
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Vincent Rolea
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2023-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,10 +63,13 @@ files:
 - README.md
 - Rakefile
 - app/controllers/panoptic/application_controller.rb
+- app/controllers/panoptic/jobs/failed_controller.rb
+- app/controllers/panoptic/jobs/scheduled_controller.rb
 - app/controllers/panoptic/jobs_controller.rb
 - app/controllers/panoptic/processes_controller.rb
 - app/controllers/panoptic/queues_controller.rb
 - app/helpers/panoptic/application_helper.rb
+- app/helpers/panoptic/date_time_helper.rb
 - app/jobs/panoptic/application_job.rb
 - app/mailers/panoptic/application_mailer.rb
 - app/models/panoptic/application_record.rb