goldiloader 5.0.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5acb78ebf278d88e47a50d7f3c6c49f55bee48704eb115082b45d1421f84313
-  data.tar.gz: 4034b092560abca7b531f81485c850f366e79bb5f4996c0477dd1525921a2ef8
+  metadata.gz: 3e2c97d263d32b7fb6d2f2e9486f780c835ea50d63746983fb0eb6c39322b9db
+  data.tar.gz: 1b9e51a04b471e59b5e8900c14518c392d1d87e7530ec421cca53603d9df6939
 SHA512:
-  metadata.gz: 433c75215165ab250d932c5e3307ec78777f45cb9a6c691dcb33386566ce211e65771808e81c95ab0d46fd0a786e41899fd418858c466503fe723828ba56858d
-  data.tar.gz: dc0947c73fd7c01697442dd717a0e43efe35fce6a87ab281d9b51f86ea6d1b192be53f6c25b975294d7896ac3d73f79701ea4ea1c8c0cfb1e01d39c31b6a8fd1
+  metadata.gz: 8ef1fc2b11be83c5f7557bf4ed7b30aa7b3eb1ecd71e710558b21591ce05bda8a09d51cc2ef1c2026817bd20bccbe6ede8c9a7636eda07b6945acb814b6cacdc
+  data.tar.gz: db3bf812806fad8e6c6d2c2afdbb2be6883e524a81a62447c8a04b5a2ac0ec9c80a67568a2a8ece2563172cbadaa7dac67e410217678041cbecf601e1da1292e

data/lib/goldiloader/active_record_patches.rb

@@ -25,6 +25,11 @@ module Goldiloader
       @auto_include_context = nil
       super
     end
+
+    def goldiload(cache_name = nil, key: self.class.primary_key, &block)
+      cache_name ||= block.source_location.join(':')
+      auto_include_context.preloaded(self, cache_name: cache_name, key: key, &block)
+    end
   end
   ::ActiveRecord::Base.include(::Goldiloader::BasePatch)
 

data/lib/goldiloader/auto_include_context.rb

@@ -51,5 +51,7 @@ module Goldiloader
     end
 
     alias_method :register_model, :register_models
+
+    prepend Goldiloader::CustomPreloads
   end
 end

data/lib/goldiloader/custom_preloads.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Goldiloader
+  module CustomPreloads
+    def initialize
+      super
+      @custom_preloads = nil
+    end
+
+    def preloaded(model, cache_name:, key:, &block)
+      unless preloaded?(cache_name)
+        ids = models.map do |record|
+          key_from_record(record, key)
+        end
+
+        # We're using instance_exec instead of a simple yield to make sure that the
+        # given block does not have any references to the model instance as this might
+        # lead to unexpected results. The block will be executed in the context of the
+        # class of the model instead.
+        block_context = models.first.class
+        preloaded_hash = block_context.instance_exec(ids, &block)
+        store_preloaded(cache_name, preloaded_hash)
+      end
+      fetch_preloaded(cache_name, model, key: key)
+    end
+
+    private
+
+    def key_from_record(record, key_or_key_list)
+      if key_or_key_list.is_a?(Array)
+        # allow passing an array of keys that will be collected from the record
+        key_or_key_list.map do |key|
+          record.public_send(key)
+        end
+      else
+        record.public_send(key_or_key_list)
+      end
+    end
+
+    def store_preloaded(cache_name, preloaded_hash)
+      @custom_preloads ||= {}
+      @custom_preloads[cache_name] = preloaded_hash
+    end
+
+    def fetch_preloaded(cache_name, instance, key:)
+      @custom_preloads&.dig(cache_name, key_from_record(instance, key))
+    end
+
+    def preloaded?(cache_name)
+      @custom_preloads&.key?(cache_name)
+    end
+  end
+end

data/lib/goldiloader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Goldiloader
-  VERSION = '5.0.0'
+  VERSION = '5.2.0'
 end

data/lib/goldiloader.rb

@@ -3,6 +3,7 @@
 require 'active_support/all'
 require 'active_record'
 require 'goldiloader/compatibility'
+require 'goldiloader/custom_preloads'
 require 'goldiloader/auto_include_context'
 require 'goldiloader/scope_info'
 require 'goldiloader/association_options'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goldiloader
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Joel Turkel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -238,6 +238,7 @@ files:
 - lib/goldiloader/association_options.rb
 - lib/goldiloader/auto_include_context.rb
 - lib/goldiloader/compatibility.rb
+- lib/goldiloader/custom_preloads.rb
 - lib/goldiloader/scope_info.rb
 - lib/goldiloader/version.rb
 homepage: https://github.com/salsify/goldiloader