ruby-progress 1.2.4 → 1.3.2

data/lib/ruby-progress/utils.rb

@@ -13,12 +13,17 @@ module RubyProgress
     end
 
     def self.clear_line(output_stream = :stderr)
-      case output_stream
-      when :stdout
-        $stdout.print "\r\e[K"
-      else
-        $stderr.print "\r\e[K"
-      end
+      io = case output_stream
+           when :stdout
+             $stdout
+           when :stderr
+             $stderr
+           else
+             # allow passing an IO-like object (e.g. StringIO) directly
+             output_stream.respond_to?(:print) ? output_stream : $stderr
+           end
+
+      io.print "\r\e[K"
     end
 
     # Enhanced line clearing for daemon mode that handles output interruption
@@ -33,39 +38,55 @@ module RubyProgress
     # @param success [Boolean] Whether this represents success or failure
     # @param show_checkmark [Boolean] Whether to show checkmark/X symbols
     # @param output_stream [Symbol] Where to output (:stdout, :stderr, :warn)
-    def self.display_completion(message, success: true, show_checkmark: false, output_stream: :warn)
+    def self.display_completion(message, success: true, show_checkmark: false, output_stream: :warn, icons: {})
       return unless message
 
-      mark = ''
-      if show_checkmark
-        mark = success ? '✅ ' : '🛑 '
-      end
+      mark = if show_checkmark
+               icon = success ? (icons[:success] || '✅') : (icons[:error] || '🛑')
+               "#{icon} "
+             else
+               ''
+             end
 
       formatted_message = "#{mark}#{message}"
 
-      case output_stream
-      when :stdout
-        puts formatted_message
-      when :stderr
-        warn formatted_message
-      when :warn
-        # Ensure we're at the beginning of a fresh line, clear it, then display message
-        $stderr.print "\r\e[2K"
-        $stderr.flush
+      # Resolve destination IO: support symbols (:stdout/:stderr/:warn) or an IO-like object
+      dest_io = case output_stream
+                when :stdout
+                  $stdout
+                when :stderr
+                  $stderr
+                when :warn
+                  $stderr
+                else
+                  output_stream.respond_to?(:print) ? output_stream : $stderr
+                end
+
+      # Only treat explicit :stdout and :stderr as non-clearing requests.
+      # For :warn and any other/custom stream, clear the current line first.
+      unless %i[stdout stderr].include?(output_stream)
+        # Always include a leading carriage return when clearing to match
+        # terminal behavior expected by the test-suite.
+        dest_io.print "\r\e[2K"
+        dest_io.flush if dest_io.respond_to?(:flush)
+      end
+
+      # Emit the message to the resolved destination IO. Use warn/puts when targeting
+      # the standard streams to preserve familiar behavior (warn writes to $stderr).
+      if dest_io == $stdout
+        $stdout.puts formatted_message
+      elsif dest_io == $stderr
         warn formatted_message
       else
-        # Ensure we're at the beginning of a fresh line, clear it, then display message
-        $stderr.print "\r\e[2K"
-        $stderr.flush
-        warn formatted_message
+        dest_io.puts formatted_message
       end
     end
 
     # Clear current line and display completion message
     # Convenience method that combines line clearing with message display
-    def self.complete_with_clear(message, success: true, show_checkmark: false, output_stream: :warn)
+    def self.complete_with_clear(message, success: true, show_checkmark: false, output_stream: :warn, icons: {})
       clear_line(output_stream) if output_stream != :warn # warn already includes clear in display_completion
-      display_completion(message, success: success, show_checkmark: show_checkmark, output_stream: output_stream)
+      display_completion(message, success: success, show_checkmark: show_checkmark, output_stream: output_stream, icons: icons)
     end
 
     # Parse start/end characters for animation wrapping

data/lib/ruby-progress/version.rb

@@ -2,11 +2,11 @@
 
 module RubyProgress
   # Main gem version
-  VERSION = '1.2.4'
+  VERSION = '1.3.2'
 
-  # Component-specific versions
-  WORM_VERSION = '1.1.2'
-  TWIRL_VERSION = '1.1.2'
-  RIPPLE_VERSION = '1.1.2'
-  FILL_VERSION = '1.0.1'
+  # Component-specific versions (patch bumps)
+  WORM_VERSION = '1.1.4'
+  TWIRL_VERSION = '1.1.4'
+  RIPPLE_VERSION = '1.1.4'
+  FILL_VERSION = '1.0.4'
 end

data/lib/ruby-progress/worm.rb

@@ -76,13 +76,14 @@ module RubyProgress
     def display_completion_message(message, success)
       return unless message
 
-      mark = ''
-      if @show_checkmark
-        mark = success ? '✅ ' : '🛑 '
-      end
-
-      # Clear animation line and output completion message on stderr
-      $stderr.print "\r\e[2K#{mark}#{message}\n"
+      # Delegate to Utils.display_completion so carriage-return and clearing
+      # behavior is consistent across all indicators and respects TTY state.
+      RubyProgress::Utils.display_completion(
+        message,
+        success: success,
+        show_checkmark: @show_checkmark,
+        output_stream: :warn
+      )
     end
 
     def parse_speed(speed_input)

data/screencast

@@ -0,0 +1,26 @@
+{"version":2,"width":146,"height":24,"timestamp":1760358387,"duration":4.124379,"env":{"SHELL":"/opt/homebrew/bin/fish","TERM":"xterm-256color"}}
+[0.002162,"o","$ bin/prg worm --command \"sleep 4\"\r\n"]
+[0.052412,"o","\u001b[?25l"]
+[0.054304,"o","\r\u001b[2K⬤··"]
+[0.260053,"o","\r\u001b[2K●⬤·"]
+[0.462807,"o","\r\u001b[2K··⬤"]
+[0.667558,"o","\r\u001b[2K·⬤●"]
+[0.86773,"o","\r\u001b[2K⬤··"]
+[1.06914,"o","\r\u001b[2K●⬤·"]
+[1.273207,"o","\r\u001b[2K··⬤"]
+[1.477782,"o","\r\u001b[2K·⬤●"]
+[1.682846,"o","\r\u001b[2K⬤··"]
+[1.885136,"o","\r\u001b[2K●⬤·"]
+[2.087746,"o","\r\u001b[2K··⬤"]
+[2.290181,"o","\r\u001b[2K·⬤●"]
+[2.494656,"o","\r\u001b[2K⬤··"]
+[2.69979,"o","\r\u001b[2K●⬤·"]
+[2.900129,"o","\r\u001b[2K··⬤"]
+[3.102774,"o","\r\u001b[2K·⬤●"]
+[3.303982,"o","\r\u001b[2K⬤··"]
+[3.507771,"o","\r\u001b[2K●⬤·"]
+[3.711678,"o","\r\u001b[2K··⬤"]
+[3.915598,"o","\r\u001b[2K·⬤●"]
+[4.120702,"o","\r\u001b[2K"]
+[4.121323,"o","\u001b[?25h"]
+[4.124379,"o",""]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-progress
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.2
 platform: ruby
 authors:
 - Brett Terpstra
@@ -101,10 +101,12 @@ files:
 - demo_worm_infinite.rb
 - examples/bash_daemon_demo.sh
 - examples/daemon_demo.rb
+- examples/daemon_job_example.sh
 - examples/utils_demo.rb
 - experimental_terminal.rb
 - lib/ruby-progress.rb
 - lib/ruby-progress/cli/fill_options.rb
+- lib/ruby-progress/cli/job_cli.rb
 - lib/ruby-progress/cli/ripple_cli.rb
 - lib/ruby-progress/cli/ripple_options.rb
 - lib/ruby-progress/cli/twirl_cli.rb
@@ -117,13 +119,14 @@ files:
 - lib/ruby-progress/daemon.rb
 - lib/ruby-progress/fill.rb
 - lib/ruby-progress/fill_cli.rb
+- lib/ruby-progress/output_capture.rb
 - lib/ruby-progress/ripple.rb
 - lib/ruby-progress/utils.rb
 - lib/ruby-progress/version.rb
 - lib/ruby-progress/worm.rb
 - quick_demo.rb
 - readme_demo.rb
-- ruby-progress.gemspec
+- screencast
 - scripts/run_matrix_mise.fish
 - test_daemon_interruption.rb
 - test_daemon_orphan.rb

data/ruby-progress.gemspec

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/ruby-progress/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'ruby-progress'
-  spec.version = RubyProgress::VERSION
-  spec.authors = ['Brett Terpstra']
-  spec.email = ['me@brettterpstra.com']
-
-  spec.summary = 'Animated terminal progress indicators'
-  spec.description = 'Animated progress indicators for Ruby: Ripple (text ripple effects), Worm (Unicode wave animations), and Twirl (spinner indicators)'
-  spec.homepage = 'https://github.com/ttscoff/ruby-progress'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.5.0'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = 'bin'
-  spec.executables = %w[prg ripple worm twirl fill]
-  spec.require_paths = ['lib']
-
-  # Runtime dependencies
-  # None required - uses only standard library
-
-  # Development dependencies
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.21'
-  spec.add_development_dependency 'simplecov', '~> 0.21'
-  spec.metadata['rubygems_mfa_required'] = 'true'
-end