Class: OllamaChat::MessageList

Inherits:
Object
  • Object
show all
Includes:
MessageFormat, Pager, Utils::ValueFormatter, Term::ANSIColor
Defined in:
lib/ollama_chat/message_list.rb

Overview

A collection class for managing chat messages with support for system prompts, paged output, and conversation history.

This class provides functionality for storing, retrieving, and displaying chat messages in a structured manner. It handles system prompts separately from regular user and assistant messages, supports pagination for displaying conversations, and offers methods for manipulating message history including clearing, loading, saving, and dropping exchanges. The class integrates with Kramdown::ANSI for formatted output.

Examples:

Creating a new message list

chat = OllamaChat::Chat.new
messages = OllamaChat::MessageList.new(chat)

Adding messages to the list

messages << OllamaChat::Message.new(role: 'user', content: 'Hello')
messages << OllamaChat::Message.new(role: 'assistant', content: 'Hi there!')

Displaying conversation history

messages.list_conversation(5)  # Shows last 5 exchanges

Clearing messages

messages.clear  # Removes all non-system messages

Loading a saved conversation

messages.load_conversation('conversation.json')

Saving current conversation

messages.save_conversation('my_conversation.json')

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils::ValueFormatter

#format_bytes, #format_tokens

Methods included from Pager

#determine_pager_command, #use_pager

Methods included from MessageFormat

#chat, #display_sender, #message_type, #role_color, #role_template, #sender_name_displayed, #talk_annotate, #think_annotate

Constructor Details

#initialize(chat) ⇒ MessageList

The initialize method sets up the message list for an OllamaChat session.

Parameters:



40
41
42
43
 
# File 'lib/ollama_chat/message_list.rb', line 40

def initialize(chat)
  @chat     = chat
  @messages = []
end

Instance Attribute Details

#messages ⇒ Object (readonly)

The messages attribute reader returns the messages set for this object, initializing it lazily if needed.

The messages set is memoized, meaning it will only be created once per object instance and subsequent calls will return the same OllamaChat::MessageList instance.



64
65
66
 
# File 'lib/ollama_chat/message_list.rb', line 64

def messages
  @messages
end

#system ⇒ Object (readonly)

The system attribute reader returns the system prompt for the chat session.



48
49
50
 
# File 'lib/ollama_chat/message_list.rb', line 48

def system
  @system
end

#system_name ⇒ Object (readonly)

The system_name attribute reader returns the name of the current system prompt.



53
54
55
 
# File 'lib/ollama_chat/message_list.rb', line 53

def system_name
  @system_name
end

Instance Method Details

#<<(message) ⇒ OllamaChat::MessageList

The << operator appends a message to the list of messages and returns self.

Parameters:

Returns:



90
91
92
93
 
# File 'lib/ollama_chat/message_list.rb', line 90

def <<(message)
  @messages << message
  sync
end

#clean_messages(messages: @messages) ⇒ Array<OllamaChat::Message>

Returns a new list of messages with the content replaced by their stripped versions. This is used to create a "clean" version of the conversation for saving or displaying without mutating the original message objects.

Parameters:

  • messages (Array<OllamaChat::Message>) (defaults to: @messages) —

    the list of messages to clean

Returns:

  • (Array<OllamaChat::Message>) —

    a new array containing duplicated messages with stripped content



198
199
200
201
202
203
204
205
 
# File 'lib/ollama_chat/message_list.rb', line 198

def clean_messages(messages: @messages)
  messages.map do |message|
    message = message.dup
    message.content = '' if message.tool?
    message.images = nil
    message
  end
end

#clear(all: false) ⇒ OllamaChat::MessageList

The clear method removes all non-system messages from the message list.

Returns:



76
77
78
79
80
81
82
83
 
# File 'lib/ollama_chat/message_list.rb', line 76

def clear(all: false)
  if all
    @messages.clear
  else
    @messages.delete_if { _1.role != 'system' }
  end
  sync
end

#clear_images ⇒ OllamaChat::MessageList

Removes all images from all messages in the current list.

Returns:



440
441
442
443
444
445
 
# File 'lib/ollama_chat/message_list.rb', line 440

def clear_images
  @messages.each do |message|
    message.images = nil
  end
  sync
end

#config ⇒ Object (private)

The config method provides access to the chat configuration object.

Returns:

  • (Object) —

    the configuration object associated with the chat instance



452
453
454
 
# File 'lib/ollama_chat/message_list.rb', line 452

def config
  @chat.config
end

#construct_message_from_hash(hash) ⇒ OllamaChat::Message (private)

Constructs a message instance from a hash, ensuring that a 'content' key is present even if it is nil.

Parameters:

  • hash (Hash) —

    the message data

Returns:



517
518
519
 
# File 'lib/ollama_chat/message_list.rb', line 517

def construct_message_from_hash(hash)
  OllamaChat::Message.from_hash(hash | { 'content' => nil })
end

#drop(n) ⇒ Integer

Note:

This method automatically synchronizes the message list with the session store.

Removes the last n conversation exchanges from the message list.

An exchange is typically defined as a pair of user and assistant messages. This method iterates backwards through the history and removes messages until the requested number of exchanges have been dropped. It will stop if it encounters a system message.

Parameters:

  • n (Object) —

    The number of exchanges to drop.

Returns:

  • (Integer) —

    The actual number of exchanges that were dropped.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/ollama_chat/message_list.rb', line 305

def drop(n)
  n = n.to_i.clamp(1, Float::INFINITY)
  i = 0
  m = 0
  @messages.reverse_each.each_cons(2) do |message, before|
    message.role == 'system' and break
    if message.role == 'assistant'
      i += 1
    elsif message.role == 'user'
      i += 1
      next if before.role == 'user'
      m += 1
    end
    m >= n and break
  end
  i.times { @messages.pop }
  STDOUT.puts "Dropped the last #{m} exchanges."
  m
ensure
  sync
end

#each_message(role: %w[ user assistant ],, tool: false) {|message| ... } ⇒ Enumerator?

Iterates over messages in the conversation, yielding those matching the specified roles.

Parameters:

  • role (Array<String>) (defaults to: %w[ user assistant ],) —

    the roles to include when iterating. Defaults to ['user', 'assistant'].

  • tool (Boolean) (defaults to: false) —

    Whether to include messages that are tool calls/responses. Defaults to false.

Yields:

  • (message) —

    yields each matching message.

Returns:

  • (Enumerator) —

    if no block is given, returns an enumerator.

  • (nil) —

    if a block is given, returns nil after yielding all matching messages.



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/ollama_chat/message_list.rb', line 148

def each_message(role: %w[ user assistant ], tool: false, &block)
  block or return enum_for(__method__, role:, tool:)

  @messages.each do |message|
    role.include?(message.role) or next
    !tool && message.tool? and next
    yield message
  end
  nil
end

#find_last(content: false) {|Message| ... } ⇒ OllamaChat::Message?

Note:

The method iterates in reverse order (reverse_each) so that the most recent matching message is returned. It also respects the content flag to skip empty messages, which is handy when the chat history contains empty messages e. g. when tool calling.

Find the last message that satisfies the supplied block.

Examples:

Find the last assistant message that contains content

last_assistant = message_list.find_last(content: true) { |m| m.role == 'assistant' }

Find the last user message regardless of content

last_user = message_list.find_last { |m| m.role == 'user' }

Parameters:

  • content (true, false) (defaults to: false) —

    If true, skip messages that have no content (m.content.present? is false). This is useful when you only care about messages that actually contain a payload (e.g. assistant replies, user queries, etc.).

Yields:

  • (Message) —

    yields each message in reverse order (from newest to oldest) until the block returns a truthy value.

Yield Parameters:

Yield Returns:

  • (true, false) —

    whether the message matches the criteria

Returns:

  • (OllamaChat::Message, nil) —

    the first message that matches the block, or nil if none match.



129
130
131
132
133
134
 
# File 'lib/ollama_chat/message_list.rb', line 129

def find_last(content: false, &block)
  @messages.reverse_each.find { |m|
    content and !m.content.present? and next
    block.(m)
  }
end

#last ⇒ OllamaChat::Message

Returns the last message from the conversation.

Returns:

  • (OllamaChat::Message) —

    The last message in the conversation, or nil if there are no messages.



99
100
101
 
# File 'lib/ollama_chat/message_list.rb', line 99

def last
  @messages.last
end

#list_conversation(last = nil) ⇒ OllamaChat::MessageList

Displays the most recent messages from the conversation history.

This method prints a specified number of trailing messages to the console using the pager for better readability. Tool messages are automatically excluded from the output. If no count is provided, the entire conversation is displayed.

Parameters:

  • last (Integer, nil) (defaults to: nil) —

    The number of recent messages to display. Defaults to the total size of the messages list if nil.

Returns:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/ollama_chat/message_list.rb', line 218

def list_conversation(last = nil)
  messages = @messages.reject(&:tool?)
  last = (last || messages.size).clamp(0, messages.size)
  messages = messages[-last..-1].to_ary
  use_pager do |output|
    messages = clean_messages(messages:)
    messages = messages.with_infobar(
      output:  STDERR,
      label:   'Message',
      total:   messages.size,
      message: @chat.infobar_message,
    )
    messages.each do |message|
      output.puts message_text_for(message)
      +infobar
    end
  end
  self
end

#load_conversation(filename) ⇒ OllamaChat::MessageList

The load_conversation method loads a conversation from a file and populates the message list.

Parameters:

  • filename (String) —

    the path to the file containing the conversation

Returns:



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/ollama_chat/message_list.rb', line 165

def load_conversation(filename)
  filename = Pathname.new(filename).expand_path
  unless filename.exist?
    STDERR.puts "File #{filename.to_s.inspect} doesn't exist. Choose another filename."
    return
  end
  @messages = OllamaChat::Utils::JSONJSONLIO.new(filename).read(
    jsonl_transform: method(:parse_message_from_json),
    json_transform:  method(:construct_message_from_hash)
  ).to_a
  sync
end

#load_conversation_jsonl(filename) ⇒ Array<OllamaChat::Message> (private)

Loads a conversation from a JSONL (JSON Lines) file.

Parameters:

  • filename (Pathname) —

    the path to the JSONL file

Returns:



487
488
489
490
491
 
# File 'lib/ollama_chat/message_list.rb', line 487

def load_conversation_jsonl(filename)
  filename.each_line.map {
    parse_message_from_json(_1)
  }
end

#message_text_for(message) ⇒ String (private)

The message_text_for method generates formatted text representation of a message including its role, content, thinking annotations, and associated images. It applies color coding to different message roles and uses markdown parsing when enabled. The method also handles special formatting for thinking annotations and image references within the message.

Parameters:

  • message (Object) —

    the message object containing role, content, thinking, and images

Returns:

  • (String) —

    the formatted text representation of the message



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/ollama_chat/message_list.rb', line 466

def message_text_for(message)
  thinking = if @chat.think_loud?
               think_annotate do
                 message.thinking.full? { @chat.markdown.on? ? @chat.kramdown_ansi_parse(_1) : _1 }
               end
             end
  content       = message.content.full? { @chat.markdown.on? ? @chat.kramdown_ansi_parse(_1) : _1 }
  message_text  = display_sender(message)
  if thinking
    message_text += [ ?:, thinking, talk_annotate { content } ].compact.
      map(&:chomp) * ?\n
  else
    message_text += ":\n#{content}"
  end
  message_text
end

#parse_message_from_json(string) ⇒ OllamaChat::Message (private)

Parse a message from a JSON string.

Parameters:

  • string (String) —

    the JSON string representing the message

Returns:



508
509
510
 
# File 'lib/ollama_chat/message_list.rb', line 508

def parse_message_from_json(string)
  construct_message_from_hash(JSON.parse(string))
end

#read_conversation_jsonl(input) ⇒ OllamaChat::MessageList

Loads conversation messages from a JSONL (JSON Lines) input stream. Each line in the input is expected to be a valid JSON representation of a message. The method parses each line and adds the resulting message to the current conversation.

Parameters:

  • input (IO) —

    the input stream containing JSONL formatted messages

Returns:



429
430
431
432
433
434
435
 
# File 'lib/ollama_chat/message_list.rb', line 429

def read_conversation_jsonl(input)
  @messages = OllamaChat::Utils::JSONJSONLIO.new('as.jsonl').read_io(
    input:,
    jsonl_transform: method(:parse_message_from_json)
  ).to_a
  self
end

#save_conversation(filename, messages: @messages) ⇒ OllamaChat::MessageList

The save_conversation method saves the current conversation to a file.

Parameters:

  • filename (String) —

    the path where the conversation will be saved

  • messages (Array<OllamaChat::Message>) (defaults to: @messages) —

    the messages to save. Defaults to all current messages in the list.

Returns:



185
186
187
188
 
# File 'lib/ollama_chat/message_list.rb', line 185

def save_conversation(filename, messages: @messages)
  OllamaChat::Utils::JSONJSONLIO.new(filename).write(collection: messages)
  self
end

#save_conversation_jsonl(filename, messages: @messages) ⇒ OllamaChat::MessageList (private)

Saves the conversation to a JSONL (JSON Lines) file.

Parameters:

  • filename (Pathname) —

    the path to the JSONL file

Returns:



497
498
499
500
501
502
 
# File 'lib/ollama_chat/message_list.rb', line 497

def save_conversation_jsonl(filename, messages: @messages)
  filename.open(?w) do |output|
    write_conversation_jsonl(output, messages:)
  end
  self
end

#set_system_prompt(system_name) ⇒ OllamaChat::MessageList

Note:

This method:

  • Removes all existing system prompts from the message list
  • Adds the new system prompt to the beginning of the message list if provided
  • Handles edge cases such as clearing prompts when system is nil or false

Sets the system prompt for the chat session.

Parameters:

  • system_name (String, nil) —

    The name of the new system prompt. If nil or false, clears the system prompt.

Returns:



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/ollama_chat/message_list.rb', line 341

def set_system_prompt(system_name)
  @system_name = system_name
  if system_name == 'model_default'
    system = @chat.model_default_system_prompt.to_s
  else
    system = @chat.system_prompt(system_name).to_s
  end
  @messages.reject! { |msg| msg.role == 'system' }
  templates_values = {
    persona:      @chat.default_persona_profile,
    runtime_info: @chat.static_runtime_information,
  }
  if new_system_prompt = system.full? { _1.to_s % templates_values }
    @system = new_system_prompt
    @messages.unshift(
      OllamaChat::Message.new(role: 'system', content: self.system)
    )
  else
    @system = nil
  end
  sync
end

#show_last(n = nil, pager: true) ⇒ OllamaChat::MessageList?

Displays the most recent messages that were not authored by the user.

This is particularly useful for quickly reviewing the assistant's last responses without having to scroll through the user's own input. Output is routed through the pager.

Parameters:

  • n (Integer, nil) (defaults to: nil) —

    The number of non-user messages to display. Defaults to 1 if not specified.

Returns:

  • (OllamaChat::MessageList, nil) —

    self if messages were displayed, or nil if no valid messages were found to show.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/ollama_chat/message_list.rb', line 249

def show_last(n = nil, pager: true)
  n ||= 1
  messages = @messages.reject { |message| message.role == 'user' }
  n = n.clamp(0..messages.size)
  n <= 0 and return
  last_message_user_message = (last.content if last&.role == 'user')
  outputter = -> output do
    last_messages = messages[-n..-1].to_a
    last_messages = last_messages.with_infobar(
      output:  STDERR,
      label:   'Message',
      total:   last_messages.size,
      message: @chat.infobar_message,
    )
    last_messages.each do |message|
      output.puts message_text_for(message)
      +infobar
    end
  ensure
    if last_message_user_message
      message_content = Kramdown::ANSI::Width.truncate(
        last_message_user_message.inspect,
        length: Tins::Terminal.columns * 0.9
      )
      msg = <<~EOT

        ⚠️ Last message is actually #{bold{'user message'}}, see:

        #{message_content}

        You might want to drop it.
      EOT
      output.puts msg
    end
  end
  if pager
    use_pager(&outputter)
  else
    outputter.(STDOUT)
  end
  self
end

#show_system_prompt ⇒ self, NilClass

The show_system_prompt method displays the system prompt configured for the chat session.

It retrieves the system prompt from the @system instance variable, parses it using Kramdown::ANSI, and removes any trailing newlines. If the resulting string is empty, the method returns immediately.

Otherwise, it prints a formatted message to the console, including the configured system prompt and its length in characters.

Returns:

  • (self, NilClass) —

    nil if the system prompt is empty, otherwise self.



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/ollama_chat/message_list.rb', line 375

def show_system_prompt
  current_system = system.to_s
  size_bytes     = current_system.size
  size           = format_bytes(size_bytes)
  tokens         = OllamaChat::Utils::TokenEstimator.estimate(size_bytes)
  tokens_size    = format_tokens(tokens)
  system_prompt  = @chat.kramdown_ansi_parse(current_system).
     gsub(/\n+\z/, '').full?
  if system_prompt.blank?
    if current_system.present?
      system_prompt = current_system
    else
      return
    end
  end
  use_pager do |output|
    output.puts <<~EOT
    Configured system prompt is:
    #{system_prompt}

    System prompt name:   #{bold{system_name}}
    System prompt length: 👾#{size} 🧩#{tokens_size}
    EOT
  end
  self
end

#size ⇒ Integer

Returns the number of messages stored in the message list.

Returns:

  • (Integer) —

    The size of the message list.



69
70
71
 
# File 'lib/ollama_chat/message_list.rb', line 69

def size
  @messages.size
end

#sync ⇒ OllOamaChat::MessageList (private)

Synchronizes the message list state with the active chat session.

This method triggers the persistence of the current messages into the database via the associated @chat instance, ensuring that any recent mutations (like adding, clearing, or dropping messages) are immediately captured in the persistent session store.

Returns:

  • (OllOamaChat::MessageList) —

    the current instance to allow for method chaining.



530
531
532
533
 
# File 'lib/ollama_chat/message_list.rb', line 530

def sync
  @chat.store_messages_in_session
  self
end

#to_ary ⇒ Array

The to_ary method converts the message list into an array of OllamaChat::Message objects.

Returns:

  • (Array) —

    An array of OllamaChat::Message objects representing the messages in the list.



407
408
409
 
# File 'lib/ollama_chat/message_list.rb', line 407

def to_ary
  @messages.dup
end

#write_conversation_jsonl(output, messages: @messages) ⇒ OllamaChat::MessageList

Writes each message in the conversation to the output as a JSON line.

Parameters:

  • output (IO) —

    the output stream to write the JSON lines

  • messages (Array<OllamaChat::Message>) (defaults to: @messages) —

    the messages to write. Defaults to all current messages in the list.

Returns:



417
418
419
420
 
# File 'lib/ollama_chat/message_list.rb', line 417

def write_conversation_jsonl(output, messages: @messages)
  OllamaChat::Utils::JSONJSONLIO.new('as.jsonl').write_io(output:, collection: messages)
  self
end