closure_tree 9.6.2 → 9.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7326f71d858362cf125f0db24593f22441bcfb1c1fc81124036d8d4cdaa7110f
-  data.tar.gz: 0b14cd7c237b4b48e7f04777c213dcaed3cfe526eb74d26672f1736ee5bf89ec
+  metadata.gz: 3b33b2d3bff238b8d3a42e41b94ece6f9b6c9efbcacd23628972d6237f2c3bda
+  data.tar.gz: 82a70b8fd95a7bdc6726e3408765027ff45caaa6c21080326966d39eeba89dd8
 SHA512:
-  metadata.gz: 53ae09bebff724ee6540d5b274330ef489726dfd690a164774a140382bc631ee0e10a8f4ad522e04f8a997714567bb2151d514b203aa6b14bc24785507a3c660
-  data.tar.gz: 14cc8606e54f4adf1de9331edc0833e7e4521a3b8a5fbb0bf9a99dad2fe619c69e6f22362f549ee44c36b21785ec14a0804a0ed3dd83976ad4350e839a6aba61
+  metadata.gz: 51f1f00fcc5c81e2fa380540178f63581aa1f66bfc941777480fb28ac87b2fbd00881e067940f62b5ae031e7a38d16a71f6b4a5e2b757e444df6e4343be09e73
+  data.tar.gz: 8116299896bd8f6eacdbfd7a4ffc8453d2328bc773760cb4d028c4444280b46513efcd7587c806bdd2194df46a0fba53847f232df99f7eadff99a3596606e5f3

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [9.7.0](https://github.com/ClosureTree/closure_tree/compare/closure_tree/v9.6.2...closure_tree/v9.7.0) (2026-05-06)
+
+
+### Features
+
+* allow advisory_lock_name proc to receive instance for per-tenant lock granularity ([#491](https://github.com/ClosureTree/closure_tree/issues/491)) ([a7a554c](https://github.com/ClosureTree/closure_tree/commit/a7a554c004fb865ab4ee721f929a8a00bb5cdc46))
+
 ## [9.6.2](https://github.com/ClosureTree/closure_tree/compare/closure_tree/v9.6.1...closure_tree/v9.6.2) (2026-04-07)
 
 

data/README.md

@@ -560,7 +560,7 @@ class Tag < ApplicationRecord
   has_closure_tree advisory_lock_name: 'custom_tag_lock'
 end
 
-# Dynamic via Proc
+# Dynamic via Proc (1-arity: receives model class only)
 class Tag < ApplicationRecord
   has_closure_tree advisory_lock_name: ->(model_class) { "#{Rails.env}_#{model_class.name.underscore}" }
 end
@@ -568,16 +568,36 @@ end
 # Delegate to model method
 class Tag < ApplicationRecord
   has_closure_tree advisory_lock_name: :custom_lock_name
-  
+
   def self.custom_lock_name
     "tag_lock_#{current_tenant_id}"
   end
 end
 ```
 
+#### Per-instance lock names (multi-tenant / scoped models)
+
+Pass a 2-arity proc to receive both the model class and the current record instance.
+This is the recommended approach for scoped models where each tenant should have its own lock,
+avoiding unnecessary serialization across tenants.
+
+```ruby
+class Node < ApplicationRecord
+  has_closure_tree scope: :company_id,
+                   advisory_lock_name: ->(klass, instance) {
+                     company = instance&.company_id
+                     company ? "ct_#{klass.name}_#{company}" : "ct_#{klass.name}"
+                   }
+end
+```
+
+When `instance` is `nil` (class-level operations like `Node.rebuild!`), the proc should
+fall back to a model-wide name. Instance-level operations (`save`, `destroy`, `add_sibling`,
+`find_or_create_by_path`) pass the record itself so the lock is scoped to that tenant.
+
 This is particularly useful when:
 * You need environment-specific lock names
-* You're using multi-tenancy and need tenant-specific locks
+* You're using multi-tenancy and need per-tenant locks (avoiding cross-tenant contention)
 * You want to avoid lock name collisions between similar model names
 
 ## Multi-Database Support

data/lib/closure_tree/finders.rb

@@ -20,7 +20,7 @@ module ClosureTree
       return found if found
 
       attrs = subpath.shift
-      _ct.with_advisory_lock do
+      _ct.with_advisory_lock(self) do
         # shenanigans because children.create is bound to the superclass
         # (in the case of polymorphism):
         child = children.where(attrs).first || begin

data/lib/closure_tree/hierarchy_maintenance.rb

@@ -64,7 +64,7 @@ module ClosureTree
     end
 
     def _ct_before_destroy
-      _ct.with_advisory_lock do
+      _ct.with_advisory_lock(self) do
         _ct_adopt_children_to_grandparent if _ct.options[:dependent] == :adopt
         delete_hierarchy_references
         self.class.find(id).children.find_each(&:rebuild!) if _ct.options[:dependent] == :nullify
@@ -86,7 +86,7 @@ module ClosureTree
     end
 
     def rebuild!(called_by_rebuild = false)
-      _ct.with_advisory_lock do
+      _ct.with_advisory_lock(self) do
         delete_hierarchy_references unless (defined? @was_new_record) && @was_new_record
         hierarchy_class.create!(ancestor: self, descendant: self, generations: 0)
         unless root?
@@ -112,7 +112,7 @@ module ClosureTree
     end
 
     def delete_hierarchy_references
-      _ct.with_advisory_lock do
+      _ct.with_advisory_lock(self) do
         # The crazy double-wrapped sub-subselect works around MySQL's limitation of subselects on the same table that is being mutated.
         # It shouldn't affect performance of postgresql.
         # See http://dev.mysql.com/doc/refman/5.0/en/subquery-errors.html

data/lib/closure_tree/numeric_deterministic_ordering.rb

@@ -162,7 +162,7 @@ module ClosureTree
       # Make sure self isn't dirty, because we're going to call reload:
       save
 
-      _ct.with_advisory_lock do
+      _ct.with_advisory_lock(self) do
         prior_sibling_parent = sibling.parent
 
         sibling.order_value = order_value

data/lib/closure_tree/support.rb

@@ -157,10 +157,10 @@ module ClosureTree
       " AND #{conditions.join(' AND ')}"
     end
 
-    def with_advisory_lock(&block)
+    def with_advisory_lock(instance = nil, &block)
       lock_method = options[:advisory_lock_timeout_seconds].present? ? :with_advisory_lock! : :with_advisory_lock
       if options[:with_advisory_lock] && connection.supports_advisory_locks? && model_class.respond_to?(lock_method)
-        model_class.public_send(lock_method, advisory_lock_name, advisory_lock_options) do
+        model_class.public_send(lock_method, advisory_lock_name(instance), advisory_lock_options) do
           transaction(&block)
         end
       else

data/lib/closure_tree/support_attributes.rb

@@ -8,28 +8,22 @@ module ClosureTree
     extend Forwardable
     def_delegators :model_class, :connection, :transaction, :table_name, :base_class, :inheritance_column, :column_names
 
-    def advisory_lock_name
-      # Allow customization via options or instance method
+    def advisory_lock_name(instance = nil)
       if options[:advisory_lock_name]
         case options[:advisory_lock_name]
         when Proc
-          # Allow dynamic generation via proc
-          options[:advisory_lock_name].call(base_class)
+          proc = options[:advisory_lock_name]
+          proc.arity == 1 ? proc.call(base_class) : proc.call(base_class, instance)
         when Symbol
-          # Allow delegation to a model method
           if model_class.respond_to?(options[:advisory_lock_name])
             model_class.send(options[:advisory_lock_name])
           else
             raise ArgumentError, "Model #{model_class} does not respond to #{options[:advisory_lock_name]}"
           end
         else
-          # Use static string value
           options[:advisory_lock_name].to_s
         end
       else
-        # Default: Use CRC32 for a shorter, consistent hash
-        # This gives us 8 hex characters which is plenty for uniqueness
-        # and leaves room for prefixes
         "ct_#{Zlib.crc32(base_class.name.to_s).to_s(16)}"
       end
     end

data/lib/closure_tree/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: closure_tree
 version: !ruby/object:Gem::Version
-  version: 9.6.2
+  version: 9.7.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.6.2
+  documentation_uri: https://www.rubydoc.info/gems/closure_tree/9.7.0
   homepage_uri: https://closuretree.github.io/closure_tree/
   source_code_uri: https://github.com/ClosureTree/closure_tree
   rubygems_mfa_required: 'true'