ollama_chat 0.0.35 → 0.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0c32096e0846e22b31ec8e27fa8aa20087ac0d88cb421c9e697d17e61bfad0b
-  data.tar.gz: 9b828f24b207fbea21c5b9a2a13c572c5f45765cf6b88b6a4624ec923bc5f109
+  metadata.gz: 3549c1258a47d46e043e045573d51e41729cc8531ecb5c9746eceb385ff01b99
+  data.tar.gz: cda7120617c155a20326f9a8445207e4b74cbd7faf100ac194b30cdbe4524293
 SHA512:
-  metadata.gz: 4a351e48b81cca88fde7299da6bab2f9e4fdcc10ce98b3af1cc8d7733dd58675bb5b7fe75896ad369169e33e7c91d858ff85ad69406e019845eaaa6d8c6d4614
-  data.tar.gz: 9951320316b3fcd7c804dfdd18a2540f5b56399c131677f29aa011995b25877346e83d550ab222e1b67f8bf92f5828bbd510bda5aed4df5dcfb9e1f92995a41d
+  metadata.gz: 88d787dbb1e4e8aa9756b21c5e0a64ab01ab52fdb2ebf84f3f4df6aa65a8b0b4aa03c77c21384ce6e98f156c9dcc9cb711d83d5baf99504e41879f05cc877131
+  data.tar.gz: 55097e08afa04486918e5939062b71d729ec27c14fcc186078f11c631f5c7dba05d8fca6f39a1823abd521acdd6712c06e0f5812c548321cdb3449cae1351549

data/CHANGES.md

@@ -1,5 +1,23 @@
 # Changes
 
+## 2025-10-11 v0.0.36
+
+- Added `openssl-dev` package to apk packages in Dockerfile
+- Replaced explicit `_1` parameter syntax with implicit `_1` syntax for
+  compatibility with older Ruby versions
+- Removed `require 'xdg'` statement from `chat.rb`
+- Removed `xdg` gem dependency and implemented direct XDG directory usage
+- Added documentation link to README with a link to the GitHub.io documentation
+  site
+- Introduced GitHub Actions workflow for static content deployment to GitHub
+  Pages
+- Updated `gem_hadar` development dependency to version **2.8**
+- Reordered menu options in dialog prompts to place `[EXIT]` first
+- Corrected YARD documentation guidelines for `initialize` methods
+- Updated documentation comments with consistent formatting
+- Updated Redis (ValKey) image version from **8.1.1** to **8.1.3**
+- Removed deprecated `REDIS_EXPRING_URL` environment variable from `.envrc`
+
 ## 2025-09-18 v0.0.35
 
 - Replaced ad-hoc ENV handling with `const_conf` gem for structured

data/README.md

@@ -5,6 +5,10 @@
 **ollama_chat** is a chat client, that can be used to connect to an ollama
 server and enter chat conversations with the LLMs provided by it.
 
+## Documentation
+
+Complete API documentation is available at: [GitHub.io](https://flori.github.io/ollama_chat/)
+
 ## Installation (gem)
 
 To install **ollama_chat**, you can type

data/Rakefile

@@ -24,8 +24,7 @@ GemHadar do
     '.yardoc', 'doc', 'tags', 'corpus', 'coverage', '/config/searxng/*',
     '.starscope.db', 'cscope.out'
   package_ignore '.all_images.yml', '.tool-versions', '.gitignore', 'VERSION',
-    '.rspec', '.github', *FileList['.contexts/*'], '.envrc'
-
+    '.rspec', '.github', '.contexts', '.envrc', '.yardopts'
 
   readme      'README.md'
 
@@ -33,6 +32,10 @@ GemHadar do
 
   executables << 'ollama_chat' << 'ollama_chat_send'
 
+  github_workflows(
+    'static.yml' => {}
+  )
+
   dependency             'excon',                 '~> 1.0'
   dependency             'ollama-ruby',           '~> 1.7'
   dependency             'documentrix',           '~> 0.0', '>= 0.0.2'
@@ -42,7 +45,6 @@ GemHadar do
   dependency             'redis',                 '~> 5.0'
   dependency             'mime-types',            '~> 3.0'
   dependency             'reverse_markdown',      '~> 3.0'
-  dependency             'xdg'
   dependency             'kramdown-ansi',         '~> 0.2'
   dependency             'complex_config',        '~> 0.22', '>= 0.22.2'
   dependency             'tins',                  '~> 1.41'

data/docker-compose.yml

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

data/lib/ollama_chat/chat.rb

@@ -13,7 +13,6 @@ require 'nokogiri'
 require 'rss'
 require 'pdf/reader'
 require 'csv'
-require 'xdg'
 require 'socket'
 require 'shellwords'
 
@@ -143,7 +142,7 @@ class OllamaChat::Chat
   # Documentrix::Documents instance.
   #
   # @return [Documentrix::Documents] A Documentrix::Documents object containing
-  # all documents associated with this instance
+  #   all documents associated with this instance
   attr_reader :documents
 
   # Returns the messages set for this object, initializing it lazily if needed.
@@ -153,7 +152,7 @@ class OllamaChat::Chat
   # OllamaChat::MessageList instance.
   #
   # @return [OllamaChat::MessageList] A MessageList object containing all
-  # messages associated with this instance
+  #   messages associated with this instance
   attr_reader :messages
 
   # Returns the links set for this object, initializing it lazily if needed.
@@ -202,6 +201,11 @@ class OllamaChat::Chat
 
   private
 
+  # Handles user input commands and processes chat interactions.
+  #
+  # @param content [String] The input content to process
+  # @return [Symbol, String, nil] Returns a symbol indicating next action,
+  #   the content to be processed, or nil for no action needed
   def handle_input(content)
     case content
     when %r(^/copy$)
@@ -470,7 +474,7 @@ class OllamaChat::Chat
   # specified parameter.
   #
   # @param what [ String, nil ] the type of data to clear, defaults to
-  # 'messages' if nil
+  #   'messages' if nil
   def clean(what)
     case what
     when 'messages', nil
@@ -647,7 +651,7 @@ class OllamaChat::Chat
   # configured document collection.
   #
   # @return [ Documentrix::Documents, NULL ] the initialized document
-  # collection if embedding is enabled, otherwise NULL
+  #   collection if embedding is enabled, otherwise NULL
   def setup_documents
     if embedding.on?
       @embedding_model         = config.embedding.model.name
@@ -729,7 +733,7 @@ class OllamaChat::Chat
   # expiring keys if a Redis URL is configured.
   #
   # @return [ Documentrix::Documents::RedisCache, nil ] the configured Redis
-  # cache instance or nil if no URL is set.
+  #   cache instance or nil if no URL is set.
   def setup_cache
     if url = config.redis.expiring.url?
       ex = config.redis.expiring.ex?.to_i
@@ -748,7 +752,7 @@ class OllamaChat::Chat
   # This method exits the program after handling the configuration error
   #
   # @param exception [ Exception ] the exception that occurred while reading
-  # the config file
+  #   the config file
   def fix_config(exception)
     save_conversation('backup.json')
     STDOUT.puts "When reading the config file, a #{exception.class} "\

data/lib/ollama_chat/dialog.rb

@@ -158,7 +158,7 @@ module OllamaChat::Dialog
     if prompts.size == 1
       system = config.system_prompts.send(prompts.first)
     else
-      prompts.unshift('[EXIT]').unshift('[NEW]')
+      prompts.unshift('[NEW]').unshift('[EXIT]')
       chosen = OllamaChat::Utils::Chooser.choose(prompts)
       system =
         case chosen

data/lib/ollama_chat/env_config.rb

@@ -1,4 +1,5 @@
 require 'const_conf'
+require 'pathname'
 
 module OllamaChat
   module EnvConfig
@@ -7,6 +8,18 @@ module OllamaChat
     description 'Environment config for OllamaChat'
     prefix ''
 
+    XDG_CONFIG_HOME = set do
+      description 'XDG Configuration directory path'
+      default { '~/.config' }
+      decode  { Pathname.new(_1) + 'ollama_chat' }
+    end
+
+    XDG_CACHE_HOME = set do
+      description 'XDG Cache directory path'
+      default { '~/.cache' }
+      decode  { Pathname.new(_1) + 'ollama_chat' }
+    end
+
     PAGER = set do
       description 'Pager command to use in case terminal lines are exceeded by output'
 
@@ -73,7 +86,7 @@ module OllamaChat
 
         DEBUG = set do
           description 'Enable debugging for chat client'
-          decode { it.to_i == 1 }
+          decode { _1.to_i == 1 }
           default 0
         end
 

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
-    XDG.new.config_home + 'ollama_chat'
+    OllamaChat::EnvConfig::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
-    XDG.new.cache_home + 'ollama_chat'
+    OllamaChat::EnvConfig::XDG_CACHE_HOME
   end
 
   # The database_path method constructs the full path to the documents database

data/lib/ollama_chat/version.rb

@@ -1,6 +1,6 @@
 module OllamaChat
   # OllamaChat version
-  VERSION         = '0.0.35'
+  VERSION         = '0.0.36'
   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.35 ruby lib
+# stub: ollama_chat 0.0.36 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama_chat".freeze
-  s.version = "0.0.35".freeze
+  s.version = "0.0.36".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.6".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.8".freeze])
   s.add_development_dependency(%q<all_images>.freeze, ["~> 0.6".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.2".freeze])
   s.add_development_dependency(%q<kramdown>.freeze, ["~> 2.0".freeze])
@@ -41,7 +41,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency(%q<redis>.freeze, ["~> 5.0".freeze])
   s.add_runtime_dependency(%q<mime-types>.freeze, ["~> 3.0".freeze])
   s.add_runtime_dependency(%q<reverse_markdown>.freeze, ["~> 3.0".freeze])
-  s.add_runtime_dependency(%q<xdg>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<kramdown-ansi>.freeze, ["~> 0.2".freeze])
   s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.22".freeze, ">= 0.22.2".freeze])
   s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.41".freeze])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama_chat
 version: !ruby/object:Gem::Version
-  version: 0.0.35
+  version: 0.0.36
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -253,20 +253,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: xdg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: kramdown-ansi
   requirement: !ruby/object:Gem::Requirement