ruby-progress 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df0ca84734879ec0824018482709764c6380d33e6c03036d442eb584d2bc079b
+  data.tar.gz: 284b601b3bfdb42512549f90af2a174226259dd305a707729988f807c13c59bf
+SHA512:
+  metadata.gz: 946ec374e45b2048a4702b76108b5eec7c52ddbabcacf5744cfee7f131e1d730e414878afcdbf8296111e64a91419c3d7e20f38e4faa4c60426b8f014484a1f3
+  data.tar.gz: 6597651f4119954be581cbc10f1400832c1a3da2bc0bb5dfda446d5785c9f461ca19ed357012ffc60767a433dd0531b40e3c684d541403906b5007726742e597

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+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).
+
+## [1.0.1] - 2025-01-01
+
+### 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**
+
+### Changed
+- 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
+
+### Fixed
+- Fixed duplicate error messages in Worm error handling
+- Improved signal handling and cursor management
+
+## [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

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-progress.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 1.21'
+  gem 'simplecov', '~> 0.21', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    ruby-progress (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.5.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    rubocop (1.75.7)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  ruby-progress!
+  simplecov (~> 0.21)
+
+BUNDLED WITH
+   2.6.8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Brett Terpstra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,353 @@
+# Ruby Progress Indicators
+
+[![Gem Version](https://badge.fury.io/rb/ruby-progress.svg)](https://badge.fury.io/rb/ruby-progress)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![RSpec Tests](https://github.com/ttscoff/ruby-progress/actions/workflows/rspec.yml/badge.svg)](https://github.com/ttscoff/ruby-progress/actions/workflows/rspec.yml)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%202.5.0-ruby.svg)](https://www.ruby-lang.org/)
+[![Coverage Status](https://img.shields.io/badge/coverage-55%25-yellow.svg)](#)
+
+This repository contains two different Ruby progress indicator projects: **Ripple** and **Worm**. Both provide animated terminal progress indicators with different visual styles and features.
+
+## Unified Interface
+
+The gem provides a unified `prg` command that supports both progress indicators through subcommands:
+
+```bash
+# Install the gem
+gem install ruby-progress
+
+# Use worm-style animation
+prg worm --message "Processing data" --style blocks --checkmark
+
+# Use ripple-style animation  
+prg ripple "Loading..." --rainbow --speed fast
+
+# With command execution
+prg worm --command "sleep 5" --success "Completed!" --error "Failed!" --checkmark
+prg ripple "Building..." --command "make build" --success "Build complete!" --stdout
+```
+
+### Global Options
+- `prg --help` - Show main help
+- `prg --version` - Show version info
+- `prg <subcommand> --help` - Show specific subcommand help
+
+### Common Options (available for both subcommands)
+- `--speed SPEED` - Animation speed (fast/medium/slow or f/m/s)
+- `--message MESSAGE` - Message to display
+- `--command COMMAND` - Command to execute during animation
+- `--success MESSAGE` - Success message after completion
+- `--error MESSAGE` - Error message on failure
+- `--checkmark` - Show checkmarks (✅ success, 🛑 failure)  
+- `--stdout` - Output command results to STDOUT
+
+## Table of Contents
+
+- [Ruby Progress Indicators](#ruby-progress-indicators)
+  - [Unified Interface](#unified-interface)
+    - [Global Options](#global-options)
+    - [Common Options (available for both subcommands)](#common-options-available-for-both-subcommands)
+  - [Ripple](#ripple)
+    - [Ripple Features](#ripple-features)
+    - [Ripple Usage](#ripple-usage)
+      - [Command Line](#command-line)
+      - [Ripple Command Line Options](#ripple-command-line-options)
+    - [Ripple Library Usage](#ripple-library-usage)
+    - [Available Spinners](#available-spinners)
+  - [Worm](#worm)
+    - [Worm Features](#worm-features)
+    - [Worm Usage](#worm-usage)
+      - [Command Line](#command-line-1)
+      - [Worm Command Line Options](#worm-command-line-options)
+    - [Worm Library Usage](#worm-library-usage)
+    - [Animation Styles](#animation-styles)
+      - [Circles](#circles)
+      - [Blocks](#blocks)
+      - [Geometric](#geometric)
+  - [Requirements](#requirements)
+  - [Installation](#installation)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+---
+
+## 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, rainbow colors, spinners, and case transformations.
+
+### Ripple Features
+
+- **Text ripple animations** with customizable speed and direction
+- **Rainbow color effects** that cycle through colors
+- **30+ built-in spinner styles** (dots, arrows, blocks, etc.)
+- **Multiple animation formats**: forward-only, bidirectional
+- **Command execution** with animated progress display
+- **Custom success/failure messages** with optional checkmarks
+- **Case transformation modes** (uppercase/lowercase rippling)
+- **Inverse highlighting** for different visual effects
+
+### Ripple Usage
+
+#### Command Line
+
+```bash
+# Basic text animation
+./ripple "Loading..."
+
+# With options
+./ripple "Processing Data" --speed fast --rainbow --direction bidirectional
+
+# Run a command with progress animation
+./ripple "Installing packages" --command "sleep 5" --success "Installation complete!" --checkmark
+
+# Use a spinner instead of text ripple
+./ripple "Working" --spinner dots --spinner-pos before
+```
+
+#### Ripple Command Line Options
+
+| Option                  | Description                                                   |
+| ----------------------- | ------------------------------------------------------------- |
+| `-s, --speed SPEED`     | Animation speed (1-10, fast/medium/slow, or f/m/s)            |
+| `-l, --length LENGTH`   | Number of dots to display                                     |
+| `-m, --message MESSAGE` | Message to display before animation                           |
+| `--style STYLE`         | Animation style (blocks/geometric/circles or b/g/c)           |
+| `-c, --command COMMAND` | Command to run (optional - runs indefinitely without command) |
+| `--success TEXT`        | Text to display on successful completion                      |
+| `--error TEXT`          | Text to display on error                                      |
+| `--checkmark`           | Show checkmarks (✅ for success, 🛑 for failure)                |
+| `--stdout`              | Output captured command result to STDOUT                      |
+
+### Ripple Library Usage
+
+You can also use Ripple as a Ruby library:
+
+```ruby
+require 'ruby-progress'
+
+# Simple progress block
+result = RubyProgress::Ripple.progress("Processing...") do
+  sleep 5  # Your actual work here
+end
+
+# With options
+rippler = RubyProgress::Ripple.new("Loading Data", {
+  speed: :fast,
+  format: :bidirectional,
+  rainbow: true,
+  spinner: :dots
+})
+
+RubyProgress::Ripple.hide_cursor
+while some_condition
+  rippler.advance
+end
+RubyProgress::Ripple.show_cursor
+```
+
+### Available Spinners
+
+Ripple includes 30+ different spinner styles:
+
+- **Classic**: `|`, `/`, `—`, `\`
+- **Dots**: Various braille dot patterns (dots, dots_2, dots_3, etc.)
+- **Arrows**: Arrow patterns and pulsing arrows
+- **Blocks**: Block characters in different patterns
+- **Geometric**: Circles, triangles, arcs
+- **Progress bars**: Bounce, push, pulse effects
+- **And many more!**
+
+Use `./ripple --list-spinners` to see all available options.
+
+---
+
+## Worm
+
+Worm is a clean, Unicode-based progress indicator that creates a ripple effect using combining characters. It's designed for running commands with visual progress feedback.
+
+### Worm Features
+
+- **Ripple wave animation** using Unicode characters
+- **Multiple visual styles** (circles, blocks, geometric)
+- **Configurable speed** (1-10 scale or named speeds)
+- **Customizable length** and messages
+- **Command execution** with progress indication
+- **Success/error message customization**
+- **Proper signal handling** and cursor management
+
+### Worm Usage
+
+#### Command Line
+
+```bash
+# Run indefinitely without a command (like ripple)
+./worm.rb --message "Loading..." --speed fast --style circles
+
+# Run a command with progress animation
+./worm.rb --command "sleep 5" --message "Installing" --success "Done!"
+
+# Customize the animation
+./worm.rb --command "make build" --speed fast --length 5 --style blocks
+
+# With custom error handling
+./worm.rb --command "risky_operation" --error "Operation failed" --style geometric
+
+# With checkmarks for visual feedback
+./worm.rb --command "npm install" --success "Installation complete!" --checkmark
+
+# Capture and display command output
+./worm.rb --command "git status" --message "Checking status" --stdout
+
+# Combine checkmarks and stdout output
+./worm.rb --command "echo 'Build output'" --success "Build complete!" --checkmark --stdout
+```
+
+#### Worm Command Line Options
+
+| Option                  | Description                                         |
+| ----------------------- | --------------------------------------------------- |
+| `-s, --speed SPEED`     | Animation speed (1-10, fast/medium/slow, or f/m/s)  |
+| `-l, --length LENGTH`   | Number of dots to display                           |
+| `-m, --message MESSAGE` | Message to display before animation                 |
+| `--style STYLE`         | Animation style (blocks/geometric/circles or b/g/c) |
+| `-c, --command COMMAND` | Command to run (required)                           |
+| `--success TEXT`        | Text to display on successful completion            |
+| `--error TEXT`          | Text to display on error                            |
+
+### Worm Library Usage
+
+```ruby
+require 'ruby-progress'
+
+# Create and run animation with a block
+worm = RubyProgress::Worm.new(
+  length: 4,
+  message: "Processing",
+  speed: 'fast',
+  style: 'circles'
+)
+
+result = worm.animate(
+  success: "Complete!",
+  error: "Failed!"
+) do
+  # Your work here
+  some_long_running_task
+end
+
+# Or run with a command
+worm = RubyProgress::Worm.new(command: "bundle install")
+worm.run_with_command
+```
+
+### Animation Styles
+
+Worm supports three built-in animation styles:
+
+#### Circles
+- Baseline: `·` (middle dot)
+- Midline: `●` (black circle)
+- Peak: `⬤` (large circle)
+
+#### Blocks
+- Baseline: `▁` (lower eighth block)
+- Midline: `▄` (lower half block)
+- Peak: `█` (full block)
+
+#### Geometric
+- Baseline: `▪` (small black square)
+- Midline: `▫` (small white square)
+- Peak: `■` (large black square)
+
+---
+
+## Requirements
+
+Both projects require:
+- Ruby 2.5 or higher
+- Terminal with Unicode support (for Worm)
+- ANSI color support (for Ripple rainbow effects)
+
+## Installation
+
+### As a Gem (Recommended)
+
+```bash
+gem install ruby-progress
+```
+
+### From Source
+
+1. Clone this repository
+2. Build and install:
+   ```bash
+   bundle install
+   bundle exec rake build
+   gem install pkg/ruby-progress-*.gem
+   ```
+
+### Development
+
+1. Clone the repository
+2. Install dependencies:
+   ```bash
+   bundle install
+   ```
+3. Run tests:
+   ```bash
+   bundle exec rspec
+   ```
+
+## Universal Utilities
+
+The gem provides universal utilities in the `RubyProgress::Utils` module for common terminal operations:
+
+### Terminal Control
+
+```ruby
+require 'ruby-progress'
+
+# Cursor control
+RubyProgress::Utils.hide_cursor    # Hide terminal cursor
+RubyProgress::Utils.show_cursor    # Show terminal cursor
+RubyProgress::Utils.clear_line     # Clear current line
+```
+
+### Completion Messages
+
+```ruby
+# Basic completion message
+RubyProgress::Utils.display_completion("Task completed!")
+
+# With success/failure indication and checkmarks
+RubyProgress::Utils.display_completion(
+  "Build successful!", 
+  success: true, 
+  show_checkmark: true
+)
+
+RubyProgress::Utils.display_completion(
+  "Build failed!", 
+  success: false, 
+  show_checkmark: true,
+  output_stream: :stdout  # :stdout, :stderr, or :warn (default)
+)
+
+# Clear line and display completion (useful for replacing progress indicators)
+RubyProgress::Utils.complete_with_clear(
+  "Processing complete!",
+  success: true,
+  show_checkmark: true,
+  output_stream: :stdout
+)
+```
+
+These utilities are used internally by both Ripple and Worm classes and are available for use in your own applications.
+
+## Contributing
+
+Feel free to submit issues and pull requests to improve either project!
+
+## License
+
+Both projects are provided as-is for educational and practical use.

data/Rakefile

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+# Version management tasks
+desc 'Show current version'
+task :version do
+  require_relative 'lib/ruby-progress/version'
+  puts RubyProgress::VERSION
+end
+
+desc 'Bump patch version'
+task :bump_patch do
+  bump_version(:patch)
+end
+
+desc 'Bump minor version'
+task :bump_minor do
+  bump_version(:minor)
+end
+
+desc 'Bump major version'
+task :bump_major do
+  bump_version(:major)
+end
+
+def bump_version(type)
+  require_relative 'lib/ruby-progress/version'
+  version_parts = RubyProgress::VERSION.split('.').map(&:to_i)
+
+  case type
+  when :patch
+    version_parts[2] += 1
+  when :minor
+    version_parts[1] += 1
+    version_parts[2] = 0
+  when :major
+    version_parts[0] += 1
+    version_parts[1] = 0
+    version_parts[2] = 0
+  end
+
+  new_version = version_parts.join('.')
+
+  # Update version file
+  version_file = 'lib/ruby-progress/version.rb'
+  content = File.read(version_file)
+  content.gsub!(/VERSION = '[^']*'/, "VERSION = '#{new_version}'")
+  File.write(version_file, content)
+
+  puts "Version bumped from #{RubyProgress::VERSION} to #{new_version}"
+end
+
+# Package management
+desc 'Clean up generated files'
+task :clobber do
+  require 'fileutils'
+  FileUtils.rm_rf('pkg')
+  FileUtils.rm_rf('coverage')
+  puts 'Cleaned up generated files'
+end
+
+desc 'Build and install gem locally'
+task install_local: :build do
+  require_relative 'lib/ruby-progress/version'
+  gem_file = "pkg/ruby-progress-#{RubyProgress::VERSION}.gem"
+  system("gem install #{gem_file}")
+end
+
+desc 'Test installed binaries'
+task :test_binaries do
+  puts 'Testing ripple binary...'
+  system('ripple --version') || abort('ripple binary test failed')
+  puts 'Testing worm binary...'
+  system('worm --version') || abort('worm binary test failed')
+  puts 'Binary tests passed!'
+end