ollama_chat 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c05a3e4579e75ba1c724d7128581de7b96dac914c2bd633368920a207be24b3a
-  data.tar.gz: 6d4cf892e3a3ec3d00dc1b4cf00e686f311240893a5cd2af561afdb7ea6946de
+  metadata.gz: 1cddb901277529210fcc39b4c086217515e98aa75c1569044a47e1cf7149acbe
+  data.tar.gz: f7a40ef2722c750bb71ff2b42d3c2cf0c04816bfd11753e22fa7a09f2d13c9f8
 SHA512:
-  metadata.gz: 9afec82d69645e4b8400b63c8f5bf51bd4b4d0471cb59c419b304e9a532fe874dce33f403625abb4fac4543892ed5c0e40b476a56da7023eda4ea99a15ac6275
-  data.tar.gz: 611da289b8ac3d9bef78d7453418ec9e90123e5f7af36d386b62a7646a578adbe90ebc5396a09248152d117085ee0598a743cf4746e4e1e9a402a6e32475bd02
+  metadata.gz: 7cd5baab3a073464bbf28d3cd9e6ebbcfdcd938c55b1a17ca5d6f2a6b3949d1a2d0a138d9aacf192f6d2f2de1751b8d3e10368c2c15eba5b955ee5454fbd6ff1
+  data.tar.gz: 3ed3442aa4962666de9a56ce5a10e816c9b6f21d85e1281c65962d70c41c60e0c9c8f47fc4e380703799d67e006b2aef36fbe4e2208632e7c3d02c4cc3120c1a

data/CHANGES.md

@@ -1,5 +1,23 @@
 # Changes
 
+## 2025-07-10 v0.0.16
+
+- **New Features**
+  - Added `-f CONFIG` option to `ollama_chat_send` for specifying configuration files.
+  - Introduced `server_socket_runtime_dir` setting in the default config, and
+  make it default to the current directory, allowing for a per directory chat
+  to receive server socket messages.
+
+- **Enhancements**
+  - Improved logging with debug output for received server socket messages.
+  - Refactored server socket handling:
+    - Created `create_socket_server` method for UnixSocks setup with configurable runtime directories.
+    - Updated `send_to_server_socket` and `init_server_socket` methods to use the new helper.
+  - Changed evaluation rate metrics from 'c/s' to 't/s' for better clarity.
+
+- **Documentation**
+  - Added additional documentation for key classes and methods in `FollowChat`.
+
 ## 2025-07-02 v0.0.15
 
 - **Enhanced `ollama_chat_send` and Unix Domain Socket Support:**

data/VERSION

@@ -1 +1 @@
-0.0.15
+0.0.16

data/bin/ollama_chat_send

@@ -5,22 +5,24 @@ require 'tins/go'
 include Tins::GO
 
 
-opts = go 'rth', ARGV
+opts = go 'f:rth', ARGV
 
 def usage(rc = 0)
   puts <<~EOT
     Usage: #{File.basename($0)} [OPTIONS]
 
     Options:
-      -r    Wait for the response from Ollama Chat and output it
-      -t    Send input as terminal input including commands, e. g. /import
-      -h    Show this help message
+      -r         Wait for the response from Ollama Chat and output it
+      -t         Send input as terminal input including commands, e. g. /import
+      -f CONFIG  file to read
+      -h         Show this help message
 
     Send data to a running Ollame Chat client via standard input.
   EOT
   exit rc
 end
 
+config = OllamaChat::OllamaChatConfig.new(opts[?f]).config
 opts[?h] and usage
 begin
   type = if opts[?t]
@@ -28,7 +30,7 @@ begin
          else
            opts[?r] ? :socket_input_with_response : :socket_input
          end
-  response = OllamaChat::ServerSocket.send_to_server_socket(STDIN.read, type:)
+  response = OllamaChat::ServerSocket.send_to_server_socket(STDIN.read, type:, config:)
   type == :socket_input_with_response and puts response.content
 rescue => e
   warn "Caught #{e.class}: #{e}"

data/lib/ollama_chat/chat.rb

@@ -355,6 +355,7 @@ class OllamaChat::Chat
         if message = server_socket_message
           type    = message.type.full?(:to_sym) || :socket_input
           content = message.content
+          STDOUT.puts color(112) { "Received a server socket message. Processing now…" }
         else
           raise
         end

data/lib/ollama_chat/follow_chat.rb

@@ -4,6 +4,15 @@ class OllamaChat::FollowChat
   include Term::ANSIColor
   include OllamaChat::MessageFormat
 
+
+  # Initializes a new instance of OllamaChat::FollowChat.
+  #
+  # @param [OllamaChat::Chat] chat The chat object, which represents the conversation context.
+  # @param [#to_a] messages A collection of message objects, representing the conversation history.
+  # @param [String] voice (optional) to speek with if any.
+  # @param [IO] output (optional) The output stream where terminal output should be printed. Defaults to STDOUT.
+  #
+  # @return [OllamaChat::FollowChat] A new instance of OllamaChat::FollowChat.
   def initialize(chat:, messages:, voice: nil, output: STDOUT)
     super(output:)
     @chat        = chat
@@ -13,8 +22,28 @@ class OllamaChat::FollowChat
     @user        = nil
   end
 
+  # Returns the conversation history (an array of message objects).
+  #
+  # @return [OllamaChat::MessageList<Ollama::Message>] The array of messages in the conversation.
   attr_reader :messages
 
+  # Invokes the chat flow based on the provided Ollama server response.
+  #
+  # The response is expected to be a parsed JSON object containing information
+  # about the user input and the assistant's response.
+  #
+  # If the response indicates an assistant message, this method:
+  #   1. Ensures that an assistant response exists in the message history (if not already present).
+  #   2. Updates the last message with the new content and thinking (if applicable).
+  #   3. Displays the formatted terminal output for the user.
+  #   4. Outputs the voice response (if configured).
+  #
+  # Regardless of whether an assistant message is present, this method also
+  # outputs evaluation statistics (if applicable).
+  #
+  # @param [Ollama::Response] response The parsed JSON response from the Ollama server.
+  #
+  # @return [OllamaChat::FollowChat] The current instance for method chaining.
   def call(response)
     debug_output(response)
 
@@ -73,10 +102,10 @@ class OllamaChat::FollowChat
     stats_text = {
       eval_duration:        Tins::Duration.new(eval_duration),
       eval_count:           response.eval_count.to_i,
-      eval_rate:            bold { "%.2f c/s" % (response.eval_count.to_i / eval_duration) } + color(111),
+      eval_rate:            bold { "%.2f t/s" % (response.eval_count.to_i / eval_duration) } + color(111),
       prompt_eval_duration: Tins::Duration.new(prompt_eval_duration),
       prompt_eval_count:    response.prompt_eval_count.to_i,
-      prompt_eval_rate:     bold { "%.2f c/s" % (response.prompt_eval_count.to_i / prompt_eval_duration) } + color(111),
+      prompt_eval_rate:     bold { "%.2f t/s" % (response.prompt_eval_count.to_i / prompt_eval_duration) } + color(111),
       total_duration:       Tins::Duration.new(response.total_duration / 1e9),
       load_duration:        Tins::Duration.new(response.load_duration / 1e9),
     }.map { _1 * ?= } * ' '

data/lib/ollama_chat/ollama_chat_config/default_config.yml

@@ -61,6 +61,7 @@ redis:
     url: <%= ENV.fetch('REDIS_EXPIRING_URL', 'null') %>
     ex: 86400
 chat_history_filename: <%= ENV.fetch('OLLAMA_CHAT_HISTORY', '~/.ollama_chat_history') %>
+server_socket_runtime_dir: .
 debug: <%= ENV['OLLAMA_CHAT_DEBUG'].to_i == 1 ? true : false %>
 request_headers:
   Accept: 'text/*,application/*,image/*'

data/lib/ollama_chat/server_socket.rb

@@ -8,8 +8,8 @@ module OllamaChat::ServerSocket
     #
     # @return [ String, NilClass ] the response from the server if type is
     #   :socket_input_with_response, otherwise nil.
-    def send_to_server_socket(content, type: :socket_input)
-      server = UnixSocks::Server.new(socket_name: 'ollama_chat.sock')
+    def send_to_server_socket(content, config:, type: :socket_input)
+      server  = create_socket_server(config:)
       message = { content:, type: }
       if type.to_sym == :socket_input_with_response
          return server.transmit_with_response(message)
@@ -18,6 +18,14 @@ module OllamaChat::ServerSocket
          nil
       end
     end
+
+    def create_socket_server(config:)
+      if runtime_dir = config.server_socket_runtime_dir
+        UnixSocks::Server.new(socket_name: 'ollama_chat.sock', runtime_dir:)
+      else
+        UnixSocks::Server.new(socket_name: 'ollama_chat.sock')
+      end
+    end
   end
 
   attr_accessor :server_socket_message
@@ -33,7 +41,7 @@ module OllamaChat::ServerSocket
   # @return [ nil ] This method does not return any value, it only sets up the
   # server socket and kills the process when a message is received.
   def init_server_socket
-    server = UnixSocks::Server.new(socket_name: 'ollama_chat.sock')
+    server = OllamaChat::ServerSocket.create_socket_server(config:)
     server.receive_in_background do |message|
       self.server_socket_message = message
       Process.kill :INT, $$

data/lib/ollama_chat/version.rb

@@ -1,6 +1,6 @@
 module OllamaChat
   # OllamaChat version
-  VERSION         = '0.0.15'
+  VERSION         = '0.0.16'
   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.15 ruby lib
+# stub: ollama_chat 0.0.16 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama_chat".freeze
-  s.version = "0.0.15".freeze
+  s.version = "0.0.16".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

metadata

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