apply patch for root ordering scope (ClosureTree#442)

Author: derek-etherton-opslevel

lib/closure_tree/has_closure_tree.rb

@@ -11,7 +11,8 @@ def has_closure_tree(options = {})
         :dont_order_roots,
         :numeric_order,
         :touch,
-        :with_advisory_lock
+        :with_advisory_lock,
+        :order_belong_to
       )
 
       class_attribute :_ct

lib/closure_tree/model.rb

@@ -171,6 +171,10 @@ def _ct_parent_id
       read_attribute(_ct.parent_column_sym)
     end
 
+    def _ct_belong_to_id
+      read_attribute(_ct.belong_to_column_sym)
+    end
+
     def _ct_quoted_parent_id
       _ct.quoted_value(_ct_parent_id)
     end

lib/closure_tree/numeric_deterministic_ordering.rb

@@ -17,17 +17,17 @@ def _ct_reorder_prior_siblings_if_parent_changed
         attribute_method = as_5_1 ? :attribute_before_last_save : :attribute_was
 
         was_parent_id = public_send(attribute_method, _ct.parent_column_name)
-        _ct.reorder_with_parent_id(was_parent_id)
+        _ct.reorder_with_parent_id(parent_id: was_parent_id, belong_to_name: _ct.belong_to_column_sym, belong_to_id: _ct_belong_to_id)
       end
     end
 
     def _ct_reorder_siblings(minimum_sort_order_value = nil)
-      _ct.reorder_with_parent_id(_ct_parent_id, minimum_sort_order_value)
+      _ct.reorder_with_parent_id(parent_id: _ct_parent_id, minimum_sort_order_value: minimum_sort_order_value, belong_to_name: _ct.belong_to_column_sym, belong_to_id: _ct_belong_to_id)
       reload unless destroyed?
     end
 
     def _ct_reorder_children(minimum_sort_order_value = nil)
-      _ct.reorder_with_parent_id(_ct_id, minimum_sort_order_value)
+      _ct.reorder_with_parent_id(parent_id: _ct_id, minimum_sort_order_value: minimum_sort_order_value)
     end
 
     def self_and_descendants_preordered

lib/closure_tree/numeric_order_support.rb

@@ -13,38 +13,48 @@ def self.adapter_for_connection(connection)
     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, belong_to_name: nil, belong_to_id: nil)
         return if parent_id.nil? && dont_order_roots
         min_where = if minimum_sort_order_value
           "AND #{quoted_order_column} >= #{minimum_sort_order_value}"
         else
           ""
         end
+        belong_to_scope = if parent_id.nil? && belong_to_id
+          "AND #{quoted_table_name}.#{belong_to_name} = #{belong_to_id}"
+        else
+          ""
+        end
         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} #{belong_to_scope}
           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, belong_to_name: nil, belong_to_id: nil)
         return if parent_id.nil? && dont_order_roots
         min_where = if minimum_sort_order_value
           "AND #{quoted_order_column} >= #{minimum_sort_order_value}"
         else
           ""
         end
+        belong_to_scope = if parent_id.nil? && belong_to_id
+          "AND #{quoted_table_name}.#{belong_to_name} = #{belong_to_id}"
+        else
+          ""
+        end
         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} #{belong_to_scope}
           ) 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}
@@ -57,14 +67,15 @@ def rows_updated(result)
     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, belong_to_name: nil, belong_to_id: nil)
         return if parent_id.nil? && dont_order_roots
         scope = model_class.
           where(parent_column_sym => parent_id).
           order(nulls_last_order_by)
         if minimum_sort_order_value
           scope = scope.where("#{quoted_order_column} >= #{minimum_sort_order_value}")
         end
+        scope = scope.where(belong_to_name => belong_to_id) if belong_to_id
         scope.each_with_index do |ea, idx|
           ea.update_order_value(idx + minimum_sort_order_value.to_i)
         end

lib/closure_tree/support_attributes.rb

@@ -36,6 +36,14 @@ def parent_column_sym
       parent_column_name.to_sym
     end
 
+    def belong_to_column_name
+      options[:order_belong_to]
+    end
+
+    def belong_to_column_sym
+      belong_to_column_name&.to_sym
+    end
+
     def name_column
       options[:name_column]
     end

spec/closure_tree/root_ordering.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Block do
+  describe "correct root order_value" do
+    let!(:group) { Group.create!(name: "TheGroup") }
+    let!(:user1) { User.create!(email: "[email protected]", group_id: group.id) }
+    let!(:user2) { User.create!(email: "[email protected]", group_id: group.id) }
+    let!(:block1) { Block.create!(name: "1block", user_id: user1.id) }
+    let!(:block2) { Block.create!(name: "2block", user_id: user2.id) }
+    let!(:block3) { Block.create!(name: "3block", user_id: user1.id) }
+    let!(:block4) { Block.create!(name: "4block", user_id: user2.id) }
+    let!(:block5) { Block.create!(name: "5block", user_id: user1.id) }
+    let!(:block6) { Block.create!(name: "6block", user_id: user2.id) }
+
+    it "should set order_value on roots" do
+      assert_equal block1.self_and_siblings.pluck(:sort_order), [1,2,3]
+      assert_equal block2.self_and_siblings.pluck(:sort_order), [1,2,3]
+    end
+  end
+end

spec/support/models.rb

@@ -78,6 +78,13 @@ class ContractType < ActiveRecord::Base
   has_many :contracts, inverse_of: :contract_type
 end
 
+class Block < ApplicationRecord
+  acts_as_tree order: :column_whereby_ordering_is_inferred, # <- symbol, and not "sort_order"
+               numeric_order: true,
+               dependent: :destroy,
+               order_belong_to: :user_id
+end
+
 class Label < ActiveRecord::Base
   # make sure order doesn't matter
   acts_as_tree :order => :column_whereby_ordering_is_inferred, # <- symbol, and not "sort_order"

spec/support/schema.rb

@@ -12,6 +12,14 @@
 
   add_foreign_key(:tags, :tags, :column => 'parent_id')
 
+  create_table 'blocks' do |t|
+    t.string 'name'
+    t.references 'parent'
+    t.references 'user', null: false
+    t.integer 'sort_order'
+    t.timestamps null: false
+  end
+
   create_table "tag_hierarchies", :id => false do |t|
     t.references "ancestor", :null => false
     t.references "descendant", :null => false