couch_potato 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36fc0534a7564b1fcf3b2a59ca91e3e4e97452c2a74d77e30540eb4b7617211
-  data.tar.gz: b1583818a743459e8ab86d88350f7ad5c6953c058c3b49c8b90da50610bdd197
+  metadata.gz: dd4dede2152745db1f3f0bf7ff3a94dfea3c7eb427beb02292034866dd7dac22
+  data.tar.gz: 29ca77512b6bdeebcdd31847deac4957792946519dda4f658f60dd90c9dd83e4
 SHA512:
-  metadata.gz: ceffb27b13b2cf9825cd5fcf507bb0e13a6ed9b5caa612fd1f5f27ba98934eb9dae34c4f4dc70835352a9176bc4562e49da12d489b925ebbeb37a3c9eaa964f4
-  data.tar.gz: c5e01a2d0d83ea11b14a618f218fe3ff66af35be893a4d74644089938b852045c52a8e1d8ecf31b53e70396737f9db0a8849ef0fbacd843c89137ec4d8bfc0e2
+  metadata.gz: 21728691cd7eb4b23bd6600899655cc7fa1dbb6a15a6d40c669b53941fab30bf38cb8a95fa9a3e8f85e05d44af116f58cd20a424eedd60d417972db893c07aff
+  data.tar.gz: d2d26373afd0bcce487b35703be3bd7bd08cc7e4e108f98e8279bf81c41715b30f5590fdf8080c4b136ec95e356c857b5c50bef123b6971e67294e79cdeb180a

data/.gitignore

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

data/CHANGES.md

@@ -1,5 +1,9 @@
 ## Changes
 
+# 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

@@ -224,6 +224,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
@@ -297,6 +298,7 @@ module CouchPotato
       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
 

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.14.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/database_spec.rb

@@ -56,6 +56,16 @@ 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)
@@ -89,7 +99,7 @@ describe CouchPotato::Database, 'load' do
 
     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 }
+      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)
+      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)

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.14.0
 platform: ruby
 authors:
 - Alexander Lang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel