ruby-progress 1.3.4 → 1.3.5

data/README.md

@@ -2,32 +2,56 @@
 
 [![Gem Version](https://badge.fury.io/rb/ruby-progress.svg)](https://badge.fury.io/rb/ruby-progress)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![RSpec Tests](https://github.com/ttscoff/ruby-progress/actions/workflows/rspec.yml/badge.svg)](https://github.com/ttscoff/ruby-progress/actions/workflows/rspec.yml)
+<!-- [![RSpec Tests](https://github.com/ttscoff/ruby-progress/actions/workflows/rspec.yml/badge.svg)](https://github.com/ttscoff/ruby-progress/actions/workflows/rspec.yml) -->
 [![Ruby](https://img.shields.io/badge/ruby-%3E%3D%202.5.0-ruby.svg)](https://www.ruby-lang.org/)
-[![Coverage Status](https://img.shields.io/badge/coverage-55%25-yellow.svg)](#)
+<!-- [![Coverage Status](https://img.shields.io/badge/coverage-31%25-yellow.svg)](#) -->
 
 This repository contains three different Ruby progress indicator projects: **Ripple**, **Worm**, and **Twirl**. All provide animated terminal progress indicators with different visual styles and features.
 
 ## Table of Contents
 
-- [Unified Interface](#unified-interface)
-  - [Submitting jobs to a running daemon](#submitting-jobs-to-a-running-daemon)
-- [Job result schema](#job-result-schema)
-- [Example: start a daemon and send a job (simple)](#example-start-a-daemon-and-send-a-job-simple)
-- [Ripple](#ripple)
-  - [Ripple Features](#ripple-features)
-  - [Ripple Usage](#ripple-usage)
-- [Twirl](#twirl)
-- [Worm](#worm)
-  - [Daemon mode (background indicator)](#daemon-mode-background-indicator)
-- [Requirements](#requirements)
-- [Installation](#installation)
-- [Universal Utilities](#universal-utilities)
-  - [Terminal Control](#terminal-control)
-  - [Completion Messages](#completion-messages)
-- [Development](#development)
-- [Contributing](#contributing)
-- [License](#license)
+- [Ruby Progress Indicators](#ruby-progress-indicators)
+  - [Table of Contents](#table-of-contents)
+  - [Unified Interface](#unified-interface)
+    - [Global Options](#global-options)
+    - [Stopping a backgrounded progress indicator](#stopping-a-backgrounded-progress-indicator)
+      - [Job Control Subcommands](#job-control-subcommands)
+  - [Example: background mode demo](#example-background-mode-demo)
+  - [Ripple](#ripple)
+    - [Ripple Features](#ripple-features)
+    - [Ripple Usage](#ripple-usage)
+      - [Ripple CLI examples](#ripple-cli-examples)
+      - [Ripple Command Line Options](#ripple-command-line-options)
+    - [Ripple Library Usage](#ripple-library-usage)
+  - [Twirl](#twirl)
+    - [Twirl Features](#twirl-features)
+    - [Twirl Usage](#twirl-usage)
+      - [Command Line](#command-line)
+      - [Twirl Command Line Options](#twirl-command-line-options)
+    - [Available Spinner Styles](#available-spinner-styles)
+  - [Worm](#worm)
+    - [Worm Features](#worm-features)
+    - [Worm Usage](#worm-usage)
+      - [Command Line](#command-line-1)
+      - [Daemon mode (background indicator)](#daemon-mode-background-indicator)
+      - [Worm Command Line Options](#worm-command-line-options)
+    - [Worm Library Usage](#worm-library-usage)
+    - [Animation Styles](#animation-styles)
+      - [Circles](#circles)
+      - [Blocks](#blocks)
+      - [Geometric](#geometric)
+      - [Custom Styles](#custom-styles)
+      - [Direction Control](#direction-control)
+  - [Requirements](#requirements)
+  - [Installation](#installation)
+    - [As a Gem (Recommended)](#as-a-gem-recommended)
+    - [From Source](#from-source)
+    - [Development](#development)
+  - [Universal Utilities](#universal-utilities)
+    - [Terminal Control](#terminal-control)
+    - [Completion Messages](#completion-messages)
+  - [Contributing](#contributing)
+  - [License](#license)
 
 ## Unified Interface
 
@@ -78,114 +102,86 @@ Notes:
 - The indicator clears its line on shutdown and prints the final message to STDOUT.
 - `--stop-pid` is still supported for backward compatibility, but `--stop [--pid-file FILE]` is preferred.
 
-### Submitting jobs to a running daemon
+### Stopping a backgrounded progress indicator
 
-When running a long-lived daemon (for example `prg worm --daemon`), you can submit additional commands to run and have their output displayed without disrupting the animation using the `prg job send` helper.
+When running a backgrounded progress indicator (for example `prg worm --daemon`), you can send control signals using the `prg job` command with subcommands.
 
-Basic usage:
+#### Job Control Subcommands
+
+**Stop a running daemon:**
 
 ```bash
-# Enqueue a command to the default daemon PID
-prg job send --command "./deploy-step.sh"
+# Send a stop signal to the default daemon
+prg job stop
+
+# Send a stop signal to a named daemon (uses /tmp/ruby-progress/<name>.pid)
+prg job stop --daemon-name mytask
 
-# Enqueue to a named daemon (creates /tmp/ruby-progress/<name>.pid)
-prg job send --daemon-name mytask --command "rsync -av ./dist/ user@host:/srv/app"
+# Send a stop signal with a completion message
+prg job stop --daemon-name mytask --message "Deployment complete!"
 
-# Read command from stdin (useful in scripts)
-echo "bundle exec rake db:migrate" | prg job send --stdin --daemon-name mytask
+# Send a stop signal with a checkmark
+prg job stop --daemon-name mytask --message "Build successful" --checkmark
 
-# Wait for the job result and print the job result JSON (default timeout 10s)
-prg job send --daemon-name mytask --command "./deploy-step.sh" --wait --timeout 30
+# Send a stop signal indicating an error
+prg job stop --daemon-name mytask --message "Build failed" --error
 ```
 
-You can also send control/action jobs (no shell command) to a running daemon. These are JSON payloads with an `action` key handled by the daemon's job processor. The helper supports a few common actions:
+**Check daemon status:**
 
 ```bash
-# Send a simple 'advance' action (no value)
-prg job send --daemon-name demo --advance
+# Check if a daemon is running
+prg job status --daemon-name mytask
 
-# Send a 'percent' action with a numeric value
-prg job send --daemon-name demo --percent 42
+# Check status using a PID file
+prg job status --pid-file /tmp/ruby-progress/mytask.pid
+```
 
-# Example using `fill` as a named daemon and sending percent updates
-```bash
-# Start a named fill worker (non-detaching so animation remains visible)
-prg fill --daemon-as demo --no-detach --output-lines 3 --output-position top
+**Advance a progress indicator:**
 
-# Send percent updates to the named worker
-prg job send --daemon-name demo --percent 10 --wait
-prg job send --daemon-name demo --percent 50 --wait
-prg job send --daemon-name demo --percent 100 --wait
-```
+```bash
+# Advance progress by 1 (for indicators that support it)
+prg job advance --daemon-name mytask
 
-# Or use the generic action/value pair
-prg job send --daemon-name demo --action percent --value 42
+# Advance by a specific amount
+prg job advance --daemon-name mytask --amount 10
 ```
 
-Note about stopping named daemons:
+**Backward Compatibility:**
 
-You can target named daemons directly using the `--stop-id NAME` shorthand which implies `--stop` and targets the named daemon (it is normalized to the canonical daemon name used for the PID file). This is convenient for scripts and demos. Example:
+The legacy `prg job send` command is still supported but deprecated. It functions identically to `prg job stop`:
 
 ```bash
-# Stop a named fill worker with a success message
-prg fill --stop-id demo --stop-success 'Demo finished'
+# This still works but shows a deprecation warning
+prg job send --daemon-name mytask --message "Complete!"
 ```
 
-Behavior and file layout:
-
-- Jobs are written as JSON files into the daemon's job directory, which is derived from the daemon PID file. For example, a PID file `/tmp/ruby-progress/mytask.pid` maps to the job directory `/tmp/ruby-progress/mytask.jobs`.
-- The CLI writes the job atomically by first writing a `*.json.tmp` temporary file and then renaming it to `*.json`.
-- The daemon's job processor claims jobs atomically by renaming the job file to `*.processing`, writes a `*.processing.result` JSON file when finished, and moves processed jobs to `processed-*`.
-
-This mechanism allows you to submit many commands to a single running indicator and have their output shown in reserved terminal rows while the animation continues.
-
-## Job result schema
+Alternatively, you can use the built-in `--stop` flags on the progress commands:
 
-When a job is processed the daemon writes a small JSON result file next to the claimed job with the suffix `.processing.result` containing at least these keys:
-
-- `id` - the job id (string)
-- `status` - `"done"` or `"error"`
-- `time` - epoch seconds when the job finished (integer)
-
-Depending on the job handler, additional keys may be present:
-
-- `exit_status` - the numeric process exit status (integer or nil if unknown)
-- `output` - a string with the last captured lines of output (if available)
-- `error` - an error message when `status` is `error`
-
-Example:
+```bash
+# Stop a named daemon with a success message
+prg worm --stop-id demo --stop-success 'Task completed'
 
-```json
-{
-  "id": "8a1f6c1e-4b7a-4f2c-b0a8-9e9f1c2f1a2b",
-  "status": "done",
-  "time": 1634044800,
-  "exit_status": 0,
-  "output": "Step 1 completed\nStep 2 completed"
-}
+# Stop with an error message
+prg worm --stop-id demo --stop-error 'Task failed'
 ```
 
-This file is intended for short messages and small captured output snippets (the CLI captures the last N lines). If you need larger logs, write them to a persistent file from the command itself and include a reference in the job metadata.
-
-## Example: start a daemon and send a job (simple)
-
-Below is an example script that demonstrates starting a worm daemon, sending a job, waiting for the result, and stopping the daemon.
----
+## Example: background mode demo
 
-If you want the background worker to continue writing to the same terminal (so you can visually watch the animation while your script continues), use the non-detaching background mode:
+Below is an example script that demonstrates starting a backgrounded progress indicator, doing work, and stopping it with a message.
 
 ```bash
-# Start a named worm worker that backgrounds but does not fully detach
-prg worm --daemon-as demo --no-detach
+# Start a named worm worker that runs in the background
+prg worm --daemon-as demo
 
-# In the same script or a subsequent command, enqueue a job to that worker
-prg job send --daemon-name demo --command "echo hello; sleep 1; echo done" --wait
+# Do some work in your script...
+sleep 2
 
 # Stop the worker with a success message
-prg worm --stop-id demo --stop-success "Demo finished"
+prg job stop --daemon-name demo --message "Demo finished" --checkmark
 ```
 
-Note: Non-detaching mode keeps the child process attached to the controlling TTY. That means both the worker and the invoking shell may write to the terminal and outputs can interleave.
+**Note:** Daemon mode automatically backgrounds the process using `Process.fork` and `Process.detach`, so you don't need to append `&`. The process detaches cleanly without shell job notifications.
 
 ## Ripple
 

data/bin/prg

@@ -24,14 +24,8 @@ module PrgCLI
     # Handle `job` subcommands early
     if ARGV[0] && ARGV[0].downcase == 'job'
       ARGV.shift
-      sub = ARGV.shift
-      case sub
-      when 'send'
-        JobCLI.send(ARGV)
-      else
-        puts 'job subcommands: send'
-        exit 1
-      end
+      JobCLI.run(ARGV)
+      exit
     end
     # Early scan: detect --ends flag and validate its argument before dispatching
     if (i = ARGV.index('--ends')) && ARGV[i + 1]
@@ -151,16 +145,16 @@ module PrgCLI
   # Spawn a background child but do NOT fully detach from the controlling
   # terminal. This keeps the child attached to the same TTY so animations
   # remain visible, while the parent exits immediately allowing the caller
-  # (shell or script) to continue. Use when the user requests a non-detaching
-  # background worker (e.g. `--daemon-as NAME --no-detach`).
+  # (shell or script) to continue.
   def self.backgroundize
     pid = fork
-    return unless pid
-
-    # parent: exit so the invoking shell/script continues
-    exit(0)
-
-    # child: continue without setsid/IO close so output remains on the TTY
+    if pid
+      # Parent: detach child and exit silently
+      Process.detach(pid)
+      exit(0)
+    end
+    # Child: create new process group but keep stdin/stdout/stderr
+    Process.setsid
   end
 
   # Attempt to stop processes for the given subcommand. Return true if any

data/examples/daemon_job_example.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env sh
-# Example: start a worm daemon, send a job, wait for result, then stop.
+# Example: start a worm in background mode, do some work, then stop it with a message.
 # This script assumes you're running from the project root and have a working
 # `bin/prg` script in the repository.
 
@@ -8,18 +8,16 @@ set -eu
 PROJECT_ROOT="$(cd "$(dirname "$0")/.." && pwd)"
 PRG_BIN="$PROJECT_ROOT/bin/prg"
 
-echo "Starting worm daemon (named 'example')..."
-# prg detaches in daemon mode so no & needed
-$PRG_BIN worm --daemon-as example --message "Example daemon"
+echo "Starting worm in background mode (named 'example')..."
+# Use --no-detach to keep it visible in the current terminal for demos
+$PRG_BIN worm --daemon-as example --no-detach --message "Example running..." &
 
-sleep 0.2
+sleep 0.5
 
-echo "Sending job and waiting for result..."
-$PRG_BIN job send --daemon-name example --command "echo hello; sleep 0.1" --wait --timeout 10
-
-sleep 0.1
+echo "Doing some work..."
+sleep 2
 
 echo "Stopping daemon with success message..."
-$PRG_BIN worm --stop-success "Example finished" --stop-checkmark --daemon-name example
+$PRG_BIN job send --daemon-name example --message "Example finished" --checkmark
 
 echo "Done."

data/lib/ruby-progress/cli/fill_options.rb

@@ -5,7 +5,7 @@ require 'optparse'
 module RubyProgress
   module FillCLI
     # Option parsing extracted to reduce module length in FillCLI
-    # rubocop:disable Metrics/AbcSize, Metrics/BlockLength
+    # rubocop:disable Metrics/AbcSize
     module Options
       # rubocop :disable Metrics/MethodLength
       def self.parse_cli_options
@@ -146,10 +146,6 @@ module RubyProgress
               options[:daemon_name] = name
             end
 
-            opts.on('--no-detach', 'When used with --daemon/--daemon-as: run background child but do not fully detach from the terminal') do
-              options[:no_detach] = true
-            end
-
             opts.on('--pid-file FILE', 'PID file location (default: /tmp/ruby-progress/fill.pid)') do |file|
               options[:pid_file] = file
             end
@@ -266,6 +262,6 @@ module RubyProgress
         opts.to_s
       end
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/BlockLength
+    # rubocop:enable Metrics/AbcSize
   end
 end