ruby-progress 1.3.1 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f08082d9cebd17f7d3ece436ff76e4f4beb8f934d803719a6bdc3477fa8c97b
-  data.tar.gz: da85e2d2e2587c13f4c778094fb1dcd8e2aa832dd0cff34b947b90db0f4e6585
+  metadata.gz: b46930eb2d8991d939a50094820ddfd0821203a8ee1b393bbb3a1269d8c2032f
+  data.tar.gz: ae70d2f66ff64d6816b177a0e145d7c6ae8f6d1ee98f71cfb7198a9784493c36
 SHA512:
-  metadata.gz: f3a816024fd6cc2aba00edd334c8b82e3783d6be3916bc36238172add46c695febcd80689ba49179b0d48a2175f983dca6b381e482c143e72f2bb0d80804b247
-  data.tar.gz: 56fe19077105ebf00cdae2c939eb761d0b37ae4f4cb82b439207c0562ed46cd97abd9105e7b6c0789868fa6087f5d646736b3ad0a58d3df6d09e5028add6d4bf
+  metadata.gz: 3323def54c36c02851a2b8da4c7daca769038631ad18610f89f1e6c390449785946f61cd70a53eebc96d93b0e8da2713c228bb4078df36d8b9e3a69a6c4c4d96
+  data.tar.gz: 66fb49464bfe312d53110de3cceb38c8e3c64f12c7b6e1790bde8da547ee6fb726d15c77458db6409dd72efebb4982b3ac7bec97197457f3162fe4527ece7d12

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-10-09 14:47:16 UTC using RuboCop version 1.75.7.
+# on 2025-10-14 13:03:02 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
@@ -22,11 +22,11 @@ Layout/TrailingEmptyLines:
   Exclude:
     - 'test_worm_flags.rb'
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
 Lint/DuplicateBranch:
   Exclude:
-    - 'bin/prg'
+    - 'lib/ruby-progress/output_capture.rb'
     - 'lib/ruby-progress/utils.rb'
     - 'lib/ruby-progress/worm.rb'
 
@@ -36,6 +36,12 @@ Lint/EmptyBlock:
   Exclude:
     - 'spec/worm_integration_spec.rb'
 
+# Offense count: 1
+# Configuration parameters: MaximumRangeSize.
+Lint/MissingCopEnableDirective:
+  Exclude:
+    - 'lib/ruby-progress/fill_cli.rb'
+
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 Lint/ScriptPermission:
@@ -43,63 +49,54 @@ Lint/ScriptPermission:
     - 'demo_gem.rb'
     - 'demo_worm_infinite.rb'
 
-# Offense count: 1
-Lint/SelfAssignment:
-  Exclude:
-    - 'lib/ruby-progress/ripple.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AutoCorrect, AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
-# NotImplementedExceptions: NotImplementedError
-Lint/UnusedMethodArgument:
-  Exclude:
-    - 'lib/ruby-progress/worm.rb'
-
-# Offense count: 23
+# Offense count: 22
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AutoCorrect.
 Lint/UselessAssignment:
   Exclude:
     - 'demo_gem.rb'
-    - 'lib/ruby-progress/worm.rb'
     - 'spec/cli_integration_spec.rb'
 
-# Offense count: 20
+# Offense count: 50
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 114
+  Max: 121
 
-# Offense count: 17
+# Offense count: 52
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 109
+  Max: 111
 
-# Offense count: 2
+# Offense count: 5
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 254
+  Max: 200
 
-# Offense count: 12
+# Offense count: 33
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 19
+  Max: 26
 
-# Offense count: 31
+# Offense count: 70
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 131
+  Max: 140
 
-# Offense count: 3
+# Offense count: 10
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 206
+  Max: 287
 
-# Offense count: 10
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 32
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Max: 20
+  Max: 27
 
 # Offense count: 1
 # Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
@@ -110,7 +107,7 @@ Naming/FileName:
     - 'Rakefile.rb'
     - 'lib/ruby-progress.rb'
 
-# Offense count: 17
+# Offense count: 10
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
 # SupportedStyles: snake_case, normalcase, non_integer
 # AllowedIdentifiers: TLS1_1, TLS1_2, capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
@@ -127,15 +124,6 @@ Style/Documentation:
     - 'lib/ruby-progress.rb'
     - 'lib/ruby-progress/daemon.rb'
 
-# Offense count: 4
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: allowed_in_returns, forbidden
-Style/DoubleNegation:
-  Exclude:
-    - 'bin/prg'
-    - 'lib/ruby-progress/worm.rb'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AutoCorrect, EnforcedStyle, AllowComments.
@@ -167,14 +155,13 @@ Style/InfiniteLoop:
   Exclude:
     - 'lib/ruby-progress/ripple.rb'
 
-# Offense count: 2
+# Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
 # SupportedStyles: predicate, comparison
 Style/NumericPredicate:
   Exclude:
     - 'spec/**/*'
-    - 'bin/prg'
     - 'lib/ruby-progress/ripple.rb'
 
 # Offense count: 1
@@ -193,7 +180,7 @@ Style/StringLiterals:
   Exclude:
     - 'test_worm_flags.rb'
 
-# Offense count: 3
+# Offense count: 46
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https

data/CHANGELOG.md

@@ -27,153 +27,124 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Merge commit: 99d9c39 (squash-merge of feature/output-handling)
 
-## 1.3.1 - 2025-10-12
+## Unreleased
 
-### Added
+### Fixed
 
-- `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.
+- 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
 
-- Bumped `FILL_VERSION` (patch) to reflect the new CLI behavior.
-
+- Prepared for next patch release.
 
-## 1.2.3 - 2025-10-11
+## 1.3.3 - 2025-10-14
 
-### Added
+### Fixed
 
-- Dedicated `fill` shim: added `bin/fill` that delegates to `prg fill`.
+- 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
 
-- Version bumps: prg 1.2.2 → 1.2.3, fill 1.0.0 → 1.0.1
+- Removed one-off init trace writes and cleaned debug logging. Bumped main gem `VERSION` to 1.3.3 during intermediate fixes.
 
-## 1.2.2 - 2025-10-11
+## 1.3.2 - 2025-10-13
 
-### Improved
+### Added
 
-- Demo script enhancements: updated quick demo with better visual examples.
+- `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.
 
-### Technical
+### Changed
 
-- Version alignment: synchronized demo script version display with actual gem version.
+- 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.
 
-## 1.2.4 - 2025-10-12
+# CHANGELOG
 
-### Added
+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).
+
+## Unreleased
 
-- Small bug fixes and test stability improvements:
-    - Ensured SimpleCov finalization runs reliably across Ruby versions during tests.
-    - Minor CLI help text clarifications and version constant alignment.
+### 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
 
-- Bumped gem version and synchronized component version constants where applicable.
-    - Messages now display cleanly at the beginning of a new line
-    - Affects all three commands: ripple, worm, and twirl
-    - Resolves issue where completion messages appeared mid-line after animation ended
-    - Improved professional appearance of CLI output
+- Prepared for next patch release.
 
-Technical
+## 1.3.4 - 2025-10-14
 
-- **Enhanced display_completion method**: Added proper line clearing and cursor positioning
-    - Uses `re[2K` sequence followed by clean message display
-    - Updated test expectations to match new output format
-    - Maintains backward compatibility with existing functionality
+### Fixed
 
-## 1.2.0 - 2025-10-11
+- Ensure non-live (`--stdout`) capture does not stream output to the terminal during animation; captured output is now emitted at completion only.
+- Stabilized PTY-based output capture redraw/reserve logic and cursor save/restore fallback.
 
-### Added
+### Changed
+
+- Bumped main gem `VERSION` to 1.3.4.
+- Cleaned up one-off debug/init traces written during development.
 
-- **--ends flag for all commands**: New universal option to add start/end characters around animations
-    - Accepts even-length strings split in half for start and end characters
-    - Works across all three commands: ripple, worm, and twirl
-    - Examples: `--ends "[]"` → `[animation]`, `--ends "<<>>"` → `<<animation>>`
-    - Multi-byte character support for emojis: `--ends "🎯🎪"` → `🎯animation🎪`
-    - Graceful fallback for invalid input (odd-length strings)
-
-- **Comprehensive test coverage for new features**: Added extensive test suites
-    - Direction control tests: Forward-only vs bidirectional animation behavior
-    - Custom style tests: ASCII, Unicode, emoji, and mixed character pattern validation
-    - CLI integration tests: End-to-end testing for all new command-line options
-    - Ends functionality tests: Multi-byte character handling, error cases, help documentation
-    - Total: 58 new test examples covering all edge cases
-
-- **Worm direction control**: Fine-grained animation movement control
-    - `--direction forward` (or `-d f`): Animation moves only forward, resets at end
-    - `--direction bidirectional` (or `-d b`): Default back-and-forth movement
-    - Compatible with all worm styles including custom patterns
-
-- **Worm custom styles**: User-defined 3-character animation patterns
-    - Format: `--style custom=abc` where `abc` defines baseline, midline, peak characters
-    - ASCII support: `--style custom=_-=` → `___-=___`
-    - Unicode support: `--style custom=▫▪■` → geometric patterns
-    - Emoji support: `--style custom=🟦🟨🟥` → colorful animations
-    - Mixed characters: `--style custom=.🟡*` → combined ASCII and emoji
-    - Proper multi-byte character counting for accurate 3-character validation
-- **Ripple style flags**: `--spinner`, `--rainbow`, `--inverse`, and `--caps` flags deprecated in favor of unified `--style` system (backward
-compatibility maintained)
+## 1.3.3 - 2025-10-14
 
 ### Fixed
 
-- **OptionParser conflicts**: Resolved parsing issues with optional arguments that could consume following flags
-- **Daemon workflow**: Streamlined daemon start/stop workflow eliminating need for redundant flag combinations
+- 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.
 
-## 1.0.1 - 2025-01-01
+### Changed
 
-## 1.1.0 - 2025-10-09
+- Removed one-off init trace writes and cleaned debug logging.
+
+## 1.3.2 - 2025-10-13
 
 ### Added
 
-- Shared daemon helpers module `RubyProgress::Daemon` for default PID file, control message file, status, and stop logic
-- Unified daemon flags across ripple and worm: `--daemon`, `--status`, `--stop`, `--pid-file`, `--stop-success`, `--stop-error`,
-`--stop-checkmark`
-- Ripple: daemon parity with worm, including clean shutdown on SIGUSR1/TERM/HUP/INT
+- `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
 
-- `bin/prg` now delegates status/stop/default PID handling to `RubyProgress::Daemon`
-- README updated with new daemon usage examples and flag descriptions
+- 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.
+
+## 1.2.4 - 2025-10-12
+
+### Added
 
-Deprecated
+- Small bug fixes and test stability improvements; ensured SimpleCov finalization runs reliably across Ruby versions during tests and minor CLI help clarifications.
 
-- `--stop-pid` remains available but is deprecated in favor of `--stop [--pid-file FILE]`
+## 1.2.3 - 2025-10-11
 
 ### Added
 
-- Packaged as proper Ruby gem with library structure
-- Added RSpec test suite with comprehensive coverage
-- Added Rake tasks for version management and packaging
-- Added --checkmark and --stdout flags to Worm (ported from Ripple)
-- Added infinite mode to Worm (runs indefinitely without command like Ripple)
-- **Added unified `prg` binary with subcommands for both `ripple` and `worm`**
-- **Enhanced command-line interface with consistent flag support across both tools**
-- **Added `RubyProgress::Utils` module with universal terminal control utilities**
-- **Centralized cursor control, line clearing, and completion message functionality**
-- **Added daemon mode for background progress indicators in bash scripts**
-- **Implemented signal-based control (SIGUSR1) for clean daemon shutdown**
+- Dedicated `fill` shim: added `bin/fill` that delegates to `prg fill`.
 
-### Changed
+## 1.2.2 - 2025-10-11
+
+### Improved
 
-- Moved classes into RubyProgress module
-- Separated logic into lib/ruby-progress/ structure
-- Created proper bin/ executables for ripple and worm
-- Updated README with gem installation and usage instructions
+- Demo script enhancements: updated quick demo with better visual examples.
 
-### Fixed
+## 1.2.0 - 2025-10-11
+
+### Added
+
+- `--ends` flag for all commands and lots of smaller UX and testing improvements.
 
-- Fixed duplicate error messages in Worm error handling
-- Improved signal handling and cursor management
+## 1.1.0 - 2025-10-09
+
+### Added
+
+- Shared daemon helpers module `RubyProgress::Daemon` and unified daemon flags across ripple and worm.
 
 ## 1.0.0 - 2025-10-09
 
 ### Added
 
-- Initial release with two progress indicators:
-    - Ripple: Text ripple animation with 30+ spinner styles, rainbow effects, and command execution
-    - Worm: Unicode wave animation with multiple styles and configurable options
-- Command-line interfaces for both tools
-- Support for custom speeds, messages, and styling options
-- Integration with system commands and process monitoring
+- Initial release with two progress indicators (Ripple and Worm) and basic CLI tooling.
+
+
+## 1.0.1 - 2025-01-01
 
 

data/Gemfile

@@ -10,4 +10,6 @@ group :development, :test do
   gem 'rspec', '~> 3.0'
   gem 'rubocop', '~> 1.21'
   gem 'simplecov', '~> 0.21', require: false
+  gem 'tty-cursor', '~> 0.7'
+  gem 'tty-screen', '~> 0.8'
 end

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    ruby-progress (1.3.1)
+    ruby-progress (1.3.4)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
 
 GEM
   remote: https://rubygems.org/
@@ -55,6 +57,8 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.1)
     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)
@@ -69,6 +73,8 @@ DEPENDENCIES
   rubocop (~> 1.21)
   ruby-progress!
   simplecov (~> 0.21)
+  tty-cursor (~> 0.7)
+  tty-screen (~> 0.8)
 
 BUNDLED WITH
    2.6.8

data/README.md

@@ -98,6 +98,39 @@ echo "bundle exec rake db:migrate" | prg job send --stdin --daemon-name mytask
 prg job send --daemon-name mytask --command "./deploy-step.sh" --wait --timeout 30
 ```
 
+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:
+
+```bash
+# Send a simple 'advance' action (no value)
+prg job send --daemon-name demo --advance
+
+# Send a 'percent' action with a numeric value
+prg job send --daemon-name demo --percent 42
+
+# 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
+
+# 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
+```
+
+# Or use the generic action/value pair
+prg job send --daemon-name demo --action percent --value 42
+```
+
+Note about stopping named daemons:
+
+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:
+
+```bash
+# Stop a named fill worker with a success message
+prg fill --stop-id demo --stop-success 'Demo finished'
+```
+
 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`.
@@ -139,6 +172,21 @@ This file is intended for short messages and small captured output snippets (the
 Below is an example script that demonstrates starting a worm daemon, sending a job, waiting for the result, and stopping the daemon.
 ---
 
+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:
+
+```bash
+# Start a named worm worker that backgrounds but does not fully detach
+prg worm --daemon-as demo --no-detach
+
+# 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
+
+# Stop the worker with a success message
+prg worm --stop-id demo --stop-success "Demo finished"
+```
+
+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.
+
 ## Ripple
 
 Ripple is a sophisticated text animation library that creates ripple effects across text strings in the terminal. It supports various animation modes including bidirectional movement, and rainbow colors.

data/Rakefile

@@ -108,7 +108,6 @@ namespace :markdown do
     !!(line =~ /^\s*```|^\s*~~~/)
   end
 
-  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
   def format_markdown(content)
     lines = content.split("\n", -1)
     out = []
@@ -167,8 +166,6 @@ namespace :markdown do
     out << '' if (last = out.last) && !last.empty?
     out.join("\n")
   end
-  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-
   desc 'Lint markdown (reports files that would be changed)'
   task :lint do
     changed = []

data/bin/prg

@@ -148,6 +148,21 @@ module PrgCLI
     end
   end
 
+  # 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`).
+  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
+  end
+
   # Attempt to stop processes for the given subcommand. Return true if any
   # process was signaled/stopped; false otherwise. Keep quiet on missing
   # processes to satisfy integration tests.