ruby-progress 1.0.1

data/bin/prg

@@ -0,0 +1,311 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/ruby-progress'
+require 'optparse'
+
+# Unified progress indicator CLI
+module PrgCLI
+  def self.run
+    if ARGV.empty?
+      show_help
+      exit 1
+    end
+
+    subcommand = ARGV.shift.downcase
+    
+    case subcommand
+    when 'ripple'
+      RippleCLI.run
+    when 'worm'
+      WormCLI.run
+    when '-v', '--version'
+      puts "prg version #{RubyProgress::VERSION}"
+      puts "  ripple - Text ripple animation with spinners and effects"
+      puts "  worm   - Unicode wave animation with customizable styles"
+      exit
+    when '-h', '--help', 'help'
+      show_help
+      exit
+    else
+      puts "Error: Unknown subcommand '#{subcommand}'"
+      puts "Run 'prg --help' for usage information."
+      exit 1
+    end
+  end
+
+  def self.show_help
+    puts <<~HELP
+      prg - Unified Ruby Progress Indicators
+
+      USAGE:
+          prg <subcommand> [options]
+
+      SUBCOMMANDS:
+          ripple    Text ripple animation with spinners and color effects
+          worm      Unicode wave animation with customizable dot styles
+
+      GLOBAL OPTIONS:
+          -v, --version    Show version information
+          -h, --help       Show this help message
+
+      EXAMPLES:
+          prg ripple "Loading..." --rainbow --speed fast
+          prg worm --message "Processing" --style blocks --checkmark
+          prg ripple --command "sleep 3" --success "Done!" --checkmark
+
+      Run 'prg <subcommand> --help' for specific subcommand options.
+    HELP
+  end
+end
+
+# Enhanced Ripple CLI with unified flags
+module RippleCLI
+  def self.run
+    trap('INT') do
+      RubyProgress::Utils.show_cursor
+      exit
+    end
+
+    options = {
+      speed: :medium,
+      direction: :bidirectional,
+      rainbow: false,
+      spinner: false,
+      spinner_position: :before,
+      caps: false,
+      inverse: false,
+      command: nil,
+      success_message: nil,
+      fail_message: nil,
+      complete_checkmark: false,
+      output: :error,
+      message: nil # For unified interface
+    }
+
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: prg ripple [options] [STRING]'
+      opts.separator ''
+      opts.separator 'Animation Options:'
+
+      opts.on('-s', '--speed SPEED', 'Animation speed (fast/medium/slow or f/m/s)') do |s|
+        options[:speed] = case s.downcase
+                          when /^f/ then :fast
+                          when /^m/ then :medium
+                          when /^s/ then :slow
+                          else :medium
+                          end
+      end
+
+      opts.on('-m', '--message MESSAGE', 'Message to display (alternative to positional argument)') do |msg|
+        options[:message] = msg
+      end
+
+      opts.on('-r', '--rainbow', 'Enable rainbow color mode') do
+        options[:rainbow] = true
+      end
+
+      opts.on('-d', '--direction DIRECTION', 'Animation direction (forward/bidirectional or f/b)') do |f|
+        options[:format] = f =~ /^f/i ? :forward_only : :bidirectional
+      end
+
+      opts.on('-i', '--inverse', 'Enable inverse highlighting mode') do
+        options[:inverse] = true
+      end
+
+      opts.separator ''
+      opts.separator 'Spinner Options:'
+
+      opts.on('--spinner TYPE', 'Use spinner animation instead of text ripple') do |type|
+        options[:spinner] = type.normalize_type
+      end
+
+      opts.on('--spinner-pos POSITION', 'Spinner position (before/after or b/a)') do |pos|
+        options[:spinner_position] = pos =~ /^a/i ? :after : :before
+      end
+
+      opts.on('--caps', 'Enable case transformation mode') do
+        options[:caps] = true
+      end
+
+      opts.on('--list-spinners', 'List all available spinner types') do
+        show_spinners
+        exit
+      end
+
+      opts.separator ''
+      opts.separator 'Command Execution:'
+
+      opts.on('-c', '--command COMMAND', 'Run command during animation (optional)') do |command|
+        options[:command] = command
+      end
+
+      opts.on('--success MESSAGE', 'Success message to display') do |msg|
+        options[:success_message] = msg
+      end
+
+      opts.on('--error MESSAGE', 'Error message to display') do |msg|
+        options[:fail_message] = msg
+      end
+
+      opts.on('--checkmark', 'Show checkmarks (✅ success, 🛑 failure)') do
+        options[:complete_checkmark] = true
+      end
+
+      opts.on('--stdout', 'Output captured command result to STDOUT') do
+        options[:output] = :stdout
+      end
+
+      opts.on('--quiet', 'Suppress all output') do
+        options[:output] = :quiet
+      end
+
+      opts.separator ''
+      opts.separator 'General:'
+
+      opts.on('-v', '--version', 'Show version') do
+        puts "Ripple version #{RubyProgress::VERSION}"
+        exit
+      end
+
+      opts.on('-h', '--help', 'Show this help') do
+        puts opts
+        exit
+      end
+    end.parse!
+
+    # Get text from positional argument or --message flag
+    text = options[:message] || ARGV.join(' ')
+    
+    if text.empty?
+      puts 'Error: Please provide text to animate via argument or --message flag'
+      puts "Example: prg ripple 'Loading...' or prg ripple --message 'Loading...'"
+      exit 1
+    end
+
+    if options[:command]
+      run_with_command(text, options)
+    else
+      run_indefinitely(text, options)
+    end
+  end
+
+  def self.show_spinners
+    puts "Available spinners:"
+    RubyProgress::INDICATORS.each do |name, chars|
+      puts "  #{name.to_s.ljust(15)} #{chars[0..2].join(' ')}"
+    end
+  end
+
+  def self.run_with_command(text, options)
+    captured_output = nil
+    RubyProgress::Ripple.progress(text, options) do
+      captured_output = `#{options[:command]} 2>&1`
+    end
+
+    success = $?.success?
+
+    if options[:output] == :stdout
+      puts captured_output
+    end
+    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)
+    end
+    exit success ? 0 : 1
+  end
+
+  def self.run_indefinitely(text, options)
+    rippler = RubyProgress::Ripple.new(text, options)
+    RubyProgress::Utils.hide_cursor
+    begin
+      while true
+        rippler.advance
+      end
+    ensure
+      RubyProgress::Utils.show_cursor
+      RubyProgress::Ripple.complete(text, options[:success_message], options[:complete_checkmark], true)
+    end
+  end
+end
+
+# Enhanced Worm CLI with unified flags
+module WormCLI
+  def self.run
+    options = parse_cli_options
+
+    progress = RubyProgress::Worm.new(options)
+
+    if options[:command]
+      progress.run_with_command
+    else
+      progress.run_indefinitely
+    end
+  end
+
+  def self.parse_cli_options
+    options = {}
+
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: prg worm [options]'
+      opts.separator ''
+      opts.separator 'Animation Options:'
+
+      opts.on('-s', '--speed SPEED', 'Animation speed (1-10, fast/medium/slow, or f/m/s)') do |speed|
+        options[:speed] = speed
+      end
+
+      opts.on('-m', '--message MESSAGE', 'Message to display before animation') do |message|
+        options[:message] = message
+      end
+
+      opts.on('-l', '--length LENGTH', Integer, 'Number of dots to display') do |length|
+        options[:length] = length
+      end
+
+      opts.on('--style STYLE', 'Animation style (circles/blocks/geometric or c/b/g)') do |style|
+        options[:style] = style
+      end
+
+      opts.separator ''
+      opts.separator 'Command Execution:'
+
+      opts.on('-c', '--command COMMAND', 'Command to run (optional - runs indefinitely without)') do |command|
+        options[:command] = command
+      end
+
+      opts.on('--success MESSAGE', 'Success message to display') do |text|
+        options[:success] = text
+      end
+
+      opts.on('--error MESSAGE', 'Error message to display') do |text|
+        options[:error] = text
+      end
+
+      opts.on('--checkmark', 'Show checkmarks (✅ success, 🛑 failure)') do
+        options[:checkmark] = true
+      end
+
+      opts.on('--stdout', 'Output captured command result to STDOUT') do
+        options[:stdout] = true
+      end
+
+      opts.separator ''
+      opts.separator 'General:'
+
+      opts.on('-v', '--version', 'Show version') do
+        puts "Worm version #{RubyProgress::VERSION}"
+        exit
+      end
+
+      opts.on('-h', '--help', 'Show this help') do
+        puts opts
+        exit
+      end
+    end.parse!
+
+    options
+  end
+end
+
+PrgCLI.run if __FILE__ == $PROGRAM_NAME

data/bin/ripple

@@ -0,0 +1,147 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/ruby-progress'
+require 'optparse'
+
+# Ripple CLI implementation
+module RippleCLI
+  def self.run
+    trap('INT') do
+      RubyProgress::Utils.show_cursor
+      exit
+    end
+
+    options = {
+      speed: :medium,
+      direction: :bidirectional,
+      rainbow: false,
+      spinner: false,
+      spinner_position: :before,
+      caps: false,
+      inverse: false,
+      command: nil,
+      success_message: nil,
+      fail_message: nil,
+      complete_checkmark: false
+    }
+
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: ripple [options] STRING'
+
+      opts.on('-s', '--speed SPEED', %i[fast medium slow], 'Set animation speed ((f)ast/(m)edium/(s)low)') do |s|
+        options[:speed] = case s
+                          when /^f/ then :fast
+                          when /^m/ then :medium
+                          when /^s/ then :slow
+                          else :slow
+                          end
+      end
+
+      opts.on('-r', '--rainbow', 'Enable rainbow mode') do
+        options[:rainbow] = true
+      end
+
+      opts.on('-d', '--direction DIRECTION', 'Set animation format ((f)orward/(b)ack-and-forth)') do |f|
+        options[:format] = f =~ /^f/ ? :forward_only : :bidirectional
+      end
+
+      opts.on('-i', '--inverse', 'Enable inverse mode') do
+        options[:inverse] = true
+      end
+
+      opts.on('-c', '--command COMMAND', 'Run a command during the animation') do |command|
+        options[:command] = command
+      end
+
+      opts.on('--success MESSAGE', 'Message to display on success') do |msg|
+        options[:success_message] = msg
+      end
+
+      opts.on('--fail MESSAGE', 'Message to display on error') do |msg|
+        options[:fail_message] = msg
+      end
+
+      opts.on('--checkmark') do
+        options[:complete_checkmark] = true
+      end
+
+      opts.on('--spinner TYPE', 'Display a rippling spinner with the message') do |type|
+        options[:spinner] = type.normalize_type
+      end
+
+      opts.on('--spinner-pos POSITION', 'Display spinner [b]efore or [a]fter message') do |pos|
+        options[:spinner_position] = pos =~ /^a/ ? :after : :before
+      end
+
+      opts.on('--list-spinners', 'List available spinners') do
+        out = "Spinners:\n"
+        RubyProgress::INDICATORS.each do |k, v|
+          out += "- #{k}: #{v[2]}\n"
+        end
+        puts out
+        exit
+      end
+
+      opts.on('--caps') do
+        options[:caps] = true
+      end
+
+      opts.on('--stdout', 'Output captured command result to STDOUT') do |_output|
+        options[:output] = :stdout
+      end
+
+      opts.on('--quiet', 'Suppress all output') do |_quiet|
+        options[:output] = :quiet
+      end
+
+      opts.on('-v', '--version', 'Display the version') do
+        puts "Ripple version #{RubyProgress::VERSION}"
+        exit
+      end
+
+      opts.on('-h', '--help', 'Display this help message') do
+        puts opts
+        exit
+      end
+    end.parse!
+
+    if ARGV.empty?
+      puts 'Please provide a string to animate as an argument.'
+      exit 1
+    end
+
+    if options[:command]
+      captured_output = nil
+      res = RubyProgress::Ripple.progress(ARGV.join(' '), options) do
+        captured_output = `#{options[:command]} 2>&1`
+      end
+
+      res = $?.success?
+
+      puts captured_output if options[:output] == :stdout
+      if options[:success_message]
+        message = if res
+                    options[:success_message]
+                  else
+                    options[:fail_message] || options[:success_message]
+                  end
+        RubyProgress::Ripple.complete(ARGV.join(' '), message, options[:complete_checkmark], res)
+      end
+      exit res ? 0 : 1
+    end
+
+    rippler = RubyProgress::Ripple.new(ARGV.join(' '), {
+                                         speed: options[:speed],
+                                         format: options[:format],
+                                         rainbow: options[:rainbow],
+                                         inverse: options[:inverse]
+                                       })
+    RubyProgress::Utils.hide_cursor
+    rippler.advance while true
+    RubyProgress::Utils.show_cursor
+    RubyProgress::Ripple.complete(ARGV.join(' '), options[:success_message], options[:complete_checkmark], true)
+  end
+end
+
+RippleCLI.run if __FILE__ == $PROGRAM_NAME

data/bin/worm

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/ruby-progress'
+require 'optparse'
+
+# Worm CLI implementation
+module WormCLI
+  def self.run
+    options = parse_cli_options
+    progress = RubyProgress::Worm.new(options)
+
+    if options[:command]
+      progress.run_with_command
+    else
+      # Run indefinitely like ripple does when no command is specified
+      progress.run_indefinitely
+    end
+  end
+
+  def self.parse_cli_options
+    options = {}
+
+    OptionParser.new do |opts|
+      opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+      opts.separator ''
+      opts.separator 'Options:'
+
+      opts.on('-s', '--speed SPEED', 'Animation speed (1-10, fast, medium, slow, or f/m/s)') do |speed|
+        options[:speed] = speed
+      end
+
+      opts.on('-l', '--length LENGTH', Integer, 'Number of dots to display') do |length|
+        options[:length] = length
+      end
+
+      opts.on('-m', '--message MESSAGE', 'Message to display before dots') do |message|
+        options[:message] = message
+      end
+
+      opts.on('--style STYLE', 'Animation style (blocks, geometric, circles, or b/g/c)') do |style|
+        options[:style] = style
+      end
+
+      opts.on('-c', '--command COMMAND', 'Command to run (optional - runs indefinitely without command)') do |command|
+        options[:command] = command
+      end
+
+      opts.on('--success TEXT', 'Text to display on successful completion') do |text|
+        options[:success] = text
+      end
+
+      opts.on('--error TEXT', 'Text to display on error') do |text|
+        options[:error] = text
+      end
+
+      opts.on('--checkmark', 'Show checkmarks (✅/🛑) in completion messages') do
+        options[:checkmark] = true
+      end
+
+      opts.on('--stdout', 'Output captured command result to STDOUT') do
+        options[:stdout] = true
+      end
+
+      opts.on('-h', '--help', 'Show this help message') do
+        puts opts
+        exit
+      end
+
+      opts.on('-v', '--version', 'Display the version') do
+        puts "Worm version #{RubyProgress::VERSION}"
+        exit
+      end
+    end.parse!
+
+    options
+  end
+end
+
+WormCLI.run if __FILE__ == $PROGRAM_NAME

data/demo_gem.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Demo script showing gem functionality for CI/CD validation
+
+puts '🚀 Ruby Progress Gem Demo'
+puts '========================='
+puts
+
+# Test library loading
+begin
+  require 'ruby-progress'
+  puts '✅ Library loaded successfully'
+  puts "📦 Version: #{RubyProgress::VERSION}"
+rescue LoadError => e
+  puts "❌ Failed to load library: #{e.message}"
+  exit 1
+end
+
+puts
+
+# Test Ripple class
+begin
+  puts '🌊 Testing Ripple class...'
+  ripple = RubyProgress::Ripple.new('Demo Test')
+  puts '✅ Ripple class instantiated successfully'
+rescue StandardError => e
+  puts "❌ Ripple test failed: #{e.message}"
+  exit 1
+end
+
+# Test Worm class
+begin
+  puts '🐛 Testing Worm class...'
+  worm = RubyProgress::Worm.new(message: 'Demo Test')
+  puts '✅ Worm class instantiated successfully'
+rescue StandardError => e
+  puts "❌ Worm test failed: #{e.message}"
+  exit 1
+end
+
+puts
+puts '🎉 All tests passed! The gem is working correctly.'
+puts
+puts '📊 Key Features Verified:'
+puts '  • Library structure and loading'
+puts '  • Version management'
+puts '  • Ripple and Worm class instantiation'
+puts '  • Module namespacing'
+puts
+puts '🔗 Ready for badge display:'
+puts '  • RubyGems version badge'
+puts '  • MIT license badge'
+puts '  • GitHub Actions test badge'
+puts '  • Ruby version compatibility badge'
+puts '  • Test coverage badge'

data/demo_worm_infinite.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Demo script showing worm.rb's new infinite mode
+
+puts '=== Worm.rb Infinite Mode Demo ==='
+puts
+
+puts '1. Running indefinitely for 3 seconds (like ripple):'
+system("timeout 3s ruby worm.rb --message 'Loading...' --speed fast --style circles || echo")
+puts
+
+puts '2. Running with command and checkmarks:'
+system("ruby worm.rb --command 'sleep 1 && echo Success' --message 'Processing' --success 'Done!' --checkmark --stdout")
+puts
+
+puts '3. Running indefinitely with blocks style:'
+system("timeout 2s ruby worm.rb --message 'Working' --style blocks --length 6 --speed medium || echo")
+puts
+
+puts 'Demo complete! Worm.rb now works like ripple when no command is specified.'

data/examples/utils_demo.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Demo of RubyProgress::Utils universal utilities
+require_relative '../lib/ruby-progress'
+
+puts "=== RubyProgress::Utils Demo ==="
+puts
+
+# Test cursor control
+puts "Testing cursor control..."
+print "Hiding cursor for 2 seconds..."
+RubyProgress::Utils.hide_cursor
+sleep 2
+print " showing cursor again."
+RubyProgress::Utils.show_cursor
+puts
+puts
+
+# Test line clearing
+puts "Testing line clearing..."
+print "This line will be cleared..."
+sleep 1
+RubyProgress::Utils.clear_line
+print "New content on the same line!"
+puts
+puts
+
+# Test completion messages
+puts "Testing completion messages..."
+
+RubyProgress::Utils.display_completion("Basic success message", success: true)
+RubyProgress::Utils.display_completion("Basic failure message", success: false)
+
+puts
+puts "With checkmarks:"
+RubyProgress::Utils.display_completion("Success with checkmark", success: true, show_checkmark: true)
+RubyProgress::Utils.display_completion("Failure with checkmark", success: false, show_checkmark: true)
+
+puts
+puts "Different output streams:"
+RubyProgress::Utils.display_completion("To STDOUT", success: true, show_checkmark: true, output_stream: :stdout)
+RubyProgress::Utils.display_completion("To STDERR", success: false, show_checkmark: true, output_stream: :stderr)
+
+puts
+puts "Complete with clear:"
+print "Content to be cleared and replaced..."
+sleep 1
+RubyProgress::Utils.complete_with_clear("Cleared and completed!", success: true, show_checkmark: true, output_stream: :stdout)
+
+puts
+puts "=== Demo Complete ==="