@quenty/observablecollection 6.0.0-canary.367.e9fdcbc.0 → 6.0.0

package/CHANGELOG.md

@@ -3,7 +3,123 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [6.0.0-canary.367.e9fdcbc.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.16.0...@quenty/observablecollection@6.0.0-canary.367.e9fdcbc.0) (2023-06-05)
+# [6.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.26.0...@quenty/observablecollection@6.0.0) (2023-10-11)
+
+
+### Features
+
+* Make observable sorted list stable and use binary search ([6ca9dc7](https://github.com/Quenty/NevermoreEngine/commit/6ca9dc74724e8446aceac432dca95a647c3ef0c2))
+
+
+
+
+
+# [5.26.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.25.0...@quenty/observablecollection@5.26.0) (2023-09-21)
+
+**Note:** Version bump only for package @quenty/observablecollection
+
+
+
+
+
+# [5.25.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.24.0...@quenty/observablecollection@5.25.0) (2023-09-04)
+
+
+### Features
+
+* Add ObservableMapList.new() and fix unit tests ([84e16ed](https://github.com/Quenty/NevermoreEngine/commit/84e16ed86af9bbc1ad19486f0298a9f7f3484b3e))
+
+
+
+
+
+# [5.24.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.23.0...@quenty/observablecollection@5.24.0) (2023-08-23)
+
+
+### Bug Fixes
+
+* Handle items after connecting to events ([800364b](https://github.com/Quenty/NevermoreEngine/commit/800364b77ce0b7fc42ad141846265657876512f8))
+
+
+### Features
+
+* ObservableMap uses subscription table ([fa39e53](https://github.com/Quenty/NevermoreEngine/commit/fa39e539c809e77f7d9539442727c48505f98ea1))
+
+
+
+
+
+# [5.23.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.22.0...@quenty/observablecollection@5.23.0) (2023-08-01)
+
+**Note:** Version bump only for package @quenty/observablecollection
+
+
+
+
+
+# [5.22.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.21.0...@quenty/observablecollection@5.22.0) (2023-07-28)
+
+**Note:** Version bump only for package @quenty/observablecollection
+
+
+
+
+
+# [5.21.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.20.0...@quenty/observablecollection@5.21.0) (2023-07-23)
+
+**Note:** Version bump only for package @quenty/observablecollection
+
+
+
+
+
+# [5.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.19.1...@quenty/observablecollection@5.20.0) (2023-07-15)
+
+
+### Features
+
+* Add :Observe() API calls to a variety of systems and allow Blend to :Observe() stuff ([ca29c68](https://github.com/Quenty/NevermoreEngine/commit/ca29c68164dfdaf136e9168faf48f487bed26088))
+
+
+
+
+
+## [5.19.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.19.0...@quenty/observablecollection@5.19.1) (2023-07-11)
+
+**Note:** Version bump only for package @quenty/observablecollection
+
+
+
+
+
+# [5.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.18.1...@quenty/observablecollection@5.19.0) (2023-07-10)
+
+**Note:** Version bump only for package @quenty/observablecollection
+
+
+
+
+
+## [5.18.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.18.0...@quenty/observablecollection@5.18.1) (2023-07-03)
+
+
+### Bug Fixes
+
+* Fix missing dependency in ObservableCollection ([f6e7834](https://github.com/Quenty/NevermoreEngine/commit/f6e7834c02142dbe6c941e7cf4226cfd723ed0b1))
+
+
+
+
+
+# [5.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.17.0...@quenty/observablecollection@5.18.0) (2023-06-17)
+
+**Note:** Version bump only for package @quenty/observablecollection
+
+
+
+
+
+# [5.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.16.0...@quenty/observablecollection@5.17.0) (2023-06-05)
 
 **Note:** Version bump only for package @quenty/observablecollection
 

package/README.md

@@ -17,5 +17,5 @@ A set of observable collections, such as sets, maps, sorted lists, and more. Gre
 
 ## Installation
 ```
-npm install @quenty/observableset --save
+npm install @quenty/observablecollection --save
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/observablecollection",
-  "version": "6.0.0-canary.367.e9fdcbc.0",
+  "version": "6.0.0",
   "description": "A set of observable collections, such as sets, maps, sorted lists, and more.",
   "keywords": [
     "Roblox",
@@ -27,17 +27,22 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "8.13.0",
-    "@quenty/loader": "6.2.1",
-    "@quenty/maid": "2.5.0",
-    "@quenty/promise": "6.5.0",
-    "@quenty/rx": "7.11.0",
-    "@quenty/signal": "2.4.0",
-    "@quenty/symbol": "2.2.0",
-    "@quenty/valueobject": "8.0.0-canary.367.e9fdcbc.0"
+    "@quenty/baseobject": "^7.0.0",
+    "@quenty/brio": "^9.0.0",
+    "@quenty/loader": "^7.0.0",
+    "@quenty/maid": "^2.6.0",
+    "@quenty/promise": "^7.0.0",
+    "@quenty/rx": "^8.0.0",
+    "@quenty/signal": "^3.0.0",
+    "@quenty/steputils": "^3.3.0",
+    "@quenty/symbol": "^2.2.0",
+    "@quenty/valueobject": "^8.0.0"
+  },
+  "devDependencies": {
+    "@quenty/blend": "^7.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e9fdcbc6ea1d46e068bf42a08b833099e9005259"
+  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
 }

package/src/Shared/FilteredObservableListView.lua

@@ -25,10 +25,10 @@ function FilteredObservableListView.new(observableList, observeScoreCallback, co
 	self._baseList = assert(observableList, "No observableList")
 	self._observeScoreCallback = assert(observeScoreCallback, "No observeScoreCallback")
 
-	self._scoredList = ObservableSortedList.new(function(a, b)
+	self._scoredList = ObservableSortedList.new(false, function(a, b)
 		-- Preserve index when scoring does not
 		if a.score == b.score then
-			return a.index < b.index
+			return a.index - b.index
 		else
 			return self._compare(a.score, b.score)
 		end

package/src/Shared/ObservableCountingMap.lua

@@ -25,8 +25,7 @@ function ObservableCountingMap.new()
 	self._maid = Maid.new()
 	self._map = {}
 
-	self._totalKeyCountValue = ValueObject.new(0, "number")
-	self._maid:GiveTask(self._totalKeyCountValue)
+	self._totalKeyCountValue = self._maid:Add(ValueObject.new(0, "number"))
 
 --[=[
 	Fires when an key is added
@@ -34,8 +33,7 @@ function ObservableCountingMap.new()
 	@prop KeyAdded Signal<T>
 	@within ObservableCountingMap
 ]=]
-	self.KeyAdded = Signal.new()
-	self._maid:GiveTask(self.KeyAdded)
+	self.KeyAdded = self._maid:Add(Signal.new())
 
 --[=[
 	Fires when an key is removed.
@@ -43,8 +41,7 @@ function ObservableCountingMap.new()
 	@prop KeyRemoved Signal<T>
 	@within ObservableCountingMap
 ]=]
-	self.KeyRemoved = Signal.new()
-	self._maid:GiveTask(self.KeyRemoved)
+	self.KeyRemoved = self._maid:Add(Signal.new())
 
 --[=[
 	Fires when an item count changes
@@ -52,8 +49,7 @@ function ObservableCountingMap.new()
 	@prop KeyChanged Signal<T>
 	@within ObservableCountingMap
 ]=]
-	self.KeyChanged = Signal.new()
-	self._maid:GiveTask(self.KeyChanged)
+	self.KeyChanged = self._maid:Add(Signal.new())
 
 --[=[
 	Fires when the total count changes.
@@ -311,7 +307,7 @@ end
 	Gets a list of all keys.
 	@return { T }
 ]=]
-function ObservableCountingMap:GetKeysList()
+function ObservableCountingMap:GetKeyList()
 	local list = {}
 	for key, _ in pairs(self._map) do
 		table.insert(list, key)

package/src/Shared/ObservableList.lua

@@ -5,13 +5,15 @@
 
 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 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 Rx = require("Rx")
 
 local ObservableList = {}
 ObservableList.ClassName = "ObservableList"
@@ -30,10 +32,9 @@ function ObservableList.new()
 	self._contents = {} -- { [Symbol]: T }
 	self._indexes = {} -- { [Symbol]: number }
 
-	self._keyObservables = {} -- { [Symbol]: { Subscription } }
-
-	self._countValue = ValueObject.new(0, "number")
-	self._maid:GiveTask(self._countValue)
+	self._indexObservers = self._maid:Add(ObservableSubscriptionTable.new())
+	self._keyIndexObservables = self._maid:Add(ObservableSubscriptionTable.new())
+	self._countValue = self._maid:Add(ValueObject.new(0, "number"))
 
 --[=[
 	Fires when an item is added
@@ -41,8 +42,7 @@ function ObservableList.new()
 	@prop ItemAdded Signal<T, number, Symbol>
 	@within ObservableList
 ]=]
-	self.ItemAdded = Signal.new()
-	self._maid:GiveTask(self.ItemAdded)
+	self.ItemAdded = self._maid:Add(Signal.new())
 
 --[=[
 	Fires when an item is removed.
@@ -50,8 +50,7 @@ function ObservableList.new()
 	@prop ItemRemoved Signal<T, Symbol>
 	@within ObservableList
 ]=]
-	self.ItemRemoved = Signal.new()
-	self._maid:GiveTask(self.ItemRemoved)
+	self.ItemRemoved = self._maid:Add(Signal.new())
 
 --[=[
 	Fires when the count changes.
@@ -103,15 +102,15 @@ function ObservableList:ObserveItemsBrio()
 			sub:Fire(brio)
 		end
 
-		for index, key in pairs(self._keyList) do
-			handleItem(self._contents[key], index, key)
-		end
-
 		maid:GiveTask(self.ItemAdded:Connect(handleItem))
 		maid:GiveTask(self.ItemRemoved:Connect(function(_item, includeKey)
 			maid[includeKey] = nil
 		end))
 
+		for index, key in pairs(self._keyList) do
+			handleItem(self._contents[key], index, key)
+		end
+
 		self._maid[sub] = maid
 		maid:GiveTask(function()
 			self._maid[sub] = nil
@@ -134,12 +133,43 @@ function ObservableList:ObserveIndex(indexToObserve)
 
 	local key = self._keyList[indexToObserve]
 	if not key then
-		error(("No entry at index %q, cannot observe changes"):format(indexToObserve))
+		error(string.format("No entry at index %q, cannot observe changes", indexToObserve))
 	end
 
 	return self:ObserveIndexByKey(key)
 end
 
+--[=[
+	Observes the current value at a given index. This can be useful for observing
+	the first entry, or matching stuff up to a given slot.
+
+	@param indexToObserve number
+	@return Observable<T?>
+]=]
+function ObservableList:ObserveAtIndex(indexToObserve)
+	assert(type(indexToObserve) == "number", "Bad indexToObserve")
+
+	return self._indexObservers:Observe(indexToObserve, function(sub)
+		sub:Fire(self:Get(indexToObserve))
+	end)
+end
+
+--[=[
+	Observes the current value at a given index. This can be useful for observing
+	the first entry, or matching stuff up to a given slot.
+
+	@param indexToObserve number
+	@return Observable<Brio<T>>
+]=]
+function ObservableList:ObserveAtIndexBrio(indexToObserve)
+	assert(type(indexToObserve) == "number", "Bad indexToObserve")
+
+	return self:ObserveAtIndex(indexToObserve):Pipe({
+		RxBrioUtils.toBrio();
+		RxBrioUtils.onlyLastBrioSurvives();
+	})
+end
+
 --[=[
 	Removes the first instance found in contents
 
@@ -176,35 +206,8 @@ end
 function ObservableList:ObserveIndexByKey(key)
 	assert(type(key) == "userdata", "Bad key")
 
-	return Observable.new(function(sub)
-		local currentIndex = self._indexes[key]
-		if not currentIndex then
-			sub:Complete()
-			return
-		end
-
-		local maid = Maid.new()
-		self._keyObservables[key] = self._keyObservables[key] or {}
-		table.insert(self._keyObservables[key], sub)
-
-		sub:Fire(currentIndex)
-
-		maid:GiveTask(function()
-			local list = self._keyObservables[key]
-			if not list then
-				return
-			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
+	return self._keyIndexObservables:Observe(key, function(sub)
+		sub:Fire(self:GetIndexByKey(key))
 	end)
 end
 
@@ -256,6 +259,8 @@ end
 function ObservableList:Get(index)
 	assert(type(index) == "number", "Bad index")
 
+	index = self:_toPositiveIndex(index)
+
 	local key = self._keyList[index]
 	if not key then
 		return nil
@@ -289,17 +294,14 @@ function ObservableList:InsertAt(item, index)
 		self._indexes[nextKey] = i + 1
 		self._keyList[i + 1] = nextKey
 
-		local subs = self._keyObservables[nextKey]
-		if subs then
-			table.insert(changed, {
-				key = nextKey;
-				newIndex = i + 1;
-				subs = subs;
-			})
-		end
+		table.insert(changed, {
+			key = nextKey;
+			newIndex = i + 1;
+		})
 	end
 
 	self._keyList[index] = key
+	local listLength = #self._keyList
 
 	-- Fire off count
 	self._countValue.Value = self._countValue.Value + 1
@@ -307,23 +309,17 @@ function ObservableList:InsertAt(item, index)
 	-- Fire off add
 	self.ItemAdded:Fire(item, index, key)
 
-	-- Fire off the index change on the value
-	do
-		local subs = self._keyObservables[key]
-		if subs then
-			table.insert(changed, {
-				key = key;
-				newIndex = index;
-				subs = subs;
-			})
-		end
-	end
 
+	-- 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)
 
-	-- Fire off index change on each key list (if the data isn't stale)
 	for _, data in pairs(changed) do
 		if self._indexes[data.key] == data.newIndex then
-			self:_fireSubs(data.subs, data.newIndex)
+			self._indexObservers:Fire(data.newIndex, self._contents[data.key])
+			self._indexObservers:Fire(self:_toNegativeIndex(listLength, index), self._contents[data.key])
+			self._keyIndexObservables:Fire(data.key, data.newIndex)
 		end
 	end
 
@@ -368,8 +364,6 @@ function ObservableList:RemoveByKey(key)
 		return nil
 	end
 
-	local observableSubs = self._keyObservables[key]
-	self._keyObservables[key] = nil
 	self._indexes[key] = nil
 	self._contents[key] = nil
 
@@ -382,16 +376,13 @@ function ObservableList:RemoveByKey(key)
 		self._indexes[nextKey] = i
 		self._keyList[i] = nextKey
 
-		local subs = self._keyObservables[nextKey]
-		if subs then
-			table.insert(changed, {
-				key = nextKey;
-				newIndex = i;
-				subs = subs;
-			})
-		end
+		table.insert(changed, {
+			key = nextKey;
+			newIndex = i;
+		})
 	end
 	self._keyList[n] = nil
+	local listLength = #self._keyList
 
 	-- Fire off that count changed
 	self._countValue.Value = self._countValue.Value - 1
@@ -401,39 +392,25 @@ function ObservableList:RemoveByKey(key)
 	end
 
 	-- Fire off the index change on the value
-	if observableSubs then
-		self:_completeSubs(observableSubs)
+	self._keyIndexObservables:Complete(key)
+	self._indexObservers:Fire(listLength, nil)
+
+	if listLength == 0 then
+		self._indexObservers:Fire(-1, nil)
 	end
 
 	-- Fire off index change on each key list (if the data isn't stale)
 	for _, data in pairs(changed) do
 		if self._indexes[data.key] == data.newIndex then
-			self:_fireSubs(data.subs, data.newIndex)
+			self._indexObservers:Fire(data.newIndex, self._contents[data.key])
+			self._indexObservers:Fire(self:_toNegativeIndex(listLength, index), self._contents[data.key])
+			self._keyIndexObservables:Fire(data.key, data.newIndex)
 		end
 	end
 
 	return item
 end
 
-function ObservableList:_fireSubs(list, index)
-	for _, sub in pairs(list) do
-		if sub:IsPending() then
-			task.spawn(function()
-				sub:Fire(index)
-			end)
-		end
-	end
-end
-
-function ObservableList:_completeSubs(list)
-	for _, sub in pairs(list) do
-		if sub:IsPending() then
-			sub:Fire(nil)
-			sub:Complete()
-		end
-	end
-end
-
 --[=[
 	Gets a list of all entries.
 	@return { T }
@@ -446,6 +423,20 @@ 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/ObservableList.spec.lua

@@ -23,6 +23,10 @@ return function()
 			expect(observableList:GetCount()).to.equal(1)
 		end)
 
+		it("should allow negative queries", function()
+			expect(observableList:Get(-1)).to.equal("a")
+			expect(observableList:Get(-2)).to.equal(nil)
+		end)
 
 		it("should allow false as a value", function()
 			expect(observableList:Get(2)).to.equal(nil)
@@ -30,6 +34,14 @@ return function()
 			expect(observableList:Get(2)).to.equal(false)
 		end)
 
+		it("should allow negative queries after false", function()
+			expect(observableList:Get(1)).to.equal("a")
+			expect(observableList:Get(2)).to.equal(false)
+
+			expect(observableList:Get(-1)).to.equal(false)
+			expect(observableList:Get(-2)).to.equal("a")
+		end)
+
 		it("should fire off events for a specific key", function()
 			local seen = {}
 			local sub = observableList:ObserveIndex(1):Subscribe(function(value)
@@ -61,6 +73,42 @@ return function()
 			expect(seen[4]:IsDead()).to.equal(true)
 		end)
 
+		it("it should be able to observe a specific key", function()
+			local seen = {}
+			local sub = observableList:ObserveAtIndex(1):Subscribe(function(value)
+				table.insert(seen, value)
+			end)
+
+			local originalList = observableList:GetList()
+			expect(originalList[1]).to.equal("c")
+
+			observableList:InsertAt("dragon", 1)
+
+			sub:Destroy()
+
+			expect(#seen).to.equal(2)
+			expect(seen[1]).to.equal("c")
+			expect(seen[2]).to.equal("dragon")
+		end)
+
+		it("it should be able to observe a specific negative key", function()
+			local seen = {}
+			local sub = observableList:ObserveAtIndex(-1):Subscribe(function(value)
+				table.insert(seen, value)
+			end)
+
+			local originalList = observableList:GetList()
+			expect(originalList[#originalList]).to.equal("a")
+
+			observableList:Add("fire")
+
+			sub:Destroy()
+
+			expect(#seen).to.equal(2)
+			expect(seen[1]).to.equal("a")
+			expect(seen[2]).to.equal("fire")
+		end)
+
 		it("should fire off events on removal", function()
 			local seen = {}
 			local sub = observableList:ObserveIndex(2):Subscribe(function(value)