thor-interactive 0.1.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e51ddada105bae31b9bc637ed25fd88e4908c281c16779b46d023d16f31db4e
+  data.tar.gz: cbccf2e8dc47f73e7f1c101bd1a0dce0c2fa51cc21f9a26e24ed7f577245d2cf
+SHA512:
+  metadata.gz: 0ea62f18e17ab19662bd3c8fac62dce8dd69582adc857664901e69729670d8de690161a111151df1ab4ee7b403521b9e9254d9d67942bdc36f244278887d2b21
+  data.tar.gz: a566b97836f0a11b75e35e35692f0996d3817b5b34dfa2d3c169d84dd125cac453cbeac14bfb76cd99f3253d144b4b550fd3e7a939f7b711e27a114242df2997

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Chris Petersen
+
+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,472 @@
+# Thor::Interactive
+
+Turn any Thor CLI into an interactive REPL with persistent state and auto-completion.
+
+Thor::Interactive automatically converts your existing Thor command-line applications into interactive REPLs, maintaining state between commands and providing auto-completion for commands and parameters. Perfect for applications that benefit from persistent sessions like RAG pipelines, database tools, or any CLI that maintains caches or connections.
+
+## Features
+
+- **Zero Configuration**: Works with any existing Thor application without modifications
+- **State Persistence**: Maintains class variables and instance state between commands
+- **Auto-completion**: Tab completion for command names and basic parameter support
+- **Default Handlers**: Configurable fallback for non-command input
+- **Command History**: Persistent readline history with up/down arrow navigation
+- **Both Modes**: Supports both traditional CLI usage and interactive REPL mode
+- **Graceful Exit**: Proper handling of Ctrl+C interrupts and Ctrl+D/exit commands
+
+## Installation
+
+Add to your application's Gemfile:
+
+```ruby
+gem 'thor-interactive'
+```
+
+Or install directly:
+
+```bash
+gem install thor-interactive
+```
+
+## Quick Start
+
+### Option 1: Add Interactive Command (Recommended)
+
+Add one line to your Thor class to get an `interactive` command:
+
+```ruby
+require 'thor'
+require 'thor/interactive'
+
+class MyApp < Thor
+  include Thor::Interactive::Command
+
+  # Your existing Thor commands work unchanged
+  desc "hello NAME", "Say hello"
+  def hello(name)
+    puts "Hello #{name}!"
+  end
+end
+```
+
+Now your app supports both modes:
+
+```bash
+# Normal CLI usage (unchanged)
+ruby myapp.rb hello World
+
+# New interactive mode
+ruby myapp.rb interactive
+myapp> hello Alice
+Hello Alice!
+myapp> exit
+```
+
+### Option 2: Programmatic Usage
+
+Start an interactive shell programmatically:
+
+```ruby
+require 'thor/interactive'
+
+class MyApp < Thor
+  desc "hello NAME", "Say hello"
+  def hello(name)
+    puts "Hello #{name}!"
+  end
+end
+
+# Start interactive shell
+Thor::Interactive.start(MyApp)
+```
+
+## State Persistence Example
+
+The key benefit is maintaining state between commands:
+
+```ruby
+class RAGApp < Thor
+  include Thor::Interactive::Command
+
+  # These persist between commands in interactive mode
+  class_variable_set(:@@llm_client, nil)
+  class_variable_set(:@@conversation_history, [])
+
+  desc "ask TEXT", "Ask the LLM a question"
+  def ask(text)
+    # Initialize once, reuse across commands
+    @@llm_client ||= expensive_llm_initialization
+
+    response = @@llm_client.chat(text)
+    @@conversation_history << {input: text, output: response}
+    puts response
+  end
+
+  desc "history", "Show conversation history"
+  def history
+    @@conversation_history.each_with_index do |item, i|
+      puts "#{i+1}. Q: #{item[:input]}"
+      puts "   A: #{item[:output]}"
+    end
+  end
+end
+```
+
+In interactive mode:
+```bash
+ruby rag_app.rb interactive
+
+rag> ask "What is Ruby?"
+# LLM initializes once
+Ruby is a programming language...
+
+rag> ask "Tell me more"
+# LLM client reused, conversation context maintained
+Based on our previous discussion about Ruby...
+
+rag> history
+1. Q: What is Ruby?
+   A: Ruby is a programming language...
+2. Q: Tell me more
+   A: Based on our previous discussion about Ruby...
+```
+
+## Configuration
+
+Configure interactive behavior:
+
+```ruby
+class MyApp < Thor
+  include Thor::Interactive::Command
+
+  configure_interactive(
+    prompt: "myapp> ",                    # Custom prompt
+    allow_nested: false,                  # Prevent nested sessions (default)
+    nested_prompt_format: "[L%d] %s",    # Format for nested prompts (if allowed)
+    default_handler: proc do |input, thor_instance|
+      # Handle unrecognized input
+      thor_instance.invoke(:search, [input])
+    end
+  )
+
+  desc "search QUERY", "Search for something"
+  def search(query)
+    puts "Searching for: #{query}"
+  end
+end
+```
+
+Now unrecognized input gets sent to the search command:
+
+```bash
+myapp> hello world
+Hello world!
+
+myapp> some random text
+Searching for: some random text
+```
+
+### Nested Session Management
+
+By default, thor-interactive prevents nested interactive sessions to avoid confusion:
+
+```ruby
+class MyApp < Thor
+  include Thor::Interactive::Command
+
+  configure_interactive(
+    prompt: "myapp> ",
+    allow_nested: false  # Default behavior
+  )
+end
+```
+
+If you try to run `interactive` while already in an interactive session:
+
+```bash
+myapp> interactive
+Already in an interactive session.
+To allow nested sessions, configure with: configure_interactive(allow_nested: true)
+```
+
+#### Allowing Nested Sessions
+
+For advanced use cases, you can enable nested sessions:
+
+```ruby
+class AdvancedApp < Thor
+  include Thor::Interactive::Command
+
+  configure_interactive(
+    prompt: "advanced> ",
+    allow_nested: true,
+    nested_prompt_format: "[Level %d] %s"  # Optional custom format
+  )
+end
+```
+
+With nested sessions enabled:
+
+```bash
+$ ruby advanced_app.rb interactive
+AdvancedApp Interactive Shell
+Type 'help' for available commands, 'exit' to quit
+
+advanced> interactive
+AdvancedApp Interactive Shell (nested level 2)
+Type 'exit' to return to previous level, or 'help' for commands
+
+[Level 2] advanced> hello nested
+Hello nested!
+
+[Level 2] advanced> exit
+Exiting nested session...
+
+advanced> exit
+Goodbye!
+```
+
+## Advanced Usage
+
+### Custom Options
+
+Pass options to the interactive command:
+
+```bash
+ruby myapp.rb interactive --prompt="custom> " --history-file=~/.my_history
+```
+
+### Multiple Applications
+
+Use the same gem with different Thor applications:
+
+```ruby
+# Database CLI
+class DBApp < Thor
+  include Thor::Interactive::Command
+  configure_interactive(prompt: "db> ")
+end
+
+# API Testing CLI
+class APIApp < Thor
+  include Thor::Interactive::Command
+  configure_interactive(prompt: "api> ")
+end
+```
+
+### Without Mixin
+
+Use programmatically without including the module:
+
+```ruby
+default_handler = proc do |input, instance|
+  puts "You said: #{input}"
+end
+
+Thor::Interactive.start(MyThorApp,
+  prompt: "custom> ",
+  default_handler: default_handler,
+  history_file: "~/.custom_history"
+)
+```
+
+## Examples
+
+See the `examples/` directory for complete working examples:
+
+- `sample_app.rb` - Demonstrates all features with a simple CLI
+- `test_interactive.rb` - Test script showing the API
+
+Run the example:
+
+```bash
+cd examples
+ruby sample_app.rb interactive
+```
+
+## How It Works
+
+Thor::Interactive creates a persistent instance of your Thor class and invokes commands on that same instance, preserving any instance variables or class variables between commands. This is different from normal CLI usage where each command starts with a fresh instance.
+
+The shell provides:
+- Tab completion for command names
+- Readline history with persistent storage
+- Proper signal handling (Ctrl+C, Ctrl+D)
+- Help system integration
+- Configurable default handlers for non-commands
+
+## Development
+
+### Getting Started
+
+After checking out the repo:
+
+```bash
+bundle install           # Install dependencies
+bundle exec rspec        # Run full test suite
+bundle exec rake build   # Build gem
+```
+
+### Testing
+
+The gem includes comprehensive tests organized into unit and integration test suites:
+
+```bash
+# Run all tests
+bundle exec rspec
+
+# Run with detailed output
+bundle exec rspec --format documentation
+
+# Run specific test suites
+bundle exec rspec spec/unit/           # Unit tests only
+bundle exec rspec spec/integration/    # Integration tests only
+
+# Run specific test files
+bundle exec rspec spec/unit/shell_spec.rb
+bundle exec rspec spec/integration/shell_integration_spec.rb
+```
+
+#### Test Structure
+
+```
+spec/
+├── spec_helper.rb              # Test configuration and shared setup
+├── support/
+│   ├── test_thor_apps.rb       # Test Thor applications (not packaged)
+│   └── capture_helpers.rb      # Test utilities for I/O capture
+├── unit/                       # Unit tests for individual components
+│   ├── shell_spec.rb           # Thor::Interactive::Shell tests
+│   ├── command_spec.rb         # Thor::Interactive::Command mixin tests
+│   └── completion_spec.rb      # Completion system tests
+└── integration/                # Integration tests for full workflows
+    └── shell_integration_spec.rb # End-to-end interactive shell tests
+```
+
+#### Test Applications
+
+Tests use dedicated Thor applications in `spec/support/test_thor_apps.rb`:
+
+- `SimpleTestApp` - Basic Thor app with simple commands
+- `StatefulTestApp` - App with state persistence and default handlers
+- `SubcommandTestApp` - App with Thor subcommands
+- `OptionsTestApp` - App with various Thor options and arguments
+
+These test apps are excluded from the packaged gem but provide comprehensive test coverage.
+
+### Example Applications
+
+The `examples/` directory contains working examples (these ARE packaged with the gem):
+
+#### Running the Sample Application
+
+```bash
+cd examples
+
+# Run in normal CLI mode
+ruby sample_app.rb help
+ruby sample_app.rb hello World
+ruby sample_app.rb count
+ruby sample_app.rb add "Test item"
+
+# Run in interactive mode
+ruby sample_app.rb interactive
+```
+
+#### Interactive Session Example
+
+```bash
+$ ruby sample_app.rb interactive
+SampleApp Interactive Shell
+Type 'help' for available commands, 'exit' to quit
+
+sample> hello Alice
+Hello Alice!
+
+sample> count
+Count: 1
+
+sample> count
+Count: 2    # Note: state persisted!
+
+sample> add "Buy groceries"
+Added: Buy groceries
+
+sample> add "Walk the dog"
+Added: Walk the dog
+
+sample> list
+1. Buy groceries
+2. Walk the dog
+
+sample> status
+Counter: 2, Items: 2
+
+sample> This is random text that doesn't match a command
+Echo: This is random text that doesn't match a command
+
+sample> help
+Available commands:
+  hello                Say hello to NAME
+  count                Show and increment counter (demonstrates state persistence)
+  add                  Add item to list (demonstrates state persistence)
+  list                 Show all items
+  clear                Clear all items
+  echo                 Echo the text back (used as default handler)
+  status               Show application status
+  interactive          Start an interactive REPL for this application
+
+Special commands:
+  help [COMMAND]       Show help for command
+  exit/quit/q          Exit the REPL
+
+sample> exit
+Goodbye!
+```
+
+#### Key Features Demonstrated
+
+1. **State Persistence**: The counter and items list maintain their values between commands
+2. **Auto-completion**: Try typing `h<TAB>` or `co<TAB>` to see command completion
+3. **Default Handler**: Text that doesn't match a command gets sent to the `echo` command
+4. **Command History**: Use up/down arrows to navigate previous commands
+5. **Error Handling**: Try invalid commands or missing arguments
+6. **Both Modes**: The same application works as traditional CLI and interactive REPL
+
+### Performance Testing
+
+For applications with expensive initialization (like LLM clients), you can measure the performance benefit:
+
+```bash
+# CLI mode - initializes fresh each time
+time ruby sample_app.rb count
+time ruby sample_app.rb count
+time ruby sample_app.rb count
+
+# Interactive mode - initializes once, reuses state
+ruby sample_app.rb interactive
+# Then run: count, count, count
+```
+
+### Debugging
+
+Enable debug mode to see backtraces on errors:
+
+```bash
+DEBUG=1 ruby sample_app.rb interactive
+```
+
+Or in your application:
+
+```ruby
+ENV["DEBUG"] = "1"
+Thor::Interactive.start(MyApp)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/scientist-labs/thor-interactive.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]