documentrix 0.0.4 → 0.1.0

data/spec/spec_helper.rb

@@ -1,9 +1,5 @@
-if ENV['START_SIMPLECOV'].to_i == 1
-  require 'simplecov'
-  SimpleCov.start do
-    add_filter "#{File.basename(File.dirname(__FILE__))}/"
-  end
-end
+require 'gem_hadar/simplecov'
+GemHadar::SimpleCov.start
 require 'rspec'
 require 'tins/xt/expose'
 begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: documentrix
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Florian Frank
@@ -13,30 +13,30 @@ dependencies:
   name: gem_hadar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 2.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 2.17.0
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -246,7 +246,6 @@ extra_rdoc_files:
 - lib/documentrix/documents/cache/common.rb
 - lib/documentrix/documents/cache/memory_cache.rb
 - lib/documentrix/documents/cache/records.rb
-- lib/documentrix/documents/cache/redis_backed_memory_cache.rb
 - lib/documentrix/documents/cache/redis_cache.rb
 - lib/documentrix/documents/cache/sqlite_cache.rb
 - lib/documentrix/documents/splitters/character.rb
@@ -258,6 +257,7 @@ extra_rdoc_files:
 - lib/documentrix/version.rb
 files:
 - ".envrc"
+- ".utilsrc"
 - ".yardopts"
 - CHANGES.md
 - Gemfile
@@ -271,7 +271,6 @@ files:
 - lib/documentrix/documents/cache/common.rb
 - lib/documentrix/documents/cache/memory_cache.rb
 - lib/documentrix/documents/cache/records.rb
-- lib/documentrix/documents/cache/redis_backed_memory_cache.rb
 - lib/documentrix/documents/cache/redis_cache.rb
 - lib/documentrix/documents/cache/sqlite_cache.rb
 - lib/documentrix/documents/splitters/character.rb
@@ -283,8 +282,8 @@ files:
 - lib/documentrix/version.rb
 - redis/redis.conf
 - spec/assets/embeddings.json
+- spec/documentrix/documents/cache/interface_spec.rb
 - spec/documentrix/documents/cache/memory_cache_spec.rb
-- spec/documentrix/documents/cache/redis_backed_memory_cache_spec.rb
 - spec/documentrix/documents/cache/redis_cache_spec.rb
 - spec/documentrix/documents/cache/sqlite_cache_spec.rb
 - spec/documentrix/documents/splitters/character_spec.rb
@@ -315,12 +314,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.2
+rubygems_version: 4.0.8
 specification_version: 4
 summary: Ruby library for embedding vector database
 test_files:
+- spec/documentrix/documents/cache/interface_spec.rb
 - spec/documentrix/documents/cache/memory_cache_spec.rb
-- spec/documentrix/documents/cache/redis_backed_memory_cache_spec.rb
 - spec/documentrix/documents/cache/redis_cache_spec.rb
 - spec/documentrix/documents/cache/sqlite_cache_spec.rb
 - spec/documentrix/documents/splitters/character_spec.rb

data/lib/documentrix/documents/cache/redis_backed_memory_cache.rb

@@ -1,64 +0,0 @@
-require 'redis'
-
-class Documentrix::Documents
-  class RedisBackedMemoryCache < MemoryCache
-
-    # The initialize method sets up the RedisBackedMemoryCache cache by
-    # creating a new instance and populating it with data from the internally
-    # created RedisCache.
-    #
-    # @param prefix [String] The prefix for keys in the Redis cache
-    # @param url [String] The URL of the Redis server (default: ENV['REDIS_URL'])
-    # @param object_class [Class] The class to use for deserializing values from Redis (default: nil)
-    #
-    # @raise [ArgumentError] If the redis_url environment variable is not set
-    def initialize(prefix:, url: ENV['REDIS_URL'], object_class: nil)
-      super(prefix:)
-      url or raise ArgumentError, 'require redis url'
-      @url, @object_class = url, object_class
-      @redis_cache = Documentrix::Documents::RedisCache.new(prefix:, url:, object_class:)
-      @redis_cache.extend(Documentrix::Documents::Cache::Records::RedisFullEach)
-      @redis_cache.full_each { |key, value| @data[key] = value }
-    end
-
-    attr_reader :object_class # the class of objects stored in the cache
-
-    # The redis method returns the Redis client instance used by the cache.
-    #
-    # @return [Redis] The Redis client instance
-    def redis
-      @redis_cache.redis
-    end
-
-    # The set method sets the value for a given key in memory and in Redis.
-    #
-    # @param [String] key the key to be set
-    # @param [Hash] value the hash containing the data to be stored
-    def []=(key, value)
-      super
-      redis.set(pre(key), JSON(value))
-    end
-
-    # The delete method removes a key from the cache by calling Redis's del
-    # method and then calling the superclass's delete method.
-    #
-    # @param [String] key the key to be deleted
-    #
-    # @return [FalseClass, TrueClass] true if the key was successfully deleted, false otherwise.
-    def delete(key)
-      result = redis.del(pre(key))
-      super && result == 1
-    end
-
-    # The clear method deletes all keys from the cache by scanning redis for
-    # keys that match the prefix `prefix` and then deleting them, then it does
-    # the same for the MemoryCache by calling its super.
-    #
-    # @return [self] self
-    def clear
-      redis.scan_each(match: "#@prefix*") { |key| redis.del(key) }
-      super
-      self
-    end
-  end
-end

data/spec/documentrix/documents/cache/redis_backed_memory_cache_spec.rb

@@ -1,121 +0,0 @@
-require 'spec_helper'
-
-describe Documentrix::Documents::RedisBackedMemoryCache do
-  let :prefix do
-    'test-'
-  end
-
-  let :cache do
-    described_class.new prefix: 'test-', url: 'something'
-  end
-
-  it 'raises ArgumentError if url is missing' do
-    expect {
-      described_class.new prefix:, url: nil
-    }.to raise_error ArgumentError
-  end
-
-  context 'test redis interactions' do
-    let :data do
-      cache.instance_eval { @data }
-    end
-
-    let :redis_cache do
-      cache.instance_eval { @redis_cache }
-    end
-
-    let :redis do
-      double('Redis')
-    end
-
-    before do
-      allow_any_instance_of(Documentrix::Documents::RedisCache).to\
-        receive(:redis).and_return(redis)
-      allow(redis).to receive(:scan_each)
-    end
-
-    it 'can be instantiated and initialized' do
-      expect(cache).to be_a described_class
-    end
-
-    it 'defaults to nil object_class' do
-      expect(cache.object_class).to be_nil
-    end
-
-    it 'can be configured with object_class' do
-      object_class = Class.new(JSON::GenericObject)
-      cache = described_class.new(prefix: 'test-', url: 'something', object_class:)
-      expect(cache.object_class).to eq object_class
-    end
-
-    it 'has Redis client' do
-      expect(cache.redis).to eq redis
-    end
-
-    it 'can get a key' do
-      key = 'foo'
-      expect(data).to receive(:[]).with('test-' + key).and_return 666
-      expect(cache[key]).to eq 666
-    end
-
-    it 'can set a value for a key' do
-      key, value = 'foo', { test: true }
-      expect(data).to receive(:[]=).with('test-' + key, { test: true }).and_call_original
-      expect(redis).to receive(:set).with('test-' + key, JSON(value))
-      cache[key] = value
-    end
-
-    it 'can determine if key exists' do
-      key = 'foo'
-      expect(data).to receive(:key?).with('test-' + key).and_return(false, true)
-      expect(cache.key?('foo')).to eq false
-      expect(cache.key?('foo')).to eq true
-    end
-
-    it 'can delete' do
-      key = 'foo'
-      expect(data).to receive(:delete).with('test-' + key).and_return 'bar'
-      expect(redis).to receive(:del).with('test-' + key).and_return 1
-      expect(cache.delete(key)).to eq true
-      expect(data).to receive(:delete).with('test-' + key).and_return nil
-      expect(redis).to receive(:del).with(prefix + key).and_return 0
-      expect(cache.delete(key)).to eq false
-    end
-
-    it 'can iterate over keys, values' do
-      key, value = 'foo', { 'test' => true }
-      expect(redis).to receive(:set).with('test-' + key, JSON(value))
-      cache[key] = value
-      cache.each do |k, v|
-        expect(k).to eq prefix + key
-        expect(v).to eq value
-      end
-    end
-
-    it 'returns size' do
-      expect(cache).to receive(:count).and_return 3
-      expect(cache.size).to eq 3
-    end
-
-    it 'can clear' do
-      expect(redis).to receive(:scan_each).with(match: 'test-*').and_yield(
-        'test-foo'
-      )
-      expect(redis).to receive(:del).with('test-foo')
-      expect(cache.clear).to eq cache
-    end
-
-    it 'can iterate over keys under a prefix' do
-      data['test-foo'] = 'bar'
-      expect(cache.to_a).to eq [ %w[ test-foo bar ] ]
-    end
-
-    it 'can compute prefix with pre' do
-      expect(cache.pre('foo')).to eq 'test-foo'
-    end
-
-    it 'can remove prefix with unpre' do
-      expect(cache.unpre('test-foo')).to eq 'foo'
-    end
-  end
-end