feat: add Rails generator for RubyLLM models

The generator creates Chat, Message, and ToolCall models with migrations
for seamless Rails integration. Users can run 'rails generate ruby_llm:install'
to automatically set up all required models and database tables.

- Add install_generator with templates for models and migrations
- Update Rails integration guide with generator instructions
- Update README with two integration options
- Update Railtie to register the generator
- Add CLAUDE.md for agent assistance

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

Author: kieranklaassen

CLAUDE.md

@@ -0,0 +1,24 @@
+# RubyLLM Development Guidelines
+
+## Commands
+- Run all tests: `bundle exec rspec`
+- Run single test: `bundle exec rspec spec/path/to/file_spec.rb`
+- Run specific test: `bundle exec rspec spec/path/to/file_spec.rb:LINE_NUMBER`
+- Code style check: `bundle exec rubocop`
+- Auto-fix style issues: `bundle exec rubocop -A`
+- Record VCR cassettes: `bundle exec rake vcr:record[provider]` (where provider is openai, anthropic, gemini, etc.)
+
+## Style Guidelines
+- Follow Standard Ruby style (https://github.com/testdouble/standard)
+- Use frozen_string_literal comment at top of files
+- Add YARD documentation comments for public methods
+- Use proper error handling with specific error classes
+- Follow consistent model naming conventions across providers
+- Keep normalized model IDs (separate model from provider)
+- Use consistent parameter naming across providers
+
+## Testing Practices
+- Tests automatically create VCR cassettes based on their descriptions
+- Use specific, descriptive test descriptions
+- Check VCR cassettes for sensitive information
+- Write tests for all new features and bug fixes

README.md

@@ -137,11 +137,37 @@ chat.with_model('gemini-2.0-flash').ask "What's your favorite algorithm?"
 
 ## Rails integration that makes sense
 
+### Option 1: Create new models with the generator
+
+Simply run the generator to set up all required models:
+
+```bash
+rails generate ruby_llm:install
+```
+
+This creates all necessary migrations, models, and database tables. Then just use them:
+
+```ruby
+# In your controller
+chat = Chat.create!(model_id: "gpt-4o-mini")
+chat.ask("What's your favorite Ruby gem?") do |chunk|
+  Turbo::StreamsChannel.broadcast_append_to(
+    chat, target: "response", partial: "messages/chunk", locals: { chunk: chunk }
+  )
+end
+
+# That's it - chat history is automatically saved
+```
+
+### Option 2: Add to your existing models
+
+Or, add RubyLLM to your existing ActiveRecord models:
+
 ```ruby
 # app/models/chat.rb
 class Chat < ApplicationRecord
   acts_as_chat
-
+  
   # Works great with Turbo
   broadcasts_to ->(chat) { "chat_#{chat.id}" }
 end

docs/guides/rails.md

@@ -12,9 +12,32 @@ RubyLLM provides seamless integration with Rails through ActiveRecord models. Th
 
 ## Setup
 
-### 1. Create Migrations
+### Using the Generator (Recommended)
 
-First, create the necessary tables in your database:
+The easiest way to set up RubyLLM with Rails is to use the built-in generator:
+
+```bash
+rails generate ruby_llm:install
+```
+
+This will automatically:
+1. Create the necessary migrations for chats, messages, and tool calls
+2. Create model files with appropriate `acts_as_*` methods
+3. Set up proper relationships between models
+
+After running the generator, simply run the migrations:
+
+```bash
+rails db:migrate
+```
+
+### Manual Setup
+
+If you prefer to set up manually or need to customize the implementation, follow these steps:
+
+#### 1. Create Migrations
+
+Create the necessary tables in your database:
 
 ```ruby
 # db/migrate/YYYYMMDDHHMMSS_create_chats.rb
@@ -65,7 +88,7 @@ Run the migrations:
 rails db:migrate
 ```
 
-### 2. Set Up Models
+#### 2. Set Up Models
 
 Create the model classes:
 

lib/generators/ruby_llm/install/templates/chat_model.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Chat < ApplicationRecord
+  acts_as_chat
+end

lib/generators/ruby_llm/install/templates/create_chats_migration.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class CreateChats < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :chats do |t|
+      t.string :model_id
+      t.timestamps
+    end
+  end
+end

lib/generators/ruby_llm/install/templates/create_messages_migration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreateMessages < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :messages do |t|
+      t.references :chat, null: false, foreign_key: true
+      t.string :role
+      t.text :content
+      t.string :model_id
+      t.integer :input_tokens
+      t.integer :output_tokens
+      t.references :tool_call
+      t.timestamps
+    end
+  end
+end

lib/generators/ruby_llm/install/templates/create_tool_calls_migration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateToolCalls < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :tool_calls do |t|
+      t.references :message, null: false, foreign_key: true
+      t.string :tool_call_id, null: false
+      t.string :name, null: false
+      t.jsonb :arguments, default: {}
+      t.timestamps
+    end
+
+    add_index :tool_calls, :tool_call_id
+  end
+end

lib/generators/ruby_llm/install/templates/initializer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# RubyLLM configuration
+RubyLLM.configure do |config|
+  # Set your API keys here or use environment variables
+  # config.openai_api_key = ENV["OPENAI_API_KEY"]
+  # config.anthropic_api_key = ENV["ANTHROPIC_API_KEY"]
+  # config.gemini_api_key = ENV["GEMINI_API_KEY"]
+  # config.deepseek_api_key = ENV["DEEPSEEK_API_KEY"]
+  
+  # Uncomment to set a default model
+  # config.default_model = "gpt-4o-mini"
+  
+  # Uncomment to set default options
+  # config.default_options = { temperature: 0.7 }
+end

lib/generators/ruby_llm/install/templates/message_model.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Message < ApplicationRecord
+  acts_as_message
+end

lib/generators/ruby_llm/install/templates/tool_call_model.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ToolCall < ApplicationRecord
+  acts_as_tool_call
+end