couch_potato 1.15.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffcaae6b2815d237b48cc3e4ad553f66920fe4df2c84c59ae38177260949ba6b
-  data.tar.gz: bd266a1033fa83fcba822a19e3de86b2c1aac2d80ba2dd1d3aef0920d4819d8f
+  metadata.gz: a78d19f65a75932bb6f60639fc9ad3dff0151e9c7de7f8cbc31e1b61038f7fa8
+  data.tar.gz: c5383ffd3db50bd45d727a84b62588dcd70d6ea3d07ac96559e1318c145fb057
 SHA512:
-  metadata.gz: 16f3e1748e3b3314f1cf3d658fb175dd90c5e7c7cd717ab42477961c364bac527b262642a29f208c4aad200e9a31ce7470c0a538db8bf8d641e13da92f85debb
-  data.tar.gz: '089f1c9e5dc7238b659a4d1b2d0f3d341a084fe52f6d9c2d058ea8440f197f7d64b6f5a9d78c8cebbd19b131aede038329ab6c0f79b503d220f1f20d2e7d8a20'
+  metadata.gz: 38aa7ce10b0f12429789ecc0f25e34b276f98eadedac900f2ea18b7c1845549be28becb624d4da1c89506d814fa403b7f9647f960f3be534ac47b02c839f6866
+  data.tar.gz: e0b48a96f9a485d0765b066b5e5bca043058b85af246775abdf2bf3afb598bf691b09ae156182b9ecf1ff9dcc0acdee3bb5cc899a8722d0a75bdff9ded965b7b

data/CHANGES.md

@@ -1,5 +1,15 @@
 ## Changes
 
+# 1.17.0
+
+- filter out nil ids for loading multiple documents
+- cache nil documents
+
+# 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

data/lib/couch_potato/database.rb

@@ -149,8 +149,8 @@ module CouchPotato
       
       cached = cache && cache[id]
       if cache
-        if cached
-          ActiveSupport::Notifications.instrument('couch_potato.load.cached') do
+        if cache.key?(id)
+          ActiveSupport::Notifications.instrument('couch_potato.load.cached', id: id, doc: cached) do
             cached
           end
         else
@@ -164,19 +164,23 @@ module CouchPotato
     alias load load_document
 
     def load_documents(ids)
+      ids = ids.compact
       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
+          cache[id] = 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
 
@@ -278,9 +282,11 @@ 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
+      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
@@ -321,9 +327,11 @@ module CouchPotato
     def bulk_load(ids)
       return [] if ids.empty?
 
-      ActiveSupport::Notifications.instrument('couch_potato.load') do
+      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
+        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=)

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.15.0'.freeze
+  VERSION = '1.17.0'.freeze
   RSPEC_VERSION = '4.1.0'.freeze
 end

data/spec/unit/caching_spec.rb

@@ -18,6 +18,10 @@ RSpec.describe 'database caching' do
     {}
   end
 
+  after(:each) do
+    ActiveSupport::Notifications.unsubscribe(@subscriber) if @subscriber
+  end
+
   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
@@ -33,6 +37,15 @@ RSpec.describe 'database caching' do
       db.load '1'
     end
 
+    it 'caches nil' do
+      allow(couchrest_db).to receive(:get).with('1').and_return(nil)
+
+      db.load '1'
+      db.load '1'
+
+      expect(couchrest_db).to have_received(:get).with('1').exactly(1).times
+    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
 
@@ -47,6 +60,29 @@ RSpec.describe 'database caching' do
       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
 
   context 'for multiple documents' do
@@ -65,6 +101,42 @@ RSpec.describe 'database caching' do
       expect(couchrest_db).to have_received(:bulk_load).with(['2']).exactly(1).times
     end
 
+    it 'caches nil' do
+      allow(couchrest_db).to receive(:bulk_load).with(['1']).and_return('rows' => [{'doc' => nil}])
+      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
+    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}])
@@ -85,22 +157,6 @@ RSpec.describe 'database caching' do
 
       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
 
   context 'when switching the database' 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
@@ -87,6 +92,12 @@ describe CouchPotato::Database, 'load' do
       db.load %w[1 2 3]
     end
 
+    it 'does not request anything when nil is given' do
+      expect(db.load([nil])).to eq([])
+
+      expect(couchrest_db).not_to have_received(:bulk_load)
+    end
+
     it 'returns only found documents' do
       expect(db.load(%w[1 2 3]).size).to eq(2)
     end
@@ -130,6 +141,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
 

metadata

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