@quenty/instanceutils 4.2.1-canary.261.5628274.0 → 5.1.0

package/CHANGELOG.md

@@ -3,7 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [4.2.1-canary.261.5628274.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/instanceutils@4.2.0...@quenty/instanceutils@4.2.1-canary.261.5628274.0) (2022-05-21)
+# [5.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/instanceutils@5.0.0...@quenty/instanceutils@5.1.0) (2022-06-21)
+
+
+### Features
+
+* Add RxInstanceUtils.observeChildrenOfNameBrio ([5e5e9a5](https://github.com/Quenty/NevermoreEngine/commit/5e5e9a52bf6cd164bb59f9dc1fdba4470fa6e2dc))
+
+
+
+
+
+# [5.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/instanceutils@4.2.0...@quenty/instanceutils@5.0.0) (2022-05-21)
 
 
 ### Features

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2021 Quenty
+Copyright (c) 2014-2022 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/instanceutils",
-  "version": "4.2.1-canary.261.5628274.0",
+  "version": "5.1.0",
   "description": "Utility functions involving instances in Roblox",
   "keywords": [
     "Roblox",
@@ -26,13 +26,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "5.2.1-canary.261.5628274.0",
-    "@quenty/loader": "4.1.1-canary.261.5628274.0",
-    "@quenty/maid": "2.3.0",
-    "@quenty/rx": "4.2.1-canary.261.5628274.0"
+    "@quenty/brio": "^6.1.0",
+    "@quenty/loader": "^5.0.0",
+    "@quenty/maid": "^2.3.0",
+    "@quenty/rx": "^5.1.0",
+    "@quenty/symbol": "^2.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5628274461f4fa0135e63b62e99fcd508d4c94f9"
+  "gitHead": "c8732cc5dea767b3ff362db43137e2a16da7bc0d"
 }

package/src/Shared/RxInstanceUtils.lua

@@ -16,6 +16,9 @@ local Brio = require("Brio")
 local Maid = require("Maid")
 local Observable = require("Observable")
 local Rx = require("Rx")
+local Symbol = require("Symbol")
+
+local UNSET_VALUE = Symbol.named("unsetValue")
 
 local RxInstanceUtils = {}
 
@@ -109,15 +112,29 @@ function RxInstanceUtils.observePropertyBrio(instance, propertyName, predicate)
 
 	return Observable.new(function(sub)
 		local maid = Maid.new()
+		local lastValue = UNSET_VALUE
 
 		local function handlePropertyChanged()
-			maid._property = nil
-
 			local propertyValue = instance[propertyName]
-			if not predicate or predicate(propertyValue) then
-				local brio = Brio.new(instance[propertyName])
-				maid._property = brio
-				sub:Fire(brio)
+
+			-- Deferred events can cause multiple values to be queued at once
+			-- but we operate at this post-deferred layer, so lets only output
+			-- reflected values.
+			if lastValue ~= propertyValue then
+				lastValue = propertyValue
+
+				if not predicate or predicate(propertyValue) then
+					local brio = Brio.new(instance[propertyName])
+
+					maid._lastBrio = brio
+
+					-- The above line can cause us to be overwritten so make sure before firing.
+					if maid._lastBrio == brio then
+						sub:Fire(brio)
+					end
+				else
+					maid._lastBrio = nil
+				end
 			end
 		end
 
@@ -182,6 +199,59 @@ function RxInstanceUtils.observeLastNamedChildBrio(parent, className, name)
 	end)
 end
 
+--[=[
+	Observes the children with a specific name.
+
+	@param parent Instance
+	@param className string
+	@param name string
+	@return Observable<Brio<Instance>>
+]=]
+function RxInstanceUtils.observeChildrenOfNameBrio(parent, className, name)
+	assert(typeof(parent) == "Instance", "Bad parent")
+	assert(type(className) == "string", "Bad className")
+	assert(type(name) == "string", "Bad name")
+
+	return Observable.new(function(sub)
+		local topMaid = Maid.new()
+
+		local function handleChild(child)
+			if not child:IsA(className) then
+				return
+			end
+
+			local maid = Maid.new()
+
+			local function handleNameChanged()
+				if child.Name == name then
+					local brio = Brio.new(child)
+					maid._brio = brio
+
+					sub:Fire(brio)
+				else
+					maid._brio = nil
+				end
+			end
+
+			maid:GiveTask(child:GetPropertyChangedSignal("Name"):Connect(handleNameChanged))
+			handleNameChanged()
+
+			topMaid[child] = maid
+		end
+
+		topMaid:GiveTask(parent.ChildAdded:Connect(handleChild))
+		topMaid:GiveTask(parent.ChildRemoved:Connect(function(child)
+			topMaid[child] = nil
+		end))
+
+		for _, child in pairs(parent:GetChildren()) do
+			handleChild(child)
+		end
+
+		return topMaid
+	end)
+end
+
 --[=[
 	Observes all children of a specific class