ar_lazy_preload 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7060cc83164f3fff3a468514246ecbb5799accc1999dab8581c97db4d10f016a
-  data.tar.gz: 98075d278f0d04fa68ae9b31ddc60e0348b6a896460f512bc27195113095e700
+  metadata.gz: a265f11a7c21888ebe4ac60ccce4ab42bf56ff8527217fa8946013df0c2b0324
+  data.tar.gz: ce5ed84890259cff5d994a6618fc8017af7e46dc6acb974ef44ec5cc183e494f
 SHA512:
-  metadata.gz: aad5db14a66fb29fa11cfbd2968e2b3dbd54110ee51f89d95ca6a5c9538125c46732a03d7d4539f3b1c251b2ae6a5c4c986b3a677d93bd76d6384c6e843c11bb
-  data.tar.gz: 482285553c6d4b1057e0d5ee173eef21f14a7e5c5214c093614ee3730677d3c32f0039b5b387da4b05023713b7868ae75b22d23cf18edd0200f1176fd6b78b4a
+  metadata.gz: 0e7220676078a6a8fb0ed8b93e7eeb81260d20ce692177466dfa97e6ee8915fd56bd524fbac81b039f48ef6ba43023d9838235d6540f0518de73053395ca7ae1
+  data.tar.gz: 35280832594c531085e7d51047282852615029d4b019532cf00e098c069f85f98a4bfa9cc85f54866baa039c9124346420aa989919161a465d53dc2a873db473

data/lib/ar_lazy_preload/active_record/association_relation.rb

@@ -6,16 +6,21 @@ module ArLazyPreload
   module AssociationRelation
     def initialize(*args)
       super(*args)
+      setup_preloading_context unless ArLazyPreload.config.auto_preload?
+    end
+
+    delegate :owner, :reflection, to: :proxy_association
+    delegate :lazy_preload_context, to: :owner
 
-      context = owner.lazy_preload_context
-      return if context.nil?
+    private
 
-      association_tree_builder = AssociationTreeBuilder.new(context.association_tree)
+    def setup_preloading_context
+      return if lazy_preload_context.nil?
+
+      association_tree_builder = AssociationTreeBuilder.new(lazy_preload_context.association_tree)
       subtree = association_tree_builder.subtree_for(reflection.name)
 
       lazy_preload!(subtree)
     end
-
-    delegate :owner, :reflection, to: :proxy_association
   end
 end

data/lib/ar_lazy_preload/associated_context_builder.rb

@@ -24,11 +24,13 @@ module ArLazyPreload
     # Takes all the associated records for the records, attached to the :parent_context and creates
     # a preloading context for them
     def perform
-      records_by_class = parent_context.records.group_by(&:class)
+      associated_records = parent_context.records.flat_map do |record|
+        next if record.nil?
 
-      associated_records = records_by_class.map do |klass, klass_records|
-        associated_records_for(klass, klass_records)
-      end.flatten
+        record_association = record.public_send(association_name)
+        reflection = reflection_cache[record.class]
+        reflection.collection? ? record_association.target : record_association
+      end
 
       Context.register(records: associated_records, association_tree: child_association_tree)
     end
@@ -36,13 +38,16 @@ module ArLazyPreload
     private
 
     def child_association_tree
+      # `association_tree` is unnecessary when auto preload is enabled
+      return nil if ArLazyPreload.config.auto_preload?
+
       AssociationTreeBuilder.new(parent_context.association_tree).subtree_for(association_name)
     end
 
-    def associated_records_for(klass, records)
-      record_associations = records.map { |record| record.send(association_name) }
-      reflection = klass.reflect_on_association(association_name)
-      reflection.collection? ? record_associations.map(&:target).flatten : record_associations
+    def reflection_cache
+      @reflection_cache ||= Hash.new do |hash, klass|
+        hash[klass] = klass.reflect_on_association(association_name)
+      end
     end
   end
 end

data/lib/ar_lazy_preload/association_tree_builder.rb

@@ -8,9 +8,6 @@ module ArLazyPreload
     attr_reader :association_tree
 
     def initialize(association_tree)
-      # Since `association_tree` can be an array or a single hash
-      # Converting it to an array is easier for processing
-      # like jquery
       @association_tree =
         case association_tree
         when Array
@@ -18,8 +15,7 @@ module ArLazyPreload
         when Hash
           [association_tree]
         else
-          raise NotImplementedError,
-                "unexpected association_tree with class #{association_tree.class}"
+          raise ArgumentError, "unexpected association_tree with class #{association_tree.class}"
         end.select { |node| node.is_a?(Hash) }
     end
 
@@ -31,7 +27,7 @@ module ArLazyPreload
 
     def subtree_cache
       @subtree_cache ||= Hash.new do |hash, association|
-        hash[association] = association_tree.map { |node| node[association] }.flatten
+        hash[association] = association_tree.flat_map { |node| node[association] }
       end
     end
   end

data/lib/ar_lazy_preload/context.rb

@@ -1,76 +1,23 @@
 # frozen_string_literal: true
 
-require "set"
-require "ar_lazy_preload/associated_context_builder"
+require "ar_lazy_preload/contexts/base_context"
+require "ar_lazy_preload/contexts/auto_preload_context"
+require "ar_lazy_preload/contexts/lazy_preload_context"
 
 module ArLazyPreload
-  # This class is responsible for holding a connection between a list of ActiveRecord::Base objects
-  # which have been loaded by the same instance of ActiveRecord::Relation. It also contains a tree
-  # of associations, which were requested to be loaded lazily.
-  # Calling #preload_association method will cause loading of ALL associated objects for EACH
-  # ecord when requested association is found in the association tree.
   class Context
     # Initiates lazy preload context for given records
     def self.register(records:, association_tree:)
-      return if records.empty? || association_tree.empty? && !ArLazyPreload.config.auto_preload?
-
-      ArLazyPreload::Context.new(records: records, association_tree: association_tree)
-    end
-
-    attr_reader :records, :association_tree
-
-    # :records - array of ActiveRecord instances
-    # :association_tree - list of symbols or hashes representing a tree of preloadable associations
-    def initialize(records:, association_tree:)
-      @records = records.compact
-      @association_tree = association_tree
-
-      @records.each { |record| record.lazy_preload_context = self }
-    end
-
-    # This method checks if the association is present in the association_tree and preloads for all
-    # objects in the context it if needed.
-    def try_preload_lazily(association_name)
-      return unless association_needs_preload?(association_name)
-
-      preloader.preload(records, association_name)
-      AssociatedContextBuilder.prepare(parent_context: self, association_name: association_name)
-      # Our tracking of loading state
-      # Otherwise `#preload` will be called many times even when association is loaded
-      mark_association_as_loaded(association_name)
-    end
-
-    private
-
-    def association_needs_preload?(association_name, node_tree = association_tree)
-      # Check whether association loading state
-      # to avoid calling preload unnecessarily
-      return false if association_loaded?(association_name)
-      return true if ArLazyPreload.config.auto_preload?
-
-      node_tree.any? do |node|
-        if node.is_a?(Symbol)
-          node == association_name
-        elsif node.is_a?(Hash)
-          node.key?(association_name)
-        end
+      return if records.empty?
+
+      if ArLazyPreload.config.auto_preload?
+        Contexts::AutoPreloadContext.new(records: records)
+      elsif association_tree.any?
+        Contexts::LazyPreloadContext.new(
+          records: records,
+          association_tree: association_tree
+        )
       end
     end
-
-    def mark_association_as_loaded(association_name)
-      loaded_association_names.add(association_name)
-    end
-
-    def association_loaded?(association_name)
-      loaded_association_names.include?(association_name)
-    end
-
-    def loaded_association_names
-      @loaded_association_names ||= Set.new
-    end
-
-    def preloader
-      @preloader ||= ActiveRecord::Associations::Preloader.new
-    end
   end
 end

data/lib/ar_lazy_preload/contexts/auto_preload_context.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArLazyPreload
+  module Contexts
+    # This class is responsible for automatic association preloading
+    class AutoPreloadContext < BaseContext
+      protected
+
+      def association_needs_preload?(_association_name)
+        true
+      end
+    end
+  end
+end

data/lib/ar_lazy_preload/contexts/base_context.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "set"
+require "ar_lazy_preload/associated_context_builder"
+
+module ArLazyPreload
+  module Contexts
+    # This is a base context class, which is responsible for holding a connection between a list of
+    # ActiveRecord::Base objects which have been loaded by the same instance of
+    # ActiveRecord::Relation.
+    class BaseContext
+      attr_reader :records
+
+      # :records - array of ActiveRecord instances
+      def initialize(records:)
+        @records = records.dup
+        @records.compact!
+        @records.each { |record| record.lazy_preload_context = self }
+      end
+
+      # This method checks if the association should be loaded and preloads it for all
+      # objects in the context it if needed.
+      def try_preload_lazily(association_name)
+        return if association_loaded?(association_name) ||
+                  !association_needs_preload?(association_name)
+
+        perform_preloading(association_name)
+      end
+
+      protected
+
+      def association_needs_preload?(_association_name)
+        raise NotImplementedError
+      end
+
+      private
+
+      def perform_preloading(association_name)
+        preloader.preload(records, association_name)
+        loaded_association_names.add(association_name)
+
+        AssociatedContextBuilder.prepare(
+          parent_context: self,
+          association_name: association_name
+        )
+      end
+
+      def association_loaded?(association_name)
+        loaded_association_names.include?(association_name)
+      end
+
+      def loaded_association_names
+        @loaded_association_names ||= Set.new
+      end
+
+      def preloader
+        @preloader ||= ActiveRecord::Associations::Preloader.new
+      end
+    end
+  end
+end

data/lib/ar_lazy_preload/contexts/lazy_preload_context.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ArLazyPreload
+  module Contexts
+    # This class is responsible for lazy preloading. It contains a tree of associations, which were
+    # requested to be loaded lazily.
+    class LazyPreloadContext < BaseContext
+      attr_reader :association_tree
+
+      # :records - array of ActiveRecord instances
+      # :association_tree - list of symbols or hashes representing a tree of preloadable
+      # associations
+      def initialize(records:, association_tree:)
+        @association_tree = association_tree
+
+        super(records: records)
+      end
+
+      protected
+
+      def association_needs_preload?(association_name)
+        association_tree.any? do |node|
+          case node
+          when Symbol
+            node == association_name
+          when Hash
+            node.key?(association_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ar_lazy_preload/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ArLazyPreload
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ar_lazy_preload
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2018-12-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: memory_profiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: lazy_preload implementation for ActiveRecord models
 email:
 - dmitry.a.tsepelev@gmail.com
@@ -143,6 +171,9 @@ files:
 - lib/ar_lazy_preload/association_tree_builder.rb
 - lib/ar_lazy_preload/configuration.rb
 - lib/ar_lazy_preload/context.rb
+- lib/ar_lazy_preload/contexts/auto_preload_context.rb
+- lib/ar_lazy_preload/contexts/base_context.rb
+- lib/ar_lazy_preload/contexts/lazy_preload_context.rb
 - lib/ar_lazy_preload/railtie.rb
 - lib/ar_lazy_preload/version.rb
 homepage: https://github.com/DmitryTsepelev/ar_lazy_preload