Possibility to eager load associations in each_record method (#39)

Author: KirIgor

.github/workflows/test.yml

@@ -54,7 +54,7 @@ jobs:
       - name: Run specs
         run: bundle exec ci-helper RunSpecs
 
-      - name: Coveralls
-        uses: coverallsapp/github-action@master
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+#      - name: Coveralls
+#        uses: coverallsapp/github-action@master
+#        with:
+#          github-token: ${{ secrets.GITHUB_TOKEN }}

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    umbrellio-utils (1.7.1)
+    umbrellio-utils (1.8.0)
       memery (~> 1)
 
 GEM
@@ -382,4 +382,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.5.18
+   2.7.1

lib/umbrellio_utils/database.rb

@@ -25,10 +25,15 @@ def get_violated_constraint_name(exception)
 
     def each_record(dataset, primary_key: nil, **options, &block)
       primary_key = primary_key_from(dataset, primary_key:)
+      eager_tables = Array(options.delete(:eager_load))
 
       with_temp_table(dataset, primary_key:, **options) do |ids|
         rows = ids.map { |id| row(id.is_a?(Hash) ? id.values : [id]) }
-        dataset.model.where(row(primary_key) => rows).reverse(row(primary_key)).each(&block)
+        records = dataset.model
+               .eager(eager_tables)
+               .where(row(primary_key) => rows)
+               .reverse(row(primary_key)).all
+        records.each(&block)
       end
     end
 

lib/umbrellio_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UmbrellioUtils
-  VERSION = "1.7.1"
+  VERSION = "1.8.0"
 end

spec/support/database.rb

@@ -4,7 +4,7 @@
 
 begin
   db_name = "umbrellio_utils_test"
-  DB = Sequel.connect(ENV.fetch("DB_URL", "postgres://localhost/#{db_name}"))
+  DB = Sequel.connect(ENV.fetch("DB_URL", "postgres:///#{db_name}"))
 rescue Sequel::DatabaseConnectionError => error
   puts error
   abort "You probably need to create a test database. " \
@@ -17,7 +17,7 @@
 
 DB.extension :batches
 
-DB.drop_table? :users
+DB.drop_table? :users, cascade: true
 DB.create_table :users do
   primary_key :id
   column :email, :text
@@ -37,6 +37,12 @@
   primary_key %i[geo nick]
 end
 
+DB.drop_table? :user_tokens
+DB.create_table :user_tokens do
+  primary_key :id
+  foreign_key :user_id, :users
+end
+
 class User < Sequel::Model(:users)
   def skip_table_sync?
     false
@@ -54,3 +60,11 @@ def skip_table_sync?
     false
   end
 end
+
+class UserToken < Sequel::Model(:user_tokens)
+  many_to_one :user, class: "User", key: :user_id
+
+  def skip_table_sync?
+    false
+  end
+end

spec/umbrellio_utils/database_spec.rb

@@ -176,5 +176,42 @@
         expect(result_emails).to eq(reversed_emails)
       end
     end
+
+    context "with eager_load" do
+      let(:options) { Hash[eager_load: [:user]] }
+
+      let!(:users) { User.all }
+      let(:tokens_data) { Array.new(10) { |i| { user_id: users[i].id } } }
+
+      let!(:db_logger) do
+        logger = Class.new(Logger) do
+          attr_accessor :queries
+
+          def add(_, _, msg)
+            self.queries ||= []
+            queries << msg if msg.include?('FROM "users"')
+          end
+        end.new(nil)
+        logger.tap { |x| DB.loggers << x }
+      end
+
+      subject(:result_users) do
+        tokens = []
+
+        described_class.each_record(UserToken.dataset, **options) do |token|
+          tokens << token
+        end
+
+        tokens.map(&:user)
+      end
+
+      before { UserToken.multi_insert(tokens_data) }
+      after { DB.loggers.pop }
+
+      it "preloads users" do
+        expect(result_users.map(&:id)).to eq(users.map(&:id).reverse)
+        expect(db_logger.queries.size).to eq(1)
+      end
+    end
   end
 end