ruby_llm_community 1.0.0 → 1.1.0

data/lib/ruby_llm/utils.rb

@@ -5,10 +5,6 @@ module RubyLLM
   module Utils
     module_function
 
-    def format_text_file_for_llm(text_file)
-      "<file name='#{text_file.filename}' mime_type='#{text_file.mime_type}'>#{text_file.content}</file>"
-    end
-
     def hash_get(hash, key)
       hash[key.to_sym] || hash[key.to_s]
     end
@@ -36,12 +32,12 @@ module RubyLLM
       value.is_a?(Date) ? value : Date.parse(value.to_s)
     end
 
-    def deep_merge(params, payload)
-      params.merge(payload) do |_key, params_value, payload_value|
-        if params_value.is_a?(Hash) && payload_value.is_a?(Hash)
-          deep_merge(params_value, payload_value)
+    def deep_merge(original, overrides)
+      original.merge(overrides) do |_key, original_value, overrides_value|
+        if original_value.is_a?(Hash) && overrides_value.is_a?(Hash)
+          deep_merge(original_value, overrides_value)
         else
-          payload_value
+          overrides_value
         end
       end
     end

data/lib/ruby_llm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/ruby_llm_community.rb

@@ -26,12 +26,12 @@ loader.inflector.inflect(
   'mistral' => 'Mistral',
   'pdf' => 'PDF',
   'version' => 'VERSION',
-  'vertexai' => 'VertexAI'
+  'vertexai' => 'VertexAI',
+  'xai' => 'XAI',
+  'UI' => 'UI'
 )
 loader.ignore("#{__dir__}/shims")
 loader.ignore("#{__dir__}/tasks")
-loader.ignore("#{__dir__}/ruby_llm/railtie")
-loader.ignore("#{__dir__}/ruby_llm/active_record")
 loader.ignore("#{__dir__}/generators")
 loader.setup
 
@@ -99,6 +99,7 @@ RubyLLM::Provider.register :openai, RubyLLM::Providers::OpenAI
 RubyLLM::Provider.register :openrouter, RubyLLM::Providers::OpenRouter
 RubyLLM::Provider.register :perplexity, RubyLLM::Providers::Perplexity
 RubyLLM::Provider.register :vertexai, RubyLLM::Providers::VertexAI
+RubyLLM::Provider.register :xai, RubyLLM::Providers::XAI
 
 if defined?(Rails::Railtie)
   require 'ruby_llm/railtie'

data/lib/tasks/models.rake

@@ -39,16 +39,19 @@ end
 
 def configure_from_env
   RubyLLM.configure do |config|
-    config.openai_api_key = ENV.fetch('OPENAI_API_KEY', nil)
+    # Providers
     config.anthropic_api_key = ENV.fetch('ANTHROPIC_API_KEY', nil)
-    config.gemini_api_key = ENV.fetch('GEMINI_API_KEY', nil)
     config.deepseek_api_key = ENV.fetch('DEEPSEEK_API_KEY', nil)
-    config.perplexity_api_key = ENV.fetch('PERPLEXITY_API_KEY', nil)
-    config.openrouter_api_key = ENV.fetch('OPENROUTER_API_KEY', nil)
+    config.gemini_api_key = ENV.fetch('GEMINI_API_KEY', nil)
     config.mistral_api_key = ENV.fetch('MISTRAL_API_KEY', nil)
+    config.openai_api_key = ENV.fetch('OPENAI_API_KEY', nil)
+    config.openrouter_api_key = ENV.fetch('OPENROUTER_API_KEY', nil)
+    config.perplexity_api_key = ENV.fetch('PERPLEXITY_API_KEY', nil)
     config.vertexai_location = ENV.fetch('GOOGLE_CLOUD_LOCATION', nil)
     config.vertexai_project_id = ENV.fetch('GOOGLE_CLOUD_PROJECT', nil)
+    config.xai_api_key = ENV.fetch('XAI_API_KEY', nil)
     configure_bedrock(config)
+    # Requests
     config.request_timeout = 30
   end
 end
@@ -76,7 +79,7 @@ def refresh_models
     validate_models!(models)
 
     puts "Saving models.json (#{models.all.size} models)"
-    models.save_models
+    models.save_to_json
   end
 
   @models = models
@@ -427,6 +430,27 @@ def generate_aliases # rubocop:disable Metrics/PerceivedComplexity
     }
   end
 
+  models['xai'].each do |model|
+    # xAI aliases
+    m = RubyLLM.models.find(model)
+    next unless m.metadata&.dig(:aliases)
+
+    m.metadata[:aliases].each do |alias_name|
+      aliases[alias_name] = { 'xai' => m.id }
+    end
+
+    # OpenRouter aliases.
+    # NOTE: OpenRouter uses "x-ai" as the provider slug
+    openrouter_model = "x-ai/#{model}"
+    next unless models['openrouter'].include?(openrouter_model)
+
+    alias_key = model.gsub('-latest', '').gsub(/-\d{4}/, '-4')
+    aliases[alias_key] = {
+      'xai' => alias_key,
+      'openrouter' => openrouter_model
+    }
+  end
+
   sorted_aliases = aliases.sort.to_h
   File.write(RubyLLM::Aliases.aliases_file, JSON.pretty_generate(sorted_aliases))
 

data/lib/tasks/ruby_llm.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+namespace :ruby_llm do
+  desc 'Load models from models.json into the database'
+  task load_models: :environment do
+    if RubyLLM.config.model_registry_class
+      RubyLLM.models.load_from_json!
+      model_class = RubyLLM.config.model_registry_class.constantize
+      model_class.save_to_database
+      puts "✅ Loaded #{model_class.count} models into database"
+    else
+      puts 'Model registry not configured. Run rails generate ruby_llm:install'
+    end
+  end
+end

data/lib/tasks/vcr.rake

@@ -75,11 +75,11 @@ end
 
 namespace :vcr do
   desc 'Record VCR cassettes (rake vcr:record[all] or vcr:record[openai,anthropic])'
-  task :record, [:providers] do |_, args|
+  task :record, :providers do |_, args|
     require 'fileutils'
     require 'ruby_llm'
 
-    providers = (args[:providers] || '').downcase.split(',')
+    providers = args.extras.unshift(args[:providers]).compact.map(&:downcase)
     cassette_dir = 'spec/fixtures/vcr_cassettes'
     FileUtils.mkdir_p(cassette_dir)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm_community
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Shippy
@@ -136,7 +136,23 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/generators/ruby_llm/install/templates/INSTALL_INFO.md.tt
+- lib/generators/ruby_llm/chat_ui/chat_ui_generator.rb
+- lib/generators/ruby_llm/chat_ui/templates/controllers/chats_controller.rb.tt
+- lib/generators/ruby_llm/chat_ui/templates/controllers/messages_controller.rb.tt
+- lib/generators/ruby_llm/chat_ui/templates/controllers/models_controller.rb.tt
+- lib/generators/ruby_llm/chat_ui/templates/jobs/chat_response_job.rb.tt
+- lib/generators/ruby_llm/chat_ui/templates/views/chats/_chat.html.erb.tt
+- lib/generators/ruby_llm/chat_ui/templates/views/chats/_form.html.erb.tt
+- lib/generators/ruby_llm/chat_ui/templates/views/chats/index.html.erb.tt
+- lib/generators/ruby_llm/chat_ui/templates/views/chats/new.html.erb.tt
+- lib/generators/ruby_llm/chat_ui/templates/views/chats/show.html.erb.tt
+- lib/generators/ruby_llm/chat_ui/templates/views/messages/_form.html.erb.tt
+- lib/generators/ruby_llm/chat_ui/templates/views/messages/_message.html.erb.tt
+- lib/generators/ruby_llm/chat_ui/templates/views/messages/create.turbo_stream.erb.tt
+- lib/generators/ruby_llm/chat_ui/templates/views/models/_model.html.erb.tt
+- lib/generators/ruby_llm/chat_ui/templates/views/models/index.html.erb.tt
+- lib/generators/ruby_llm/chat_ui/templates/views/models/show.html.erb.tt
+- lib/generators/ruby_llm/install/install_generator.rb
 - lib/generators/ruby_llm/install/templates/chat_model.rb.tt
 - lib/generators/ruby_llm/install/templates/create_chats_migration.rb.tt
 - lib/generators/ruby_llm/install/templates/create_messages_migration.rb.tt
@@ -146,8 +162,13 @@ files:
 - lib/generators/ruby_llm/install/templates/message_model.rb.tt
 - lib/generators/ruby_llm/install/templates/model_model.rb.tt
 - lib/generators/ruby_llm/install/templates/tool_call_model.rb.tt
-- lib/generators/ruby_llm/install_generator.rb
+- lib/generators/ruby_llm/upgrade_to_v1_7/templates/migration.rb.tt
+- lib/generators/ruby_llm/upgrade_to_v1_7/upgrade_to_v1_7_generator.rb
 - lib/ruby_llm/active_record/acts_as.rb
+- lib/ruby_llm/active_record/acts_as_legacy.rb
+- lib/ruby_llm/active_record/chat_methods.rb
+- lib/ruby_llm/active_record/message_methods.rb
+- lib/ruby_llm/active_record/model_methods.rb
 - lib/ruby_llm/aliases.json
 - lib/ruby_llm/aliases.rb
 - lib/ruby_llm/attachment.rb
@@ -242,6 +263,10 @@ files:
 - lib/ruby_llm/providers/vertexai/embeddings.rb
 - lib/ruby_llm/providers/vertexai/models.rb
 - lib/ruby_llm/providers/vertexai/streaming.rb
+- lib/ruby_llm/providers/xai.rb
+- lib/ruby_llm/providers/xai/capabilities.rb
+- lib/ruby_llm/providers/xai/chat.rb
+- lib/ruby_llm/providers/xai/models.rb
 - lib/ruby_llm/railtie.rb
 - lib/ruby_llm/stream_accumulator.rb
 - lib/ruby_llm/streaming.rb
@@ -253,6 +278,7 @@ files:
 - lib/shims/ruby_llm.rb
 - lib/tasks/models.rake
 - lib/tasks/release.rake
+- lib/tasks/ruby_llm.rake
 - lib/tasks/vcr.rake
 homepage: https://rubyllm.com
 licenses:
@@ -264,6 +290,9 @@ metadata:
   documentation_uri: https://rubyllm.com
   bug_tracker_uri: https://github.com/tpaulshippy/ruby_llm_community/issues
   rubygems_mfa_required: 'true'
+post_install_message: |
+  Upgrading from RubyLLM <= 1.6.x? Check the upgrade guide for new features and migration instructions
+  --> https://rubyllm.com/upgrading-to-1-7/
 rdoc_options: []
 require_paths:
 - lib

data/lib/generators/ruby_llm/install/templates/INSTALL_INFO.md.tt

@@ -1,108 +0,0 @@
-# RubyLLM Rails Setup Complete!
-
-Thanks for installing RubyLLM in your Rails application. Here's what was created:
-
-## Models
-
-- `<%= options[:chat_model_name] %>` - Stores chat sessions and their associated model ID
-- `<%= options[:message_model_name] %>` - Stores individual messages in a chat
-- `<%= options[:tool_call_model_name] %>` - Stores tool calls made by language models
-
-**Note:** Do not add `validates :content, presence: true` to your Message model - RubyLLM creates empty assistant messages before API calls for streaming support.
-
-## Configuration Options
-
-The generator supports the following options to customize model names:
-
-```bash
-rails generate ruby_llm:install \
-  --chat-model-name=Conversation \
-  --message-model-name=ChatMessage \
-  --tool-call-model-name=FunctionCall
-```
-
-This is useful when you need to avoid namespace collisions with existing models in your application. Table names will be automatically derived from the model names following Rails conventions.
-
-## Next Steps
-
-1. **Run migrations:**
-   ```bash
-   rails db:migrate
-   ```
-
-   **Database Note:** The migrations use `jsonb` for PostgreSQL and `json` for MySQL/SQLite automatically.
-
-2. **Set your API keys** in `config/initializers/ruby_llm.rb` or using environment variables:
-   ```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']
-     config.gemini_api_key = ENV['GEMINI_API_KEY']
-     # ... add other providers as needed
-   end
-   ```
-
-3. **Start using RubyLLM in your code:**
-   ```ruby
-   # Basic usage
-   chat = <%= options[:chat_model_name] %>.create!(model_id: 'gpt-4.1-nano')
-   response = chat.ask("What is Ruby on Rails?")
-
-   # With file attachments (requires ActiveStorage setup)
-   chat.ask("What's in this file?", with: "report.pdf")
-   chat.ask("Analyze these files", with: ["image.jpg", "data.csv", "notes.txt"])
-   ```
-
-4. **For streaming responses** with Hotwire/Turbo:
-   ```ruby
-   # app/models/<%= options[:message_model_name].underscore %>.rb
-   class <%= options[:message_model_name] %> < ApplicationRecord
-     acts_as_message
-
-     # Helper to broadcast chunks during streaming
-     def broadcast_append_chunk(chunk_content)
-       broadcast_append_to [ chat, "messages" ],
-         target: dom_id(self, "content"),
-         html: chunk_content
-     end
-   end
-
-   # app/jobs/chat_stream_job.rb
-   class ChatStreamJob < ApplicationJob
-     def perform(chat_id, user_content)
-       chat = <%= options[:chat_model_name] %>.find(chat_id)
-       chat.ask(user_content) do |chunk|
-         assistant_message = chat.messages.last
-         if chunk.content && assistant_message
-           assistant_message.broadcast_append_chunk(chunk.content)
-         end
-       end
-     end
-   end
-
-   # In your controller
-   ChatStreamJob.perform_later(@chat.id, params[:content])
-   ```
-
-## Optional: ActiveStorage for Attachments
-
-If you want to use file attachments (PDFs, images, etc.), set up ActiveStorage:
-
-```bash
-rails active_storage:install
-rails db:migrate
-```
-
-Then add to your Message model:
-```ruby
-class <%= options[:message_model_name] %> < ApplicationRecord
-  acts_as_message
-  has_many_attached :attachments
-end
-```
-
-## Learn More
-
-- See the [Rails Integration Guide](https://rubyllm.com/guides/rails) for detailed examples
-- Visit the [RubyLLM Documentation](https://rubyllm.com) for full API reference

data/lib/generators/ruby_llm/install_generator.rb

@@ -1,146 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators'
-require 'rails/generators/active_record'
-
-module RubyLLM
-  # Generator for RubyLLM Rails models and migrations
-  class InstallGenerator < Rails::Generators::Base
-    include Rails::Generators::Migration
-
-    namespace 'ruby_llm:install'
-
-    source_root File.expand_path('install/templates', __dir__)
-
-    class_option :chat_model_name, type: :string, default: 'Chat',
-                                   desc: 'Name of the Chat model class'
-    class_option :message_model_name, type: :string, default: 'Message',
-                                      desc: 'Name of the Message model class'
-    class_option :tool_call_model_name, type: :string, default: 'ToolCall',
-                                        desc: 'Name of the ToolCall model class'
-    class_option :model_model_name, type: :string, default: 'Model',
-                                    desc: 'Name of the Model model class (for model registry)'
-    class_option :skip_model, type: :boolean, default: false,
-                              desc: 'Skip creating Model model for model registry persistence'
-
-    desc 'Creates models and migrations for RubyLLM Rails integration'
-
-    def self.next_migration_number(dirname)
-      ::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 acts_as_chat_declaration
-      acts_as_chat_params = []
-      if options[:message_model_name] != 'Message'
-        acts_as_chat_params << "message_class: \"#{options[:message_model_name]}\""
-      end
-      if options[:tool_call_model_name] != 'ToolCall'
-        acts_as_chat_params << "tool_call_class: \"#{options[:tool_call_model_name]}\""
-      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
-      acts_as_message_params = []
-      acts_as_message_params << "chat_class: \"#{options[:chat_model_name]}\"" if options[:chat_model_name] != 'Chat'
-      if options[:tool_call_model_name] != 'ToolCall'
-        acts_as_message_params << "tool_call_class: \"#{options[:tool_call_model_name]}\""
-      end
-      if acts_as_message_params.any?
-        "acts_as_message #{acts_as_message_params.join(', ')}"
-      else
-        'acts_as_message'
-      end
-    end
-
-    def acts_as_tool_call_declaration
-      acts_as_tool_call_params = []
-      if options[:message_model_name] != 'Message'
-        acts_as_tool_call_params << "message_class: \"#{options[:message_model_name]}\""
-      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'
-    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_#{options[:chat_model_name].tableize}.rb"
-
-      # Then create messages table (must come before tool_calls due to foreign key)
-      sleep 1 # Ensure different timestamp
-      migration_template 'create_messages_migration.rb.tt',
-                         "db/migrate/create_#{options[:message_model_name].tableize}.rb"
-
-      # Then create tool_calls table (references messages)
-      sleep 1 # Ensure different timestamp
-      migration_template 'create_tool_calls_migration.rb.tt',
-                         "db/migrate/create_#{options[:tool_call_model_name].tableize}.rb"
-
-      # Finally create models table (for model registry)
-      return if options[:skip_model]
-
-      sleep 1 # Ensure different timestamp
-      migration_template 'create_models_migration.rb.tt',
-                         "db/migrate/create_#{options[:model_model_name].tableize}.rb"
-    end
-
-    def create_model_files
-      template 'chat_model.rb.tt', "app/models/#{options[:chat_model_name].underscore}.rb"
-      template 'message_model.rb.tt', "app/models/#{options[:message_model_name].underscore}.rb"
-      template 'tool_call_model.rb.tt', "app/models/#{options[:tool_call_model_name].underscore}.rb"
-
-      return if options[:skip_model]
-
-      template 'model_model.rb.tt', "app/models/#{options[:model_model_name].underscore}.rb"
-    end
-
-    def create_initializer
-      template 'initializer.rb.tt', 'config/initializers/ruby_llm.rb'
-    end
-
-    def show_install_info
-      say "\n  ✅ RubyLLM installed!", :green
-
-      say "\n  Next steps:", :yellow
-      say '     1. Run: rails db:migrate'
-      say '     2. Set your API keys in config/initializers/ruby_llm.rb'
-      say "     3. Start chatting: #{options[:chat_model_name]}.create!(model_id: 'gpt-4.1-nano').ask('Hello!')"
-
-      unless options[:skip_model]
-        say "     4. Sync models: #{options[:model_model_name]}.sync!"
-        say "\n  🚀 Model registry is database-backed!", :cyan
-        say '     Models will automatically load from the database'
-      end
-
-      say "\n  📚 Full docs: https://rubyllm.com", :cyan
-
-      say "\n  ❤️  Love RubyLLM?", :magenta
-      say '     • ⭐ Star on GitHub: https://github.com/crmne/ruby_llm'
-      say '     • 💖 Sponsor: https://github.com/sponsors/crmne'
-      say "\n"
-    end
-  end
-end