ollama_chat 0.0.57 → 0.0.58

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0812722ef6dcc9b968a058ad3e4d96a8944ba61aaf347e39b064881e67704c3c'
-  data.tar.gz: 03ceba63e04403a982eac23c0a1d5bbf9ff50512f83a721a2def8c5ed8ebec46
+  metadata.gz: e977681ee5ceb8267b4c2d9f2ad7f9c22ac168791a14cf12a6ae5d8696d58c24
+  data.tar.gz: f5277d49ba8ccd5af55f83e742dfcb5b9818395151478547f183873669024d09
 SHA512:
-  metadata.gz: 14949a812f2040b5f4ec0fb767abcb8e41e8ff2f64af2502cc9278d8245f9794e1d7f9bcab0b1b99214c80aa135b1c9b68551a5d208356fa521f3fb36bb8e7f3
-  data.tar.gz: 44a2dfcccaa933286b5c0a0a93d6916e4bfd8e2af516d16d3524b4c26ffb76a59fd50557aef8262416fd00e7cb88e12d73fab653a6fda3c470f23f9be937d767
+  metadata.gz: c39142b8c05b16591d285f66d80dbbda12e20058a8fb5b533e219c029bc08e66ade15e5c87a90228a9598929f0444e71b1fdf6cfe18abb4426a423f177716086
+  data.tar.gz: 734d78b497080fce515f6fa326396cb031f0540b18d565cdd324eeb4f1d16010840afd1177c55ac0cf24f7dc49b7101d108d17cf499de5d75b1daf54559ef7a3

data/CHANGES.md

@@ -1,5 +1,18 @@
 # 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

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

@@ -79,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
@@ -90,10 +90,7 @@ class OllamaChat::Chat
     self.config         = @ollama_chat_config.config
     setup_switches(config)
     setup_state_selectors(config)
-    @ollama = connect_ollama
-    if server_version.version < '0.9.0'.version
-      raise ArgumentError, 'require ollama API version 0.9.0 or higher'
-    end
+    connect_ollama
     @model           = choose_model(@opts[?m], config.model.name)
     @model_options   = Ollama::Options[config.model.options]
     model_system     = pull_model_unless_present(@model, @model_options)
@@ -218,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$)
@@ -688,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?,
@@ -701,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

@@ -109,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/

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/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)}"

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?

data/lib/ollama_chat/ollama_chat_config.rb

@@ -75,7 +75,7 @@ class OllamaChat::OllamaChatConfig
   # configuration file.
   #
   # @return [ Pathname ] a Pathname object representing the path to the
-  # config.yml file within the configuration directory
+  #   config.yml file within the configuration directory
   def default_path
     config_dir_path + 'config.yml'
   end
@@ -85,7 +85,7 @@ class OllamaChat::OllamaChatConfig
   # 'ollama_chat' subdirectory.
   #
   # @return [ Pathname ] the pathname object representing the configuration
-  # directory
+  #   directory
   def config_dir_path
     OllamaChat::EnvConfig::XDG_CONFIG_HOME
   end

data/lib/ollama_chat/parsing.rb

@@ -18,7 +18,7 @@ module OllamaChat::Parsing
   # @param source_io [IO] the input source to be parsed
   #
   # @return [ String, nil ] the parsed content as a string or nil if the
-  # content type is not supported
+  #   content type is not supported
   def parse_source(source_io)
     case source_io&.content_type
     when 'text/html'
@@ -79,7 +79,7 @@ module OllamaChat::Parsing
   # @param source_io [IO] the input stream containing the RSS feed data
   #
   # @return [String] a formatted string representation of the RSS feed with
-  # channel title and item details
+  #   channel title and item details
   def parse_rss(source_io)
     feed = RSS::Parser.parse(source_io, false, false)
     title = <<~EOT
@@ -109,7 +109,7 @@ module OllamaChat::Parsing
   # @param source_io [IO] the input stream containing the Atom feed data
   #
   # @return [String] a formatted string representation of the Atom feed with
-  # title, items, links, update dates, and content
+  #   title, items, links, update dates, and content
   def parse_atom(source_io)
     feed = RSS::Parser.parse(source_io, false, false)
     title = <<~EOT
@@ -147,7 +147,8 @@ module OllamaChat::Parsing
   # If Ghostscript is not available in the system path, it outputs an error message.
   #
   # @param io [IO] An IO object containing PDF data to be processed
-  # @return [String, nil] The processed PDF content as a string, or nil if processing fails
+  # @return [String, nil] The processed PDF content as a string, or nil if
+  #   processing fails
   def ps_read(io)
     gs = `which gs`.chomp
     if gs.present?

data/lib/ollama_chat/server_socket.rb

@@ -43,7 +43,7 @@ module OllamaChat::ServerSocket
     # @param parse [ TrueClass, FalseClass ] whether to parse the response, defaults to false
     #
     # @return [ UnixSocks::Message, nil ] the response from transmit_with_response if type
-    # is :socket_input_with_response, otherwise nil
+    #   is :socket_input_with_response, otherwise nil
     def send_to_server_socket(content, config:, type: :socket_input, runtime_dir: nil, working_dir: nil, parse: false)
       server  = create_socket_server(config:, runtime_dir:, working_dir:)
       message = { content:, type:, parse: }
@@ -66,12 +66,12 @@ module OllamaChat::ServerSocket
     # for Unix domain sockets.
     #
     # @param config [ComplexConfig::Settings] the configuration object
-    # containing server settings
+    #   containing server settings
     # @param runtime_dir [ String ] pathname to runtime_dir of socket file
     # @param working_dir [ String ] pathname to working_dir used for deriving socket file
     #
     # @return [UnixSocks::DomainSocketServer] a configured Unix domain socket server
-    # instance ready to receive messages
+    #   instance ready to receive messages
     def create_socket_server(config:, runtime_dir: nil, working_dir: nil)
       working_dir ||= Dir.pwd
       if runtime_dir
@@ -91,7 +91,7 @@ module OllamaChat::ServerSocket
   # the server socket message instance variable.
   #
   # @return [ Object, nil ] the current server socket message object or nil if
-  # not set
+  #   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

@@ -32,7 +32,7 @@ module OllamaChat::SourceFetching
   # @param url [ String ] the URL for which HTTP options are being prepared
   #
   # @return [ Hash ] a hash containing HTTP options such as ssl_verify_peer and
-  # proxy settings
+  #   proxy settings
   def http_options(url)
     options = {}
     if ssl_no_verify = config.ssl_no_verify?
@@ -49,7 +49,8 @@ module OllamaChat::SourceFetching
   # including commands, URLs, and file paths. It processes the source based on
   # its type and yields a temporary file handle for further processing.
   #
-  # @param source [ String ] the source identifier which can be a command, URL, or file path
+  # @param source [ String ] the source identifier which can be a command, URL,
+  #   or file path
   #
   # @yield [ tmp ]
   def fetch_source(source, check_exist: false, &block)
@@ -135,7 +136,7 @@ module OllamaChat::SourceFetching
   # @param source [ String ] the source identifier or path
   #
   # @return [ String ] a formatted message indicating the import result and the
-  # parsed content
+  #   parsed content
   def import_source(source_io, source)
     source        = source.to_s
     document_type = source_io&.content_type.full? { |ct| italic { ct } + ' ' }
@@ -150,7 +151,7 @@ module OllamaChat::SourceFetching
   # passes the resulting IO object to the import_source method for processing.
   #
   # @param source [String] The source identifier which can be a command, URL,
-  # or file path
+  #   or file path
   #
   # @return [String, nil] A formatted message indicating the import result and
   #                       parsed content, #   or nil if the operation fails
@@ -208,7 +209,7 @@ module OllamaChat::SourceFetching
   # @param count [Integer, nil] An optional counter for tracking processing order
   #
   # @return [Array, String, nil] The embedded chunks or processed content, or
-  # nil if embedding is disabled or fails
+  #   nil if embedding is disabled or fails
   def embed_source(source_io, source, count: nil)
     @embedding.on? or return parse_source(source_io)
     m = "Embedding #{italic { source_io&.content_type }} document #{source.to_s.inspect}."
@@ -263,10 +264,10 @@ module OllamaChat::SourceFetching
   # disabled, it falls back to generating a summary instead.
   #
   # @param source [String] The source identifier which can be a command, URL,
-  # or file path
+  #   or file path
   #
   # @return [String, nil] The formatted embedding result or summary message, or
-  # nil if the operation fails
+  #   nil if the operation fails
   def embed(source)
     if @embedding.on?
       STDOUT.puts "Now embedding #{source.to_s.inspect}."

data/lib/ollama_chat/state_selectors.rb

@@ -90,7 +90,7 @@ module OllamaChat::StateSelectors
     # or exiting the chooser if the user selects '[EXIT]' or cancels the selection.
     #
     # @return [ nil ] This method does not return a value; it updates the instance
-    # variable @selected based on user input.
+    #   variable @selected based on user input.
     def choose
       states = @states + [ '[EXIT]' ]
       case chosen = OllamaChat::Utils::Chooser.choose(states)

data/lib/ollama_chat/switches.rb

@@ -64,8 +64,6 @@ module OllamaChat::Switches
     #
     # @param msg [ Hash ] a hash containing true and false messages
     # @param value [ Object ] the default state of the switch
-    #
-    # @return [ void ]
     def initialize(msg:, value:)
       @value = !!value
       @msg   = msg
@@ -78,9 +76,9 @@ module OllamaChat::Switches
     # and optionally displays it.
     #
     # @param value [ Object ] the value to be converted to a boolean and
-    # assigned
+    #   assigned
     # @param show [ TrueClass, FalseClass ] determines whether to display the
-    # value after setting
+    #   value after setting
     def set(value, show: false)
       @value = !!value
       show && self.show
@@ -90,7 +88,7 @@ module OllamaChat::Switches
     # optionally displays it.
     #
     # @param show [ TrueClass, FalseClass ] determines whether to show the
-    # value after toggling
+    #   value after toggling
     def toggle(show: true)
       @value = !@value
       show && self.show
@@ -154,13 +152,13 @@ module OllamaChat::Switches
   # The embedding attribute reader returns the embedding switch object.
   #
   # @return [ OllamaChat::Switches::CombinedSwitch ] the embedding switch
-  # instance
+  #   instance
   attr_reader :embedding
 
   # The embedding_enabled reader returns the embedding enabled switch instance.
   #
   # @return [ OllamaChat::Switches::Switch ] the embedding enabled switch
-  # instance
+  #   instance
   attr_reader :embedding_enabled
 
   # The embedding_paused method returns the current state of the embedding pause flag.
@@ -181,7 +179,7 @@ module OllamaChat::Switches
   # output, voice output, embedding, and location settings.
   #
   # @param config [ ComplexConfig::Settings ] the configuration object
-  # containing settings for the switches
+  #   containing settings for the switches
   def setup_switches(config)
     @stream = Switch.new(
       value: config.stream,

data/lib/ollama_chat/utils/fetcher.rb

@@ -127,7 +127,7 @@ class OllamaChat::Utils::Fetcher
   #
   # @return [ nil ] returns nil if the file does not exist
   # @return [ Object ] returns the result of the block execution if the file
-  # exists
+  #   exists
   def self.read(filename, &block)
     if File.exist?(filename)
       File.open(filename) do |file|

data/lib/ollama_chat/version.rb

@@ -1,6 +1,6 @@
 module OllamaChat
   # OllamaChat version
-  VERSION         = '0.0.57'
+  VERSION         = '0.0.58'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/ollama_chat/web_searching.rb

@@ -21,7 +21,7 @@ module OllamaChat::WebSearching
   # @param n [ Integer ] the maximum number of results to return
   #
   # @return [ Array<String>, nil ] an array of URLs from the search results or
-  # nil if the search engine is not implemented
+  #   nil if the search engine is not implemented
   def search_web(query, n = nil)
     l     = @messages.at_location.full? and query += " #{l}"
     n     = n.to_i.clamp(1..)
@@ -70,10 +70,10 @@ module OllamaChat::WebSearching
   #
   # @param query [ String ] the search query string to be used
   # @param n [ Integer ] the maximum number of URLs to extract from the search
-  # results
+  #   results
   #
   # @return [ Array<String> ] an array of URL strings extracted from the search
-  # results
+  #   results
   def search_web_with_duckduckgo(query, n)
     url = config.web_search.engines.duckduckgo.url % { query: }
     OllamaChat::Utils::Fetcher.get(

data/ollama_chat.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama_chat 0.0.57 ruby lib
+# stub: ollama_chat 0.0.58 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama_chat".freeze
-  s.version = "0.0.57".freeze
+  s.version = "0.0.58".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<debug>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<context_spook>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<utils>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<excon>.freeze, ["~> 1.0".freeze])
   s.add_runtime_dependency(%q<ollama-ruby>.freeze, ["~> 1.18".freeze])
   s.add_runtime_dependency(%q<documentrix>.freeze, [">= 0.0.4".freeze])

data/spec/spec_helper.rb

@@ -58,7 +58,7 @@ module AssetHelpers
   # @yield [ io ] yields the IO object for the asset file to the provided block
   #
   # @return [ File, nil ] returns the IO object for the asset file, or nil if a
-  # block is provided and the block does not return a value
+  #   block is provided and the block does not return a value
   def asset_io(name, &block)
     io = File.new(File.join(__dir__, 'assets', name))
     if block
@@ -130,7 +130,7 @@ module ProtectEnvVars
   # during test execution.
   #
   # @return [Proc] a lambda that wraps test execution with environment variable
-  # preservation
+  #   preservation
   def self.apply
     -> example do
       if example.metadata[:protect_env]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama_chat
 version: !ruby/object:Gem::Version
-  version: 0.0.57
+  version: 0.0.58
 platform: ruby
 authors:
 - Florian Frank
@@ -121,6 +121,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement