ollama_chat 0.0.123 → 0.0.125

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2d0c5676e03433f245a21795872a9d7bd64357306ec691de3012195b5403bef
-  data.tar.gz: 933dca2b53647c523b9849d958cc1625106c97500caf2814bc731458a0e683f4
+  metadata.gz: 3de94c682281a4667e89feee589883bd33acf082165f37ce443072117a773167
+  data.tar.gz: 94cccbb92af48198a70879cf1028a0aebfe0cda49e25ccd82352cb35d9054bf7
 SHA512:
-  metadata.gz: 4589b5f1cf689bb35bdf26c288e59f40b87ef926eaf7f91e187c3fa729958c9d042f784eb3bf9a4b6e64966c201312713c2e20607291c6aabc10d306cf4cf272
-  data.tar.gz: 19102c3d01a2ebb4bb14b8ea617b09a7e168d0175225024a490dc85e23b41ce3c7eba249d82cc671f5530da0090e945f8f6358d17ca7f6b7587a413002e27dc2
+  metadata.gz: d3bad30e34ad309fe6c2f2263802af2778eded9459affc6c6713c6383f58706fe54411e7a4b6f087c487718d0a6ea8e07e90dfed22ca1a64b563d207ce61287e
+  data.tar.gz: 8f9befaa4a6a519b8f7b4424f0d16380663b863e039f08142fc667b01ecb83aa989b9e635ea5373b22191c7ba8f568e97dd210d732d1d6d5099dd3e5cffb74ee

data/CHANGES.md

@@ -1,5 +1,160 @@
 # Changes
 
+## 2026-10-03 v0.0.125
+
+### Added
+
+* Session-scoped trigger injection mechanism:
+  * New migration `011_add_trigger_to_sessions` adding a `:text` JSON column to
+    `sessions`.
+  * `Session#trigger` attribute with `plugin :serialization, :json` and `nil`
+    default.
+  * `CollectionSearch#trigger_inject` dispatch logic including embedding
+    guards, collection switching, document finding, and reranking.
+  * New `/session trigger edit` command registered in `commands.rb`.
+  * `edit_session_trigger` method in `session_management.rb` supporting dual
+    chooser and prefill.
+  * Trigger configuration display (⚡ block) added to `info_rag` in
+    `information.rb`.
+  * `runtime_information_inject` extracted from `chat.rb` into
+    `information.rb`.
+  * New prompt contexts: `prompts.rerank` (`default`, `memory_rerank`,
+    `lorebook_rerank`), `prompts.prompt.snippets_retrieval`, and
+    `prompts.prompt.snippets_trigger`.
+  * `persona_name` line added to `prompts.system.persona`.
+  * `TagResult` changed from `Data.define` to `Struct.new` to allow mutable
+    fields.
+  * `∅` fallback for empty patterns in `collection_stats`.
+  * Info-level logging for embedding requests/responses and rerank survivors in
+    `collection_search.rb`.
+  * New spec file `collection_search_spec.rb` with 7 examples for
+    `#trigger_inject`.
+
+### Changed
+
+* `SessionLocking#lock?` now accepts a required `chat:` keyword argument to
+  decouple feedback delegation from the host object.
+* `search_knowledge.rb` updated to use `snippets_retrieval` DB prompt,
+  `collection` block, and `database_collection?` guard.
+* `@embedding` instance variable swept to `embedding` accessor in
+  `information.rb`, `source_fetching.rb`, and `web_searching.rb`.
+* `Tins::Duration#format` used for compaction voice timing in
+  `report_compaction`, replacing `%.1f seconds`.
+* `tins` dependency bumped from `~> **1.58**` to `~> **1.60**` to support
+  unpadded `%H`, `%M`, and `%u` directives.
+* `resolve_tag_spec.rb` updated to replace an unreachable rescue-path test with
+  a "tagged file does not exist" test.
+* `search_knowledge_spec.rb` updated for new prompt names, `collection` block,
+  and `tags_set` doubles.
+* `compaction_spec.rb` regex updated to match the new duration format.
+* `Tins::GO.go` flag string reordered in `bin/ollama_chat_log`.
+
+### Fixed
+
+* Spec expectations in `session_management_spec.rb`, `parsing_spec.rb`, and
+  `source_fetching_spec.rb` updated to use Ruby 3.1+ hash shorthand `chat:`.
+
+### Tests
+
+* Added specs for `CommandConcern` class methods:
+  * `help_message` via `OllamaChat::Commands`: table structure, category
+    headers, pattern filtering, subcommand expansion, and optional/mandatory
+    asterisks.
+  * `command_completions`: array shape, bare names, subcommand variants, and
+    sort order.
+  * `Command` class: `execute_if_match?` (match, captures, nil-regexp path,
+    no-context error), `completions` (product, optional bare, strict),
+    `command_names`, and `optional?`.
+  * Duplicate registration guard against the real `:copy` entry in
+    `OllamaChat::Commands`.
+* Added specs for remaining command dispatch gaps:
+  * `/paste -i` stdin path via `paste_from_stdin`.
+  * `/last -v` voice output via `speak_last`.
+  * `/regenerate` success path (drop + return content).
+  * `/prompt delete` routes to `choose_and_delete_prompt`.
+  * `/web` without explicit count passes `nil`.
+  * `/character` JSON success paths: `info` (pager), `load` (raw content),
+    `import` (delegation).
+  * `/character` PNG `load` with `PNGMetadataExtractor`.
+* Added specs for `SessionManagement#edit_session_trigger`:
+  * Setting trigger from `nil` to a configured hash with `enabled`,
+    `prompt_name`, and `text_count`.
+  * Updating config for an already-configured collection.
+  * Switching the trigger to a different collection name.
+* Added specs for session model options and trigger edit:
+  * `/session model options` delegates to `edit_session_model_options` and
+    returns `:next`.
+  * `/session trigger edit` delegates to `edit_session_trigger` and returns
+    `:next`.
+
+## 2026-10-02 v0.0.124
+
+### Added
+
+*   `OllamaChat::Feedback` module to replace raw `STDOUT.puts` and
+    `STDERR.puts` calls with typed, testable system notifications.
+    *   Supports types: `:success`, `:cancel`, `:denied`, `:warn`, `:info`,
+        `:alarm`.
+    *   Integrates with `use_pager` and handles newline formatting via
+        `output.print`.
+*   `memorize` tool to embed timestamped entries into per-persona
+    `memory-<persona_name>` Documentrix collections.
+*   `forget` tool to clear a single memory record by its ISO-8601 timestamp
+    tag.
+*   `/collection query` subcommand to debug collections, supporting optional
+    `-e` (edit) and `-r` (rerank) flags.
+*   `/config env` subcommand to display the Ollama Chat environment variable
+    tree using `OC.view`.
+*   `/last -v` flag to voice previous assistant messages via
+    `MessageList#speak_last`.
+*   `OllamaChat::CollectionSearch` module extracted from `SearchKnowledge`
+    tool, providing `find_document_records` and `rerank_records` methods mixed
+    into `Chat`.
+*   `refresh_system_prompt` method in `SystemPromptManagement` to
+    re-interpolate the active system prompt with fresh `persona` and
+    `runtime_info` values after collection mutations.
+*   Voice announcement in the compaction report, including
+    `context_filled_before`, `context_filled_after`, and `duration` in
+    `Compaction::Result`.
+*   `Speaker#wait_for_speaker` method to join the speaker thread and block
+    until completion.
+*   `spec/ollama_chat/speaker_spec.rb` with tests for `OllamaChat::Speaker`.
+
+### Changed
+
+*   Replaced `str % {…}` with `named_placeholders_interpolate({…})` for
+    DB-prompt call sites to handle unknown placeholders gracefully.
+*   Updated `directory_structure` tool description from "Tree viewer" to "File
+    locator" and added guidance to prefer it over shell `find` or `ls -R`.
+*   Routed prompt change feedback through the `chat` instance in `app_state.rb`
+    to ensure messages target the active chat session.
+*   Switched spec stubs from `allow` to `expect` in `http_handling_spec.rb`,
+    `message_list_spec.rb`, `execute_shell_spec.rb`, `tts_spec.rb`,
+    `compaction_spec.rb`, `audio_player_spec.rb`, and `asr_spec.rb` to enforce
+    required calls.
+*   Bumped `const_conf` dependency from `~> **0.3**` to `~> **0.9**`.
+*   Updated `rerank_records` to accept an optional `prompt_name:` keyword
+    argument.
+*   Improved new session name generation by extracting
+    `new_random_session_name` into `SessionManagement` and handling `nil`
+    cancellation in `determine_valid_new_name_for_session`.
+*   Allowed naming new sessions via `choose_session` by threading an optional
+    `name:` keyword through `new_session` and `Session.with_defaults`.
+*   Logged stored memory text in the `memorize` tool by adding `text:` to the
+    `chat.log` data hash.
+*   Extracted context usage helpers `context_usage_colored` and
+    `context_percentage` to eliminate duplicated format logic.
+*   Updated `output_eval_stats` in `follow_chat.rb` to print colored context
+    usage.
+
+### Fixed
+
+*   Fixed indentation bug in `model_handling.rb` import/export by changing
+    `sub` to `gsub`.
+*   Guarded source link rendering in `search_knowledge` against `nil` or empty
+    `source` values.
+*   Suppressed `report_on_exception` on `AudioPlayer` background thread.
+
 ## 2026-09-25 v0.0.123
 
 ### Added

data/Rakefile

@@ -49,13 +49,13 @@ GemHadar do
   dependency             'reverse_markdown',      '~> 3.0'
   dependency             'kramdown-ansi',         '~> 0.5'
   dependency             'complex_config',        '~> 0.22', '>= 0.22.2'
-  dependency             'tins',                  '~> 1.58'
+  dependency             'tins',                  '~> 1.60'
   dependency             'search_ui',             '>= 0.2'
   dependency             'amatch',                '~> 0.4'
   dependency             'pdf-reader',            '~> 2.0'
   dependency             'bigdecimal',            '~> 3.1'
   dependency             'csv',                   '~> 3.0'
-  dependency             'const_conf',            '~> 0.3'
+  dependency             'const_conf',            '~> 0.9'
   dependency             'context_spook',         '~> 1.6'
   dependency             'infobar',               '>= 0.13.1'
   dependency             'rubyzip',               '~> 3.0'

data/bin/ollama_chat_log

@@ -4,7 +4,7 @@ require 'ollama_chat'
 require 'file/tail'
 require 'tins/xt'
 
-opts     = Tins::GO.go 'fm:n:h:', defaults: { ?n => 10  }
+opts     = Tins::GO.go 'hfm:n:', defaults: { ?n => 10  }
 log_path = ARGV.shift || OC::OLLAMA::CHAT::LOG::CHAT
 
 if opts[?h]

data/lib/ollama_chat/asr.rb

@@ -38,11 +38,11 @@ module OllamaChat
           executable = Shellwords.split(cmd).first
           result     = system(cmd, out: File::NULL, err: File::NULL)
           if result.nil?
-            STDERR.puts "ASR: #{executable} not found in PATH."
+            chat.feedback("ASR: #{executable} not found in PATH.", type: :warn)
             return
           end
           unless File.size(wav.path) > 0
-            STDERR.puts "ASR: #{executable} produced no output."
+            chat.feedback("ASR: #{executable} produced no output.", type: :warn)
             return
           end
 
@@ -61,7 +61,7 @@ module OllamaChat
           result = JSON.parse(response.body) rescue nil
         end
         chat.log(:error, e, data: { status:, result: })
-        STDERR.puts "ASR transcription failed: #{e.message}"
+        chat.feedback("ASR transcription failed: #{e.message}", type: :warn)
         nil
       end
 

data/lib/ollama_chat/chat.rb

@@ -34,6 +34,7 @@ require 'zlib'
 class OllamaChat::Chat
   include Tins::GO
   include Term::ANSIColor
+  include OllamaChat::Feedback
   include OllamaChat::TokenEstimator
   include OllamaChat::HTTPHandling
   include OllamaChat::Commands
@@ -64,6 +65,7 @@ class OllamaChat::Chat
   include OllamaChat::ConfigHandling
   include OllamaChat::PersonaeManagement
   include OllamaChat::SessionManagement
+  include OllamaChat::CollectionSearch
   include OllamaChat::RAGHandling
   include OllamaChat::FavouritesManagement
   include OllamaChat::PromptHandling
@@ -195,7 +197,7 @@ class OllamaChat::Chat
       abort "Failed to use to model: #{e}"
     end
 
-    STDOUT.puts
+    feedback ?\n
 
     setup_persona_from_session
     setup_system_prompt
@@ -203,7 +205,7 @@ class OllamaChat::Chat
     print_welcome
     info_session
 
-    STDOUT.puts "\nType /help to display the chat help."
+    feedback("\nType /help to display the chat help.")
 
     interact_with_user
   end
@@ -312,10 +314,11 @@ class OllamaChat::Chat
   #   instance when a background thread was spawned (so callers can call
   #   `cancel_speaking`), or `nil` for inline playback or when voice is off
   def speak(text, background: true)
+    session or return
     voice.on? or return
-    voice = session.current_voice.full? or return
+    current_voice = session.current_voice.full? or return
     voice_handler.method_defined?(:speak) or return
-    voice_handler.new(chat: self, voice:).speak(text, background:)
+    voice_handler.new(chat: self, voice: current_voice).speak(text, background:)
   end
 
   # Returns a human-readable string representation of the Chat object,
@@ -434,19 +437,19 @@ class OllamaChat::Chat
     case what
     when 'messages', nil
       messages.clear
-      STDOUT.puts "Cleared messages."
+      feedback("Cleared messages.", type: :info)
     when 'links'
       links.clear
-      STDOUT.puts "Cleared links."
+      feedback("Cleared links.", type: :info)
     when 'history'
       clear_history
-      STDOUT.puts "Cleared history."
+      feedback("Cleared history.", type: :info)
     when 'tags'
       @documents.clear
-      STDOUT.puts "Cleared all tags."
+      feedback("Cleared all tags.", type: :info)
     when 'images'
       messages.clear_images
-      STDOUT.puts "Cleared all images."
+      feedback("Cleared all images.", type: :info)
     when 'all'
       if confirm?(
           prompt: '🔔 Are you sure to clear messages and collection? (y/n) ',
@@ -457,9 +460,9 @@ class OllamaChat::Chat
         @documents.clear
         links.clear
         clear_history
-        STDOUT.puts "Cleared messages and collection #{bold{collection}}."
+        feedback("Cleared messages and collection #{bold{collection}}.", type: :info)
       else
-        STDOUT.puts 'Cancelled.'
+        feedback("Denied.", type: :denied)
       end
     end
     persona_profile
@@ -517,7 +520,7 @@ class OllamaChat::Chat
           type           = message.type.full?(:to_sym) || :socket_input
           content        = message.content
           @parse_content = message.parse
-          STDOUT.puts color(112) { "Received a server socket message. Processing now…" }
+          feedback color(112) { "Received a server socket message. Processing now…" }, type: :info
         else
           raise
         end
@@ -551,17 +554,8 @@ class OllamaChat::Chat
           group_uuid:
         )
 
-        if runtime_info.on?
-          tool_name = 'runtime_information'
-          messages << OllamaChat::Message.new(
-            role:        'user',
-            tool_name:   ,
-            sender_name: tool_name,
-            content:     dynamic_runtime_information,
-            images:      @images.dup,
-            group_uuid:
-          )
-        end
+        runtime_information_inject(group_uuid:)
+        trigger_inject(content, group_uuid:)
       end
       @images.clear
       handler = OllamaChat::FollowChat.new(
@@ -619,13 +613,13 @@ class OllamaChat::Chat
       msg = "Currently lost connection to ollama server and cannot send command."
       log(:warn, msg, warn: true)
     rescue Interrupt
-      STDOUT.puts "Type /quit to quit."
+      feedback("Type /quit to quit.")
     ensure
       self.server_socket_message = nil
     end
     0
   rescue OllamaChat::OllamaChatQuitError
-    STDOUT.puts "Goodbye."
+    feedback("Goodbye.")
   rescue ComplexConfig::AttributeMissing, ComplexConfig::ConfigurationSyntaxError => e
     log(:error, e)
     fix_config(e)
@@ -718,7 +712,7 @@ class OllamaChat::Chat
   # @note Progress is reported to STDOUT during processing
   def add_documents_from_argv(document_list)
     if document_list.any?(&:empty?)
-      STDOUT.puts "Clearing collection #{bold{documents.collection}}."
+      feedback("Clearing collection #{bold{documents.collection}}.", type: :info)
       documents.clear
       document_list.reject!(&:empty?)
     end
@@ -730,7 +724,7 @@ class OllamaChat::Chat
           File.expand_path(doc)
         end
       end
-      STDOUT.puts "Collection #{bold{documents.collection}}: Adding #{document_list.size} documents…"
+      feedback("Collection #{bold{documents.collection}}: Adding #{document_list.size} documents…", type: :info)
       count = 1
       document_list.each_slice(25) do |docs|
         docs.each do |doc|

data/lib/ollama_chat/clipboard.rb

@@ -116,11 +116,11 @@ module OllamaChat::Clipboard
     text = last_message_content(content: false)
     perform_copy_to_clipboard(text:, edit:)
     log(:info, "Copied to clipboard", data: { bytes: format_bytes(text.bytesize) }) if text
-    STDOUT.puts "The last response has been successfully copied to the system clipboard."
+    feedback("The last response has been successfully copied to the system clipboard.", type: :info)
     true
   rescue OllamaChat::OllamaChatError => e
     log(:error, e, data: { method: __method__ })
-    STDERR.puts e.message
+    feedback(e.message, type: :warn)
   end
 
   # Pastes content from the system clipboard into the chat.
@@ -137,11 +137,11 @@ module OllamaChat::Clipboard
   def paste_from_clipboard(edit: false)
     result = perform_paste_from_clipboard(edit:)
     log(:info, "Pasted from clipboard", data: { bytes: format_bytes(result.bytesize) }) if result
-    STDOUT.puts "The clipboard content has been successfully copied to the chat."
+    feedback("The clipboard content has been successfully copied to the chat.", type: :info)
     result
   rescue OllamaChat::OllamaChatError => e
     log(:error, e, data: { method: __method__ })
-    STDERR.puts e.message
+    feedback(e.message, type: :warn)
   end
 
   # Read the full text from STDIN and return it.

data/lib/ollama_chat/collection_search.rb

@@ -0,0 +1,162 @@
+# Shared collection search primitives for document retrieval and LLM
+# reranking.
+#
+# Extracted from {OllamaChat::Tools::SearchKnowledge} so that the
+# `/collection query` command and the trigger mechanism can reuse
+# the same search + rerank pipeline without duplicating logic.
+module OllamaChat::CollectionSearch
+  include Kramdown::ANSI::Width
+
+  # Searches the active document collection for records matching
+  # the given query.
+  #
+  # @param query [String] the search query
+  # @param tags [Array<String>, nil] tag filter
+  # @param text_size [Integer, nil] max snippet size
+  # @param text_count [Integer, nil] max number of snippets
+  # @param min_similarity [Float, nil] minimum similarity threshold
+  #
+  # @return [Array<Documentrix::Utils::TagResult>] matching records
+  def find_document_records(
+    query,
+    tags: nil, text_size: nil, text_count: nil, min_similarity: nil
+  )
+    tags = Documentrix::Utils::Tags.new(
+      tags, valid_tag: /\A#*([-\w.\]\[]+)/
+    )
+    effective_query  = query.first(
+      config.embedding.model.context_length
+    )
+    embedding_prompt = config.embedding.model.prompt?
+    log(
+      :info, 'Embedding search request',
+      data: {
+        model:      config.embedding.model.to_h,
+        collection: collection,
+        query:      effective_query,
+        prompt:     embedding_prompt,
+      }
+    )
+    records = @documents.find_where(
+      effective_query,
+      tags:,
+      prompt:         embedding_prompt,
+      text_size:,
+      text_count:,
+      min_similarity:
+    )
+    log(
+      :info, 'Embedding search response',
+      data: {
+        collection:   collection,
+        query:        effective_query,
+        result_count: records.size,
+        top:          records.first&.similarity&.round(4),
+      }
+    )
+    records
+  end
+
+  # Reranks a set of records using the LLM with the `rerank` prompt.
+  #
+  # @param query [String] the original search query
+  # @param records [Array<Documentrix::Utils::TagResult>] candidate records
+  # @param prompt_name [String, nil] the prompt template to use for
+  #   reranking; defaults to `'rerank'`
+  # @return [Array<Documentrix::Utils::TagResult>] filtered records
+  def rerank_records(query, records, prompt_name: nil)
+    candidates = records.each_with_index.map { |r, i|
+      "[#{i}] #{r.tags_set.to_s(link: false)} #{truncate(r.text.squeeze, length: 300)}"
+    }.join("\n")
+
+    prompt_name ||= 'default'
+    rerank_prompt = prompt(prompt_name, context: 'rerank') or
+      raise 'missing prompt %s' % prompt_name.inspect
+    rerank_prompt = rerank_prompt.to_s
+      .named_placeholders_interpolate({ query:, candidates: })
+
+    begin
+      if response = generate(prompt: rerank_prompt).full?
+        indices = response.scan(/\d+/).map(&:to_i)
+          .select { |i| (0...records.size).include?(i) }
+        records = records.values_at(*indices) if indices.any?
+      end
+    rescue => e
+      log(:error, e, data: { context: 'rerank' })
+    end
+    records
+  end
+
+  # Injects relevant snippets from the session's trigger collection
+  # into the conversation as a tool message.
+  #
+  # Reads the first entry of the session's `trigger` hash, performs a
+  # vector search in the configured collection, reranks the candidates
+  # via the LLM, and appends a `trigger_inject` tool message containing
+  # the surviving snippets (text, similarity, tags). The message is
+  # grouped with the current user message via `group_uuid`.
+  #
+  # @param content [String] the parsed user message text used as the
+  #   search query
+  # @param group_uuid [String, nil] the group UUID for message grouping
+  #   (shared with the user message and runtime-info message)
+  #
+  # @return [self, nil] self if snippets were injected, nil if no
+  #   trigger is configured, the trigger or embedding is disabled, the
+  #   collection or prompt is missing, or no snippets survived reranking
+  def trigger_inject(content, group_uuid:)
+    embedding.on? or return
+    trigger = session.trigger&.first or return
+    collection, config = trigger
+    unless config['enabled']
+      log(:info, 'Trigger for collection %s disabled.' % collection)
+      return
+    end
+    unless col = database_collection?(collection)
+      log(:error, 'Unknown collection named %s' % collection)
+      return
+    end
+    prompt_name = config['prompt_name']
+    unless rerank_prompt = prompt(prompt_name, context: 'rerank').full?(:to_s)
+      log(
+        :error, 'Unknown rerank prompt named %s' % prompt_name,
+        data: { config: }
+      )
+      return
+    end
+    records = []
+    switch_collection(collection) do
+      records = find_document_records(content, text_count: config['text_count'])
+      records.empty? and return
+      pre_rerank = records.size
+      records    = rerank_records(content, records, prompt_name:)
+      log(:info, 'Trigger: %d/%d passed rerank for %s' % [ records.size, pre_rerank, collection ],
+          data: { collection:, prompt_name: })
+      records.empty? and return
+    end
+    snippets = records.map { |record|
+      {
+        text:       record.text,
+        similarity: record.similarity.to_f,
+        tags:       record.tags_set.to_s(link: false),
+      }
+    }
+    message_content = {
+      prompt: prompt('snippets_trigger').to_s,
+      collection: {
+        name:        collection,
+        description: col.description&.to_s,
+      },
+      snippets:
+    }.to_json
+    tool_name       = 'trigger_inject'
+    messages << OllamaChat::Message.new(
+      role:        'user',
+      tool_name:   ,
+      sender_name: tool_name,
+      content:     message_content,
+      group_uuid:
+    )
+    self
+  end
+end