@quenty/binder 14.44.0 → 14.46.0

package/src/Shared/Collection/BoundChildCollection.lua

@@ -21,6 +21,7 @@ export type BoundChildCollection<T> =
 			_binder: Binder.Binder<T>,
 			_parent: Instance,
 			_classes: Set.Set<T>,
+			_childToClass: { [Instance]: T },
 			ClassAdded: Signal.Signal<T>,
 			ClassRemoved: Signal.Signal<T>,
 			_size: number,
@@ -56,15 +57,9 @@ function BoundChildCollection.new<T>(binder: Binder.Binder<T>, parent: Instance)
 	self.ClassRemoved = self._maid:Add(Signal.new() :: any) -- :Fire(class)
 
 	self._classes = {} -- [class] = true
+	self._childToClass = {}
 	self._size = 0
 
-	self._maid:GiveTask(self._binder:GetClassAddedSignal():Connect(function(...)
-		self:_handleNewClassBound(...)
-	end))
-	self._maid:GiveTask(self._binder:GetClassRemovingSignal():Connect(function(class)
-		self:_removeClass(class)
-	end))
-
 	self:_startTracking()
 
 	return self
@@ -128,29 +123,39 @@ function BoundChildCollection._startTracking<T>(self: BoundChildCollection<T>)
 end
 
 function BoundChildCollection._addChild<T>(self: BoundChildCollection<T>, inst: Instance, doNotFire: boolean?): ()
-	local class = self._binder:Get(inst)
-	if not class then
-		return
-	end
+	self._maid[inst] = self._binder:ObserveInstance(inst, function(class)
+		self:_setChildClass(inst, class)
+	end)
 
-	self:_addClass(class, doNotFire)
+	self:_setChildClass(inst, self._binder:Get(inst), doNotFire)
 end
 
-function BoundChildCollection._handleNewClassBound<T>(self: BoundChildCollection<T>, class: T, inst: Instance): ()
-	if inst.Parent ~= self._parent then
-		return
-	end
+function BoundChildCollection._removeChild<T>(self: BoundChildCollection<T>, inst: Instance): ()
+	self._maid[inst] = nil
 
-	self:_addClass(class)
+	self:_setChildClass(inst, nil)
 end
 
-function BoundChildCollection._removeChild<T>(self: BoundChildCollection<T>, inst: Instance): ()
-	local class = self._binder:Get(inst)
-	if not class then
+function BoundChildCollection._setChildClass<T>(
+	self: BoundChildCollection<T>,
+	inst: Instance,
+	class: T?,
+	doNotFire: boolean?
+): ()
+	local existing = self._childToClass[inst]
+	if existing == class then
 		return
 	end
 
-	self:_removeClass(class)
+	if existing ~= nil then
+		self._childToClass[inst] = nil
+		self:_removeClass(existing)
+	end
+
+	if class ~= nil then
+		self._childToClass[inst] = class
+		self:_addClass(class, doNotFire)
+	end
 end
 
 function BoundChildCollection._addClass<T>(self: BoundChildCollection<T>, class: T, doNotFire: boolean?): ()

package/src/Shared/Collection/BoundChildCollection.spec.lua

@@ -9,6 +9,8 @@ local Binder = require("Binder")
 local BinderProvider = require("BinderProvider")
 local BoundChildCollection = require("BoundChildCollection")
 local Jest = require("Jest")
+local JestUtils = require("JestUtils")
+local Maid = require("Maid")
 local ServiceBag = require("ServiceBag")
 
 local describe = Jest.Globals.describe
@@ -29,6 +31,8 @@ local function makeClass()
 end
 
 local function setup()
+	local maid = Maid.new()
+
 	specCounter += 1
 	local suffix = specCounter
 
@@ -37,8 +41,8 @@ local function setup()
 	container.Name = "BoundChildCollectionSpecContainer"
 	container.Parent = workspace
 
-	local instances = {}
-	local cleanups = {}
+	local instances: { Instance } = {}
+	local cleanups: { any } = {}
 	local booted = false
 
 	local binder = Binder.new(string.format("BoundChildCollectionSpecTag_%d", suffix), makeClass() :: any)
@@ -67,27 +71,35 @@ local function setup()
 		serviceBag:Start()
 	end
 
-	return {
+	maid:GiveTask(function()
+		for _, item in cleanups do
+			pcall(function()
+				item:Destroy()
+			end)
+		end
+		serviceBag:Destroy()
+		for _, inst in instances do
+			pcall(function()
+				inst:Destroy()
+			end)
+		end
+		container:Destroy()
+	end)
+
+	local controller = {
 		container = container,
 		binder = binder,
 		newInstance = newInstance,
 		track = track,
 		boot = boot,
-		destroy = function()
-			for _, item in cleanups do
-				pcall(function()
-					item:Destroy()
-				end)
-			end
-			serviceBag:Destroy()
-			for _, inst in instances do
-				pcall(function()
-					inst:Destroy()
-				end)
-			end
-			container:Destroy()
+		Destroy = function(_self)
+			maid:DoCleaning()
 		end,
 	}
+
+	maid:GiveTask(JestUtils.afterThis(controller))
+
+	return controller
 end
 
 describe("BoundChildCollection construction", function()
@@ -114,7 +126,7 @@ describe("BoundChildCollection construction", function()
 		expect(#collection:GetClasses()).toEqual(2)
 		expect(collection:HasClass(controller.binder:Get(childA))).toEqual(true)
 
-		controller.destroy()
+		controller:Destroy()
 	end)
 end)
 
@@ -146,7 +158,97 @@ describe("BoundChildCollection dynamic updates", function()
 		expect(addedClass).toEqual(class)
 		expect(collection:GetSize()).toEqual(1)
 
-		controller.destroy()
+		controller:Destroy()
+	end)
+
+	it("fires ClassAdded when an existing child binds after construction", function()
+		local controller = setup()
+
+		local parent = controller.newInstance()
+		local child = controller.newInstance(parent)
+		controller.boot()
+
+		local collection = controller.track(BoundChildCollection.new(controller.binder, parent))
+		expect(collection:GetSize()).toEqual(0)
+
+		local added = {}
+		collection.ClassAdded:Connect(function(class)
+			table.insert(added, class)
+		end)
+
+		controller.binder:Tag(child)
+
+		expect(collection:GetSize()).toEqual(1)
+		expect(#added).toEqual(1)
+		expect(added[1]).toEqual(controller.binder:Get(child))
+
+		controller:Destroy()
+	end)
+
+	it("ignores a bind on an instance that is not a child of the parent", function()
+		local controller = setup()
+
+		local parent = controller.newInstance()
+		local outsider = controller.newInstance()
+		local grandchild = controller.newInstance(controller.newInstance(parent))
+		controller.boot()
+
+		local collection = controller.track(BoundChildCollection.new(controller.binder, parent))
+
+		controller.binder:Tag(outsider)
+		controller.binder:Tag(grandchild)
+
+		expect(collection:GetSize()).toEqual(0)
+
+		controller:Destroy()
+	end)
+
+	it("stops following a child that was reparented out", function()
+		local controller = setup()
+
+		local parent = controller.newInstance()
+		local child = controller.newInstance(parent)
+		controller.binder:Tag(child)
+		controller.boot()
+
+		local collection = controller.track(BoundChildCollection.new(controller.binder, parent))
+		expect(collection:GetSize()).toEqual(1)
+
+		child.Parent = controller.container
+		expect(collection:GetSize()).toEqual(0)
+
+		local removed = 0
+		collection.ClassRemoved:Connect(function()
+			removed += 1
+		end)
+
+		controller.binder:Untag(child)
+
+		expect(collection:GetSize()).toEqual(0)
+		expect(removed).toEqual(0)
+
+		controller:Destroy()
+	end)
+
+	it("re-adds a child that leaves and comes back", function()
+		local controller = setup()
+
+		local parent = controller.newInstance()
+		local child = controller.newInstance(parent)
+		controller.binder:Tag(child)
+		controller.boot()
+
+		local collection = controller.track(BoundChildCollection.new(controller.binder, parent))
+		expect(collection:GetSize()).toEqual(1)
+
+		child.Parent = controller.container
+		expect(collection:GetSize()).toEqual(0)
+
+		child.Parent = parent
+		expect(collection:GetSize()).toEqual(1)
+		expect(collection:HasClass(controller.binder:Get(child))).toEqual(true)
+
+		controller:Destroy()
 	end)
 
 	it("fires ClassRemoved when a tracked child is reparented out", function()
@@ -175,7 +277,7 @@ describe("BoundChildCollection dynamic updates", function()
 		expect(removedClass).toEqual(class)
 		expect(collection:GetSize()).toEqual(0)
 
-		controller.destroy()
+		controller:Destroy()
 	end)
 
 	it("fires ClassRemoved when a tracked child is unbound", function()
@@ -198,6 +300,6 @@ describe("BoundChildCollection dynamic updates", function()
 
 		expect(collection:GetSize()).toEqual(0)
 
-		controller.destroy()
+		controller:Destroy()
 	end)
 end)

package/src/Shared/Promise/promiseBoundClass.spec.lua

@@ -8,6 +8,8 @@ local require = require(script.Parent.loader).load(script)
 local Binder = require("Binder")
 local BinderProvider = require("BinderProvider")
 local Jest = require("Jest")
+local JestUtils = require("JestUtils")
+local Maid = require("Maid")
 local ServiceBag = require("ServiceBag")
 local promiseBoundClass = require("promiseBoundClass")
 
@@ -29,6 +31,8 @@ local function makeClass()
 end
 
 local function setup()
+	local maid = Maid.new()
+
 	specCounter += 1
 	local suffix = specCounter
 
@@ -37,7 +41,7 @@ local function setup()
 	container.Name = "PromiseBoundClassSpecContainer"
 	container.Parent = workspace
 
-	local instances = {}
+	local instances: { Instance } = {}
 	local booted = false
 
 	local binder = Binder.new(string.format("PromiseBoundClassSpecTag_%d", suffix), makeClass() :: any)
@@ -61,20 +65,28 @@ local function setup()
 		serviceBag:Start()
 	end
 
-	return {
+	maid:GiveTask(function()
+		serviceBag:Destroy()
+		for _, inst in instances do
+			pcall(function()
+				inst:Destroy()
+			end)
+		end
+		container:Destroy()
+	end)
+
+	local controller = {
 		binder = binder,
 		newInstance = newInstance,
 		boot = boot,
-		destroy = function()
-			serviceBag:Destroy()
-			for _, inst in instances do
-				pcall(function()
-					inst:Destroy()
-				end)
-			end
-			container:Destroy()
+		Destroy = function(_self)
+			maid:DoCleaning()
 		end,
 	}
+
+	maid:GiveTask(JestUtils.afterThis(controller))
+
+	return controller
 end
 
 describe("promiseBoundClass()", function()
@@ -89,7 +101,7 @@ describe("promiseBoundClass()", function()
 		assert(ok, "Never bound")
 		expect(class).toEqual(controller.binder:Get(inst))
 
-		controller.destroy()
+		controller:Destroy()
 	end)
 
 	it("resolves once an instance is bound after start", function()
@@ -102,7 +114,7 @@ describe("promiseBoundClass()", function()
 		local ok = promiseBoundClass(controller.binder, inst):Yield()
 		expect(ok).toEqual(true)
 
-		controller.destroy()
+		controller:Destroy()
 	end)
 
 	it("throws when the binder is not a binder", function()
@@ -113,7 +125,7 @@ describe("promiseBoundClass()", function()
 			promiseBoundClass({} :: any, controller.newInstance())
 		end).toThrow()
 
-		controller.destroy()
+		controller:Destroy()
 	end)
 
 	it("throws when the instance is not an Instance", function()
@@ -124,6 +136,6 @@ describe("promiseBoundClass()", function()
 			promiseBoundClass(controller.binder, 5 :: any)
 		end).toThrow()
 
-		controller.destroy()
+		controller:Destroy()
 	end)
 end)

package/src/Shared/Trackers/BoundAncestorTracker.lua

@@ -1,83 +0,0 @@
---!strict
---[=[
-	Tracks a parent bound to a specific binder
-	@class BoundAncestorTracker
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local BaseObject = require("BaseObject")
-local Binder = require("Binder")
-local BinderUtils = require("BinderUtils")
-local ValueObject = require("ValueObject")
-
-local BoundAncestorTracker = setmetatable({}, BaseObject)
-BoundAncestorTracker.ClassName = "BoundAncestorTracker"
-BoundAncestorTracker.__index = BoundAncestorTracker
-
-export type BoundAncestorTracker<T> =
-	typeof(setmetatable(
-		{} :: {
-			_child: Instance,
-			_binder: Binder.Binder<T>,
-			Class: ValueObject.ValueObject<T?>,
-		},
-		{} :: typeof({ __index = BoundAncestorTracker })
-	))
-	& BaseObject.BaseObject
-
---[=[
-Constructs a new BoundAncestorTracker
-
-@param binder Binder<T>
-@param child Instance
-@return BoundAncestorTracker
-]=]
-function BoundAncestorTracker.new<T>(binder: Binder.Binder<T>, child: Instance): BoundAncestorTracker<T>
-	local self: BoundAncestorTracker<T> = setmetatable(BaseObject.new() :: any, BoundAncestorTracker)
-
-	self._child = child or error("No child")
-	self._binder = binder or error("No binder")
-
-	--[=[
-	@prop Class ValueObject<T>
-	@readonly
-	@within BoundAncestorTracker
-	Bound value
-]=]
-	self.Class = ValueObject.new() :: ValueObject.ValueObject<T?>
-	self._maid:GiveTask(self.Class)
-
-	-- Handle instance removing
-	self._maid:GiveTask(self._binder:GetClassRemovingSignal():Connect(function(class)
-		if class == self.Class.Value then
-			self.Class.Value = nil
-		end
-	end))
-
-	self._maid:GiveTask(self._binder:GetClassAddedSignal():Connect(function(_, instance)
-		if self._child:IsDescendantOf(instance) then
-			self:_update()
-		end
-	end))
-
-	-- Perform update
-	self._maid:GiveTask(self._child.AncestryChanged:Connect(function()
-		self:_update()
-	end))
-	self:_update()
-
-	return self
-end
-
-function BoundAncestorTracker._update<T>(self: BoundAncestorTracker<T>): ()
-	local parent = self._child.Parent
-	if not parent then
-		self.Class.Value = nil
-		return
-	end
-
-	self.Class.Value = BinderUtils.findFirstAncestor(self._binder, parent)
-end
-
-return BoundAncestorTracker

package/src/Shared/Trackers/BoundAncestorTracker.spec.lua

@@ -1,167 +0,0 @@
---!strict
---[[
-	@class BoundAncestorTracker.spec.lua
-]]
-
-local require = require(script.Parent.loader).load(script)
-
-local Binder = require("Binder")
-local BinderProvider = require("BinderProvider")
-local BoundAncestorTracker = require("BoundAncestorTracker")
-local Jest = require("Jest")
-local ServiceBag = require("ServiceBag")
-
-local describe = Jest.Globals.describe
-local expect = Jest.Globals.expect
-local it = Jest.Globals.it
-
-local specCounter = 0
-
-local function makeClass()
-	local Class = {}
-	Class.__index = Class
-	Class.ClassName = "BoundAncestorTrackerSpecClass"
-	function Class.new(inst)
-		return setmetatable({ instance = inst }, Class)
-	end
-	function Class:Destroy() end
-	return Class
-end
-
-local function setup()
-	specCounter += 1
-	local suffix = specCounter
-
-	local serviceBag = ServiceBag.new()
-	local container = Instance.new("Folder")
-	container.Name = "BoundAncestorTrackerSpecContainer"
-	container.Parent = workspace
-
-	local instances = {}
-	local cleanups = {}
-	local booted = false
-
-	local binder = Binder.new(string.format("BoundAncestorTrackerSpecTag_%d", suffix), makeClass() :: any)
-
-	local function newInstance(parent: Instance?): Instance
-		local inst = Instance.new("Folder")
-		inst.Parent = parent or container
-		table.insert(instances, inst)
-		return inst
-	end
-
-	local function track(item: any): any
-		table.insert(cleanups, item)
-		return item
-	end
-
-	local function boot()
-		assert(not booted, "Already booted")
-		booted = true
-
-		local provider = BinderProvider.new(string.format("BoundAncestorTrackerSpecProvider_%d", suffix), function(self)
-			self:Add(binder)
-		end)
-		serviceBag:GetService(provider)
-		serviceBag:Init()
-		serviceBag:Start()
-	end
-
-	local function awaitChange(tracker, previous)
-		if tracker.Class.Value == previous then
-			tracker.Class.Changed:Wait()
-		end
-		return tracker.Class.Value
-	end
-
-	return {
-		container = container,
-		binder = binder,
-		newInstance = newInstance,
-		track = track,
-		boot = boot,
-		awaitChange = awaitChange,
-		destroy = function()
-			for _, item in cleanups do
-				pcall(function()
-					item:Destroy()
-				end)
-			end
-			serviceBag:Destroy()
-			for _, inst in instances do
-				pcall(function()
-					inst:Destroy()
-				end)
-			end
-			container:Destroy()
-		end,
-	}
-end
-
-describe("BoundAncestorTracker tracking", function()
-	it("exposes the nearest bound ancestor's class", function()
-		local controller = setup()
-
-		local grandparent = controller.newInstance()
-		local parent = controller.newInstance(grandparent)
-		local child = controller.newInstance(parent)
-		controller.binder:Tag(grandparent)
-		controller.boot()
-
-		local tracker = controller.track(BoundAncestorTracker.new(controller.binder, child))
-		expect(tracker.Class.Value).toEqual(controller.binder:Get(grandparent))
-
-		controller.destroy()
-	end)
-
-	it("has no value when no ancestor is bound", function()
-		local controller = setup()
-
-		local parent = controller.newInstance()
-		local child = controller.newInstance(parent)
-		controller.boot()
-
-		local tracker = controller.track(BoundAncestorTracker.new(controller.binder, child))
-		expect(tracker.Class.Value).toBeNil()
-
-		controller.destroy()
-	end)
-
-	it("updates when an ancestor becomes bound", function()
-		local controller = setup()
-
-		-- The tracker resolves ancestors above the child's direct parent, so bind the grandparent.
-		local ancestor = controller.newInstance()
-		local parent = controller.newInstance(ancestor)
-		local child = controller.newInstance(parent)
-		controller.boot()
-
-		local tracker = controller.track(BoundAncestorTracker.new(controller.binder, child))
-		expect(tracker.Class.Value).toBeNil()
-
-		controller.binder:Tag(ancestor)
-		local value = controller.awaitChange(tracker, nil)
-		expect(value).toEqual(controller.binder:Get(ancestor))
-
-		controller.destroy()
-	end)
-
-	it("clears the value when the child leaves the bound ancestry", function()
-		local controller = setup()
-
-		local ancestor = controller.newInstance()
-		local parent = controller.newInstance(ancestor)
-		local child = controller.newInstance(parent)
-		controller.binder:Tag(ancestor)
-		controller.boot()
-
-		local tracker = controller.track(BoundAncestorTracker.new(controller.binder, child))
-		local class = controller.binder:Get(ancestor)
-		expect(tracker.Class.Value).toEqual(class)
-
-		child.Parent = controller.container
-		expect(controller.awaitChange(tracker, class)).toBeNil()
-
-		controller.destroy()
-	end)
-end)

package/src/Shared/Trackers/BoundParentTracker.lua

@@ -1,64 +0,0 @@
---!strict
---[=[
-	Tracks a parent bound to a specific binder
-	@class BoundParentTracker
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local BaseObject = require("BaseObject")
-local Binder = require("Binder")
-local ValueObject = require("ValueObject")
-
-local BoundParentTracker = setmetatable({}, BaseObject)
-BoundParentTracker.ClassName = "BoundParentTracker"
-BoundParentTracker.__index = BoundParentTracker
-
-export type BoundParentTracker<T> =
-	typeof(setmetatable(
-		{} :: {
-			_child: Instance,
-			_binder: Binder.Binder<T>,
-			Class: ValueObject.ValueObject<T?>,
-		},
-		{} :: typeof({ __index = BoundParentTracker })
-	))
-	& BaseObject.BaseObject
-
-function BoundParentTracker.new<T>(binder: Binder.Binder<T>, child: Instance): BoundParentTracker<T>
-	local self: BoundParentTracker<T> = setmetatable(BaseObject.new() :: any, BoundParentTracker)
-
-	self._child = child or error("No child")
-	self._binder = binder or error("No binder")
-
-	-- Bound value
-	self.Class = ValueObject.new(nil :: T?)
-	self._maid:GiveTask(self.Class)
-
-	-- Handle instance removing
-	self._maid:GiveTask(self._binder:GetClassRemovingSignal():Connect(function(class)
-		if class == self.Class.Value then
-			self.Class.Value = nil
-		end
-	end))
-
-	-- Perform update
-	self._maid:GiveTask(self._child:GetPropertyChangedSignal("Parent"):Connect(function()
-		self:_update()
-	end))
-	self:_update()
-
-	return self
-end
-
-function BoundParentTracker._update<T>(self: BoundParentTracker<T>): ()
-	local parent = self._child.Parent
-	if not parent then
-		self.Class.Value = nil
-		return
-	end
-
-	self.Class.Value = self._binder:Get(parent)
-end
-
-return BoundParentTracker