pretty_irb 0.1.0

data/QUICK_REFERENCE.md

@@ -0,0 +1,253 @@
+# Pretty IRB - Quick Feature Reference
+
+## 🚀 Quick Start Commands
+
+### History Management (Search & Replay)
+```ruby
+history                    # Show all commands
+history search keyword     # Find past commands
+history last 5            # View recent 5 commands
+history export file.rb    # Save session
+```
+
+### Snippet Manager (Save Code)
+```ruby
+snippet save name "code"   # Store code snippet
+snippet list              # Show all snippets
+snippet load name         # Execute snippet
+snippet search term       # Find snippets
+```
+
+### Variable Inspector (Inspect State)
+```ruby
+vars                      # List all variables
+vars name                # Details on variable
+vars type:String         # Find String variables
+vars memory              # Memory usage report
+```
+
+### Benchmarker (Performance Testing)
+```ruby
+bench "code"             # Benchmark code
+bench compare "a" vs "b" # Compare two approaches
+bench memory "code"      # Memory profiling
+```
+
+### Ruby Cheat Sheet (Quick Reference)
+```ruby
+cheat                    # General reference
+cheat array             # Array methods
+cheat hash              # Hash methods
+cheat string            # String methods
+```
+
+---
+
+## 💡 Real-World Examples
+
+### Example 1: Finding Performance Issues
+
+```ruby
+# 1. Load a function
+snippet save my_func "[1,2,3].each { |x| puts x }"
+
+# 2. Benchmark it
+bench "my_func"
+
+# 3. Try faster version
+bench compare "[1,2,3].each { |x| puts x }" vs "[1,2,3].map { puts _1 }"
+
+# 4. Check memory
+bench memory "[1,2,3].each { |x| puts x }"
+```
+
+### Example 2: Learning New Methods
+
+```ruby
+# 1. View cheatsheet
+cheat array
+
+# 2. Try different methods
+[1,2,3].map { |x| x * 2 }
+
+# 3. Get explanation
+?explain(map)
+
+# 4. See best practices
+?practices(performance)
+```
+
+### Example 3: Session Management
+
+```ruby
+# 1. Work on code
+name = "Ruby"
+scores = [95, 87, 92]
+
+# 2. Inspect variables
+vars
+
+# 3. Search history
+history search scores
+
+# 4. Export everything
+history export my_work.rb
+```
+
+---
+
+## 📋 All New Features Matrix
+
+| Feature | Command | Purpose |
+|---------|---------|---------|
+| **History** | `history` | Search & replay commands |
+| **History Search** | `history search TERM` | Find past commands |
+| **History Export** | `history export FILE` | Save session to file |
+| **Snippet Save** | `snippet save NAME CODE` | Store code patterns |
+| **Snippet List** | `snippet list` | View all saved snippets |
+| **Snippet Load** | `snippet load NAME` | Execute saved snippet |
+| **Variable List** | `vars` | See all variables |
+| **Variable Detail** | `vars NAME` | Inspect specific var |
+| **Variable Search** | `vars search:TERM` | Find variables by name |
+| **Type Filter** | `vars type:String` | Find by type |
+| **Memory Report** | `vars memory` | Usage breakdown |
+| **Benchmark** | `bench CODE` | Performance test |
+| **Compare** | `bench compare A vs B` | Performance comparison |
+| **Memory Profile** | `bench memory CODE` | Memory allocation |
+| **Cheat Sheet** | `cheat` | General reference |
+| **Topic Reference** | `cheat TOPIC` | Topic-specific help |
+
+---
+
+## 🎯 Pro Tips & Tricks
+
+### 1. Fast Learning Loop
+```ruby
+cheat array              # See reference
+[1,2,3].select { |x| x > 1 }  # Try it
+?explain(select)         # Understand it
+?practices(readability)  # Learn best way
+```
+
+### 2. Performance Optimization
+```ruby
+snippet save original "slow_code"
+bench original
+# Make changes...
+bench compare "slow_code" vs "new_code"
+snippet save optimized "new_code"
+```
+
+### 3. Session Export
+```ruby
+# Work on something
+x = 5
+y = x * 2
+
+# Save everything
+history export work_session.rb
+# Now you have all commands in a file!
+```
+
+### 4. Code Reuse
+```ruby
+# Save useful patterns
+snippet save sum_array "arr.reduce(:+)"
+snippet save double_array "arr.map { |x| x * 2 }"
+
+# Later, just load them
+snippet load sum_array
+```
+
+### 5. Memory Analysis
+```ruby
+# Create data
+big_array = (1..10000).to_a
+big_hash = big_array.each_with_index.to_h
+
+# Analyze
+vars memory
+# See which takes more space
+```
+
+---
+
+## 🔍 Troubleshooting
+
+### Snippets not saving?
+- Check `~/.pretty_irb_snippets/` directory exists
+- Ensure write permissions in home directory
+
+### History not showing?
+- History only records during REPL session
+- Export before exiting to save permanently
+
+### Benchmark results vary?
+- First run may be slower (optimization)
+- Try multiple benchmarks for average
+- Close other applications for consistent results
+
+### Variables disappearing?
+- They only exist during current session
+- Use `history export` to save code
+- Use `snippet save` to preserve code
+
+---
+
+## 📊 Feature Comparison
+
+### vs Regular IRB
+- ✅ Pretty colored output
+- ✅ History search & export
+- ✅ Snippet management
+- ✅ Variable inspection
+- ✅ Performance benchmarking
+- ✅ AI learning features
+- ✅ Ruby cheat sheets
+
+### vs Python IPython
+- ✅ Ruby-specific features
+- ✅ Snippet management
+- ✅ AI helper for learning
+- ✅ Cheat sheet integration
+- ✅ Benchmarking built-in
+
+---
+
+## 🚀 Getting Started in 5 Minutes
+
+1. **Start Pretty IRB**
+   ```bash
+   pretty_irb
+   ```
+
+2. **Try a command**
+   ```ruby
+   [1, 2, 3].map { |x| x * 2 }
+   ```
+
+3. **View history**
+   ```ruby
+   history
+   ```
+
+4. **Learn about methods**
+   ```ruby
+   ?explain(map)
+   ```
+
+5. **Save for later**
+   ```ruby
+   snippet save my_snippet "[1, 2, 3].map { |x| x * 2 }"
+   ```
+
+Done! You're now using Pretty IRB's advanced features!
+
+---
+
+## 📚 See Also
+
+- [README.md](README.md) - Main documentation
+- [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) - Detailed feature guide
+- [AI_HELP.md](AI_HELP.md) - AI Helper documentation
+- [AI_QUICK_START.md](AI_QUICK_START.md) - AI learning guide

data/README.md

@@ -0,0 +1,251 @@
+# Pretty IRB - Enhanced Interactive Ruby Shell
+
+A beautiful, feature-rich IRB alternative with:
+
+✨ **Pretty Fonts & Colors** - Beautiful syntax highlighting with colorized output
+🔧 **Auto-Correct** - Smart suggestions for common mistakes using `did_you_mean`
+🤖 **AI Helper** - Learn Ruby methods, best practices, and get code analysis
+📜 **History Manager** - Search and replay command history
+💾 **Snippet Manager** - Save and reuse code snippets
+🔍 **Variable Inspector** - Inspect and analyze variables
+⚡ **Benchmarker** - Performance testing and comparison
+📖 **Ruby Cheat Sheet** - Quick reference for syntax and methods
+⚡ **Enhanced Readline** - Better line editing with history support
+💡 **Helpful Hints** - Smart error messages with correction suggestions
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'pretty_irb'
+```
+
+Or install it yourself:
+
+```bash
+gem install pretty_irb
+```
+
+## Usage
+
+Start the Pretty IRB shell:
+
+```bash
+pretty_irb
+```
+
+Then use it like regular IRB:
+
+```ruby
+pretty_irb >> 1 + 2
+=> 3
+
+pretty_irb >> "hello world".upcase
+=> "HELLO WORLD"
+
+pretty_irb >> [1, 2, 3].map { |x| x * 2 }
+=> [2, 4, 6]
+```
+
+### Commands
+
+#### Basic Commands
+- `exit` or `quit` - Exit the shell
+- `help` - Show available commands
+- `clear` - Clear the screen
+
+#### History Management
+- `history` - Show all command history
+- `history search KEYWORD` - Search history
+- `history last N` - Show last N commands
+- `history export FILE` - Export to file
+- `history clear` - Clear history
+
+#### Snippet Manager
+- `snippet list` - List saved snippets
+- `snippet save NAME CODE` - Save code
+- `snippet load NAME` - Load and execute
+- `snippet show NAME` - View snippet details
+- `snippet delete NAME` - Delete snippet
+- `snippet search KEYWORD` - Search snippets
+
+#### Variable Inspector
+- `vars` - List all variables
+- `vars VARNAME` - Inspect variable
+- `vars type:TYPE` - Find by type
+- `vars search:KEYWORD` - Search variables
+- `vars memory` - Memory usage
+
+#### Benchmarker
+- `bench CODE` - Benchmark code
+- `bench compare CODE1 vs CODE2` - Compare
+- `bench memory CODE` - Profile memory
+
+#### Cheat Sheet
+- `cheat` - Show general cheat sheet
+- `cheat TOPIC` - Topic cheat sheet (array, hash, string, enumerable, file, regex, date)
+
+#### AI Helper
+- `?explain(method)` - Explain a method
+- `?example(topic)` - Get code examples
+- `?debug(code)` - Analyze code
+- `?practices(topic)` - Learn best practices
+- `?ref(keyword)` - Quick reference
+
+## Features
+
+### 1. Syntax Highlighting
+Code is automatically syntax-highlighted with beautiful colors using the Rouge gem.
+
+### 2. Auto-Correct
+Common Ruby errors are automatically corrected and suggestions are provided:
+- Method name typos (`.lenght` → `.length`)
+- Variable name suggestions using `did_you_mean`
+- Helpful error messages
+
+### 3. Pretty Output
+Different data types are displayed with appropriate colors:
+- Strings in blue
+- Numbers in green
+- Booleans in cyan
+- Nil in gray
+- Arrays and Hashes formatted nicely
+
+### 4. AI Helper - Learn Ruby Interactively! 🤖
+
+Get instant help right in your REPL:
+
+```ruby
+# Learn how a method works
+pretty_irb >> ?explain(map)
+
+# Get code examples
+pretty_irb >> ?example(class)
+
+# Learn best practices
+pretty_irb >> ?practices(naming)
+
+# Analyze your code for issues
+pretty_irb >> ?debug("[1,2,3][0]")
+
+# Quick reference
+pretty_irb >> ?ref(operators)
+```
+
+See [AI_HELP.md](AI_HELP.md) for detailed documentation.
+
+### 5. History Manager 📜
+
+Never lose your commands again:
+
+```ruby
+# Search previous commands
+pretty_irb >> history search map
+
+# View recent history
+pretty_irb >> history last 10
+
+# Export for sharing
+pretty_irb >> history export my_session.rb
+```
+
+### 6. Snippet Manager 💾
+
+Save and reuse code patterns:
+
+```ruby
+# Save a useful snippet
+pretty_irb >> snippet save double_array "[1,2,3].map { |x| x * 2 }"
+
+# Load it later
+pretty_irb >> snippet load double_array
+
+# Search your snippets
+pretty_irb >> snippet search array
+```
+
+### 7. Variable Inspector 🔍
+
+Understand your current state:
+
+```ruby
+# List all variables
+pretty_irb >> vars
+
+# Inspect specific variable
+pretty_irb >> vars name
+
+# Find by type
+pretty_irb >> vars type:String
+
+# Memory usage
+pretty_irb >> vars memory
+```
+
+### 8. Benchmarker ⚡
+
+Measure and compare code performance:
+
+```ruby
+# Benchmark code
+pretty_irb >> bench "[1,2,3] * 100"
+
+# Compare implementations
+pretty_irb >> bench compare "(1..100).map { |x| x*2 }" vs "(1..100).collect { |x| x*2 }"
+
+# Profile memory
+pretty_irb >> bench memory "[1,2,3] * 1000"
+```
+
+### 9. Ruby Cheat Sheet 📖
+
+Quick reference without leaving REPL:
+
+```ruby
+# General overview
+pretty_irb >> cheat
+
+# Array methods
+pretty_irb >> cheat array
+
+# String methods
+pretty_irb >> cheat string
+
+# Available topics: array, hash, string, enumerable, file, regex, date
+```
+
+### 10. Enhanced Error Messages
+Errors include color-coded messages and helpful hints:
+```
+NameError: undefined local variable or method `foo'
+💡 Did you mean?: for
+```
+
+## Documentation
+
+- [AI_HELP.md](AI_HELP.md) - AI Helper features and examples
+- [ADVANCED_FEATURES.md](ADVANCED_FEATURES.md) - Advanced features guide with workflows
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+Then run `rake spec` to run the tests.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.
+
+## Inspirations
+
+This gem is inspired by:
+- Ruby's IRB (Interactive Ruby Shell)
+- Python's IPython
+- Node.js's REPL with autocomplete

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/task"
+
+RSpec::Task.new(:spec)
+
+task :default => :spec

data/SETUP.md

@@ -0,0 +1,209 @@
+# Pretty IRB - Setup Guide
+
+## 📦 Installation
+
+### Option 1: Local Development
+
+```bash
+cd c:\Users\Jayesh\Music\ROR\pretty_irb
+bundle install
+```
+
+### Option 2: Install as Gem (for production)
+
+```bash
+gem build pretty_irb.gemspec
+gem install pretty_irb-0.1.0.gem
+```
+
+## 🚀 Running Pretty IRB
+
+### Development Mode
+```bash
+ruby bin/console
+```
+
+### Installed as Gem
+```bash
+pretty_irb
+```
+
+## 📁 Project Structure
+
+```
+pretty_irb/
+├── bin/
+│   ├── console          # Development console
+│   └── setup
+├── exe/
+│   └── pretty_irb       # Executable entry point
+├── lib/
+│   ├── pretty_irb.rb    # Main gem file
+│   └── pretty_irb/
+│       ├── version.rb   # Version info
+│       ├── formatter.rb # Syntax highlighting & output formatting
+│       ├── auto_corrector.rb  # Auto-correct functionality
+│       └── shell.rb     # Main REPL shell
+├── spec/
+│   ├── spec_helper.rb
+│   ├── pretty_irb_spec.rb
+│   ├── formatter_spec.rb
+│   └── auto_corrector_spec.rb
+├── Gemfile              # Dependencies
+├── Rakefile             # Build tasks
+├── pretty_irb.gemspec   # Gem specification
+├── README.md            # Documentation
+└── LICENSE.txt          # MIT License
+```
+
+## ✨ Key Features
+
+### 1. **Syntax Highlighting**
+- Ruby code is automatically highlighted with beautiful colors
+- Uses Rouge gem for lexing
+
+### 2. **Auto-Correct**
+- Common method name typos are fixed automatically
+- `did_you_mean` provides smart suggestions for errors
+- Helpful error messages with fix suggestions
+
+### 3. **Pretty Output**
+- Strings: Light Blue
+- Numbers: Light Green
+- Booleans: Light Cyan
+- Nil: Light Black/Gray
+- Arrays & Hashes: Formatted with colors
+
+### 4. **Enhanced REPL**
+- Customizable prompt
+- Command history
+- Better line editing with Reline
+- `help` command for available commands
+
+## 🔧 Dependencies
+
+```ruby
+irb >= 1.0              # Interactive Ruby shell base
+rouge ~> 3.26           # Syntax highlighting
+colorize ~> 0.8         # Colored output
+did_you_mean ~> 1.5     # Auto-correct suggestions
+reline ~> 0.3           # Enhanced readline
+```
+
+## 💡 Usage Examples
+
+```ruby
+# Start the shell
+$ pretty_irb
+
+pretty_irb >> 1 + 2
+=> 3
+
+pretty_irb >> "hello".upcase
+=> "HELLO"
+
+pretty_irb >> [1, 2, 3].map { |x| x * 2 }
+=> [2, 4, 6]
+
+pretty_irb >> { name: "Ruby", version: 2.7 }
+=> {:name=>"Ruby", :version=>2.7}
+
+# Commands
+pretty_irb >> help        # Show available commands
+pretty_irb >> exit        # Exit the shell
+```
+
+## 🧪 Running Tests
+
+```bash
+cd pretty_irb
+bundle install
+bundle exec rspec
+```
+
+## 📝 Development Notes
+
+### Adding New Auto-Corrections
+
+Edit `lib/pretty_irb/auto_corrector.rb`:
+
+```ruby
+def fix_method_names(code)
+  code.gsub(/\.old_method/, ".new_method")
+end
+```
+
+### Adding New Syntax Colors
+
+Edit `lib/pretty_irb/formatter.rb`:
+
+```ruby
+def colorize_token(token_type, value)
+  case token_type
+  when Rouge::Token::YourToken
+    value.your_color
+  end
+end
+```
+
+## 🐛 Troubleshooting
+
+### Issue: Commands not found
+**Solution**: Make sure the gem is properly installed:
+```bash
+gem list | grep pretty_irb
+```
+
+### Issue: Colors not showing
+**Solution**: Try running with:
+```bash
+export TERM=xterm-256color
+pretty_irb
+```
+
+### Issue: Auto-correct not working
+**Solution**: Check that `did_you_mean` is properly installed:
+```bash
+gem list | grep did_you_mean
+```
+
+## 📚 Next Steps
+
+### Future Enhancements
+
+1. **More Auto-Corrections**
+   - Common Rails methods
+   - String method typos
+   - Common logic errors
+
+2. **Theme Support**
+   - Dark mode
+   - Light mode
+   - Custom themes
+
+3. **Enhanced Features**
+   - Code search history
+   - Snippet support
+   - Plugin system
+
+4. **Performance**
+   - Faster startup time
+   - Caching for frequently used methods
+   - Lazy loading of modules
+
+## 📜 License
+
+MIT License - See LICENSE.txt for details
+
+## 🤝 Contributing
+
+Contributions are welcome! Please:
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Write tests
+5. Submit a pull request
+
+---
+
+For more information, see README.md or visit the GitHub repository.