ollama_chat 0.0.15 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c05a3e4579e75ba1c724d7128581de7b96dac914c2bd633368920a207be24b3a
-  data.tar.gz: 6d4cf892e3a3ec3d00dc1b4cf00e686f311240893a5cd2af561afdb7ea6946de
+  metadata.gz: 1ca8b4d15da972d1600ccab9349f1852ccb75f2733cd9a85ccfb57f2890cb786
+  data.tar.gz: 3ec2450f156b98ac722b58358de3190e58d30ebf6f8e09dd435804b409c1e1e0
 SHA512:
-  metadata.gz: 9afec82d69645e4b8400b63c8f5bf51bd4b4d0471cb59c419b304e9a532fe874dce33f403625abb4fac4543892ed5c0e40b476a56da7023eda4ea99a15ac6275
-  data.tar.gz: 611da289b8ac3d9bef78d7453418ec9e90123e5f7af36d386b62a7646a578adbe90ebc5396a09248152d117085ee0598a743cf4746e4e1e9a402a6e32475bd02
+  metadata.gz: 98a1335f95549196c6a6a486465c3dad12694b8006c18a7ff2619be8a866b826869ed35dde99d810fea330101e67361142000ac705e5784450bc9ae11952f8d7
+  data.tar.gz: dce73464d416d095eee8d86723ca241cc7affdbc87b4472bf4e0cf0caf084f52d2c47810fd3fe8ec67cb883df85e58098caae1ad45c4088850d98cc37705c2b0

data/CHANGES.md

@@ -1,5 +1,30 @@
 # Changes
 
+## 2025-07-14 v0.0.17
+
+* Implement Pager Support for List Command
+* Add simple command completion to chat
+* Improved chat link generation
+  + Changed `record.tags.first` to have prefix `?#` before the tag
+
+## 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/Rakefile

@@ -32,13 +32,13 @@ GemHadar do
   dependency             'excon',                 '~> 1.0'
   dependency             'ollama-ruby',           '~> 1.2'
   dependency             'documentrix',           '~> 0.0', '>= 0.0.2'
-  dependency             'unix_socks'
+  dependency             'unix_socks',            '>= 0.0.1'
   dependency             'rss',                   '~> 0.3'
   dependency             'term-ansicolor',        '~> 1.11'
   dependency             'redis',                 '~> 5.0'
   dependency             'mime-types',            '~> 3.0'
   dependency             'reverse_markdown',      '~> 3.0'
-  dependency             'xdg',                   '~> 7.0'
+  dependency             'xdg'
   dependency             'kramdown-ansi',         '~> 0.0', '>= 0.0.1'
   dependency             'complex_config',        '~> 0.22', '>= 0.22.2'
   dependency             'tins',                  '~> 1.34'

data/VERSION

@@ -1 +1 @@
-0.0.15
+0.0.17

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

@@ -348,13 +348,15 @@ class OllamaChat::Chat
       @parse_content = true
       type           = :terminal_input
       input_prompt   = bold { color(172) { message_type(@images) + " user" } } + bold { "> " }
-
       begin
-        content = Reline.readline(input_prompt, true)&.chomp
+        content = enable_command_completion do
+          Reline.readline(input_prompt, true)&.chomp
+        end
       rescue Interrupt
         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
@@ -417,7 +419,7 @@ class OllamaChat::Chat
                  else
                    'file://%s' % File.expand_path(record.source)
                  end
-          [ link, record.tags.first ]
+          [ link, ?# + record.tags.first ]
         }.uniq.map { |l, t| hyperlink(l, t) }.join(' ')
         config.debug and jj messages.to_ary
       end
@@ -525,4 +527,15 @@ class OllamaChat::Chat
       exit 1
     end
   end
+
+  def enable_command_completion(&block)
+    old = Reline.completion_proc
+    commands = display_chat_help_message.scan(/^\s*(\S+)/).inject(&:concat)
+    Reline.completion_proc = -> input {
+      commands.grep Regexp.new('\A' + Regexp.quote(input))
+    }
+    block.()
+  ensure
+    Reline.completion_proc = old
+  end
 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/information.rb

@@ -58,8 +58,8 @@ module OllamaChat::Information
     nil
   end
 
-  def display_chat_help
-    STDOUT.puts <<~EOT
+  private def display_chat_help_message
+    <<~EOT
       /copy                           to copy last response to clipboard
       /paste                          to paste content
       /markdown                       toggle markdown output
@@ -89,6 +89,10 @@ module OllamaChat::Information
       /quit                           to quit
       /help                           to view this help
     EOT
+  end
+
+  def display_chat_help
+    STDOUT.puts display_chat_help_message
     nil
   end
 

data/lib/ollama_chat/message_list.rb

@@ -99,31 +99,33 @@ class OllamaChat::MessageList
   # @return [ OllamaChat::MessageList ]
   def list_conversation(last = nil)
     last = (last || @messages.size).clamp(0, @messages.size)
-    @messages[-last..-1].to_a.each do |m|
-      role_color = case m.role
-                   when 'user' then 172
-                   when 'assistant' then 111
-                   when 'system' then 213
-                   else 210
+    use_pager do |output|
+      @messages[-last..-1].to_a.each do |m|
+        role_color = case m.role
+                     when 'user' then 172
+                     when 'assistant' then 111
+                     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
-      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 } }
-      if thinking
-        message_text += [ ?:, thinking, talk_annotate { content } ].compact.
-          map { _1.chomp } * ?\n
-      else
-        message_text += ":\n#{content}"
+        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 } }
+        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) * ', ' }
+        }
+        output.puts message_text
       end
-      m.images.full? { |images|
-        message_text += "\nImages: " + italic { images.map(&:path) * ', ' }
-      }
-      STDOUT.puts message_text
     end
     self
   end
@@ -261,4 +263,22 @@ class OllamaChat::MessageList
   def config
     @chat.config
   end
+
+  def determine_pager_command
+    default_pager = ENV['PAGER'].full?
+    if fallback_pager = `which less`.chomp.full? || `which more`.chomp.full?
+      fallback_pager << ' -r'
+    end
+    default_pager || fallback_pager
+  end
+
+  def use_pager
+    command       = determine_pager_command
+    output_buffer = StringIO.new
+    yield output_buffer
+    messages = output_buffer.string
+    Kramdown::ANSI::Pager.pager(command:, lines: messages.count(?\n)) do |output|
+      output.puts messages
+    end
+  end
 end

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.17'
   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.17 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama_chat".freeze
-  s.version = "0.0.15".freeze
+  s.version = "0.0.17".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -34,13 +34,13 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency(%q<excon>.freeze, ["~> 1.0".freeze])
   s.add_runtime_dependency(%q<ollama-ruby>.freeze, ["~> 1.2".freeze])
   s.add_runtime_dependency(%q<documentrix>.freeze, ["~> 0.0".freeze, ">= 0.0.2".freeze])
-  s.add_runtime_dependency(%q<unix_socks>.freeze, [">= 0".freeze])
+  s.add_runtime_dependency(%q<unix_socks>.freeze, [">= 0.0.1".freeze])
   s.add_runtime_dependency(%q<rss>.freeze, ["~> 0.3".freeze])
   s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.11".freeze])
   s.add_runtime_dependency(%q<redis>.freeze, ["~> 5.0".freeze])
   s.add_runtime_dependency(%q<mime-types>.freeze, ["~> 3.0".freeze])
   s.add_runtime_dependency(%q<reverse_markdown>.freeze, ["~> 3.0".freeze])
-  s.add_runtime_dependency(%q<xdg>.freeze, ["~> 7.0".freeze])
+  s.add_runtime_dependency(%q<xdg>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<kramdown-ansi>.freeze, ["~> 0.0".freeze, ">= 0.0.1".freeze])
   s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.22".freeze, ">= 0.22.2".freeze])
   s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.34".freeze])

data/spec/ollama_chat/message_list_spec.rb

@@ -10,7 +10,8 @@ RSpec.describe OllamaChat::MessageList do
         units: 'SI (International System of Units)'
       ),
       prompts: double(
-        location: 'You are at %{location_name} (%{location_decimal_degrees}), on %{localtime}, preferring %{units}'
+        location: 'You are at %{location_name} (%{location_decimal_degrees}),' \
+        ' on %{localtime}, preferring %{units}'
       ),
       system_prompts: double(
         assistant?: 'You are a helpful assistant.'
@@ -64,32 +65,60 @@ RSpec.describe OllamaChat::MessageList do
     FileUtils.rm_f 'tmp/test-conversation.json'
   end
 
-  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")
-    expect(STDOUT).to receive(:puts).
-      with("📨 \e[1m\e[38;5;172muser\e[0m\e[0m:\nworld\n")
-    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
+  context 'without pager' do
+    before do
+      expect(list).to receive(:determine_pager_command).and_return nil
+    end
+
+    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" \
+          "📨 \e[1m\e[38;5;172muser\e[0m\e[0m:\nworld\n"
+        )
+      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" \
+          "📨 \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
+  end
+
+  context 'with pager' do
+    before do
+      expect(list).to receive(:determine_pager_command).and_return 'true'
+      expect(Tins::Terminal).to receive(:lines).and_return 1
+    end
+
+    it 'can list conversations' 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')
+      list.list_conversation
+    end
   end
 
   it 'can show_system_prompt' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama_chat
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.17
 platform: ruby
 authors:
 - Florian Frank
@@ -161,14 +161,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: rss
   requirement: !ruby/object:Gem::Requirement
@@ -243,16 +243,16 @@ dependencies:
   name: xdg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: kramdown-ansi
   requirement: !ruby/object:Gem::Requirement