ollama_chat 0.0.99 → 0.0.101

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0818076703ebd6e8d8babbe5898a6a0069863ce7cebf18658f70e8d4b5592c51'
-  data.tar.gz: 7e9f768d41bff3560c2d22ac20ace84da0b580b3b17f8f9d1ffd3522af5d8db1
+  metadata.gz: 55511ef08f35b482ac7529dae4b9e4d9cb490bd37467fac563b966f3ad87f569
+  data.tar.gz: 26846b60e0ef32214b21a1e56128b4be6dbe6bd0808f195c8130186c01f8975c
 SHA512:
-  metadata.gz: 4864950b3246106793b51ffe74e3ead6dad4683f1b9fcaf710bf7f672264c646dc90dacdbcef437725b725230b8d0b70938045729ca982c83845ebce41bb773d
-  data.tar.gz: 5b99426668efc34bbb89a17faf2dcf016c1a6ada4c69d44882ebb40bcb836907741f96b5fb66ee99ea75b78abbdd34069ddbc186d525acd015302bcea95e55a7
+  metadata.gz: 1d7960e9303887e5ef3571b79bffbf2cd30785c8db4051e6fc7a16f828e7d5dbe8754006a5356074c83fb989dd35b27b5311d1e676c330f4303a81014d16c4ac
+  data.tar.gz: dfcb0fee96b6093e0d30cd7cb4894aa25752054236d85a14161519fb781d1697c7011816441dbdddfeb3477872c057b9382c594b2691c40f3238c9c727d43843

data/CHANGES.md

@@ -1,5 +1,117 @@
 # Changes
 
+## 2026-07-26 v0.0.101
+
+### Added
+
+- Introduced a `clean` subcommand to `/conversation` to remove tool content,
+  images, and thinking from messages in place, including a confirmation prompt
+  for the destructive operation.
+- Implemented `OllamaChat::Utils::LogViewer` and the `bin/ollama_chat_log`
+  utility for real-time, colorized JSON log tailing with regex filtering.
+- Added `estimate_tokens` and `count_messages` helper methods to
+  `OllamaChat::Database::Models::Session`.
+- Implemented `clean_messages!` in `MessageList` with associated YARD
+  documentation.
+
+### Changed
+
+- Enhanced file patching integrity by replacing `mtime` and `line_count` checks
+  with a CRC32 `checksum`. This acts as a "proof of reading": since LLMs cannot
+  calculate CRC32 in their head, echoing the checksum proves they have the
+  latest file context including linenumbers without requiring cryptographic
+  security.
+- Updated `read_file` to conditionally return `checksum` only when full-file
+  line numbers are requested, optimizing token usage for non-patching workflows.
+- Refactored `OllamaChat::Logging#log` to use `deep_transform` for payload
+  sanitization, handling circular references and non-serializable objects.
+- Standardized the `tool: name` variable across 28+ tool classes to ensure
+  consistent audit trails.
+- Expanded logging coverage for file operations, grep, tests, RAG handling,
+  session management, and clipboard operations.
+- Split `OllamaChat::FollowChat#eval_stats` into a data extraction method
+  `stats_hash` and a separate formatting method.
+- Updated `/conversation` command to support the `-c` flag for `save` and added
+  path validation for `save` and `load` subcommands.
+- Modified `lib/ollama_chat/tools/patch_file.rb` to validate that `edits` is an
+  `Array` and handle `checksum` mismatches.
+
+### Fixed
+
+- Improved option parsing scope within the `/conversation` command by moving
+  logic inside the `when 'save'` block.
+
+## 2026-07-23 v0.0.100
+
+### New Features
+
+- **UUID v7 Integration**: Implemented a compatibility shim via
+  `OllamaChat::UUIDV7.generate` that utilizes native `SecureRandom.uuid_v7` for
+  Ruby **3.3**+ and a custom RFC 9562 compliant implementation for older
+  versions.
+- **Document Parsing & Embeddings**:
+    - Added EPUB support using `pandoc` via the `epub_read` method and updated
+      `parse_source` to handle `application/epub+zip`.
+    - Enhanced retrieval precision by prepending source identifiers to document
+      chunks in `embed_source`.
+- **Structured Logging**: Implemented a JSON formatter in `OllamaChat::Logging`
+  with a `data:` keyword argument for structured context, including separate
+  capture of backtraces and tool execution details.
+- **Prompt Management Refactor**: 
+    - Unified prompt API using a `context:` keyword argument across `prompt`,
+      `each_prompt`, `delete_prompt`, `store_prompt`, and `write_prompt`.
+    - Introduced dynamic context parameters (defaulting to `'prompt'`) and
+      restructured `default_config.yml` to nest prompts under `prompt:`,
+      `suggest:`, and `system:`.
+    - Promoted `/suggest` to a top-level command and simplified the `/system`
+      command.
+- **Conversation Grouping**: Introduced `group_uuid` in `OllamaChat::Message`
+  to enable conversation grouping, including a `repair_group_uuids` method in
+  `OllamaChat::SessionManagement` for legacy data migration.
+- **Tool Enhancements**:
+    - **`read_file`**: Added support for line numbering via the `line_numbers`
+      parameter and range extraction using `start_line` and `end_line`. Now
+      returns total `line_count` and file `mtime` in ISO8601 format.
+    - **`patch_file`**: Refactored to support coordinate-based patching via an
+      `edits` parameter for targeted line-range replacements, including overlap
+      detection and freshness checks using `mtime`.
+    - **`generate_password`**: Added `base64url` alphabet support and critical
+      security warnings to discourage the use of `eval_ruby` for secret
+      generation.
+
+### Improvements & Refactoring
+
+- **CLI & UX**:
+    - Refactored command help strings with emoji prefixes and a more concise,
+      scannable multi-line format using heredocs.
+    - Added a welcome message upon startup displaying the version, connected
+      server version, and URL via `print_welcome`.
+    - Standardized the creation workflow for prompts and personae with a source
+      selection menu (`[CLIPBOARD]`, `[FILES]`, `[EMPTY/MANUAL]`).
+- **Application Flow**: 
+    - Implemented `OllamaChatQuitError` to handle graceful application
+      shutdowns via exception-based control flow.
+    - Added a `[QUIT-APP]` option to the session chooser after deletion.
+- **Internal Logic**:
+    - Optimized `ps_read` by replacing manual read loops with `IO.copy_stream`.
+    - Centralized Ollama chat request logging through a new `call_ollama_chat`
+      wrapper.
+    - Refactored model option reconfiguration into a dedicated
+      `reconfigure_model_options` method in
+      `lib/ollama_chat/model_handling.rb`.
+    - Updated dependencies: `ollama-ruby` to **1.23** and `tins` to **1.54**.
+
+### Bug Fixes & Stability
+
+- Added error logging (`chat.log(:error, e)`) to the `rescue` blocks of all 33
+  tool execution methods.
+- Fixed a typo in the Ghostscript error message within `ps_read`.
+- Added defensive handling for `JSON.load` results in `model_handling.rb` using
+  `.full? || {}` to prevent `nil` propagation.
+- Removed implicit fallbacks to the last assistant response in
+  `copy_to_clipboard` and `paste_into_editor`, making `text` a required
+  parameter.
+
 ## 2026-07-13 v0.0.99
 
 ### Changed

data/README.md

@@ -120,7 +120,7 @@ A source isn't just a filename; it can be any of the following:
 *   **Remote URLs**: Any `http://` or `https://` link. The command will fetch the
     web content and parse it before importing.
 *   **Shell Commands (`!`)**: Any source starting with an exclamation mark is
-    executed as a shell command, and its **STDOUT** is imported as the content. 
+    executed as a shell command, and its **STDOUT** is imported as the content.
     *   *Example*: `/input !ls -la` imports the current directory listing.
     *   *Example*: `/input !git branch` tells the AI which branch you are on.
 
@@ -358,6 +358,56 @@ functionality:
 These parameters provide greater flexibility in how you interact with
 `ollama_chat`, whether from the command line or integrated tools like `vim`.
 
+### Using `ollama_chat_log` to Inspect Application Logs
+
+OllamaChat produces structured JSON logs that capture every tool execution,
+conversation state, and internal event. The `ollama_chat_log` utility allows you
+to filter, colorize, and tail these logs in real-time, displaying the full
+structured data payload by default.
+
+#### Basic Usage
+
+By default, `ollama_chat_log` reads the current session's log file located at
+`~/.local/state/ollama_chat/chat.json` (or wherever the default points).
+
+```bash
+# Show the last 10 log entries
+$ ollama_chat_log
+
+# Show the last 50 entries
+$ ollama_chat_log -n 50
+```
+
+#### Real-time Tailing
+
+Use the `-f` flag to follow the log file as new entries are appended, similar to
+`tail -f`.
+
+```bash
+$ ollama_chat_log -f
+```
+
+#### Filtering Logs with `-m`
+
+The `-m` flag allows you to filter logs based on nested JSON paths using dot
+notation. You can match for key presence or substring matches within values.
+
+- **Key Presence**: `-m "data.tool"` (shows only logs that have a `tool` key)
+- **Substring Match**: `-m "data.tool=read_file"` (shows logs where the tool is `read_file`)
+- **Nested Paths**: `-m "data.function.name=patch_file"`
+- **Regexp Match**: `-m "data.tool=^(write_file|patch_file)$"`
+
+You can chain multiple `-m` flags together. All patterns must match for a log
+entry to be displayed (AND logic).
+
+```bash
+# Show only successful file reads
+$ ollama_chat_log -m "data.tool=read_file" -m "level=info"
+
+# Follow and watch for specific tool executions
+$ ollama_chat_log -f -m "data.tool=execute_grep"
+```
+
 ## Available Tools
 
 The assistant can interact with the system using a variety of tools to gather

data/Rakefile

@@ -39,7 +39,7 @@ GemHadar do
   )
 
   dependency             'excon',                 '~> 1.0'
-  dependency             'ollama-ruby',           '~> 1.22'
+  dependency             'ollama-ruby',           '~> 1.23'
   dependency             'documentrix',           '>= 0.6.0'
   dependency             'unix_socks',            '>= 0.4'
   dependency             'rss',                   '~> 0.3'
@@ -49,7 +49,7 @@ GemHadar do
   dependency             'reverse_markdown',      '~> 3.0'
   dependency             'kramdown-ansi',         '~> 0.5'
   dependency             'complex_config',        '~> 0.22', '>= 0.22.2'
-  dependency             'tins',                  '~> 1.53'
+  dependency             'tins',                  '~> 1.55'
   dependency             'search_ui',             '>= 0.2'
   dependency             'amatch',                '~> 0.4'
   dependency             'pdf-reader',            '~> 2.0'
@@ -60,6 +60,7 @@ GemHadar do
   dependency             'infobar',               '>= 0.13.1'
   dependency             'rubyzip',               '~> 3.0'
   dependency             'sequel',                '~> 5.0'
+  dependency             'file-tail',             '~> 1.4'
   development_dependency 'all_images',            '~> 0.12'
   development_dependency 'rspec',                 '~> 3.2'
   development_dependency 'kramdown',              '~> 2.0'

data/bin/ollama_chat_log

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'ollama_chat'
+require 'file/tail'
+require 'tins/xt'
+
+opts     = Tins::GO.go 'fm:n:h:', defaults: { ?n => 10  }
+log_path = ARGV.shift || OC::OLLAMA::CHAT::LOGFILE
+
+if opts[?h]
+  puts <<~EOT
+    Usage: #{File.basename($0)} [OPTIONS] [LOGFILE]
+
+    Options:
+    -f            Follow the log file (real-time tailing)
+    -n NUMBER     Rewind and show the last NUMBER of lines before starting
+    -m MATCH      Filter logs by JSON key paths and values (can be used multiple times)
+                  - Key presence match: -m "data.tool"
+                  - Substring match:    -m "data.tool=read_file" or -m "level=ERROR"
+                  - Regexp match:       -m "data.tool=^(write_file|patch_file)$"
+                  - Nested path match:  -m "data.function.name=write_file"
+    -h            Show this help
+
+    LOGFILE       Path to the JSON log file (defaults to the current chat log)
+  EOT
+  exit 0
+end
+
+unless File.exist?(log_path)
+  STDERR.puts "Error: Log file not found at #{log_path.inspect}"
+  exit 1
+end
+
+# The processing loop
+def process_logs(path, follow: false, rewind: 0, display_data: true, match: nil)
+  if follow
+    # Real-time tailing implementation
+    puts "Watching logs... (Ctrl+C to stop)"
+    File::Tail::Logfile.open(path, backward: rewind) do |log|
+      log.tail do |line|
+        output = OllamaChat::Utils::LogViewer.format_line(line, display_data:, match:)
+        output or next
+        puts output
+      end
+    end
+  else
+    File::Tail::Logfile.open(path, backward: rewind) do |log|
+      log.each do |line|
+        output = OllamaChat::Utils::LogViewer.format_line(line, display_data:, match:)
+        output or next
+        puts output
+      end
+    end
+  end
+rescue Interrupt
+  puts "\nStopping log viewer..."
+end
+
+process_logs(
+  log_path,
+  follow:       opts[?f],
+  rewind:       opts[?n].to_i,
+  match:        opts[?m]
+)

data/lib/ollama_chat/chat.rb

@@ -15,6 +15,7 @@ require 'csv'
 require 'socket'
 require 'shellwords'
 require 'context_spook'
+require 'zlib'
 
 # A chat client for interacting with Ollama models through a terminal
 # interface.
@@ -116,6 +117,7 @@ class OllamaChat::Chat
     else
       messages.read_conversation_jsonl(session.messages.to_s)
     end
+    repair_group_uuids
     embedding_enabled.set(config.embedding.enabled && !@opts[?E])
     @documents            = setup_documents
     @cache                = setup_cache
@@ -124,7 +126,6 @@ class OllamaChat::Chat
     @tool_call_results    = Hash.new { |h, name| h[name] = [] }
     setup_personae_directory
     @opts[?S] and init_server_socket
-    info_session
   rescue ComplexConfig::AttributeMissing, ComplexConfig::ConfigurationSyntaxError => e
     fix_config(e)
   end
@@ -160,9 +161,9 @@ class OllamaChat::Chat
   # @return [Array] a list of images to be sent with the next prompt
   attr_reader :images
 
-  # Provides read-only access to the cache instance used by the object
+  # Provides read-only access to the cache instance used by the object.
   #
-  # @attr_reader [Cache] the cache instance
+  # @return [OllamaChat::RedisCache, nil] the cache instance
   attr_reader :cache
 
   # The start method initializes the chat session by displaying information,
@@ -183,6 +184,7 @@ class OllamaChat::Chat
     setup_persona_from_session
     setup_system_prompt
 
+    print_welcome
     info_session
 
     STDOUT.puts "\nType /help to display the chat help."
@@ -255,7 +257,7 @@ class OllamaChat::Chat
       ),
     ]
 
-    content = ollama.chat(
+    content = call_ollama_chat(
       model:    @model,
       messages: ,
       options:  model_options,
@@ -265,22 +267,39 @@ class OllamaChat::Chat
     )&.message&.content.to_s
 
     if content.empty?
-      log(
-        :warn,
-        "Sent #{prompt.inspect} to LLM for generation, received no content!"
-      )
+      log(:warn, "LLM generation returned empty content", data: { prompt: })
     else
-      log(
-        :info,
-        "Sent #{prompt.inspect} to LLM for generation, received #{content.inspect}"
-      )
+      log(:info, "LLM generation successful", data: { prompt:, content: })
     end
 
     content
   end
 
+  # Returns a human-readable string representation of the Chat object,
+  # including the class name and the base URL.
+  #
+  # @return [String] the inspected string
+  def inspect
+    "#<#{self.class}: #{base_url.to_s}>"
+  end
+
   private
 
+  # Wrapper for ollama.chat to provide consistent logging of all arguments.
+  #
+  # @param opts [Hash] keyword arguments for the chat call
+  # @param block [Proc] optional handler block
+  def call_ollama_chat(**opts, &block)
+    if debug
+      log(:debug, "Ollama chat request sent", data: opts)
+    else
+      clean_opts = opts.dup
+      clean_opts = clean_opts.slice!(:messages, :tools)
+      log(:info, "Ollama chat request sent", data: clean_opts)
+    end
+    ollama.chat(**opts, &block)
+  end
+
   # @return [Module] The module containing the database models.
   def models
     OllamaChat::Database::Models
@@ -328,6 +347,14 @@ class OllamaChat::Chat
   # @param prefill_prompt [String, nil] The text to prefill, or nil to clear it
   attr_writer :prefill_prompt
 
+  # Signals a graceful shutdown of the application.
+  #
+  # Raises {OllamaChat::OllamaChatQuitError} which is caught by the main
+  # interaction loop to terminate the session cleanly.
+  def quit_app
+    raise OllamaChat::OllamaChatQuitError
+  end
+
   # Handles user input commands and processes chat interactions.
   #
   # @param content [String] The input content to process
@@ -394,13 +421,16 @@ class OllamaChat::Chat
   # The method also handles server socket messages, manages chat history, and
   # ensures proper cleanup and configuration handling throughout the
   # interaction.
+  #
+  # @return [Integer] returns 0 on successful completion or raises an error
   def interact_with_user
     loop do
       content           = nil
+      group_uuid        = OllamaChat::UUIDV7.generate
       tools_were_called = false
       enable_content_parsing
-      type              = :terminal_input
-      input_prompt      = bold { color(172) { message_type(@images) + " user" } } + bold { "> " }
+      type         = :terminal_input
+      input_prompt = bold { color(172) { message_type(@images) + " user" } } + bold { "> " }
       begin
         tools_were_called = handle_tool_call_results? { |index, tool_name, content|
           messages << OllamaChat::Message.new(
@@ -408,7 +438,8 @@ class OllamaChat::Chat
             sender_name: tool_name,
             tool_name:   ,
             content:     ,
-            images:      @images.dup
+            images:      @images.dup,
+            group_uuid:
           )
         }
         tools_were_called and type = :tool_input
@@ -444,8 +475,6 @@ class OllamaChat::Chat
           next
         when :redo
           redo
-        when :return
-          return
         when String
           content = next_action
         end
@@ -458,6 +487,14 @@ class OllamaChat::Chat
 
         parse_content? and content = parse_content(content, @images)
 
+        messages << OllamaChat::Message.new(
+          role:        'user',
+          sender_name: user_name,
+          content:     ,
+          images:      @images.dup,
+          group_uuid:
+        )
+
         if runtime_info.on?
           tool_name = 'runtime_information'
           messages << OllamaChat::Message.new(
@@ -465,22 +502,17 @@ class OllamaChat::Chat
             tool_name:   ,
             sender_name: tool_name,
             content:     dynamic_runtime_information,
-            images:      @images.dup
+            images:      @images.dup,
+            group_uuid:
           )
         end
-
-        messages << OllamaChat::Message.new(
-          role:        'user',
-          sender_name: user_name,
-          content:     ,
-          images:      @images.dup
-        )
       end
       @images.clear
       handler = OllamaChat::FollowChat.new(
         chat:     self,
         messages:,
-        voice:    (voices.selected if voice.on?)
+        voice:    (voices.selected if voice.on?),
+        group_uuid:
       )
       begin
         retried = false
@@ -493,7 +525,7 @@ class OllamaChat::Chat
           }
         end
         prepare_model(@model)
-        ollama.chat(
+        call_ollama_chat(
           model:    @model,
           messages: sent_messages,
           options:  model_options,
@@ -534,6 +566,8 @@ class OllamaChat::Chat
       self.server_socket_message = nil
     end
     0
+  rescue OllamaChat::OllamaChatQuitError
+    STDOUT.puts "Goodbye."
   rescue ComplexConfig::AttributeMissing, ComplexConfig::ConfigurationSyntaxError => e
     log(:error, e)
     fix_config(e)
@@ -572,7 +606,7 @@ class OllamaChat::Chat
     if server_version.version < '0.9.0'.version
       raise 'require ollama API version 0.9.0 or higher'
     end
-    log(:info, "Connection to #{base_url} established.")
+    log(:info, "Connection established", data: { base_url: })
     @ollama
   end
 
@@ -609,7 +643,7 @@ class OllamaChat::Chat
     end
   end
 
-  # Adds documents from command line arguments to the document collection
+  # Adds documents from command line arguments to the document collection.
   #
   # Processes a list of document paths or URLs, handling both local files and
   # remote resources.

data/lib/ollama_chat/clipboard.rb

@@ -109,14 +109,17 @@ module OllamaChat::Clipboard
   # message to standard error and does not re-raise the exception.
   #
   # @param edit [truthy/falsy] If true, opens the content in the editor for
-  #   modification before copying (default: true)
+  #   modification before copying (default: false)
   #
   # @return [TrueClass] if the copying has been performed successfully.
   def copy_to_clipboard(edit: false)
-    perform_copy_to_clipboard(edit:)
+    text = last_message_content(content: false)
+    perform_copy_to_clipboard(text: 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."
     true
   rescue OllamaChat::OllamaChatError => e
+    log(:error, e, data: { method: __method__ })
     STDERR.puts e.message
   end
 
@@ -133,9 +136,11 @@ module OllamaChat::Clipboard
   #   or nil if an error occurred
   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."
     result
   rescue OllamaChat::OllamaChatError => e
+    log(:error, e, data: { method: __method__ })
     STDERR.puts e.message
   end
 end