chat_manager 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 657c0a813d68c57d94d7a4583a690bca52696bb46057504e63516b1b84e7c05d
-  data.tar.gz: 1a1b07a2d9e997c0fa4b8e6748639bb2325d35bbcf6d74691f29758e5306cc09
+  metadata.gz: 8b511ecced21ece0ee04d99c18a5ddc602583a0e8ec259669f8127e81fc80624
+  data.tar.gz: f7dfc3090521f0e533a5c1ab684f1ad3b25c8ed5f00d61c0bcc589d095760563
 SHA512:
-  metadata.gz: e3b1677ea4441b6c23edac0730dd9fc31dbdd91e46fd0d293704d1f7210aabb086bdd190ce8376b1cc1ca4f7296ba6511286198fa9c120aaa18ee40b14d52023
-  data.tar.gz: b7cb2b4b5c9dda1c5dce2e9479dca145adedfc6c0b202a730b1ffeb58433d6f7f4764d027e424a553e8e03f6da466b4f05078d37da4a40edfdfc6f1540bbeaf3
+  metadata.gz: 584400568e1b29a5de4cf9379399427815c7deccd1e59003a4fb69ecf850ce71636682a047115fb2170d14fb760afca584a6e0f29e7a5f625c493782c29975e4
+  data.tar.gz: 7643eac34c2623e4c46e068b9daf8e54b1adb41f71b0f59c1bab94c5c3953596b97a9cab1b0795567cc584d8499954044feea34d7f0f8082db79325056335daa

data/README.md

@@ -1,10 +1,23 @@
 # ChatManager
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+A Rails engine for managing LLM chat conversations with CSV export, auto-titling, and ready-to-use UI components.
+
+## Features
+
+- **Chat Management** — Controller concern (`ChatManageable`) for initializing and managing chat arrays with duplicate/nil prevention
+- **Automatic Title Generation** — Model concern (`TitleGeneratable`) for generating chat titles from initial prompts
+- **CSV Export** — Controller concern (`CsvDownloadable`) for individual and bulk chat CSV downloads
+- **UI Components** — Chat list and chat card partials with Stimulus-powered inline title editing
+- **Database Migration Generator** — `chat_manager:modeling` generator for creating the chats table
+- **Turbo/Turbolinks Safe** — CSV download links work correctly with modern Rails JS frameworks
+
+## Requirements
+
+- Ruby 4.0+
+- Rails 8.1+
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -12,17 +25,161 @@ gem "chat_manager"
 ```
 
 And then execute:
+
 ```bash
-$ bundle
+$ bundle install
 ```
 
 Or install it yourself as:
+
 ```bash
 $ gem install chat_manager
 ```
 
+## Setup
+
+### 1. Run the migration generator
+
+```bash
+$ rails generate chat_manager:modeling
+$ rails db:migrate
+```
+
+This creates the `chat_manager_chats` table with the following columns:
+
+| Column | Type | Description |
+|---|---|---|
+| `uuid` | string (NOT NULL) | Unique identifier for the chat |
+| `title` | string | Chat title (auto-generated or manually set) |
+| `llm_uuid` | string | LLM identifier |
+| `model` | string | Model name/type |
+| `created_at` | datetime | Timestamp |
+| `updated_at` | datetime | Timestamp |
+
+### 2. Include concerns in your controller
+
+```ruby
+class ChatsController < ApplicationController
+  include ChatManager::ChatManageable
+  include ChatManager::CsvDownloadable
+
+  def index
+    initialize_chat(current_user.chats)
+    set_active_chat_uuid(params[:uuid])
+  end
+end
+```
+
+### 3. Include the title generation concern in your model
+
+```ruby
+class Chat < ApplicationRecord
+  include ChatManager::TitleGeneratable
+
+  # You must implement this method
+  def summarize_for_title(prompt_text, jwt_token)
+    # Call your LLM API to generate a title from the prompt
+    # Return a string (max 255 characters)
+  end
+end
+```
+
+## Usage
+
+### ChatManageable (Controller Concern)
+
+Provides methods for managing chat arrays in your controller:
+
+```ruby
+initialize_chat(chats)        # Initialize with a collection of chats
+set_active_chat_uuid(uuid)    # Set the active chat UUID
+add_chat(chat)                # Add a chat (prevents nil and duplicates)
+```
+
+### CsvDownloadable (Controller Concern)
+
+Provides CSV export actions:
+
+```ruby
+download_csv      # Download a single chat as CSV
+download_all_csv  # Download all user chats as CSV
+```
+
+CSV output includes the following columns: `Chat Title`, `Role`, `Message Content`, `Sent At`, `Model`.
+
+**Prerequisites:** The host application must provide:
+
+- `current_user` method in the controller (returning an object with a `chats` association)
+- `chats` association that supports `.includes(messages: :prompt_manager_prompt_execution)`
+- `ordered_messages` method on the Chat model
+- Each message must have a `role` attribute and a `prompt_manager_prompt_execution` association with `prompt` and `response` attributes
+
+### TitleGeneratable (Model Concern)
+
+Generates a chat title from the initial user prompt:
+
+```ruby
+chat.generate_title(prompt_text, jwt_token)
+```
+
+Delegates to the `summarize_for_title` method which must be implemented by the including model.
+
+### View Helper
+
+Use the `chat_list` helper in your views to render the chat list UI:
+
+```erb
+<%= chat_list(
+  ->(uuid) { chat_path(uuid) },
+  active_uuid: @active_uuid,
+  download_csv_path: ->(uuid) { download_csv_chat_path(uuid) },
+  download_all_csv_path: download_all_csv_chats_path
+) %>
+```
+
+Parameters:
+
+| Parameter | Type | Required | Description |
+|---|---|---|---|
+| `card_path` | Positional | Yes | Proc/lambda that receives a UUID string and returns the path for each chat card link |
+| `active_uuid` | Keyword | No | ID of the currently active chat (for highlighting) |
+| `download_csv_path` | Keyword | No | Proc/lambda that receives a UUID string and returns the CSV download path for each chat |
+| `download_all_csv_path` | Keyword | No | Path for the "Download All Chats CSV" button |
+
+### UI Components
+
+The engine provides two partials:
+
+- **`chat_manager/chat_list`** — Renders the full chat list with optional bulk CSV download button
+- **`chat_manager/chat_card`** — Renders an individual chat card with:
+  - Title display (truncated to 30 characters)
+  - Active state highlighting
+  - Inline title editing via Stimulus (`chat-title-edit` controller)
+  - Optional per-chat CSV download button
+
+### Stylesheets
+
+The engine includes CSS for the chat interface. Available CSS classes:
+
+- `.chat-stack` — Flex column layout for the chat list
+- `.chat-card` — Card styling with hover effects and active state (`.is-active` modifier)
+- `.chat-card-row` — Flex row layout for card content and download button
+- `.chat-card-link` — Grid layout for card link area
+- `.chat-card-prompt` — Title text display with line clamping
+- `.chat-card-number` — Chat number label
+- `.chat-card-download` — Per-chat CSV download button
+- `.chat-card-title-input` — Inline edit input field
+- `.chat-download-all` — Container for the bulk download button
+- `.chat-download-all-link` — Bulk download button
+
 ## Contributing
-Contribution directions go here.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/chat_manager/version.rb

@@ -1,3 +1,3 @@
 module ChatManager
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chat_manager
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - dhq_boiler
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A Rails engine for managing LLM chat conversations with CSV export and auto-titling.
 test_files: []