girb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16db97a82963a642f3816a1083664d3434e94a8bbe6c589ef21cc2da21d0ba46
+  data.tar.gz: f1bb07ca19f8c2af6d11cb0ba37738e9948a0bc0f286e38494a00bc7113ce482
+SHA512:
+  metadata.gz: ae327ef4bd1ac6d9cdfdf18a2135707ab6959a9af1390737a2e02bc4fc05dd586469d4196d94136b37d140c405dae379d2d987dd30dfb70253aa507637864cd7
+  data.tar.gz: ab3de747ee65f5d5d77e72203261f0a2c110e6c3d5fa5b39a299aded75f38d64e6de91ce1ce854a3044556c57b8d28933663afca13ce5159b8006f4f38fea427

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## [0.1.0] - 2025-02-02
+
+### Added
+
+- Initial release
+- AI-powered IRB assistant with `qq` command
+- Provider-agnostic architecture supporting multiple LLM backends
+- Tools: evaluate_code, read_file, find_file, get_source, inspect_object, list_methods
+- Rails integration with model inspection tools
+- Session history support
+- Exception capture and context building
+- Custom prompt configuration
+- Debug mode

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Rira
+
+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,253 @@
+# girb (Generative IRB)
+
+An AI assistant embedded in your IRB session. It understands your runtime context and helps with debugging and development.
+
+[日本語版 README](README_ja.md)
+
+## Features
+
+- **Context Awareness**: Automatically understands local variables, instance variables, and self object
+- **Exception Capture**: Automatically captures recent exceptions - just ask "why did this fail?" after an error
+- **Session History Understanding**: Tracks IRB input history and understands conversation flow
+- **Tool Execution**: AI autonomously executes code, inspects objects, and retrieves source code
+- **Multi-language Support**: Detects user's language and responds in the same language
+- **Customizable**: Add custom prompts for project-specific instructions
+- **Provider Agnostic**: Use any LLM provider or implement your own
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'girb'
+gem 'girb-ruby_llm'  # or girb-gemini
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install girb girb-ruby_llm
+```
+
+Set the provider via environment variable:
+
+```bash
+export GIRB_PROVIDER=girb-ruby_llm
+```
+
+## Providers
+
+Currently available providers:
+
+- [girb-ruby_llm](https://github.com/rira100000000/girb-ruby_llm) - Multiple providers via RubyLLM (OpenAI, Anthropic, Gemini, Ollama, etc.)
+- [girb-gemini](https://github.com/rira100000000/girb-gemini) - Google Gemini
+
+You can also [create your own provider](#custom-providers).
+
+## Setup
+
+### Using girb-ruby_llm (Recommended)
+
+girb-ruby_llm supports multiple LLM providers through RubyLLM.
+
+```bash
+# Install
+gem install girb girb-ruby_llm
+
+# Set provider and API key
+export GIRB_PROVIDER=girb-ruby_llm
+export GEMINI_API_KEY=your-api-key  # or OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.
+```
+
+See [girb-ruby_llm README](https://github.com/rira100000000/girb-ruby_llm) for detailed configuration.
+
+### Using girb-gemini
+
+```bash
+# Install
+gem install girb girb-gemini
+
+# Set provider and API key
+export GIRB_PROVIDER=girb-gemini
+export GEMINI_API_KEY=your-api-key
+```
+
+## Usage
+
+### Quick Start
+
+```bash
+girb
+```
+
+Or add to your `~/.irbrc` for automatic loading with regular `irb`:
+
+```ruby
+require 'girb-ruby_llm'  # or 'girb-gemini'
+```
+
+### Debug with binding.girb
+
+Insert `binding.girb` in your code:
+
+```ruby
+def problematic_method
+  result = some_calculation
+  binding.girb  # AI-powered IRB starts here
+  result
+end
+```
+
+### How to Ask AI
+
+#### Method 1: Ctrl+Space
+
+Press `Ctrl+Space` after typing to send your input as a question to AI.
+
+```
+irb(main):001> What's causing this error?[Ctrl+Space]
+```
+
+#### Method 2: qq command
+
+```
+irb(main):001> qq "How do I use this method?"
+```
+
+## Configuration Options
+
+Add to your `~/.irbrc`:
+
+```ruby
+require 'girb-ruby_llm'
+
+Girb.configure do |c|
+  # Debug output (default: false)
+  c.debug = true
+
+  # Custom prompt (optional)
+  c.custom_prompt = <<~PROMPT
+    This is a production environment. Always confirm before destructive operations.
+  PROMPT
+end
+```
+
+### Command Line Options
+
+```bash
+girb --debug    # Enable debug output
+girb -d         # Same as above
+girb --help     # Show help
+```
+
+### Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `GIRB_PROVIDER` | **Required.** Provider gem to load (e.g., `girb-ruby_llm`, `girb-gemini`) |
+| `GIRB_DEBUG` | Set to `1` to enable debug output |
+
+## Available Tools
+
+| Tool | Description |
+|------|-------------|
+| `evaluate_code` | Execute Ruby code in IRB context |
+| `inspect_object` | Inspect object details |
+| `get_source` | Get source code of methods or classes |
+| `list_methods` | List methods of an object |
+| `find_file` | Search for files in the project |
+| `read_file` | Read file contents |
+| `session_history` | Get IRB session history |
+
+### Additional Tools in Rails Environment
+
+| Tool | Description |
+|------|-------------|
+| `query_model` | Execute queries on ActiveRecord models |
+| `model_info` | Get model schema information |
+
+## Custom Providers
+
+Implement your own LLM provider:
+
+```ruby
+class MyProvider < Girb::Providers::Base
+  def initialize(api_key:)
+    @api_key = api_key
+  end
+
+  def chat(messages:, system_prompt:, tools:)
+    # messages: Array of { role: :user/:assistant/:tool_call/:tool_result, content: "..." }
+    # tools: Array of { name: "...", description: "...", parameters: {...} }
+
+    # Call your LLM API here
+    response = call_my_llm(messages, system_prompt, tools)
+
+    # Return a Response object
+    Girb::Providers::Base::Response.new(
+      text: response.text,
+      function_calls: response.tool_calls&.map { |tc| { name: tc.name, args: tc.args } }
+    )
+  end
+end
+
+Girb.configure do |c|
+  c.provider = MyProvider.new(api_key: ENV['MY_API_KEY'])
+end
+```
+
+Then run with:
+
+```bash
+GIRB_PROVIDER=my_provider girb
+```
+
+## Examples
+
+### Debugging Assistance
+
+```
+irb(main):001> user = User.find(1)
+irb(main):002> user.update(name: "test")
+=> false
+irb(main):003> Why did the update fail?[Ctrl+Space]
+Checking `user.errors.full_messages` shows validation errors:
+- "Email can't be blank"
+The email might be getting cleared when updating the name.
+```
+
+### Code Understanding
+
+```
+irb(main):001> Where is the User model defined in this project?[Ctrl+Space]
+It's defined in app/models/user.rb.
+```
+
+### Pattern Recognition
+
+```
+irb(main):001> a = 1
+irb(main):002> b = 2
+irb(main):003> What would z be if I continue with c = 3 and beyond?[Ctrl+Space]
+Following the pattern a=1, b=2, c=3..., z would be 26.
+```
+
+## Requirements
+
+- Ruby 3.2.0 or higher
+- IRB 1.6.0 or higher
+- An LLM provider gem (girb-ruby_llm or girb-gemini)
+
+## License
+
+MIT License
+
+## Contributing
+
+Bug reports and feature requests are welcome at [GitHub Issues](https://github.com/rira100000000/girb/issues).

data/README_ja.md

@@ -0,0 +1,251 @@
+# girb (Generative IRB)
+
+IRBセッションに組み込まれたAIアシスタント。実行中のコンテキストを理解し、デバッグや開発を支援します。
+
+## 特徴
+
+- **コンテキスト認識**: ローカル変数、インスタンス変数、selfオブジェクトなどを自動的に把握
+- **例外キャプチャ**: 直前の例外を自動キャプチャ - エラー後に「なぜ失敗した？」と聞くだけでOK
+- **セッション履歴の理解**: IRBでの入力履歴を追跡し、会話の流れを理解
+- **ツール実行**: コードの実行、オブジェクトの検査、ソースコードの取得などをAIが自律的に実行
+- **多言語対応**: ユーザーの言語を検出し、同じ言語で応答
+- **カスタマイズ可能**: 独自のプロンプトを追加して、プロジェクト固有の指示を設定可能
+- **プロバイダー非依存**: 任意のLLMプロバイダーを使用、または独自実装が可能
+
+## インストール
+
+Gemfileに追加:
+
+```ruby
+gem 'girb'
+gem 'girb-ruby_llm'  # または girb-gemini
+```
+
+そして実行:
+
+```bash
+bundle install
+```
+
+または直接インストール:
+
+```bash
+gem install girb girb-ruby_llm
+```
+
+環境変数でプロバイダーを設定:
+
+```bash
+export GIRB_PROVIDER=girb-ruby_llm
+```
+
+## プロバイダー
+
+現在利用可能なプロバイダー:
+
+- [girb-ruby_llm](https://github.com/rira100000000/girb-ruby_llm) - RubyLLM経由で複数プロバイダー対応（OpenAI、Anthropic、Gemini、Ollama等）
+- [girb-gemini](https://github.com/rira100000000/girb-gemini) - Google Gemini
+
+[独自プロバイダーの作成](#カスタムプロバイダー)も可能です。
+
+## セットアップ
+
+### girb-ruby_llmを使用する場合（推奨）
+
+girb-ruby_llmはRubyLLMを通じて複数のLLMプロバイダーをサポートしています。
+
+```bash
+# インストール
+gem install girb girb-ruby_llm
+
+# プロバイダーとAPIキーを設定
+export GIRB_PROVIDER=girb-ruby_llm
+export GEMINI_API_KEY=your-api-key  # または OPENAI_API_KEY、ANTHROPIC_API_KEY 等
+```
+
+詳細な設定については [girb-ruby_llm README](https://github.com/rira100000000/girb-ruby_llm) を参照してください。
+
+### girb-geminiを使用する場合
+
+```bash
+# インストール
+gem install girb girb-gemini
+
+# プロバイダーとAPIキーを設定
+export GIRB_PROVIDER=girb-gemini
+export GEMINI_API_KEY=your-api-key
+```
+
+## 使い方
+
+### 起動方法
+
+```bash
+girb
+```
+
+または `~/.irbrc` に以下を追加すると、通常の `irb` コマンドでも使えます:
+
+```ruby
+require 'girb-ruby_llm'  # または 'girb-gemini'
+```
+
+### binding.girbでデバッグ
+
+コード内に `binding.girb` を挿入:
+
+```ruby
+def problematic_method
+  result = some_calculation
+  binding.girb  # ここでAI付きIRBが起動
+  result
+end
+```
+
+### AIへの質問方法
+
+#### 方法1: Ctrl+Space
+
+入力後に `Ctrl+Space` を押すと、その入力がAIへの質問として送信されます。
+
+```
+irb(main):001> このエラーの原因は？[Ctrl+Space]
+```
+
+#### 方法2: qqコマンド
+
+```
+irb(main):001> qq "このメソッドの使い方を教えて"
+```
+
+## 設定オプション
+
+`~/.irbrc` に追加:
+
+```ruby
+require 'girb-ruby_llm'
+
+Girb.configure do |c|
+  # デバッグ出力（デフォルト: false）
+  c.debug = true
+
+  # カスタムプロンプト（オプション）
+  c.custom_prompt = <<~PROMPT
+    本番環境です。破壊的操作の前に必ず確認してください。
+  PROMPT
+end
+```
+
+### コマンドラインオプション
+
+```bash
+girb --debug    # デバッグ出力を有効化
+girb -d         # 同上
+girb --help     # ヘルプを表示
+```
+
+### 環境変数
+
+| 変数 | 説明 |
+|------|------|
+| `GIRB_PROVIDER` | **必須。** 読み込むプロバイダーgem（例: `girb-ruby_llm`、`girb-gemini`） |
+| `GIRB_DEBUG` | `1`に設定するとデバッグ出力を有効化 |
+
+## AIが使用できるツール
+
+| ツール | 説明 |
+|--------|------|
+| `evaluate_code` | IRBのコンテキストでRubyコードを実行 |
+| `inspect_object` | オブジェクトの詳細を検査 |
+| `get_source` | メソッドやクラスのソースコードを取得 |
+| `list_methods` | オブジェクトのメソッド一覧を取得 |
+| `find_file` | プロジェクト内のファイルを検索 |
+| `read_file` | ファイルの内容を読み取り |
+| `session_history` | IRBセッションの履歴を取得 |
+
+### Rails環境での追加ツール
+
+| ツール | 説明 |
+|--------|------|
+| `query_model` | ActiveRecordモデルへのクエリ実行 |
+| `model_info` | モデルのスキーマ情報を取得 |
+
+## カスタムプロバイダー
+
+独自のLLMプロバイダーを実装:
+
+```ruby
+class MyProvider < Girb::Providers::Base
+  def initialize(api_key:)
+    @api_key = api_key
+  end
+
+  def chat(messages:, system_prompt:, tools:)
+    # messages: { role: :user/:assistant/:tool_call/:tool_result, content: "..." } の配列
+    # tools: { name: "...", description: "...", parameters: {...} } の配列
+
+    # LLM APIを呼び出す
+    response = call_my_llm(messages, system_prompt, tools)
+
+    # Responseオブジェクトを返す
+    Girb::Providers::Base::Response.new(
+      text: response.text,
+      function_calls: response.tool_calls&.map { |tc| { name: tc.name, args: tc.args } }
+    )
+  end
+end
+
+Girb.configure do |c|
+  c.provider = MyProvider.new(api_key: ENV['MY_API_KEY'])
+end
+```
+
+実行:
+
+```bash
+GIRB_PROVIDER=my_provider girb
+```
+
+## 使用例
+
+### デバッグ支援
+
+```
+irb(main):001> user = User.find(1)
+irb(main):002> user.update(name: "test")
+=> false
+irb(main):003> なぜ更新に失敗したの？[Ctrl+Space]
+`user.errors.full_messages` を確認したところ、バリデーションエラーが発生しています:
+- "Email can't be blank"
+nameの更新時にemailが空になっている可能性があります。
+```
+
+### コードの理解
+
+```
+irb(main):001> このプロジェクトでUserモデルはどこで定義されてる？[Ctrl+Space]
+app/models/user.rb で定義されています。
+```
+
+### パターン認識
+
+```
+irb(main):001> a = 1
+irb(main):002> b = 2
+irb(main):003> c = 3以降も続けるとzはいくつ？[Ctrl+Space]
+パターン a=1, b=2, c=3... を続けると、z=26 になります。
+```
+
+## 動作要件
+
+- Ruby 3.2.0以上
+- IRB 1.6.0以上
+- LLMプロバイダーgem（girb-ruby_llm または girb-gemini）
+
+## ライセンス
+
+MIT License
+
+## 貢献
+
+バグ報告や機能リクエストは [GitHub Issues](https://github.com/rira100000000/girb/issues) へお願いします。

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/girb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: girb [options]"
+
+  opts.on("-d", "--debug", "Enable debug output") do
+    options[:debug] = true
+  end
+
+  opts.on("-h", "--help", "Show this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+ENV["GIRB_DEBUG"] = "1" if options[:debug]
+
+require "irb"
+
+# Load girb and provider
+require "girb"
+
+if ENV["GIRB_PROVIDER"]
+  begin
+    require ENV["GIRB_PROVIDER"]
+  rescue LoadError
+    warn "[girb] Failed to load provider: #{ENV["GIRB_PROVIDER"]}"
+  end
+else
+  warn "[girb] No provider specified. Set GIRB_PROVIDER environment variable."
+  warn "[girb]   Example: GIRB_PROVIDER=girb-ruby_llm girb"
+end
+
+IRB.start