solid_bro 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0575114fea552d5585ae04378861ae261cdc27e99feb5ddd669b87c25cb43062
+  data.tar.gz: 591212912d620f5567e875d9c9e533f9b9579608fffbb4e2ff54cc8498aca842
+SHA512:
+  metadata.gz: f8fe6346ca1fcf4a0cfd322c4d0024c72b32a6e990aa6813518c8abbc9f71dd7ab8a362c92c395737517dfc51322cbdd57076910e726672db18ae468253526ca
+  data.tar.gz: e85ceae138bb5fc6a9777171bd876697a0bb89c85aa54261c2f08e0a66e2c4a0d815a7a793cf3c98070938abf9bd37202d137577ea40c3f778814c6c30657361

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Emanuel Comsa
+
+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

@@ -0,0 +1,133 @@
+# SolidBro
+
+A web UI dashboard for managing SolidQueue jobs, queues, workers, and recurring tasks in Rails applications.
+
+## Features
+
+- **Job Management**: View all jobs with filtering by class name, queue name, and date ranges
+- **Job Scopes**: Filter by status (All, Failed, In Progress, Blocked, Scheduled, Finished)
+- **Pagination**: Built-in pagination using Pagy
+- **Queue Management**: View queues with job counts
+- **Worker Monitoring**: Monitor SolidQueue worker processes
+- **Recurring Tasks**: View and manage recurring job tasks
+- **Job Details**: Detailed job view with formatted arguments and exception information
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "solid_bro"
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+## Setup
+
+### 1. Mount the Engine
+
+Add the engine to your main application's routes file (`config/routes.rb`):
+
+```ruby
+Rails.application.routes.draw do
+  # Your existing routes...
+  
+  mount SolidBro::Engine => "/solid_bro"
+end
+```
+
+This will make the dashboard available at `/solid_bro` in your application.
+
+### 1.1. Protecting the Dashboard with HTTP Basic Auth
+
+Authentication is handled by the host application. A simple way to protect the SolidBro UI is to wrap the engine in HTTP Basic auth in an initializer:
+
+```ruby
+# config/initializers/solid_bro.rb
+
+if Rails.env.production?
+  SolidBro::Engine.middleware.use Rack::Auth::Basic, "SolidBro" do |username, password|
+    # Use environment variables so credentials are not hard‑coded
+    ActiveSupport::SecurityUtils.secure_compare(username, ENV.fetch("SOLID_BRO_USER")) &
+      ActiveSupport::SecurityUtils.secure_compare(password, ENV.fetch("SOLID_BRO_PASSWORD"))
+  end
+end
+```
+
+Set the credentials in your environment (for example in `credentials.yml.enc`, your deployment environment, or `.env`):
+
+```bash
+SOLID_BRO_USER=admin
+SOLID_BRO_PASSWORD=super-secret
+```
+
+You can also choose to integrate with your existing authentication system instead of HTTP Basic (e.g. only allow signed‑in admins) by adding the appropriate middleware or constraints around the engine mount in your app.
+
+### 2. Configure SolidQueue (if not already done)
+
+Make sure SolidQueue is configured in your application. Add to `config/application.rb`:
+
+```ruby
+config.active_job.queue_adapter = :solid_queue
+```
+
+### 3. Run Migrations
+
+Ensure SolidQueue migrations are run:
+
+```bash
+rails solid_queue:install:migrations
+rails db:migrate
+```
+
+### 4. Assets Setup
+
+**For Propshaft (Rails 7+ default)**: Assets are automatically added to your `manifest.js` in development/test environments. For production, you can run:
+
+```bash
+rails generate solid_bro:install
+```
+
+Or manually add to `app/assets/config/manifest.js`:
+```javascript
+//= link solid_bro/application.css
+//= link solid_bro/application.js
+```
+
+**For Sprockets**: Assets are automatically precompiled - no additional setup needed.
+
+## Usage
+
+Once mounted, access the dashboard at:
+
+- **Jobs**: `/solid_bro/jobs` (or `/solid_bro/` as the root)
+- **Queues**: `/solid_bro/queues`
+- **Workers**: `/solid_bro/workers`
+- **Recurring Tasks**: `/solid_bro/recurring-tasks`
+
+### Job Filtering
+
+The jobs index supports filtering by:
+- **Job class name**: Case-insensitive partial match
+- **Queue name**: Case-insensitive partial match
+- **Date range**: Filter by created_at (for all/failed/in_progress/blocked/scheduled) or finished_at (for finished jobs)
+
+### Job Actions
+
+- **Retry**: Retry a failed job (available on failed jobs)
+- **Discard**: Delete a job from the queue
+
+## Requirements
+
+- Rails >= 7.0
+- SolidQueue gem
+- Pagy >= 8.0
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: :spec
+

data/app/assets/javascripts/solid_bro/application.js

@@ -0,0 +1,25 @@
+document.addEventListener('DOMContentLoaded', () => {
+    console.log('Dashboard initialized');
+
+    // Add interactivity to buttons
+    const deleteButtons = document.querySelectorAll('.btn-danger');
+    deleteButtons.forEach(btn => {
+        btn.addEventListener('click', (e) => {
+            if(confirm('Are you sure you want to delete this user?')) {
+                const row = e.target.closest('tr');
+                row.style.opacity = '0.5';
+                setTimeout(() => {
+                    alert('User deleted (mock action)');
+                    row.style.opacity = '1';
+                }, 500);
+            }
+        });
+    });
+
+    const editButtons = document.querySelectorAll('.btn-icon:not(.btn-danger)');
+    editButtons.forEach(btn => {
+        btn.addEventListener('click', () => {
+            console.log('Edit clicked');
+        });
+    });
+});