couch_potato 1.14.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd4dede2152745db1f3f0bf7ff3a94dfea3c7eb427beb02292034866dd7dac22
-  data.tar.gz: 29ca77512b6bdeebcdd31847deac4957792946519dda4f658f60dd90c9dd83e4
+  metadata.gz: 3fd11db6b5bb37ef9b0d12115ae4586f8f0ec8afff586e7a2b381e1839af0196
+  data.tar.gz: 7f03e40ec9297bb669f28559e251b72f5b8e849010b8861d992c75c5ed7737a3
 SHA512:
-  metadata.gz: 21728691cd7eb4b23bd6600899655cc7fa1dbb6a15a6d40c669b53941fab30bf38cb8a95fa9a3e8f85e05d44af116f58cd20a424eedd60d417972db893c07aff
-  data.tar.gz: d2d26373afd0bcce487b35703be3bd7bd08cc7e4e108f98e8279bf81c41715b30f5590fdf8080c4b136ec95e356c857b5c50bef123b6971e67294e79cdeb180a
+  metadata.gz: 72bc1831a2b773d3f64682f1fbe20fb10acccad204fd057e92676c53fe03f5f56b462c02905b3f3ee52ddb6fa640f6dfe6a05a3f1e1aeb8e750eaecb76922a38
+  data.tar.gz: 4a49349375cabe65b465c99336e3c0b05564d0b720faa6ae4d956633809ea52d6a73119118c7bc923d0ffde0aefd5af93f3fbdc587fed89696942b05ce421025

data/CHANGES.md

@@ -1,5 +1,15 @@
 ## Changes
 
+# 1.16.0
+
+- add payload to ActiveSupport instrumentation calls
+- only notify load.cached when there are cached documents
+
+# 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

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,10 +145,12 @@ 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
+          ActiveSupport::Notifications.instrument('couch_potato.load.cached', id: id, doc: cached) do
             cached
           end
         else
@@ -159,6 +163,26 @@ 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) }
+      cached_docs_by_id = cache&.slice(*ids) || {}
+      if cached_docs_by_id.any?
+        ActiveSupport::Notifications.instrument('couch_potato.load.cached', ids: cached_docs_by_id.keys, docs: cached_docs_by_id.values) do
+          cached_docs_by_id
+        end
+      end
+      if cache
+        uncached_ids.each do |id|
+          doc = uncached_docs_by_id[id]
+          cache[id] = doc if doc
+        end
+      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 +200,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 +209,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
@@ -247,15 +281,13 @@ module CouchPotato
     def load_document_without_caching(id)
       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
+      payload = {id: id}
+      ActiveSupport::Notifications.instrument('couch_potato.load', payload) do
+        instance = couchrest_database.get(id)
+        instance.database = self if instance
+        payload[:doc] = instance
+        instance
+    end
     end
 
     def view_cache_id(spec)
@@ -294,11 +326,15 @@ 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=)
-        doc.database_collection = docs if doc.respond_to?(:database_collection=)
+      payload = {ids: ids}
+      ActiveSupport::Notifications.instrument('couch_potato.load', payload) do
+        response = couchrest_database.bulk_load ids
+        docs = response["rows"].map { |row| row["doc"] }.compact
+        payload[:docs] = docs
+        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/ghost_attributes.rb

@@ -1,12 +1,16 @@
 module CouchPotato
-  module GhostAttributes #:nodoc:
-    def method_missing(name, *args)
-      if(value = _document && _document[name.to_s])
+  module GhostAttributes # :nodoc:
+    def method_missing(name, *)
+      if (value = _document && _document[name.to_s])
         value
       else
         super
       end
     end
+
+    def respond_to_missing?(name, *)
+      _document && _document[name.to_s]
+    end
   end
 end
 

data/lib/couch_potato/version.rb

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

data/spec/unit/caching_spec.rb

@@ -18,41 +18,144 @@ 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
-
-    db.load_document '1'
-    db.load_document '1'
+  after(:each) do
+    ActiveSupport::Notifications.unsubscribe(@subscriber) if @subscriber
   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
+  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 '1'
-    db.load '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 'returns the correct object' do
-    doc = double(:doc, 'database=': nil)
-    allow(couchrest_db).to receive_messages(get: doc)
+    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_document '1'
-    expect(db.load_document('1')).to eql(doc)
+      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)
+
+      db.load_document '1'
+      expect(db.load_document('1')).to eql(doc)
+    end
+
+    it 'instruments the load call' do
+      doc = double("doc").as_null_object
+      allow(couchrest_db).to receive(:get).and_return(doc)
+      events = []
+      @subscriber = ActiveSupport::Notifications.subscribe(
+        'couch_potato.load.cached'
+      ) do |event|
+        events << event
+      end
+  
+      db.load("1")
+      db.load("1")
+  
+      expect(events.size).to eq(1)
+      expect(events.first.payload).to eq(
+        {
+          id: "1",
+          doc: 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 'instruments the load call' 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}])
+      events = []
+      @subscriber = ActiveSupport::Notifications.subscribe(
+        'couch_potato.load.cached'
+      ) do |event|
+        events << event
+      end
+
+
+      db.load_document(['1'])
+      db.load_document(['1', '2'])
+
+      expect(events.size).to eq(1)
+      expect(events.first.payload).to eq(
+        {
+          ids: ["1"],
+          docs: [doc1]
+        }
+      )
+    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' => doc2}])
+
+      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

@@ -42,6 +42,11 @@ describe CouchPotato::Database, 'load' do
   let(:couchrest_db) { double('couchrest db', info: nil).as_null_object }
   let(:db) { CouchPotato::Database.new couchrest_db }
 
+
+  after(:each) do
+    ActiveSupport::Notifications.unsubscribe(@subscriber) if @subscriber
+  end
+
   it 'should raise an exception if nil given' do
     expect do
       db.load nil
@@ -72,8 +77,8 @@ describe CouchPotato::Database, 'load' do
   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
@@ -98,7 +103,7 @@ describe CouchPotato::Database, 'load' do
     end
 
     it 'does not write itself to a document that has no database= method' do
-      doc1 = double(:doc1)
+      doc1 = double(:doc1, id: '1')
       allow(doc1).to receive(:respond_to?) { false }
       allow(couchrest_db).to receive(:bulk_load) do
         { 'rows' => [{ 'doc' => doc1 }] }
@@ -116,7 +121,7 @@ describe CouchPotato::Database, 'load' do
     end
 
     it 'does not set database_collection on a document that has no database_collection= method' do
-      doc1 = double(:doc1)
+      doc1 = double(:doc1, id: '1')
       allow(doc1).to receive(:respond_to?) { false }
       allow(couchrest_db).to receive(:bulk_load) do
         { 'rows' => [{ 'doc' => doc1 }] }
@@ -130,6 +135,46 @@ describe CouchPotato::Database, 'load' do
     it 'returns an empty array when passing an empty array' do
       expect(db.load([])).to eq([])
     end
+
+    it 'instruments the load call' do
+      events = []
+      @subscriber = ActiveSupport::Notifications.subscribe(
+        'couch_potato.load'
+      ) do |event|
+        events << event
+      end
+  
+      db.load(["1", "2"])
+  
+      expect(events.size).to eq(1)
+      expect(events.first.payload).to eq(
+        {
+          ids: ["1", "2"],
+          docs: [doc1, doc2]
+        }
+      )
+    end
+  end
+
+  it 'instruments the load call' do
+    doc = double("doc").as_null_object
+    allow(couchrest_db).to receive(:get).and_return(doc)
+    events = []
+    @subscriber = ActiveSupport::Notifications.subscribe(
+      'couch_potato.load'
+    ) do |event|
+      events << event
+    end
+
+    db.load("1")
+
+    expect(events.size).to eq(1)
+    expect(events.first.payload).to eq(
+      {
+        id: "1",
+        doc: doc
+      }
+    )
   end
 end
 
@@ -571,6 +616,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couch_potato
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Alexander Lang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel