@quenty/observablecollection 5.15.0 → 5.16.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.
 
+# [5.16.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.15.0...@quenty/observablecollection@5.16.0) (2023-05-26)
+
+
+### Features
+
+* Add :Observe() calls to ObservableList and ObservableSortedList ([2f22fbc](https://github.com/Quenty/NevermoreEngine/commit/2f22fbc0830f51aa73ba01b6bb0d25f736e37b6e))
+* Initial refactor of guis to use ValueObject instead of ValueObject ([723aba0](https://github.com/Quenty/NevermoreEngine/commit/723aba0208cae7e06c9d8bf2d8f0092d042d70ea))
+
+
+
+
+
 # [5.15.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.14.0...@quenty/observablecollection@5.15.0) (2023-05-08)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/observablecollection",
-  "version": "5.15.0",
+  "version": "5.16.0",
   "description": "A set of observable collections, such as sets, maps, sorted lists, and more.",
   "keywords": [
     "Roblox",
@@ -27,17 +27,17 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^8.12.0",
+    "@quenty/brio": "^8.13.0",
     "@quenty/loader": "^6.2.1",
     "@quenty/maid": "^2.5.0",
     "@quenty/promise": "^6.5.0",
-    "@quenty/rx": "^7.10.0",
-    "@quenty/signal": "^2.3.0",
+    "@quenty/rx": "^7.11.0",
+    "@quenty/signal": "^2.4.0",
     "@quenty/symbol": "^2.2.0",
-    "@quenty/valuebaseutils": "^7.13.0"
+    "@quenty/valueobject": "^7.14.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2ad8cea7dd3ad79a39afd7d7b785b489b90553fd"
+  "gitHead": "11058e90e51ea83d3dad6ae9abe59cc19c36b94b"
 }

package/src/Shared/FilteredObservableListView.lua

@@ -5,8 +5,8 @@
 local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
-local ObservableSortedList = require("ObservableSortedList")
 local Observable = require("Observable")
+local ObservableSortedList = require("ObservableSortedList")
 local Rx = require("Rx")
 
 local FilteredObservableListView = setmetatable({}, BaseObject)
@@ -35,10 +35,6 @@ function FilteredObservableListView.new(observableList, observeScoreCallback, co
 	end)
 	self._maid:GiveTask(self._scoredList)
 
-	self._countValue = Instance.new("IntValue")
-	self._countValue.Value = 0
-	self._maid:GiveTask(self._countValue)
-
 	-- Shockingly this is somewhat performant because the sorted list defers all events
 	-- to process the list reordering.
 	self._maid:GiveTask(self._baseList:ObserveItemsBrio():Subscribe(function(brio)

package/src/Shared/ObservableCountingMap.lua

@@ -9,7 +9,7 @@ local Signal = require("Signal")
 local Observable = require("Observable")
 local Maid = require("Maid")
 local Brio = require("Brio")
-local RxValueBaseUtils = require("RxValueBaseUtils")
+local ValueObject = require("ValueObject")
 
 local ObservableCountingMap = {}
 ObservableCountingMap.ClassName = "ObservableCountingMap"
@@ -25,8 +25,7 @@ function ObservableCountingMap.new()
 	self._maid = Maid.new()
 	self._map = {}
 
-	self._totalKeyCountValue = Instance.new("IntValue")
-	self._totalKeyCountValue.Value = 0
+	self._totalKeyCountValue = ValueObject.new(0, "number")
 	self._maid:GiveTask(self._totalKeyCountValue)
 
 --[=[
@@ -198,7 +197,7 @@ end
 	@return Observable<number>
 ]=]
 function ObservableCountingMap:ObserveTotalKeyCount()
-	return RxValueBaseUtils.observeValue(self._totalKeyCountValue)
+	return self._totalKeyCountValue:Observe()
 end
 
 --[=[

package/src/Shared/ObservableList.lua

@@ -9,8 +9,9 @@ local Signal = require("Signal")
 local Observable = require("Observable")
 local Maid = require("Maid")
 local Brio = require("Brio")
-local RxValueBaseUtils = require("RxValueBaseUtils")
 local Symbol = require("Symbol")
+local ValueObject = require("ValueObject")
+local Rx = require("Rx")
 
 local ObservableList = {}
 ObservableList.ClassName = "ObservableList"
@@ -31,8 +32,7 @@ function ObservableList.new()
 
 	self._keyObservables = {} -- { [Symbol]: { Subscription } }
 
-	self._countValue = Instance.new("IntValue")
-	self._countValue.Value = 0
+	self._countValue = ValueObject.new(0, "number")
 	self._maid:GiveTask(self._countValue)
 
 --[=[
@@ -72,6 +72,23 @@ function ObservableList.isObservableList(value)
 	return type(value) == "table" and getmetatable(value) == ObservableList
 end
 
+--[=[
+	Observes the list, allocating a new list in the process.
+
+	@return Observable<{ T }>
+]=]
+function ObservableList:Observe()
+	return Rx.combineLatest({
+		Rx.fromSignal(self.ItemAdded):Pipe({ Rx.startWith({ true }) });
+		Rx.fromSignal(self.ItemRemoved):Pipe({ Rx.startWith({ true }) });
+	}):Pipe({
+		Rx.throttleDefer();
+		Rx.map(function()
+			return self:GetList();
+		end);
+	})
+end
+
 --[=[
 	Observes all items in the list
 	@return Observable<Brio<T>>
@@ -211,7 +228,7 @@ end
 	@return number
 ]=]
 function ObservableList:GetCount()
-	return self._countValue.Value
+	return self._countValue.Value or 0
 end
 
 --[=[
@@ -219,7 +236,7 @@ end
 	@return Observable<number>
 ]=]
 function ObservableList:ObserveCount()
-	return RxValueBaseUtils.observeValue(self._countValue)
+	return self._countValue:Observe()
 end
 
 --[=[

package/src/Shared/ObservableMap.lua

@@ -9,7 +9,7 @@ local Signal = require("Signal")
 local Observable = require("Observable")
 local Maid = require("Maid")
 local Brio = require("Brio")
-local RxValueBaseUtils = require("RxValueBaseUtils")
+local ValueObject = require("ValueObject")
 
 local ObservableMap = {}
 ObservableMap.ClassName = "ObservableMap"
@@ -27,8 +27,7 @@ function ObservableMap.new()
 
 	self._keyToSubList = {}
 
-	self._countValue = Instance.new("IntValue")
-	self._countValue.Value = 0
+	self._countValue = ValueObject.new(0, "number")
 	self._maid:GiveTask(self._countValue)
 
 --[=[
@@ -164,7 +163,7 @@ end
 	@return number
 ]=]
 function ObservableMap:GetCount()
-	return self._countValue.Value
+	return self._countValue.Value or 0
 end
 
 --[=[
@@ -172,7 +171,7 @@ end
 	@return Observable<number>
 ]=]
 function ObservableMap:ObserveCount()
-	return RxValueBaseUtils.observeValue(self._countValue)
+	return self._countValue:Observe()
 end
 
 --[=[

package/src/Shared/ObservableMapSet.lua

@@ -13,7 +13,7 @@ local ObservableSet = require("ObservableSet")
 local Signal = require("Signal")
 local Brio = require("Brio")
 local RxBrioUtils = require("RxBrioUtils")
-local RxValueBaseUtils = require("RxValueBaseUtils")
+local ValueObject = require("ValueObject")
 
 local ObservableMapSet = {}
 ObservableMapSet.ClassName = "ObservableMapSet"
@@ -47,8 +47,7 @@ function ObservableMapSet.new()
 	self.SetRemoved = Signal.new() -- :Fire(key)
 	self._maid:GiveTask(self.SetRemoved)
 
-	self._setCount = Instance.new("IntValue")
-	self._setCount.Value = 0
+	self._setCount = ValueObject.new(0, "number")
 	self._maid:GiveTask(self._setCount)
 
 	return self
@@ -107,7 +106,7 @@ end
 	@return Observable<number>
 ]=]
 function ObservableMapSet:ObserveSetCount()
-	return RxValueBaseUtils.observeValue(self._setCount)
+	return self._setCount:Observe()
 end
 
 --[=[
@@ -262,7 +261,9 @@ function ObservableMapSet:_removeObservableSet(key)
 			self.SetRemoved:Fire(key)
 		end
 
-		self._setCount.Value = self._setCount.Value - 1
+		if self._setCount.Destroy then
+			self._setCount.Value = self._setCount.Value - 1
+		end
 	end
 end
 
@@ -278,7 +279,10 @@ function ObservableMapSet:_getOrCreateObservableSet(key)
 	self._observableSetMap[key] = set
 
 	self.SetAdded:Fire(key, set)
-	self._setCount.Value = self._setCount.Value + 1
+
+	if self._setCount.Destroy then
+		self._setCount.Value = self._setCount.Value + 1
+	end
 
 	self._maid[set] = maid
 	return set

package/src/Shared/ObservableSet.lua

@@ -9,7 +9,7 @@ local Signal = require("Signal")
 local Observable = require("Observable")
 local Maid = require("Maid")
 local Brio = require("Brio")
-local RxValueBaseUtils = require("RxValueBaseUtils")
+local ValueObject = require("ValueObject")
 local ObservableSubscriptionTable = require("ObservableSubscriptionTable")
 
 local ObservableSet = {}
@@ -29,8 +29,7 @@ function ObservableSet.new()
 	self._containsObservables = ObservableSubscriptionTable.new()
 	self._maid:GiveTask(self._containsObservables)
 
-	self._countValue = Instance.new("IntValue")
-	self._countValue.Value = 0
+	self._countValue = ValueObject.new(0, "number")
 	self._maid:GiveTask(self._countValue)
 
 --[=[
@@ -152,7 +151,7 @@ end
 	@return number
 ]=]
 function ObservableSet:GetCount()
-	return self._countValue.Value
+	return self._countValue.Value or 0
 end
 
 --[=[
@@ -160,7 +159,7 @@ end
 	@return Observable<number>
 ]=]
 function ObservableSet:ObserveCount()
-	return RxValueBaseUtils.observeValue(self._countValue)
+	return self._countValue:Observe()
 end
 
 --[=[

package/src/Shared/ObservableSortedList.lua

@@ -14,13 +14,14 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Signal = require("Signal")
-local Observable = require("Observable")
-local Maid = require("Maid")
 local Brio = require("Brio")
-local RxValueBaseUtils = require("RxValueBaseUtils")
-local Symbol = require("Symbol")
+local Maid = require("Maid")
+local Observable = require("Observable")
 local ObservableSubscriptionTable = require("ObservableSubscriptionTable")
+local Rx = require("Rx")
+local Signal = require("Signal")
+local Symbol = require("Symbol")
+local ValueObject = require("ValueObject")
 
 -- Higher numbers last. Using <= ensures insertion at end on ties.
 local function defaultCompare(a, b)
@@ -56,8 +57,8 @@ function ObservableSortedList.new(compare)
 	self._keyObservables = {} -- { [Symbol]: { Subscription } }
 
 	self._compare = compare or defaultCompare
-	self._countValue = Instance.new("IntValue")
-	self._countValue.Value = 0
+
+	self._countValue = ValueObject.new(0, "number")
 	self._maid:GiveTask(self._countValue)
 
 --[=[
@@ -78,6 +79,9 @@ function ObservableSortedList.new(compare)
 	self.ItemRemoved = Signal.new()
 	self._maid:GiveTask(self.ItemRemoved)
 
+	self.OrderChanged = Signal.new()
+	self._maid:GiveTask(self.OrderChanged)
+
 --[=[
 	Fires when the count changes.
 	@prop CountChanged RBXScriptSignal
@@ -88,6 +92,25 @@ function ObservableSortedList.new(compare)
 	return self
 end
 
+--[=[
+	Observes the list, allocating a new list in the process.
+
+	@return Observable<{ T }>
+]=]
+function ObservableSortedList:Observe()
+	return Rx.combineLatest({
+		Rx.fromSignal(self.ItemAdded):Pipe({ Rx.startWith({ true }) });
+		Rx.fromSignal(self.ItemRemoved):Pipe({ Rx.startWith({ true }) });
+		Rx.fromSignal(self.OrderChanged):Pipe({ Rx.startWith({ true }) });
+	}):Pipe({
+		Rx.throttleDefer();
+		Rx.map(function()
+			return self:GetList();
+		end);
+	})
+end
+
+
 --[=[
 	Returns whether the value is an observable list
 	@param value any
@@ -251,7 +274,7 @@ end
 	@return number
 ]=]
 function ObservableSortedList:GetCount()
-	return self._countValue.Value
+	return self._countValue.Value or 0
 end
 
 --[=[
@@ -271,7 +294,7 @@ end
 	@return Observable<number>
 ]=]
 function ObservableSortedList:ObserveCount()
-	return RxValueBaseUtils.observeValue(self._countValue)
+	return self._countValue:Observe()
 end
 
 --[=[
@@ -491,17 +514,24 @@ function ObservableSortedList:_deferChange(countChange, itemAdded, itemRemoved,
 end
 
 function ObservableSortedList:_queueDeferredChange()
-	if not self._deferredChange then
-		self._deferredChange = {
-			countChange = 0;
-			indexChanges = {};
-			itemsAdded = {};
-			itemsRemoved = {};
-		}
-
-		task.defer(function()
-			local snapshot = self._deferredChange
-			self._deferredChange = nil
+	if self._deferredChange then
+		return
+	end
+
+	self._deferredChange = {
+		countChange = 0;
+		indexChanges = {};
+		itemsAdded = {};
+		itemsRemoved = {};
+	}
+
+	self._maid._currentDefer = task.defer(function()
+		local snapshot = self._deferredChange
+		self._deferredChange = nil
+
+		task.spawn(function()
+			self._maid._currentDefer = nil
+			local changed = false
 
 			self._countValue.Value = self._countValue.Value + snapshot.countChange
 
@@ -510,6 +540,8 @@ function ObservableSortedList:_queueDeferredChange()
 				if not self.ItemAdded.Destroy then
 					break
 				end
+
+				changed = true
 				self.ItemAdded:Fire(lastAdded.item, lastAdded.newIndex, lastAdded.key)
 
 				-- Item adds are included in indexChanges.
@@ -520,6 +552,7 @@ function ObservableSortedList:_queueDeferredChange()
 					break
 				end
 
+				changed = true
 				self.ItemRemoved:Fire(lastRemoved.item, lastRemoved.key)
 
 				-- Fire only if we aren't handled by an index change.
@@ -531,6 +564,8 @@ function ObservableSortedList:_queueDeferredChange()
 			-- Fire off index change on each key list (if the data isn't stale)
 			for _, lastChange in pairs(snapshot.indexChanges) do
 				if self._indexes[lastChange.key] == lastChange.newIndex then
+					changed = true
+
 					local subs = self._keyObservables[lastChange.key]
 					if subs then
 						self:_fireSubs(subs, lastChange.newIndex)
@@ -539,8 +574,12 @@ function ObservableSortedList:_queueDeferredChange()
 					self._indexObservers:Fire(lastChange.newIndex, self._contents[lastChange.key])
 				end
 			end
+
+			if changed then
+				self.OrderChanged:Fire()
+			end
 		end)
-	end
+	end)
 end
 
 function ObservableSortedList:_findCorrectIndex(sortValue, currentIndex)