Add chat UI scaffold generator with Turbo streaming

Creates a complete chat interface with:
- Chat and message controllers following Rails conventions
- Simple HTML views for chat list, creation, and messaging
- Model selector in new chat form
- Models index page showing available AI models
- Background job for streaming AI responses
- Turbo Stream integration for real-time message updates
- Automatic broadcasting from Message model
- Clean, simple controller methods

The generator creates a working chat UI that can be customized
while maintaining Rails best practices and simplicity.

Author: crmne

.rubocop.yml

@@ -10,6 +10,7 @@ AllCops:
     - docs/**/*
     - vendor/**/*
     - gemfiles/**/*
+    - lib/generators/**/templates/**/*
   SuggestExtensions: false
 
 Metrics/ClassLength:

lib/generators/ruby_llm/chat_ui/chat_ui_generator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module RubyLLM
+  module Generators
+    # Generates a simple chat UI scaffold for RubyLLM
+    class ChatUIGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      namespace 'ruby_llm:chat_ui'
+
+      def create_views
+        # Chat views
+        template 'views/chats/index.html.erb', 'app/views/chats/index.html.erb'
+        template 'views/chats/new.html.erb', 'app/views/chats/new.html.erb'
+        template 'views/chats/show.html.erb', 'app/views/chats/show.html.erb'
+        template 'views/chats/_chat.html.erb', 'app/views/chats/_chat.html.erb'
+        template 'views/chats/_form.html.erb', 'app/views/chats/_form.html.erb'
+
+        # Message views
+        template 'views/messages/_message.html.erb', 'app/views/messages/_message.html.erb'
+        template 'views/messages/_form.html.erb', 'app/views/messages/_form.html.erb'
+        template 'views/messages/create.turbo_stream.erb', 'app/views/messages/create.turbo_stream.erb'
+
+        # Model views
+        template 'views/models/index.html.erb', 'app/views/models/index.html.erb'
+        template 'views/models/show.html.erb', 'app/views/models/show.html.erb'
+      end
+
+      def create_controllers
+        template 'controllers/chats_controller.rb', 'app/controllers/chats_controller.rb'
+        template 'controllers/messages_controller.rb', 'app/controllers/messages_controller.rb'
+        template 'controllers/models_controller.rb', 'app/controllers/models_controller.rb'
+      end
+
+      def create_jobs
+        template 'jobs/chat_response_job.rb', 'app/jobs/chat_response_job.rb'
+      end
+
+      def add_routes
+        route 'resources :models, only: [:index, :show]'
+        route "resources :chats do\n    resources :messages, only: [:create]\n  end"
+      end
+
+      def display_post_install_message
+        readme 'README' if behavior == :invoke
+      end
+    end
+  end
+end

lib/generators/ruby_llm/chat_ui/templates/README

@@ -0,0 +1,31 @@
+===============================================================================
+
+The chat UI has been successfully generated!
+
+Next steps:
+
+1. Make sure your models are set up with the RubyLLM acts_as methods:
+
+   class Chat < ApplicationRecord
+     acts_as_chat
+   end
+
+   class Message < ApplicationRecord
+     acts_as_message
+   end
+
+2. Run migrations if you haven't already:
+
+   rails db:migrate
+
+3. Start your Rails server and visit:
+
+   http://localhost:3000/chats
+
+4. The UI provides:
+   - A list of all chats at /chats
+   - Create new chats with an initial prompt at /chats/new
+   - View and continue conversations at /chats/:id
+   - Simple, clean HTML interface
+
+===============================================================================

lib/generators/ruby_llm/chat_ui/templates/controllers/chats_controller.rb

@@ -0,0 +1,38 @@
+class ChatsController < ApplicationController
+  before_action :set_chat, only: [:show]
+
+  def index
+    @chats = Chat.order(created_at: :desc)
+  end
+
+  def new
+    @chat = Chat.new
+  end
+
+  def create
+    return unless prompt.present?
+
+    @chat = Chat.create!(model: model)
+    ChatResponseJob.perform_later(@chat.id, prompt)
+
+    redirect_to @chat, notice: 'Chat was successfully created.'
+  end
+
+  def show
+    @message = @chat.messages.build
+  end
+
+  private
+
+  def set_chat
+    @chat = Chat.find(params[:id])
+  end
+
+  def model
+    params[:chat][:model].presence
+  end
+
+  def prompt
+    params[:chat][:prompt]
+  end
+end

lib/generators/ruby_llm/chat_ui/templates/controllers/messages_controller.rb

@@ -0,0 +1,24 @@
+class MessagesController < ApplicationController
+  before_action :set_chat
+
+  def create
+    return unless content.present?
+
+    ChatResponseJob.perform_later(@chat.id, content)
+
+    respond_to do |format|
+      format.turbo_stream
+      format.html { redirect_to @chat }
+    end
+  end
+
+  private
+
+  def set_chat
+    @chat = Chat.find(params[:chat_id])
+  end
+
+  def content
+    params[:message][:content]
+  end
+end

lib/generators/ruby_llm/chat_ui/templates/controllers/models_controller.rb

@@ -0,0 +1,9 @@
+class ModelsController < ApplicationController
+  def index
+    @models = Model.all.group_by(&:provider)
+  end
+
+  def show
+    @model = Model.find(params[:id])
+  end
+end

lib/generators/ruby_llm/chat_ui/templates/jobs/chat_response_job.rb

@@ -0,0 +1,12 @@
+class ChatResponseJob < ApplicationJob
+  def perform(chat_id, content)
+    chat = Chat.find(chat_id)
+
+    chat.ask(content) do |chunk|
+      if chunk.content && !chunk.content.blank?
+        message = chat.messages.last
+        message.update!(content: message.content + chunk.content)
+      end
+    end
+  end
+end

lib/generators/ruby_llm/chat_ui/templates/views/chats/_chat.html.erb

@@ -0,0 +1,6 @@
+<div id="<%%= dom_id chat %>">
+  <p><strong>Chat #<%%= chat.id %></strong></p>
+  <p><%%= chat.model.name %></p>
+  <p><%%= chat.created_at.strftime("%B %d, %Y at %I:%M %p") %></p>
+  <p><%%= pluralize(chat.messages.count, 'message') %></p>
+</div>

lib/generators/ruby_llm/chat_ui/templates/views/chats/_form.html.erb

@@ -0,0 +1,30 @@
+<%%= form_with(model: chat, url: chats_path) do |form| %>
+  <%% if chat.errors.any? %>
+    <div style="color: red">
+      <h2><%%= pluralize(chat.errors.count, "error") %> prohibited this chat from being saved:</h2>
+
+      <ul>
+        <%% chat.errors.each do |error| %>
+          <li><%%= error.full_message %></li>
+        <%% end %>
+      </ul>
+    </div>
+  <%% end %>
+
+  <div>
+    <%%= form.label :model, "Select AI model:", style: "display: block" %>
+    <%%= form.select :model,
+        options_for_select(Model.pluck(:name, :model_id).unshift(["Default (#{RubyLLM.config.default_model})", nil])),
+        {},
+        style: "width: 100%; max-width: 600px; padding: 5px;" %>
+  </div>
+
+  <div style="margin-top: 15px;">
+    <%%= form.label :prompt, "Enter your prompt:", style: "display: block" %>
+    <%%= form.text_area :prompt, rows: 4, style: "width: 100%; max-width: 600px;" %>
+  </div>
+
+  <div style="margin-top: 15px;">
+    <%%= form.submit "Start new chat" %>
+  </div>
+<%% end %>

lib/generators/ruby_llm/chat_ui/templates/views/chats/index.html.erb

@@ -0,0 +1,16 @@
+<p style="color: green"><%%= notice %></p>
+
+<%% content_for :title, "Chats" %>
+
+<h1>Chats</h1>
+
+<div id="chats">
+  <%% @chats.each do |chat| %>
+    <%%= render chat %>
+    <p>
+      <%%= link_to "Show this chat", chat %>
+    </p>
+  <%% end %>
+</div>
+
+<%%= link_to "New chat", new_chat_path %>