@quenty/valueobject 7.13.0 → 7.14.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [7.14.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@7.13.0...@quenty/valueobject@7.14.0) (2023-05-26)
+
+
+### Features
+
+* Add type checking and mounting to ValueObject ([c3ee035](https://github.com/Quenty/NevermoreEngine/commit/c3ee0354df477b96e60e7aa14fd7a95be8ecd6ed))
+* Initial refactor of guis to use ValueObject instead of ValueObject ([723aba0](https://github.com/Quenty/NevermoreEngine/commit/723aba0208cae7e06c9d8bf2d8f0092d042d70ea))
+
+
+
+
+
 # [7.13.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@7.12.0...@quenty/valueobject@7.13.0) (2023-05-08)
 
 **Note:** Version bump only for package @quenty/valueobject

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/valueobject",
-  "version": "7.13.0",
+  "version": "7.14.0",
   "description": "To work like value objects in Roblox and track a single item with .Changed events",
   "keywords": [
     "Roblox",
@@ -26,14 +26,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^8.12.0",
+    "@quenty/brio": "^8.13.0",
     "@quenty/loader": "^6.2.1",
     "@quenty/maid": "^2.5.0",
-    "@quenty/rx": "^7.10.0",
-    "@quenty/signal": "^2.3.0"
+    "@quenty/rx": "^7.11.0",
+    "@quenty/signal": "^2.4.0",
+    "@quenty/valuebaseutils": "^7.14.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2ad8cea7dd3ad79a39afd7d7b785b489b90553fd"
+  "gitHead": "11058e90e51ea83d3dad6ae9abe59cc19c36b94b"
 }

package/src/Shared/ValueObject.lua

@@ -6,9 +6,13 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Signal = require("Signal")
+local GoodSignal = require("GoodSignal")
 local Maid = require("Maid")
 local Observable = require("Observable")
+local ValueBaseUtils = require("ValueBaseUtils")
+local RxValueBaseUtils = require("RxValueBaseUtils")
+
+local EMPTY_FUNCTION = function() end
 
 local ValueObject = {}
 ValueObject.ClassName = "ValueObject"
@@ -16,21 +20,26 @@ ValueObject.ClassName = "ValueObject"
 --[=[
 	Constructs a new value object
 	@param baseValue T
+	@param checkType string | nil
 	@return ValueObject
 ]=]
-function ValueObject.new(baseValue)
-	local self = {}
-
-	rawset(self, "_value", baseValue)
-
-	self._maid = Maid.new()
+function ValueObject.new(baseValue, checkType)
+	local self = {
+		_value = baseValue;
+		_checkType = checkType;
+		_maid = Maid.new();
+	}
+
+	if checkType and typeof(baseValue) ~= checkType then
+		error(string.format("Expected value of type %q, got %q instead", checkType, typeof(baseValue)))
+	end
 
 --[=[
 	Event fires when the value's object value change
 	@prop Changed Signal<T> -- fires with oldValue, newValue, ...
 	@within ValueObject
 ]=]
-	self.Changed = Signal.new() -- :Fire(newValue, oldValue, maid, ...)
+	self.Changed = GoodSignal.new() -- :Fire(newValue, oldValue, maid, ...)
 	self._maid:GiveTask(self.Changed)
 
 	return setmetatable(self, ValueObject)
@@ -44,9 +53,7 @@ end
 function ValueObject.fromObservable(observable)
 	local result = ValueObject.new()
 
-	result._maid:GiveTask(observable:Subscribe(function(value, ...)
-		result:SetValue(value, ...)
-	end))
+	result:Mount(observable)
 
 	return result
 end
@@ -60,6 +67,63 @@ function ValueObject.isValueObject(value)
 	return type(value) == "table" and getmetatable(value) == ValueObject
 end
 
+function ValueObject:_toMountableObservable(value)
+	if Observable.isObservable(value) then
+		return value
+	elseif typeof(value) == "Instance" then
+		-- IntValue, ObjectValue, et cetera
+		if ValueBaseUtils.isValueBase(value) then
+			return RxValueBaseUtils.observeValue(value)
+		end
+	elseif type(value) == "table" then
+		if ValueObject.isValueObject(value) then
+			return value:Observe()
+		-- elseif Promise.isPromise(value) then
+		-- 	return Rx.fromPromise(value)
+		end
+	end
+
+	return nil
+end
+--[=[
+	Mounts the value to the observable. Overrides the last mount.
+
+	@param value Observable | T
+	@return MaidTask
+]=]
+function ValueObject:Mount(value)
+	local observable = self:_toMountableObservable(value)
+	if observable then
+		self._maid._mount = nil
+
+		local maid = Maid.new()
+
+		maid:GiveTask(observable:Subscribe(function(...)
+			self:SetValue(...)
+		end))
+
+		maid:GiveTask(function()
+			if self._maid._mount == maid then
+				self._maid._mount = nil
+			end
+		end)
+
+		self._maid._mount = maid
+
+		return function()
+			if self._maid._mount == maid then
+				self._maid._mount = nil
+			end
+		end
+	else
+		self._maid._mount = nil
+
+		self:SetValue(value)
+
+		return EMPTY_FUNCTION
+	end
+end
+
 --[=[
 	Observes the current value of the ValueObject
 	@return Observable<T>
@@ -107,6 +171,12 @@ end
 ]=]
 function ValueObject:SetValue(value, ...)
 	local previous = rawget(self, "_value")
+	local checkType = rawget(self, "_checkType")
+
+	if checkType and typeof(value) ~= checkType then
+		error(string.format("Expected value of type %q, got %q instead", checkType, typeof(value)))
+	end
+
 	if previous ~= value then
 		if select("#", ...) > 0 then
 			rawset(self, "_lastEventContext", table.pack(...))