tramway 3.0.3.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17fe97e6ab94f2d72d4cb67fad3facfafa3d2e9e046e9a52b84bc376beddd3f2
-  data.tar.gz: 1d3ba244c662e9facdd4a2f28c63c4a20bfb720295fca5713e7eb633cf1ff696
+  metadata.gz: 8f1294b704f5b6bc2779d6eae4168a9c63508af6b485dfe267fa70a1b2ca786e
+  data.tar.gz: 662bf3c75f819a46229a55cce0804b11a70511ade1ecbc08e8aa50a09d246381
 SHA512:
-  metadata.gz: 745193d204d4e871248c8bc7531dd5d74b9c99759cc45d5190ed1f66ffca3b109d82239154aa86cfd70804c15c1683f848b92adbd20a43d3bdddc102a2c9b7d2
-  data.tar.gz: d14350608083e3dc4ab6d0c4de6bd7e057a45c9d289c0fdff37080e0e365b4d265f734647cfe296afbc1356c1dcf0ea1c7ef3258265206f588b85f3e90f2f6ad
+  metadata.gz: 90eb4ab0b7d5e871f904d320a42469ea92d35a83ebad3c014b167fe7b5294e7c046c1c0ebc41f64a09693794995e82641d69b3cb9d59d3e5183f5108ace44745
+  data.tar.gz: 53bc0d610787669587ed26f4c6bbadce0c0e476ae34b8f4ea49128ad7e20265080d09abdf3726fea93aea1014a2a935b12077b6049c47fd46c199c044ad6872f

data/README.md

@@ -925,17 +925,17 @@ When set to `false`, the text field is disabled and the waiting placeholder is s
 If you do not want to render the message form, pass `message_form: nil`. When the form is present, `send_message_path` is
 required and the helper will generate the correct POST form.
 
-To append messages to an already-rendered `tramway_chat` stream, use `tramway_chat_append_message`.
+To append a message to an already-rendered `tramway_chat` stream, use `tramway_chat_append_message`.
 The method is mixed into controllers and ActiveRecord models by Tramway and expects:
 - `chat_id:` — the same value used in `tramway_chat chat_id:`
-- `message_type:` — only `:sent` or `:received` (raises `ArgumentError` otherwise)
+- `type:` — only `:sent` or `:received` (raises `ArgumentError` otherwise)
 - `text:` — message content
 - `sent_at:` — message timestamp
 
 ```ruby
 tramway_chat_append_message(
   chat_id: 'support-chat',
-  message_type: :received,
+  type: :received,
   text: 'We got your request',
   sent_at: Time.current
 )
@@ -943,6 +943,49 @@ tramway_chat_append_message(
 
 It broadcasts with `target: 'messages'` and renders the `tramway/chats/message` partial so the message appears in the live chat.
 
+To prepend a message to the same stream, use `tramway_chat_prepend_message`. It accepts the same arguments and validation rules,
+but inserts the rendered `tramway/chats/message` partial at the beginning of the `messages` target instead of the end.
+
+```ruby
+tramway_chat_prepend_message(
+  chat_id: 'support-chat',
+  type: :received,
+  text: 'Earlier message from history',
+  sent_at: 5.minutes.ago
+)
+```
+
+To append multiple messages at once, use `tramway_chat_append_messages`. The method expects:
+- `chat_id:` — the same value used in `tramway_chat chat_id:`
+- `messages:` — an array of hashes, where each hash includes `type:`, `text:`, and `sent_at:`
+
+Each message `type:` must be `:sent` or `:received` or the helper raises `ArgumentError`. It broadcasts with `target:
+'messages'` and renders the `tramway/chats/messages` partial so the full collection appears in the live chat.
+
+```ruby
+tramway_chat_append_messages(
+  chat_id: 'support-chat',
+  messages: [
+    { type: :received, text: 'First update', sent_at: 2.minutes.ago },
+    { type: :sent, text: 'Thanks, checking now', sent_at: 1.minute.ago }
+  ]
+)
+```
+
+To prepend multiple messages, use `tramway_chat_prepend_messages`. It accepts the same `chat_id:` and `messages:` arguments
+as `tramway_chat_append_messages`, validates each `type:`, and prepends the rendered `tramway/chats/messages` partial to the
+beginning of the `messages` target.
+
+```ruby
+tramway_chat_prepend_messages(
+  chat_id: 'support-chat',
+  messages: [
+    { type: :received, text: 'Older history item', sent_at: 10.minutes.ago },
+    { type: :sent, text: 'Reply from earlier', sent_at: 9.minutes.ago }
+  ]
+)
+```
+
 ### Tramway Table Component
 
 Tramway provides a responsive, tailwind-styled table with light and dark themes. Use the `tramway_table`, `tramway_row`, and

data/app/components/tramway/chat_component.html.haml

@@ -1,7 +1,7 @@
 = helpers.turbo_stream_from chat_id, 'messages'
 
 #chat.flex.flex-1.h-full.w-full.min-h-0.min-w-0.flex-col
-  #messages.flex.flex-col.flex-1.min-h-0.overflow-y-auto.overflow-x-hidden.p-2.md:p-6.space-y-2.md:space-y-4.md:rounded-xl.rounded-t-xl{ class: 'text-gray-100 bg-gray-800/60' }
+  #messages.flex.flex-col.flex-1.min-h-0.overflow-y-auto.overflow-x-hidden.p-2.md:p-6.space-y-2.md:space-y-4.md:rounded-xl.rounded-t-xl{ class: 'text-gray-100 bg-gray-800/60', data: { scroll_to_bottom_on_update: scroll_to_bottom_on_update } }
     - messages.each do |message|
       = component "tramway/chats/message", **message
     - if disabled?
@@ -31,13 +31,23 @@
       const messages = document.getElementById('messages');
       if (!messages || messages.dataset.chatScrollInitialized === 'true') return;
 
+      const shouldScrollToBottomOnUpdate = () => {
+        return messages.dataset.scrollToBottomOnUpdate !== 'false' &&
+          messages.dataset.preserveScroll !== 'true';
+      };
+
       const scrollToBottom = () => {
         messages.scrollTop = messages.scrollHeight;
       };
 
+      // Always scroll to bottom on initial page load.
       scrollToBottom();
 
-      const observer = new MutationObserver(scrollToBottom);
+      const observer = new MutationObserver(() => {
+        if (!shouldScrollToBottomOnUpdate()) return;
+        scrollToBottom();
+      });
+
       observer.observe(messages, { childList: true });
 
       messages.dataset.chatScrollInitialized = 'true';

data/app/components/tramway/chat_component.rb

@@ -9,6 +9,7 @@ module Tramway
     option :options, optional: true, default: -> { {} }
     option :send_message_path
     option :send_messages_enabled, optional: true, default: -> { true }
+    option :scroll_to_bottom_on_update, optional: true, default: -> { true }
 
     def disabled?
       options[:disabled]

data/app/components/tramway/containers/main_component.html.haml

@@ -1,2 +1,2 @@
-%main.w-full.min-h-dvh{ class: container_classes }
+%main.w-full.min-h-dvh{ class: container_classes, **options.except(:class) }
   = content

data/app/components/tramway/containers/main_component.rb

@@ -4,9 +4,13 @@ module Tramway
   module Containers
     # Main container for tailwind-styled layout
     class MainComponent < Tramway::BaseComponent
+      option :options, optional: true, default: proc { {} }
+
       def container_classes
+        options_classes = options[:class] || ''
+
         theme_classes(
-          classic: 'bg-gray-900 text-gray-100 shadow-inner'
+          classic: "bg-gray-900 text-gray-100 shadow-inner#{options_classes}"
         )
       end
     end

data/app/components/tramway/containers/narrow_component.html.haml

@@ -1,3 +1,3 @@
-%div{ class: container_classes, id:, **options }
+%div{ class: container_classes, id:, **options.except(:class, :id) }
   .flex.flex-col.justify-center.w-full
     = content

data/app/components/tramway/containers/narrow_component.rb

@@ -8,9 +8,11 @@ module Tramway
       option :options, optional: true, default: proc { {} }
 
       def container_classes
+        options_classes = options[:class] || ''
+
         theme_classes(
           classic: 'container p-4 flex align-center justify-center w-full mx-auto bg-gray-100 text-gray-700 ' \
-                   'shadow-inner rounded-xl bg-gray-900 text-gray-100'
+                   'shadow-inner rounded-xl bg-gray-900 text-gray-100' + options_classes
         )
       end
     end

data/app/views/tramway/chats/_message.html.haml

@@ -1,4 +1 @@
-= component 'tramway/chats/message',
-  type:,
-  text:,
-  sent_at:
+= component 'tramway/chats/message', type:, text:, sent_at:

data/app/views/tramway/chats/_messages.html.haml

@@ -0,0 +1,2 @@
+- messages.each do |message|
+  = component 'tramway/chats/message', type:, text:, sent_at:

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

@@ -91,7 +91,7 @@ module Tramway
       end
 
       def agents_template_url
-        'https://github.com/Purple-Magic/base_project/blob/main/docs/agents/tramway.md'
+        'https://raw.githubusercontent.com/Purple-Magic/tramway-skill/refs/heads/main/skills/tramway-skill/agents/tramway.md'
       end
 
       def agents_template_body

data/lib/tramway/chats/broadcast.rb

@@ -14,6 +14,43 @@ module Tramway
                                                   partial: 'tramway/chats/message',
                                                   locals: { type:, text:, sent_at: }
       end
+
+      def tramway_chat_prepend_message(chat_id:, type:, text:, sent_at:)
+        raise ArgumentError, 'message_type must be :sent or :received' unless MESSAGE_TYPES.include?(type.to_sym)
+
+        Turbo::StreamsChannel.broadcast_prepend_to [chat_id, 'messages'],
+                                                   target: 'messages',
+                                                   partial: 'tramway/chats/message',
+                                                   locals: { type:, text:, sent_at: }
+      end
+
+      def tramway_chat_append_messages(chat_id:, messages:)
+        messages.each do |message|
+          unless MESSAGE_TYPES.include?(message[:type].to_sym)
+            raise ArgumentError,
+                  'Each message must have :id and :type keys'
+          end
+        end
+
+        Turbo::StreamsChannel.broadcast_append_to [chat_id, 'messages'],
+                                                  target: 'messages',
+                                                  partial: 'tramway/chats/messages',
+                                                  locals: { messages: }
+      end
+
+      def tramway_chat_prepend_messages(chat_id:, messages:)
+        messages.each do |message|
+          unless MESSAGE_TYPES.include?(message[:type].to_sym)
+            raise ArgumentError,
+                  'Each message must have :id and :type keys'
+          end
+        end
+
+        Turbo::StreamsChannel.broadcast_prepend_to [chat_id, 'messages'],
+                                                   target: 'messages',
+                                                   partial: 'tramway/chats/messages',
+                                                   locals: { messages: }
+      end
     end
   end
 end

data/lib/tramway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tramway
-  VERSION = '3.0.3.3'
+  VERSION = '3.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 3.0.3.3
+  version: 3.0.4
 platform: ruby
 authors:
 - kalashnikovisme
@@ -250,6 +250,7 @@ files:
 - app/views/kaminari/_paginator.html.haml
 - app/views/kaminari/_prev_page.html.haml
 - app/views/tramway/chats/_message.html.haml
+- app/views/tramway/chats/_messages.html.haml
 - app/views/tramway/entities/_form.html.haml
 - app/views/tramway/entities/_list.html.haml
 - app/views/tramway/entities/edit.html.haml