ruby-progress 1.2.0 → 1.3.1

data/quick_demo.rb

@@ -0,0 +1,134 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Short demo script for interactive/manual testing of ruby-progress features.
+# Focuses on a compact set of examples used during development and quick checks.
+##
+#
+# A shorter, more focused demo script for quick testing and demonstrations.
+# This version focuses on the most impressive features without long pauses.
+# QuickDemo: small, focused demo runner used for development and CI smoke tests.
+class QuickDemo
+  def initialize
+    @gem_path = File.expand_path('bin/prg', __dir__)
+    @lib_path = File.expand_path('lib', __dir__)
+  end
+
+  def run
+    puts "\n🚀 Ruby Progress Gem v1.2.2 - Quick Demo\n"
+    puts "=========================================\n\n"
+
+    # Showcase the most impressive features
+    showcase_ends_feature
+    showcase_custom_styles
+    showcase_direction_control
+    showcase_error_handling
+
+    puts "\n✨ Demo complete! Install with: gem install ruby-progress"
+    puts "📚 GitHub: https://github.com/ttscoff/ruby-progress\n\n"
+  end
+
+  private
+
+  def showcase_ends_feature
+    puts '🎯 Universal --ends Flag (NEW in v1.2.0)'
+    puts '-' * 40
+
+    puts 'Ripple with brackets:'
+    run_cmd("ripple 'Loading...' --ends '[]' --command 'sleep 3' --success 'Bracketed!' --checkmark")
+
+    puts "\nWorm with angles:"
+    run_cmd("worm --length 10 --ends '<<>>' --command 'sleep 3' --success 'Angled!' --checkmark")
+
+    puts "\nTwirl with emojis:"
+    run_cmd("twirl --ends '♥️👍' --command 'sleep 2' --success 'Decorated!'")
+
+    puts "\n"
+  end
+
+  def showcase_custom_styles
+    puts '🎨 Custom Worm Styles (NEW in v1.2.0)'
+    puts '-' * 40
+
+    puts 'ASCII custom pattern:'
+    run_cmd("worm --length 10 --style custom=_-= --command 'sleep 3' --success 'Custom ASCII!'")
+
+    puts "\nEmoji custom pattern:"
+    run_cmd("worm --length 10 --style custom=🟦🟨🟥 --command 'sleep 3' --success 'Custom emoji!'")
+
+    puts "\n"
+  end
+
+  def showcase_direction_control
+    puts '🏃 Direction Control (NEW in v1.2.0)'
+    puts '-' * 40
+
+    puts 'Forward-only worm:'
+    run_cmd("worm --length 10 --direction forward --command 'sleep 4' --success 'Always forward!'")
+
+    puts "\nCombined features:"
+    run_cmd("worm --length 10 --style custom=.*🟡 --direction forward --ends '【】' --command 'sleep 4' --success 'Ultimate combo!'")
+
+    puts "\n"
+  end
+
+  def showcase_error_handling
+    puts '❌ Error Handling'
+    puts '-' * 40
+
+    puts 'Graceful failure:'
+    run_cmd("ripple 'Processing...' --command 'sleep 2 && exit 1' --error 'Task failed!' --checkmark")
+
+    puts "\n"
+  end
+
+  def print_command(args)
+    # ANSI color codes
+    cyan = "\e[36m"
+    bright_red = "\e[91m"
+    bright_white = "\e[97m"
+    bright_green = "\e[92m"
+    reset = "\e[0m"
+
+    # Start with the base command
+    colored_cmd = "$ #{cyan}prg#{reset}"
+
+    # Use regex to colorize the command
+    # First capture the subcommand (ripple, worm, twirl)
+    colored_args = args.gsub(/^(ripple|worm|twirl)/, "#{bright_red}\\1#{reset}")
+
+    # Colorize flags (--flag-name) in bright white and their values in bright green
+    colored_args = colored_args.gsub(/(--[\w-]+)(\s+|=)('[^']*'|"[^"]*"|\S+)/) do |_match|
+      flag = ::Regexp.last_match(1)
+      separator = ::Regexp.last_match(2)
+      value = ::Regexp.last_match(3)
+      "#{bright_white}#{flag}#{reset}#{separator}#{bright_green}#{value}#{reset}"
+    end
+
+    # Colorize short flags (-f) in bright white and their values in bright green
+    colored_args = colored_args.gsub(/(-[a-zA-Z])(\s+)('[^']*'|"[^"]*"|\S+)/) do |_match|
+      flag = ::Regexp.last_match(1)
+      separator = ::Regexp.last_match(2)
+      value = ::Regexp.last_match(3)
+      "#{bright_white}#{flag}#{reset}#{separator}#{bright_green}#{value}#{reset}"
+    end
+
+    puts "#{colored_cmd} #{colored_args}"
+  end
+
+  def run_cmd(args)
+    full_cmd = "ruby -I #{@lib_path} #{@gem_path} #{args}"
+    print_command(args)
+    system(full_cmd)
+    puts
+  end
+end
+
+# Quick execution
+if __FILE__ == $PROGRAM_NAME
+  begin
+    QuickDemo.new.run
+  rescue Interrupt
+    puts "\n\nDemo stopped. Thanks!"
+  end
+end

data/readme_demo.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# README Demo Script - Ruby Progress Gem
+# =====================================
+#
+# ReadmeDemo: demos and examples intended for inclusion in the README
+# and other documentation. Keeps examples compact and easy to run.
+class ReadmeDemo
+  def initialize
+    @gem_path = File.expand_path('bin/prg', __dir__)
+    @lib_path = File.expand_path('lib', __dir__)
+  end
+
+  def run_all_demos
+    puts 'Ruby Progress Gem - README Examples'
+    puts '==================================='
+    puts
+
+    basic_examples
+    style_examples
+    new_features_examples
+    advanced_examples
+
+    puts "\nAll examples completed!"
+  end
+
+  def basic_examples
+    section('Basic Usage Examples')
+
+    demo('Basic ripple animation',
+         "ripple --command 'sleep 3' --success 'Download complete!'")
+
+    demo('Basic worm progress bar',
+         "worm --length 10 --command 'sleep 4' --success 'Processing finished!'")
+
+    demo('Basic spinner',
+         "twirl --command 'sleep 2' --success 'Task completed!'")
+  end
+
+  def style_examples
+    section('Style Variations')
+
+    demo('Ripple pulse style',
+         "ripple --style pulse --command 'sleep 3' --success 'Pulsing!'")
+
+    demo('Worm with emoji style',
+         "worm --length 10 --style emoji --command 'sleep 3' --success 'Colorful! 🌈'")
+
+    demo('Classic spinner',
+         "twirl --style classic --command 'sleep 2' --success 'Spinning!'")
+  end
+
+  def new_features_examples
+    section('New v1.2.0 Features')
+
+    demo('Universal --ends flag with brackets',
+         "ripple --ends '[]' --command 'sleep 3' --success 'Framed!'")
+
+    demo('Worm with custom style',
+         "worm --length 10 --style custom=▫▪■ --command 'sleep 3' --success 'Custom blocks!'")
+
+    demo('Forward-only worm direction',
+         "worm --length 10 --direction forward --command 'sleep 4' --success 'Always forward!'")
+
+    demo('Emoji decoration',
+         "twirl --ends '🎯🎪' --command 'sleep 2' --success 'Decorated!'")
+
+    demo('Ultimate combination',
+         "worm --length 10 --style custom=🟦🟨🟥 --direction forward --ends '《》' --command 'sleep 4' --success 'All features!'")
+  end
+
+  def advanced_examples
+    section('Advanced Features')
+
+    demo('Error handling',
+         "worm --length 10 --command 'sleep 2 && exit 1' --error 'Task failed!' --fail-icon")
+
+    demo('Silent completion',
+         "ripple --command 'sleep 2'")
+
+    demo('Custom success icon',
+         "twirl --command 'sleep 2' --success 'Backup done' --icon '✓'")
+  end
+
+  private
+
+  def section(title)
+    puts "\n#{'-' * 50}"
+    puts " #{title}"
+    puts "#{'-' * 50}\n\n"
+  end
+
+  def demo(description, command)
+    puts "#{description}:"
+    puts "$ prg #{command}"
+    puts
+
+    full_command = "ruby -I #{@lib_path} #{@gem_path} #{command}"
+    system(full_command)
+
+    puts "\n"
+    sleep(1) # Brief pause between demos
+  end
+end
+
+# Command line interface
+if __FILE__ == $PROGRAM_NAME
+  demo = ReadmeDemo.new
+
+  if ARGV.empty?
+    demo.run_all_demos
+  else
+    case ARGV[0]
+    when 'basic'
+      demo.basic_examples
+    when 'styles'
+      demo.style_examples
+    when 'new'
+      demo.new_features_examples
+    when 'advanced'
+      demo.advanced_examples
+    else
+      puts "Usage: #{$PROGRAM_NAME} [basic|styles|new|advanced]"
+      puts "       #{$PROGRAM_NAME}     # run all demos"
+    end
+  end
+end

data/ruby-progress.gemspec

@@ -0,0 +1,40 @@
+# 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

data/scripts/run_matrix_mise.fish

@@ -0,0 +1,41 @@
+#!/usr/bin/env fish
+# Runs the test matrix using mise-managed Ruby installs and writes per-version logs.
+# Safe for fish shell; intended to be run from project root.
+
+set -l VERSIONS 2.7.8 3.0.6 3.1.4 3.2.0 3.3.0
+set -l REPO_ROOT (pwd)
+
+for v in $VERSIONS
+    set -l bin_dir $HOME/.local/share/mise/installs/ruby/$v/bin
+    if test -x "$bin_dir/ruby"
+        echo "\n=== Ruby $v ==="
+        echo "ruby: " (printf "%s" ("$bin_dir/ruby" -v))
+        echo "Installing bundler for Ruby $v (if needed)" >&2
+        # install bundler quietly; ignore errors from this step so we can try bundle install next
+        "$bin_dir/gem" install bundler --no-document >/dev/null 2>&1 || true
+        echo "Running bundle install for Ruby $v" >&2
+        # Use --quiet to reduce log noise, but keep failures visible
+        if test -x "$bin_dir/bundle"
+            "$bin_dir/bundle" install --quiet
+        else
+            # try using bundler directly
+            "$bin_dir/ruby" -S gem install bundler --no-document
+            "$bin_dir/ruby" -S bundle install --quiet
+        end
+
+        echo "Running rspec for Ruby $v (output -> rspec-$v.log)" >&2
+        # Capture exit status per-version; write logs
+        # run rspec and tee output to a per-version log
+        "$bin_dir/bundle" exec rspec --format documentation 2>&1 | tee rspec-$v.log
+        if test $status -ne 0
+            echo "rspec failed for Ruby $v (exit $status)" >&2
+            # stop the matrix if a version fails
+            exit $status
+        end
+    else
+        echo "Ruby $v not found at $bin_dir, skipping"
+    end
+end
+
+echo "Matrix complete. Logs:"
+ls -1 rspec-*.log 2>/dev/null || echo "No logs found"

data/test_daemon_interruption.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # Test script to explore terminal cursor behavior with daemon output interruption
 
 require_relative 'lib/ruby-progress'

data/test_daemon_orphan.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Test script to reproduce daemon orphaning issue
 puts 'Starting daemon...'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-progress
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Brett Terpstra
@@ -70,6 +70,7 @@ description: 'Animated progress indicators for Ruby: Ripple (text ripple effects
 email:
 - me@brettterpstra.com
 executables:
+- fill
 - prg
 - ripple
 - twirl
@@ -83,28 +84,50 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
+- DEMO_SCRIPTS.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- bin/fill
 - bin/prg
 - bin/ripple
 - bin/twirl
 - bin/worm
 - blog-post.md
 - demo_gem.rb
+- demo_screencast.rb
 - 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
+- lib/ruby-progress/cli/twirl_options.rb
+- lib/ruby-progress/cli/twirl_runner.rb
+- lib/ruby-progress/cli/twirl_spinner.rb
+- lib/ruby-progress/cli/worm_cli.rb
+- lib/ruby-progress/cli/worm_options.rb
+- lib/ruby-progress/cli/worm_runner.rb
 - 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
+- scripts/run_matrix_mise.fish
 - test_daemon_interruption.rb
 - test_daemon_orphan.rb
 - test_worm_flags.rb