active_record_custom_preloader 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3ae2d7473982e7d6c8a0acb437c9035639b612a
-  data.tar.gz: 569cdbd12ef58432b9ec7943483a1ecc0e674b53
+  metadata.gz: f437b6601b911a6dc53a3e9a87ef86a44c031bf7
+  data.tar.gz: 01733c6190ca58c13e606371eaf445178727a87c
 SHA512:
-  metadata.gz: 739c08fcfd37f34beade62def759197b85ca34f64751aa0ee860b5b843689353cfb7ebc9e134b97d9807db78d410274e537275483a65396eeae6988df96ec1c8
-  data.tar.gz: b30be1a80b7fc0c691fca81178754dcad5674abd3dd1b05f54e9a0f118179b445196023892c00c69bc8de61bc334a3217088e559b8f966a36bcdda0654cea361
+  metadata.gz: f129529340548f1f9dec261bb9f8fced68425adb513c936b5ccbe85e789db6b860f092099e83a48d4584de05ddb42e95349f713f8ac67faf8a86f2923ec3de0c
+  data.tar.gz: 39b22ccbcb98ba60478cdc9a5ee7b2f034948b4a5bb4b4a1202df2d239587e067bee18493c8ee9b9fd1cc39c3db817f8b8ec650c884b1ff908d2e5db16004277

data/lib/active_record_custom_preloader/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordCustomPreloader
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

data/lib/active_record_custom_preloader/with_array_foreign_keys_loading.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'active_support/concern'
+
+# Usage example:
+#
+#   class Employee < ApplicationRecord
+#     # columns: id, name, department_ids
+#     add_custom_loader :_departments, class_name: 'EmployeeDepartmentPreloader'
+#   end
+#
+#   class Department < ApplicationRecord
+#     # columns: id, name
+#   end
+#
+#   class EmployeeDepartmentPreloader < ActiveRecordCustomPreloader::Preloader
+#     include ActiveRecordCustomPreloader::WithArrayForeignKeysLoading
+#     self.model_class_name = 'Department'
+#     self.association_foreign_keys_names = :department_ids
+#     self.keep_sorting = true
+#   end
+#
+module ActiveRecordCustomPreloader
+  module WithArrayForeignKeysLoading
+    extend ActiveSupport::Concern
+
+    included do
+      # set to true if you want associated records to be sorted in same way as ids.
+      # [optional] (default false)
+      class_attribute :keep_sorting, instance_writer: false
+      self.keep_sorting = false
+
+      # model class of association records
+      # [required]
+      class_attribute :model_class_name, instance_writer: false
+
+      # Name of foreign keys array which link association record to parent record.
+      # Should returns symbol name of a column or parent record instance method.
+      # [required]
+      class_attribute :association_foreign_keys_name, instance_writer: false
+
+      private :fetch_association, :associations_by_parent_record
+    end
+
+    # returns associations for provided parent_record.
+    # array for has_many and model or nil for has_one.
+    def associations_by_parent_record(parent_record, association_records)
+      ids = parent_record.public_send(association_foreign_keys_name)
+      result = association_records.select { |r| ids.include?(r.id) }
+      result.sort_by! { |r| ids.index r.id } if keep_sorting
+      result
+    end
+
+    def fetch_association(parent_records)
+      ids = parent_records.map(&association_foreign_keys_name).flatten.uniq
+      associations_scope.where(id: ids).to_a
+    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 preload(parent_records)
+      association_records = fetch_association(parent_records)
+      parent_records.each do |parent_record|
+        value = associations_by_parent_record(parent_record, association_records)
+        parent_record._set_custom_preloaded_value(name, value)
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_custom_preloader
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Denis Talakevich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -119,6 +119,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_array_foreign_keys_loading.rb
 - lib/active_record_custom_preloader/with_context_dependent_loading.rb
 - lib/active_record_custom_preloader/with_multiple_foreign_keys_loading.rb
 homepage: https://github.com/senid231/active_record_custom_preloader