closure_tree 9.2.0 → 9.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ace270a69b46da9e3ba8594cb5299e0eb3d9b222f3261c6304566cdbe1f5c7bd
-  data.tar.gz: ea4dccd196cf9278d510f89fa62d5e892916f2effa82b9c08cf851305523d528
+  metadata.gz: b7af281d62397e19768240a93ab284f2ceb9b261f5c4c3d2ac7d288300212b6e
+  data.tar.gz: ef0cf220eb02fcfafb17034265ee6d3ceb514c13898bf8c71eab1915f2a156c6
 SHA512:
-  metadata.gz: 6f915001574717ed1bbadf7f528a6d8d04aa1143cf3ca736db3c1649e72cf4e0d3a60303df86456b6f5ab86a8b1a819987475361a6497f2488f3768ff243dc68
-  data.tar.gz: 865de6b37ea0db45a27852799e2853b37091f32e06e28a405123e429275a05c7591069039f878cf26f6064e0e5d58ad67c9d227ef8911c2092667f009b4610f5
+  metadata.gz: 0a04211a36264ac886ecb8b7260c23e767de8364725fdc39dbfbe508116a5201ec8a54f4edf1865b3b91c8ee0fca4d2152d7f1091fca056501995723e4edbce6
+  data.tar.gz: d0ac8d6a477e357ff6582079443b6221100d868e1234d7aaaa4a815108b0db2e024e84086e2ace0c3dc3d1b85b8cd40701737f4bc292dabf479ca6263bccd994

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [9.3.0](https://github.com/ClosureTree/closure_tree/compare/closure_tree/v9.2.0...closure_tree/v9.3.0) (2025-11-19)
+
+
+### Features
+
+* eager loading of hierarchies by defining the primary key ([#465](https://github.com/ClosureTree/closure_tree/issues/465)) ([8c7e490](https://github.com/ClosureTree/closure_tree/commit/8c7e490ff89239e44aee71577288bff0e177a8d6))
+
 ## [9.2.0](https://github.com/ClosureTree/closure_tree/compare/closure_tree/v9.1.1...closure_tree/v9.2.0) (2025-10-17)
 
 

data/README.md

@@ -319,6 +319,7 @@ When you include ```has_closure_tree``` in your model, you can provide a hash to
     * ```nil``` does nothing with descendant nodes
 * ```:name_column``` used by #```find_or_create_by_path```, #```find_by_path```, and ```ancestry_path``` instance methods. This is primarily useful if the model only has one required field (like a "tag").
 * ```:order``` used to set up [deterministic ordering](#deterministic-ordering)
+* ```:scope``` restricts root nodes and sibling ordering to specific columns. Can be a single symbol or an array of symbols. Example: ```scope: :user_id``` or ```scope: [:user_id, :group_id]```. This ensures that root nodes and siblings are scoped correctly when reordering. See [Ordering Roots](#ordering-roots) for more details.
 * ```:touch``` delegates to the `belongs_to` annotation for the parent, so `touch`ing cascades to all children (the performance of this for deep trees isn't currently optimal).
 
 ## Accessing Data
@@ -491,9 +492,30 @@ table. So for instance if you have 5 nodes with no parent, they will be ordered
 If your model represents many separate trees and you have a lot of records, this can cause performance
 problems, and doesn't really make much sense.
 
-You can disable this default behavior by passing `dont_order_roots: true` as an option to your delcaration:
+You can scope root nodes and sibling ordering by passing the `scope` option:
 
+```ruby
+class Block < ApplicationRecord
+  has_closure_tree order: 'sort_order', numeric_order: true, scope: :user_id
+end
 ```
+
+This ensures that:
+* Root nodes are scoped by the specified columns. You can filter roots like: ```Block.roots.where(user_id: 123)```
+* Sibling reordering only affects nodes with the same scope values
+* Children reordering respects the parent's scope values
+
+You can also scope by multiple columns:
+
+```ruby
+class Block < ApplicationRecord
+  has_closure_tree order: 'sort_order', numeric_order: true, scope: [:user_id, :group_id]
+end
+```
+
+Alternatively, you can disable root ordering entirely by passing `dont_order_roots: true`:
+
+```ruby
 has_closure_tree order: 'sort_order', numeric_order: true, dont_order_roots: true
 ```
 

data/lib/closure_tree/has_closure_tree.rb

@@ -14,7 +14,8 @@ module ClosureTree
         :numeric_order,
         :touch,
         :with_advisory_lock,
-        :advisory_lock_name
+        :advisory_lock_name,
+        :scope
       )
 
       class_attribute :_ct

data/lib/closure_tree/model.rb

@@ -80,7 +80,9 @@ module ClosureTree
     end
 
     def self_and_siblings
-      _ct.scope_with_order(_ct.base_class.where(_ct.parent_column_sym => _ct_parent_id))
+      scope = _ct.base_class.where(_ct.parent_column_sym => _ct_parent_id)
+      scope = _ct.apply_scope_conditions(scope, self)
+      _ct.scope_with_order(scope)
     end
 
     def siblings

data/lib/closure_tree/numeric_deterministic_ordering.rb

@@ -15,16 +15,19 @@ module ClosureTree
       return unless saved_change_to_attribute?(_ct.parent_column_name) && !@was_new_record
 
       was_parent_id = attribute_before_last_save(_ct.parent_column_name)
-      _ct.reorder_with_parent_id(was_parent_id)
+      scope_conditions = _ct.scope_values_from_instance(self)
+      _ct.reorder_with_parent_id(was_parent_id, nil, scope_conditions)
     end
 
     def _ct_reorder_siblings(minimum_sort_order_value = nil)
-      _ct.reorder_with_parent_id(_ct_parent_id, minimum_sort_order_value)
+      scope_conditions = _ct.scope_values_from_instance(self)
+      _ct.reorder_with_parent_id(_ct_parent_id, minimum_sort_order_value, scope_conditions)
       reload unless destroyed?
     end
 
     def _ct_reorder_children(minimum_sort_order_value = nil)
-      _ct.reorder_with_parent_id(_ct_id, minimum_sort_order_value)
+      scope_conditions = _ct.scope_values_from_instance(self)
+      _ct.reorder_with_parent_id(_ct_id, minimum_sort_order_value, scope_conditions)
     end
 
     def self_and_descendants_preordered

data/lib/closure_tree/numeric_order_support.rb

@@ -14,7 +14,7 @@ module ClosureTree
     end
 
     module MysqlAdapter
-      def reorder_with_parent_id(parent_id, minimum_sort_order_value = nil)
+      def reorder_with_parent_id(parent_id, minimum_sort_order_value = nil, scope_conditions = {})
         return if parent_id.nil? && dont_order_roots
 
         min_where = if minimum_sort_order_value
@@ -22,18 +22,21 @@ module ClosureTree
                     else
                       ''
                     end
+
+        scope_where = build_scope_where_clause(scope_conditions)
+
         connection.execute 'SET @i = 0'
         connection.execute <<-SQL.squish
           UPDATE #{quoted_table_name}
             SET #{quoted_order_column} = (@i := @i + 1) + #{minimum_sort_order_value.to_i - 1}
-          WHERE #{where_eq(parent_column_name, parent_id)} #{min_where}
+          WHERE #{where_eq(parent_column_name, parent_id)} #{min_where}#{scope_where}
           ORDER BY #{nulls_last_order_by}
         SQL
       end
     end
 
     module PostgreSQLAdapter
-      def reorder_with_parent_id(parent_id, minimum_sort_order_value = nil)
+      def reorder_with_parent_id(parent_id, minimum_sort_order_value = nil, scope_conditions = {})
         return if parent_id.nil? && dont_order_roots
 
         min_where = if minimum_sort_order_value
@@ -41,13 +44,16 @@ module ClosureTree
                     else
                       ''
                     end
+
+        scope_where = build_scope_where_clause(scope_conditions)
+
         connection.execute <<-SQL.squish
           UPDATE #{quoted_table_name}
           SET #{quoted_order_column(false)} = t.seq + #{minimum_sort_order_value.to_i - 1}
           FROM (
             SELECT #{quoted_id_column_name} AS id, row_number() OVER(ORDER BY #{order_by}) AS seq
             FROM #{quoted_table_name}
-            WHERE #{where_eq(parent_column_name, parent_id)} #{min_where}
+            WHERE #{where_eq(parent_column_name, parent_id)} #{min_where}#{scope_where}
           ) AS t
           WHERE #{quoted_table_name}.#{quoted_id_column_name} = t.id and
                 #{quoted_table_name}.#{quoted_order_column(false)} is distinct from t.seq + #{minimum_sort_order_value.to_i - 1}
@@ -60,12 +66,13 @@ module ClosureTree
     end
 
     module GenericAdapter
-      def reorder_with_parent_id(parent_id, minimum_sort_order_value = nil)
+      def reorder_with_parent_id(parent_id, minimum_sort_order_value = nil, scope_conditions = {})
         return if parent_id.nil? && dont_order_roots
 
         scope = model_class
                 .where(parent_column_sym => parent_id)
                 .order(nulls_last_order_by)
+        scope = scope.where(scope_conditions) if scope_conditions.any?
         scope = scope.where("#{quoted_order_column} >= #{minimum_sort_order_value}") if minimum_sort_order_value
         scope.each_with_index do |ea, idx|
           ea.update_order_value(idx + minimum_sort_order_value.to_i)

data/lib/closure_tree/support.rb

@@ -23,6 +23,13 @@ module ClosureTree
       }.merge(options)
       raise ArgumentError, "name_column can't be 'path'" if options[:name_column] == 'path'
 
+      if options[:scope]
+        scope_option = options[:scope]
+        unless scope_option.is_a?(Symbol) || (scope_option.is_a?(Array) && scope_option.all? { |item| item.is_a?(Symbol) })
+          raise ArgumentError, "scope option must be a Symbol or an Array of Symbols (e.g., :user_id or [:user_id, :group_id])"
+        end
+      end
+
       return unless order_is_numeric?
 
       extend NumericOrderSupport.adapter_for_connection(connection)
@@ -36,6 +43,10 @@ module ClosureTree
         # Rails 8.1+ requires an implicit_order_column for models without a primary key
         self.implicit_order_column = 'ancestor_id'
 
+        # Rails uses the primary key to correctly match associations when using a join to preload (e.g. via `eager_load`).
+        # The migration generator adds a unique index across these three columns so this is safe.
+        self.primary_key = [:ancestor_id, :descendant_id, :generations]
+
         belongs_to :ancestor, class_name: model_class_name
         belongs_to :descendant, class_name: model_class_name
         def ==(other)
@@ -109,6 +120,22 @@ module ClosureTree
       end
     end
 
+    # Builds SQL WHERE conditions for scope columns
+    # Returns a string that can be appended to a WHERE clause
+    def build_scope_where_clause(scope_conditions)
+      return '' unless scope_conditions.is_a?(Hash) && scope_conditions.any?
+
+      conditions = scope_conditions.map do |column, value|
+        if value.nil?
+          "#{connection.quote_column_name(column.to_s)} IS NULL"
+        else
+          "#{connection.quote_column_name(column.to_s)} = #{quoted_value(value)}"
+        end
+      end
+
+      " AND #{conditions.join(' AND ')}"
+    end
+
     def with_advisory_lock(&block)
       if options[:with_advisory_lock] && connection.supports_advisory_locks? && model_class.respond_to?(:with_advisory_lock)
         model_class.with_advisory_lock(advisory_lock_name) do
@@ -170,5 +197,49 @@ module ClosureTree
     def create!(model_class, attributes)
       create(model_class, attributes).tap(&:save!)
     end
+
+    def scope_columns
+      return [] unless options[:scope]
+
+      scope_option = options[:scope]
+
+      case scope_option
+      when Symbol
+        [scope_option]
+      when Array
+        scope_option.select { |item| item.is_a?(Symbol) }
+      else
+        []
+      end
+    end
+
+    def scope_values_from_instance(instance)
+      return {} unless options[:scope] && instance
+
+      scope_option = options[:scope]
+      scope_hash = {}
+
+      case scope_option
+      when Symbol
+        value = instance.read_attribute(scope_option)
+        scope_hash[scope_option] = value unless value.nil?
+      when Array
+        scope_option.each do |item|
+          if item.is_a?(Symbol)
+            value = instance.read_attribute(item)
+            scope_hash[item] = value unless value.nil?
+          end
+        end
+      end
+
+      scope_hash
+    end
+
+    def apply_scope_conditions(scope, instance = nil)
+      return scope unless options[:scope] && instance
+
+      scope_values = scope_values_from_instance(instance)
+      scope_values.any? ? scope.where(scope_values) : scope
+    end
   end
 end

data/lib/closure_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClosureTree
-  VERSION = Gem::Version.new('9.2.0')
+  VERSION = Gem::Version.new('9.3.0')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: closure_tree
 version: !ruby/object:Gem::Version
-  version: 9.2.0
+  version: 9.3.0
 platform: ruby
 authors:
 - Matthew McEachen
@@ -178,7 +178,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/ClosureTree/closure_tree/issues
   changelog_uri: https://github.com/ClosureTree/closure_tree/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/closure_tree/9.2.0
+  documentation_uri: https://www.rubydoc.info/gems/closure_tree/9.3.0
   homepage_uri: https://closuretree.github.io/closure_tree/
   source_code_uri: https://github.com/ClosureTree/closure_tree
   rubygems_mfa_required: 'true'