acts_as_recursive_tree-26 Add include options for preload_tree

Author: wollistik

CHANGELOG.md

@@ -1,3 +1,6 @@
+### NEXT
+- added __includes:__ option to __preload_tree__
+
 ### Version 3.2.0
 - Added #preload_tree method to preload the parent/child relations of a single node
 

lib/acts_as_recursive_tree/model.rb

@@ -94,8 +94,10 @@ def leaf?
     #
     # Fetches all descendants of this node and assigns the parent/children associations
     #
-    def preload_tree
-      ActsAsRecursiveTree::Preloaders::Descendants.new(self).preload!
+    # @param includes [Array|Hash] pass the same arguments that should be passed to the #includes() method.
+    #
+    def preload_tree(includes: nil)
+      ActsAsRecursiveTree::Preloaders::Descendants.new(self, includes: includes).preload!
       true
     end
 
@@ -107,27 +109,27 @@ def base_class
 
     module ClassMethods
       def self_and_ancestors_of(ids, &block)
-        Builders::Ancestors.build(self, ids, &block)
+        ActsAsRecursiveTree::Builders::Ancestors.build(self, ids, &block)
       end
 
       def ancestors_of(ids, &block)
-        Builders::Ancestors.build(self, ids, exclude_ids: true, &block)
+        ActsAsRecursiveTree::Builders::Ancestors.build(self, ids, exclude_ids: true, &block)
       end
 
       def roots_of(ids)
         self_and_ancestors_of(ids).roots
       end
 
       def self_and_descendants_of(ids, &block)
-        Builders::Descendants.build(self, ids, &block)
+        ActsAsRecursiveTree::Builders::Descendants.build(self, ids, &block)
       end
 
       def descendants_of(ids, &block)
-        Builders::Descendants.build(self, ids, exclude_ids: true, &block)
+        ActsAsRecursiveTree::Builders::Descendants.build(self, ids, exclude_ids: true, &block)
       end
 
       def leaves_of(ids, &block)
-        Builders::Leaves.build(self, ids, &block)
+        ActsAsRecursiveTree::Builders::Leaves.build(self, ids, &block)
       end
     end
   end

lib/acts_as_recursive_tree/preloaders/descendants.rb

@@ -7,9 +7,10 @@ module Preloaders
     # based on the preloaded data. After this, calling #parent or #children will not trigger a database query.
     #
     class Descendants
-      def initialize(node)
-        @node = node
+      def initialize(node, includes: nil)
+        @node       = node
         @parent_key = node._recursive_tree_config.parent_key
+        @includes   = includes
       end
 
       def preload!
@@ -19,7 +20,11 @@ def preload!
       private
 
       def records
-        @records ||= @node.descendants.to_a
+        @records ||= begin
+          descendants = @node.descendants
+          descendants = descendants.includes(*@includes) if @includes
+          descendants.to_a
+        end
       end
 
       def apply_records(parent_node)

spec/acts_as_recursive_tree/preloaders/descendants_spec.rb

@@ -5,25 +5,40 @@
 RSpec.describe ActsAsRecursiveTree::Preloaders::Descendants do
   include TreeMethods
 
-  let(:preloader) { described_class.new(root.reload) }
-  let(:root) { create_tree(2) }
+  let(:preloader) { described_class.new(root.reload, includes: included_associations) }
+  let(:included_associations) { nil }
+  let(:root) { create_tree(2, create_node_info: true) }
   let(:children) { root.children }
 
   describe '#preload! will set the associations target attribute' do
     before do
       preloader.preload!
     end
 
-    it 'sets the children assoction' do
+    it 'sets the children association' do
       children.each do |child|
         expect(child.association(:children).target).not_to be_nil
       end
     end
 
-    it 'sets the parent assoction' do
+    it 'sets the parent association' do
       children.each do |child|
         expect(child.association(:parent).target).not_to be_nil
       end
     end
   end
+
+  describe '#preload! will include associations' do
+    let(:included_associations) { :node_info }
+
+    before do
+      preloader.preload!
+    end
+
+    it 'sets the children association' do
+      children.each do |child|
+        expect(child.association(included_associations).target).not_to be_nil
+      end
+    end
+  end
 end

spec/support/tree_methods.rb

@@ -2,11 +2,12 @@
 
 # Helper methods for simple tree creation
 module TreeMethods
-  def create_tree(max_level, current_level = 0, node = nil)
+  def create_tree(max_level, current_level = 0, node = nil, create_node_info: false)
     node = Node.create!(name: 'root') if node.nil?
 
     1.upto(max_level - current_level) do |index|
       child = node.children.create!(name: "child #{index} - level #{current_level}")
+      child.create_node_info if create_node_info
       create_tree(max_level, current_level + 1, child)
     end