documentrix 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7987ac709860e4747aec91c9d99b766e1b959b40142ebb17a3516aa80a0f6b85
-  data.tar.gz: a9ea8a8f360bef62ad687d1ecbcf04e6a978dc7450a76f26d97c6f04ee1bdf62
+  metadata.gz: 3adb452ed3a325dfd48b90e46fb3d75fc060f00e98c4faaa1e1e5646e3166651
+  data.tar.gz: 6328ec106db80374061e3ec96b8ece3b85da6c353d937178561518c4e50b42a8
 SHA512:
-  metadata.gz: ba03da2c50fffb014489ee3281765e1ad0712da263dae1a6f45d5f449aba345113f28c093c7d2df14986ad283aee6cbd88c8545c6a7dceaacadff405ad27f457
-  data.tar.gz: 3a10470a23349509a575e79ab1ca18b0969827ef7f720f745537de83924348109cb3fcbd4b7a4a9703daebb471489948ec26ba704362838ad41fa546bb0040f2
+  metadata.gz: 7cc0997fcaf8aeab5d3da01a6b6aecd7d90a89e869a4b5dd2f9e6874b7f5e94f62028a708b223eb7f4c69c0cab23ab5cd7aed416dbbe52e5c659ca13d67b3a19
+  data.tar.gz: 31b958b1bcd08ccfdfd178b826a05c28b8b3c86818ee29acb03021a1d8c5dfe865b48692e9024bd83ceb62292793baa748c3dcfb56d26bd10968113015c477fa

data/.envrc

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

data/CHANGES.md

@@ -0,0 +1,29 @@
+# Changes
+
+## 2025-05-26 v0.0.2
+
+* Documentrix::Utils::Tags enhancements for improved tagging functionality:
+  * Added `valid_tag` parameter to `initialize` method with default value.
+  * Introduced `DEFAULT_VALID_TAG` regular expression constant.
+  * Updated `initialize` and `add` methods to use new `valid_tag` parameter.
+  * Added `attr_reader` for `valid_tag`.
+* Added `describe` block for `Tag` in `tags_spec.rb`.
+  * Added three `it` blocks to test instantiation, default tag value trimming, and custom regex usage.
+* Update `.envrc` file to include Redis connection settings:
+  * Added `REDIS_URL` environment variable with value `redis://localhost:9736`
+  * Created new `.envrc` file in the root directory.
+
+## 2025-01-29 v0.0.1
+
+* Added docker-compose redis
+    * Added a `services` section to `docker-compose.yml`
+    * Created Redis service with image `valkey/valkey:*7.2.8-alpine*` and specified ports
+    * Configured Redis volumes, including mounting a Redis config file (`./redis/redis.conf`)
+    * Created new file `redis/redis.conf` with Redis configuration settings
+* Added support for **Ruby 3.4** to the Docker image
+* Added copyright notice and permissions to `LICENSE` file
+* Remove double quotes from `summary` field
+
+## 2024-12-06 v0.0.0
+
+  * Start

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright Florian Frank
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -8,7 +8,7 @@ GemHadar do
   author      'Florian Frank'
   email       'flori@ping.de'
   homepage    "https://github.com/flori/#{name}"
-  summary     '"Ruby library for embedding vector database'
+  summary     'Ruby library for embedding vector database'
   description <<~EOT
     The Ruby library, Documentrix, is designed to provide a way to build and
     query vector databases for applications in natural language processing
@@ -26,7 +26,7 @@ GemHadar do
 
   required_ruby_version  '~> 3.1'
 
-  dependency 'infobar',       '~> 0.8'
+  dependency 'infobar',       '~> 0.9'
   dependency 'json',          '~> 2.0'
   dependency 'tins',          '~> 1.34'
   dependency 'sqlite-vec',    '~> 0.0'

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/documentrix.gemspec

@@ -1,35 +1,35 @@
 # -*- encoding: utf-8 -*-
-# stub: documentrix 0.0.0 ruby lib
+# stub: documentrix 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "documentrix".freeze
-  s.version = "0.0.0".freeze
+  s.version = "0.0.2".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 = "2024-12-06"
+  s.date = "1980-01-02"
   s.description = "The Ruby library, Documentrix, is designed to provide a way to build and\nquery vector databases for applications in natural language processing\n(NLP) and large language models (LLMs). It allows users to store and\nretrieve dense vector embeddings for text strings.\n".freeze
   s.email = "flori@ping.de".freeze
   s.extra_rdoc_files = ["README.md".freeze, "lib/documentrix.rb".freeze, "lib/documentrix/documents.rb".freeze, "lib/documentrix/documents/cache/common.rb".freeze, "lib/documentrix/documents/cache/memory_cache.rb".freeze, "lib/documentrix/documents/cache/records.rb".freeze, "lib/documentrix/documents/cache/redis_backed_memory_cache.rb".freeze, "lib/documentrix/documents/cache/redis_cache.rb".freeze, "lib/documentrix/documents/cache/sqlite_cache.rb".freeze, "lib/documentrix/documents/splitters/character.rb".freeze, "lib/documentrix/documents/splitters/semantic.rb".freeze, "lib/documentrix/utils.rb".freeze, "lib/documentrix/utils/colorize_texts.rb".freeze, "lib/documentrix/utils/math.rb".freeze, "lib/documentrix/utils/tags.rb".freeze, "lib/documentrix/version.rb".freeze]
-  s.files = [".yardopts".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "documentrix.gemspec".freeze, "lib/documentrix.rb".freeze, "lib/documentrix/documents.rb".freeze, "lib/documentrix/documents/cache/common.rb".freeze, "lib/documentrix/documents/cache/memory_cache.rb".freeze, "lib/documentrix/documents/cache/records.rb".freeze, "lib/documentrix/documents/cache/redis_backed_memory_cache.rb".freeze, "lib/documentrix/documents/cache/redis_cache.rb".freeze, "lib/documentrix/documents/cache/sqlite_cache.rb".freeze, "lib/documentrix/documents/splitters/character.rb".freeze, "lib/documentrix/documents/splitters/semantic.rb".freeze, "lib/documentrix/utils.rb".freeze, "lib/documentrix/utils/colorize_texts.rb".freeze, "lib/documentrix/utils/math.rb".freeze, "lib/documentrix/utils/tags.rb".freeze, "lib/documentrix/version.rb".freeze, "spec/assets/embeddings.json".freeze, "spec/documentrix/documents/cache/memory_cache_spec.rb".freeze, "spec/documentrix/documents/cache/redis_backed_memory_cache_spec.rb".freeze, "spec/documentrix/documents/cache/redis_cache_spec.rb".freeze, "spec/documentrix/documents/cache/sqlite_cache_spec.rb".freeze, "spec/documentrix/documents/splitters/character_spec.rb".freeze, "spec/documentrix/documents/splitters/semantic_spec.rb".freeze, "spec/documents_spec.rb".freeze, "spec/spec_helper.rb".freeze, "spec/utils/colorize_texts_spec.rb".freeze, "spec/utils/tags_spec.rb".freeze]
+  s.files = [".envrc".freeze, ".yardopts".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "docker-compose.yml".freeze, "documentrix.gemspec".freeze, "lib/documentrix.rb".freeze, "lib/documentrix/documents.rb".freeze, "lib/documentrix/documents/cache/common.rb".freeze, "lib/documentrix/documents/cache/memory_cache.rb".freeze, "lib/documentrix/documents/cache/records.rb".freeze, "lib/documentrix/documents/cache/redis_backed_memory_cache.rb".freeze, "lib/documentrix/documents/cache/redis_cache.rb".freeze, "lib/documentrix/documents/cache/sqlite_cache.rb".freeze, "lib/documentrix/documents/splitters/character.rb".freeze, "lib/documentrix/documents/splitters/semantic.rb".freeze, "lib/documentrix/utils.rb".freeze, "lib/documentrix/utils/colorize_texts.rb".freeze, "lib/documentrix/utils/math.rb".freeze, "lib/documentrix/utils/tags.rb".freeze, "lib/documentrix/version.rb".freeze, "redis/redis.conf".freeze, "spec/assets/embeddings.json".freeze, "spec/documentrix/documents/cache/memory_cache_spec.rb".freeze, "spec/documentrix/documents/cache/redis_backed_memory_cache_spec.rb".freeze, "spec/documentrix/documents/cache/redis_cache_spec.rb".freeze, "spec/documentrix/documents/cache/sqlite_cache_spec.rb".freeze, "spec/documentrix/documents/splitters/character_spec.rb".freeze, "spec/documentrix/documents/splitters/semantic_spec.rb".freeze, "spec/documents_spec.rb".freeze, "spec/spec_helper.rb".freeze, "spec/utils/colorize_texts_spec.rb".freeze, "spec/utils/tags_spec.rb".freeze]
   s.homepage = "https://github.com/flori/documentrix".freeze
   s.licenses = ["MIT".freeze]
-  s.rdoc_options = ["--title".freeze, "Documentrix - \"Ruby library for embedding vector database".freeze, "--main".freeze, "README.md".freeze]
+  s.rdoc_options = ["--title".freeze, "Documentrix - Ruby library for embedding vector database".freeze, "--main".freeze, "README.md".freeze]
   s.required_ruby_version = Gem::Requirement.new("~> 3.1".freeze)
-  s.rubygems_version = "3.5.23".freeze
-  s.summary = "\"Ruby library for embedding vector database".freeze
+  s.rubygems_version = "3.6.7".freeze
+  s.summary = "Ruby library for embedding vector database".freeze
   s.test_files = ["spec/documentrix/documents/cache/memory_cache_spec.rb".freeze, "spec/documentrix/documents/cache/redis_backed_memory_cache_spec.rb".freeze, "spec/documentrix/documents/cache/redis_cache_spec.rb".freeze, "spec/documentrix/documents/cache/sqlite_cache_spec.rb".freeze, "spec/documentrix/documents/splitters/character_spec.rb".freeze, "spec/documentrix/documents/splitters/semantic_spec.rb".freeze, "spec/documents_spec.rb".freeze, "spec/spec_helper.rb".freeze, "spec/utils/colorize_texts_spec.rb".freeze, "spec/utils/tags_spec.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.19".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.20".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])
   s.add_development_dependency(%q<debug>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
-  s.add_runtime_dependency(%q<infobar>.freeze, ["~> 0.8".freeze])
+  s.add_runtime_dependency(%q<infobar>.freeze, ["~> 0.9".freeze])
   s.add_runtime_dependency(%q<json>.freeze, ["~> 2.0".freeze])
   s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.34".freeze])
   s.add_runtime_dependency(%q<sqlite-vec>.freeze, ["~> 0.0".freeze])

data/lib/documentrix/utils/tags.rb

@@ -1,6 +1,10 @@
 require 'term/ansicolor'
 
 class Documentrix::Utils::Tags
+  # Matches tags with optional leading # characters and at least one non-space
+  # character by default:
+  DEFAULT_VALID_TAG = /\A#*(\S+)/
+
   class Tag < String
     include Term::ANSIColor
 
@@ -9,13 +13,15 @@ class Documentrix::Utils::Tags
     #
     # @param tag [String] the string representation of the tag
     # @param source [String, nil] the source URL for the tag (default: nil)
-    def initialize(tag, source: nil)
-      super(tag.to_s.gsub(/\A#+/, ''))
+    def initialize(tag, valid_tag: DEFAULT_VALID_TAG, source: nil)
+      super(tag.to_s[valid_tag, 1])
       self.source = source
     end
 
     attr_accessor :source # the source URL for the tag
 
+    attr_reader :valid_tag # the regular expression capturing a valid tag's content
+
     # The to_s method formats the tag string for output, including source URL
     # if requested.
     #
@@ -46,15 +52,18 @@ class Documentrix::Utils::Tags
   #   Documentrix::Utils::Tags.new(%w[ foo bar ])
   #
   # @return [Documentrix::Utils::Tags] an instance of Documentrix::Utils::Tags
-  def initialize(tags = [], source: nil)
-    tags = Array(tags)
-    @set = []
+  def initialize(tags = [], valid_tag: DEFAULT_VALID_TAG, source: nil)
+    tags       = Array(tags)
+    @valid_tag = valid_tag
+    @set       = []
     tags.each { |tag| add(tag, source:) }
   end
 
+  attr_reader :valid_tag # the regular expression capturing a valid tag's content
+
   def add(tag, source: nil)
     unless tag.is_a?(Tag)
-      tag = Tag.new(tag, source:)
+      tag = Tag.new(tag, valid_tag:, source:)
     end
     index = @set.bsearch_index { _1 >= tag }
     if index == nil

data/lib/documentrix/version.rb

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

data/redis/redis.conf

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

data/spec/utils/tags_spec.rb

@@ -50,4 +50,19 @@ RSpec.describe Documentrix::Utils::Tags do
       "\e]8;;file:///path/to/bar.html\e\\#bar\e]8;;\e\\ \e]8;;https://foo.example.com\e\\#foo\e]8;;\e\\"
     )
   end
+
+  describe described_class::Tag do
+    it 'can be instantiated' do
+      expect(described_class.new('#foo')).to be_a described_class
+    end
+
+    it 'can cannot contain a space by default' do
+      expect(described_class.new('#foo bar')).to eq 'foo'
+    end
+
+    it 'can cannot use a custom regular expression for capturing the tag value' do
+      valid_tag = /\A#*([\w\]\[]+)/
+      expect(described_class.new('#foo[bar]!!!!', valid_tag:)).to eq 'foo[bar]'
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: documentrix
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - Florian Frank
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +99,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -258,10 +257,14 @@ extra_rdoc_files:
 - lib/documentrix/utils/tags.rb
 - lib/documentrix/version.rb
 files:
+- ".envrc"
 - ".yardopts"
+- CHANGES.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
+- docker-compose.yml
 - documentrix.gemspec
 - lib/documentrix.rb
 - lib/documentrix/documents.rb
@@ -278,6 +281,7 @@ files:
 - lib/documentrix/utils/math.rb
 - lib/documentrix/utils/tags.rb
 - lib/documentrix/version.rb
+- redis/redis.conf
 - spec/assets/embeddings.json
 - spec/documentrix/documents/cache/memory_cache_spec.rb
 - spec/documentrix/documents/cache/redis_backed_memory_cache_spec.rb
@@ -293,10 +297,9 @@ homepage: https://github.com/flori/documentrix
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--title"
-- Documentrix - "Ruby library for embedding vector database
+- Documentrix - Ruby library for embedding vector database
 - "--main"
 - README.md
 require_paths:
@@ -312,10 +315,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
-summary: "\"Ruby library for embedding vector database"
+summary: Ruby library for embedding vector database
 test_files:
 - spec/documentrix/documents/cache/memory_cache_spec.rb
 - spec/documentrix/documents/cache/redis_backed_memory_cache_spec.rb