ollama_chat 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7968cdb60fc0612f59f3c240927a4a11f21ad664009270d614a31a119e818f17
-  data.tar.gz: f27240bd0371ecb4c5e2b20a73f2b94e3091ee3c6e230b313c89b39112be6096
+  metadata.gz: e5c75809ec83f12f9b70645f426774dec435a2510db811fa861e9c862a1e5c71
+  data.tar.gz: bca4f2fcf8e5e77ccc922858e4fe25db8933e5b09a9b264b94648a39feabc0c2
 SHA512:
-  metadata.gz: d665a8f4e8182b0b6a18f3daf86ce7a464632c2dfe3c608332528d10502ac65f4c3663cd7a6ebc18439f4c1156a183ce0962171d3bfe326b074f539fba51cee4
-  data.tar.gz: fa7a6384dabf4204a128ae56ef43c3fe22cbe2842f69ffa5c5d1db16133d64767541be616e6219ac4923cde21d4441b6e8f1a1f24dea726ed27dbbca35043d6a
+  metadata.gz: a8e9c93775bfd1629a743436a7fd85b7b7801d7a69221a423b5abbe0a44d98afccc7f9c8eb5182fdfacd848b0d1b27140fb599c3794f77bd4fa2cec7a012a9fb
+  data.tar.gz: 4f0460bb249fcd988a3425bdedc377ceaf5052f90c12563ef5fa01b72100857e30484622ed840b11147aed9cdc9e8a9c5cf4f9979c96fa317c8c27780d9fa990

data/.envrc

@@ -0,0 +1,2 @@
+export REDIS_URL=redis://localhost:9736
+export REDIS_EXPRING_URL=redis://localhost:9736

data/CHANGES.md

@@ -0,0 +1,18 @@
+# Changes
+
+## 2025-02-02 v0.0.1
+
+* Renamed `documents` variable to `@documents` in `OllamaChat::Chat`
+    * Modified `add_documents_from_argv` method to accept only `document_list` as argument
+    * Updated spec for `OllamaChat::Chat` to reflect changes in `add_documents_from_argv` method
+* Use `clamp(1..)` instead of manual checks for `n.to_i` in source fetching
+* Dropped is now used consistently in the code for message popping
+* Set up Redis environment and service for development:
+  * Added `.envrc` file with Redis URL exports.
+  * Added `docker-compose.yml` file to define a Redis service:
+  * Added `redis.conf` file with basic settings:
+* Use method names rather than instance variables for switch access.
+
+## 2025-01-29 v0.0.0
+
+  * Start

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/docker-compose.yml

@@ -0,0 +1,10 @@
+services:
+  redis:
+    image: valkey/valkey:7.2.8-alpine
+    restart: unless-stopped
+    ports: [ "127.0.0.1:9736:6379" ]
+    volumes:
+      - "redis-data:/data:delegated"
+      - "./redis/redis.conf:/etc/redis.conf"
+volumes:
+  redis-data:

data/lib/ollama_chat/chat.rb

@@ -41,7 +41,7 @@ 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)
-    @embedding_enabled.set(config.embedding.enabled && !@opts[?E])
+    embedding_enabled.set(config.embedding.enabled && !@opts[?E])
     @messages        = OllamaChat::MessageList.new(self)
     if @opts[?c]
       @messages.load_conversation(@opts[?c])
@@ -96,19 +96,19 @@ class OllamaChat::Chat
       when %r(^/paste$)
         content = paste_from_input
       when %r(^/markdown$)
-        @markdown.toggle
+        markdown.toggle
         next
       when %r(^/stream$)
-        @stream.toggle
+        stream.toggle
         next
       when %r(^/location$)
-        @location.toggle
+        location.toggle
         next
       when %r(^/voice(?:\s+(change))?$)
         if $1 == 'change'
           change_voice
         else
-          @voice.toggle
+          voice.toggle
         end
         next
       when %r(^/list(?:\s+(\d*))?$)
@@ -192,8 +192,8 @@ class OllamaChat::Chat
         parse_content = false
         content       = summarize($2, words: $1) or next
       when %r(^/embedding$)
-        @embedding_paused.toggle(show: false)
-        @embedding.show
+        embedding_paused.toggle(show: false)
+        embedding.show
         next
       when %r(^/embed\s+(.+))
         parse_content = false
@@ -287,7 +287,7 @@ class OllamaChat::Chat
                         [ content, Documentrix::Utils::Tags.new ]
                       end
 
-      if @embedding.on? && content
+      if embedding.on? && content
         records = @documents.find_where(
           content.downcase,
           tags:,
@@ -304,18 +304,18 @@ class OllamaChat::Chat
       @messages << Ollama::Message.new(role: 'user', content:, images: @images.dup)
       @images.clear
       handler = OllamaChat::FollowChat.new(
+        chat:     self,
         messages: @messages,
-        markdown: @markdown.on?,
-        voice:    (@current_voice if @voice.on?)
+        voice:    (@current_voice if voice.on?)
       )
       ollama.chat(
         model: @model,
         messages: @messages,
         options: @model_options,
-        stream: @stream.on?,
+        stream: stream.on?,
         &handler
       )
-      if @embedding.on? && !records.empty?
+      if embedding.on? && !records.empty?
         STDOUT.puts "", records.map { |record|
           link = if record.source =~ %r(\Ahttps?://)
                    record.source
@@ -335,12 +335,12 @@ class OllamaChat::Chat
   private
 
   def setup_documents
-    if @embedding.on?
+    if embedding.on?
       @embedding_model         = config.embedding.model.name
       @embedding_model_options = Ollama::Options[config.embedding.model.options]
       pull_model_unless_present(@embedding_model, @embedding_model_options)
       collection = @opts[?C] || config.embedding.collection
-      documents = Documentrix::Documents.new(
+      @documents = Documentrix::Documents.new(
         ollama:,
         model:             @embedding_model,
         model_options:     config.embedding.model.options,
@@ -352,14 +352,14 @@ class OllamaChat::Chat
       )
 
       document_list = @opts[?D].to_a
-      add_documents_from_argv(documents, document_list)
-      documents
+      add_documents_from_argv(document_list)
+      @documents
     else
       Tins::NULL
     end
   end
 
-  def add_documents_from_argv(documents, document_list)
+  def add_documents_from_argv(document_list)
     if document_list.any?(&:empty?)
       STDOUT.puts "Clearing collection #{bold{documents.collection}}."
       documents.clear

data/lib/ollama_chat/follow_chat.rb

@@ -4,10 +4,10 @@ class OllamaChat::FollowChat
   include Term::ANSIColor
   include OllamaChat::MessageType
 
-  def initialize(messages:, markdown: false, voice: nil, output: STDOUT)
+  def initialize(chat:, messages:, voice: nil, output: STDOUT)
     super(output:)
+    @chat        = chat
     @output.sync = true
-    @markdown    = markdown
     @say         = voice ? Handlers::Say.new(voice:) : NOP
     @messages    = messages
     @user        = nil
@@ -20,13 +20,13 @@ class OllamaChat::FollowChat
         @messages << Message.new(role: 'assistant', content: '')
         @user = message_type(@messages.last.images) + " " +
           bold { color(111) { 'assistant:' } }
-        @output.puts @user unless @markdown
+        @output.puts @user unless @chat.markdown.on?
       end
       if content = response.message&.content
         content = content.gsub(%r(<think>), "💭\n").gsub(%r(</think>), "\n💬")
       end
       @messages.last.content << content
-      if @markdown and content = @messages.last.content.full?
+      if @chat.markdown.on? and content = @messages.last.content.full?
         markdown_content = Kramdown::ANSI.parse(content)
         @output.print clear_screen, move_home, @user, ?\n, markdown_content
       else

data/lib/ollama_chat/information.rb

@@ -42,9 +42,9 @@ module OllamaChat::Information
       collection_stats
     end
     STDOUT.puts "Documents database cache is #{@documents.nil? ? 'n/a' : bold{@documents.cache.class}}"
-    @markdown.show
-    @stream.show
-    @location.show
+    markdown.show
+    stream.show
+    location.show
     STDOUT.puts "Document policy for references in user text: #{bold{@document_policy}}"
     if @voice.on?
       STDOUT.puts "Using voice #{bold{@current_voice}} to speak."

data/lib/ollama_chat/message_list.rb

@@ -128,10 +128,10 @@ class OllamaChat::MessageList
       n = n.to_i.clamp(1, Float::INFINITY)
       r = @messages.pop(2 * n)
       m = r.size / 2
-      STDOUT.puts "Popped the last #{m} exchanges."
+      STDOUT.puts "Dropped the last #{m} exchanges."
       m
     else
-      STDOUT.puts "No more exchanges you can pop."
+      STDOUT.puts "No more exchanges you can drop."
       0
     end
   end

data/lib/ollama_chat/source_fetching.rb

@@ -145,8 +145,7 @@ module OllamaChat::SourceFetching
     if l = @messages.at_location.full?
       query += " #{l}"
     end
-    n = n.to_i
-    n < 1 and n = 1
+    n = n.to_i.clamp(1..)
     query = URI.encode_uri_component(query)
     url = "https://www.duckduckgo.com/html/?q=#{query}"
     OllamaChat::Utils::Fetcher.get(url, debug: config.debug) do |tmp|

data/lib/ollama_chat/switches.rb

@@ -51,6 +51,16 @@ module OllamaChat::Switches
 
   attr_reader :markdown
 
+  attr_reader :stream
+
+  attr_reader :voice
+
+  attr_reader :embedding
+
+  attr_reader :embedding_enabled
+
+  attr_reader :embedding_paused
+
   attr_reader :location
 
   def setup_switches(config)

data/lib/ollama_chat/version.rb

@@ -1,6 +1,6 @@
 module OllamaChat
   # OllamaChat version
-  VERSION         = '0.0.0'
+  VERSION         = '0.0.1'
   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,19 +1,19 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama_chat 0.0.0 ruby lib
+# stub: ollama_chat 0.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama_chat".freeze
-  s.version = "0.0.0".freeze
+  s.version = "0.0.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2025-01-29"
+  s.date = "2025-02-02"
   s.description = "The app provides a command-line interface (CLI) to an Ollama AI model,\nallowing users to engage in text-based conversations and generate\nhuman-like responses. Users can import data from local files or web pages,\nwhich are then processed through three different modes: fully importing the\ncontent into the conversation context, summarizing the information for\nconcise reference, or storing it in an embedding vector database for later\nretrieval based on the conversation.\n".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["ollama_chat".freeze]
   s.extra_rdoc_files = ["README.md".freeze, "lib/ollama_chat.rb".freeze, "lib/ollama_chat/chat.rb".freeze, "lib/ollama_chat/clipboard.rb".freeze, "lib/ollama_chat/dialog.rb".freeze, "lib/ollama_chat/document_cache.rb".freeze, "lib/ollama_chat/follow_chat.rb".freeze, "lib/ollama_chat/information.rb".freeze, "lib/ollama_chat/message_list.rb".freeze, "lib/ollama_chat/message_type.rb".freeze, "lib/ollama_chat/model_handling.rb".freeze, "lib/ollama_chat/ollama_chat_config.rb".freeze, "lib/ollama_chat/parsing.rb".freeze, "lib/ollama_chat/source_fetching.rb".freeze, "lib/ollama_chat/switches.rb".freeze, "lib/ollama_chat/utils.rb".freeze, "lib/ollama_chat/utils/cache_fetcher.rb".freeze, "lib/ollama_chat/utils/chooser.rb".freeze, "lib/ollama_chat/utils/fetcher.rb".freeze, "lib/ollama_chat/utils/file_argument.rb".freeze, "lib/ollama_chat/version.rb".freeze]
-  s.files = [".all_images.yml".freeze, ".gitignore".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/ollama_chat".freeze, "lib/ollama_chat.rb".freeze, "lib/ollama_chat/chat.rb".freeze, "lib/ollama_chat/clipboard.rb".freeze, "lib/ollama_chat/dialog.rb".freeze, "lib/ollama_chat/document_cache.rb".freeze, "lib/ollama_chat/follow_chat.rb".freeze, "lib/ollama_chat/information.rb".freeze, "lib/ollama_chat/message_list.rb".freeze, "lib/ollama_chat/message_type.rb".freeze, "lib/ollama_chat/model_handling.rb".freeze, "lib/ollama_chat/ollama_chat_config.rb".freeze, "lib/ollama_chat/parsing.rb".freeze, "lib/ollama_chat/source_fetching.rb".freeze, "lib/ollama_chat/switches.rb".freeze, "lib/ollama_chat/utils.rb".freeze, "lib/ollama_chat/utils/cache_fetcher.rb".freeze, "lib/ollama_chat/utils/chooser.rb".freeze, "lib/ollama_chat/utils/fetcher.rb".freeze, "lib/ollama_chat/utils/file_argument.rb".freeze, "lib/ollama_chat/version.rb".freeze, "ollama_chat.gemspec".freeze, "spec/assets/api_show.json".freeze, "spec/assets/api_tags.json".freeze, "spec/assets/conversation.json".freeze, "spec/assets/duckduckgo.html".freeze, "spec/assets/example.atom".freeze, "spec/assets/example.csv".freeze, "spec/assets/example.html".freeze, "spec/assets/example.pdf".freeze, "spec/assets/example.ps".freeze, "spec/assets/example.rb".freeze, "spec/assets/example.rss".freeze, "spec/assets/example.xml".freeze, "spec/assets/kitten.jpg".freeze, "spec/assets/prompt.txt".freeze, "spec/ollama_chat/chat_spec.rb".freeze, "spec/ollama_chat/clipboard_spec.rb".freeze, "spec/ollama_chat/follow_chat_spec.rb".freeze, "spec/ollama_chat/information_spec.rb".freeze, "spec/ollama_chat/message_list_spec.rb".freeze, "spec/ollama_chat/model_handling_spec.rb".freeze, "spec/ollama_chat/parsing_spec.rb".freeze, "spec/ollama_chat/source_fetching_spec.rb".freeze, "spec/ollama_chat/switches_spec.rb".freeze, "spec/ollama_chat/utils/cache_fetcher_spec.rb".freeze, "spec/ollama_chat/utils/fetcher_spec.rb".freeze, "spec/ollama_chat/utils/file_argument_spec.rb".freeze, "spec/spec_helper.rb".freeze, "tmp/.keep".freeze]
+  s.files = [".all_images.yml".freeze, ".envrc".freeze, ".gitignore".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/ollama_chat".freeze, "docker-compose.yml".freeze, "lib/ollama_chat.rb".freeze, "lib/ollama_chat/chat.rb".freeze, "lib/ollama_chat/clipboard.rb".freeze, "lib/ollama_chat/dialog.rb".freeze, "lib/ollama_chat/document_cache.rb".freeze, "lib/ollama_chat/follow_chat.rb".freeze, "lib/ollama_chat/information.rb".freeze, "lib/ollama_chat/message_list.rb".freeze, "lib/ollama_chat/message_type.rb".freeze, "lib/ollama_chat/model_handling.rb".freeze, "lib/ollama_chat/ollama_chat_config.rb".freeze, "lib/ollama_chat/parsing.rb".freeze, "lib/ollama_chat/source_fetching.rb".freeze, "lib/ollama_chat/switches.rb".freeze, "lib/ollama_chat/utils.rb".freeze, "lib/ollama_chat/utils/cache_fetcher.rb".freeze, "lib/ollama_chat/utils/chooser.rb".freeze, "lib/ollama_chat/utils/fetcher.rb".freeze, "lib/ollama_chat/utils/file_argument.rb".freeze, "lib/ollama_chat/version.rb".freeze, "ollama_chat.gemspec".freeze, "redis/redis.conf".freeze, "spec/assets/api_show.json".freeze, "spec/assets/api_tags.json".freeze, "spec/assets/conversation.json".freeze, "spec/assets/duckduckgo.html".freeze, "spec/assets/example.atom".freeze, "spec/assets/example.csv".freeze, "spec/assets/example.html".freeze, "spec/assets/example.pdf".freeze, "spec/assets/example.ps".freeze, "spec/assets/example.rb".freeze, "spec/assets/example.rss".freeze, "spec/assets/example.xml".freeze, "spec/assets/kitten.jpg".freeze, "spec/assets/prompt.txt".freeze, "spec/ollama_chat/chat_spec.rb".freeze, "spec/ollama_chat/clipboard_spec.rb".freeze, "spec/ollama_chat/follow_chat_spec.rb".freeze, "spec/ollama_chat/information_spec.rb".freeze, "spec/ollama_chat/message_list_spec.rb".freeze, "spec/ollama_chat/model_handling_spec.rb".freeze, "spec/ollama_chat/parsing_spec.rb".freeze, "spec/ollama_chat/source_fetching_spec.rb".freeze, "spec/ollama_chat/switches_spec.rb".freeze, "spec/ollama_chat/utils/cache_fetcher_spec.rb".freeze, "spec/ollama_chat/utils/fetcher_spec.rb".freeze, "spec/ollama_chat/utils/file_argument_spec.rb".freeze, "spec/spec_helper.rb".freeze, "tmp/.keep".freeze]
   s.homepage = "https://github.com/flori/ollama_chat".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "OllamaChat - A command-line interface (CLI) for interacting with an Ollama AI model.".freeze, "--main".freeze, "README.md".freeze]

data/redis/redis.conf

@@ -0,0 +1,5 @@
+save 60 1000
+dbfilename dump.rdb
+appendonly yes
+appendfilename "appendonly.aof"
+appendfsync always

data/spec/ollama_chat/chat_spec.rb

@@ -48,7 +48,7 @@ RSpec.describe OllamaChat::Chat do
 
       it 'Adds documents passed to app via -D option' do
         expect_any_instance_of(OllamaChat::Chat).to receive(:add_documents_from_argv).
-          with(kind_of(Documentrix::Documents), [ asset('example.html') ])
+          with([ asset('example.html') ])
         chat
       end
     end

data/spec/ollama_chat/follow_chat_spec.rb

@@ -7,8 +7,12 @@ RSpec.describe OllamaChat::FollowChat do
     ]
   end
 
+  let :chat do
+    double('Chat', markdown: double(on?: false))
+  end
+
   let :follow_chat do
-    described_class.new(messages:, output:)
+    described_class.new(chat:, messages:, output:)
   end
 
   let :output do

data/spec/ollama_chat/switches_spec.rb

@@ -18,7 +18,6 @@ RSpec.describe OllamaChat::Switches do
         double(test?: false)
       end
 
-
       it 'can be switched on' do
         expect {
           switch.set(true)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ollama_chat
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Florian Frank
 bindir: bin
 cert_chain: []
-date: 2025-01-29 00:00:00.000000000 Z
+date: 2025-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -379,12 +379,15 @@ extra_rdoc_files:
 - lib/ollama_chat/version.rb
 files:
 - ".all_images.yml"
+- ".envrc"
 - ".gitignore"
+- CHANGES.md
 - Gemfile
 - README.md
 - Rakefile
 - VERSION
 - bin/ollama_chat
+- docker-compose.yml
 - lib/ollama_chat.rb
 - lib/ollama_chat/chat.rb
 - lib/ollama_chat/clipboard.rb
@@ -406,6 +409,7 @@ files:
 - lib/ollama_chat/utils/file_argument.rb
 - lib/ollama_chat/version.rb
 - ollama_chat.gemspec
+- redis/redis.conf
 - spec/assets/api_show.json
 - spec/assets/api_tags.json
 - spec/assets/conversation.json