@quenty/valueobject 4.0.0-canary.236.5597d0a.0 → 4.1.0

package/CHANGELOG.md

@@ -3,7 +3,74 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [4.0.0-canary.236.5597d0a.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.4.0...@quenty/valueobject@4.0.0-canary.236.5597d0a.0) (2021-12-18)
+# [4.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@4.0.0...@quenty/valueobject@4.1.0) (2022-03-10)
+
+**Note:** Version bump only for package @quenty/valueobject
+
+
+
+
+
+# [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.8.0...@quenty/valueobject@4.0.0) (2022-03-06)
+
+**Note:** Version bump only for package @quenty/valueobject
+
+
+
+
+
+# [3.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.7.1...@quenty/valueobject@3.8.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/valueobject
+
+
+
+
+
+## [3.7.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.7.0...@quenty/valueobject@3.7.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/valueobject
+
+
+
+
+
+# [3.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.6.0...@quenty/valueobject@3.7.0) (2022-01-07)
+
+
+### Features
+
+* Add ValueObject:Observe() and StateStack:Observe() ([91af9f2](https://github.com/Quenty/NevermoreEngine/commit/91af9f25e41faddeaa2f02f31ddfb8b145d01068))
+
+
+
+
+
+# [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.5.2...@quenty/valueobject@3.6.0) (2022-01-03)
+
+**Note:** Version bump only for package @quenty/valueobject
+
+
+
+
+
+## [3.5.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.5.1...@quenty/valueobject@3.5.2) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/valueobject
+
+
+
+
+
+## [3.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.5.0...@quenty/valueobject@3.5.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/valueobject
+
+
+
+
+
+# [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/valueobject@3.4.0...@quenty/valueobject@3.5.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/valueobject
 

package/README.md

@@ -1,10 +1,10 @@
 ## ValueObject
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,6 +13,8 @@
 
 To work like value objects in Roblox and track a single item with .Changed events. The motivation here is to keep it simple to work with an encapsulated value. Instead of exposing an `IPropertyChanged` interface like C# might do, we instead expose objects with .Changed that are encapsulated within the object in question.
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ValueObject">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/valueobject --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/valueobject",
-  "version": "4.0.0-canary.236.5597d0a.0",
+  "version": "4.1.0",
   "description": "To work like value objects in Roblox and track a single item with .Changed events",
   "keywords": [
     "Roblox",
@@ -26,14 +26,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "4.0.0-canary.236.5597d0a.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/maid": "2.0.1",
-    "@quenty/rx": "4.0.0-canary.236.5597d0a.0",
-    "@quenty/signal": "2.0.0"
+    "@quenty/brio": "^5.1.0",
+    "@quenty/loader": "^4.0.0",
+    "@quenty/maid": "^2.2.0",
+    "@quenty/rx": "^4.1.0",
+    "@quenty/signal": "^2.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5597d0abdadd88f369f1401a558a8d6d1a1c5aab"
+  "gitHead": "0797de955876b050fb24875de0423453e268b2ce"
 }

package/src/Shared/ValueObject.lua

@@ -1,27 +1,23 @@
---- To work like value objects in Roblox and track a single item,
--- with `.Changed` events
--- @classmod ValueObject
+--[=[
+	To work like value objects in Roblox and track a single item,
+	with `.Changed` events
+	@class ValueObject
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
 local Signal = require("Signal")
 local Maid = require("Maid")
+local Observable = require("Observable")
 
 local ValueObject = {}
 ValueObject.ClassName = "ValueObject"
 
---- The value of the ValueObject
--- @tfield Variant Value
-
---- Event fires when the value's object value change
--- @signal Changed
--- @tparam Variant newValue The new value
--- @tparam Variant oldValue The old value
-
-
---- Constructs a new value object
--- @constructor
--- @treturn ValueObject
+--[=[
+	Constructs a new value object
+	@param baseValue T
+	@return ValueObject
+]=]
 function ValueObject.new(baseValue)
 	local self = {}
 
@@ -29,16 +25,57 @@ function ValueObject.new(baseValue)
 
 	self._maid = Maid.new()
 
+--[=[
+	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._maid:GiveTask(self.Changed)
 
 	return setmetatable(self, ValueObject)
 end
 
+--[=[
+	Returns whether the object is a ValueObject class
+	@param value any
+	@return boolean
+]=]
 function ValueObject.isValueObject(value)
 	return type(value) == "table" and getmetatable(value) == ValueObject
 end
 
+--[=[
+	Observes the current value of the ValueObject
+	@return Observable<T>
+]=]
+function ValueObject:Observe()
+	return Observable.new(function(sub)
+		if not self.Destroy then
+			warn("[ValueObject.observeValue] - Connecting to dead ValueObject")
+			-- No firing, we're dead
+			sub:Complete()
+			return
+		end
+
+		local maid = Maid.new()
+
+		maid:GiveTask(self.Changed:Connect(function()
+			sub:Fire(self.Value)
+		end))
+
+		sub:Fire(self.Value)
+
+		return maid
+	end)
+
+end
+
+--[=[
+	The value of the ValueObject
+	@prop Value T
+	@within ValueObject
+]=]
 function ValueObject:__index(index)
 	if index == "Value" then
 		return self._value
@@ -68,7 +105,11 @@ function ValueObject:__newindex(index, value)
 	end
 end
 
---- Forces the value to be nil on cleanup, cleans up the Maid
+--[=[
+	Forces the value to be nil on cleanup, cleans up the Maid
+
+	Does not fire the event since 3.5.0
+]=]
 function ValueObject:Destroy()
 	rawset(self, "_value", nil)
 	self._maid:DoCleaning()

package/src/Shared/ValueObjectUtils.lua

@@ -1,5 +1,7 @@
---- Utils that work with Roblox Value objects (and also ValueObject)
--- @module ValueObjectUtils
+--[=[
+	Utils that work with Roblox Value objects (and also ValueObject)
+	@class ValueObjectUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -10,6 +12,12 @@ local ValueObject = require("ValueObject")
 
 local ValueObjectUtils = {}
 
+--[=[
+	Syncs the value from `from` to `to`.
+	@param from ValueObject<T>
+	@param to ValueObject<T>
+	@return MaidTask
+]=]
 function ValueObjectUtils.syncValue(from, to)
 	local maid = Maid.new()
 	to.Value = from.Value
@@ -21,6 +29,11 @@ function ValueObjectUtils.syncValue(from, to)
 	return maid
 end
 
+--[=[
+	Observes the current value of the ValueObject
+	@param valueObject ValueObject<T>
+	@return Observable<T>
+]=]
 function ValueObjectUtils.observeValue(valueObject)
 	assert(ValueObject.isValueObject(valueObject), "Bad valueObject")
 
@@ -28,6 +41,7 @@ function ValueObjectUtils.observeValue(valueObject)
 		if not valueObject.Destroy then
 			warn("[ValueObjectUtils.observeValue] - Connecting to dead ValueObject")
 			-- No firing, we're dead
+			sub:Complete()
 			return
 		end
 
@@ -43,6 +57,11 @@ function ValueObjectUtils.observeValue(valueObject)
 	end)
 end
 
+--[=[
+	Observes the current value of the ValueObject
+	@param valueObject ValueObject<T>
+	@return Observable<Brio<T>>
+]=]
 function ValueObjectUtils.observeValueBrio(valueObject)
 	assert(valueObject, "Bad valueObject")
 

package/test/default.project.json

@@ -0,0 +1,11 @@
+{
+  "name": "ValueObject",
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "valueobject": {
+        "$path": ".."
+      }
+    }
+  }
+}