ollama_chat 0.0.69 → 0.0.70

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4c1e0e4af70239c191a9b7fb36bafb5e813bebbe99b3884a19ed1350074937c
-  data.tar.gz: 39ff2ea149df672fdf021fc367681d578e701fe9d8fe7b4a4b202e9e73575cee
+  metadata.gz: 54c023c5c8eca7b676ab5a3803f657c941e7bf2416d77fda8a54ac3ec8e3a995
+  data.tar.gz: ee70e5b6cf6e279e919e3a06377c016a4c5fa83ea09b5fb68ade1839538514ef
 SHA512:
-  metadata.gz: 7bb2eb1885554be1140c8748adad8168c4eec9cfc85b267ea3af8f046643489c5611787a43da878a41fe3382828930caeb80be10b24f0059bae865f56d8f1e8b
-  data.tar.gz: a1c629f1678eb8b763b04ba0def7666e00f0d76ca346d5a285efc9aa8ad3b71dd13dba04482a778e2b7b178e1cbe43e10895f0cac69ad01145d276771789e574
+  metadata.gz: d38bf14e210c51df07476ea648ef2ae430f0ad9620267940ce7c5f7ecb0ad2451a700bb6ac0d1043c82331bc5c91f4b1a8cc5ad7030f1b0a07e06b6d9e14781e
+  data.tar.gz: 7df74bd1ce54a2ebc94243f83516cae117ff03ed6d9e721aaff2b0ee050d8c61e7128a7f519f2af3fe404b3a4dd49b8d5c7a9c0ad018fdd6f65454d46e6481e7

data/CHANGES.md

@@ -1,5 +1,41 @@
 # Changes
 
+## 2026-02-23 v0.0.70
+
+- Added `generate_password` tool with secure password generation, supporting
+  multiple alphabet types.  
+- Updated `tins` gem dependency to **1.52**.  
+- Added comprehensive tests for `generate_password` with various parameters.  
+- Registered `generate_password` tool in the gemspec and configured it in
+  `default_config.yml`.  
+- Added `get_rfc` tool for fetching RFC documents, including URL template
+  configuration in `default_config.yml`.  
+- Implemented `OllamaChat::Tools::GetRFC` class and required it in `tools.rb`.  
+- Added comprehensive test suite for `get_rfc` in `get_rfc_spec.rb`.  
+- Implemented backup fallback for conversation loading: `chat.rb` now loads
+  from `OC::XDG_CACHE_HOME.join('backup.json')` when `-c` is not provided, and
+  deletes the backup after successful load.  
+- Updated `config_handling.rb` to save backups to
+  `OC::XDG_CACHE_HOME.join('backup.json')` instead of the current directory.  
+- Modified `message_list.rb` to print file‑existence errors using
+  `filename.to_s.inspect` and to safely remove the backup file with
+  `FileUtils.rm_f`.  
+- Renamed `OllamaChat::EnvConfig` to `OC` module alias, updating all references
+  accordingly.  
+- Added new constants: `OC::OLLAMA::SEARXNG_URL`, `OC::OLLAMA::REDIS_URL`,
+  `OC::OLLAMA::REDIS_EXPIRING_URL`.  
+- Updated nested module paths, e.g., `OC::OLLAMA::CHAT::TOOLS::JIRA` and
+  `OC::OLLAMA::CHAT::TOOLS::RUN_TESTS_TEST_RUNNER`.  
+- Refactored code to use nested class structure within the module and added
+  comprehensive YARD documentation with `@param`, `@return`, and `@example`
+  tags.  
+- Added module‑level documentation explaining tool purpose.  
+- Added YARD documentation to `read_file.rb`, including module docstring,
+  return type `[Ollama::Tool]`, and execute method parameter/return
+  documentation.  
+- Removed empty `lib/ollama_chat/tools/endoflife.rb`; the functionality is now
+  provided by the `get_endoflife` tool.
+
 ## 2026-02-23 v0.0.69
 
 - Reorganized access modifiers in `module OllamaChat::Dialog`, moving `ask?` to

data/Rakefile

@@ -51,7 +51,7 @@ GemHadar do
   dependency             'reverse_markdown',      '~> 3.0'
   dependency             'kramdown-ansi',         '~> 0.3'
   dependency             'complex_config',        '~> 0.22', '>= 0.22.2'
-  dependency             'tins',                  '~> 1.51'
+  dependency             'tins',                  '~> 1.52'
   dependency             'search_ui',             '~> 0.0'
   dependency             'amatch',                '~> 0.4'
   dependency             'pdf-reader',            '~> 2.0'

data/lib/ollama_chat/chat.rb

@@ -97,8 +97,11 @@ class OllamaChat::Chat
     @model           = choose_model(@opts[?m], config.model.name)
     @model_options   = Ollama::Options[config.model.options]
     @model_system    = pull_model_unless_present(@model, @model_options)
-    if @opts[?c]
-      messages.load_conversation(@opts[?c])
+    if conversation_file = @opts[?c]
+      messages.load_conversation(conversation_file)
+    elsif backup_file = OC::XDG_CACHE_HOME + 'backup.json' and backup_file.exist?
+      messages.load_conversation(backup_file)
+      FileUtils.rm_f backup_file
     else
       setup_system_prompt
     end
@@ -188,7 +191,7 @@ class OllamaChat::Chat
   #
   # @return [TrueClass, FalseClass] the current debug mode status
   def debug
-    OllamaChat::EnvConfig::OLLAMA::CHAT::DEBUG
+    OC::OLLAMA::CHAT::DEBUG
   end
 
   private
@@ -692,7 +695,7 @@ class OllamaChat::Chat
   #
   # @return [String] the base URL used for connecting to the Ollama API
   def base_url
-    @opts[?u] || OllamaChat::EnvConfig::OLLAMA::URL
+    @opts[?u] || OC::OLLAMA::URL
   end
 
   # The connect_ollama method establishes a connection to the Ollama API server.

data/lib/ollama_chat/config_handling.rb

@@ -34,7 +34,7 @@ module OllamaChat::ConfigHandling
   # variables and available system commands, then uses Kramdown::ANSI::Pager to
   # show the formatted configuration output.
   def display_config
-    command  = OllamaChat::EnvConfig::PAGER?
+    command  = OC::PAGER?
     rendered = config.to_s
     Kramdown::ANSI::Pager.pager(
       lines: rendered.count(?\n),
@@ -52,10 +52,10 @@ module OllamaChat::ConfigHandling
   # @param exception [Exception] the exception that occurred while reading
   #   the config file
   def fix_config(exception)
-    save_conversation('backup.json')
+    save_conversation(OC::XDG_CACHE_HOME + 'backup.json')
     STDOUT.puts "When reading the config file, a #{exception.class} "\
       "exception was caught: #{exception.message.inspect}"
-    unless diff_tool = OllamaChat::EnvConfig::DIFF_TOOL?
+    unless diff_tool = OC::DIFF_TOOL?
       exit 1
     end
     if ask?(prompt: 'Do you want to fix the config? (y/n) ') =~ /\Ay/i
@@ -73,7 +73,7 @@ module OllamaChat::ConfigHandling
   # Edit the current configuration file in the editor defined by the
   # environment variable `EDITOR`.
   #
-  # 1. Looks up the editor command via `OllamaChat::EnvConfig::EDITOR`.
+  # 1. Looks up the editor command via `OC::EDITOR`.
   #    If the value is `nil` or empty, it prints an error message to
   #    STDERR and returns immediately.
   # 2. Invokes the editor with the path to the active configuration
@@ -83,13 +83,14 @@ module OllamaChat::ConfigHandling
   # 3. If editing was successful, prompts the user to restart
   #    `ollama_chat` if desired.
   def edit_config
-    unless editor = OllamaChat::EnvConfig::EDITOR?
+    unless editor = OC::EDITOR?
       STDERR.puts "Need the environment variable var EDITOR defined to use an editor"
       return
     end
     result = system Shellwords.join([ editor, @ollama_chat_config.filename ])
     if result
       if ask?(prompt: "Do you want to restart #{progname}? (y/n) ") =~ /\Ay/i
+        save_conversation(OC::XDG_CACHE_HOME + 'backup.json')
         exec($0, *ARGV)
       end
     else

data/lib/ollama_chat/env_config.rb

@@ -1,171 +1,169 @@
 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
-
-    description 'Environment config for OllamaChat'
-    prefix ''
-
-    XDG_CONFIG_HOME = set do
-      description 'XDG Configuration directory path'
-      default { '~/.config' }
-      decode  { Pathname.new(_1).join('ollama_chat').expand_path }
-    end
+# 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 OC
+  include ConstConf
+
+  description 'Environment config for OllamaChat'
+  prefix ''
+
+  XDG_CONFIG_HOME = set do
+    description 'XDG Configuration directory path'
+    default { '~/.config' }
+    decode  { Pathname.new(_1).join('ollama_chat').expand_path }
+  end
 
-    XDG_CACHE_HOME = set do
-      description 'XDG Cache directory path'
-      default { '~/.cache' }
-      decode  { Pathname.new(_1).join('ollama_chat').expand_path }
-    end
+  XDG_CACHE_HOME = set do
+    description 'XDG Cache directory path'
+    default { '~/.cache' }
+    decode  { Pathname.new(_1).join('ollama_chat').expand_path }
+  end
 
-    PAGER = set do
-      description 'Pager command to use in case terminal lines are exceeded by output'
+  PAGER = set do
+    description 'Pager command to use in case terminal lines are exceeded by output'
 
-      default do
-        if fallback_pager = `which less`.full?(:chomp) || `which more`.full?(:chomp)
-          fallback_pager << ' -r'
-        end
+    default do
+      if fallback_pager = `which less`.full?(:chomp) || `which more`.full?(:chomp)
+        fallback_pager << ' -r'
       end
     end
+  end
 
-    EDITOR = set do
-      description 'Editor to use'
+  EDITOR = set do
+    description 'Editor to use'
 
-      default do
-        if  editor = %w[ vim vi ].find { `which #{_1}`.full?(:chomp) }
-          editor
-        else
-          warn 'Need an editor command configured via env var "EDITOR"'
-        end
+    default do
+      if  editor = %w[ vim vi ].find { `which #{_1}`.full?(:chomp) }
+        editor
+      else
+        warn 'Need an editor command configured via env var "EDITOR"'
       end
     end
+  end
 
-    BROWSER = set do
-      description 'Browser to use'
+  BROWSER = set do
+    description 'Browser to use'
 
-      default do
-        %w[ open xdg-open ].find { `which #{_1}` }.full?(:chomp)
-      end
+    default do
+      %w[ open xdg-open ].find { `which #{_1}` }.full?(:chomp)
     end
+  end
 
-    DIFF_TOOL = set do
-      description 'Diff tool to apply changes with'
+  DIFF_TOOL = set do
+    description 'Diff tool to apply changes with'
 
-      default do
-        if  diff = `which vimdiff`.full?(:chomp)
-          diff
-        else
-          warn 'Need a diff tool configured via env var "DIFF_TOOL"'
-        end
+    default do
+      if  diff = `which vimdiff`.full?(:chomp)
+        diff
+      else
+        warn 'Need a diff tool configured via env var "DIFF_TOOL"'
       end
     end
+  end
 
-    KRAMDOWN_ANSI_OLLAMA_CHAT_STYLES = set do
-      description 'Styles to use for kramdown-ansi markdown'
+  KRAMDOWN_ANSI_OLLAMA_CHAT_STYLES = set do
+    description 'Styles to use for kramdown-ansi markdown'
 
-      default ENV['KRAMDOWN_ANSI_STYLES'].full?
+    default ENV['KRAMDOWN_ANSI_STYLES'].full?
+  end
+
+  module OLLAMA
+    description 'Ollama Configuration'
+    prefix 'OLLAMA'
+
+    HOST = set do
+      description 'Ollama "host" to connect to'
+      default     'localhost:11434'
     end
 
-    module OLLAMA
-      description 'Ollama Configuration'
-      prefix 'OLLAMA'
+    URL = set do
+      description 'Ollama base URL to connect to'
+      default     { 'http://%s' % OC::OLLAMA::HOST }
+      sensitive   true
+    end
 
-      HOST = set do
-        description 'Ollama "host" to connect to'
-        default     'localhost:11434'
-      end
+    SEARXNG_URL = set do
+      description 'URL for the SearXNG service for searches'
+      default     'http://localhost:8088/search?q=%{query}&language=en&format=json'
+      sensitive   true
+    end
 
-      URL = set do
-        description 'Ollama base URL to connect to'
-        default     { 'http://%s' % OllamaChat::EnvConfig::OLLAMA::HOST }
-        sensitive   true
-      end
+    REDIS_URL = set do
+      description 'Redis URL for documents'
+      default     { ENV['REDIS_URL'].full?  }
+      sensitive   true
+    end
 
-      SEARXNG_URL = set do
-        description 'URL for the SearXNG service for searches'
-        default     'http://localhost:8088/search?q=%{query}&language=en&format=json'
-        sensitive   true
-      end
+    REDIS_EXPIRING_URL = set do
+      description 'Redis URL for caching'
+      default     { OC::OLLAMA::REDIS_URL? || ENV['REDIS_URL'].full? }
+      sensitive   true
+    end
 
-      REDIS_URL = set do
-        description 'Redis URL for documents'
-        default     { ENV['REDIS_URL'].full?  }
-        sensitive   true
+    module CHAT
+      description 'OllamaChat Configuration'
+
+      DEBUG = set do
+        description 'Enable debugging for chat client'
+        decode { _1.to_i == 1 }
+        default 0
       end
 
-      REDIS_EXPIRING_URL = set do
-        description 'Redis URL for caching'
-        default     { EnvConfig::OLLAMA::REDIS_URL? || ENV['REDIS_URL'].full? }
-        sensitive   true
+      MODEL = set do
+        description 'Default model to use for the chat'
+        default 'llama3.1'
       end
 
-      module CHAT
-        description 'OllamaChat Configuration'
+      SYSTEM = set do
+        description 'Default system prompt'
+      end
 
-        DEBUG = set do
-          description 'Enable debugging for chat client'
-          decode { _1.to_i == 1 }
-          default 0
-        end
+      COLLECTION = set do
+        description 'Default collection for embeddings'
+      end
 
-        MODEL = set do
-          description 'Default model to use for the chat'
-          default 'llama3.1'
-        end
+      HISTORY = set do
+        description 'File to save the chat history in'
+        default     XDG_CACHE_HOME + 'history.json'
+      end
 
-        SYSTEM = set do
-          description 'Default system prompt'
-        end
+      module TOOLS
+        description 'Tool specific configuration settings'
 
-        COLLECTION = set do
-          description 'Default collection for embeddings'
+        # Run Tests tool configuration
+        RUN_TESTS_TEST_RUNNER = set do
+          description 'Configured test runner for run_tests tool function'
+          default     'rspec'
+          required     true
         end
 
-        HISTORY = set do
-          description 'File to save the chat history in'
-          default     XDG_CACHE_HOME + 'history.json'
-        end
+        module JIRA
+          description 'Jira tool configuration'
 
-        module TOOLS
-          description 'Tool specific configuration settings'
+          URL = set do
+            description 'Base URL for Jira instance'
+            sensitive   true
+          end
 
-          # Run Tests tool configuration
-          RUN_TESTS_TEST_RUNNER = set do
-            description 'Configured test runner for run_tests tool function'
-            default     'rspec'
-            required     true
+          USER = set do
+            description 'Username for Jira authentication'
+            sensitive   true
+            required { OC::OLLAMA::CHAT::TOOLS::JIRA::URL? }
           end
 
-          module JIRA
-            description 'Jira tool configuration'
-
-            URL = set do
-              description 'Base URL for Jira instance'
-              sensitive   true
-            end
-
-            USER = set do
-              description 'Username for Jira authentication'
-              sensitive   true
-              required { OllamaChat::EnvConfig::OLLAMA::CHAT::TOOLS::JIRA::URL? }
-            end
-
-            API_TOKEN = set do
-              description 'API token for Jira authentication'
-              sensitive   true
-              required { OllamaChat::EnvConfig::OLLAMA::CHAT::TOOLS::JIRA::URL? }
-            end
+          API_TOKEN = set do
+            description 'API token for Jira authentication'
+            sensitive   true
+            required { OC::OLLAMA::CHAT::TOOLS::JIRA::URL? }
           end
         end
       end

data/lib/ollama_chat/history.rb

@@ -28,7 +28,7 @@ module OllamaChat::History
   # @return [String] the absolute file path to the chat history file as
   #   specified in the configuration
   def chat_history_filename
-    File.expand_path(OllamaChat::EnvConfig::OLLAMA::CHAT::HISTORY)
+    File.expand_path(OC::OLLAMA::CHAT::HISTORY)
   end
 
   # The init_chat_history method initializes the chat session by loading

data/lib/ollama_chat/input_content.rb

@@ -110,9 +110,9 @@ module OllamaChat::InputContent
   #
   # @return [ String, nil ] the composed content if successful, nil otherwise
   def compose
-    unless editor = OllamaChat::EnvConfig::EDITOR?
+    unless editor = OC::EDITOR?
       STDERR.puts "Editor required for compose, set env var "\
-        "#{OllamaChat::EnvConfig::EDITOR!.env_var.inspect}."
+        "#{OC::EDITOR!.env_var.inspect}."
       return
     end
     Tempfile.open do |tmp|

data/lib/ollama_chat/kramdown_ansi.rb

@@ -18,7 +18,7 @@ module OllamaChat::KramdownANSI
   # @return [ Hash ] a hash of ANSI styles configured either from environment
   #   variables or using default settings
   def configure_kramdown_ansi_styles
-    if json = OllamaChat::EnvConfig::KRAMDOWN_ANSI_OLLAMA_CHAT_STYLES?
+    if json = OC::KRAMDOWN_ANSI_OLLAMA_CHAT_STYLES?
       Kramdown::ANSI::Styles.from_json(json).ansi_styles
     else
       Kramdown::ANSI::Styles.new.ansi_styles

data/lib/ollama_chat/message_editing.rb

@@ -18,9 +18,9 @@ module OllamaChat::MessageEditing
   # @return [String, nil] the edited content if successful, nil otherwise
   def revise_last
     if message = @messages.last
-      unless editor = OllamaChat::EnvConfig::EDITOR?
+      unless editor = OC::EDITOR?
         STDERR.puts "Editor required for revise, set env var " \
-          "#{OllamaChat::EnvConfig::EDITOR!.env_var.inspect}."
+          "#{OC::EDITOR!.env_var.inspect}."
         return
       end
 

data/lib/ollama_chat/message_list.rb

@@ -108,7 +108,7 @@ class OllamaChat::MessageList
   # @return [ OllamaChat::MessageList ] self
   def load_conversation(filename)
     unless File.exist?(filename)
-      STDERR.puts "File #{filename.inspect} doesn't exist. Choose another filename."
+      STDERR.puts "File #{filename.to_s.inspect} doesn't exist. Choose another filename."
       return
     end
     @messages =
@@ -320,7 +320,7 @@ class OllamaChat::MessageList
   # '-r' flag for proper handling of raw control characters when a fallback
   # pager is used.
   def determine_pager_command
-    OllamaChat::EnvConfig::PAGER?
+    OC::PAGER?
   end
 
   # The message_text_for method generates formatted text representation of a

data/lib/ollama_chat/ollama_chat_config/default_config.yml

@@ -1,7 +1,7 @@
 ---
 proxy: null # http://localhost:8080
 model:
-  name: <%= OllamaChat::EnvConfig::OLLAMA::CHAT::MODEL %>
+  name: <%= OC::OLLAMA::CHAT::MODEL %>
   options:
     num_ctx: 8192
 timeouts:
@@ -32,7 +32,7 @@ prompts:
     %{results}
   location: You are at %{location_name}, %{location_decimal_degrees}, preferring %{units}
 system_prompts:
-  default: <%= OllamaChat::EnvConfig::OLLAMA::CHAT::SYSTEM || 'null' %>
+  default: <%= OC::OLLAMA::CHAT::SYSTEM || 'null' %>
   assistant: You are a helpful assistant.
 voice:
   enabled: false
@@ -57,7 +57,7 @@ embedding:
     prompt: 'Represent this sentence for searching relevant passages: %s'
   batch_size: 10
   database_filename: null # ':memory:'
-  collection: <%= OllamaChat::EnvConfig::OLLAMA::CHAT::COLLECTION %>
+  collection: <%= OC::OLLAMA::CHAT::COLLECTION %>
   found_texts_size: 4096
   found_texts_count: 10
   splitter:
@@ -66,9 +66,9 @@ embedding:
 cache: Documentrix::Documents::SQLiteCache
 redis:
   documents:
-    url: <%= OllamaChat::EnvConfig::OLLAMA::REDIS_URL %>
+    url: <%= OC::OLLAMA::REDIS_URL %>
   expiring:
-    url: <%= OllamaChat::EnvConfig::OLLAMA::REDIS_EXPIRING_URL %>
+    url: <%= OC::OLLAMA::REDIS_EXPIRING_URL %>
     ex: 86400
 working_dir_dependent_socket: true
 request_headers:
@@ -81,7 +81,7 @@ web_search:
     duckduckgo:
       url: 'https://www.duckduckgo.com/html/?q=%{query}'
     searxng:
-      url: <%= OllamaChat::EnvConfig::OLLAMA::SEARXNG_URL %>
+      url: <%= OC::OLLAMA::SEARXNG_URL %>
 vim:
   clientserver: socket
 tools:
@@ -147,3 +147,8 @@ tools:
       default: true
     get_jira_issue:
       default: false
+    get_rfc:
+      url: "https://www.rfc-editor.org/rfc/rfc%{rfc_id}.txt"
+      default: true
+    generate_password:
+      default: true

data/lib/ollama_chat/ollama_chat_config.rb

@@ -87,7 +87,7 @@ class OllamaChat::OllamaChatConfig
   # @return [ Pathname ] the pathname object representing the configuration
   #   directory
   def config_dir_path
-    OllamaChat::EnvConfig::XDG_CONFIG_HOME
+    OC::XDG_CONFIG_HOME
   end
 
   # The cache_dir_path method returns the path to the ollama_chat cache
@@ -95,7 +95,7 @@ class OllamaChat::OllamaChatConfig
   #
   # @return [ Pathname ] the pathname object representing the cache directory path
   def cache_dir_path
-    OllamaChat::EnvConfig::XDG_CACHE_HOME
+    OC::XDG_CACHE_HOME
   end
 
   # The database_path method constructs the full path to the documents database
@@ -112,6 +112,6 @@ class OllamaChat::OllamaChatConfig
   #
   # @return [ String ] the command name of the diff tool to be used
   def diff_tool
-    OllamaChat::EnvConfig::DIFF_TOOL?
+    OC::DIFF_TOOL?
   end
 end

data/lib/ollama_chat/tools/browse.rb

@@ -77,7 +77,7 @@ class OllamaChat::Tools::Browse
   # @param url [String] the URL or file path to open
   # @return [Process::Status] the process status of the system call
   def browse_url(url)
-    browser = OllamaChat::EnvConfig::BROWSER? || "open"
+    browser = OC::BROWSER? || "open"
     system %{#{browser} #{Shellwords.escape(url)}}
     $?
   end