ruby_llm_community 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82545649470ef24d251c3cf4a5f7eceff777ea2d3939e48eb76fc5109e8a1b5a
-  data.tar.gz: 378d2d26c2cc08362b5b552ca42ee397c9ab1e96cb394223cf8df2dae2548aa6
+  metadata.gz: 867ea1c17955648ccfc017acdcce2ba4710d452cca065657a8a527cec7f36cb7
+  data.tar.gz: 57f6401b2a0892f36885d5c4806587f6ed6f17f5cc7572b6a484f63074167b4e
 SHA512:
-  metadata.gz: 6340051367db4bd6401e2d8c5468eefded5bbf5a72daa94b3bf930ab8b3601b7d3c3cc26e6e878a45e11d3fce15f99747e09eee7393d966f59ce8f968b7d3640
-  data.tar.gz: 1c7de7980a77d5340325ef1db12c4e6b8e6347639f956a925b1ec8dffeb3ae819086159e35aeb3d7964cc4c60133f09657326dc0eb894c28a2c81efda1a4ddb4
+  metadata.gz: e542c506cb9591aa561d062197a2cc3d013be6ec30e35c0b2279084b9f04fbd6451de9db33a58826a5440fd953d069b636a1d3ff7c5605961561af72de376dbe
+  data.tar.gz: b7155e89145f0be7f6305baefd4286dd7ee7b948bd66ca685d8787309a755fa93852fb32db2639d9af5200b86a33010ab717c1705faa7932a5a17b178d39597c

data/README.md

@@ -9,7 +9,7 @@
 
 Battle tested at [<picture><source media="(prefers-color-scheme: dark)" srcset="https://chatwithwork.com/logotype-dark.svg"><img src="https://chatwithwork.com/logotype.svg" alt="Chat with Work" height="30" align="absmiddle"></picture>](https://chatwithwork.com) — *Claude Code for your documents*
 
-[![Gem Version](https://badge.fury.io/rb/ruby_llm.svg?a=8)](https://badge.fury.io/rb/ruby_llm)
+[![Gem Version](https://badge.fury.io/rb/ruby_llm.svg?a=10)](https://badge.fury.io/rb/ruby_llm)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 [![Gem Downloads](https://img.shields.io/gem/dt/ruby_llm)](https://rubygems.org/gems/ruby_llm)
 [![codecov](https://codecov.io/gh/crmne/ruby_llm/branch/main/graph/badge.svg?a=2)](https://codecov.io/gh/crmne/ruby_llm)
@@ -34,11 +34,13 @@ RubyLLM gives you one beautiful API for all of them. Same interface whether you'
 
 Use this gem to get early access to features currently in PR at the main gem.
 
-Initial examples --
+Some examples --
 
 - Prompt caching for Anthropic
 - Image editing for Gemini and OpenAI
 - Responses API for OpenAI
+- xAI provider that supports Grok 2, Grok 3, Grok 4, and Grok Code
+- Red Candle provider
 
 This project is intended to be compatible with RubyLLM. I will attempt to keep it up to date as Carmine pushes commits often.
 
@@ -55,6 +57,7 @@ chat.ask "What's the best way to learn Ruby?"
 ```ruby
 # Analyze any file type
 chat.ask "What's in this image?", with: "ruby_conf.jpg"
+chat.ask "What's happening in this video?", with: "video.mp4"
 chat.ask "Describe this meeting", with: "meeting.wav"
 chat.ask "Summarize this document", with: "contract.pdf"
 chat.ask "Explain this code", with: "app.rb"
@@ -82,6 +85,11 @@ RubyLLM.paint "a sunset over mountains in watercolor style"
 RubyLLM.embed "Ruby is elegant and expressive"
 ```
 
+```ruby
+# Moderate content for safety
+RubyLLM.moderate("Check if this text is safe").flagged? # => false
+```
+
 ```ruby
 # Let AI use your code
 class Weather < RubyLLM::Tool
@@ -114,18 +122,19 @@ response = chat.with_schema(ProductSchema).ask "Analyze this product", with: "pr
 ## Features
 
 * **Chat:** Conversational AI with `RubyLLM.chat`
-* **Vision:** Analyze images and screenshots
+* **Vision:** Analyze images and videos
 * **Audio:** Transcribe and understand speech
 * **Documents:** Extract from PDFs, CSVs, JSON, any file type
 * **Image generation:** Create images with `RubyLLM.paint`
 * **Embeddings:** Vector search with `RubyLLM.embed`
+* **Moderation:** Content safety with `RubyLLM.moderate`
 * **Tools:** Let AI call your Ruby methods
 * **Structured output:** JSON schemas that just work
 * **Streaming:** Real-time responses with blocks
 * **Rails:** ActiveRecord integration with `acts_as_chat`
 * **Async:** Fiber-based concurrency
 * **Model registry:** 500+ models with capability detection and pricing
-* **Providers:** OpenAI, Anthropic, Gemini, VertexAI, Bedrock, DeepSeek, Mistral, Ollama, OpenRouter, Perplexity, GPUStack, and any OpenAI-compatible API
+* **Providers:** OpenAI, Anthropic, Gemini, VertexAI, Bedrock, DeepSeek, Mistral, Ollama, OpenRouter, Perplexity, GPUStack, [RedCandle](https://github.com/scientist-labs/red-candle), and any OpenAI-compatible API
 
 ## Installation
 
@@ -146,7 +155,11 @@ end
 ## Rails
 
 ```bash
+# Install database models
 rails generate ruby_llm:install
+
+# Add chat UI (optional)
+rails generate ruby_llm:chat_ui
 ```
 
 ```ruby
@@ -154,10 +167,12 @@ class Chat < ApplicationRecord
   acts_as_chat
 end
 
-chat = Chat.create! model_id: "claude-sonnet-4"
+chat = Chat.create! model: "claude-sonnet-4"
 chat.ask "What's in this file?", with: "report.pdf"
 ```
 
+Visit `http://localhost:3000/chats` for a ready-to-use chat interface!
+
 ## Documentation
 
 [rubyllm.com](https://rubyllm.com)

data/lib/generators/ruby_llm/generator_helpers.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  # Shared helpers for RubyLLM generators
+  module GeneratorHelpers
+    def parse_model_mappings
+      @model_names = {
+        chat: 'Chat',
+        message: 'Message',
+        tool_call: 'ToolCall',
+        model: 'Model'
+      }
+
+      model_mappings.each do |mapping|
+        if mapping.include?(':')
+          key, value = mapping.split(':', 2)
+          @model_names[key.to_sym] = value.classify
+        end
+      end
+
+      @model_names
+    end
+
+    %i[chat message tool_call model].each do |type|
+      define_method("#{type}_model_name") do
+        @model_names ||= parse_model_mappings
+        @model_names[type]
+      end
+
+      define_method("#{type}_table_name") do
+        table_name_for(send("#{type}_model_name"))
+      end
+    end
+
+    def acts_as_chat_declaration
+      params = []
+
+      add_association_params(params, :messages, message_table_name, message_model_name, plural: true)
+      add_association_params(params, :model, model_table_name, model_model_name)
+
+      "acts_as_chat#{" #{params.join(', ')}" if params.any?}"
+    end
+
+    def acts_as_message_declaration
+      params = []
+
+      add_association_params(params, :chat, chat_table_name, chat_model_name)
+      add_association_params(params, :tool_calls, tool_call_table_name, tool_call_model_name, plural: true)
+      add_association_params(params, :model, model_table_name, model_model_name)
+
+      "acts_as_message#{" #{params.join(', ')}" if params.any?}"
+    end
+
+    def acts_as_model_declaration
+      params = []
+
+      add_association_params(params, :chats, chat_table_name, chat_model_name, plural: true)
+
+      "acts_as_model#{" #{params.join(', ')}" if params.any?}"
+    end
+
+    def acts_as_tool_call_declaration
+      params = []
+
+      add_association_params(params, :message, message_table_name, message_model_name)
+
+      "acts_as_tool_call#{" #{params.join(', ')}" if params.any?}"
+    end
+
+    def create_namespace_modules
+      namespaces = []
+
+      [chat_model_name, message_model_name, tool_call_model_name, model_model_name].each do |model_name|
+        if model_name.include?('::')
+          namespace = model_name.split('::').first
+          namespaces << namespace unless namespaces.include?(namespace)
+        end
+      end
+
+      namespaces.each do |namespace|
+        module_path = "app/models/#{namespace.underscore}.rb"
+        next if File.exist?(Rails.root.join(module_path))
+
+        create_file module_path do
+          <<~RUBY
+            module #{namespace}
+              def self.table_name_prefix
+                "#{namespace.underscore}_"
+              end
+            end
+          RUBY
+        end
+      end
+    end
+
+    def migration_version
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    end
+
+    def postgresql?
+      ::ActiveRecord::Base.connection.adapter_name.downcase.include?('postgresql')
+    rescue StandardError
+      false
+    end
+
+    def table_exists?(table_name)
+      ::ActiveRecord::Base.connection.table_exists?(table_name)
+    rescue StandardError
+      false
+    end
+
+    private
+
+    def add_association_params(params, default_assoc, table_name, model_name, plural: false)
+      assoc = plural ? table_name.to_sym : table_name.singularize.to_sym
+
+      return if assoc == default_assoc
+
+      params << "#{default_assoc}: :#{assoc}"
+      params << "#{default_assoc.to_s.singularize}_class: '#{model_name}'" if model_name != assoc.to_s.classify
+    end
+
+    def table_name_for(model_name)
+      # Convert namespaced model names to proper table names
+      # e.g., "Assistant::Chat" -> "assistant_chats" (not "assistant/chats")
+      model_name.underscore.pluralize.tr('/', '_')
+    end
+  end
+end

data/lib/generators/ruby_llm/install/install_generator.rb

@@ -2,11 +2,13 @@
 
 require 'rails/generators'
 require 'rails/generators/active_record'
+require_relative '../generator_helpers'
 
 module RubyLLM
   # Generator for RubyLLM Rails models and migrations
   class InstallGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
+    include RubyLLM::GeneratorHelpers
 
     namespace 'ruby_llm:install'
 
@@ -24,139 +26,18 @@ module RubyLLM
       ::ActiveRecord::Generators::Base.next_migration_number(dirname)
     end
 
-    def migration_version
-      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-    end
-
-    def postgresql?
-      ::ActiveRecord::Base.connection.adapter_name.downcase.include?('postgresql')
-    rescue StandardError
-      false
-    end
-
-    def parse_model_mappings
-      @model_names = {
-        chat: 'Chat',
-        message: 'Message',
-        tool_call: 'ToolCall',
-        model: 'Model'
-      }
-
-      model_mappings.each do |mapping|
-        if mapping.include?(':')
-          key, value = mapping.split(':', 2)
-          @model_names[key.to_sym] = value.classify
-        end
-      end
-
-      @model_names
-    end
-
-    %i[chat message tool_call model].each do |type|
-      define_method("#{type}_model_name") do
-        @model_names ||= parse_model_mappings
-        @model_names[type]
-      end
-
-      define_method("#{type}_table_name") do
-        table_name_for(send("#{type}_model_name"))
-      end
-    end
-
-    def acts_as_chat_declaration
-      acts_as_chat_params = []
-      messages_assoc = message_model_name.tableize.to_sym
-      model_assoc = model_model_name.underscore.to_sym
-
-      if messages_assoc != :messages
-        acts_as_chat_params << "messages: :#{messages_assoc}"
-        if message_model_name != messages_assoc.to_s.classify
-          acts_as_chat_params << "message_class: '#{message_model_name}'"
-        end
-      end
-
-      if model_assoc != :model
-        acts_as_chat_params << "model: :#{model_assoc}"
-        acts_as_chat_params << "model_class: '#{model_model_name}'" if model_model_name != model_assoc.to_s.classify
-      end
-
-      if acts_as_chat_params.any?
-        "acts_as_chat #{acts_as_chat_params.join(', ')}"
-      else
-        'acts_as_chat'
-      end
-    end
-
-    def acts_as_message_declaration
-      params = []
-
-      add_message_association_params(params, :chat, chat_model_name)
-      add_message_association_params(params, :tool_calls, tool_call_model_name, tableize: true)
-      add_message_association_params(params, :model, model_model_name)
-
-      params.any? ? "acts_as_message #{params.join(', ')}" : 'acts_as_message'
-    end
-
-    private
-
-    def add_message_association_params(params, default_assoc, model_name, tableize: false)
-      assoc = tableize ? model_name.tableize.to_sym : model_name.underscore.to_sym
-
-      return if assoc == default_assoc
-
-      params << "#{default_assoc}: :#{assoc}"
-      expected_class = assoc.to_s.classify
-      params << "#{default_assoc.to_s.singularize}_class: '#{model_name}'" if model_name != expected_class
-    end
-
-    public
-
-    def acts_as_tool_call_declaration
-      acts_as_tool_call_params = []
-      message_assoc = message_model_name.underscore.to_sym
-
-      if message_assoc != :message
-        acts_as_tool_call_params << "message: :#{message_assoc}"
-        if message_model_name != message_assoc.to_s.classify
-          acts_as_tool_call_params << "message_class: '#{message_model_name}'"
-        end
-      end
-
-      if acts_as_tool_call_params.any?
-        "acts_as_tool_call #{acts_as_tool_call_params.join(', ')}"
-      else
-        'acts_as_tool_call'
-      end
-    end
-
-    def acts_as_model_declaration
-      acts_as_model_params = []
-      chats_assoc = chat_model_name.tableize.to_sym
-
-      if chats_assoc != :chats
-        acts_as_model_params << "chats: :#{chats_assoc}"
-        acts_as_model_params << "chat_class: '#{chat_model_name}'" if chat_model_name != chats_assoc.to_s.classify
-      end
-
-      if acts_as_model_params.any?
-        "acts_as_model #{acts_as_model_params.join(', ')}"
-      else
-        'acts_as_model'
-      end
-    end
-
     def create_migration_files
       # Create migrations with timestamps to ensure proper order
       # First create chats table
       migration_template 'create_chats_migration.rb.tt',
                          "db/migrate/create_#{chat_table_name}.rb"
 
-      # Then create messages table (must come before tool_calls due to foreign key)
+      # Then create messages table
       sleep 1 # Ensure different timestamp
       migration_template 'create_messages_migration.rb.tt',
                          "db/migrate/create_#{message_table_name}.rb"
 
-      # Then create tool_calls table (references messages)
+      # Then create tool_calls table
       sleep 1 # Ensure different timestamp
       migration_template 'create_tool_calls_migration.rb.tt',
                          "db/migrate/create_#{tool_call_table_name}.rb"
@@ -165,9 +46,17 @@ module RubyLLM
       sleep 1 # Ensure different timestamp
       migration_template 'create_models_migration.rb.tt',
                          "db/migrate/create_#{model_table_name}.rb"
+
+      # Add references to chats, tool_calls and messages.
+      sleep 1 # Ensure different timestamp
+      migration_template 'add_references_to_chats_tool_calls_and_messages_migration.rb.tt',
+                         'db/migrate/add_references_to_' \
+                         "#{chat_table_name}_#{tool_call_table_name}_and_#{message_table_name}.rb"
     end
 
     def create_model_files
+      create_namespace_modules
+
       template 'chat_model.rb.tt', "app/models/#{chat_model_name.underscore}.rb"
       template 'message_model.rb.tt', "app/models/#{message_model_name.underscore}.rb"
       template 'tool_call_model.rb.tt', "app/models/#{tool_call_model_name.underscore}.rb"
@@ -186,12 +75,6 @@ module RubyLLM
       rails_command 'active_storage:install'
     end
 
-    def table_name_for(model_name)
-      # Convert namespaced model names to proper table names
-      # e.g., "Assistant::Chat" -> "assistant_chats" (not "assistant/chats")
-      model_name.underscore.pluralize.tr('/', '_')
-    end
-
     def show_install_info
       say "\n  ✅ RubyLLM installed!", :green
 

data/lib/generators/ruby_llm/install/templates/add_references_to_chats_tool_calls_and_messages_migration.rb.tt

@@ -0,0 +1,9 @@
+class AddReferencesTo<%= "#{chat_model_name.gsub('::', '').pluralize}#{tool_call_model_name.gsub('::', '').pluralize}And#{message_model_name.gsub('::', '').pluralize}" %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_reference :<%= chat_table_name %>, :<%= model_table_name.singularize %>, foreign_key: true
+    add_reference :<%= tool_call_table_name %>, :<%= message_table_name.singularize %>, null: false, foreign_key: true
+    add_reference :<%= message_table_name %>, :<%= chat_table_name.singularize %>, null: false, foreign_key: true
+    add_reference :<%= message_table_name %>, :<%= model_table_name.singularize %>, foreign_key: true
+    add_reference :<%= message_table_name %>, :<%= tool_call_table_name.singularize %>, foreign_key: true
+  end
+end

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

@@ -1,7 +1,6 @@
 class Create<%= chat_model_name.gsub('::', '').pluralize %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :<%= chat_table_name %> do |t|
-      t.references :<%= model_table_name.singularize %>, foreign_key: true
       t.timestamps
     end
   end

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

@@ -1,13 +1,10 @@
 class Create<%= message_model_name.gsub('::', '').pluralize %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :<%= message_table_name %> do |t|
-      t.references :<%= chat_table_name.singularize %>, null: false, foreign_key: true
       t.string :role, null: false
       t.text :content
-      t.references :<%= model_table_name.singularize %>, foreign_key: true
       t.integer :input_tokens
       t.integer :output_tokens
-      t.references :<%= tool_call_table_name.singularize %>, foreign_key: true
       t.timestamps
     end
 

data/lib/generators/ruby_llm/install/templates/create_models_migration.rb.tt

@@ -34,10 +34,7 @@ class Create<%= model_model_name.gsub('::', '').pluralize %> < ActiveRecord::Mig
     # Load models from JSON
     say_with_time "Loading models from models.json" do
       RubyLLM.models.load_from_json!
-      model_class = '<%= model_model_name %>'.constantize
-      model_class.save_to_database
-
-      "Loaded #{model_class.count} models"
+      <%= model_model_name %>.save_to_database
     end
   end
 end

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

@@ -2,7 +2,6 @@
 class Create<%= tool_call_model_name.gsub('::', '').pluralize %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :<%= tool_call_table_name %> do |t|
-      t.references :<%= message_table_name.singularize %>, null: false, foreign_key: true
       t.string :tool_call_id, null: false
       t.string :name, null: false
       t.<%= postgresql? ? 'jsonb' : 'json' %> :arguments, default: {}

data/lib/generators/ruby_llm/upgrade_to_v1_7/templates/migration.rb.tt

@@ -3,6 +3,14 @@ class MigrateToRubyLLMModelReferences < ActiveRecord::Migration<%= migration_ver
     model_class = <%= model_model_name %>
     chat_class = <%= chat_model_name %>
     message_class = <%= message_model_name %>
+<% if @model_table_already_existed %>
+    # Load models from models.json if Model table already existed
+    say_with_time "Loading models from models.json" do
+      RubyLLM.models.load_from_json!
+      model_class.save_to_database
+      "Loaded #{model_class.count} models"
+    end
+<% end %>
 
     # Then check for any models in existing data that aren't in models.json
     say_with_time "Checking for additional models in existing data" do