ollama_chat 0.0.56 → 0.0.58

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 683c0bf5fdb8756030c0c5b69767d95f8ae852094a0048cb61b4cf7166f6a045
-  data.tar.gz: 8e7f9022cfd1e9c32f987b76196222d346100cd5ceaa6d59e6dc5c30257e5dbb
+  metadata.gz: e977681ee5ceb8267b4c2d9f2ad7f9c22ac168791a14cf12a6ae5d8696d58c24
+  data.tar.gz: f5277d49ba8ccd5af55f83e742dfcb5b9818395151478547f183873669024d09
 SHA512:
-  metadata.gz: 854af0ea07ced05e3f2f36741dd98592a2f6968e3307662e10c14bcb9a10b2168a1dde962de32f44e73719d177547cbccd8eee76c0554878a0de7ce2e1811772
-  data.tar.gz: 86b71f7b0748be19d0f772213b1a21ea8c7f838296bcd48348076ef39372e0a0f07db20c59a1c1b56f8a7592d100993a7ffa6b6507b4febbbca2977f0375baff
+  metadata.gz: c39142b8c05b16591d285f66d80dbbda12e20058a8fb5b533e219c029bc08e66ade15e5c87a90228a9598929f0444e71b1fdf6cfe18abb4426a423f177716086
+  data.tar.gz: 734d78b497080fce515f6fa326396cb031f0540b18d565cdd324eeb4f1d16010840afd1177c55ac0cf24f7dc49b7101d108d17cf499de5d75b1daf54559ef7a3

data/CHANGES.md

@@ -1,5 +1,51 @@
 # Changes
 
+## 2026-02-02 v0.0.58
+
+- Updated Redis image to version to valkey **9.0.1** in docker-compose.yml
+- Added `errors.lst` to `.gitignore` and updated packaging to ignore this file
+- Added `utils` gem as a development dependency in `Rakefile` and
+  `ollama_chat.gemspec`
+- Enhanced documentation consistency with standardized leading spaces for doc
+  comment continuation lines
+    - Standardized parameter and return value descriptions for methods to align
+      with YARD documentation standards
+    - Ensured all method signatures and descriptions comply with YARD documentation
+      standards
+
+## 2026-01-21 v0.0.57
+
+- Introduce `OllamaChat::StateSelectors` module with `StateSelector` class for
+  managing configurable states
+- Replace simple string-based document policy and think mode with
+  `StateSelector` objects
+- Add `allow_empty` parameter to `StateSelector#initialize` method to allow
+  empty states in voice output
+- Update `StateSelector#selected=` to conditionally validate states based on
+  `allow_empty?`
+- Refactor voice handling to use `StateSelector` by replacing `@current_voice`
+  with `@voices` `StateSelector`
+- Update `FollowChat` to use `@voices.selected` instead of `@current_voice` for
+  voice selection
+- Simplify `change_voice` method in `dialog.rb` to delegate to `@voices.choose`
+- Update voice display in `information.rb` to use `@voices.show` instead of raw
+  voice name
+- Update configuration format to support nested `think` settings with `mode`
+  and `loud` sub-properties
+- Modify command handlers to use `document_policy.choose` and
+  `think_mode.choose` instead of legacy methods
+- Update `OllamaChat::Chat` initialization to use `setup_state_selectors`
+  method
+- Refactor `OllamaChat::ThinkControl` to use new state selector system
+- Update `OllamaChat::Parsing` to reference `@document_policy.selected` instead
+  of `@document_policy`
+- Update default configuration file to use format with nested think settings
+- Add proper `attr_reader` for `document_policy` and `think_mode` state
+  selectors
+- Update help text to reference new state selector system
+- Update `OllamaChat::Switches` to handle nested think configuration
+- Add `OllamaChat::StateSelectors` to required files in `lib/ollama_chat.rb`
+
 ## 2026-01-17 v0.0.56
 
 - Updated `context_spook` dependency from version **1.4** to **1.5**

data/Rakefile

@@ -22,7 +22,7 @@ GemHadar do
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.AppleDouble', '.bundle',
     '.yardoc', 'doc', 'tags', 'corpus', 'coverage', '/config/searxng/*',
-    '.starscope.db', 'cscope.out'
+    '.starscope.db', 'cscope.out', 'errors.lst'
   package_ignore '.all_images.yml', '.tool-versions', '.gitignore', 'VERSION',
     '.rspec', '.github', '.contexts', '.envrc', '.yardopts'
 
@@ -66,6 +66,7 @@ GemHadar do
   development_dependency 'debug'
   development_dependency 'simplecov'
   development_dependency 'context_spook'
+  development_dependency 'utils'
 
   licenses << 'MIT'
   

data/docker-compose.yml

@@ -1,7 +1,7 @@
 services:
   redis:
     container_name: redis
-    image: valkey/valkey:8.1.5-alpine
+    image: valkey/valkey:9.0.1-alpine
     restart: unless-stopped
     ports: [ "127.0.0.1:9736:6379" ]
     volumes:

data/lib/ollama_chat/chat.rb

@@ -36,6 +36,7 @@ class OllamaChat::Chat
   include Term::ANSIColor
   include OllamaChat::DocumentCache
   include OllamaChat::Switches
+  include OllamaChat::StateSelectors
   include OllamaChat::ModelHandling
   include OllamaChat::Parsing
   include OllamaChat::SourceFetching
@@ -78,7 +79,7 @@ class OllamaChat::Chat
   #
   # @param argv [Array<String>] Command-line arguments to parse (defaults to ARGV.dup)
   #
-  # @raise [ArgumentError] If the Ollama API version is less than 0.9.0, indicating
+  # @raise [RuntimeError] If the Ollama API version is less than 0.9.0, indicating
   #   incompatibility with required API features
   def initialize(argv: ARGV.dup)
     @opts               = go 'f:u:m:s:c:C:D:MESVh', argv
@@ -88,14 +89,10 @@ class OllamaChat::Chat
     @ollama_chat_config = OllamaChat::OllamaChatConfig.new(@opts[?f])
     self.config         = @ollama_chat_config.config
     setup_switches(config)
-    @ollama = connect_ollama
-    if server_version.version < '0.9.0'.version
-      raise ArgumentError, 'require ollama API version 0.9.0 or higher'
-    end
-    @document_policy = config.document_policy
+    setup_state_selectors(config)
+    connect_ollama
     @model           = choose_model(@opts[?m], config.model.name)
     @model_options   = Ollama::Options[config.model.options]
-    @think           = config.think
     model_system     = pull_model_unless_present(@model, @model_options)
     embedding_enabled.set(config.embedding.enabled && !@opts[?E])
     if @opts[?c]
@@ -111,7 +108,6 @@ class OllamaChat::Chat
     end
     @documents            = setup_documents
     @cache                = setup_cache
-    @current_voice        = config.voice.default
     @images               = []
     @kramdown_ansi_styles = configure_kramdown_ansi_styles
     init_chat_history
@@ -120,6 +116,18 @@ class OllamaChat::Chat
     fix_config(e)
   end
 
+  # The document_policy reader returns the document policy selector for the chat session.
+  #
+  # @return [ OllamaChat::StateSelector ] the document policy selector object
+  #   that manages the policy for handling document references in user text
+  attr_reader :document_policy
+
+  # The think_mode reader returns the think mode selector for the chat session.
+  #
+  # @return [ OllamaChat::StateSelector ] the think mode selector object
+  #   that manages the thinking mode setting for the Ollama model interactions
+  attr_reader :think_mode
+
   # The debug method accesses the debug configuration setting.
   #
   # @return [TrueClass, FalseClass] the current debug mode status
@@ -207,7 +215,7 @@ class OllamaChat::Chat
     case content
     when %r(^/reconnect)
       STDERR.print green { "Reconnecting to ollama #{base_url.to_s.inspect}…" }
-      @ollama = connect_ollama
+      connect_ollama
       STDERR.puts green { " Done." }
       :next
     when %r(^/copy$)
@@ -304,10 +312,10 @@ class OllamaChat::Chat
       info
       :next
     when %r(^/document_policy$)
-      choose_document_policy
+      document_policy.choose
       :next
     when %r(^/think$)
-      choose_think_mode
+      think_mode.choose
       :next
     when %r(^/think_loud$)
       think_loud.toggle
@@ -385,9 +393,9 @@ class OllamaChat::Chat
   # the specified number of URLs. The processing approach varies based on the current
   # document policy and embedding status:
   #
-  # - **Embedding mode**: When `@document_policy == 'embedding'` AND `@embedding.on?` is true,
+  # - **Embedding mode**: When `document_policy.selected == 'embedding'` AND `@embedding.on?` is true,
   #   each result is embedded and the query is interpolated into the `web_embed` prompt.
-  # - **Summarizing mode**: When `@document_policy == 'summarizing'`,
+  # - **Summarizing mode**: When `document_policy.selected == 'summarizing'`,
   #   each result is summarized and both query and results are interpolated into the
   #   `web_summarize` prompt.
   # - **Importing mode**: For all other cases, each result is imported and both query and
@@ -403,11 +411,11 @@ class OllamaChat::Chat
   #   web('3', 'ruby programming tutorials')
   #
   # @example Web search with embedding policy
-  #   # With @document_policy == 'embedding' and @embedding.on?
+  #   # With document_policy.selected == 'embedding' and @embedding.on?
   #   # Processes results through embedding pipeline
   #
   # @example Web search with summarizing policy
-  #   # With @document_policy == 'summarizing'
+  #   # With document_policy.selected == 'summarizing'
   #   # Processes results through summarization pipeline
   #
   # @see #search_web
@@ -417,13 +425,13 @@ class OllamaChat::Chat
   # @see #summarize
   def web(count, query)
     urls = search_web(query, count.to_i) or return :next
-    if @document_policy == 'embedding' && @embedding.on?
+    if document_policy.selected == 'embedding' && @embedding.on?
       prompt = config.prompts.web_embed
       urls.each do |url|
         fetch_source(url) { |url_io| embed_source(url_io, url) }
       end
       prompt.named_placeholders_interpolate({query:})
-    elsif @document_policy == 'summarizing'
+    elsif document_policy.selected == 'summarizing'
       prompt = config.prompts.web_import
       results = urls.each_with_object('') do |url, content|
         summarize(url).full? do |c|
@@ -617,7 +625,7 @@ class OllamaChat::Chat
       handler = OllamaChat::FollowChat.new(
         chat:     self,
         messages:,
-        voice:    (@current_voice if voice.on?)
+        voice:    (@voices.selected if voice.on?)
       )
       begin
         retried = false
@@ -633,7 +641,7 @@ class OllamaChat::Chat
         if think? && !retried
           STDOUT.puts "#{bold('Error')}: in think mode, switch thinking off and retry."
           sleep 1
-          @think  = false
+          think_mode.selected  = 'disabled'
           retried = true
           retry
         else
@@ -677,12 +685,27 @@ class OllamaChat::Chat
 
   private
 
+  # The base_url method returns the Ollama server URL from command-line options
+  # or environment configuration.
+  #
+  # @return [String] the base URL used for connecting to the Ollama API
   def base_url
     @opts[?u] || OllamaChat::EnvConfig::OLLAMA::URL
   end
 
+  # The connect_ollama method establishes a connection to the Ollama API server.
+  #
+  # This method initializes a new Ollama::Client instance with configured timeouts
+  # and connection parameters, then verifies that the connected server meets
+  # the minimum required API version (0.9.0). It sets the @ollama instance
+  # variable to the configured client and stores the server version in @server_version.
+  #
+  # @return [Ollama::Client] the configured Ollama client instance
+  # @raise [RuntimeError] if the connected Ollama server API version is less
+  #   than 0.9.0
   def connect_ollama
-    Ollama::Client.new(
+    @server_version = nil
+    @ollama = Ollama::Client.new(
       connect_timeout: config.timeouts.connect_timeout?,
       read_timeout:    config.timeouts.read_timeout?,
       write_timeout:   config.timeouts.write_timeout?,
@@ -690,6 +713,10 @@ class OllamaChat::Chat
       debug:           ,
       user_agent:
     )
+    if server_version.version < '0.9.0'.version
+      raise 'require ollama API version 0.9.0 or higher'
+    end
+    @ollama
   end
 
   # The setup_documents method initializes the document processing pipeline by

data/lib/ollama_chat/clipboard.rb

@@ -13,10 +13,11 @@
 module OllamaChat::Clipboard
   # Copy the last assistant's message to the system clipboard.
   #
-  # This method checks if there is a last message from an assistant in the `@messages`
-  # array and copies its content to the clipboard using the specified command from `config.copy`.
-  # If no assistant response is available or the clipboard command is not found, appropriate
-  # error messages are displayed.
+  # This method checks if there is a last message from an assistant in the
+  # `@messages` array and copies its content to the clipboard using the
+  # specified command from `config.copy`.
+  # If no assistant response is available or the clipboard command is not
+  # found, appropriate error messages are displayed.
   #
   # @return [NilClass] Always returns nil.
   def copy_to_clipboard
@@ -38,9 +39,9 @@ module OllamaChat::Clipboard
 
   # Paste content from the input.
   #
-  # Prompts the user to paste their content and then press C-d (Ctrl+D) to terminate
-  # input. Reads all lines from standard input until Ctrl+D is pressed and returns
-  # the pasted content as a string.
+  # Prompts the user to paste their content and then press C-d (Ctrl+D) to
+  # terminate input. Reads all lines from standard input until Ctrl+D is
+  # pressed and returns the pasted content as a string.
   #
   # @return [String] The pasted content entered by the user.
   def paste_from_input

data/lib/ollama_chat/conversation.rb

@@ -19,7 +19,7 @@ module OllamaChat::Conversation
   # format.
   #
   # @param filename [String] The path to the file where the conversation should
-  # be saved
+  #   be saved
   #
   # @example Save conversation with explicit filename
   #   chat.save_conversation('conversations/2023-10-15_my_session.json')
@@ -43,7 +43,7 @@ module OllamaChat::Conversation
   # for confirmation.
   #
   # @param filename [String] The path to the file containing the conversation
-  # to load
+  #   to load
   #
   # @example Load a conversation from a specific file
   #   chat.load_conversation('conversations/2023-10-15_my_session.json')

data/lib/ollama_chat/dialog.rb

@@ -12,9 +12,6 @@
 #
 # @example Changing the system prompt
 #   chat.change_system_prompt('default_prompt', system: '?sherlock')
-#
-# @example Choosing a document policy
-#   chat.choose_document_policy
 module OllamaChat::Dialog
   # The model_with_size method formats a model's size for display
   # by creating a formatted string that includes the model name and its size
@@ -104,41 +101,6 @@ module OllamaChat::Dialog
     info
   end
 
-  # The document_policy method sets the policy for handling document imports.
-  #
-  # @param value [ String ] the document policy to be set
-  attr_writer :document_policy
-
-  # The choose_document_policy method presents a menu to select a document policy.
-  # It allows the user to choose from importing, embedding, summarizing, or
-  # ignoring documents.
-  # The method displays available policies and sets the selected policy as the
-  # current document policy.
-  # If no valid policy is found, it defaults to the first option.
-  # After selection, it outputs the chosen policy and displays the current
-  # configuration information.
-  def choose_document_policy
-    policies = %w[ importing embedding summarizing ignoring ].sort
-    current  = if policies.index(@document_policy)
-                 @document_policy
-               elsif policies.index(config.document_policy)
-                 config.document_policy
-               else
-                 policies.first
-               end
-    policies.unshift('[EXIT]')
-    policy = OllamaChat::Utils::Chooser.choose(policies)
-    case policy
-    when nil, '[EXIT]'
-      STDOUT.puts "Exiting chooser."
-      policy = current
-    end
-    self.document_policy = policy
-  ensure
-    STDOUT.puts "Using document policy #{bold{@document_policy}}."
-    info
-  end
-
   # The change_system_prompt method allows the user to select or enter a new
   # system prompt for the chat session.
   # It provides an interactive chooser when multiple prompts match the given
@@ -147,7 +109,7 @@ module OllamaChat::Dialog
   #
   # @param default [ String ] the default system prompt to fall back to
   # @param system [ String ] the system prompt identifier or pattern to
-  # search for
+  #   search for
   def change_system_prompt(default, system: nil)
     selector = case system
                when /\A\?(.+)\z/
@@ -204,8 +166,7 @@ module OllamaChat::Dialog
   #
   # @return [ String ] the full name of the chosen voice
   def change_voice
-    chosen  = OllamaChat::Utils::Chooser.choose(config.voice.list)
-    @current_voice = chosen.full? || config.voice.default
+    @voices.choose
   end
 
   # The message_list method creates and returns a new MessageList instance

data/lib/ollama_chat/document_cache.rb

@@ -12,9 +12,9 @@ module OllamaChat::DocumentCache
   # configuration to dynamically load the appropriate cache implementation.
   #
   # @return [Class] The cache class referenced by the configuration's cache
-  # setting.
+  #   setting.
   # @raise [NameError] If the configured cache class name does not correspond
-  # to an existing constant.
+  #   to an existing constant.
   def document_cache_class
     Object.const_get(config.cache)
   end
@@ -22,17 +22,18 @@ module OllamaChat::DocumentCache
   # 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
+  # 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 for document storage and
-  # retrieval.
+  #   retrieval.
   # @raise [StandardError] If there is an error resolving the configured cache
-  # class, logs the error to standard error and falls back to MemoryCache.
+  #   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/env_config.rb

@@ -2,6 +2,15 @@ require 'const_conf'
 require 'pathname'
 
 module OllamaChat
+  # Environment configuration module for OllamaChat
+  #
+  # This module provides a structured way to manage environment variables and
+  # configuration settings for the OllamaChat application. It uses the
+  # ConstConf library to define and manage configuration parameters with
+  # default values, descriptions, and decoding logic.
+  #
+  # The module organizes configuration into logical sections including general
+  # settings, Ollama-specific configurations, and chat-specific options.
   module EnvConfig
     include ConstConf
 

data/lib/ollama_chat/follow_chat.rb

@@ -19,12 +19,12 @@ class OllamaChat::FollowChat
   # Initializes a new instance of OllamaChat::FollowChat.
   #
   # @param [OllamaChat::Chat] chat The chat object, which represents the
-  # conversation context.
+  #   conversation context.
   # @param [#to_a] messages A collection of message objects, representing the
-  # conversation history.
+  #   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.
+  #   should be printed. Defaults to STDOUT.
   #
   # @return [OllamaChat::FollowChat] A new instance of OllamaChat::FollowChat.
   def initialize(chat:, messages:, voice: nil, output: STDOUT)
@@ -39,7 +39,7 @@ class OllamaChat::FollowChat
   # Returns the conversation history (an array of message objects).
   #
   # @return [OllamaChat::MessageList<Ollama::Message>] The array of messages in
-  # the conversation.
+  #   the conversation.
   attr_reader :messages
 
   # Invokes the chat flow based on the provided Ollama server response.
@@ -59,7 +59,7 @@ class OllamaChat::FollowChat
   # outputs evaluation statistics (if applicable).
   #
   # @param [Ollama::Response] response The parsed JSON response from the Ollama
-  # server.
+  #   server.
   #
   # @return [OllamaChat::FollowChat] The current instance for method chaining.
   def call(response)
@@ -128,7 +128,7 @@ class OllamaChat::FollowChat
   # last message if thinking is enabled and thinking content is present.
   #
   # @param response [ Object ] the response object containing message content
-  # and thinking
+  #   and thinking
   def update_last_message(response)
     @messages.last.content << response.message&.content
     if @chat.think_loud? and response_thinking = response.message&.thinking.full?
@@ -212,8 +212,8 @@ class OllamaChat::FollowChat
   # @param response [ Object ] the response object containing evaluation metrics
   #
   # @return [ String ] a formatted string with statistical information about
-  # the evaluation process including durations, counts, and rates, styled with
-  # colors and formatting
+  #   the evaluation process including durations, counts, and rates, styled
+  #   with colors and formatting
   def eval_stats(response)
     eval_duration        = response.eval_duration / 1e9
     prompt_eval_duration = response.prompt_eval_duration / 1e9

data/lib/ollama_chat/history.rb

@@ -24,7 +24,7 @@ module OllamaChat::History
   # 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
+  #   specified in the configuration
   def chat_history_filename
     File.expand_path(OllamaChat::EnvConfig::OLLAMA::CHAT::HISTORY)
   end

data/lib/ollama_chat/information.rb

@@ -80,7 +80,7 @@ module OllamaChat::Information
   # configurations, embedding settings, and various operational switches.
   #
   # @return [ nil ] This method does not return a value; it outputs information
-  # directly to standard output.
+  #   directly to standard output.
   def info
     STDOUT.puts "Running ollama_chat version: #{bold(OllamaChat::VERSION)}"
     STDOUT.puts "Connected to ollama server version: #{bold(server_version)} on: #{bold(server_url)}"
@@ -99,15 +99,13 @@ module OllamaChat::Information
     end
     markdown.show
     stream.show
-    think_show
+    think_mode.show
     think_loud.show
     location.show
     voice.show
-    if @voice.on?
-      STDOUT.puts "  Using voice #{bold{@current_voice}} to speak."
-    end
+    @voice.on? and @voices.show
     STDOUT.puts "Documents database cache is #{@documents.nil? ? 'n/a' : bold{@documents.cache.class}}"
-    STDOUT.puts "Document policy for references in user text: #{bold{@document_policy}}"
+    STDOUT.puts "Document policy for references in user text: #{bold{document_policy}}"
     STDOUT.puts "Currently selected search engine is #{bold(search_engine)}."
     STDOUT.puts "Conversation length: #{bold(@messages.size.to_s)} message(s)."
     nil
@@ -144,7 +142,7 @@ module OllamaChat::Information
       /summarize [n] source           summarize the source's content in n words
       /embedding                      toggle embedding paused or not
       /embed source                   embed the source's content
-      /web [n] query                  query web & for n(=1) results (policy: #@document_policy)
+      /web [n] query                  query web & for n(=1) results (policy: #{document_policy})
       /links [clear]                  display (or clear) links used in the chat
       /save filename                  store conversation messages
       /load filename                  load conversation messages

data/lib/ollama_chat/kramdown_ansi.rb

@@ -16,7 +16,7 @@ module OllamaChat::KramdownANSI
   # falling back to default styles.
   #
   # @return [ Hash ] a hash of ANSI styles configured either from environment
-  # variables or using default settings
+  #   variables or using default settings
   def configure_kramdown_ansi_styles
     if json = OllamaChat::EnvConfig::KRAMDOWN_ANSI_OLLAMA_CHAT_STYLES?
       Kramdown::ANSI::Styles.from_json(json).ansi_styles
@@ -37,7 +37,7 @@ module OllamaChat::KramdownANSI
   #   If nil, returns an empty string.
   #
   # @return [ String ] the content formatted with ANSI escape sequences
-  # according to the configured styles
+  #   according to the configured styles
   def kramdown_ansi_parse(content)
     content.nil? and return ''
     Kramdown::ANSI.parse(content, ansi_styles: @kramdown_ansi_styles)

data/lib/ollama_chat/message_list.rb

@@ -35,7 +35,7 @@ class OllamaChat::MessageList
   # The initialize method sets up the message list for an OllamaChat session.
   #
   # @param chat [ OllamaChat::Chat ] the chat object that this message list
-  # belongs to
+  #   belongs to
   def initialize(chat)
     @chat     = chat
     @messages = []
@@ -54,7 +54,7 @@ class OllamaChat::MessageList
   # OllamaChat::MessageList instance.
   #
   # @attr_reader [OllamaChat::MessageList] A MessageList object containing all
-  # messages associated with this instance
+  #   messages associated with this instance
   attr_reader :messages
 
   # Returns the number of messages stored in the message list.
@@ -202,9 +202,11 @@ class OllamaChat::MessageList
 
   # Sets the system prompt for the chat session.
   #
-  # @param system [String, nil] The new system prompt. If `nil` or `false`, clears the system prompt.
+  # @param system [String, nil] The new system prompt. If `nil` or `false`,
+  #   clears the system prompt.
   #
-  # @return [OllamaChat::MessageList] Returns `self` to allow chaining of method calls.
+  # @return [OllamaChat::MessageList] Returns `self` to allow chaining of
+  #   method calls.
   #
   # @note This method:
   #   - Removes all existing system prompts from the message list
@@ -252,7 +254,7 @@ class OllamaChat::MessageList
   # curent location, time, and unit preferences.
   #
   # @return [Array] An array of Ollama::Message objects representing the
-  # messages in the list.
+  #   messages in the list.
   def to_ary
     location = at_location.full?
     add_system = !!location

data/lib/ollama_chat/message_output.rb

@@ -18,7 +18,7 @@ module OllamaChat::MessageOutput
   #
   # @return [ OllamaChat::Chat ] returns self
   # @return [ nil ] returns nil if the command is not provided or if there is
-  # no assistant message
+  #   no assistant message
   def pipe(cmd)
     cmd.present? or return
     if message = @messages.last and message.role == 'assistant'
@@ -44,7 +44,7 @@ module OllamaChat::MessageOutput
   # The output method writes the last assistant message to a file.
   #
   # @param filename [ String ] the path to the file where the last assistant
-  # message should be written
+  #   message should be written
   #
   # @return [ OllamaChat::Chat ] returns self
   def output(filename)
@@ -72,11 +72,14 @@ module OllamaChat::MessageOutput
   # doesn't exist, the method returns early without writing. Otherwise, it
   # opens the file in write mode and writes the message content to it.
   #
-  # @param filename [ String ] the path to the file where the content should be written
-  # @param message [ Ollama::Message ] the message object containing the content to write
+  # @param filename [ String ] the path to the file where the content should be
+  #   written
+  # @param message [ Ollama::Message ] the message object containing the
+  #   content to write
   #
   # @return [ TrueClass ] returns true if the file was successfully written
-  # @return [ nil ] returns nil if the user chose not to overwrite or if an error occurred
+  # @return [ nil ] returns nil if the user chose not to overwrite or if an
+  #   error occurred
   def attempt_to_write_file(filename, message)
     path = Pathname.new(filename.to_s).expand_path
     if !path.exist? ||

data/lib/ollama_chat/model_handling.rb

@@ -21,7 +21,7 @@ module OllamaChat::ModelHandling
   # @param model [ String ] the name of the Ollama model
   #
   # @return [ String, FalseClass ] the system prompt if the model is present,
-  # false otherwise
+  #   false otherwise
   def model_present?(model)
     ollama.show(model:) { return _1.system.to_s }
   rescue Ollama::Errors::NotFoundError
@@ -32,8 +32,6 @@ module OllamaChat::ModelHandling
   # remote server if it is not found locally.
   #
   # @param model [ String ] the name of the model to be pulled
-  #
-  # @return [ nil ]
   def pull_model_from_remote(model)
     STDOUT.puts "Model #{bold{model}} not found locally, attempting to pull it from remote now…"
     ollama.pull(model:)
@@ -54,7 +52,7 @@ module OllamaChat::ModelHandling
   # @param options [ Hash ] Options for the pull_model_from_remote method.
   #
   # @return [ String, FalseClass ] the system prompt if the model and it are
-  # present, false otherwise.
+  #   present, false otherwise.
   def pull_model_unless_present(model, options)
     if system = model_present?(model)
       return system.full?