active_record_custom_preloader 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99ce25238e6af5cdf1e5ded9fb5a20cb538eea30
-  data.tar.gz: 6e51a7f912349423c01112afd78b06f0a59806a4
+  metadata.gz: ea88d7f2390b0e45e10bd34521c31856bc6ef72f
+  data.tar.gz: 465b71a9c3155369e73188a617bbaadad847322a
 SHA512:
-  metadata.gz: 4f732ec7ac341a988cfbe4163211a0f85176980c31b9581641d5ad9ace75f045a9f021837f2329e7dd7c0748ee97b132825ddc4364066878f319e49dcf152cc1
-  data.tar.gz: af9a8f4e709aac03f81b250ac96a4f61289c640e59127dfd5a092a81805e5ffa82ba8c24e77c49b59ffca9aa9a369c94d77f4019e2d0e80bdb349237aa2ef120
+  metadata.gz: 57180386f8368ab09c39033d093a8952de62143dd81d98d62c37c355c75e098b27a24684f70fcfb4802d1ee7d09d29ada1ccfde0ee27acb25b9e028e2828d741
+  data.tar.gz: 8ce168e2bcc13fe4dee152d6727103eddb57c67c601e7f4daa0904f795c8db257ce3286d2f56741c3c9e48fbb1c9b4f0314554eadb8048a71fefa7f85d98f7ac

data/README.md

@@ -31,6 +31,8 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+require 'active_record_custom_preloader/railtie'
+
 class Person < ActiveRecord::Base
   add_custom_loader :_stats, class_name: 'StatsPreloader'
 end
@@ -59,6 +61,67 @@ person.clear_custom_preloaded_value(:_stats) # will clear preloaded value for _s
 person._stats # will preload again and return value
 ```
 
+you can use `ActiveRecordCustomPreloader::WithMultipleForeignKeysLoading` module
+for preloading active_record models which are related to parent record by multiple keys
+```ruby
+require 'active_record_custom_preloader/railtie'
+
+class Employee < ActiveRecord::Base
+  # columns: id, name, department_id, position_id
+  add_custom_loader :_contract, class_name: 'EmployeeContractPreloader'
+end
+
+class Contract < ActiveRecord::Base
+  # 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
+```
+
+also you can use `ActiveRecordCustomPreloader::WithContextDependentLoading` module
+for preloading active_record models which should be filtered by some external context
+```ruby
+require 'active_record_custom_preloader/railtie'
+
+class User < ActiveRecord::Base
+  # columns: id, name, pricelist_id
+end
+
+class Discount < ActiveRecord::Base
+  # columns id, user_pricelist_id, product_id, percentage
+end
+
+class Product < ActiveRecord::Base
+  # columns: id, name, price
+  add_loader :_discount, class_name: 'ProductDiscountPreloader'
+end
+
+class ProductDiscountPreloader < ActiveRecordCustomPreloader::Preloader
+  include ActiveRecordCustomPreloader::WithContextDependentLoading
+  self.to_many = true
+  self.association_group_key = :user_pricelist_id
+  self.record_group_key = :pricelist_id
+
+  def scoped_collection(records)
+    product_ids = records.map(&:id)
+    pricelist_id = args.fetch(:pricelist_id)
+    Discount.where(user_pricelist_id: pricelist_id, product_id: product_ids)
+  end
+end
+
+user = User.first
+products = Product.limit(10).custom_preload(:_discount, pricelist_id: user.pricelist_id)
+products.first._discount # will return array with zero or more Discount records
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -75,4 +138,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the ActiveRecordCustomPreloader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/active_record_custom_preloader/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ActiveRecordCustomPreloader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/senid231/active_record_custom_preloader/blob/master/CODE_OF_CONDUCT.md).

data/lib/active_record_custom_preloader/relation_patch.rb

@@ -12,5 +12,44 @@ module ActiveRecordCustomPreloader
         ActiveRecordCustomPreloader::AssociationsPreloader.new
       end
     end
+
+    # custom preload with optional args
+    # usage:
+    #
+    #   class IncomingStatisticPreloader < ActiveRecordCustomPreloader::Preloader
+    #     def preload(records)
+    #       StatsApi.fetch(:incoming, group_by: args.fetch(:group_by))
+    #     end
+    #   end
+    #
+    #   class OutgoingStatisticPreloader < ActiveRecordCustomPreloader::Preloader
+    #     def preload(records)
+    #       ids = records.map(&:id)
+    #       api_result = StatsApi.fetch(:incoming, person_ids: ids, group: args.fetch(:group))
+    #       values = api_result.group_by(&:person_id)
+    #       records.each do |record|
+    #         value = values[record.id] || []
+    #         record._set_custom_preloaded_value(name, value)
+    #       end
+    #     end
+    #   end
+    #
+    #   class Person < ActiveRecord::Base
+    #     add_loader :_incoming_stats, class_name: 'IncomingStatisticPreloader'
+    #     add_loader :_outgoing_stats, class_name: 'OutgoingStatisticPreloader'
+    #   end
+    #
+    #   Person.limit(10).custom_preload(:_incoming_stats, :_outgoing_stats, group: 'hour')
+    #   # is syntax sugar for
+    #   Person.limit(10).preload(
+    #       ActiveRecordCustomPreloader::PreloadWithOptions.new(:_incoming_stats, group: 'hour'),
+    #       ActiveRecordCustomPreloader::PreloadWithOptions.new(:_outgoing_stats, group: 'hour')
+    #   )
+    #
+    def custom_preload(*names)
+      args = names.extract_options!
+      preloads = names.map { |name| PreloadWithOptions.new(name, args) }
+      preload(*preloads)
+    end
   end
 end

data/lib/active_record_custom_preloader/version.rb

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

data/lib/active_record_custom_preloader/with_context_dependent_loading.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+require 'active_support/concern'
+
+# Usage example:
+#
+#   class User < ApplicationRecord
+#     # columns: id, name, pricelist_id
+#   end
+#
+#   class Pricelist < ApplicationRecord
+#     # columns: id, name
+#   end
+#
+#   class Discount < ApplicationRecord
+#     # columns id, user_pricelist_id, product_id, percentage
+#   end
+#
+#   class Product < ApplicationRecord
+#     # columns: id, name, price
+#     add_loader :_discount, class_name: 'ProductDiscountPreloader'
+#   end
+#
+#   class ProductDiscountPreloader < ActiveRecordCustomPreloader::Preloader
+#     include ActiveRecordCustomPreloader::WithContextDependentLoading
+#     self.to_many = true
+#     self.association_group_key = :user_pricelist_id
+#     self.record_group_key = :pricelist_id
+#
+#     def scoped_collection(records)
+#       product_ids = records.map(&:id)
+#       pricelist_id = args.fetch(:pricelist_id)
+#       Discount.where(user_pricelist_id: pricelist_id, product_id: product_ids)
+#     end
+#   end
+#
+#   user = User.first
+#   products = Product.limit(10).custom_preload(:_discount, pricelist_id: user.pricelist_id)
+#   products.first._discount # will return array with zero or more Discount records
+#
+module ActiveRecordCustomPreloader
+  module WithContextDependentLoading
+    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
+
+      # by this method association records will be grouped
+      # [required]
+      class_attribute :association_group_key, instance_writer: false
+
+      # by this method grouped association records will be matched with parent record
+      # [required]
+      class_attribute :record_group_key, instance_writer: false
+    end
+
+    # should return associations scope.
+    # must be overridden.
+    def scoped_collection(_parent_records)
+      raise NotImplementedError.new 'override #scoped_collection in a subclass'
+    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)
+      key = parent_record.public_send(record_group_key)
+      associations = grouped_associations[key]
+      to_many ? associations || [] : associations&.first
+    end
+
+    def fetch_association(parent_records)
+      scope = scoped_collection(parent_records)
+      scope.to_a.group_by(&association_group_key)
+    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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_custom_preloader
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Denis Talakevich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-09 00:00:00.000000000 Z
+date: 2019-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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_context_dependent_loading.rb
 - lib/active_record_custom_preloader/with_multiple_foreign_keys_loading.rb
 homepage: https://github.com/senid231/active_record_custom_preloader
 licenses: