@quenty/observablecollection 5.3.1 → 5.4.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.3.1...@quenty/observablecollection@5.4.0) (2022-12-29)
+
+
+### Features
+
+* Add FilteredObservableListView.new ([de1e703](https://github.com/Quenty/NevermoreEngine/commit/de1e70362c9bef48ae00cc4620beca3e549fb20b))
+
+
+
+
+
 ## [5.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@5.3.0...@quenty/observablecollection@5.3.1) (2022-12-27)
 
 **Note:** Version bump only for package @quenty/observablecollection

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/observablecollection",
-  "version": "5.3.1",
+  "version": "5.4.0",
   "description": "A set of observable collections, such as sets, maps, sorted lists, and more.",
   "keywords": [
     "Roblox",
@@ -39,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ff0c0732eca3400949945c58c1d3cb8a479c9789"
+  "gitHead": "daae02817ae9128c5bf81220ef44e41d22ec14ad"
 }

package/src/Shared/FilteredObservableListView.lua

@@ -0,0 +1,107 @@
+--[=[
+	@class FilteredObservableListView
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local ObservableSortedList = require("ObservableSortedList")
+local Observable = require("Observable")
+local Rx = require("Rx")
+
+local FilteredObservableListView = setmetatable({}, BaseObject)
+FilteredObservableListView.ClassName = "FilteredObservableListView"
+FilteredObservableListView.__index = FilteredObservableListView
+
+-- Higher numbers last
+local function defaultCompare(a, b)
+	return a < b
+end
+
+function FilteredObservableListView.new(observableList, observeScoreCallback, compare)
+	local self = setmetatable(BaseObject.new(), FilteredObservableListView)
+
+	self._compare = compare or defaultCompare
+	self._baseList = assert(observableList, "No observableList")
+	self._observeScoreCallback = assert(observeScoreCallback, "No observeScoreCallback")
+
+	self._scoredList = ObservableSortedList.new(function(a, b)
+		-- Preserve index when scoring does not
+		if a.score == b.score then
+			return a.index < b.index
+		else
+			return self._compare(a.score, b.score)
+		end
+	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)
+		if brio:IsDead() then
+			return
+		end
+
+		local maid = brio:ToMaid()
+		local entry, key = brio:GetValue()
+		local observeScore = self._observeScoreCallback(entry)
+		assert(Observable.isObservable(observeScore), "Bad observeScore")
+
+		maid._add = self._scoredList:Add(entry, Rx.combineLatest({
+			score = observeScore;
+			index = self._baseList:ObserveIndexByKey(key);
+		}):Pipe({
+			Rx.map(function(state)
+				if state.score == nil then
+					return nil
+				end
+				return state
+			end)
+		}))
+
+
+	end))
+
+	return self
+end
+
+--[=[
+	Observes all items in the list
+	@return Observable<Brio<T>>
+]=]
+function FilteredObservableListView:ObserveItemsBrio()
+	return self._scoredList:ObserveItemsBrio()
+end
+
+--[=[
+	Observes the index as it changes, until the entry at the existing
+	key is removed.
+
+	@param key Symbol
+	@return Observable<number>
+]=]
+function FilteredObservableListView:ObserveIndexByKey(key)
+	return self._scoredList:ObserveIndexByKey(key)
+end
+
+--[=[
+	Gets the count of items in the list
+	@return number
+]=]
+function FilteredObservableListView:GetCount()
+	return self._scoredList:GetCount()
+end
+
+--[=[
+	Observes the count of the list
+	@return Observable<number>
+]=]
+function FilteredObservableListView:ObserveCount()
+	return self._scoredList:ObserveCount()
+end
+
+return FilteredObservableListView

package/src/Shared/ObservableSortedList.lua

@@ -21,6 +21,7 @@ local Brio = require("Brio")
 local RxValueBaseUtils = require("RxValueBaseUtils")
 local Symbol = require("Symbol")
 
+-- Higher numbers last
 local function defaultCompare(a, b)
 	return a < b
 end

package/src/Shared/ObservableSortedList.spec.lua

@@ -33,5 +33,17 @@ return function()
 			expect(observableSortedList:Get(2)).to.equal("b")
 			expect(observableSortedList:GetCount()).to.equal(2)
 		end)
+
+		it("should add in order if number is the same", function()
+			observableSortedList = ObservableSortedList.new()
+			observableSortedList:Add("a", Rx.of(0))
+			observableSortedList:Add("b", Rx.of(0))
+			observableSortedList:Add("c", Rx.of(0))
+
+			expect(observableSortedList:Get(1)).to.equal("a")
+			expect(observableSortedList:Get(2)).to.equal("b")
+			expect(observableSortedList:Get(3)).to.equal("c")
+			expect(observableSortedList:GetCount()).to.equal(1)
+		end)
 	end)
 end