Rails Generator for RubyLLM Models #75

kieranklaassen · 2025-03-27T16:51:13Z

This PR adds a Rails generator for RubyLLM models, making it easier to integrate RubyLLM with Rails applications.

Changes in this PR

Added generator that creates Chat, Message, and ToolCall models with migrations
Updated Rails integration guide with generator instructions
Added support for customizing model names to avoid namespace collisions
Added cross-database support for JSON columns

Recent updates to address PR comments

Renamed README.md.tt to INSTALL_INFO.md.tt to avoid confusion with the project README, and updated the reference in the install_generator.rb file.
Fixed migration order by using timestamps in the migration filenames in the install_generator.rb file. This ensures that migrations run in the correct order (chats first, then tool_calls, then messages).
Updated railtie.rb to include rake tasks from the lib/ruby_llm/tasks directory, which addresses the issue mentioned in the comments about rake tasks not showing up in Rails applications.
Reverted several changes in docs/guides/rails.md as requested in the comments, including fixing formatting issues and removing unnecessary content.
Removed the comment about migration order from the create_messages_migration.rb.tt file since we're now enforcing it with timestamps.

These changes should address all the issues mentioned in the PR comments.

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>

Added tests for the Rails generator template files to ensure they contain the expected content. Fixed a Zeitwerk warning by ignoring the generators directory in the loader. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

Updated the tool_calls migration to detect and use the appropriate JSON column type based on the database adapter: - Uses jsonb for PostgreSQL databases (better performance and indexing) - Falls back to standard json type for other databases (MySQL, SQLite, etc.) - Added postgresql? detection method with proper error handling - Added comprehensive tests for database adapter detection 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

test

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

This adds a helpful README template that's displayed after successful generator installation, providing users with clear next steps and examples of how to use the generated models. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

Addresses PR feedback to remove redundant comments from the migration template. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

- Renamed all template files to use .tt extension following Rails convention - Updated generator code and tests to reference the new template files - Fixed style issues in the generator code according to Rubocop 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

- Split large tests into smaller focused tests - Fix string quotes to follow style guidelines - Remove trailing whitespace - Improve test readability and organization 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

- Removed unnecessary whitespace in railtie.rb for cleaner code. - Added comprehensive tests for the RubyLLM::InstallGenerator to ensure migration and model templates are correctly defined and structured. - Deleted outdated template files spec to streamline test organization. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

jamster · 2025-03-29T15:13:01Z

I created a PR on this PR (not sure where to put it so commenting here). This PR adds to this one by allowing the user to pass in the class (and hence table) names for the Chat, Message and ToolCall classes and tables. I had an existing set of tables that did have conflicts, and my new use case was better suited with a different taxonomy.

PR for Dynamic Names

Here is an example:

rails generate ruby_llm:install --chat-model-name=Review --message-model-name=ReviewMessage --force

kieranklaassen · 2025-03-30T16:51:00Z

Amazing! Thanks @jamster once merge conflicts are resolved I'll merge it

readme as template, migration # handled by rails, remove `frozen_literal` from models and migrations forcing timestamp order for migrations make act_as methods dynamic, cleaned ordering/references

Making class and table names optional

kieranklaassen · 2025-03-31T23:15:26Z

Ok ready for review!

crmne · 2025-04-01T15:22:08Z

lib/generators/ruby_llm/install/templates/README.md.tt

Wouldn't it be annoying to have a new README? I would delete this

I think the name "README" is a bit misleading here. This is the text generated AFTER you run the generator to explain what you did, whereas the readme for RubyLLM remains the same and untouched. Originally, this did overwrite the README, but has been corrected to be more of an ephemeral display post install.

Yes, you can see it in the test added too. It's to give direction after using the generator.

crmne · 2025-04-01T15:23:50Z

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

@@ -0,0 +1,16 @@
+# This migration must be run AFTER create_<%= options[:chat_model_name].tableize %> and create_<%= options[:tool_call_model_name].tableize %> migrations


Would it be possible to enforce this constraint with the timestamp of the migration? Disclaimer: I'm new to making templates for migrations.

See comments on latest PR below

crmne · 2025-04-01T15:25:00Z

lib/generators/ruby_llm/install_generator.rb

+    def create_migration_files
+      # Use a fixed timestamp for testing and to ensure they're sequential
+      # @migration_number = Time.now.utc.strftime('%Y%m%d%H%M%S')
+      migration_template 'create_chats_migration.rb.tt', "db/migrate/create_#{options[:chat_model_name].tableize}.rb"


ah there you go that's where we can enforce the order.

@kieranklaassen can you enforce the order by using timestamps in the name just like rails does?

crmne · 2025-04-01T15:26:06Z

ruby_llm.gemspec

+  # Add generator files
+  spec.files += Dir.glob('lib/generators/**/*')
+


This should be already covered by the lines above

crmne · 2025-04-01T15:26:22Z

ruby_llm.gemspec

+
+  # Development dependencies
+  spec.add_development_dependency 'rails', '>= 7.0.0'


We don't add dev dependencies here, we do it in the Gemfile

crmne · 2025-04-01T15:27:02Z

spec/lib/generators/ruby_llm/install_generator_spec.rb

+  let(:template_dir) { File.join(File.dirname(__FILE__), '../../../../lib/generators/ruby_llm/install/templates') }
+  let(:generator_file) { File.join(File.dirname(__FILE__), '../../../../lib/generators/ruby_llm/install_generator.rb') }


File.dirname(__FILE__) can be __dir__ right?

README.md

Address PR feedback and cleanup - Replace File.dirname(__FILE__) with __dir__ in specs for better Ruby idioms - Remove redundant spec.files line for generators (already covered by lib/**/*) - Move rails development dependency to Gemfile from gemspec - Update example in README to use ActiveJob instead of controller for better practices Note on migration timestamps: The current implementation has no table dependencies, so migration order is not critical. Rails generators automatically handle timestamps for migrations, making manual timestamp management unnecessary.

jamster · 2025-04-08T16:21:32Z

I've made the updates you requested and created this PR: kieranklaassen#2
Not sure the best workflow here with PRs to PRs, etc. Happy to do this better with any direction.

for context, the PR addresses:

Address PR feedback and cleanup

Replace File.dirname(FILE) with dir in specs for better Ruby idioms
Remove redundant spec.files line for generators (already covered by lib/**/*)
Move rails development dependency to Gemfile from gemspec
Update example in README to use ActiveJob instead of controller for better practices

Note on migration timestamps: The current implementation has no table dependencies,
so migration order is not critical. Rails generators automatically handle
timestamps for migrations, making manual timestamp management unnecessary.

Addresses comments in PR

kieranklaassen · 2025-04-10T16:31:49Z

Thanks @jamster !! I've been really busy so appreciate doing the work!!

kieranklaassen · 2025-04-18T16:15:16Z

@crmne Let me know if you need any more chnages, waiting for review

…mprove formatting - Added a section on using the generator for setting up RubyLLM in Rails applications. - Improved formatting for better readability, including table of contents and notes. - Updated examples to reflect changes in model creation and button usage in forms.

…cord creation - Modified examples in the Rails integration guide to reflect the inclusion of the `user` parameter when creating a new chat record. - Updated model_id in examples to 'gpt-4.1-nano' for consistency.

- Introduced the `ChatStreamJob` class to the Rails integration guide, detailing its purpose and functionality in handling chat streaming. - Included comments within the job to explain the process of saving user messages and broadcasting assistant message updates.

crmne

Nice work! there are a couple things to change and then I'm ready to merge it

crmne · 2025-04-23T20:17:01Z

docs/guides/rails.md

@@ -7,31 +7,67 @@ permalink: /guides/rails
 ---

 # Rails Integration
+


remove empty line

crmne · 2025-04-23T20:17:18Z

docs/guides/rails.md

-RubyLLM offers seamless integration with Ruby on Rails applications through helpers for ActiveRecord models. This allows you to easily persist chat conversations, including messages and tool interactions, directly in your database.
-{: .fs-6 .fw-300 }
+RubyLLM offers seamless integration with Ruby on Rails applications through helpers for ActiveRecord models. This allows you to easily persist chat conversations, including messages and tool interactions, directly in your database. {: .fs-6 .fw-300 }


stick to previous version

crmne · 2025-04-23T20:17:25Z

docs/guides/rails.md


 ## Table of contents
+


remove empty line

crmne · 2025-04-23T20:17:32Z

docs/guides/rails.md

-1. TOC
-{:toc}
+1. TOC {:toc}


stick to previous version

crmne · 2025-04-23T20:17:50Z

docs/guides/rails.md

-*   How to set up ActiveRecord models for persisting chats and messages.
-*   How to use `acts_as_chat` and `acts_as_message`.
-*   How chat interactions automatically persist data.
-*   A basic approach for integrating streaming responses with Hotwire/Turbo Streams.
+- How to set up ActiveRecord models for persisting chats and messages.
+- How to use `acts_as_chat` and `acts_as_message`.
+- How chat interactions automatically persist data.
+- A basic approach for integrating streaming responses with Hotwire/Turbo Streams.


unnecessary change

crmne · 2025-04-23T20:18:39Z

docs/guides/rails.md

-{: .note }
-The `acts_as` helpers primarily handle loading history and saving messages/tool calls related to the chat interaction. Add your application-specific logic (associations, validations, scopes, callbacks) as usual.
+{: .note } The `acts_as` helpers primarily handle loading history and saving messages/tool calls related to the chat interaction. Add your application-specific logic (associations, validations, scopes, callbacks) as usual.


stick to previous version

crmne · 2025-04-23T20:19:05Z

docs/guides/rails.md

+```ruby
+# config/initializers/ruby_llm.rb
+RubyLLM.configure do |config|
+  config.openai_api_key = ENV["OPENAI_API_KEY"]
+  config.anthropic_api_key = ENV["ANTHROPIC_API_KEY"]
+  # Add other provider keys as needed
+end
+```
+


no need for this, we have the configuration guide for it

crmne · 2025-04-23T20:19:44Z

docs/guides/rails.md

-{: .note }
-This example shows the core idea. You'll need to adapt the broadcasting, targets, and partials for your specific UI needs (e.g., handling Markdown rendering, adding styling, showing typing indicators). See the [Streaming Responses Guide]({% link guides/streaming.md %}) for more on streaming itself.
+{: .note } This example shows the core idea. You'll need to adapt the broadcasting, targets, and partials for your specific UI needs (e.g., handling Markdown rendering, adding styling, showing typing indicators). See the [Streaming Responses Guide]({% link guides/streaming.md %}) for more on streaming itself.


stick to previous version

crmne · 2025-04-23T20:19:51Z

docs/guides/rails.md

-*   [Chatting with AI Models]({% link guides/chat.md %})
-*   [Using Tools]({% link guides/tools.md %})
-*   [Streaming Responses]({% link guides/streaming.md %})
-*   [Working with Models]({% link guides/models.md %})
-*   [Error Handling]({% link guides/error-handling.md %})
+- [Chatting with AI Models]({% link guides/chat.md %})
+- [Using Tools]({% link guides/tools.md %})
+- [Streaming Responses]({% link guides/streaming.md %})
+- [Working with Models]({% link guides/models.md %})
+- [Error Handling]({% link guides/error-handling.md %})


stick to previous version

crmne · 2025-04-23T20:21:19Z

lib/generators/ruby_llm/install_generator.rb

+    def create_migration_files
+      # Use a fixed timestamp for testing and to ensure they're sequential
+      # @migration_number = Time.now.utc.strftime('%Y%m%d%H%M%S')
+      migration_template 'create_chats_migration.rb.tt', "db/migrate/create_#{options[:chat_model_name].tableize}.rb"


@kieranklaassen can you enforce the order by using timestamps in the name just like rails does?

harrisreynolds · 2025-04-24T13:18:22Z

lib/ruby_llm/railtie.rb

@@ -8,5 +8,15 @@ class Railtie < Rails::Railtie
        include RubyLLM::ActiveRecord::ActsAs
      end
    end
+
+    # Include rake tasks if applicable


We should include the ruby_llm rake tasks in a Rails application:

rake_tasks do path = File.expand_path(__dir__) Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f } end

I added an issue for the rake task not show up in a Rails application: #136

This is making it harder for me to use the latest Gemini models.

… railtie.rb, and revert rails.md changes

kieranklaassen and others added 4 commits March 27, 2025 09:50

fix: ensure proper migration order for database schema

2d50909

test

kieranklaassen commented Mar 27, 2025

View reviewed changes

lib/generators/ruby_llm/install/templates/create_tool_calls_migration.rb Outdated Show resolved Hide resolved

kieranklaassen and others added 8 commits March 27, 2025 09:55

Remove unnecessary comments from create_tool_calls_migration.rb

dacb148

Addresses PR feedback to remove redundant comments from the migration template. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

chore: memory

131e51c

Delete CLAUDE.md

f40d1b4

Update CONTRIBUTING.md

5eeedf9

jamster and others added 3 commits March 31, 2025 11:40

first run at options for model names

61d66ab

readme as template, migration # handled by rails, remove `frozen_literal` from models and migrations forcing timestamp order for migrations make act_as methods dynamic, cleaned ordering/references

fixing generator specs with updated options setup

a239b34

Merge pull request #1 from jamster/generators

8316ce5

Making class and table names optional

Merge branch 'main' into generators

cf4a560

crmne requested changes Apr 1, 2025

View reviewed changes

Merge branch 'main' into generators

492188f

crmne added the enhancement New feature or request label Apr 2, 2025

kieranklaassen and others added 2 commits April 2, 2025 13:39

Merge branch 'main' into generators

52d761a

kieranklaassen and others added 2 commits April 10, 2025 09:22

Merge pull request #2 from jamster/generators

9eba7bc

Addresses comments in PR

Merge branch 'main' into generators

7cded01

kieranklaassen requested a review from crmne April 10, 2025 16:31

kieranklaassen requested a review from jamster April 18, 2025 16:15

Merge branch 'main' into generators

21c4ee0

kieranklaassen closed this Apr 18, 2025

kieranklaassen force-pushed the generators branch from 21c4ee0 to fd7e972 Compare April 18, 2025 21:28

kieranklaassen reopened this Apr 18, 2025

kieranklaassen and others added 6 commits April 18, 2025 14:33

docs

fda4df1

Merge branch 'main' into generators

1f8d3b0

Merge branch 'main' into generators

a350738

crmne requested changes Apr 23, 2025

View reviewed changes

harrisreynolds reviewed Apr 24, 2025

View reviewed changes

Address PR comments: rename README.md.tt, fix migration order, update…

1ed3c2e

… railtie.rb, and revert rails.md changes

kieranklaassen changed the title ~~Rails Generators~~ Rails Generator for RubyLLM Models Apr 29, 2025

kieranklaassen and others added 7 commits April 29, 2025 17:53

Delete .cursor/rules/add_new_provider.mdc

f16858a

Delete .cursor/rules/ruby_llm_conventions.mdc

26bcf50

Delete .cursor/rules/ruby_style_guide.mdc

c352d5f

Delete .cursor/rules/ruby_llm_philosophy.mdc

b064713

fix: address PR comments - remove sleep calls and fix formatting

5a9b3b8

fix: revert rails.md to previous version as requested in PR comments

224b24e

fix: remove empty line in rails.md as requested in PR comments

1fe4320

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rails Generator for RubyLLM Models #75

Rails Generator for RubyLLM Models #75

kieranklaassen commented Mar 27, 2025 •

edited

Loading

jamster commented Mar 29, 2025

kieranklaassen commented Mar 30, 2025 •

edited

Loading

kieranklaassen commented Mar 31, 2025

crmne Apr 1, 2025

jamster Apr 8, 2025

kieranklaassen Apr 10, 2025

crmne Apr 1, 2025

jamster Apr 8, 2025

crmne Apr 1, 2025

crmne Apr 23, 2025

crmne Apr 1, 2025

crmne Apr 1, 2025

crmne Apr 1, 2025

jamster commented Apr 8, 2025

kieranklaassen commented Apr 10, 2025

kieranklaassen commented Apr 18, 2025

crmne left a comment

crmne Apr 23, 2025

crmne Apr 23, 2025

crmne Apr 23, 2025

crmne Apr 23, 2025

crmne Apr 23, 2025

crmne Apr 23, 2025

crmne Apr 23, 2025

crmne Apr 23, 2025

crmne Apr 23, 2025

crmne Apr 23, 2025

harrisreynolds Apr 24, 2025

harrisreynolds Apr 24, 2025

		@@ -0,0 +1,16 @@
		# This migration must be run AFTER create_<%= options[:chat_model_name].tableize %> and create_<%= options[:tool_call_model_name].tableize %> migrations

		# Add generator files
		spec.files += Dir.glob('lib/generators/*/')


		# Development dependencies
		spec.add_development_dependency 'rails', '>= 7.0.0'

		let(:template_dir) { File.join(File.dirname(__FILE__), '../../../../lib/generators/ruby_llm/install/templates') }
		let(:generator_file) { File.join(File.dirname(__FILE__), '../../../../lib/generators/ruby_llm/install_generator.rb') }

		@@ -7,31 +7,67 @@ permalink: /guides/rails
		---

		# Rails Integration

Rails Generator for RubyLLM Models #75

Are you sure you want to change the base?

Rails Generator for RubyLLM Models #75

Conversation

kieranklaassen commented Mar 27, 2025 • edited Loading

Changes in this PR

Recent updates to address PR comments

jamster commented Mar 29, 2025

kieranklaassen commented Mar 30, 2025 • edited Loading

kieranklaassen commented Mar 31, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jamster commented Apr 8, 2025

kieranklaassen commented Apr 10, 2025

kieranklaassen commented Apr 18, 2025

crmne left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kieranklaassen commented Mar 27, 2025 •

edited

Loading

kieranklaassen commented Mar 30, 2025 •

edited

Loading