@quenty/observablecollection 12.11.1 → 12.12.0

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [12.12.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@12.11.1...@quenty/observablecollection@12.12.0) (2024-11-06)
+
+
+### Bug Fixes
+
+* Apparently working list ([e7a19a7](https://github.com/Quenty/NevermoreEngine/commit/e7a19a75cc06cd8df27768b89839a0b5c91d0c46))
+* Fix some state issues and improve performance ([69305a7](https://github.com/Quenty/NevermoreEngine/commit/69305a7732218a28c70d8e081238974b45da95e1))
+* Slightly cleaner code ([d0a9822](https://github.com/Quenty/NevermoreEngine/commit/d0a98220429dba24b67bbccd70fa9d90a11ac793))
+
+
+### Features
+
+* Add __iter implementations ([dd6db9a](https://github.com/Quenty/NevermoreEngine/commit/dd6db9a27c98afb4177ea950f1b3e2b22d4487d2))
+* Add unfinished observable sorted list ([c7e9817](https://github.com/Quenty/NevermoreEngine/commit/c7e9817f07c9431e5f7cdf1fa2e700d3b3277f60))
+* Broken observable list ([4f8a551](https://github.com/Quenty/NevermoreEngine/commit/4f8a551b5b1ca6ca5bc9fd9f471ab26aeefc28f9))
+* More stuff broken, but it's getting there ([d141e80](https://github.com/Quenty/NevermoreEngine/commit/d141e8007d789f47766b9ab98eebda864142a1ae))
+
+
+### Performance Improvements
+
+* Improve iteration perf ([40ebb7a](https://github.com/Quenty/NevermoreEngine/commit/40ebb7aeea5d3f6d5e292567e023638ff8f45864))
+* Use ObservableSubscriptionTable and stop debug validating integrity ([9d8e66b](https://github.com/Quenty/NevermoreEngine/commit/9d8e66b73b25f6ed087cbb38341bb9ea4a1162b4))
+
+
+
+
+
 ## [12.11.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@12.11.0...@quenty/observablecollection@12.11.1) (2024-11-04)
 
 **Note:** Version bump only for package @quenty/observablecollection

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/observablecollection",
-  "version": "12.11.1",
+  "version": "12.12.0",
   "description": "A set of observable collections, such as sets, maps, sorted lists, and more.",
   "keywords": [
     "Roblox",
@@ -28,22 +28,23 @@
   ],
   "dependencies": {
     "@quenty/baseobject": "^10.7.1",
-    "@quenty/brio": "^14.11.1",
+    "@quenty/brio": "^14.12.0",
     "@quenty/ducktype": "^5.7.1",
     "@quenty/loader": "^10.7.1",
     "@quenty/maid": "^3.4.0",
-    "@quenty/promise": "^10.7.1",
-    "@quenty/rx": "^13.11.1",
-    "@quenty/signal": "^7.8.1",
+    "@quenty/promise": "^10.8.0",
+    "@quenty/rx": "^13.12.0",
+    "@quenty/signal": "^7.9.0",
     "@quenty/steputils": "^3.5.2",
-    "@quenty/symbol": "^3.2.0",
-    "@quenty/valueobject": "^13.11.1"
+    "@quenty/symbol": "^3.3.0",
+    "@quenty/table": "^3.6.0",
+    "@quenty/valueobject": "^13.12.0"
   },
   "devDependencies": {
-    "@quenty/blend": "^12.11.1"
+    "@quenty/blend": "^12.12.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "01c43a0ddd3c5e0cb2d9027313dbfa9852eedef1"
+  "gitHead": "00e6f71716216dd6ecbc8505ad898a1ab7f72756"
 }

package/src/Shared/ObservableCountingMap.lua

@@ -73,6 +73,15 @@ function ObservableCountingMap.isObservableMap(value)
 	return DuckTypeUtils.isImplementation(ObservableCountingMap, value)
 end
 
+--[=[
+	Allows iteration over the observable counting map
+
+	@return (T) -> ((T, nextIndex: any) -> ...any, T?)
+]=]
+function ObservableCountingMap:__iter()
+	return pairs(self._map)
+end
+
 --[=[
 	Observes the current set of active keys
 	@return Observable<{ T }>

package/src/Shared/ObservableList.lua

@@ -9,12 +9,12 @@ local Brio = require("Brio")
 local Maid = require("Maid")
 local Observable = require("Observable")
 local ObservableSubscriptionTable = require("ObservableSubscriptionTable")
-local Rx = require("Rx")
 local RxBrioUtils = require("RxBrioUtils")
 local Signal = require("Signal")
 local Symbol = require("Symbol")
 local ValueObject = require("ValueObject")
 local DuckTypeUtils = require("DuckTypeUtils")
+local ListIndexUtils = require("ListIndexUtils")
 
 local ObservableList = {}
 ObservableList.ClassName = "ObservableList"
@@ -78,15 +78,38 @@ end
 	@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);
-	})
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local function queueFire()
+			if maid._queue then
+				return
+			end
+
+			maid._queue = task.defer(function()
+				maid._queue = nil
+				sub:Fire(self:GetList())
+			end)
+		end
+
+		maid:GiveTask(self.ItemAdded:Connect(queueFire))
+		maid:GiveTask(self.ItemRemoved:Connect(queueFire))
+
+		return maid
+	end)
+end
+
+--[=[
+	Allows iteration over the observable map
+
+	@return (T) -> ((T, nextIndex: any) -> ...any, T?)
+]=]
+function ObservableList:__iter()
+	return coroutine.wrap(function()
+		for index, value in self._keyList do
+			coroutine.yield(index, self._contents[value])
+		end
+	end)
 end
 
 --[=[
@@ -265,7 +288,7 @@ end
 function ObservableList:Get(index)
 	assert(type(index) == "number", "Bad index")
 
-	index = self:_toPositiveIndex(index)
+	index = ListIndexUtils.toPositiveIndex(#self._keyList, index)
 
 	local key = self._keyList[index]
 	if not key then
@@ -319,12 +342,12 @@ function ObservableList:InsertAt(item, index)
 	-- Fire off the index change on the value
 	self._keyIndexObservables:Fire(key, index)
 	self._indexObservers:Fire(index, item)
-	self._indexObservers:Fire(self:_toNegativeIndex(listLength, index), item)
+	self._indexObservers:Fire(ListIndexUtils.toNegativeIndex(listLength, index), item)
 
 	for _, data in pairs(changed) do
 		if self._indexes[data.key] == data.newIndex then
 			self._indexObservers:Fire(data.newIndex, self._contents[data.key])
-			self._indexObservers:Fire(self:_toNegativeIndex(listLength, index), self._contents[data.key])
+			self._indexObservers:Fire(ListIndexUtils.toNegativeIndex(listLength, index), self._contents[data.key])
 			self._keyIndexObservables:Fire(data.key, data.newIndex)
 		end
 	end
@@ -409,7 +432,7 @@ function ObservableList:RemoveByKey(key)
 	for _, data in pairs(changed) do
 		if self._indexes[data.key] == data.newIndex then
 			self._indexObservers:Fire(data.newIndex, self._contents[data.key])
-			self._indexObservers:Fire(self:_toNegativeIndex(listLength, index), self._contents[data.key])
+			self._indexObservers:Fire(ListIndexUtils.toNegativeIndex(listLength, index), self._contents[data.key])
 			self._keyIndexObservables:Fire(data.key, data.newIndex)
 		end
 	end
@@ -429,20 +452,6 @@ function ObservableList:GetList()
 	return list
 end
 
-function ObservableList:_toPositiveIndex(index)
-	if index > 0 then
-		return index
-	elseif index < 0 then
-		return #self._keyList + index + 1
-	else
-		error(string.format("[ObservableList._toPositiveIndex] - Bad index %d", index))
-	end
-end
-
-function ObservableList:_toNegativeIndex(listLength, index)
-	return -listLength + index - 1
-end
-
 --[=[
 	Cleans up the ObservableList and sets the metatable to nil.
 ]=]

package/src/Shared/ObservableMap.lua

@@ -74,6 +74,16 @@ function ObservableMap.isObservableMap(value)
 	return DuckTypeUtils.isImplementation(ObservableMap, value)
 end
 
+--[=[
+	Allows iteration over the observable map
+
+	@return (T) -> ((T, nextIndex: any) -> ...any, T?)
+]=]
+function ObservableMap:__iter()
+	return pairs(self._map)
+end
+
+
 --[=[
 	Observes all keys in the map
 	@return Observable<Brio<TKey>>

package/src/Shared/ObservableSet.lua

@@ -65,6 +65,15 @@ function ObservableSet.isObservableSet(value)
 	return DuckTypeUtils.isImplementation(ObservableSet, value)
 end
 
+--[=[
+	Allows iteration over the observable set
+
+	@return (T) -> ((T, nextIndex: any) -> ...any, T?)
+]=]
+function ObservableSet:__iter()
+	return pairs(self._set)
+end
+
 --[=[
 	Observes all items in the set
 	@return Observable<Brio<T>>