@quenty/observablecollection 1.0.1-canary.241.8dba9c1.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1-canary.241.8dba9c1.0 (2022-01-03)
+
+
+### Features
+
+* Add ObservableCollection package ([a4e8214](https://github.com/Quenty/NevermoreEngine/commit/a4e821471f35998d63f38a4f4a578e07b4e79035))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2021 Quenty
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+## Observable Collection
+<div align="center">
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
+  </a>
+  <a href="https://discord.gg/mhtGUS8">
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
+  </a>
+  <a href="https://github.com/Quenty/NevermoreEngine/actions">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
+  </a>
+</div>
+
+An observable set for use in UI situations
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ObservableSet">View docs →</a></div>
+
+## Installation
+```
+npm install @quenty/observableset --save
+```

package/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "observablecollection",
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@quenty/observablecollection",
+  "version": "1.0.1-canary.241.8dba9c1.0",
+  "description": "An observable set",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "event",
+    "list",
+    "observable"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/observablecollection/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/brio": "3.5.3-canary.241.8dba9c1.0",
+    "@quenty/loader": "3.1.3-canary.241.8dba9c1.0",
+    "@quenty/maid": "2.0.2",
+    "@quenty/promise": "3.3.2-canary.241.8dba9c1.0",
+    "@quenty/rx": "3.5.3-canary.241.8dba9c1.0",
+    "@quenty/signal": "2.0.3-canary.241.8dba9c1.0",
+    "@quenty/valuebaseutils": "3.5.3-canary.241.8dba9c1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "8dba9c1e474a8f8c5de373dc04e3c876e21b034b"
+}

package/src/Shared/ObservableSet.lua

@@ -0,0 +1,183 @@
+--[=[
+	A list that can be observed for blend and other components
+	@class ObservableSet
+]=]
+
+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 RxValueBaseUtils = require("RxValueBaseUtils")
+
+local ObservableSet = {}
+ObservableSet.ClassName = "ObservableSet"
+ObservableSet.__index = ObservableSet
+
+--[=[
+	Constructs a new ObservableSet
+	@return ObservableSet
+]=]
+function ObservableSet.new()
+	local self = setmetatable({}, ObservableSet)
+
+	self._maid = Maid.new()
+	self._set = {}
+
+	self._countValue = Instance.new("IntValue")
+	self._countValue.Value = 0
+	self._maid:GiveTask(self._countValue)
+
+--[=[
+	Fires when an item is added
+	@readonly
+	@prop ItemAdded Signal<T>
+	@within ObservableSet
+]=]
+	self.ItemAdded = Signal.new()
+	self._maid:GiveTask(self.ItemAdded)
+
+--[=[
+	Fires when an item is removed.
+	@readonly
+	@prop ItemRemoved Signal<T>
+	@within ObservableSet
+]=]
+	self.ItemRemoved = Signal.new()
+	self._maid:GiveTask(self.ItemRemoved)
+
+--[=[
+	Fires when the count changes.
+	@prop CountChanged RBXScriptSignal
+	@within ObservableSet
+]=]
+	self.CountChanged = self._countValue.Changed
+
+	return self
+end
+
+--[=[
+	Returns whether the set is an observable set
+	@param value any
+	@return boolean
+]=]
+function ObservableSet.isObservableSet(value)
+	return type(value) == "table" and getmetatable(value) == ObservableSet
+end
+
+--[=[
+	Observes all items in the set
+	@return Observable<Brio<T>>
+]=]
+function ObservableSet:ObserveItemsBrio()
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local function handleItem(item)
+			local brio = Brio.new(item)
+			maid[item] = brio
+			sub:Fire(brio)
+		end
+
+		for item, _ in pairs(self._set) do
+			handleItem(item)
+		end
+
+		maid:GiveTask(self.ItemAdded:Connect(handleItem))
+		maid:GiveTask(self.ItemRemoved:Connect(function(item)
+			maid[item] = nil
+		end))
+
+		self._maid[sub] = maid
+		maid:GiveTask(function()
+			self._maid[sub] = nil
+			sub:Complete()
+		end)
+
+		return maid
+	end)
+end
+
+--[=[
+	Returns whether the set contains the item
+	@param item T
+	@return boolean
+]=]
+function ObservableSet:Contains(item)
+	assert(item ~= nil, "Bad item")
+
+	return self._set[item] == true
+end
+
+--[=[
+	Gets the count of items in the set
+	@return number
+]=]
+function ObservableSet:GetCount()
+	return self._countValue.Value
+end
+
+--[=[
+	Observes the count of the set
+	@return Observable<number>
+]=]
+function ObservableSet:ObserveCount()
+	return RxValueBaseUtils.observeValue(self._countValue)
+end
+
+--[=[
+	Adds the item to the set if it does not exists.
+	@param item T
+]=]
+function ObservableSet:Add(item)
+	assert(item ~= nil, "Bad item")
+
+	if not self._set[item] then
+		self._countValue.Value = self._countValue.Value + 1
+		self._set[item] = true
+		self.ItemAdded:Fire(item)
+	end
+
+	return function()
+		if self.Destroy then
+			self:Remove(item)
+		end
+	end
+end
+
+--[=[
+	Removes the item from the set if it exists.
+	@param item T
+]=]
+function ObservableSet:Remove(item)
+	assert(item ~= nil, "Bad item")
+
+	if self._set[item] then
+		self._countValue.Value = self._countValue.Value - 1
+		self._set[item] = nil
+		self.ItemRemoved:Fire(item)
+	end
+end
+
+--[=[
+	Gets a list of all entries.
+	@return { T }
+]=]
+function ObservableSet:GetList()
+	local list = {}
+	for item, _ in pairs(self._set) do
+		table.insert(list, item)
+	end
+	return list
+end
+
+--[=[
+	Cleans up the ObservableSet and sets the metatable to nil.
+]=]
+function ObservableSet:Destroy()
+	self._maid:DoCleaning()
+	setmetatable(self, nil)
+end
+
+return ObservableSet

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}