ollama_chat 0.0.12 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c11573f3fe926d4b3a52336ae1fbae81587365725b1fe3724406b0d0d6fd2bf1
-  data.tar.gz: 756a07f1f4eb9056b5b2ff8441a034022d31df4c5b6c199c409c34438dad9aa7
+  metadata.gz: 9c7760df8454e8d8b522c8d37448ca4b872f27b44ef484e842f8c35a96fec50b
+  data.tar.gz: abbc3fe1a7d53ded7ed878dfbbd6a584a99e8b687e16f1386e6e4e058cda1f46
 SHA512:
-  metadata.gz: a58029a24c550ee8b1b934ea0c995fe95ce6015fd23af0a503b939dfa8fb681e451293b5b4437bd04fb036b7d6643b4c30468c1c129a5bb0a546247e3b51a0cf
-  data.tar.gz: 0bf0ea4532ea5dea7977cb5ef97505c336082c60f67f0be03ee1ffda815de76fd8fa23625b1e88b2595434476f6258a59e251150f1aa7705de8881a70f2a12f9
+  metadata.gz: 28056039df80caf298aafb8445c0d3b6662e9fee8d28b6756fb13b844c006092754e68e33fc8947f8326ee11e4248206558c522b170463e4f58da88792cadfde
+  data.tar.gz: 795e2bf8fefb75b53c1108637affadb796c24b86c1cec853b16f62053d80c0319a239a8053676434a6c22197411557d91ad995b025e00bb735b83dccbb0d6ef2

data/CHANGES.md

@@ -1,5 +1,28 @@
 # Changes
 
+## 2025-06-07 v0.0.14
+
+* **Message List Improvements**:
+  * Added thinking status to messages when chat is in think mode
+  * Improved system prompt handling with new method documentation
+* **Improved /system command handling for OllamaChat chat system**:
+  * Added support for '/system [show]' command to show or change system prompt.
+* Add conversation length to chat information display
+* **Improvements to OllamaChat::SourceFetching**:
+  * Fixed bug where document type concatenation could cause errors when `full?`
+    returns `nil`, ensuring proper string formatting and avoiding potential
+    crashes.
+
+## 2025-06-05 v0.0.13
+
+* **Improved chat command handling**
+  - Added support for '/clear tags' to clear all tags.
+  - Updated cases for 'history', 'all' and added case for 'tags'.
+  - Added commands to clear documents collection and print a message in `information.rb`.
+  - `OllamaChat::Chat#clean` now accepts 'tags' as an option.
+* Apply read and write timeouts from configuration (300 seconds) for ollama server.
+* Added method comments
+
 ## 2025-06-01 v0.0.12
 
 * **API Compatibility**: Enforces Ollama API version `0.9.0` or higher to

data/README.md

@@ -123,11 +123,11 @@ The following commands can be given inside the chat, if prefixed by a `/`:
 /location                       toggle location submission
 /voice [change]                 toggle voice output or change the voice
 /list [n]                       list the last n / all conversation exchanges
-/clear [messages|links|history] clear the all messages, links, or the chat history (defaults to messages)
+/clear [what]                   clear what=messages|links|history|tags|all
 /clobber                        clear the conversation, links, and collection
 /drop [n]                       drop the last n exchanges, defaults to 1
 /model                          change the model
-/system                         change system prompt (clears conversation)
+/system [show]                  change/show system prompt
 /regenerate                     the last answer message
 /collection [clear|change]      change (default) collection or clear
 /info                           show information for current session

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.0.14

data/lib/ollama_chat/chat.rb

@@ -41,8 +41,11 @@ class OllamaChat::Chat
     setup_switches(config)
     base_url         = @opts[?u] || config.url
     @ollama          = Ollama::Client.new(
-      base_url:   base_url,
-      debug:      config.debug,
+      connect_timeout: config.timeouts.connect_timeout?,
+      read_timeout:    config.timeouts.read_timeout?,
+      write_timeout:   config.timeouts.write_timeout?,
+      base_url:        base_url,
+      debug:           config.debug,
       user_agent:
     )
     if server_version.version < '0.9.0'.version
@@ -136,7 +139,7 @@ class OllamaChat::Chat
       last = 2 * $1.to_i if $1
       messages.list_conversation(last)
       :next
-    when %r(^/clear(?:\s+(messages|links|history|all))?$)
+    when %r(^/clear(?:\s+(messages|links|history|tags|all))?$)
       clean($1)
       :next
     when %r(^/clobber$)
@@ -149,9 +152,11 @@ class OllamaChat::Chat
     when %r(^/model$)
       @model = choose_model('', @model)
       :next
-    when %r(^/system$)
-      change_system_prompt(@system)
-      info
+    when %r(^/system(?:\s+(show))?$)
+      if $1 != 'show'
+        change_system_prompt(@system)
+      end
+      @messages.show_system_prompt
       :next
     when %r(^/regenerate$)
       if content = messages.second_last&.content
@@ -306,6 +311,9 @@ class OllamaChat::Chat
     when 'history'
       clear_history
       STDOUT.puts "Cleared history."
+    when 'tags'
+      @documents.clear
+      STDOUT.puts "Cleared all tags."
     when 'all'
       if ask?(prompt: 'Are you sure to clear messages and collection? (y/n) ') =~ /\Ay/i
         messages.clear
@@ -365,6 +373,8 @@ class OllamaChat::Chat
         end
       end
 
+      content = content.encode(invalid: :replace)
+
       content, tags = if @parse_content
                         parse_content(content, @images)
                       else

data/lib/ollama_chat/clipboard.rb

@@ -1,4 +1,13 @@
 module OllamaChat::Clipboard
+
+  # Copy the last assistant's message to the system clipboard.
+  #
+  # This method checks if there is a last message from an assistant in the `@messages`
+  # array and copies its content to the clipboard using the specified command from `config.copy`.
+  # If no assistant response is available or the clipboard command is not found, appropriate
+  # error messages are displayed.
+  #
+  # @return [NilClass] Always returns nil.
   def copy_to_clipboard
     if message = @messages.last and message.role == 'assistant'
       copy = `which #{config.copy}`.chomp
@@ -16,6 +25,13 @@ module OllamaChat::Clipboard
     nil
   end
 
+  # Paste content from the input.
+  #
+  # Prompts the user to paste their content and then press C-d (Ctrl+D) to terminate
+  # input. Reads all lines from standard input until Ctrl+D is pressed and returns
+  # the pasted content as a string.
+  #
+  # @return [String] The pasted content entered by the user.
   def paste_from_input
     STDOUT.puts bold { "Paste your content and then press C-d!" }
     STDIN.read

data/lib/ollama_chat/history.rb

@@ -1,8 +1,12 @@
 module OllamaChat::History
+  # Returns the full path of the chat history filename based on the
+  # configuration.
   def chat_history_filename
     File.expand_path(config.chat_history_filename)
   end
 
+  # Initializes the chat history by loading it from a file if it exists, and
+  # then loads the history into Readline::HISTORY.
   def init_chat_history
     if File.exist?(chat_history_filename)
       File.open(chat_history_filename, ?r) do |history|
@@ -13,10 +17,12 @@ module OllamaChat::History
     end
   end
 
+  # Saves the current chat history to a file in JSON format.
   def save_history
     File.secure_write(chat_history_filename, JSON.dump(Readline::HISTORY))
   end
 
+  # Clears all entries from Readline::HISTORY.
   def clear_history
     Readline::HISTORY.clear
   end

data/lib/ollama_chat/information.rb

@@ -30,30 +30,31 @@ module OllamaChat::Information
   def info
     STDOUT.puts "Running ollama_chat version: #{bold(OllamaChat::VERSION)}"
     STDOUT.puts "Connected to ollama server version: #{bold(server_version)}"
-    STDOUT.puts "Current model is #{bold{@model}}."
+    STDOUT.puts "Current conversation model is #{bold{@model}}."
     if @model_options.present?
       STDOUT.puts "  Options: #{JSON.pretty_generate(@model_options).gsub(/(?<!\A)^/, '  ')}"
     end
     @embedding.show
     if @embedding.on?
-      STDOUT.puts "Embedding model is #{bold{@embedding_model}}"
+      STDOUT.puts "Current embedding model is #{bold{@embedding_model}}"
       if @embedding_model_options.present?
         STDOUT.puts "  Options: #{JSON.pretty_generate(@embedding_model_options).gsub(/(?<!\A)^/, '  ')}"
       end
       STDOUT.puts "Text splitter is #{bold{config.embedding.splitter.name}}."
       collection_stats
     end
-    STDOUT.puts "Documents database cache is #{@documents.nil? ? 'n/a' : bold{@documents.cache.class}}"
     markdown.show
     stream.show
+    think.show
     location.show
-    STDOUT.puts "Document policy for references in user text: #{bold{@document_policy}}"
-    STDOUT.puts "Thinking is #{bold(think.on? ? 'enabled' : 'disabled')}."
-    STDOUT.puts "Currently selected search engine is #{bold(search_engine)}."
+    voice.show
     if @voice.on?
-      STDOUT.puts "Using voice #{bold{@current_voice}} to speak."
+      STDOUT.puts "  Using voice #{bold{@current_voice}} to speak."
     end
-    @messages.show_system_prompt
+    STDOUT.puts "Documents database cache is #{@documents.nil? ? 'n/a' : bold{@documents.cache.class}}"
+    STDOUT.puts "Document policy for references in user text: #{bold{@document_policy}}"
+    STDOUT.puts "Currently selected search engine is #{bold(search_engine)}."
+    STDOUT.puts "Conversation length: #{bold(@messages.size.to_s)} message(s)."
     nil
   end
 
@@ -66,11 +67,11 @@ module OllamaChat::Information
       /location                       toggle location submission
       /voice [change]                 toggle voice output or change the voice
       /list [n]                       list the last n / all conversation exchanges
-      /clear [messages|links|history] clear the all messages, links, or the chat history (defaults to messages)
+      /clear [what]                   clear what=messages|links|history|tags|all
       /clobber                        clear the conversation, links, and collection
       /drop [n]                       drop the last n exchanges, defaults to 1
       /model                          change the model
-      /system                         change system prompt (clears conversation)
+      /system [show]                  change/show system prompt
       /regenerate                     the last answer message
       /collection [clear|change]      change (default) collection or clear
       /info                           show information for current session

data/lib/ollama_chat/message_list.rb

@@ -106,10 +106,20 @@ class OllamaChat::MessageList
                    when 'system' then 213
                    else 210
                    end
+      thinking = if @chat.think.on?
+                   think_annotate do
+                     m.thinking.full? { @chat.markdown.on? ? Kramdown::ANSI.parse(_1) : _1 }
+                   end
+                 end
       content = m.content.full? { @chat.markdown.on? ? Kramdown::ANSI.parse(_1) : _1 }
       message_text = message_type(m.images) + " "
       message_text += bold { color(role_color) { m.role } }
-      message_text += ":\n#{content}"
+      if thinking
+        message_text += [ ?:, thinking, talk_annotate { content } ].compact.
+          map { _1.chomp } * ?\n
+      else
+        message_text += ":\n#{content}"
+      end
       m.images.full? { |images|
         message_text += "\nImages: " + italic { images.map(&:path) * ', ' }
       }
@@ -136,17 +146,26 @@ class OllamaChat::MessageList
     end
   end
 
-  # The set_system_prompt method sets the system prompt for the chat session.
-  # This implies deleting all of the messages in the message list, so it only
-  # contains the system prompt at the end.
+  # Sets the system prompt for the chat session.
   #
-  # @param system [ String ] the new system prompt
+  # @param system [String, nil] The new system prompt. If `nil` or `false`, clears the system prompt.
   #
-  # @return [ OllamaChat::MessageList ] the message list instance itself, allowing for chaining.
+  # @return [OllamaChat::MessageList] Returns `self` to allow chaining of method calls.
+  #
+  # @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`
   def set_system_prompt(system)
-    @system = system.to_s
-    @messages.clear
-    @messages << Ollama::Message.new(role: 'system', content: self.system)
+    @messages.reject! { |msg| msg.role == 'system' }
+    if new_system_prompt = system.full?(:to_s)
+      @system = new_system_prompt
+      @messages.unshift(
+        Ollama::Message.new(role: 'system', content: self.system)
+      )
+    else
+      @system = nil
+    end
     self
   end
 

data/lib/ollama_chat/ollama_chat_config/default_config.yml

@@ -5,6 +5,10 @@ model:
   name: <%= ENV.fetch('OLLAMA_CHAT_MODEL', 'llama3.1') %>
   options:
     num_ctx: 8192
+timeouts:
+  connect_timeout: null
+  read_timeout: 300
+  write_timeout: 300
 location:
   enabled: false
   name: Berlin

data/lib/ollama_chat/server_socket.rb

@@ -1,13 +1,23 @@
 module OllamaChat::ServerSocket
   class << self
+    # Returns the path to the XDG runtime directory, or a default path if not set.
+    # @return [String] the expanded path to the XDG runtime directory
     def runtime_dir
       File.expand_path(ENV.fetch('XDG_RUNTIME_DIR',  '~/.local/run'))
     end
 
+    # Constructs the full path to the server socket file.
+    # @return [String] the full path to the Unix socket
     def server_socket_path
       File.join(runtime_dir, 'ollama_chat.sock')
     end
 
+    # Sends a message to the server socket.
+    #
+    # @param content [String] the content to send
+    # @param type [Symbol] the type of message (default: :socket_input)
+    # @raise [Errno::ENOENT] if the socket file does not exist
+    # @raise [Errno::ECONNREFUSED] if the socket is not listening (server no running)
     def send_to_server_socket(content, type: :socket_input)
       FileUtils.mkdir_p runtime_dir
       message = { content:, type: }
@@ -17,8 +27,20 @@ module OllamaChat::ServerSocket
     end
   end
 
+  # Accessor for the server socket message.
+  # Holds the last message received from the Unix socket.
+  # @return [String, nil] the message content, or nil if not set
+  # @see OllamaChat::ServerSocket#init_server_socket
+  # @see OllamaChat::ServerSocket#send_to_server_socket
   attr_accessor :server_socket_message
 
+  # Initializes a Unix domain socket server for OllamaChat.
+  #
+  # Creates the necessary runtime directory, checks for existing socket file,
+  # and starts a server loop in a new thread. Listens for incoming connections,
+  # reads JSON data, and terminates the server upon receiving a message.
+  #
+  # Raises Errno::EEXIST if the socket path already exists.
   def init_server_socket
     FileUtils.mkdir_p OllamaChat::ServerSocket.runtime_dir
     if File.exist?(OllamaChat::ServerSocket.server_socket_path)

data/lib/ollama_chat/source_fetching.rb

@@ -50,7 +50,7 @@ module OllamaChat::SourceFetching
 
   def import_source(source_io, source)
     source        = source.to_s
-    document_type = source_io&.content_type.full? { |ct| italic { ct } } + ' '
+    document_type = source_io&.content_type.full? { |ct| italic { ct } + ' ' }
     STDOUT.puts "Importing #{document_type}document #{source.to_s.inspect} now."
     source_content = parse_source(source_io)
     "Imported #{source.inspect}:\n\n#{source_content}\n\n"

data/lib/ollama_chat/version.rb

@@ -1,6 +1,6 @@
 module OllamaChat
   # OllamaChat version
-  VERSION         = '0.0.12'
+  VERSION         = '0.0.14'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/ollama_chat.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama_chat 0.0.12 ruby lib
+# stub: ollama_chat 0.0.14 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama_chat".freeze
-  s.version = "0.0.12".freeze
+  s.version = "0.0.14".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

data/spec/ollama_chat/chat_spec.rb

@@ -86,7 +86,7 @@ RSpec.describe OllamaChat::Chat do
 
     it 'returns :next when input is "/system"' do
       expect(chat).to receive(:change_system_prompt).with(nil)
-      expect(chat).to receive(:info)
+      expect(chat.messages).to receive(:show_system_prompt)
       expect(chat.handle_input("/system")).to eq :next
     end
 
@@ -288,7 +288,8 @@ RSpec.describe OllamaChat::Chat do
           /
             Running\ ollama_chat\ version|
             Connected\ to\ ollama\ server|
-            Current\ model|
+            Current\ conversation\ model|
+            Current\ embedding\ model|
             Options|
             Embedding|
             Text\ splitter|
@@ -297,8 +298,10 @@ RSpec.describe OllamaChat::Chat do
             Streaming|
             Location|
             Document\ policy|
-            Thinking\ is|
-            Currently\ selected\ search\ engine
+            Thinking|
+            Voice\ output|
+            Currently\ selected\ search\ engine|
+            Conversation\ length
           /x
         ).at_least(1)
       expect(chat.info).to be_nil

data/spec/ollama_chat/information_spec.rb

@@ -24,7 +24,7 @@ RSpec.describe OllamaChat::Information do
 
   it 'can show info' do
     expect(STDOUT).to receive(:puts).with(/Connected to ollama server version/)
-    expect(STDOUT).to receive(:puts).with(/Current model is/)
+    expect(STDOUT).to receive(:puts).with(/Current conversation model is/)
     expect(STDOUT).to receive(:puts).at_least(1)
     expect(chat.info).to be_nil
   end

data/spec/ollama_chat/message_list_spec.rb

@@ -64,9 +64,11 @@ RSpec.describe OllamaChat::MessageList do
     FileUtils.rm_f 'tmp/test-conversation.json'
   end
 
-  it 'can list conversations' do
+  it 'can list conversations without thinking' do
     expect(chat).to receive(:markdown).
       and_return(double(on?: true)).at_least(:once)
+    expect(chat).to receive(:think).
+      and_return(double(on?: false)).at_least(:once)
     list <<  Ollama::Message.new(role: 'user', content: 'world')
     expect(STDOUT).to receive(:puts).
       with("📨 \e[1m\e[38;5;213msystem\e[0m\e[0m:\nhello\n")
@@ -75,6 +77,21 @@ RSpec.describe OllamaChat::MessageList do
     list.list_conversation
   end
 
+  it 'can list conversations with thinking' do
+    expect(chat).to receive(:markdown).
+      and_return(double(on?: true)).at_least(:once)
+    expect(chat).to receive(:think).
+      and_return(double(on?: true)).at_least(:once)
+    expect(STDOUT).to receive(:puts).
+      with("📨 \e[1m\e[38;5;213msystem\e[0m\e[0m:\n💭\nI need to say something nice…\n\n💬\nhello\n")
+    expect(STDOUT).to receive(:puts).
+      with("📨 \e[1m\e[38;5;172muser\e[0m\e[0m:\nworld\n")
+    list.set_system_prompt nil
+    list << Ollama::Message.new(role: 'system', content: 'hello', thinking: 'I need to say something nice…')
+    list << Ollama::Message.new(role: 'user', content: 'world')
+    list.list_conversation
+  end
+
   it 'can show_system_prompt' do
     expect(list).to receive(:system).and_return 'test **prompt**'
     expect(Kramdown::ANSI).to receive(:parse).with('test **prompt**').
@@ -82,10 +99,27 @@ RSpec.describe OllamaChat::MessageList do
     expect(list.show_system_prompt).to eq list
   end
 
-  it 'can set_system_prompt' do
+  it 'can set_system_prompt if unset' do
+    list.messages.clear
+    expect(list.messages.count { _1.role == 'system' }).to eq 0
     expect {
       expect(list.set_system_prompt('test prompt')).to eq list
     }.to change { list.system }.from(nil).to('test prompt')
+    expect(list.messages.count { _1.role == 'system' }).to eq 1
+  end
+
+  it 'can set_system_prompt if already set' do
+    list.messages.clear
+    expect(list.messages.count { _1.role == 'system' }).to eq 0
+    list.set_system_prompt('first prompt')
+    expect(list.system).to eq('first prompt')
+    expect(list.messages.count { _1.role == 'system' }).to eq 1
+    #
+    list.set_system_prompt('new prompt')
+    expect(list.system).to eq('new prompt')
+    expect(list.messages.count { _1.role == 'system' }).to eq 1
+    expect(list.messages.first.role).to eq('system')
+    expect(list.messages.first.content).to eq('new prompt')
   end
 
   it 'can drop n conversations exhanges' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama_chat
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.14
 platform: ruby
 authors:
 - Florian Frank