@quenty/observablecollection 6.2.1 → 6.3.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [6.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@6.2.1...@quenty/observablecollection@6.3.0) (2023-12-14)
+
+
+### Bug Fixes
+
+* Fix removing from lists in ObservableMapList ([14278f0](https://github.com/Quenty/NevermoreEngine/commit/14278f0136b944ad679fa5b29e1e94a560bef8ac))
+
+
+### Features
+
+* Add :ObserveKeyList() to ObservableMap and equivalents ([8f1cb4b](https://github.com/Quenty/NevermoreEngine/commit/8f1cb4b705c98fed0e96c9889c4aa62f635751ce))
+
+
+
+
+
 ## [6.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@6.2.0...@quenty/observablecollection@6.2.1) (2023-10-28)
 
 **Note:** Version bump only for package @quenty/observablecollection

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/observablecollection",
-  "version": "6.2.1",
+  "version": "6.3.0",
   "description": "A set of observable collections, such as sets, maps, sorted lists, and more.",
   "keywords": [
     "Roblox",
@@ -27,22 +27,22 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^7.0.0",
-    "@quenty/brio": "^9.1.1",
-    "@quenty/loader": "^7.0.0",
+    "@quenty/baseobject": "^7.1.0",
+    "@quenty/brio": "^9.2.0",
+    "@quenty/loader": "^7.1.0",
     "@quenty/maid": "^2.6.0",
-    "@quenty/promise": "^7.0.0",
-    "@quenty/rx": "^8.1.1",
-    "@quenty/signal": "^3.0.0",
+    "@quenty/promise": "^7.1.0",
+    "@quenty/rx": "^8.2.0",
+    "@quenty/signal": "^3.1.0",
     "@quenty/steputils": "^3.3.0",
     "@quenty/symbol": "^2.2.0",
-    "@quenty/valueobject": "^8.1.1"
+    "@quenty/valueobject": "^8.2.0"
   },
   "devDependencies": {
-    "@quenty/blend": "^7.1.1"
+    "@quenty/blend": "^7.2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "440aca7ce2b50b74317ee05fdc0b8d1e58001af3"
+  "gitHead": "2c2dbbc0cb2fbb46b4f3270c559c63890fe18b26"
 }

package/src/Shared/ObservableMap.lua

@@ -27,11 +27,8 @@ function ObservableMap.new()
 	self._maid = Maid.new()
 	self._map = {}
 
-	self._keySubTable = ObservableSubscriptionTable.new()
-	self._maid:GiveTask(self._keySubTable)
-
-	self._countValue = ValueObject.new(0, "number")
-	self._maid:GiveTask(self._countValue)
+	self._keySubTable = self._maid:Add(ObservableSubscriptionTable.new())
+	self._countValue = self._maid:Add(ValueObject.new(0, "number"))
 
 --[=[
 	Fires when a key is added
@@ -39,8 +36,7 @@ function ObservableMap.new()
 	@prop KeyAdded Signal<TKey>
 	@within ObservableMap
 ]=]
-	self.KeyAdded = Signal.new() -- :Fire(key, value)
-	self._maid:GiveTask(self.KeyAdded)
+	self.KeyAdded = self._maid:Add(Signal.new()) -- :Fire(key, value)
 
 --[=[
 	Fires when a key is removed
@@ -48,8 +44,7 @@ function ObservableMap.new()
 	@prop KeyRemoved Signal<TKey>
 	@within ObservableMap
 ]=]
-	self.KeyRemoved = Signal.new() -- :Fire(key)
-	self._maid:GiveTask(self.KeyRemoved)
+	self.KeyRemoved = self._maid:Add(Signal.new()) -- :Fire(key)
 
 --[=[
 	Fires when a key value changes, including add and remove.
@@ -57,8 +52,7 @@ function ObservableMap.new()
 	@prop KeyValueChanged Signal<(TKey, TValue, TValue)>
 	@within ObservableMap
 ]=]
-	self.KeyValueChanged = Signal.new() -- :Fire(key, value, oldValue)
-	self._maid:GiveTask(self.KeyValueChanged)
+	self.KeyValueChanged = self._maid:Add(Signal.new()) -- :Fire(key, value, oldValue)
 
 --[=[
 	Fires when the count changes.
@@ -298,6 +292,39 @@ function ObservableMap:GetKeyList()
 	return list
 end
 
+--[=[
+	Observes the list of all keys.
+	@return Observable<{ TKey }>
+]=]
+function ObservableMap:ObserveKeyList()
+	return Observable.new(function(sub)
+		local topMaid = Maid.new()
+
+		-- TODO: maybe don't allocate as much here?
+		local keyList = {}
+
+		topMaid:GiveTask(self.KeyAdded:Connect(function(addedKey)
+			table.insert(keyList, addedKey)
+			sub:Fire(table.clone(keyList))
+		end))
+
+		topMaid:GiveTask(self.KeyRemoved:Connect(function(removedKey)
+			local index = table.find(keyList, removedKey)
+			if index then
+				table.remove(keyList, index)
+			end
+			sub:Fire(table.clone(keyList))
+		end))
+
+		for key, _ in pairs(self._map) do
+			table.insert(keyList, key)
+		end
+
+		sub:Fire(table.clone(keyList))
+
+		return topMaid
+	end)
+end
 
 --[=[
 	Cleans up the ObservableMap and sets the metatable to nil.

package/src/Shared/ObservableMapList.lua

@@ -52,26 +52,14 @@ function ObservableMapList:Push(observeKey, entry)
 
 	local maid = Maid.new()
 
-	local lastKey = nil
-	local function removeLastEntry()
-		if lastKey ~= nil then
-			self:_removeFromList(lastKey, entry)
-		end
-		lastKey = nil
-	end
-
 	maid:GiveTask(observeKey:Subscribe(function(key)
-		removeLastEntry()
+		maid._currentAddValue = nil
 
 		if key ~= nil then
-			self:_addToList(key, entry)
+			maid._currentAddValue = self:_addToList(key, entry)
 		end
-
-		lastKey = key
 	end))
 
-	maid:GiveTask(removeLastEntry)
-
 	-- Ensure self-cleanup when map cleans up
 	self._maid[maid] = maid
 	maid:GiveTask(function()
@@ -147,6 +135,13 @@ function ObservableMapList:GetKeyList()
 	return self._observableMapOfLists:GetKeyList()
 end
 
+--[=[
+	Observes the list of all keys.
+	@return Observable<{ TKey }>
+]=]
+function ObservableMapList:ObserveKeyList()
+	return self._observableMapOfLists:ObserveKeyList()
+end
 
 --[=[
 	Observes all keys in the map
@@ -169,7 +164,7 @@ function ObservableMapList:ObserveAtListIndexBrio(key, index)
 
 	return self._observableMapOfLists:ObserveAtKeyBrio(key):Pipe({
 		RxBrioUtils.switchMapBrio(function(list)
-			return list:ObserveAtIndexBrio(-1)
+			return list:ObserveAtIndexBrio(index)
 		end);
 		RxBrioUtils.toBrio();
 		RxBrioUtils.where(function(value)
@@ -251,35 +246,11 @@ end
 
 function ObservableMapList:_addToList(key, entry)
 	local list = self:_getOrCreateList(key)
-	list:Add(entry)
-end
-
-function ObservableMapList:_removeFromList(key, entry)
-	local list = self._observableMapOfLists:Get(key)
-	if not list then
-		return
-	end
-
-	-- This happens when we're cleaning up sometimes
-	if not list.Destroy then
-		return
-	end
-
-	if list:Contains(entry) then
-		list:Remove(entry)
-
-		if list:GetCount() == 0 then
-			self:_removeList(key)
-		end
-	end
+	return list:Add(entry)
 end
 
-function ObservableMapList:_removeList(key)
-	local list = self._observableMapOfLists:Get(key)
-	if list then
-		self._observableMapOfLists:Set(key, nil)
-		self._maid[list] = nil
-	end
+function ObservableMapList:_removeList(list)
+	self._maid[list] = nil
 end
 
 function ObservableMapList:_getOrCreateList(key)
@@ -291,7 +262,13 @@ function ObservableMapList:_getOrCreateList(key)
 	local maid = Maid.new()
 	local list = maid:Add(ObservableList.new(nil))
 
-	self._observableMapOfLists:Set(key, list)
+	maid:GiveTask(list.CountChanged:Connect(function(count)
+		if count <= 0 then
+			self._maid[list] = nil
+		end
+	end))
+
+	maid:GiveTask(self._observableMapOfLists:Set(key, list))
 	self._maid[list] = maid
 
 	return list

package/src/Shared/ObservableMapSet.lua

@@ -36,8 +36,7 @@ function ObservableMapSet.new()
 	@prop SetAdded Signal<TKey>
 	@within ObservableMapSet
 ]=]
-	self.SetAdded = Signal.new() -- :Fire(key, set)
-	self._maid:GiveTask(self.SetAdded)
+	self.SetAdded = self._maid:Add(Signal.new()) -- :Fire(key, set)
 
 --[=[
 	Fires when an item is removed
@@ -45,11 +44,9 @@ function ObservableMapSet.new()
 	@prop SetRemoved Signal<TKey>
 	@within ObservableMapSet
 ]=]
-	self.SetRemoved = Signal.new() -- :Fire(key)
-	self._maid:GiveTask(self.SetRemoved)
+	self.SetRemoved = self._maid:Add(Signal.new()) -- :Fire(key)
 
-	self._setCount = ValueObject.new(0, "number")
-	self._maid:GiveTask(self._setCount)
+	self._setCount = self._maid:Add(ValueObject.new(0, "number"))
 
 	return self
 end
@@ -142,6 +139,40 @@ function ObservableMapSet:GetKeyList()
 	return list
 end
 
+--[=[
+	Observes the list of all keys.
+	@return Observable<{ TKey }>
+]=]
+function ObservableMapSet:ObserveKeyList()
+	return Observable.new(function(sub)
+		local topMaid = Maid.new()
+
+		-- TODO: maybe don't allocate as much here?
+		local keyList = {}
+
+		topMaid:GiveTask(self.SetAdded:Connect(function(addedKey)
+			table.insert(keyList, addedKey)
+			sub:Fire(table.clone(keyList))
+		end))
+
+		topMaid:GiveTask(self.SetRemoved:Connect(function(removedKey)
+			local index = table.find(keyList, removedKey)
+			if index then
+				table.remove(keyList, index)
+			end
+			sub:Fire(table.clone(keyList))
+		end))
+
+		for key, _ in pairs(self._observableSetMap) do
+			table.insert(keyList, key)
+		end
+
+		sub:Fire(table.clone(keyList))
+
+		return topMaid
+	end)
+end
+
 --[=[
 	Gets how many sets exist
 	@return number

package/src/Shared/ObservableSortedList.lua

@@ -138,7 +138,7 @@ end
 
 --[=[
 	Observes all items in the list
-	@return Observable<Brio<T>>
+	@return Observable<Brio<T, Symbol>>
 ]=]
 function ObservableSortedList:ObserveItemsBrio()
 	return Observable.new(function(sub)