@quenty/observablecollection 12.10.1-canary.513.484c203.0 → 12.11.1

package/CHANGELOG.md

@@ -3,17 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [12.10.1-canary.513.484c203.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@12.10.0...@quenty/observablecollection@12.10.1-canary.513.484c203.0) (2024-10-24)
+## [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
 
-### Features
 
-* Add __iter implementations ([b8e614a](https://github.com/Quenty/NevermoreEngine/commit/b8e614a8fda875c03237dc6cde18cf817beec0c4))
 
 
-### Performance Improvements
 
-* Use ObservableSubscriptionTable and stop debug validating integrity ([dbe74ba](https://github.com/Quenty/NevermoreEngine/commit/dbe74ba23b3b541f687999e22e60322fe11bbd2c))
+# [12.11.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@12.10.0...@quenty/observablecollection@12.11.0) (2024-11-03)
+
+**Note:** Version bump only for package @quenty/observablecollection
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/observablecollection",
-  "version": "12.10.1-canary.513.484c203.0",
+  "version": "12.11.1",
   "description": "A set of observable collections, such as sets, maps, sorted lists, and more.",
   "keywords": [
     "Roblox",
@@ -27,23 +27,23 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "10.7.0",
-    "@quenty/brio": "14.10.1-canary.513.484c203.0",
-    "@quenty/ducktype": "5.7.0",
-    "@quenty/loader": "10.7.0",
-    "@quenty/maid": "3.4.0",
-    "@quenty/promise": "10.7.1-canary.513.484c203.0",
-    "@quenty/rx": "13.10.1-canary.513.484c203.0",
-    "@quenty/signal": "7.8.0",
-    "@quenty/steputils": "3.5.2",
-    "@quenty/symbol": "3.2.0",
-    "@quenty/valueobject": "13.10.1-canary.513.484c203.0"
+    "@quenty/baseobject": "^10.7.1",
+    "@quenty/brio": "^14.11.1",
+    "@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/steputils": "^3.5.2",
+    "@quenty/symbol": "^3.2.0",
+    "@quenty/valueobject": "^13.11.1"
   },
   "devDependencies": {
-    "@quenty/blend": "12.10.1-canary.513.484c203.0"
+    "@quenty/blend": "^12.11.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "484c2031829caf7e983cae58a6aa6f0ceef1d059"
+  "gitHead": "01c43a0ddd3c5e0cb2d9027313dbfa9852eedef1"
 }

package/src/Shared/ObservableCountingMap.lua

@@ -73,15 +73,6 @@ 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

@@ -89,19 +89,6 @@ function ObservableList:Observe()
 	})
 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
-
 --[=[
 	Observes all items in the list
 	@return Observable<Brio<T>>

package/src/Shared/ObservableMap.lua

@@ -74,16 +74,6 @@ 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,15 +65,6 @@ 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>>

package/src/Shared/ObservableSortedList.lua

@@ -60,12 +60,13 @@ function ObservableSortedList.new(isReversed, compare)
 
 	self._indexObservers = self._maid:Add(ObservableSubscriptionTable.new())
 	self._contentIndexObservers = self._maid:Add(ObservableSubscriptionTable.new())
-	self._keyObservables = self._maid:Add(ObservableSubscriptionTable.new())
 
 	self._sortValue = {} -- { [Symbol]: number }
 	self._contents = {} -- { [Symbol]: T }
 	self._indexes = {} -- { [Symbol]: number }
 
+	self._keyObservables = {} -- { [Symbol]: { Subscription } }
+
 	self._isReversed = isReversed or false
 	self._compare = compare or defaultCompare
 
@@ -123,19 +124,6 @@ function ObservableSortedList:Observe()
 	})
 end
 
---[=[
-	Allows iteration over the observable map
-
-	@return (T) -> ((T, nextIndex: any) -> ...any, T?)
-]=]
-function ObservableSortedList:__iter()
-	return coroutine.wrap(function()
-		for index, value in self._keyList do
-			coroutine.yield(index, self._contents[value])
-		end
-	end)
-end
-
 function ObservableSortedList:Contains(value)
 	-- TODO: Binary search
 	for _, item in pairs(self._contents) do
@@ -251,16 +239,33 @@ end
 function ObservableSortedList:ObserveIndexByKey(key)
 	assert(Symbol.isSymbol(key), "Bad key")
 
-	return self._keyObservables:Observe(key):Pipe({
-		Rx.startFrom(function()
-			local currentIndex = self._indexes[key]
-			if currentIndex then
-				return { currentIndex }
-			else
-				return {}
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+		self._keyObservables[key] = self._keyObservables[key] or {}
+		table.insert(self._keyObservables[key], sub)
+
+		local currentIndex = self._indexes[key]
+		if currentIndex then
+			sub:Fire(currentIndex)
+		end
+
+		maid:GiveTask(function()
+			local list = self._keyObservables[key]
+			if not list then
+				return
 			end
-		end);
-	})
+
+			local index = table.find(list, sub)
+			if index then
+				table.remove(list, index)
+				if #list == 0 then
+					self._keyObservables[key] = nil
+				end
+			end
+		end)
+
+		return maid
+	end)
 end
 
 --[=[
@@ -332,10 +337,15 @@ function ObservableSortedList:Add(item, observeValue)
 	end
 
 	maid:GiveTask(function()
+		local observableSubs = self._keyObservables[key]
+		self._keyObservables[key] = nil
+
 		self:_removeItemByKey(key, item)
 
 		-- Fire off the index change on the value
-		self._keyObservables:Complete(key)
+		if observableSubs then
+			self:_completeSubs(observableSubs)
+		end
 
 		self._contents[key] = nil
 		self._sortValue[key] = nil
@@ -349,7 +359,7 @@ function ObservableSortedList:Add(item, observeValue)
 end
 
 function ObservableSortedList:_assignSortValue(key, item, sortValue)
-	-- self:_debugVerifyIntegrity()
+	self:_debugVerifyIntegrity()
 
 	if sortValue ~= nil then
 		local currentIndex = self._indexes[key]
@@ -358,12 +368,18 @@ function ObservableSortedList:_assignSortValue(key, item, sortValue)
 		self._sortValue[key] = sortValue
 		self:_updateIndex(key, item, targetIndex, sortValue)
 	else
+		local observableSubs = self._keyObservables[key]
+
 		-- calling this also may unsubscribe some observables.
 		self:_removeItemByKey(key, item)
-		self._keyObservables:Complete(key)
+
+		if observableSubs then
+			-- fire nil index
+			self:_fireSubs(observableSubs, nil)
+		end
 	end
 
-	-- 	self:_debugVerifyIntegrity()
+	self:_debugVerifyIntegrity()
 end
 
 
@@ -580,7 +596,11 @@ function ObservableSortedList:_queueDeferredChange()
 				if self._indexes[lastChange.key] == lastChange.newIndex then
 					changed = true
 
-					self._keyObservables:Fire(lastChange.key, lastChange.newIndex)
+					local subs = self._keyObservables[lastChange.key]
+					if subs then
+						self:_fireSubs(subs, lastChange.newIndex)
+					end
+
 					self._indexObservers:Fire(lastChange.newIndex, self._contents[lastChange.key])
 				end
 			end
@@ -662,9 +682,7 @@ function ObservableSortedList:_lowBinarySearch(sortValue)
 	while true do
 		local mid = math.floor((minIndex + maxIndex) / 2)
 		local compareValue = self._compare(self._sortValue[self._keyList[mid]], sortValue)
-		if type(compareValue) ~= "number" then
-			error(string.format("Bad compareValue, expected number, got %q", type(compareValue)))
-		end
+		assert(type(compareValue) == "number", "Expecting number")
 
 		if self._isReversed then
 			compareValue = -compareValue
@@ -684,6 +702,16 @@ function ObservableSortedList:_lowBinarySearch(sortValue)
 	end
 end
 
+function ObservableSortedList:_debugSortValuesToString()
+	local values = {}
+
+	for _, key in pairs(self._keyList) do
+		table.insert(values, string.format("%4d", self._sortValue[key]))
+	end
+
+	return table.concat(values, ", ")
+end
+
 function ObservableSortedList:_debugVerifyIntegrity()
 	for i=2, #self._keyList do
 		local compare = self._compare(self._sortValue[self._keyList[i-1]], self._sortValue[self._keyList[i]])
@@ -702,14 +730,23 @@ function ObservableSortedList:_debugVerifyIntegrity()
 	end
 end
 
-function ObservableSortedList:_debugSortValuesToString()
-	local values = {}
-
-	for _, key in pairs(self._keyList) do
-		table.insert(values, string.format("%4d", self._sortValue[key]))
+function ObservableSortedList:_fireSubs(list, index)
+	for _, sub in pairs(list) do
+		if sub:IsPending() then
+			task.spawn(function()
+				sub:Fire(index)
+			end)
+		end
 	end
+end
 
-	return table.concat(values, ", ")
+function ObservableSortedList:_completeSubs(list)
+	for _, sub in pairs(list) do
+		if sub:IsPending() then
+			sub:Fire(nil)
+			sub:Complete()
+		end
+	end
 end
 
 --[=[