sqdash 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbf32880457e6d0e0ee135bdedcd9c4011bcf4a446c195eaa18a296e2afc20c6
-  data.tar.gz: e1dfaf39989e034e60c48932dc7a0599d0c3a1b42db79b7058e49b7325450f64
+  metadata.gz: 72ee9eb4f696be8766e6dbdbd24a75651674c2c7369a3d634f68600002eff350
+  data.tar.gz: 0bf7bc1d1834a98dc8a9db6640b64967e8e193a67a4f6550bd7fc5b601a68de3
 SHA512:
-  metadata.gz: bf714d16853aab1ccdf74e756dfdb0477b459903fa5c6f20d8984673946562cb693c3f51bde983882a8add79107d44ecdce7fb872e7f49a1c63c77b812d1048e
-  data.tar.gz: d06062de2d0d589685e015b8da084414460c38b9688069cf0b73ba2973704f6d33606cc3e1df7a609acea3ccd0fb8b5f9985a41e53d41055a16debf062838046
+  metadata.gz: 6e1396b021bc066a486d5b5be623bf76d058c123ada0184d253f05aa98b4996e194767db96dc8377311a1c8e6d2f6c6eb237acef48d545c1c9bc8698a15cf5a2
+  data.tar.gz: '007933f8ea693afcb433bb41ba1e72e274b0d8f1506a4e3dfc62dd52acfe447251604cc3be2668bb0872290453d515a894fcd915ff1f46a5824a7e01a29f015e'

data/.rubocop.yml

@@ -0,0 +1,71 @@
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - "vendor/**/*"
+    - "bin/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - "lib/sqdash/cli.rb"
+    - "lib/sqdash/renderer.rb"
+
+Metrics/MethodLength:
+  Max: 30
+  Exclude:
+    - "lib/sqdash/cli.rb"
+    - "lib/sqdash/renderer.rb"
+    - "lib/sqdash/input_handler.rb"
+    - "lib/sqdash/autocomplete.rb"
+
+Metrics/ClassLength:
+  Max: 300
+  Exclude:
+    - "lib/sqdash/cli.rb"
+    - "test/cli_test.rb"
+
+Metrics/ModuleLength:
+  Max: 100
+  Exclude:
+    - "lib/sqdash/renderer.rb"
+    - "lib/sqdash/input_handler.rb"
+    - "lib/sqdash/autocomplete.rb"
+
+Metrics/AbcSize:
+  Max: 30
+  Exclude:
+    - "lib/sqdash/cli.rb"
+    - "lib/sqdash/renderer.rb"
+    - "lib/sqdash/autocomplete.rb"
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+  Exclude:
+    - "lib/sqdash/cli.rb"
+    - "lib/sqdash/autocomplete.rb"
+
+Metrics/PerceivedComplexity:
+  Max: 15
+  Exclude:
+    - "lib/sqdash/cli.rb"
+    - "lib/sqdash/renderer.rb"
+    - "lib/sqdash/autocomplete.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "test/**/*"
+    - "sqdash.gemspec"

data/README.md

@@ -1,4 +1,4 @@
-# sqdash
+# sqdash: Solid Queue Terminal Dashboard
 
 A terminal dashboard for Rails 8's Solid Queue.
 
@@ -7,6 +7,7 @@ Solid Queue is the default Active Job backend in Rails 8, but it ships with no b
 ## Features
 
 - Live overview of all Solid Queue jobs with status, queue, and timestamps
+- Paginated loading — handles 100k+ jobs without slowing down
 - View filters: all, failed, completed, pending
 - Sortable by created date or ID, ascending or descending
 - Fuzzy text filter across job class, queue name, and ID
@@ -32,7 +33,7 @@ bundle add sqdash
 sqdash connects directly to your Solid Queue database. You need:
 
 - A database with the Solid Queue schema (`solid_queue_*` tables) — PostgreSQL, MySQL, or SQLite
-- Ruby >= 3.0
+- Ruby >= 3.2
 - The database adapter gem for your database:
 
 ```bash
@@ -62,11 +63,66 @@ sqdash sqlite3:///path/to/queue.db
 export DATABASE_URL=postgres://user:pass@localhost:5432/myapp_queue
 sqdash
 
+# Use a specific config file
+sqdash --config /path/to/config.yml
+
 # Falls back to default: postgres://sqd:sqd@localhost:5432/sqd_web_development_queue
 sqdash
 ```
 
-Connection priority: **CLI argument** > **`DATABASE_URL` env var** > **built-in default**.
+Connection priority: **CLI argument** > **`DATABASE_URL` env var** > **`.sqdash.yml`** > **`~/.sqdash.yml`** > **built-in default**.
+
+### Config file
+
+Instead of passing a database URL every time, create a `.sqdash.yml` file in your project directory or home directory:
+
+```yaml
+# .sqdash.yml or ~/.sqdash.yml
+database_url: postgres://user:pass@localhost:5432/myapp_queue
+```
+
+A project-local `.sqdash.yml` takes precedence over `~/.sqdash.yml`. You can also specify a config file explicitly with `--config` / `-c`.
+
+## How to use
+
+Once connected, sqdash shows a live dashboard of all your Solid Queue jobs. Here are common workflows:
+
+### Quick start
+
+```bash
+# Connect to your Rails app's queue database
+sqdash postgres://user:pass@localhost:5432/myapp_development
+
+# Or if you have a .sqdash.yml config file, just run:
+sqdash
+```
+
+### Investigating failed jobs
+
+1. Type `:view failed` and press `Enter` to show only failed jobs
+2. Use `↑`/`↓` to select a job
+3. Press `Enter` to see the full error backtrace and job arguments
+4. Press `r` to retry the job, or `d` to discard it
+5. Press `Esc` to go back to the list
+
+### Finding a specific job
+
+1. Press `/` to open the search filter
+2. Start typing a job class name (e.g., `UserMailer`), queue name, or job ID
+3. Press `Tab` to autocomplete — sqdash suggests matching class and queue names
+4. Press `Enter` to apply the filter
+5. Press `Esc` to clear the filter and see all jobs again
+
+### Sorting jobs
+
+1. Press `:` to open the command bar
+2. Type `sort created asc` to see oldest jobs first (useful for finding stuck jobs)
+3. Press `Enter` to apply
+4. Other options: `sort created desc` (default), `sort id asc`, `sort id desc`
+
+### Monitoring a queue in real time
+
+sqdash auto-refreshes data every second when idle. You can also press `Space` to manually refresh. The stats bar at the top shows live counts of total, completed, failed, and pending jobs.
 
 ### Keyboard shortcuts
 
@@ -106,6 +162,7 @@ git clone https://github.com/nuhasami/sqdash.git
 cd sqdash
 bin/setup
 bundle exec ruby exe/sqdash
+rake test
 ```
 
 ## Contributing

data/Rakefile

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/exe/sqdash

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require "sqdash"
 Sqdash::CLI.start

data/lib/sqdash/autocomplete.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Sqdash
+  module Autocomplete
+    def autocomplete_filter
+      return if @filter_text.empty?
+
+      query = @filter_text.downcase
+
+      candidates = (
+        Models::Job.distinct.pluck(:class_name) +
+        Models::Job.distinct.pluck(:queue_name)
+      ).uniq
+
+      matches = candidates.select { |c| c.downcase.start_with?(query) }
+
+      if matches.length == 1
+        @filter_text = matches.first
+      elsif matches.length > 1
+        @filter_text = common_prefix(matches)
+      end
+
+      load_data
+    end
+
+    def autocomplete_hint
+      return "" if @filter_text.empty?
+
+      query = @filter_text.downcase
+      candidates = (
+        Models::Job.distinct.pluck(:class_name) +
+        Models::Job.distinct.pluck(:queue_name)
+      ).uniq
+
+      matches = candidates.select { |c| c.downcase.start_with?(query) }
+
+      if matches.length == 1
+        matches.first[@filter_text.length..]
+      elsif matches.length > 1
+        prefix = common_prefix(matches)
+        remaining = prefix[@filter_text.length..] || ""
+        remaining + " (#{matches.length} matches)"
+      else
+        " (no matches)"
+      end
+    end
+
+    def autocomplete_command
+      return if @command_text.empty?
+
+      parts = @command_text.strip.split(/\s+/)
+      completing_new_word = @command_text.end_with?(" ")
+
+      if completing_new_word
+        case parts.length
+        when 1
+          subtree = CLI::COMMANDS[parts[0]]
+          return unless subtree.is_a?(Hash)
+
+          completed = complete_word("", subtree.keys)
+          @command_text = "#{parts[0]} #{completed}" if completed
+        when 2
+          subtree = CLI::COMMANDS.dig(parts[0], parts[1])
+          return unless subtree.is_a?(Array) && subtree.any?
+
+          completed = complete_word("", subtree)
+          @command_text = "#{parts[0]} #{parts[1]} #{completed}" if completed
+        end
+      else
+        case parts.length
+        when 1
+          completed = complete_word(parts[0], CLI::COMMANDS.keys)
+          @command_text = completed if completed
+        when 2
+          subtree = CLI::COMMANDS[parts[0]]
+          return unless subtree.is_a?(Hash)
+
+          completed = complete_word(parts[1], subtree.keys)
+          @command_text = "#{parts[0]} #{completed}" if completed
+        when 3
+          subtree = CLI::COMMANDS.dig(parts[0], parts[1])
+          return unless subtree.is_a?(Array) && subtree.any?
+
+          completed = complete_word(parts[2], subtree)
+          @command_text = "#{parts[0]} #{parts[1]} #{completed}" if completed
+        end
+      end
+    end
+
+    def command_autocomplete_hint
+      return "" if @command_text.empty?
+
+      parts = @command_text.strip.split(/\s+/)
+      completing_new_word = @command_text.end_with?(" ")
+
+      if completing_new_word
+        case parts.length
+        when 1
+          subtree = CLI::COMMANDS[parts[0]]
+          return "" unless subtree.is_a?(Hash)
+
+          hint_for_candidates("", subtree.keys)
+        when 2
+          subtree = CLI::COMMANDS.dig(parts[0], parts[1])
+          return "" unless subtree.is_a?(Array) && subtree.any?
+
+          hint_for_candidates("", subtree)
+        else
+          ""
+        end
+      else
+        case parts.length
+        when 1
+          hint_for_candidates(parts[0], CLI::COMMANDS.keys)
+        when 2
+          subtree = CLI::COMMANDS[parts[0]]
+          return "" unless subtree.is_a?(Hash)
+
+          hint_for_candidates(parts[1], subtree.keys)
+        when 3
+          subtree = CLI::COMMANDS.dig(parts[0], parts[1])
+          return "" unless subtree.is_a?(Array) && subtree.any?
+
+          hint_for_candidates(parts[2], subtree)
+        else
+          ""
+        end
+      end
+    end
+
+    def complete_word(partial, candidates)
+      matches = candidates.select { |c| c.downcase.start_with?(partial.downcase) }
+      if matches.length == 1
+        matches.first
+      elsif matches.length > 1
+        prefix = common_prefix(matches)
+        prefix.length > partial.length ? prefix : nil
+      end
+    end
+
+    def common_prefix(strings)
+      return "" if strings.empty?
+
+      prefix = strings.first
+      strings.each do |s|
+        prefix = prefix[0...prefix.length].chars.take_while.with_index { |c, i| s[i]&.downcase == c.downcase }.join
+      end
+      prefix
+    end
+
+    def hint_for_candidates(partial, candidates)
+      matches = candidates.select { |c| c.downcase.start_with?(partial.downcase) }
+      if matches.length == 1
+        matches.first[partial.length..]
+      elsif matches.length > 1
+        prefix = common_prefix(matches)
+        remaining = prefix[partial.length..] || ""
+        remaining + " (#{matches.join('|')})"
+      else
+        " (no matches)"
+      end
+    end
+  end
+end