ruby-progress 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b46930eb2d8991d939a50094820ddfd0821203a8ee1b393bbb3a1269d8c2032f
-  data.tar.gz: ae70d2f66ff64d6816b177a0e145d7c6ae8f6d1ee98f71cfb7198a9784493c36
+  metadata.gz: a22fcfc5ae8ffc222ac1f19f4d7b5295f9205c8ae95bce7ec8be8884e076f578
+  data.tar.gz: f96675ec9f6bcc1e6dd905763b45ea776bbf3f78f57629fc50a2cac4a13d22b2
 SHA512:
-  metadata.gz: 3323def54c36c02851a2b8da4c7daca769038631ad18610f89f1e6c390449785946f61cd70a53eebc96d93b0e8da2713c228bb4078df36d8b9e3a69a6c4c4d96
-  data.tar.gz: 66fb49464bfe312d53110de3cceb38c8e3c64f12c7b6e1790bde8da547ee6fb726d15c77458db6409dd72efebb4982b3ac7bec97197457f3162fe4527ece7d12
+  metadata.gz: 4a61a58643c367f94645d5f3fded92473c44f72ee17553f47f89e27403780cbb3c7bb0fb3a3b36876be8928162434cd28aa847ef6e2ec488ec115c64f06bee2e
+  data.tar.gz: 9a7eda5a91f80ea1be162bb6bd250da3134f0567fa1c47f6c9e782f6aa80e16ed379e60da48a1ebd59f44dcb80a50cc92467ed9ec42be7196ceb973be66113fb

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-10-14 13:03:02 UTC using RuboCop version 1.75.7.
+# on 2025-10-15 10:46:34 UTC using RuboCop version 1.75.7.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 4
+# Offense count: 3
 # Configuration parameters: EnforcedStyle, AllowedGems, Include.
 # SupportedStyles: Gemfile, gems.rb, gemspec
 # Include: **/*.gemspec, **/Gemfile, **/gems.rb
@@ -57,28 +57,28 @@ Lint/UselessAssignment:
     - 'demo_gem.rb'
     - 'spec/cli_integration_spec.rb'
 
-# Offense count: 50
+# Offense count: 46
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 121
 
-# Offense count: 52
+# Offense count: 56
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 111
+  Max: 136
 
 # Offense count: 5
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
   Max: 200
 
-# Offense count: 33
+# Offense count: 29
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 26
+  Max: 22
 
-# Offense count: 70
+# Offense count: 68
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 140
@@ -86,17 +86,17 @@ Metrics/MethodLength:
 # Offense count: 10
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 287
+  Max: 231
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 6
 
-# Offense count: 32
+# Offense count: 28
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Max: 27
+  Max: 22
 
 # Offense count: 1
 # Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
@@ -122,7 +122,7 @@ Style/Documentation:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/ruby-progress.rb'
-    - 'lib/ruby-progress/daemon.rb'
+    - 'lib/ruby-progress/cli/job_cli.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
@@ -132,6 +132,13 @@ Style/EmptyElse:
   Exclude:
     - 'lib/ruby-progress/ripple.rb'
 
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, Mode, AllowedMethods, AllowedPatterns.
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
@@ -155,6 +162,12 @@ Style/InfiniteLoop:
   Exclude:
     - 'lib/ruby-progress/ripple.rb'
 
+# Offense count: 2
+Style/MultilineBlockChain:
+  Exclude:
+    - 'spec/cli/twirl_options_unit_spec.rb'
+    - 'spec/job_cli_spec.rb'
+
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
@@ -180,7 +193,7 @@ Style/StringLiterals:
   Exclude:
     - 'test_worm_flags.rb'
 
-# Offense count: 46
+# Offense count: 50
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https

data/CHANGELOG.md

@@ -5,67 +5,47 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 1.3.0 - 2025-10-12
+## [1.3.5] - 2025-10-15
 
 ### Added
 
-- PTY-based output capture: `RubyProgress::OutputCapture` now allows running commands under a PTY, keeps a rolling buffer of the last N lines for live redraw, and optionally writes the full streamed output to a `log_path` file.
-- File-based daemon job queue: `RubyProgress::Daemon.process_jobs` implements atomic job enqueue/claim/processing with `.processing.result` metadata files and processed-archive behavior.
-- `prg job send` CLI helper: atomically writes jobs to daemon job dirs and supports `--wait` to poll for results, `--daemon-name`, `--pid-file`, `--stdin`, and `--timeout`.
-- Integration of job processing into Ripple/Twirl/Worm daemon modes so a running daemon can accept and display job output without interrupting animations.
-- CLI options for output handling: `--output-position` and `--output-lines` to reserve terminal rows for captured output.
+- **Job CLI refactoring**: Restructured `prg job` command to use proper subcommands instead of hardcoded send behavior
+  - `prg job stop` - Stop a running progress indicator (replaces `prg job send`)
+  - `prg job status` - Check if a daemon is running and show its PID
+  - `prg job advance` - Advance a fill progress bar by a specified amount
+- Backward compatibility: `prg job send` still works but shows deprecation warning
+- Silent operation for job commands - no confirmation messages, only daemon output shown
+- Control message framework using JSON files and USR2 signal for daemon communication
+- Comprehensive test coverage improvements (from 10.63% to 31.38%)
+  - 119 new tests across 8 new spec files
+  - Unit tests for CLI options modules (twirl, ripple, fill, worm)
+  - Job CLI subcommand tests
+  - Custom icon propagation tests
 
 ### Changed
 
-- Job result files now merge any Hash returned by the job handler into the `.processing.result` JSON (e.g., `exit_status`, `output`, `log_path`).
-
-### Tests
-
-- Added unit and integration tests covering job enqueueing, processing, and result persistence.
-
-### Release notes
-
-- Merge commit: 99d9c39 (squash-merge of feature/output-handling)
-
-## Unreleased
-
-### Fixed
-
-- Output capture: ensure `--output-lines N` is honored when reserving terminal rows for captured output; coerce the `lines` option to an integer and stabilize the reserve/redraw logic so live captured output does not overwrite the prompt or animation.
-
-### Changed
-
-- Prepared for next patch release.
-
-## 1.3.3 - 2025-10-14
+- **Daemon mode improvements**: All CLI subcommands now consistently use `PrgCLI.backgroundize`
+- Removed `--no-detach` option from all CLIs (backgrounding is now always used)
+- Fixed `backgroundize` method to use `Process.detach()` preventing shell job notifications
+- Ripple completion messages now go to stderr (animation output stream) instead of stdout
+- Enhanced `Utils.display_completion` to show custom icons even without checkmark flag
+- Updated README with new job CLI subcommand documentation
+- Updated documentation (DAEMON_MODE.md, JOB_CLI_REFACTOR.md)
 
 ### Fixed
 
-- Output capture: ensure `--output-lines N` is honored when reserving terminal rows for captured output; coerce the `lines` option to an integer and stabilize the reserve/redraw logic so live captured output does not overwrite the prompt or animation.
-
-### Changed
+- Ripple CLI tests updated to check stderr for completion messages (not stdout)
+- Ripple CLI tests updated to require `--stdout` flag to see command output
+- Output capture compatibility for older Ruby versions (added `wait_readable` fallback)
+- Fixed daemon PID file cleanup and signal handling
+- Custom success/error icons now display correctly with `--success-icon` and `--error-icon` flags
 
-- Removed one-off init trace writes and cleaned debug logging. Bumped main gem `VERSION` to 1.3.3 during intermediate fixes.
+### Removed
 
-## 1.3.2 - 2025-10-13
-
-### Added
-
-- `fill` subcommand: added `-c, --command COMMAND` so the determinate progress bar can run and capture command output like the other subcommands. This includes `--output-lines` and `--output-position` support for reserving terminal rows during capture.
-
-### Changed
-
-- Added `--stop-id NAME` shorthand for targeting named daemons (implies `--stop` and normalizes the name to the canonical PID filename). This is a small convenience used by the demo and scripts.
-- Demo: updated `demo_screencast.rb` to call the local `bin/prg` when stopping the demo daemon to avoid conflicts with system-installed versions.
-
-# CHANGELOG
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+- `--no-detach` option from all progress indicator CLIs (ripple, worm, twirl, fill)
+- Confirmation output from job control commands for script-friendly silent operation
 
-## Unreleased
+## 1.3.4 - 2024-10-14
 
 ### Fixed
 

data/DAEMON_MODE.md

@@ -0,0 +1,127 @@
+# Daemon Mode Usage
+
+## Summary of Changes
+
+We've simplified daemon mode to ALWAYS use backgrounding (not detaching). This means:
+
+1. **The `--no-detach` option has been removed** (it's now the default behavior)
+2. **Daemon mode backgrounds in the same terminal** so you can see the progress indicator while running other commands
+3. **All CLI subcommands (twirl, ripple, worm, fill) now use `PrgCLI.backgroundize`** instead of conditionally using `daemonize`
+
+## How to Use Daemon Mode
+
+### Starting a background progress indicator
+
+```bash
+# Start a twirl spinner in the background
+./bin/prg twirl --daemon-as my_task
+
+# Start a ripple animation in the background
+./bin/prg ripple --daemon-as my_task
+
+# Start a worm animation in the background
+./bin/prg worm --daemon-as my_task
+
+# Start a fill progress bar in the background
+./bin/prg fill --daemon-as my_task --total 100
+```
+
+The indicator will appear in your terminal and remain visible while you
+continue working.
+
+### Stopping a background indicator
+
+```bash
+# Stop with default message
+./bin/prg job stop --daemon-name my_task
+
+# Stop with custom message
+./bin/prg job stop --daemon-name my_task --message "Task completed!"
+
+# Stop with success checkmark
+./bin/prg job stop --daemon-name my_task --message "Success!" --checkmark
+
+# Stop with error state
+./bin/prg job stop --daemon-name my_task --message "Failed" --error
+```
+
+### Checking daemon status
+
+```bash
+# Check if a daemon is running
+./bin/prg job status --daemon-name my_task
+
+# The PID file is stored at:
+/tmp/ruby-progress/my_task.pid
+
+# Or check the process manually:
+ps aux | grep "prg twirl"
+```
+
+### Advancing a fill progress bar
+
+```bash
+# Advance by 1 (default)
+./bin/prg job advance --daemon-name mybar
+
+# Advance by a specific amount
+./bin/prg job advance --daemon-name mybar --amount 10
+
+# Advance and update total
+./bin/prg job advance --daemon-name mybar --amount 5 --total 100
+```
+
+### Using in shell scripts
+
+Daemons are designed to work cleanly in shell scripts with no extraneous
+output:
+
+```bash
+#!/usr/bin/env bash
+
+# Start a background progress indicator
+prg twirl --daemon-as build --message "Building..."
+
+# Do your work
+make build
+
+# Stop the indicator
+prg job stop --daemon-name build --message "Build complete!" --checkmark
+```
+
+The daemon will background silently with no shell job notifications, making
+it perfect for scripts and automation.
+
+## Technical Details
+
+- **`PrgCLI.backgroundize`**: Forks the process; parent detaches child and
+  exits (returning control to shell), child creates new process group with
+  `Process.setsid` but keeps stdin/stdout/stderr so output remains visible
+  on the TTY. The use of `Process.detach` prevents shell job notifications.
+- **PID files**: Stored in `/tmp/ruby-progress/DAEMON_NAME.pid`
+- **Signal handling**: Daemons listen for INT, USR1, TERM, and HUP signals
+  to gracefully stop; USR2 for control messages (advance, etc.)
+- **Control messages**: `job` subcommands use signal + message file to pass
+  messages to the daemon
+- **Shell scripting**: No shell job completion messages are emitted, making
+  daemons suitable for use in scripts
+
+## Job Subcommands
+
+The `prg job` command provides control over running progress indicators:
+
+- **`stop`**: Gracefully stop a running indicator with optional message,
+  checkmark, or error state
+- **`advance`**: Increment a fill progress bar (sends data via control
+  message file)
+- **`status`**: Check if a daemon is running and show its PID
+
+### Backward Compatibility
+
+The old `prg job send` command still works but is deprecated. It now
+maps to `prg job stop` and displays a deprecation warning. Update your
+scripts to use `prg job stop` instead.
+
+## Fixed Bug
+
+The `backgroundize` method had a logic error where the child process would return immediately instead of continuing execution. This has been fixed - the child now properly executes the daemon code and writes the PID file.

data/Gemfile

@@ -8,7 +8,13 @@ gemspec
 group :development, :test do
   gem 'rake', '~> 13.0'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 1.21'
+  # RuboCop requires Ruby >= 2.7 for older versions, >= 3.0 for recent versions
+  # Pin to a version compatible with Ruby 2.7/3.0 for CI
+  if RUBY_VERSION >= '3.1'
+    gem 'rubocop', '~> 1.50'
+  else
+    gem 'rubocop', '~> 1.21.0'
+  end
   gem 'simplecov', '~> 0.21', require: false
   gem 'tty-cursor', '~> 0.7'
   gem 'tty-screen', '~> 0.8'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-progress (1.3.4)
+    ruby-progress (1.3.5)
       tty-cursor (~> 0.7)
       tty-screen (~> 0.8)
 
@@ -11,32 +11,32 @@ GEM
     ast (2.4.3)
     diff-lcs (1.6.2)
     docile (1.4.1)
-    json (2.12.2)
+    json (2.15.1)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     parallel (1.27.0)
-    parser (3.3.8.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
-    prism (1.5.1)
+    prism (1.5.2)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.0)
-    regexp_parser (2.10.0)
-    rspec (3.13.0)
+    regexp_parser (2.11.3)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.5)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.4)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.6)
-    rubocop (1.75.7)
+    rubocop (1.81.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -44,10 +44,10 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.44.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.1)
+    rubocop-ast (1.47.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     ruby-progressbar (1.13.0)
@@ -55,26 +55,27 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.1)
+    simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
     tty-cursor (0.7.1)
     tty-screen (0.8.2)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
 
 PLATFORMS
+  arm64-darwin-23
   arm64-darwin-24
-  ruby
+  arm64-darwin-25
 
 DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.21)
+  rubocop (~> 1.50)
   ruby-progress!
   simplecov (~> 0.21)
   tty-cursor (~> 0.7)
   tty-screen (~> 0.8)
 
 BUNDLED WITH
-   2.6.8
+   2.4.22

data/JOB_CLI_REFACTOR.md

@@ -0,0 +1,67 @@
+# Job CLI Refactoring Summary
+
+## Changes Made
+
+Restructured `prg job` to use proper subcommands instead of being hardcoded to only send stop signals.
+
+### Before
+```bash
+prg job send --daemon-name mytask --message "Done!"
+```
+
+### After
+```bash
+# Stop a daemon
+prg job stop --daemon-name mytask --message "Done!"
+
+# Check daemon status
+prg job status --daemon-name mytask
+
+# Advance a fill progress bar
+prg job advance --daemon-name mybar --amount 10
+```
+
+## New Subcommands
+
+1. **`prg job stop`** - Stop a running progress indicator
+   - Options: `--daemon-name`, `--pid-file`, `--message`, `--checkmark`, `--error`
+   - Replaces the old `prg job send` command
+
+2. **`prg job status`** - Check if a daemon is running
+   - Options: `--daemon-name`, `--pid-file`
+   - Shows PID and running status
+
+3. **`prg job advance`** - Advance a fill progress bar
+   - Options: `--daemon-name`, `--pid-file`, `--amount`, `--total`
+   - Sends control message to update progress
+   - Uses USR2 signal to notify daemon
+
+## Implementation Details
+
+- **Main entry point**: `JobCLI.run(argv)` - dispatches to subcommands
+- **Backward compatibility**: `prg job send` still works but shows deprecation warning
+- **Control messages**: Uses JSON files (`.pid.msg`) to pass data to daemons
+- **Signal handling**: USR2 for control messages, USR1/INT/TERM/HUP for stop
+- **Silent operation**: No confirmation messages for script-friendly usage -
+  only daemon output is shown
+
+## Files Modified
+
+- `lib/ruby-progress/cli/job_cli.rb` - Complete rewrite with subcommands
+- `bin/prg` - Updated to call `JobCLI.run` instead of `JobCLI.send`
+- `DAEMON_MODE.md` - Updated documentation with new command syntax
+
+## Testing
+
+All three subcommands tested and working:
+- ✅ `prg job stop` - Gracefully stops daemons
+- ✅ `prg job status` - Shows daemon status
+- ✅ `prg job send` - Backward compatibility with deprecation warning
+- ⏳ `prg job advance` - Ready for implementation (requires daemon-side handling)
+
+## Next Steps
+
+To fully implement `job advance`, the fill daemon needs to:
+1. Listen for USR2 signal
+2. Read control message file on USR2
+3. Parse JSON and update progress accordingly