ollama_chat 0.0.25 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a08d4184578d406a8e5d02823cbd5fc0c1999591f86f715b99637b9a263ba7f4
-  data.tar.gz: 2cdbb7c09d8de378fc58b292e4d2e29ba6849f3b9c3f1bb742ba658ec6b997e0
+  metadata.gz: c2155f3ea224b97ac3a471848b53530b60308b685b21804a23138ce31e752891
+  data.tar.gz: f96db1b34a1d1a95bad394d6c0ac0ba43f7bc1c481344aa7d0d19565c4889149
 SHA512:
-  metadata.gz: da10d3bd76363f8856a0e35dfe927084374025c3e87a9e531d02ba07bcaa214e057a649ab9c3c46057947e651f8ca616344a1de30bcecc1d64fe4e8c13df3893
-  data.tar.gz: c2944a6a328e5a1833d4becfe9842dbdd6b4d223bb36903b22254914d22ec19eadcc7942f0e4ba0d6a11d0fccfb4d41f3bf5624019901fb594e652aeacd70c21
+  metadata.gz: 6dfc776afc77a3cfdb3b5ab6d6d4d41e188345c15d4e8341495c00e90d4c03aefef4ac01af1d8ffae4b1a20deb11c8cfe3f063e8d4d11c53aaa8253fd66d5466
+  data.tar.gz: aee0b2f2fe0a17af19d09384df6dca08a3848fb6ebea981d71f93f1e8dc56858e6e293619b1755ea97aaefd2f7174925d50387cb5b9782c976ef477270d4e373

data/CHANGES.md

@@ -1,5 +1,27 @@
 # Changes
 
+## 2025-09-05 v0.0.27
+
+- Enhanced cache hit notifications to properly handle content type with
+  fallback to 'unknown'
+- Modified `OllamaChat::Utils::CacheFetcher` to return `io` for proper content
+  type propagation
+
+## 2025-08-27 v0.0.26
+
+- Enhanced `/last` command to support numeric argument, allowing users to
+  specify the number of messages to display
+- Configured tests to protect environment variables by using `protect_env:
+  true` option and direct `ENV` manipulation
+- Refactored spec helper with modularized `AssetHelpers`, `StubOllamaServer`,
+  and `ProtectEnvVars` modules for better organization
+- Improved code clarity and added comprehensive documentation across multiple
+  modules including `OllamaChat`, `Chat`, `MessageList`, and others
+- Added detailed class-level documentation for `OllamaChatConfig` with examples
+- Included documentation for the `Parsing`, `Vim`, `MessageFormat`,
+  `KramdownANSI`, `Information`, `UserAgent`, and `History` modules
+- Improved cache hit message formatting and wording for better user experience
+
 ## 2025-08-18 v0.0.25
 
 - Integrated `context_spook` gem as development dependency

data/README.md

@@ -153,7 +153,7 @@ The following commands can be given inside the chat, if prefixed by a `/`:
 /stream                         toggle stream output
 /location                       toggle location submission
 /voice [change]                 toggle voice output or change the voice
-/last                           show the last system/assistant message
+/last [n]                       show the last n / 1 system/assistant message
 /list [n]                       list the last n / all conversation exchanges
 /clear [what]                   clear what=messages|links|history|tags|all
 /clobber                        clear the conversation, links, and collection
@@ -177,6 +177,7 @@ The following commands can be given inside the chat, if prefixed by a `/`:
 /load filename                  load conversation messages
 /output filename                save last response to filename
 /pipe command                   write last response to command's stdin
+/vim                            insert the last message into a vim server
 /quit                           to quit
 /help                           to view this help
 ```

data/Rakefile

@@ -21,7 +21,11 @@ GemHadar do
 
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.AppleDouble', '.bundle',
-    '.yardoc', 'tags', 'corpus', 'coverage', '/config/searxng/*'
+    '.yardoc', 'doc', 'tags', 'corpus', 'coverage', '/config/searxng/*',
+    '.starscope.db', 'cscope.out'
+  package_ignore '.all_images.yml', '.tool-versions', '.gitignore', 'VERSION',
+    '.rspec', '.github', *FileList['.contexts/*'], '.envrc'
+
 
   readme      'README.md'
 

data/lib/ollama_chat/chat.rb

@@ -17,6 +17,20 @@ require 'xdg'
 require 'socket'
 require 'shellwords'
 
+# A chat client for interacting with Ollama models through a terminal
+# interface.
+#
+# The Chat class provides a complete command-line interface for chatting with
+# language models via the Ollama API. It handles configuration management,
+# message history, document processing, web searching, and various interactive
+# features including voice output, markdown rendering, and embedding
+# capabilities.
+#
+# @example Initializing a chat session
+#   chat = OllamaChat::Chat.new(argv: ['-m', 'llama3.1'])
+#
+# @example Starting an interactive chat
+#   chat.start
 class OllamaChat::Chat
   include Tins::GO
   include Term::ANSIColor
@@ -114,7 +128,6 @@ class OllamaChat::Chat
   # @return [Ollama::Client] the configured Ollama API client
   attr_reader :ollama
 
-
   # Returns the documents set for this object, initializing it lazily if needed.
   #
   # The documents set is memoized, meaning it will only be created once per
@@ -205,11 +218,12 @@ class OllamaChat::Chat
       end
       :next
     when %r(^/list(?:\s+(\d*))?$)
-      last = 2 * $1.to_i if $1
-      messages.list_conversation(last)
+      n = 2 * $1.to_i if $1
+      messages.list_conversation(n)
       :next
-    when %r(^/last$)
-      messages.show_last
+    when %r(^/last(?:\s+(\d*))?$)
+      n = $1.to_i if $1
+      messages.show_last(n)
       :next
     when %r(^/clear(?:\s+(messages|links|history|tags|all))?$)
       clean($1)
@@ -661,7 +675,6 @@ class OllamaChat::Chat
   #
   # @see fetch_source
   # @see embed_source
-  # @see documents.clear
   def add_documents_from_argv(document_list)
     if document_list.any?(&:empty?)
       STDOUT.puts "Clearing collection #{bold{documents.collection}}."

data/lib/ollama_chat/document_cache.rb

@@ -1,20 +1,38 @@
+# Module for handling document caching and retrieval using embedding
+# similarity.
+#
+# This module provides methods to configure cache backends and manage document
+# storage with semantic search capabilities. It integrates with Documentrix's
+# document management system to enable efficient storage, retrieval, and
+# similarity-based searching of documents using vector embeddings.
 module OllamaChat::DocumentCache
-  # The document_cache_class method returns the cache class specified in the
-  # configuration.
+  # Retrieves the cache class specified in the configuration.
   #
-  # @return [ Class ] the cache class defined by the config.cache setting
+  # This method resolves the cache class name from the application's
+  # configuration to dynamically load the appropriate cache implementation.
+  #
+  # @return [Class] The cache class referenced by the configuration's cache
+  # setting.
+  # @raise [NameError] If the configured cache class name does not correspond
+  # to an existing constant.
   def document_cache_class
     Object.const_get(config.cache)
   end
 
-  # The configure_cache method determines the appropriate cache class to use
-  # for document storage.
-  # It checks if the -M option was specified to use MemoryCache, otherwise it
-  # attempts to use the configured cache class.
-  # If an error occurs during this process, it falls back to using MemoryCache
-  # and reports the error.
+  # Configures and returns the appropriate cache class based on command-line
+  # options.
+  #
+  # Determines which cache implementation to use based on command-line flags: -
+  # If the `-M` flag is set, uses {Documentrix::Documents::MemoryCache} -
+  # Otherwise, resolves and returns the cache class specified in configuration
+  #
+  # Falls back to {Documentrix::Documents::MemoryCache} if configuration
+  # resolution fails.
   #
-  # @return [ Class ] the selected cache class to be used for document caching
+  # @return [Class] The selected cache class for document storage and
+  # retrieval.
+  # @raise [StandardError] If there is an error resolving the configured cache
+  # class, logs the error to standard error and falls back to MemoryCache.
   def configure_cache
     if @opts[?M]
       Documentrix::Documents::MemoryCache

data/lib/ollama_chat/follow_chat.rb

@@ -1,3 +1,15 @@
+# A class that handles chat responses and manages the flow of conversation
+# between the user and Ollama models.
+#
+# This class is responsible for processing Ollama API responses, updating
+# message history, displaying formatted output to the terminal, and managing
+# voice synthesis for spoken responses. It acts as a handler for streaming
+# responses and ensures proper formatting and display of both regular content
+# and thinking annotations.
+#
+# @example Processing a chat response
+#   follow_chat = OllamaChat::FollowChat.new(chat: chat_instance, messages: message_list)
+#   follow_chat.call(response)
 class OllamaChat::FollowChat
   include Ollama
   include Ollama::Handlers::Concern
@@ -6,10 +18,13 @@ class OllamaChat::FollowChat
 
   # 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 [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.
+  # @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)
@@ -23,7 +38,8 @@ class OllamaChat::FollowChat
 
   # Returns the conversation history (an array of message objects).
   #
-  # @return [OllamaChat::MessageList<Ollama::Message>] The array of messages in the conversation.
+  # @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.
@@ -32,15 +48,18 @@ class OllamaChat::FollowChat
   # 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).
+  #   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.
+  # @param [Ollama::Response] response The parsed JSON response from the Ollama
+  # server.
   #
   # @return [OllamaChat::FollowChat] The current instance for method chaining.
   def call(response)

data/lib/ollama_chat/history.rb

@@ -1,29 +1,77 @@
+# A module that provides history management functionality for OllamaChat
+# sessions.
+#
+# The History module encapsulates methods for initializing, saving, and
+# clearing command-line history within the OllamaChat application. It handles
+# persistence of user input history to a file and ensures that chat sessions
+# can maintain state across invocations by loading previous command histories.
+#
+# @example Initializing chat history
+#   chat.init_chat_history
+#
+# @example Saving chat history
+#   chat.save_history
+#
+# @example Clearing chat history
+#   chat.clear_history
 module OllamaChat::History
-  # Returns the full path of the chat history filename based on the
-  # configuration.
+  # The chat_history_filename method constructs and returns the full file path
+  # for the chat history file.
+  #
+  # This method takes the configured chat history filename from the
+  # configuration and expands it to an absolute path using File.expand_path.
+  # This ensures that the returned path is fully qualified and can be used
+  # reliably for reading from or writing to the chat history file.
+  #
+  # @return [String] the absolute file path to the chat history file as
+  # specified in 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.
+  # The init_chat_history method initializes the chat session by loading
+  # previously saved command history from a file.
+  #
+  # This method checks for the existence of a chat history file and, if found,
+  # loads its contents into the Readline::HISTORY array. It clears the current
+  # history and replaces it with the saved history data. Any errors during the
+  # loading process are caught and logged as warnings, but do not interrupt the
+  # execution flow.
   def init_chat_history
     if File.exist?(chat_history_filename)
       File.open(chat_history_filename, ?r) do |history|
         history_data = JSON.load(history)
-        clear_history
+        Readline::HISTORY.clear
         Readline::HISTORY.push(*history_data)
       end
     end
+  rescue => e
+    warn "Caught #{e.class} while loading #{chat_history_filename.inspect}: #{e}"
   end
 
-  # Saves the current chat history to a file in JSON format.
+  # The save_history method persists the current command history to a file.
+  #
+  # This method serializes the Readline::HISTORY array into JSON format and
+  # writes it to the chat history filename. It handles potential errors during
+  # the write operation by catching exceptions and issuing a warning message.
   def save_history
     File.secure_write(chat_history_filename, JSON.dump(Readline::HISTORY))
+  rescue => e
+    warn "Caught #{e.class} while saving #{chat_history_filename.inspect}: #{e}"
   end
 
-  # Clears all entries from Readline::HISTORY.
+  # The clear_history method clears the Readline history array and ensures that
+  # the chat history is saved afterwards.
+  #
+  # This method removes all entries from the Readline::HISTORY array,
+  # effectively clearing the command history maintained by the readline
+  # library. It then calls save_history to persist this cleared state to the
+  # configured history file. The method uses an ensure block to guarantee that
+  # save_history is called even if an exception occurs during the clearing
+  # process.
   def clear_history
     Readline::HISTORY.clear
+  ensure
+    save_history
   end
 end

data/lib/ollama_chat/information.rb

@@ -1,3 +1,20 @@
+# A module that provides information and user agent functionality for
+# OllamaChat
+#
+# The Information module encapsulates methods for managing application
+# identification, displaying version and configuration details, and handling
+# command-line interface help messages. It includes user agent capabilities for
+# HTTP requests and provides comprehensive information display features for
+# chat sessions.
+#
+# @example Displaying application information
+#   chat.info
+#
+# @example Showing version details
+#   chat.version
+#
+# @example Displaying usage help
+#   chat.usage
 module OllamaChat::Information
   extend Tins::Concern
 
@@ -6,6 +23,20 @@ module OllamaChat::Information
     extend UserAgent
   end
 
+  # A module that provides user agent functionality for identifying the
+  # application.
+  #
+  # This module encapsulates methods for determining the application name and
+  # constructing a standardized user agent string that includes the application
+  # name and version. It is designed to be included in classes that need to
+  # provide identification information for HTTP requests or other
+  # communications.
+  #
+  # @example Accessing the program name
+  #   UserAgent.progname # => "ollama_chat"
+  #
+  # @example Generating a user agent string
+  #   UserAgent.user_agent # => "ollama_chat/0.0.25"
   module UserAgent
     # The progname method returns the name of the application.
     #
@@ -92,7 +123,7 @@ module OllamaChat::Information
       /stream                         toggle stream output
       /location                       toggle location submission
       /voice [change]                 toggle voice output or change the voice
-      /last                           show the last system/assistant message
+      /last [n]                       show the last n / 1 system/assistant message
       /list [n]                       list the last n / all conversation exchanges
       /clear [what]                   clear what=messages|links|history|tags|all
       /clobber                        clear the conversation, links, and collection

data/lib/ollama_chat/kramdown_ansi.rb

@@ -1,3 +1,15 @@
+# A module that provides Kramdown::ANSI styling configuration and parsing
+# functionality for OllamaChat.
+#
+# This module handles the setup and application of ANSI styles for markdown
+# rendering, allowing for customizable terminal output formatting. It manages
+# the configuration of ANSI styles either from environment variables or falls
+# back to default settings, and provides methods to parse content with the
+# configured styling.
+#
+# @example Configuring custom ANSI styles via environment variable
+#   Set KRAMDOWN_ANSI_OLLAMA_CHAT_STYLES to a JSON object containing style
+#   definitions for customizing markdown output formatting in the terminal.
 module OllamaChat::KramdownANSI
   # The configure_kramdown_ansi_styles method sets up ANSI styling for
   # Kramdown::ANSI output by checking for specific environment variables and

data/lib/ollama_chat/message_format.rb

@@ -1,3 +1,19 @@
+# A module that provides formatting functionality for chat messages.
+#
+# The MessageFormat module encapsulates methods for determining message icons
+# based on whether images are present, and for conditionally annotating content
+# with thinking or talk indicators. It supports customizable formatting of
+# message text for display in terminal interfaces.
+#
+# @example Using message_type to determine icon based on images
+#   message_type([])        # => "📨"
+#   message_type(["image"]) # => "📸"
+#
+# @example Annotating content with thinking indicator
+#   think_annotate { "Thinking..." } # => "💭\nThinking...\n" (when think is enabled)
+#
+# @example Annotating content with talk indicator
+#   talk_annotate { "Speaking..." } # => "💬\nSpeaking...\n" (when think is enabled)
 module OllamaChat::MessageFormat
   # The message_type method determines the appropriate message icon based on
   # whether images are present.

data/lib/ollama_chat/message_list.rb

@@ -1,3 +1,33 @@
+# A collection class for managing chat messages with support for system
+# prompts, paged output, and conversation history.
+
+# This class provides functionality for storing, retrieving, and displaying
+# chat messages in a structured manner. It handles system prompts separately
+# from regular user and assistant messages, supports pagination for displaying
+# conversations, and offers methods for manipulating message history including
+# clearing, loading, saving, and dropping exchanges. The class integrates with
+# Kramdown::ANSI for formatted output and supports location information in
+# system messages.
+
+# @example Creating a new message list
+#   chat = OllamaChat::Chat.new
+#   messages = OllamaChat::MessageList.new(chat)
+#
+# @example Adding messages to the list
+#   messages << Ollama::Message.new(role: 'user', content: 'Hello')
+#   messages << Ollama::Message.new(role: 'assistant', content: 'Hi there!')
+#
+# @example Displaying conversation history
+#   messages.list_conversation(5)  # Shows last 5 exchanges
+#
+# @example Clearing messages
+#   messages.clear  # Removes all non-system messages
+#
+# @example Loading a saved conversation
+#   messages.load_conversation('conversation.json')
+#
+# @example Saving current conversation
+#   messages.save_conversation('my_conversation.json')
 class OllamaChat::MessageList
   include Term::ANSIColor
   include OllamaChat::MessageFormat
@@ -11,8 +41,20 @@ class OllamaChat::MessageList
     @messages = []
   end
 
+  # The system attribute reader returns the system prompt for the chat session.
+  #
+  # @attr_reader [ String, nil ] the current system prompt content or nil if not set
   attr_reader :system
 
+  # The messages attribute reader returns the messages set for this object,
+  # initializing it lazily if needed.
+  #
+  # The messages set is memoized, meaning it will only be created once per
+  # object instance and subsequent calls will return the same
+  # OllamaChat::MessageList instance.
+  #
+  # @attr_reader [OllamaChat::MessageList] A MessageList object containing all
+  # messages associated with this instance
   attr_reader :messages
 
   # Returns the number of messages stored in the message list.
@@ -111,11 +153,15 @@ class OllamaChat::MessageList
   # from the user. It uses a pager for output and returns the instance itself.
   #
   # @return [ OllamaChat::MessageList ] returns the instance of the class
-  def show_last
-    message = last
-    !message || message.role == 'user' and return
+  def show_last(n = nil)
+    n ||= 1
+    messages = @messages.reject { |message| message.role == 'user' }
+    n = n.clamp(0..messages.size)
+    n <= 0 and return
     use_pager do |output|
-      output.puts message_text_for(message)
+      messages[-n..-1].to_a.each do |message|
+        output.puts message_text_for(message)
+      end
     end
     self
   end
@@ -277,7 +323,8 @@ class OllamaChat::MessageList
   # If the output would exceed the terminal's line capacity, it pipes the content
   # through an appropriate pager command (like 'less' or 'more').
   #
-  # @param block [Proc] A block that yields an IO object to write output to
+  # @yield A block that yields an IO object to write output to
+  # @yieldparam [IO] the IO object to write to
   def use_pager
     command       = determine_pager_command
     output_buffer = StringIO.new

data/lib/ollama_chat/message_output.rb

@@ -1,3 +1,15 @@
+# A module that provides output functionality for chat messages.
+#
+# This module encapsulates methods for piping assistant responses to command
+# standard input and writing assistant responses to files. It handles the
+# mechanics of sending output to external processes or saving content to disk
+# while providing appropriate error handling and user feedback.
+#
+# @example Piping a response to a command
+#   chat.pipe('cat > output.txt')
+#
+# @example Writing a response to a file
+#   chat.output('response.txt')
 module OllamaChat::MessageOutput
   # The pipe method forwards the last assistant message to a command's standard
   # input.

data/lib/ollama_chat/model_handling.rb

@@ -1,3 +1,20 @@
+# A module that provides functionality for managing Ollama models, including
+# checking model availability, pulling models from remote servers, and handling
+# model presence verification.
+#
+# This module encapsulates the logic for interacting with Ollama models,
+# ensuring that required models are available locally before attempting to use
+# them in chat sessions. It handles both local model verification and remote
+# model retrieval when necessary.
+#
+# @example Checking if a model is present
+#   chat.model_present?('llama3.1')
+#
+# @example Pulling a model from a remote server
+#   chat.pull_model_from_remote('mistral')
+#
+# @example Ensuring a model is available locally
+#   chat.pull_model_unless_present('phi3', {})
 module OllamaChat::ModelHandling
   # The model_present? method checks if the specified Ollama model is available.
   #

data/lib/ollama_chat/ollama_chat_config.rb

@@ -1,12 +1,31 @@
 require 'pathname'
 
+# A configuration class for managing OllamaChat settings and file paths.
+#
+# This class handles the initialization and management of configuration files
+# for the OllamaChat application. It provides methods for setting up default
+# configurations, determining appropriate file paths for config and cache
+# directories, and managing the loading and creation of configuration files
+# based on XDG standards.
+#
+# @example Initializing with a custom configuration file
+#   config = OllamaChat::OllamaChatConfig.new('/path/to/custom/config.yml')
+#
+# @example Accessing default configuration paths
+#   config = OllamaChat::OllamaChatConfig.new
+#   config.default_config_path # => Path to the default configuration file
+#   config.config_dir_path     # => Path to the configuration directory
+#   config.cache_dir_path      # => Path to the cache directory
+#   config.database_path       # => Path to the documents database file
 class OllamaChat::OllamaChatConfig
   include ComplexConfig
   include FileUtils
 
+  # Path to the default config
   DEFAULT_CONFIG_PATH = Pathname.new(__FILE__).dirname.
     join('ollama_chat_config/default_config.yml')
 
+  # Content of the default config
   DEFAULT_CONFIG = File.read(DEFAULT_CONFIG_PATH)
 
   # The initialize method sets up the configuration file path and ensures the

data/lib/ollama_chat/parsing.rb

@@ -1,3 +1,16 @@
+# A module that provides content parsing functionality for OllamaChat.
+#
+# The Parsing module encapsulates methods for processing various types of input
+# sources including HTML, XML, CSV, RSS, Atom, PDF, and Postscript documents.
+# It handles content extraction and conversion into standardized text formats
+# suitable for chat interactions. The module supports different document
+# policies for handling imported or embedded content and provides utilities for
+# parsing structured data from multiple source types.
+#
+# @example Processing different document types
+#   chat.parse_source(html_io)    # Converts HTML to markdown
+#   chat.parse_source(pdf_io)     # Extracts text from PDF files
+#   chat.parse_source(csv_io)     # Formats CSV data into readable strings
 module OllamaChat::Parsing
   # The parse_source method processes different types of input sources and
   # converts them into a standardized text representation.

data/lib/ollama_chat/server_socket.rb

@@ -1,3 +1,25 @@
+# A module that provides server socket functionality for OllamaChat
+#
+# The ServerSocket module encapsulates the logic for creating and managing Unix
+# domain socket servers that enable external processes to send input to running
+# ollama_chat sessions. It supports both simple message transmission and
+# bidirectional communication with response handling, allowing for integration
+# with tools like ollama_chat_send.
+#
+# @example Sending a message to a running chat session
+#   OllamaChat::ServerSocket.send_to_server_socket(
+#     "Hello from external process",
+#     config: chat_config,
+#     type: :socket_input
+#   )
+#
+# @example Sending a message and waiting for a response
+#   response = OllamaChat::ServerSocket.send_to_server_socket(
+#     "What is the answer?",
+#     config: chat_config,
+#     type: :socket_input_with_response,
+#     parse: true
+#   )
 module OllamaChat::ServerSocket
   class << self
     # The send_to_server_socket method transmits a message to a Unix domain
@@ -56,6 +78,11 @@ module OllamaChat::ServerSocket
     end
   end
 
+  # The server_socket_message accessor method provides read and write access to
+  # the server socket message instance variable.
+  #
+  # @return [ Object, nil ] the current server socket message object or nil if
+  # not set
   attr_accessor :server_socket_message
 
   # Initializes the server socket to receive messages from the Ollama Chat

data/lib/ollama_chat/source_fetching.rb

@@ -1,3 +1,28 @@
+# A module that provides functionality for fetching and processing various
+# types of content sources.
+#
+# The SourceFetching module encapsulates methods for retrieving content from
+# different source types including URLs, file paths, and shell commands. It
+# handles the logic for determining the appropriate fetching method based on
+# the source identifier and processes the retrieved content through specialized
+# parsers depending on the content type. The module also manages image
+# handling, document importing, summarizing, and embedding operations while
+# providing error handling and debugging capabilities.
+#
+# @example Fetching content from a URL
+#   chat.fetch_source('https://example.com/document.html') do |source_io|
+#     # Process the fetched content
+#   end
+#
+# @example Importing a local file
+#   chat.fetch_source('/path/to/local/file.txt') do |source_io|
+#     # Process the imported file content
+#   end
+#
+# @example Executing a shell command
+#   chat.fetch_source('!ls -la') do |source_io|
+#     # Process the command output
+#   end
 module OllamaChat::SourceFetching
   # The http_options method prepares HTTP options for requests based on
   # configuration settings.