couch_potato 1.13.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36fc0534a7564b1fcf3b2a59ca91e3e4e97452c2a74d77e30540eb4b7617211
-  data.tar.gz: b1583818a743459e8ab86d88350f7ad5c6953c058c3b49c8b90da50610bdd197
+  metadata.gz: ffcaae6b2815d237b48cc3e4ad553f66920fe4df2c84c59ae38177260949ba6b
+  data.tar.gz: bd266a1033fa83fcba822a19e3de86b2c1aac2d80ba2dd1d3aef0920d4819d8f
 SHA512:
-  metadata.gz: ceffb27b13b2cf9825cd5fcf507bb0e13a6ed9b5caa612fd1f5f27ba98934eb9dae34c4f4dc70835352a9176bc4562e49da12d489b925ebbeb37a3c9eaa964f4
-  data.tar.gz: c5e01a2d0d83ea11b14a618f218fe3ff66af35be893a4d74644089938b852045c52a8e1d8ecf31b53e70396737f9db0a8849ef0fbacd843c89137ec4d8bfc0e2
+  metadata.gz: 16f3e1748e3b3314f1cf3d658fb175dd90c5e7c7cd717ab42477961c364bac527b262642a29f208c4aad200e9a31ce7470c0a538db8bf8d641e13da92f85debb
+  data.tar.gz: '089f1c9e5dc7238b659a4d1b2d0f3d341a084fe52f6d9c2d058ea8440f197f7d64b6f5a9d78c8cebbd19b131aede038329ab6c0f79b503d220f1f20d2e7d8a20'

data/.gitignore

@@ -7,3 +7,4 @@ pkg
 
 .ruby-version
 .tool-versions
+.vscode/settings.json

data/CHANGES.md

@@ -1,5 +1,14 @@
 ## Changes
 
+# 1.15.0
+
+- cache loading multiple documents
+- keep the database cache when switching to another database and back to the original one
+
+# 1.14.0
+
+- add database_collection to models to help avoid n+1 requests
+
 # 1.13.0
 
 - add Ruby 3.2 support

data/lib/couch_potato/database.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/enumerable'
+
 module CouchPotato
   class Database
     class ValidationsFailedError < ::StandardError; end
@@ -143,7 +145,9 @@ module CouchPotato
     # returns nil if the single document could not be found. when passing an array and some documents
     # could not be found these are omitted from the returned array
     def load_document(id)
-      cached = cache && id.is_a?(String) && cache[id]
+      return load_documents(id) if id.is_a?(Array)
+      
+      cached = cache && cache[id]
       if cache
         if cached
           ActiveSupport::Notifications.instrument('couch_potato.load.cached') do
@@ -159,6 +163,23 @@ module CouchPotato
     end
     alias load load_document
 
+    def load_documents(ids)
+      return [] if ids.empty?
+
+      uncached_ids = ids - (cache&.keys || [])
+      uncached_docs_by_id = bulk_load(uncached_ids).index_by {|doc| doc.id if doc.respond_to?(:id) }
+      if cache
+        uncached_ids.each do |id|
+          doc = uncached_docs_by_id[id]
+          cache[id] = doc if doc
+        end
+      end
+      cached_docs_by_id = ActiveSupport::Notifications.instrument('couch_potato.load.cached') do
+        cache&.slice(*ids) || {}
+      end
+      ids.filter_map { |id| (cached_docs_by_id[id]) || uncached_docs_by_id[id] }
+    end
+
     # loads one or more documents by its id(s)
     # behaves like #load except it raises a CouchPotato::NotFound if any of the documents could not be found
     def load!(id)
@@ -176,6 +197,8 @@ module CouchPotato
     # returns the underlying CouchRest::Database instance
     attr_reader :couchrest_database
 
+    attr_accessor :switched_databases
+
     # returns a new database instance connected to the CouchDB database
     # with the given name. the name is passed through the
     # additional_databases configuration to resolve it to a database
@@ -183,21 +206,29 @@ module CouchPotato
     # if the current database has a cache, the new database will receive
     # a cleared copy of it.
     def switch_to(database_name)
-      resolved_database_name = CouchPotato.resolve_database_name(database_name)
-      self
+      self.switched_databases ||= {}
+      if (db = switched_databases[database_name || :default])
+        return db
+      end
+      switched_databases[name || :default] ||= self
+
+
+      resolved_database_name = CouchPotato.resolve_database_name(database_name) unless database_name == :default
+      couchrest_database = resolved_database_name ? CouchPotato.couchrest_database_for_name(resolved_database_name) : CouchPotato.couchrest_database
+      new_db = self
         .class
-        .new(CouchPotato.couchrest_database_for_name(resolved_database_name), name: database_name)
+        .new(couchrest_database, name: database_name == :default ? nil : database_name)
         .tap(&copy_clear_cache_proc)
+
+      new_db.switched_databases = switched_databases
+      new_db
     end
 
     # returns a new database instance connected to the default CouchDB database.
     # if the current database has a cache, the new database will receive
     # a cleared copy of it.
     def switch_to_default
-      self
-        .class
-        .new(CouchPotato.couchrest_database)
-        .tap(&copy_clear_cache_proc)
+      switch_to(:default)
     end
 
     private
@@ -224,6 +255,7 @@ module CouchPotato
       elsif processed_results.respond_to?(:each)
         processed_results.each do |document|
           document.database = self if document.respond_to?(:database=)
+          document.database_collection = processed_results if document.respond_to?(:database_collection=)
         end
       end
       processed_results
@@ -247,14 +279,10 @@ module CouchPotato
       raise "Can't load a document without an id (got nil)" if id.nil?
 
       ActiveSupport::Notifications.instrument('couch_potato.load') do
-        if id.is_a?(Array)
-          bulk_load id
-        else
-          instance = couchrest_database.get(id)
-          instance.database = self if instance
-          instance
-        end
-      end
+        instance = couchrest_database.get(id)
+        instance.database = self if instance
+        instance
+    end
     end
 
     def view_cache_id(spec)
@@ -293,10 +321,13 @@ module CouchPotato
     def bulk_load(ids)
       return [] if ids.empty?
 
-      response = couchrest_database.bulk_load ids
-      docs = response['rows'].map { |row| row['doc'] }.compact
-      docs.each do |doc|
-        doc.database = self if doc.respond_to?(:database=)
+      ActiveSupport::Notifications.instrument('couch_potato.load') do
+        response = couchrest_database.bulk_load ids
+        docs = response['rows'].map { |row| row['doc'] }.compact
+        docs.each do |doc|
+          doc.database = self if doc.respond_to?(:database=)
+          doc.database_collection = docs if doc.respond_to?(:database_collection=)
+        end
       end
     end
 

data/lib/couch_potato/persistence.rb

@@ -27,7 +27,7 @@ module CouchPotato
         ForbiddenAttributesProtection, Revisions
       base.send :include, Validation
       base.class_eval do
-        attr_accessor :_id, :_rev, :_deleted, :database
+        attr_accessor :_id, :_rev, :_deleted, :database, :database_collection
         alias_method :id, :_id
         alias_method :id=, :_id=
 

data/lib/couch_potato/version.rb

@@ -1,4 +1,4 @@
 module CouchPotato
-  VERSION = '1.13.0'.freeze
+  VERSION = '1.15.0'.freeze
   RSPEC_VERSION = '4.1.0'.freeze
 end

data/lib/couch_potato/view/flex_view_spec.rb

@@ -73,9 +73,11 @@ module CouchPotato
         end
 
         def docs
+          all_docs = rows.map { |r| r['doc'] }
           rows.map do |row|
             doc = row['doc']
             doc.database = database if doc.respond_to?(:database=)
+            doc.database_collection = all_docs if doc.respond_to?(:database_collection=)
             doc
           end
         end

data/lib/couch_potato.rb

@@ -54,7 +54,7 @@ module CouchPotato
   def self.use(database_name)
     resolved_database_name = resolve_database_name(database_name)
     Thread.current[:__couch_potato_databases] ||= {}
-    Thread.current[:__couch_potato_databases][resolved_database_name] ||= Database.new(couchrest_database_for_name!(resolved_database_name), name: database_name)
+    Thread.current[:__couch_potato_databases][resolved_database_name] ||= Database.new(couchrest_database_for_name(resolved_database_name), name: database_name)
   end
 
   # resolves a name to a database name/full url configured under additional databases

data/spec/create_spec.rb

@@ -34,14 +34,24 @@ describe "create" do
   end
 
   describe "multi-db" do
-    TEST_DBS = ['comment_a', 'comment_b', 'comment_c']
+    let(:test_dbs) do 
+      ['comment_a', 'comment_b', 'comment_c'].map do |name|
+        if ENV['DATABASE']
+          uri = URI.parse(ENV['DATABASE'])
+          uri.path  = "/#{name}"
+          uri.to_s
+        else
+          name
+        end
+      end
+    end
 
     before(:each) do
-      TEST_DBS.each { |db_name| CouchPotato.couchrest_database_for_name(db_name).recreate! }
+      test_dbs.each { |db_name| CouchPotato.couchrest_database_for_name(db_name).recreate! }
     end
 
     it "should create documents in multiple dbs" do
-      TEST_DBS.each do |db_name|
+      test_dbs.each do |db_name|
         @comment = Comment.new(:title => 'my_title')
         CouchPotato.with_database(db_name) do |couch|
           couch.save_document! @comment

data/spec/unit/caching_spec.rb

@@ -18,41 +18,92 @@ RSpec.describe 'database caching' do
     {}
   end
 
-  it 'gets an object from the cache the 2nd time via #load_documemt' do
-    expect(couchrest_db).to receive(:get).with('1').exactly(1).times
+  context 'for a single document' do
+    it 'gets an object from the cache the 2nd time via #load_documemt' do
+      expect(couchrest_db).to receive(:get).with('1').exactly(1).times
 
-    db.load_document '1'
-    db.load_document '1'
-  end
+      db.load_document '1'
+      db.load_document '1'
+    end
 
-  it 'gets an object from the cache the 2nd time via #load' do
-    expect(couchrest_db).to receive(:get).with('1').exactly(1).times
+    it 'gets an object from the cache the 2nd time via #load' do
+      expect(couchrest_db).to receive(:get).with('1').exactly(1).times
 
-    db.load '1'
-    db.load '1'
-  end
+      db.load '1'
+      db.load '1'
+    end
 
-  it 'gets an object from the cache the 2nd time via #load!' do
-    expect(couchrest_db).to receive(:get).with('1').exactly(1).times
+    it 'gets an object from the cache the 2nd time via #load!' do
+      expect(couchrest_db).to receive(:get).with('1').exactly(1).times
 
-    db.load! '1'
-    db.load! '1'
-  end
+      db.load! '1'
+      db.load! '1'
+    end
 
-  it 'returns the correct object' do
-    doc = double(:doc, 'database=': nil)
-    allow(couchrest_db).to receive_messages(get: doc)
+    it 'returns the correct object' do
+      doc = double(:doc, 'database=': nil)
+      allow(couchrest_db).to receive_messages(get: doc)
 
-    db.load_document '1'
-    expect(db.load_document('1')).to eql(doc)
+      db.load_document '1'
+      expect(db.load_document('1')).to eql(doc)
+    end
   end
 
-  it 'does not cache bulk loads' do
-    allow(couchrest_db).to receive_messages(bulk_load: {'rows' => []})
-    expect(couchrest_db).to receive(:bulk_load).with(['1']).exactly(2).times
+  context 'for multiple documents' do
+    let(:doc1) { double(:doc1, 'database=': nil, id: '1') }
+    let(:doc2) { double(:doc12, 'database=': nil, id: '2') }
+
+    it 'only loads uncached documents' do
+      allow(couchrest_db).to receive(:bulk_load).with(['1']).and_return('rows' => [{'doc' => doc1}])
+      allow(couchrest_db).to receive(:bulk_load).with(['2']).and_return('rows' => [{'doc' => doc2}])
+      
+
+      db.load_document(['1'])
+      db.load_document(['1', '2'])
+
+      expect(couchrest_db).to have_received(:bulk_load).with(['1']).exactly(1).times
+      expect(couchrest_db).to have_received(:bulk_load).with(['2']).exactly(1).times
+    end
+
+    it 'loads nothing if all documents are cached' do
+      allow(couchrest_db).to receive(:bulk_load).with(['1', '2'])
+        .and_return('rows' => [{'doc' => doc1}, {'doc' => doc2}])
+
+      db.load_document(['1', '2'])
+      db.load_document(['1', '2'])
+
+      expect(couchrest_db).to have_received(:bulk_load).with(['1', '2']).exactly(1).times
+    end
+
+    it 'returns all requested documents' do
+      allow(couchrest_db).to receive(:bulk_load).with(['1']).and_return('rows' => [{'doc' => doc1}])
+      allow(couchrest_db).to receive(:bulk_load).with(['2']).and_return('rows' => [{'doc' => doc2}])
+      
+
+      db.load_document(['1'])
+      result = db.load_document(['1', '2'])
+
+      expect(result).to eql([doc1, doc2])
+    end
+
+    it 'does not cache documents that do not respond to id' do
+      doc1 = {
+        'id' => '1',
+      }
+      doc2 = {
+        'id' => '2',
+      }
+      allow(couchrest_db).to receive(:bulk_load).with(['1', '2'])
+        .and_return('rows' => [{'doc' => doc1}, {'doc' => doc1}])
+
+      db.load_document(['1', '2'])
+      db.load_document(['1', '2'])
+
+      expect(couchrest_db).to have_received(:bulk_load).with(['1', '2']).exactly(2).times
+    end
+  end
 
-    db.load_document ['1']
-    db.load_document ['1']
+  context 'when switching the database' do
   end
 
   it 'clears the cache when destroying a document via #destroy_document' do

data/spec/unit/database_spec.rb

@@ -56,14 +56,24 @@ describe CouchPotato::Database, 'load' do
     db.load '1'
   end
 
+  it 'does not set database_collection on the model' do
+    user = double('user', 'database_collection=': nil).as_null_object
+    allow(DbTestUser).to receive(:new).and_return(user)
+    allow(couchrest_db).to receive(:get).and_return DbTestUser.json_create({ JSON.create_id => 'DbTestUser' })
+    
+    db.load '1'
+
+    expect(user).not_to have_received(:database_collection=).with(db)
+  end
+
   it 'should load namespaced models' do
     allow(couchrest_db).to receive(:get).and_return Parent::Child.json_create({ JSON.create_id => 'Parent::Child' })
     expect(db.load('1').class).to eq(Parent::Child)
   end
 
   context 'when several ids given' do
-    let(:doc1) { DbTestUser.new }
-    let(:doc2) { DbTestUser.new }
+    let(:doc1) { DbTestUser.new(id: '1') }
+    let(:doc2) { DbTestUser.new(id: '2') }
     let(:response) do
       { 'rows' => [{ 'doc' => nil }, { 'doc' => doc1 }, { 'doc' => doc2 }] }
     end
@@ -88,8 +98,8 @@ describe CouchPotato::Database, 'load' do
     end
 
     it 'does not write itself to a document that has no database= method' do
-      doc1 = double(:doc1)
-      allow(doc1).to receive(:respond_to?).with(:database=) { false }
+      doc1 = double(:doc1, id: '1')
+      allow(doc1).to receive(:respond_to?) { false }
       allow(couchrest_db).to receive(:bulk_load) do
         { 'rows' => [{ 'doc' => doc1 }] }
       end
@@ -99,6 +109,24 @@ describe CouchPotato::Database, 'load' do
       db.load(['1'])
     end
 
+    it 'sets database_collection on each of the documents' do
+      db.load(%w[1 2]).each do |doc|
+        expect(doc.database_collection).to eql([doc1, doc2])
+      end
+    end
+
+    it 'does not set database_collection on a document that has no database_collection= method' do
+      doc1 = double(:doc1, id: '1')
+      allow(doc1).to receive(:respond_to?) { false }
+      allow(couchrest_db).to receive(:bulk_load) do
+        { 'rows' => [{ 'doc' => doc1 }] }
+      end
+
+      expect(doc1).not_to receive(:database_collection=)
+
+      db.load(['1'])
+    end
+
     it 'returns an empty array when passing an empty array' do
       expect(db.load([])).to eq([])
     end
@@ -336,7 +364,7 @@ describe CouchPotato::Database, 'view' do
     allow(CouchPotato::View::ViewQuery).to receive_messages(new: double('view query', query_view!: { 'rows' => [@result] }))
   end
 
-  it 'initialzes a view query with map/reduce/list/lib funtions' do
+  it 'initializes a view query with map/reduce/list/lib funtions' do
     allow(@spec).to receive_messages(design_document: 'design_doc', view_name: 'my_view',
                                      map_function: '<map_code>', reduce_function: '<reduce_code>',
                                      lib: { test: '<test_code>' },
@@ -355,7 +383,7 @@ describe CouchPotato::Database, 'view' do
     @db.view(@spec)
   end
 
-  it 'initialzes a view query with map/reduce/list funtions' do
+  it 'initializes a view query with map/reduce/list funtions' do
     allow(@spec).to receive_messages(design_document: 'design_doc', view_name: 'my_view',
                                      map_function: '<map_code>', reduce_function: '<reduce_code>',
                                      lib: nil, list_name: 'my_list', list_function: '<list_code>',
@@ -374,7 +402,7 @@ describe CouchPotato::Database, 'view' do
     @db.view(@spec)
   end
 
-  it 'initialzes a view query with only map/reduce/lib functions' do
+  it 'initializes a view query with only map/reduce/lib functions' do
     allow(@spec).to receive_messages(design_document: 'design_doc', view_name: 'my_view',
                                      map_function: '<map_code>', reduce_function: '<reduce_code>',
                                      list_name: nil, list_function: nil,
@@ -390,7 +418,7 @@ describe CouchPotato::Database, 'view' do
     @db.view(@spec)
   end
 
-  it 'initialzes a view query with only map/reduce functions' do
+  it 'initializes a view query with only map/reduce functions' do
     allow(@spec).to receive_messages(design_document: 'design_doc', view_name: 'my_view',
                                      map_function: '<map_code>', reduce_function: '<reduce_code>',
                                      lib: nil, list_name: nil, list_function: nil)
@@ -405,18 +433,37 @@ describe CouchPotato::Database, 'view' do
     @db.view(@spec)
   end
 
-  it 'sets itself on returned results that have an accessor' do
+  it 'sets itself on returned docs that have an accessor' do
+    allow(@result).to receive(:respond_to?).and_return(false)
     allow(@result).to receive(:respond_to?).with(:database=).and_return(true)
     expect(@result).to receive(:database=).with(@db)
     @db.view(@spec)
   end
 
-  it "does not set itself on returned results that don't have an accessor" do
-    allow(@result).to receive(:respond_to?).with(:database=).and_return(false)
+  it "does not set itself on returned docs that don't have an accessor" do
+    allow(@result).to receive(:respond_to?).and_return(false)
     expect(@result).not_to receive(:database=).with(@db)
     @db.view(@spec)
   end
 
+  it 'sets the result of the view call on each returned doc' do
+    allow(@result).to receive(:respond_to?).and_return(false)
+    allow(@result).to receive(:respond_to?).with(:database_collection=).and_return(true)
+    allow(@result).to receive(:database_collection=)
+
+    @db.view(@spec)
+
+    expect(@result).to have_received(:database_collection=).with([@result])
+  end
+
+  it "does not set the result of the view call on docs that don't have an accessor" do
+    allow(@result).to receive(:respond_to?).and_return(false)
+
+    @db.view(@spec)
+
+    expect(@result).not_to receive(:database_collection=).with([@result])
+  end
+
   it 'does not try to set itself on result sets that are not collections' do
     expect do
       allow(@spec).to receive_messages(process_results: 1)
@@ -524,6 +571,14 @@ describe CouchPotato::Database, '#switch_to' do
 
     expect(new_db.cache).to be_nil
   end
+
+  it 're-uses the original cache when switching back to the original database' do
+    db.cache = { key: 'value' }
+    new_db = db.switch_to('db2')
+    original_db = new_db.switch_to_default
+
+    expect(original_db.cache).to have_key(:key)
+  end
 end
 
 describe CouchPotato::Database, '#switch_to_default' do

data/spec/unit/flex_view_spec_spec.rb

@@ -15,3 +15,30 @@ RSpec.describe CouchPotato::View::FlexViewSpec::Results, '#reduce_count' do
     expect(result.reduce_count).to eq(0)
   end
 end
+
+RSpec.describe CouchPotato::View::FlexViewSpec::Results, '#docs' do
+  it 'sets the database on each doc' do
+    db = double('db')
+    doc = double('doc', 'database=': nil)
+
+    result = CouchPotato::View::FlexViewSpec::Results.new 'rows' => [{ 'doc' => doc }]
+    result.database = db
+
+    result.docs
+
+    expect(doc).to have_received(:database=).with(db)
+  end
+
+  it 'sets all docs as database_collection on each doc' do
+    doc = double('doc', 'database_collection=': nil)
+
+    result = CouchPotato::View::FlexViewSpec::Results.new 'rows' => [{ 'doc' => doc }]
+
+    result.docs
+
+    expect(doc).to have_received(:database_collection=).with([doc])
+  end
+
+  it 'returns the docs' do
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couch_potato
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Alexander Lang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel