active_record_custom_preloader 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebc260ca02c7f72a2c65f2cb594735d982482108
-  data.tar.gz: 473f45b86356872c382adfde7fa35f7229e5ec38
+  metadata.gz: 99ce25238e6af5cdf1e5ded9fb5a20cb538eea30
+  data.tar.gz: 6e51a7f912349423c01112afd78b06f0a59806a4
 SHA512:
-  metadata.gz: 38dd285e78ce11f4d9648db79b56b95c196916bf7b5c7412d1e81ff6eb7c0bd2ad5f888a215be3e96b54e35afae1258f0bc626eb0452bacf00ea06f0a7b96a75
-  data.tar.gz: f4b515d22b3a83e74a57e55ac6ceaf7acc0212e09f27856f3c8c90df9a48c073444deb5e48526e49dfd80fed81ae75c3035c95dac9ed8e3ea06d5c24b6f326c3
+  metadata.gz: 4f732ec7ac341a988cfbe4163211a0f85176980c31b9581641d5ad9ace75f045a9f021837f2329e7dd7c0748ee97b132825ddc4364066878f319e49dcf152cc1
+  data.tar.gz: af9a8f4e709aac03f81b250ac96a4f61289c640e59127dfd5a092a81805e5ffa82ba8c24e77c49b59ffca9aa9a369c94d77f4019e2d0e80bdb349237aa2ef120

data/README.md

@@ -4,12 +4,22 @@ custom preloader for ActiveRecord model
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'active_record_custom_preloader'
 ```
 
+if you use Rails you should require `railtie.rb` file 
+like this in `config/application.rb`:
+```ruby
+require 'active_record_custom_preloader/railtie'
+```
+or like this in `Gemfile`
+```ruby
+gem 'active_record_custom_preloader', require: 'active_record_custom_preloader/railtie'
+```
+
 And then execute:
 
     $ bundle
@@ -25,7 +35,10 @@ class Person < ActiveRecord::Base
   add_custom_loader :_stats, class_name: 'StatsPreloader'
 end
 
-class StatsPreloader < ActiveRecordCustomerPreloader::Preloader
+class ApplicationPreloader < ActiveRecordCustomPreloader::Preloader
+end
+
+class StatsPreloader < ApplicationPreloader
   def preload(records)
     ids = records.map(&:id)
     values = CustomApi.fetch_stats_for(ids)

data/lib/active_record_custom_preloader.rb

@@ -4,6 +4,7 @@ require 'active_record_custom_preloader/preload_with_options'
 require 'active_record_custom_preloader/associations_preloader'
 require 'active_record_custom_preloader/model_patch'
 require 'active_record_custom_preloader/relation_patch'
+require 'active_record_custom_preloader/with_multiple_foreign_keys_loading'
 
 module ActiveRecordCustomPreloader
   class Error < StandardError

data/lib/active_record_custom_preloader/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordCustomPreloader
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/active_record_custom_preloader/with_multiple_foreign_keys_loading.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+require 'active_support/concern'
+
+# Usage example:
+#
+#   class Employee < ApplicationRecord
+#     # columns: id, name, department_id, position_id
+#     add_custom_loader :_contract, class_name: 'EmployeeContractPreloader'
+#   end
+#
+#   class Contract < ApplicationRecord
+#     # columns: id, text, employee_department_id, position_id
+#   end
+#
+#   class EmployeeContractPreloader < ActiveRecordCustomPreloader::Preloader
+#     include ActiveRecordCustomPreloader::WithMultipleForeignKeysLoading
+#     self.model_class_name = 'Contract'
+#     self.association_foreign_keys_names = [:employee_department_id, :position_id]
+#
+#     def record_foreign_keys(record)
+#       [record.department_id, record.position_id]
+#     end
+#   end
+#
+module ActiveRecordCustomPreloader
+  module WithMultipleForeignKeysLoading
+    extend ActiveSupport::Concern
+
+    included do
+      # should be true for has_many and false for has_one.
+      # [optional] (default false)
+      class_attribute :to_many, instance_writer: false
+      self.to_many = false
+
+      # model class of association records
+      # [required]
+      class_attribute :model_class_name, instance_writer: false
+
+      # Names of foreign keys which link association record to parent record.
+      # Should returns array of key names for association record for query.
+      # [required]
+      class_attribute :association_foreign_keys_names, instance_writer: false
+
+      private :fetch_association
+    end
+
+    # association table is queried by return value of this method.
+    # returns array of keys for parent record to match association record
+    def record_foreign_keys(parent_record)
+      association_foreign_keys(parent_record)
+    end
+
+    # association records are grouped by return value of this method.
+    # it should match
+    # returns array of keys for association record to match parent record
+    def association_foreign_keys(assoc_record)
+      association_foreign_keys_names.map { |name| assoc_record.public_send(name) }
+    end
+
+    # returns associations for provided parent_record.
+    # array for has_many and model or nil for has_one.
+    def associations_by_record(grouped_associations, parent_record)
+      associations = grouped_associations[record_foreign_keys(parent_record)]
+      to_many ? associations || [] : associations&.first
+    end
+
+    # default scope for association records.
+    # you can override it for example to preload some values to association records.
+    def associations_scope
+      model_class_name.constantize.all
+    end
+
+    def fetch_association(parent_records)
+      keys = parent_records.map(&method(:record_foreign_keys))
+      condition_part = association_foreign_keys_names.map { |name| "#{name} = ?" }.join(' AND ')
+      conditions = []
+      keys.size.times { conditions.push(condition_part) }
+      condition_sql = conditions.map { |condition| "(#{condition})" }.join(' OR ')
+      condition_bindings = keys.flatten
+      return associations_scope.none if condition_sql.blank? || condition_bindings.empty?
+      associations = associations_scope.where(condition_sql, *condition_bindings).to_a
+      associations.group_by(&method(:association_foreign_keys))
+    end
+
+    def preload(parent_records)
+      grouped_associations = fetch_association(parent_records)
+      parent_records.each do |parent_record|
+        value = associations_by_record(grouped_associations, parent_record)
+        parent_record._set_custom_preloaded_value(name, value)
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_custom_preloader
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Denis Talakevich
@@ -105,6 +105,7 @@ files:
 - lib/active_record_custom_preloader/railtie.rb
 - lib/active_record_custom_preloader/relation_patch.rb
 - lib/active_record_custom_preloader/version.rb
+- lib/active_record_custom_preloader/with_multiple_foreign_keys_loading.rb
 homepage: https://github.com/senid231/active_record_custom_preloader
 licenses:
 - MIT