@quenty/binder 8.17.0 → 8.18.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.17.0...@quenty/binder@8.18.0) (2023-06-17)
+
+
+### Features
+
+* Binders can be initialized by the ServiceBag directly instead of requireing a BinderProvider ([28ce17f](https://github.com/Quenty/NevermoreEngine/commit/28ce17fe254b7fdce115132244ca1a6e8693d24b))
+
+
+
+
+
 # [8.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@8.16.0...@quenty/binder@8.17.0) (2023-06-05)
 
 **Note:** Version bump only for package @quenty/binder

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/binder",
-  "version": "8.17.0",
+  "version": "8.18.0",
   "description": "Utility object to Bind a class to Roblox object, and associated helper methods",
   "keywords": [
     "Roblox",
@@ -26,17 +26,18 @@
   ],
   "dependencies": {
     "@quenty/baseobject": "^6.2.1",
-    "@quenty/brio": "^8.13.0",
-    "@quenty/instanceutils": "^7.14.0",
-    "@quenty/linkutils": "^7.14.0",
+    "@quenty/brio": "^8.14.0",
+    "@quenty/instanceutils": "^7.15.0",
+    "@quenty/linkutils": "^7.15.0",
     "@quenty/loader": "^6.2.1",
     "@quenty/maid": "^2.5.0",
-    "@quenty/promise": "^6.5.0",
+    "@quenty/promise": "^6.6.0",
+    "@quenty/rx": "^7.12.0",
     "@quenty/signal": "^2.4.0",
-    "@quenty/valueobject": "^7.15.0"
+    "@quenty/valueobject": "^7.16.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d8ad8f8567843d3867b6c06c8c57ec4493672335"
+  "gitHead": "dc77d6de09e9eb9d3fd6dafd790c052d8393d38f"
 }

package/src/Shared/Binder.lua

@@ -31,8 +31,10 @@ local CollectionService = game:GetService("CollectionService")
 
 local Maid = require("Maid")
 local MaidTaskUtils = require("MaidTaskUtils")
-local Signal = require("Signal")
+local Observable = require("Observable")
 local promiseBoundClass = require("promiseBoundClass")
+local Signal = require("Signal")
+local Brio = require("Brio")
 
 local Binder = {}
 Binder.__index = Binder
@@ -65,22 +67,17 @@ Binder.ClassName = "Binder"
 	@return Binder<T>
 ]=]
 function Binder.new(tagName, constructor, ...)
-	local self = setmetatable({}, Binder)
+	assert(type(tagName) == "string", "Bad tagName")
 
-	self._maid = Maid.new()
-	self._tagName = tagName or error("Bad argument 'tagName', expected string")
-	self._constructor = constructor or error("Bad argument 'constructor', expected table or function")
-
-	self._instToClass = {} -- [inst] = class
-	self._allClassSet = {} -- [class] = true
-	self._pendingInstSet = {} -- [inst] = true
+	local self = setmetatable({}, Binder)
 
-	self._listeners = {} -- [inst] = callback
-	self._args = {...}
+	self._tagName = assert(tagName, "Bad argument 'tagName', expected string")
+	self._constructor = assert(constructor, "Bad argument 'constructor', expected table or function")
+	self.ServiceName = self._tagName .. "Binder"
 
-	self._maid._warning = task.delay(5, function()
-		warn(("Binder %q is not loaded. Call :Start() on it!"):format(self._tagName))
-	end)
+	if select("#", ...) > 0 then
+		self._args = { ... }
+	end
 
 	return self
 end
@@ -111,10 +108,60 @@ function Binder.isBinder(value)
 		and type(value.Destroy) == "function"
 end
 
+--[=[
+	Initializes the Binder. Designed to be done via ServiceBag.
+
+	@param ... any
+]=]
+function Binder:Init(...)
+	if self._initialized then
+		return
+	end
+
+	self._initialized = true
+	self._maid = Maid.new()
+
+	self._instToClass = {} -- [inst] = class
+	self._allClassSet = {} -- [class] = true
+	self._pendingInstSet = {} -- [inst] = true
+
+	self._listeners = {} -- [inst] = callback
+
+	if select("#", ...) > 0 then
+		if not self._args then
+			self._args = {...}
+		elseif not self:_argsMatch(...) then
+			warn("[Binder.Init] - Non-matching args from :Init() and .new()")
+		end
+	end
+
+	self._maid._warning = task.delay(5, function()
+		warn(("Binder %q is not loaded. Call :Start() on it!"):format(self._tagName))
+	end)
+end
+
+function Binder:_argsMatch(...)
+	if #self._args ~= select("#", ...) then
+		return false
+	end
+
+	for index, value in pairs({...}) do
+		if self._args[index] ~= value then
+			return false
+		end
+	end
+
+	return true
+end
+
 --[=[
 	Listens for new instances and connects to the GetInstanceAddedSignal() and removed signal!
 ]=]
 function Binder:Start()
+	if not self._initialized then
+		self:Init()
+	end
+
 	if self._loaded then
 		return
 	end
@@ -151,9 +198,65 @@ function Binder:GetConstructor()
 	return self._constructor
 end
 
+--[=[
+	Observes the current value of the instance
+
+	@param instance Instance
+	@return Observable<T | nil>
+]=]
+function Binder:Observe(instance)
+	assert(typeof(instance) == "Instance", "Bad instance")
+
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		maid:GiveTask(self:ObserveInstance(instance, function(...)
+			sub:Fire(...)
+		end))
+		sub:Fire(self:Get(instance))
+
+		return maid
+	end)
+end
+
+--[=[
+	Observes a bound class on a given instance.
+
+	@param instance Instance
+	@return Observable<Brio<T>>
+]=]
+function Binder:ObserveBrio(instance)
+	assert(typeof(instance) == "Instance", "Bad instance")
+
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local function handleClassChanged(class)
+			if class then
+				local brio = Brio.new(class)
+				maid._lastBrio = brio
+
+				sub:Fire(brio)
+			else
+				maid._lastBrio = nil
+			end
+		end
+
+		maid:GiveTask(self:ObserveInstance(instance, handleClassChanged))
+		handleClassChanged(self:Get(instance))
+
+		return maid
+	end)
+end
+
 --[=[
 	Fired when added, and then after removal, but before destroy!
 
+	```info
+	This is before [Rx] so it doesn't follow the same Rx pattern. See [Binder.Observe] for
+	an [Rx] compatible interface.
+	```
+
 	@param inst Instance
 	@param callback function
 	@return function -- Cleanup function
@@ -308,6 +411,28 @@ function Binder:Bind(inst)
 	return self:Get(inst)
 end
 
+--[=[
+	Tags the instance with the tag for the binder
+
+	@param inst Instance
+]=]
+function Binder:Tag(inst)
+	assert(typeof(inst) == "Instance", "Bad inst")
+
+	CollectionService:AddTag(inst, self._tagName)
+end
+
+--[=[
+	Untags the instance with the tag for the binder
+
+	@param inst Instance
+]=]
+function Binder:Untag(inst)
+	assert(typeof(inst) == "Instance", "Bad inst")
+
+	CollectionService:RemoveTag(inst, self._tagName)
+end
+
 --[=[
 	Unbinds the instance by removing the tag.
 

package/src/Shared/BinderProvider.lua

@@ -117,6 +117,10 @@ function BinderProvider:Init(...)
 
 	self._initMethod(self, ...)
 
+	for _, binder in pairs(self._binders) do
+		binder:Init(...)
+	end
+
 	self._bindersAddedPromise:Resolve()
 end