ruby-progress 1.3.1 → 1.3.4

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

@@ -33,8 +33,13 @@ module RippleCLI
       )
       exit
     elsif options[:daemon]
-      # For daemon mode, detach so shell has no tracked job
-      PrgCLI.daemonize
+      # For daemon mode, detach so shell has no tracked job unless the user
+      # requested a non-detaching background child via --no-detach.
+      if options[:no_detach]
+        PrgCLI.backgroundize
+      else
+        PrgCLI.daemonize
+      end
 
       # For daemon mode, default message if none provided
       text = options[:message] || ARGV.join(' ')
@@ -63,13 +68,22 @@ module RippleCLI
   end
 
   def self.run_with_command(text, options)
-    if $stdout.tty? && options[:output] == :stdout
-      oc = RubyProgress::OutputCapture.new(command: options[:command], lines: options[:output_lines] || 3, position: options[:output_position] || :above)
+    if $stdout.tty?
+      # Interactive TTY: use PTY-based capture so the animation can run while the
+      # command executes. We only print captured stdout if options[:output] == :stdout.
+      oc = RubyProgress::OutputCapture.new(
+        command: options[:command],
+        lines: options[:output_lines] || 3,
+        position: options[:output_position] || :above,
+        stream: options[:output] == :stdout || options[:stdout_live]
+      )
       oc.start
 
-      # Create rippler and attach output capture so redraw occurs each frame
+      # Create rippler. Attach output capture only when the user requested
+      # live stdout display via --stdout; otherwise start the PTY reader so
+      # we can collect the child's exit status but do not call redraw.
       rippler = RubyProgress::Ripple.new(text, options)
-      rippler.instance_variable_set(:@output_capture, oc)
+      rippler.instance_variable_set(:@output_capture, oc) if options[:output] == :stdout
 
       thread = Thread.new { loop { rippler.advance } }
       oc.wait
@@ -77,17 +91,24 @@ module RippleCLI
 
       captured_lines = oc.lines
       captured_output = captured_lines.join("\n")
-      success = true
+      success = oc.exit_status.nil? || oc.exit_status.zero?
     else
-      # Fallback to legacy capture (non-interactive / CI)
+      # Non-interactive / CI: fallback to legacy synchronous capture
       captured_output = `#{options[:command]} 2>&1`
       success = $CHILD_STATUS.success?
     end
 
     puts captured_output if options[:output] == :stdout
+
     if options[:success_message] || options[:complete_checkmark]
       message = success ? options[:success_message] : options[:fail_message] || options[:success_message]
-      RubyProgress::Ripple.complete(text, message, options[:complete_checkmark], success)
+      RubyProgress::Ripple.complete(
+        text,
+        message,
+        options[:complete_checkmark],
+        success,
+        icons: { success: options[:success_icon], error: options[:error_icon] }
+      )
     end
     exit success ? 0 : 1
   end
@@ -147,7 +168,8 @@ module RippleCLI
               message,
               success: success_val,
               show_checkmark: check,
-              output_stream: :stdout
+              output_stream: :stdout,
+              icons: { success: options[:success_icon], error: options[:error_icon] }
             )
           end
         rescue StandardError
@@ -196,7 +218,8 @@ module RippleCLI
           job['message'],
           success: success,
           show_checkmark: job['checkmark'] || false,
-          output_stream: :stdout
+          output_stream: :stdout,
+          icons: { success: options[:success_icon], error: options[:error_icon] }
         )
       end
 

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

@@ -71,6 +71,14 @@ module RippleCLI
             options[:success_message] = msg
           end
 
+          opts.on('--success-icon ICON', 'Custom success icon to show with completion messages') do |ic|
+            options[:success_icon] = ic
+          end
+
+          opts.on('--error-icon ICON', 'Custom error icon to show with failure messages') do |ic|
+            options[:error_icon] = ic
+          end
+
           opts.on('--error MESSAGE', 'Error message to display') do |msg|
             options[:fail_message] = msg
           end
@@ -83,6 +91,10 @@ module RippleCLI
             options[:output] = :stdout
           end
 
+          opts.on('--stdout-live', 'Stream captured output to STDOUT as it arrives (non-blocking)') do
+            options[:stdout_live] = true
+          end
+
           opts.on('--quiet', 'Suppress all output') do
             options[:output] = :quiet
           end
@@ -94,6 +106,10 @@ module RippleCLI
             options[:daemon] = true
           end
 
+          opts.on('--no-detach', 'When used with --daemon: run background child but do not fully detach from the terminal') do
+            options[:no_detach] = true
+          end
+
           opts.on('--pid-file FILE', 'Write process ID to file (default: /tmp/ruby-progress/progress.pid)') do |file|
             options[:pid_file] = file
           end

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

@@ -32,6 +32,12 @@ module TwirlCLI
           options[:style] = style
         end
 
+        opts.on('-d', '--direction DIRECTION', 'Animation direction (forward/bidirectional or f/b)') do |direction|
+          # Twirl is a spinner and doesn't visibly change with direction, but accept the
+          # flag for parity with other subcommands (Worm/Ripple) so scripts can use it.
+          options[:direction] = direction =~ /^f/i ? :forward_only : :bidirectional
+        end
+
         opts.on('--ends CHARS', 'Start/end characters (even number of chars, split in half)') do |chars|
           options[:ends] = chars
         end
@@ -55,6 +61,14 @@ module TwirlCLI
           options[:success] = text
         end
 
+        opts.on('--success-icon ICON', 'Custom success icon to show with completion messages') do |ic|
+          options[:success_icon] = ic
+        end
+
+        opts.on('--error-icon ICON', 'Custom error icon to show with failure messages') do |ic|
+          options[:error_icon] = ic
+        end
+
         opts.on('--error MESSAGE', 'Error message to display') do |text|
           options[:error] = text
         end
@@ -67,6 +81,10 @@ module TwirlCLI
           options[:stdout] = true
         end
 
+        opts.on('--stdout-live', 'Stream captured output to STDOUT as it arrives (non-blocking)') do
+          options[:stdout_live] = true
+        end
+
         opts.separator ''
         opts.separator 'Daemon Mode:'
 
@@ -74,6 +92,10 @@ module TwirlCLI
           options[:daemon] = true
         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('--daemon-as NAME', 'Run in daemon mode with custom name (creates /tmp/ruby-progress/NAME.pid)') do |name|
           options[:daemon] = true
           options[:daemon_name] = name

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

@@ -23,11 +23,12 @@ module TwirlRunner
       RubyProgress::Utils.hide_cursor
       spinner_thread = Thread.new { loop { spinner.animate } }
 
-      if $stdout.tty? && options[:stdout]
+      if $stdout.tty? && (options[:stdout] || options[:stdout_live])
         oc = RubyProgress::OutputCapture.new(
           command: options[:command],
           lines: options[:output_lines] || 3,
-          position: options[:output_position] || :above
+          position: options[:output_position] || :above,
+          stream: options[:stdout] || options[:stdout_live]
         )
         oc.start
 
@@ -58,7 +59,8 @@ module TwirlRunner
       RubyProgress::Utils.display_completion(
         final_msg,
         success: success,
-        show_checkmark: options[:checkmark]
+        show_checkmark: options[:checkmark],
+        icons: { success: options[:success_icon], error: options[:error_icon] }
       )
     end
 
@@ -78,7 +80,8 @@ module TwirlRunner
         RubyProgress::Utils.display_completion(
           options[:success] || 'Complete',
           success: true,
-          show_checkmark: options[:checkmark]
+          show_checkmark: options[:checkmark],
+          icons: { success: options[:success_icon], error: options[:error_icon] }
         )
       end
     end
@@ -108,7 +111,8 @@ module TwirlRunner
           oc = RubyProgress::OutputCapture.new(
             command: job['command'],
             lines: options[:output_lines] || 3,
-            position: options[:output_position] || :above
+            position: options[:output_position] || :above,
+            stream: options[:stdout] || options[:stdout_live]
           )
           oc.start
 
@@ -124,7 +128,8 @@ module TwirlRunner
               job['message'],
               success: success,
               show_checkmark: job['checkmark'] || false,
-              output_stream: :stdout
+              output_stream: :stdout,
+              icons: { success: options[:success_icon], error: options[:error_icon] }
             )
           end
 
@@ -152,7 +157,8 @@ module TwirlRunner
               message,
               success: success_val,
               show_checkmark: check,
-              output_stream: :stdout
+              output_stream: :stdout,
+              icons: { success: options[:success_icon], error: options[:error_icon] }
             )
           end
         rescue StandardError

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

@@ -10,9 +10,23 @@ require_relative '../utils'
 class TwirlSpinner
   def initialize(message, options = {})
     @message = message
-    @style = parse_style(options[:style] || 'dots')
     @speed = parse_speed(options[:speed] || 'medium')
-    @frames = RubyProgress::INDICATORS[@style] || RubyProgress::INDICATORS[:dots]
+
+    style_opt = options[:style].to_s
+    if style_opt.start_with?('custom=')
+      chars = style_opt.sub('custom=', '')
+      @frames = if chars.length >= 3
+                  chars.chars
+                elsif chars.length == 2
+                  [chars[0], chars[1], chars[1]]
+                else
+                  [chars, chars, chars]
+                end
+      @style = :custom
+    else
+      @style = parse_style(style_opt.empty? ? 'dots' : style_opt)
+      @frames = RubyProgress::INDICATORS[@style] || RubyProgress::INDICATORS[:dots]
+    end
     @start_chars, @end_chars = RubyProgress::Utils.parse_ends(options[:ends])
     @index = 0
   end
@@ -36,6 +50,8 @@ class TwirlSpinner
 
     style_lower = style_input.to_s.downcase.strip
 
+    # parse_style returns a symbol key for RubyProgress::INDICATORS
+
     indicator_keys = RubyProgress::INDICATORS.keys.map(&:to_s)
     return style_lower.to_sym if indicator_keys.include?(style_lower)
 

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

@@ -33,8 +33,14 @@ module WormCLI
       )
       exit
     elsif options[:daemon]
-      # Detach before starting daemon logic so there's no tracked shell job
-      PrgCLI.daemonize
+      # Detach (or background without detaching) before starting daemon logic
+      # so the invoking shell/script continues immediately.
+      if options[:no_detach]
+        PrgCLI.backgroundize
+      else
+        PrgCLI.daemonize
+      end
+
       run_daemon_mode(options)
     else
       progress = RubyProgress::Worm.new(options)
@@ -70,7 +76,8 @@ module WormCLI
             command: job['command'],
             lines: options[:output_lines] || 3,
             position: options[:output_position] || :above,
-            log_path: log_path
+            log_path: log_path,
+            stream: options[:stdout] || options[:stdout_live]
           )
           oc.start
 
@@ -86,7 +93,8 @@ module WormCLI
               job['message'],
               success: success,
               show_checkmark: job['checkmark'] || false,
-              output_stream: :stdout
+              output_stream: :stdout,
+              icons: { success: options[:success_icon], error: options[:error_icon] }
             )
           end
 
@@ -99,7 +107,8 @@ module WormCLI
       progress.run_daemon_mode(
         success_message: options[:success],
         show_checkmark: options[:checkmark],
-        control_message_file: RubyProgress::Daemon.control_message_file(pid_file)
+        control_message_file: RubyProgress::Daemon.control_message_file(pid_file),
+        icons: { success: options[:success_icon], error: options[:error_icon] }
       )
     ensure
       job_thread&.kill

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

@@ -63,6 +63,14 @@ module WormCLI
             options[:success] = text
           end
 
+          opts.on('--success-icon ICON', 'Custom success icon to show with completion messages') do |ic|
+            options[:success_icon] = ic
+          end
+
+          opts.on('--error-icon ICON', 'Custom error icon to show with failure messages') do |ic|
+            options[:error_icon] = ic
+          end
+
           opts.on('--error MESSAGE', 'Error message to display') do |text|
             options[:error] = text
           end
@@ -75,6 +83,10 @@ module WormCLI
             options[:stdout] = true
           end
 
+          opts.on('--stdout-live', 'Stream captured output to STDOUT as it arrives (non-blocking)') do
+            options[:stdout_live] = true
+          end
+
           opts.separator ''
           opts.separator 'Daemon Mode:'
 
@@ -93,6 +105,10 @@ module WormCLI
             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', 'Write process ID to file (default: /tmp/ruby-progress/progress.pid)') do |file|
             options[:pid_file] = file
           end

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

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ModuleLength
 require 'open3'
 require 'json'
 require_relative '../utils'
@@ -58,11 +57,12 @@ module WormRunner
     stdout_content = nil
 
     begin
-      stdout_content = if $stdout.tty? && @output_stdout
+      stdout_content = if $stdout.tty? && (@output_stdout || @output_live)
                          oc = RubyProgress::OutputCapture.new(
                            command: @command,
                            lines: @output_lines || 3,
-                           position: @output_position || :above
+                           position: @output_position || :above,
+                           stream: @output_live || false
                          )
                          oc.start
                          @output_capture = oc
@@ -120,7 +120,7 @@ module WormRunner
     @running = false
   end
 
-  def run_daemon_mode(success_message: nil, show_checkmark: false, control_message_file: nil)
+  def run_daemon_mode(success_message: nil, show_checkmark: false, control_message_file: nil, icons: {})
     @running = true
     stop_requested = false
 
@@ -163,7 +163,8 @@ module WormRunner
           final_message,
           success: final_success,
           show_checkmark: final_checkmark,
-          output_stream: :stdout
+          output_stream: :stdout,
+          icons: icons
         )
       end
 
@@ -233,8 +234,12 @@ module WormRunner
       $stderr.print "\r\e[2K"
 
       if (frame_count % 10).zero?
-        $stderr.print "\e[1A\e[2K"
-        $stderr.print "\r"
+        # Use ANSI save/restore to clear the previous line without moving the
+        # global cursor position. This prevents the animation from erasing
+        # reserved output lines that we draw elsewhere.
+        $stderr.print "\e7"    # save
+        $stderr.print "\e[1A\e[2K\r"
+        $stderr.print "\e8"    # restore
       end
 
       $stderr.print "#{message_part}#{generate_dots(position, direction)}"
@@ -278,5 +283,3 @@ module WormRunner
     dots.join
   end
 end
-
-# rubocop:enable Metrics/ModuleLength

data/lib/ruby-progress/fill.rb

@@ -95,7 +95,7 @@ module RubyProgress
     end
 
     # Complete the progress bar and show success message
-    def complete(message = nil)
+    def complete(message = nil, icons: {})
       @current_progress = @length
       render
 
@@ -105,7 +105,8 @@ module RubyProgress
           completion_message,
           success: true,
           show_checkmark: true,
-          output_stream: :warn
+          output_stream: :warn,
+          icons: icons
         )
       else
         $stderr.puts # Just add a newline if no message
@@ -124,7 +125,8 @@ module RubyProgress
         error_msg,
         success: false,
         show_checkmark: true,
-        output_stream: :warn
+        output_stream: :warn,
+        icons: {}
       )
     end