vibe-sort 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b152ab9be69894b49e7a1324253a4e0a4fe3d5a15ec61f50e8b67b3bd424e8ef
-  data.tar.gz: 7818eebe77421199fefeba102c3986da5e5665155cb7a916500377515a16b505
+  metadata.gz: 2f7d0e027ef929afd808fecba7f64a697a87ff6be489bce20bf9a8da73334847
+  data.tar.gz: b59cb7de762f093a8a5c0ac702841b4bad42d68599a346135a69867af54b6407
 SHA512:
-  metadata.gz: ce32c1524e7afaa485bf600e082fa1bceed852acb617570635c35c2a299a9472f5d8f08df883e76df6e047e1ca1c3e8ca6d3d5d492e8a7bbf104c6d5fb152cfe
-  data.tar.gz: 5b95ce876ce4a67bba1662344b2c46c05ff7d6328708458d571e60f3b2e6d347c7ddb442dfd97103c41699f3d7941d4e901894bb8f9fb29d9c70ab1a4248234a
+  metadata.gz: 53ac2db8b8b227fd151542ed86a350aab7bf6e3a740347cef034348f175465f3e17b7f32b6ca868da4c300bc0ad7b681b5fcdc84375e58838115e0f0d34ec0ac
+  data.tar.gz: 604e37c539b045cf9ecc3ff12a88fa467514506fb9149a2e02d85278f5a2dbd468ecf0cacf9259922dca87d21cdff4fd7f247cfad8dcf5752e5289ae82a2662c

data/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.1] - 2026-07-11
+
+### Changed
+
+- Gemspec summary and description now list all five supported providers (OpenAI, Anthropic Claude, Google Gemini, Groq, SpaceXAI Grok)
+- Added `documentation_uri` and `bug_tracker_uri` gem metadata links
+
 ## [0.3.0] - 2026-07-10
 
 ### Added
@@ -30,7 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Notes
 
 - Fully backward compatible: `VibeSort::Client.new(api_key: ...)` still defaults to OpenAI
-- Still zero runtime dependencies beyond Faraday — all providers are called over plain HTTPS
+- Still zero runtime dependencies beyond Faraday, all providers are called over plain HTTPS
 
 ## [0.2.0] - 2025-10-16
 

data/README.md

@@ -1,35 +1,35 @@
-# 🌀 VibeSort
+# VibeSort
 
 > **AI-powered array sorting using OpenAI, Anthropic Claude, Google Gemini, Groq, or SpaceXAI Grok**
 
-VibeSort is a proof-of-concept Ruby gem that demonstrates sorting arrays by leveraging LLM APIs. Instead of using traditional sorting algorithms, it asks an AI model to do the work! Supports the OpenAI Chat Completions API, the Anthropic Messages API, the Google Gemini API, and the OpenAI-compatible Groq and SpaceXAI (xAI) APIs — with zero dependencies beyond Faraday.
+VibeSort is a proof-of-concept Ruby gem that demonstrates sorting arrays by leveraging LLM APIs. Instead of using traditional sorting algorithms, it asks an AI model to do the work. Supports the OpenAI Chat Completions API, the Anthropic Messages API, the Google Gemini API, and the OpenAI-compatible Groq and SpaceXAI (xAI) APIs, with zero dependencies beyond Faraday.
 
 [![Gem Version](https://badge.fury.io/rb/vibe-sort.svg)](https://badge.fury.io/rb/vibe-sort)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-## ⚠️ Disclaimer
+## Disclaimer
 
-This is a **proof-of-concept** and educational project. It is not intended for production use. Traditional sorting algorithms are far more efficient, reliable, and cost-effective. Use this gem to explore AI capabilities, not to sort arrays in real applications!
+This is a **proof-of-concept** and educational project. It is not intended for production use. Traditional sorting algorithms are far more efficient, reliable, and cost-effective. Use this gem to explore AI capabilities, not to sort arrays in real applications.
 
-## ✨ Features
+## Features
 
-- 🤖 **AI-Powered Sorting**: Uses OpenAI, Anthropic Claude, Google Gemini, Groq, or SpaceXAI Grok models to sort arrays
-- 🔌 **Multi-Provider**: Switch providers with a single `provider:` option — no extra dependencies
-- 🎯 **Simple Interface**: Clean, intuitive API with a single `sort` method
-- 🔧 **Configurable**: Supports custom model and temperature settings
-- 🛡️ **Error Handling**: Comprehensive error handling with clear error messages
-- 📊 **Structured Output**: Uses JSON mode for reliable, parsable responses
-- 🔍 **Type Validation**: Validates input and output to ensure data integrity
-- 📝 **Mixed-Type Support**: Sorts arrays containing integers, floats, and strings
+- **AI-Powered Sorting**: Uses OpenAI, Anthropic Claude, Google Gemini, Groq, or SpaceXAI Grok models to sort arrays
+- **Multi-Provider**: Switch providers with a single `provider:` option, no extra dependencies
+- **Simple Interface**: Clean, intuitive API with a single `sort` method
+- **Configurable**: Supports custom model and temperature settings
+- **Error Handling**: Comprehensive error handling with clear error messages
+- **Structured Output**: Uses JSON mode for reliable, parsable responses
+- **Type Validation**: Validates input and output to ensure data integrity
+- **Mixed-Type Support**: Sorts arrays containing integers, floats, and strings
 
-## ✅ Requirements
+## Requirements
 
 - Ruby **3.0** or newer (MRI)
 - Bundler **2.0+**
-- An API key for at least one supported provider (OpenAI, Anthropic, or Google Gemini)
+- An API key for at least one supported provider (OpenAI, Anthropic, Google Gemini, Groq, or SpaceXAI)
 - Internet connectivity (each sort performs a remote API call)
 
-## 📦 Installation
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -49,7 +49,7 @@ Or install it yourself as:
 gem install vibe-sort
 ```
 
-## ⚡ Quick Start
+## Quick Start
 
 ```bash
 export OPENAI_API_KEY="your-openai-api-key"
@@ -68,7 +68,7 @@ client.sort([34, 1, 'Apple', 8.5])
 # => { success: true, sorted_array: [1, 8.5, 34, "Apple"] }
 ```
 
-## 🚀 Usage
+## Usage
 
 ### Basic Usage
 
@@ -83,12 +83,12 @@ numbers = [34, 1, 99, 15, 8]
 result = client.sort(numbers)
 
 if result[:success]
-  puts "✅ Vibe Sort successful!"
+  puts "Vibe Sort successful!"
   puts "Original: #{numbers}"
   puts "Sorted: #{result[:sorted_array]}"
   # Output: [1, 8, 15, 34, 99]
 else
-  puts "❌ Vibe Sort failed: #{result[:error]}"
+  puts "Vibe Sort failed: #{result[:error]}"
 end
 ```
 
@@ -148,7 +148,7 @@ client = VibeSort::Client.new(provider: :spacexai, api_key: ENV['XAI_API_KEY'])
 | `:groq` | Chat Completions (OpenAI-compatible) | `llama-3.3-70b-versatile` | any Groq-hosted model |
 | `:spacexai` | Chat Completions (OpenAI-compatible) | `grok-4` | e.g. `grok-4.5` |
 
-> **Groq ≠ Grok**: Groq is the independent fast-inference company (`api.groq.com`); Grok is SpaceXAI's model (`api.x.ai`). They are unrelated — VibeSort supports both.
+> **Groq is not Grok**: Groq is the independent fast-inference company (`api.groq.com`); Grok is SpaceXAI's model (`api.x.ai`). They are unrelated, and VibeSort supports both.
 
 ```ruby
 # Pick a specific model
@@ -170,7 +170,7 @@ client = VibeSort::Client.new(
   temperature: 0.0
 )
 
-# Higher temperature = more creative/random (not recommended for sorting!)
+# Higher temperature = more creative/random (not recommended for sorting)
 creative_client = VibeSort::Client.new(
   api_key: ENV['OPENAI_API_KEY'],
   temperature: 0.5
@@ -219,7 +219,7 @@ The `sort` method always returns a hash with the following structure:
 - **Strings only**: Sorted in ascending alphabetical order (case-sensitive)
 - **Mixed types**: Numbers come before strings; each group sorted within itself
 
-## 🏗️ Architecture
+## Architecture
 
 VibeSort follows a clean, modular architecture:
 
@@ -227,18 +227,18 @@ VibeSort follows a clean, modular architecture:
 - **`VibeSort::Configuration`**: Manages provider, API key, model, and settings
 - **`VibeSort::Sorter`**: Dispatches to the configured provider adapter
 - **`VibeSort::Providers::Base`**: Shared prompt, HTTP plumbing (Faraday), and response validation
-- **`VibeSort::Providers::{OpenAI, Anthropic, Gemini}`**: Provider-specific request/response mapping
+- **`VibeSort::Providers::{OpenAI, Anthropic, Gemini, Groq, SpaceXAI}`**: Provider-specific request/response mapping
 - **`VibeSort::ApiError`**: Custom exception for API-related errors
 
 See the [Architecture Documentation](docs/architecture.md) for more details.
 
-## 📚 Documentation
+## Documentation
 
 - [Architecture Overview](docs/architecture.md)
 - [API Reference](docs/api_reference.md)
 - [Development Guide](docs/development.md)
 
-## 🧪 Development
+## Development
 
 After checking out the repo, run `bin/setup` 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.
 
@@ -266,33 +266,33 @@ bundle exec rspec --format documentation
 bundle exec rspec spec/vibe/sort_spec.rb
 ```
 
-## 🤔 Why Does This Exist?
+## Why Does This Exist?
 
 This gem was created as an educational exercise to:
 
 1. Explore the capabilities and limitations of LLMs for computational tasks
-2. Demonstrate how to integrate OpenAI's API into Ruby applications
+2. Demonstrate how to integrate LLM APIs into Ruby applications
 3. Provide a template for building Ruby gems with external API dependencies
 4. Spark conversations about appropriate use cases for AI
 
-**Please note**: This is intentionally inefficient and expensive compared to traditional sorting algorithms. It's a conversation starter, not a production solution!
+**Please note**: This is intentionally inefficient and expensive compared to traditional sorting algorithms. It's a conversation starter, not a production solution.
 
-## ⚡ Performance Considerations
+## Performance Considerations
 
 - **Latency**: Each sort requires an API call (typically 1-3 seconds)
-- **Cost**: OpenAI API usage is metered and costs money
+- **Cost**: LLM API usage is metered and costs money
 - **Reliability**: Depends on API availability and internet connection
 - **Accuracy**: Generally accurate, but not guaranteed (unlike algorithmic sorting)
 - **Scale**: Not suitable for large arrays or high-frequency sorting
 
 Traditional sorting (e.g., Ruby's `Array#sort`) is:
 
-- ⚡ **10,000x faster** (microseconds vs seconds)
-- 💰 **Free** (no API costs)
-- 🎯 **100% reliable** (deterministic algorithm)
-- 📈 **Scalable** (handles millions of elements)
+- **10,000x faster** (microseconds vs seconds)
+- **Free** (no API costs)
+- **100% reliable** (deterministic algorithm)
+- **Scalable** (handles millions of elements)
 
-## 🔑 Environment Variables
+## Environment Variables
 
 Set the API key for your chosen provider as an environment variable:
 
@@ -315,16 +315,16 @@ require 'dotenv/load'
 client = VibeSort::Client.new(api_key: ENV['OPENAI_API_KEY'])
 ```
 
-## 📄 License
+## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## 🙏 Acknowledgments
+## Acknowledgments
 
 - Built with [Faraday](https://lostisland.github.io/faraday/) for HTTP requests
-- Powered by [OpenAI](https://openai.com/), [Anthropic](https://www.anthropic.com/), and [Google Gemini](https://ai.google.dev/) models
+- Powered by [OpenAI](https://openai.com/), [Anthropic](https://www.anthropic.com/), [Google Gemini](https://ai.google.dev/), [Groq](https://groq.com/), and [SpaceXAI](https://x.ai/) models
 - Inspired by the absurdity and creativity of the AI era
 
 ---
 
-**Remember**: With great AI power comes great responsibility (and API bills). Sort wisely! 🧙‍♂️
+**Remember**: With great AI power comes great responsibility (and API bills). Sort wisely.

data/docs/IMPLEMENTATION_PLAN.md

@@ -4,7 +4,7 @@
 
 This document outlines the complete implementation plan for the **VibeSort** Ruby gem - a proof-of-concept library that sorts number arrays using the OpenAI Chat Completions API.
 
-**Status:** ✅ Complete (All tasks finished)
+**Status:**  Complete (All tasks finished)
 
 **Version:** 0.1.0
 
@@ -16,23 +16,23 @@ This document outlines the complete implementation plan for the **VibeSort** Rub
 
 ### Primary Goals
 
-1. ✅ Create a functional Ruby gem that sorts arrays via OpenAI API
-2. ✅ Demonstrate AI integration in Ruby applications
-3. ✅ Provide clean, well-documented code as a learning resource
-4. ✅ Follow Ruby gem best practices and conventions
+1.  Create a functional Ruby gem that sorts arrays via OpenAI API
+2.  Demonstrate AI integration in Ruby applications
+3.  Provide clean, well-documented code as a learning resource
+4.  Follow Ruby gem best practices and conventions
 
 ### Non-Goals
 
-- ❌ Production-ready sorting solution (this is a proof-of-concept)
-- ❌ Performance optimization (intentionally uses AI for education)
-- ❌ Support for non-numeric data types
-- ❌ Local sorting fallback (requires API)
+-  Production-ready sorting solution (this is a proof-of-concept)
+-  Performance optimization (intentionally uses AI for education)
+-  Support for non-numeric data types
+-  Local sorting fallback (requires API)
 
 ---
 
 ## Implementation Checklist
 
-### Phase 1: Project Setup ✅
+### Phase 1: Project Setup 
 
 - [x] Initialize gem structure with Bundler
 - [x] Configure gemspec with metadata and dependencies
@@ -40,7 +40,7 @@ This document outlines the complete implementation plan for the **VibeSort** Rub
 - [x] Configure RSpec for testing
 - [x] Add development dependencies (pry for debugging)
 
-### Phase 2: Core Implementation ✅
+### Phase 2: Core Implementation 
 
 - [x] **VibeSort::Configuration** - API key and settings management
   - API key validation
@@ -70,7 +70,7 @@ This document outlines the complete implementation plan for the **VibeSort** Rub
   - Load all components
   - Namespace definition
 
-### Phase 3: Documentation ✅
+### Phase 3: Documentation 
 
 - [x] **README.md** - User-facing documentation
   - Installation instructions
@@ -174,13 +174,13 @@ This document outlines the complete implementation plan for the **VibeSort** Rub
 ```
 vibe-sort/
 ├── lib/
-│   ├── vibe_sort.rb              ✅ Main entry point
+│   ├── vibe_sort.rb               Main entry point
 │   └── vibe_sort/
-│       ├── client.rb             ✅ Public API
-│       ├── configuration.rb      ✅ Config object
-│       ├── error.rb              ✅ Custom exceptions
-│       ├── sorter.rb             ✅ API communication
-│       └── version.rb            ✅ Version constant
+│       ├── client.rb              Public API
+│       ├── configuration.rb       Config object
+│       ├── error.rb               Custom exceptions
+│       ├── sorter.rb              API communication
+│       └── version.rb             Version constant
 ├── spec/
 │   ├── spec_helper.rb            ⏳ To be implemented
 │   └── vibe_sort/
@@ -189,19 +189,19 @@ vibe-sort/
 │       ├── sorter_spec.rb        ⏳ To be implemented
 │       └── integration_spec.rb   ⏳ To be implemented
 ├── docs/
-│   ├── README.md                 ✅ Documentation index
-│   ├── architecture.md           ✅ Architecture guide
-│   ├── api_reference.md          ✅ API documentation
-│   └── development.md            ✅ Development guide
+│   ├── README.md                  Documentation index
+│   ├── architecture.md            Architecture guide
+│   ├── api_reference.md           API documentation
+│   └── development.md             Development guide
 ├── bin/
-│   ├── console                   ✅ Interactive console
-│   └── setup                     ✅ Setup script
-├── Gemfile                       ✅ Dependencies
-├── Rakefile                      ✅ Rake tasks
-├── vibe-sort.gemspec             ✅ Gem specification
-├── README.md                     ✅ User documentation
-├── CHANGELOG.md                  ✅ Version history
-└── LICENSE.txt                   ✅ MIT License
+│   ├── console                    Interactive console
+│   └── setup                      Setup script
+├── Gemfile                        Dependencies
+├── Rakefile                       Rake tasks
+├── vibe-sort.gemspec              Gem specification
+├── README.md                      User documentation
+├── CHANGELOG.md                   Version history
+└── LICENSE.txt                    MIT License
 ```
 
 ---
@@ -299,26 +299,26 @@ client = VibeSort::Client.new(
 
 ### API Key Management
 
-✅ **Implemented:**
+ **Implemented:**
 - Environment variable support
 - Configuration validation
 - No hardcoded keys in examples
 
-⚠️ **User Responsibility:**
+ **User Responsibility:**
 - Store keys securely
 - Use .env files (not committed)
 - Rotate keys regularly
 
 ### Input Validation
 
-✅ **Implemented:**
+ **Implemented:**
 - Type checking (must be Array)
 - Element validation (must be Numeric)
 - Empty array rejection
 
 ### Output Validation
 
-✅ **Implemented:**
+ **Implemented:**
 - Response structure validation
 - Type checking on sorted array
 - Numeric value verification
@@ -366,7 +366,7 @@ client = VibeSort::Client.new(
 
 ## Release Plan
 
-### Version 0.1.0 (Initial Release) ✅
+### Version 0.1.0 (Initial Release) 
 
 **Release Date:** October 16, 2025
 
@@ -408,7 +408,7 @@ client = VibeSort::Client.new(
 
 ## Success Criteria
 
-### Functional Requirements ✅
+### Functional Requirements 
 
 - [x] Successfully sort arrays of numbers
 - [x] Handle invalid inputs gracefully
@@ -416,7 +416,7 @@ client = VibeSort::Client.new(
 - [x] Integrate with OpenAI API
 - [x] Support configuration options
 
-### Non-Functional Requirements ✅
+### Non-Functional Requirements 
 
 - [x] Clear, comprehensive documentation
 - [x] Clean, readable code
@@ -424,7 +424,7 @@ client = VibeSort::Client.new(
 - [x] Ruby gem best practices
 - [x] MIT License
 
-### Documentation Requirements ✅
+### Documentation Requirements 
 
 - [x] Installation instructions
 - [x] Usage examples
@@ -441,39 +441,39 @@ client = VibeSort::Client.new(
 
 | Risk | Impact | Mitigation | Status |
 |------|--------|------------|--------|
-| API rate limits | High | Document limits, add retry logic | ⚠️ Documented |
-| API downtime | High | Graceful error handling | ✅ Implemented |
-| API changes | Medium | Version pinning, monitoring | ⚠️ Documented |
-| Cost overruns | Medium | Cost warnings in docs | ✅ Documented |
-| Network issues | Medium | Timeout handling | ✅ Implemented |
+| API rate limits | High | Document limits, add retry logic |  Documented |
+| API downtime | High | Graceful error handling |  Implemented |
+| API changes | Medium | Version pinning, monitoring |  Documented |
+| Cost overruns | Medium | Cost warnings in docs |  Documented |
+| Network issues | Medium | Timeout handling |  Implemented |
 
 ### Business Risks
 
 | Risk | Impact | Mitigation | Status |
 |------|--------|------------|--------|
-| Misuse in production | Low | Clear disclaimers | ✅ Documented |
-| API cost complaints | Low | Cost transparency | ✅ Documented |
-| Performance expectations | Low | Performance warnings | ✅ Documented |
+| Misuse in production | Low | Clear disclaimers |  Documented |
+| API cost complaints | Low | Cost transparency |  Documented |
+| Performance expectations | Low | Performance warnings |  Documented |
 
 ---
 
 ## Lessons Learned
 
-### What Went Well ✅
+### What Went Well 
 
 1. Clean architecture with separation of concerns
 2. Comprehensive documentation from the start
 3. Consistent error handling strategy
 4. Simple, intuitive API design
 
-### What Could Be Improved 🔄
+### What Could Be Improved 
 
 1. Test suite should have been implemented first (TDD)
 2. CI/CD pipeline not yet set up
 3. No integration with GitHub Actions
 4. Missing code coverage reporting
 
-### Best Practices Applied 🌟
+### Best Practices Applied 
 
 1. **Separation of Concerns:** Client, Configuration, Sorter, Error
 2. **Dependency Injection:** Configuration passed to Sorter
@@ -513,7 +513,7 @@ client = VibeSort::Client.new(
 
 The VibeSort gem v0.1.0 is complete and ready for release. All core functionality has been implemented, tested manually, and thoroughly documented. The gem serves as both a proof-of-concept for AI integration and an educational resource for Ruby developers.
 
-**Status:** ✅ Ready for Release
+**Status:**  Ready for Release
 
 **Next Milestone:** v0.2.0 with comprehensive test suite
 

data/docs/README.md

@@ -2,7 +2,7 @@
 
 Welcome to the VibeSort documentation! This directory contains comprehensive guides for using, understanding, and contributing to the VibeSort gem.
 
-## 📚 Documentation Overview
+## Documentation Overview
 
 ### [Architecture Overview](architecture.md)
 
@@ -52,7 +52,7 @@ Welcome to the VibeSort documentation! This directory contains comprehensive gui
 
 ---
 
-## 🚀 Quick Links
+## Quick Links
 
 ### For Users
 
@@ -76,7 +76,7 @@ Welcome to the VibeSort documentation! This directory contains comprehensive gui
 
 ---
 
-## 📖 Reading Guide
+## Reading Guide
 
 ### I want to use VibeSort in my project
 
@@ -107,25 +107,25 @@ Welcome to the VibeSort documentation! This directory contains comprehensive gui
 
 ---
 
-## 🏗️ Architecture at a Glance
+## Architecture at a Glance
 
 ```
 User Application
-      ↓
+      
 VibeSort::Client (validates input, handles errors)
-      ↓
+      
 VibeSort::Configuration (stores API key, settings)
-      ↓
+      
 VibeSort::Sorter (communicates with OpenAI)
-      ↓
+      
 OpenAI API (GPT model processes request)
-      ↓
+      
 Sorted Array (returned to user)
 ```
 
 ---
 
-## 📝 Example Usage
+## Example Usage
 
 ```ruby
 require 'vibe_sort'
@@ -148,7 +148,7 @@ For more examples, see the [README](../README.md) or [API Reference](api_referen
 
 ---
 
-## 🔧 Key Concepts
+## Key Concepts
 
 ### Configuration
 
@@ -175,7 +175,7 @@ VibeSort never raises exceptions to user code. All errors are caught and returne
 
 ---
 
-## 🤝 Contributing
+## Contributing
 
 We welcome contributions! Please see:
 
@@ -185,22 +185,22 @@ We welcome contributions! Please see:
 
 ---
 
-## 📞 Support
+## Support
 
-- 🐛 [Report a Bug](https://github.com/chayut/vibe-sort/issues/new?labels=bug)
-- 💡 [Request a Feature](https://github.com/chayut/vibe-sort/issues/new?labels=enhancement)
-- 📖 [Read the Docs](README.md)
-- 💬 [Discussions](https://github.com/chayut/vibe-sort/discussions)
+-  [Report a Bug](https://github.com/chayut/vibe-sort/issues/new?labels=bug)
+-  [Request a Feature](https://github.com/chayut/vibe-sort/issues/new?labels=enhancement)
+-  [Read the Docs](README.md)
+-  [Discussions](https://github.com/chayut/vibe-sort/discussions)
 
 ---
 
-## 📜 License
+## License
 
 VibeSort is released under the [MIT License](../LICENSE.txt).
 
 ---
 
-## 🙏 Acknowledgments
+## Acknowledgments
 
 - Built with [Faraday](https://lostisland.github.io/faraday/)
 - Powered by [OpenAI](https://openai.com/)
@@ -208,4 +208,4 @@ VibeSort is released under the [MIT License](../LICENSE.txt).
 
 ---
 
-**Happy Sorting! 🌀**
+**Happy Sorting! **

data/docs/architecture.md

@@ -119,11 +119,11 @@ VibeSort follows a layered architecture with clear separation of concerns:
 **Adapter hooks** (implemented per provider): `provider_name`, `endpoint`, `headers`, `build_payload`, `extract_content`
 
 **Adapters and default models**:
-- `Providers::OpenAI` — Chat Completions, `gpt-4o-mini`
-- `Providers::Anthropic` — Messages API with structured outputs (JSON schema), `claude-opus-4-8`
-- `Providers::Gemini` — generateContent with JSON response mode, `gemini-2.5-flash`
-- `Providers::Groq` — OpenAI-compatible (subclasses `Providers::OpenAI`), `llama-3.3-70b-versatile`
-- `Providers::SpaceXAI` — OpenAI-compatible (subclasses `Providers::OpenAI`), `grok-4`
+- `Providers::OpenAI`: Chat Completions, `gpt-4o-mini`
+- `Providers::Anthropic`: Messages API with structured outputs (JSON schema), `claude-opus-4-8`
+- `Providers::Gemini`: generateContent with JSON response mode, `gemini-2.5-flash`
+- `Providers::Groq`: OpenAI-compatible (subclasses `Providers::OpenAI`), `llama-3.3-70b-versatile`
+- `Providers::SpaceXAI`: OpenAI-compatible (subclasses `Providers::OpenAI`), `grok-4`
 
 ### VibeSort::ApiError
 
@@ -244,7 +244,7 @@ VibeSort follows a layered architecture with clear separation of concerns:
 ## Dependencies
 
 ### Runtime
-- **faraday** (~> 2.0): HTTP client library — the only runtime dependency; all providers are called over plain HTTPS
+- **faraday** (~> 2.0): HTTP client library, the only runtime dependency; all providers are called over plain HTTPS
 
 ### Development
 - **rspec** (~> 3.0): Testing framework

data/docs/development.md

@@ -521,8 +521,8 @@ Document all public methods:
 # @return [Hash] Result hash with :success, :sorted_array, :error keys
 #
 # @example
-#   client.sort([5, 2, 8])
-#   # => { success: true, sorted_array: [2, 5, 8] }
+# client.sort([5, 2, 8])
+# # => { success: true, sorted_array: [2, 5, 8] }
 def sort(array)
   # ...
 end
@@ -563,4 +563,4 @@ Before submitting a PR:
 - Read the documentation
 - Ask in the community
 
-Happy coding! 🚀
+Happy coding! 

data/docs/v0.2.0_UPDATE.md

@@ -6,23 +6,23 @@ VibeSort has been updated to **version 0.2.0** with support for sorting arrays c
 
 ---
 
-## 🎯 What Changed
+## What Changed
 
 ### Core Functionality
 
 #### Before (v0.1.0)
-- ✅ Sort arrays of numbers (integers and floats)
-- ❌ Strings not supported
-- ❌ Mixed-type arrays rejected
+-  Sort arrays of numbers (integers and floats)
+-  Strings not supported
+-  Mixed-type arrays rejected
 
 #### After (v0.2.0)
-- ✅ Sort arrays of numbers (integers and floats)
-- ✅ Sort arrays of strings (case-sensitive)
-- ✅ Sort mixed-type arrays (numbers + strings)
+-  Sort arrays of numbers (integers and floats)
+-  Sort arrays of strings (case-sensitive)
+-  Sort mixed-type arrays (numbers + strings)
 
 ---
 
-## 📝 Technical Changes
+## Technical Changes
 
 ### 1. Input Validation (`VibeSort::Client`)
 
@@ -114,7 +114,7 @@ end
 
 ---
 
-## 🚀 New Usage Examples
+## New Usage Examples
 
 ### Sorting Strings
 
@@ -141,24 +141,24 @@ puts result[:sorted_array]
 
 ---
 
-## 📋 Sorting Rules
+## Sorting Rules
 
 The AI follows these standard sorting conventions:
 
 1. **Numbers Only**: Ascending numerical order
-   - `[5, 2, 8, 1]` → `[1, 2, 5, 8]`
+   - `[5, 2, 8, 1]`  `[1, 2, 5, 8]`
 
 2. **Strings Only**: Ascending alphabetical order (case-sensitive)
-   - `["banana", "Apple", "cherry"]` → `["Apple", "banana", "cherry"]`
+   - `["banana", "Apple", "cherry"]`  `["Apple", "banana", "cherry"]`
    - Capital letters come before lowercase in ASCII ordering
 
 3. **Mixed Types**: Numbers first, then strings
-   - `[42, "hello", 8, "world"]` → `[8, 42, "hello", "world"]`
+   - `[42, "hello", 8, "world"]`  `[8, 42, "hello", "world"]`
    - Each group is sorted within itself
 
 ---
 
-## 📚 Documentation Updates
+## Documentation Updates
 
 ### Updated Files
 
@@ -185,7 +185,7 @@ The AI follows these standard sorting conventions:
 
 ---
 
-## ✅ Backward Compatibility
+## Backward Compatibility
 
 **Good News:** This update is **fully backward compatible**!
 
@@ -203,7 +203,7 @@ result = client.sort([5, 2, 8, 1, 9])
 
 ---
 
-## 🧪 Testing Recommendations
+## Testing Recommendations
 
 When upgrading to v0.2.0, test these scenarios:
 
@@ -237,7 +237,7 @@ client.sort([1, { key: "value" }]) # Contains hash
 
 ---
 
-## 🔍 Implementation Notes
+## Implementation Notes
 
 ### Why These Changes?
 
@@ -263,27 +263,27 @@ The OpenAI GPT model (gpt-3.5-turbo-1106) handles mixed-type sorting intelligent
 
 ---
 
-## 🎨 Architecture Remains Clean
+## Architecture Remains Clean
 
 The core architecture is unchanged:
 
 ```
 User Application
-      ↓
+      
 VibeSort::Client (validates input)
-      ↓
+      
 VibeSort::Configuration (stores settings)
-      ↓
+      
 VibeSort::Sorter (communicates with OpenAI)
-      ↓
+      
 OpenAI API (processes request)
-      ↓
+      
 Sorted Array (returned to user)
 ```
 
 ---
 
-## 📦 Upgrade Instructions
+## Upgrade Instructions
 
 ### Using Bundler
 
@@ -307,7 +307,7 @@ gem install vibe-sort -v 0.2.0
 
 ---
 
-## 🐛 Known Limitations
+## Known Limitations
 
 Same limitations as v0.1.0:
 
@@ -326,7 +326,7 @@ Same limitations as v0.1.0:
 
 ---
 
-## 🔮 Future Enhancements
+## Future Enhancements
 
 Potential features for future versions:
 
@@ -348,27 +348,27 @@ Potential features for future versions:
 
 ---
 
-## 📞 Support
+## Support
 
-- 🐛 [Report Issues](https://github.com/chayut/vibe-sort/issues)
-- 💡 [Feature Requests](https://github.com/chayut/vibe-sort/issues/new?labels=enhancement)
-- 📖 [Documentation](https://github.com/chayut/vibe-sort/tree/main/docs)
+-  [Report Issues](https://github.com/chayut/vibe-sort/issues)
+-  [Feature Requests](https://github.com/chayut/vibe-sort/issues/new?labels=enhancement)
+-  [Documentation](https://github.com/chayut/vibe-sort/tree/main/docs)
 
 ---
 
-## ✨ Summary
+## Summary
 
 Version 0.2.0 expands VibeSort's capabilities while maintaining:
 
-- ✅ Same clean API
-- ✅ Same architecture
-- ✅ Full backward compatibility
-- ✅ Same performance characteristics
-- ✅ Comprehensive documentation
+-  Same clean API
+-  Same architecture
+-  Full backward compatibility
+-  Same performance characteristics
+-  Comprehensive documentation
 
 The gem now handles a wider variety of data types, making it more versatile for educational purposes and demonstrations.
 
-**Happy Sorting!** 🌀
+**Happy Sorting!** 
 
 ---
 

data/lib/vibe_sort/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VibeSort
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vibe-sort
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Chayut Orapinpatipat
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-10 00:00:00.000000000 Z
+date: 2026-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -25,8 +25,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 description: A proof-of-concept Ruby gem that sorts arrays by leveraging LLM APIs
-  (OpenAI Chat Completions, Anthropic Messages, Google Gemini). Demonstrates how AI
-  can be used for computational tasks.
+  (OpenAI Chat Completions, Anthropic Messages, Google Gemini, and the OpenAI-compatible
+  Groq and SpaceXAI Grok APIs). Demonstrates how AI can be used for computational
+  tasks.
 email:
 - chayut_o@hotmail.com
 executables: []
@@ -65,6 +66,8 @@ metadata:
   homepage_uri: https://github.com/chayuto/vibe-sort
   source_code_uri: https://github.com/chayuto/vibe-sort
   changelog_uri: https://github.com/chayuto/vibe-sort/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/vibe-sort
+  bug_tracker_uri: https://github.com/chayuto/vibe-sort/issues
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -84,5 +87,6 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: AI-powered array sorting using OpenAI, Anthropic Claude, or Google Gemini
+summary: AI-powered array sorting using OpenAI, Anthropic Claude, Google Gemini, Groq,
+  or SpaceXAI Grok
 test_files: []