ollama_chat 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56f1fbbeb7e84fe906636ac0e16d5223f4968a063ee73c862398bdd575b8409b
-  data.tar.gz: f9ffc5725d73ad54efbd55239c55a615f0cd630c682d293c11fa461b72be17d9
+  metadata.gz: f42ba971131695901f87aea1e9b7c99a41781a61acfae487e812c5c3f185aa01
+  data.tar.gz: b27f7e733b13c3f0023c189fc7be8ac9a1efab943ef562ad5c322e6ad085c7c6
 SHA512:
-  metadata.gz: b331c3ca96198b45e8cf6531a1e7e0f7542607a13512d516767180ae7a21c4cc6ba3eda280a24ee0472a9bf24a45a2acaba586f635dc8e1fe3f6e459b567f574
-  data.tar.gz: 0f2da5cc8c319d414d812af7067701567f463c8b9db6507f1cdb34eec880bb05204ddd1111a448bad289e8299858a59534315da2091287b5b033e0a85d28c7f1
+  metadata.gz: 393146c6eb88e53e056ef5b303076c0584cb8f28f32db4e37b44dd24a845bc86c2987239f31cbfd600906030af004f020e68e4a30491945be250704353b3a567
+  data.tar.gz: b9ab5d2f1ab4d9abf34da61e341304fcf0f1a7fd7fe5e14eb3819ea41f37e3394102b4990a71bf7abd6641b181ef1cf2e40d90fd47e5e3f5665ee081bfb32568

data/CHANGES.md

@@ -1,5 +1,17 @@
 # Changes
 
+## 2025-08-11 v0.0.20
+
+### Documentation
+
+- Added more YARD-style documentation to all public methods throughout the codebase.
+
+### Fixed
+
+- **Message Output**:
+  - Corrected `output(filename)` method to pass the message object to
+    `write_file_unless_exist` for proper content writing.
+
 ## 2025-08-11 v0.0.19
 
 * Added `/last` command to show last assistant message:

data/VERSION

@@ -1 +1 @@
-0.0.19
+0.0.20

data/lib/ollama_chat/clipboard.rb

@@ -1,5 +1,4 @@
 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`

data/lib/ollama_chat/dialog.rb

@@ -1,4 +1,12 @@
 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
+  # in a human-readable format with appropriate units.
+  #
+  # @param model [ Object ] the model object that has name and size attributes
+  #
+  # @return [ Object ] a result object with an overridden to_s method
+  #                     that combines the model name and formatted size
   private def model_with_size(model)
     result = model.name
     formatted_size = Term::ANSIColor.bold {
@@ -10,6 +18,13 @@ module OllamaChat::Dialog
     result
   end
 
+  # The choose_model method selects a model from the available list based on
+  # CLI input or user interaction.
+  # It processes the provided CLI model parameter to determine if a regex
+  # selector is used, filters the models accordingly, and prompts the user to
+  # choose from the filtered list if needed.
+  # The method ensures that a model is selected and displays a connection
+  # message with the chosen model and base URL.
   def choose_model(cli_model, current_model)
     selector = if cli_model =~ /\A\?+(.*)\z/
                  cli_model = ''
@@ -26,11 +41,23 @@ module OllamaChat::Dialog
     STDOUT.puts green { "Connecting to #{model}@#{ollama.base_url} now…" }
   end
 
+  # The ask? method prompts the user with a question and returns their input.
+  #
+  # @param prompt [ String ] the message to display to the user
+  #
+  # @return [ String ] the user's response with trailing newline removed
   def ask?(prompt:)
     print prompt
     STDIN.gets.chomp
   end
 
+  # The choose_collection method presents a menu to select or create a document
+  # collection. It displays existing collections along with options to create a
+  # new one or exit.
+  # The method prompts the user for input and updates the document collection
+  # accordingly.
+  #
+  # @param current_collection [ String, nil ] the name of the currently active collection
   def choose_collection(current_collection)
     collections = [ current_collection ] + @documents.collections
     collections = collections.compact.map(&:to_s).uniq.sort
@@ -49,8 +76,19 @@ 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)
@@ -73,6 +111,15 @@ module OllamaChat::Dialog
     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
+  # selector, and sets the selected prompt as the current system prompt for the
+  # messages.
+  #
+  # @param default [ String ] the default system prompt to fall back to
+  # @param system [ String ] the system prompt identifier or pattern to
+  # search for
   def change_system_prompt(default, system: nil)
     selector = if system =~ /\A\?(.+)\z/
                  Regexp.new($1)
@@ -103,6 +150,11 @@ module OllamaChat::Dialog
     @messages.set_system_prompt(system)
   end
 
+  # The choose_prompt method presents a menu of available prompts for selection.
+  # It retrieves the list of prompt attributes from the configuration,
+  # adds an '[EXIT]' option to the list, and displays it to the user.
+  # After the user makes a choice, the method either exits the chooser
+  # or applies the selected prompt configuration.
   def choose_prompt
     prompts = config.prompts.attribute_names.sort
     prompts.unshift('[EXIT]')
@@ -115,11 +167,20 @@ module OllamaChat::Dialog
     end
   end
 
+  # The change_voice method allows the user to select a voice from a list of
+  # available options. It uses the chooser to present the options and sets the
+  # selected voice as the current voice.
+  #
+  # @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
   end
 
+  # The message_list method creates and returns a new MessageList instance
+  # initialized with the current object as its argument.
+  #
+  # @return [ MessageList ] a new MessageList object
   def message_list
     MessageList.new(self)
   end

data/lib/ollama_chat/document_cache.rb

@@ -1,8 +1,20 @@
 module OllamaChat::DocumentCache
+  # The document_cache_class method returns the cache class specified in the
+  # configuration.
+  #
+  # @return [ Class ] the cache class defined by the config.cache setting
   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.
+  #
+  # @return [ Class ] the selected cache class to be used for document caching
   def configure_cache
     if @opts[?M]
       Documentrix::Documents::MemoryCache

data/lib/ollama_chat/follow_chat.rb

@@ -4,7 +4,6 @@ class OllamaChat::FollowChat
   include Term::ANSIColor
   include OllamaChat::MessageFormat
 
-
   # Initializes a new instance of OllamaChat::FollowChat.
   #
   # @param [OllamaChat::Chat] chat The chat object, which represents the conversation context.

data/lib/ollama_chat/information.rb

@@ -7,15 +7,31 @@ module OllamaChat::Information
   end
 
   module UserAgent
+    # The progname method returns the name of the application.
+    #
+    # @return [ String ] the application name "ollama_chat"
     def progname
       'ollama_chat'
     end
 
+    # The user_agent method constructs and returns a user agent string
+    # that combines the program name and the OllamaChat version
+    # separated by a forward slash.
+    #
+    # @return [ String ] the formatted user agent string
     def user_agent
       [ progname, OllamaChat::VERSION ] * ?/
     end
   end
 
+  # The collection_stats method displays statistics about the current document
+  # collection.
+  #
+  # This method outputs information regarding the active document collection,
+  # including the collection name, total number of embeddings, and a list of
+  # tags.
+  #
+  # @return [ nil ] This method always returns nil.
   def collection_stats
     STDOUT.puts <<~EOT
       Current Collection
@@ -27,6 +43,13 @@ module OllamaChat::Information
     nil
   end
 
+  # The info method displays comprehensive information about the current state
+  # of the ollama_chat instance.
+  # This includes version details, server connection status, model
+  # configurations, embedding settings, and various operational switches.
+  #
+  # @return [ nil ] This method does not return a value; it outputs information
+  # 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)}"
@@ -58,6 +81,9 @@ module OllamaChat::Information
     nil
   end
 
+  # The display_chat_help_message method returns a formatted string containing
+  # all available command-line options and their descriptions for the chat
+  # interface.
   private def display_chat_help_message
     <<~EOT
       /copy                           to copy last response to clipboard
@@ -95,11 +121,18 @@ module OllamaChat::Information
     EOT
   end
 
+  # The display_chat_help method outputs the chat help message to standard output.
+  #
+  # @return [ nil ] This method always returns nil after printing the help message.
   def display_chat_help
     STDOUT.puts display_chat_help_message
     nil
   end
 
+  # The usage method displays the command-line interface help text
+  # and returns an exit code of 0.
+  #
+  # @return [ Integer ] always returns 0 indicating successful help display
   def usage
     STDOUT.puts <<~EOT
       Usage: #{progname} [OPTIONS]
@@ -123,15 +156,25 @@ module OllamaChat::Information
     0
   end
 
+  # The version method outputs the program name and its version number to
+  # standard output.
+  #
+  # @return [ Integer ] returns 0 indicating successful execution
   def version
     STDOUT.puts "%s %s" % [ progname, OllamaChat::VERSION ]
     0
   end
 
+  # The server_version method retrieves the version of the Ollama server.
+  #
+  # @return [ String ] the version string of the connected Ollama server
   def server_version
     @server_version ||= ollama.version.version
   end
 
+  # The server_url method returns the base URL of the Ollama server connection.
+  #
+  # @return [ String ] the base URL used for communicating with the Ollama API
   def server_url
     @server_url ||= ollama.base_url
   end

data/lib/ollama_chat/message_format.rb

@@ -1,8 +1,20 @@
 module OllamaChat::MessageFormat
+  # The message_type method determines the appropriate message icon based on
+  # whether images are present.
+  #
+  # @param images [ Array ] an array of images
+  #
+  # @return [ String ] returns 📸 if images are present, 📨 otherwise
   def message_type(images)
     images.present? ? ?📸 : ?📨
   end
 
+  # The think_annotate method processes a string and conditionally annotates it
+  # with a thinking emoji if the think feature is enabled.
+  #
+  # @param block [ Proc ] a block that returns a string to be processed
+  #
+  # @return [ String, nil ] the annotated string with a thinking emoji if enabled, otherwise nil
   def think_annotate(&block)
     string = block.()
     string.to_s.size == 0 and return
@@ -11,6 +23,12 @@ module OllamaChat::MessageFormat
     end
   end
 
+  # The talk_annotate method processes a string output by a block and
+  # conditionally adds annotation.
+  #
+  # @param block [ Proc ] a block that returns a string to be processed
+  #
+  # @return [ String, nil ] the annotated string if it has content, otherwise nil
   def talk_annotate(&block)
     string = block.()
     string.to_s.size == 0 and return

data/lib/ollama_chat/message_output.rb

@@ -1,4 +1,12 @@
 module OllamaChat::MessageOutput
+  # The pipe method forwards the last assistant message to a command's standard
+  # input.
+  #
+  # @param cmd [ String ] the command to which the output should be piped
+  #
+  # @return [ OllamaChat::Chat ] returns self
+  # @return [ nil ] returns nil if the command is not provided or if there is
+  # no assistant message
   def pipe(cmd)
     cmd.present? or return
     if message = @messages.last and message.role == 'assistant'
@@ -21,10 +29,19 @@ module OllamaChat::MessageOutput
     end
   end
 
+  # The output method writes the last assistant message to a file.
+  #
+  # @param filename [ String ] the path to the file where the output should be written
+  #
+  # @return [ Chat ] returns self on success, nil on failure
+  #
+  # @see write_file_unless_exist
+  #
+  # @note If no assistant message is available, an error message is printed to stderr.
   def output(filename)
     if message = @messages.last and message.role == 'assistant'
       begin
-        write_file_unless_exist(filename)
+        write_file_unless_exist(filename, message)
         STDOUT.puts "Last response was written to #{filename.inspect}."
         self
       rescue => e
@@ -37,7 +54,15 @@ module OllamaChat::MessageOutput
 
   private
 
-  def write_file_unless_exist(filename)
+  # The write_file_unless_exist method creates a new file with the specified
+  # message content, but only if a file with that name does not already exist.
+  #
+  # @param filename [ String ] the path of the file to be created
+  # @param message [ Ollama::Message ] the message object containing the content to write
+  #
+  # @return [ TrueClass ] if the file was successfully created
+  # @return [ nil ] if the file already exists and was not created
+  def write_file_unless_exist(filename, message)
     if File.exist?(filename)
       STDERR.puts "File #{filename.inspect} already exists. Choose another filename."
       return
@@ -47,4 +72,4 @@ module OllamaChat::MessageOutput
     end
     true
   end
-  end
+end

data/lib/ollama_chat/model_handling.rb

@@ -1,5 +1,4 @@
 module OllamaChat::ModelHandling
-
   # The model_present? method checks if the specified Ollama model is available.
   #
   # @param model [ String ] the name of the Ollama model

data/lib/ollama_chat/ollama_chat_config.rb

@@ -9,6 +9,15 @@ class OllamaChat::OllamaChatConfig
 
   DEFAULT_CONFIG = File.read(DEFAULT_CONFIG_PATH)
 
+  # The initialize method sets up the configuration file path and ensures the
+  # cache directory exists.
+  # It attempts to load configuration from the specified filename or uses a
+  # default path.
+  # If the configuration file is missing and the default path is used, it
+  # creates the necessary directory structure and writes a default
+  # configuration file.
+  #
+  # @param filename [ String, nil ] the path to the configuration file
   def initialize(filename = nil)
     @filename = filename || default_path
     unless File.directory?(cache_dir_path)
@@ -27,30 +36,62 @@ class OllamaChat::OllamaChatConfig
     end
   end
 
+  # The filename reader returns the name of the file associated with this instance.
   attr_reader :filename
 
+  # The config reader returns the configuration object for the chat instance.
+  #
+  # @return [ ComplexConfig::Settings ] the configuration object
   attr_reader :config
 
+  # The default_config_path method returns the path to the default
+  # configuration file.
+  #
+  # @return [ String ] the path to the default configuration file
   def default_config_path
     DEFAULT_CONFIG_PATH
   end
 
+  # The default_path method constructs the full path to the default
+  # configuration file.
+  #
+  # @return [ Pathname ] a Pathname object representing the path to the
+  # config.yml file within the configuration directory
   def default_path
     config_dir_path + 'config.yml'
   end
 
+  # The config_dir_path method returns the path to the ollama_chat
+  # configuration directory by combining the XDG config home directory with the
+  # 'ollama_chat' subdirectory.
+  #
+  # @return [ Pathname ] the pathname object representing the configuration
+  # directory
   def config_dir_path
     XDG.new.config_home + 'ollama_chat'
   end
 
+  # The cache_dir_path method returns the path to the ollama_chat cache
+  # directory within the XDG cache home directory.
+  #
+  # @return [ Pathname ] the pathname object representing the cache directory path
   def cache_dir_path
     XDG.new.cache_home + 'ollama_chat'
   end
 
+  # The database_path method constructs the full path to the documents database
+  # file by joining the cache directory path with the filename 'documents.db'.
+  #
+  # @return [ Pathname ] the full path to the documents database file
   def database_path
     cache_dir_path + 'documents.db'
   end
 
+  # The diff_tool method returns the preferred diff tool command.
+  # It checks for the DIFF_TOOL environment variable and falls back to
+  # 'vimdiff' if not set.
+  #
+  # @return [ String ] the command name of the diff tool to be used
   def diff_tool
     ENV.fetch('DIFF_TOOL', 'vimdiff')
   end

data/lib/ollama_chat/parsing.rb

@@ -1,4 +1,11 @@
 module OllamaChat::Parsing
+  # The parse_source method processes different types of input sources and
+  # converts them into a standardized text representation.
+  #
+  # @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
   def parse_source(source_io)
     case source_io&.content_type
     when 'text/html'
@@ -28,6 +35,16 @@ module OllamaChat::Parsing
     end
   end
 
+  # The parse_csv method processes CSV content from an input source and
+  # converts it into a formatted string representation.
+  # It iterates through each row of the CSV, skipping empty rows, and
+  # constructs a structured output where each row's fields are formatted with
+  # indentation and separated by newlines. The resulting string includes double
+  # newlines between rows for readability.
+  #
+  # @param source_io [ IO ] the input source containing CSV data
+  #
+  # @return [ String ] a formatted string representation of the CSV content
   def parse_csv(source_io)
     result = +''
     CSV.table(File.new(source_io), col_sep: ?,).each do |row|
@@ -40,6 +57,18 @@ module OllamaChat::Parsing
     result
   end
 
+  # The parse_rss method processes an RSS feed source and converts it into a
+  # formatted text representation.
+  # It extracts the channel title and iterates through each item in the feed to
+  # build a structured output.
+  # The method uses the RSS parser to handle the source input and formats the
+  # title, link, publication date, and description of each item into a readable
+  # text format with markdown-style headers and links.
+  #
+  # @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
   def parse_rss(source_io)
     feed = RSS::Parser.parse(source_io, false, false)
     title = <<~EOT
@@ -58,6 +87,18 @@ module OllamaChat::Parsing
     end
   end
 
+  # The parse_atom method processes an Atom feed from the provided IO source
+  # and converts it into a formatted text representation.
+  # It extracts the feed title and iterates through each item to build a
+  # structured output containing titles, links, and update dates.
+  #
+  # The content of each item is converted using reverse_markdown for better
+  # readability.
+  #
+  # @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
   def parse_atom(source_io)
     feed = RSS::Parser.parse(source_io, false, false)
     title = <<~EOT
@@ -76,11 +117,26 @@ module OllamaChat::Parsing
     end
   end
 
+  # The pdf_read method extracts text content from a PDF file by reading all
+  # pages.
+  #
+  # @param io [IO] the input stream containing the PDF data
+  #
+  # @return [String] the concatenated text content from all pages in the PDF
   def pdf_read(io)
     reader = PDF::Reader.new(io)
     reader.pages.inject(+'') { |result, page| result << page.text }
   end
 
+
+  # Reads and processes PDF content using Ghostscript for conversion
+  #
+  # This method takes an IO object containing PDF data, processes it through
+  # Ghostscript's pdfwrite device, and returns the processed PDF content.
+  # 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
   def ps_read(io)
     gs = `which gs`.chomp
     if gs.present?
@@ -102,6 +158,15 @@ module OllamaChat::Parsing
     end
   end
 
+  # The reverse_markdown method converts HTML content into Markdown format.
+  #
+  # This method processes HTML input and transforms it into equivalent
+  # Markdown, using specific conversion options to ensure compatibility and
+  # formatting.
+  #
+  # @param html [ String ] the HTML string to be converted
+  #
+  # @return [ String ] the resulting Markdown formatted string
   def reverse_markdown(html)
     ReverseMarkdown.convert(
       html,
@@ -111,6 +176,17 @@ module OllamaChat::Parsing
     )
   end
 
+  # Parses content and processes embedded resources based on document policy
+  #
+  # This method analyzes input content for URLs, tags, and file references,
+  # fetches referenced resources, and processes them according to the current
+  # document policy. It supports different processing modes for various content
+  # types.
+  #
+  # @param content [String] The input content string to parse
+  # @param images [Array] An array to collect image references (will be cleared)
+  # @return [Array<String, Documentrix::Utils::Tags>] Returns an array containing
+  #   the processed content string and tags object if any tags were found
   def parse_content(content, images)
     images.clear
     tags = Documentrix::Utils::Tags.new valid_tag: /\A#*([\w\]\[]+)/

data/lib/ollama_chat/version.rb

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

data/ollama_chat.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama_chat 0.0.19 ruby lib
+# stub: ollama_chat 0.0.20 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama_chat".freeze
-  s.version = "0.0.19".freeze
+  s.version = "0.0.20".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama_chat
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - Florian Frank