@quenty/maid 3.3.0 → 3.4.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/maid@3.3.0...@quenty/maid@3.4.0) (2024-10-04)
+
+
+### Bug Fixes
+
+* Maid:Add reports the correct method name in error ([3d31b0d](https://github.com/Quenty/NevermoreEngine/commit/3d31b0d5c6aa7c3bf280e102b1b37a3219ef2dba))
+
+
+### Performance Improvements
+
+* Order maid tasks by most common access scenarios and reduce query of typeof() calls ([2f6c713](https://github.com/Quenty/NevermoreEngine/commit/2f6c7130f462188e77ee4789315e5692302280eb))
+
+
+
+
+
 # [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/maid@3.2.0...@quenty/maid@3.3.0) (2024-09-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/maid",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "Easily cleanup event listeners and objects in Roblox",
   "keywords": [
     "Roblox",
@@ -29,5 +29,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fb172906f3ee725269ec1e5f4daf9dca227e729d"
+  "gitHead": "035abfa088c854a73e1c65b350267eaa17669646"
 }

package/src/Shared/Maid.lua

@@ -103,34 +103,39 @@ function Maid:__newindex(index, newTask)
 	end
 
 	local tasks = self._tasks
-	local oldTask = tasks[index]
+	local job = tasks[index]
 
-	if oldTask == newTask then
+	if job == newTask then
 		return
 	end
 
 	tasks[index] = newTask
 
-	if oldTask then
-		if type(oldTask) == "function" then
-			oldTask()
-		elseif type(oldTask) == "thread" then
+	if job then
+		local jobType = typeof(job)
+		if jobType == "function" then
+			job()
+		elseif jobType == "table" then
+			if type(job.Destroy) == "function" then
+				job:Destroy()
+			end
+		elseif jobType == "Instance" then
+			job:Destroy()
+		elseif jobType == "thread" then
 			local cancelled
-			if coroutine.running() ~= oldTask then
+			if coroutine.running() ~= job then
 				cancelled = pcall(function()
-					task.cancel(oldTask)
+					task.cancel(job)
 				end)
 			end
 
 			if not cancelled then
 				task.defer(function()
-					task.cancel(oldTask)
+					task.cancel(job)
 				end)
 			end
-		elseif typeof(oldTask) == "RBXScriptConnection" then
-			oldTask:Disconnect()
-		elseif oldTask.Destroy then
-			oldTask:Destroy()
+		elseif jobType == "RBXScriptConnection" then
+			job:Disconnect()
 		end
 	end
 end
@@ -149,7 +154,7 @@ function Maid:Add(task)
 	self[#self._tasks+1] = task
 
 	if type(task) == "table" and (not task.Destroy) then
-		warn("[Maid.GiveTask] - Gave table task without .Destroy\n\n" .. debug.traceback())
+		warn("[Maid.Add] - Gave table task without .Destroy\n\n" .. debug.traceback())
 	end
 
 	return task
@@ -229,9 +234,14 @@ function Maid:DoCleaning()
 	local index, job = next(tasks)
 	while job ~= nil do
 		tasks[index] = nil
-		if type(job) == "function" then
+		local jobType = typeof(job)
+		if jobType == "function" then
 			job()
-		elseif type(job) == "thread" then
+		elseif jobType == "table" and type(job.Destroy) == "function" then
+			job:Destroy()
+		elseif jobType == "Instance" then
+			job:Destroy()
+		elseif jobType == "thread" then
 			local cancelled
 			if coroutine.running() ~= job then
 				cancelled = pcall(function()
@@ -245,10 +255,8 @@ function Maid:DoCleaning()
 					task.cancel(toCancel)
 				end)
 			end
-		elseif typeof(job) == "RBXScriptConnection" then
+		elseif jobType == "RBXScriptConnection" then
 			job:Disconnect()
-		elseif job.Destroy then
-			job:Destroy()
 		end
 		index, job = next(tasks)
 	end

package/src/Shared/MaidTaskUtils.lua

@@ -23,11 +23,12 @@ local MaidTaskUtils = {}
 	@return boolean
 ]=]
 function MaidTaskUtils.isValidTask(job)
-	return type(job) == "function"
-		or type(job) == "thread"
-		or typeof(job) == "RBXScriptConnection"
-		or type(job) == "table" and type(job.Destroy) == "function"
-		or typeof(job) == "Instance"
+	local jobType = typeof(job)
+	return jobType == "function"
+		or jobType == "thread"
+		or jobType == "RBXScriptConnection"
+		or jobType == "Instance"
+		or (jobType == "table" and type(job.Destroy) == "function")
 end
 
 --[=[
@@ -36,9 +37,16 @@ end
 	@param job MaidTask -- Task to execute
 ]=]
 function MaidTaskUtils.doTask(job)
-	if type(job) == "function" then
+	local jobType = typeof(job)
+	if jobType == "function" then
 		job()
-	elseif type(job) == "thread" then
+	elseif jobType == "table" then
+		if type(job.Destroy) == "function" then
+			job:Destroy()
+		end
+	elseif jobType == "Instance" then
+		job:Destroy()
+	elseif jobType == "thread" then
 		local cancelled
 		if coroutine.running() ~= job then
 			cancelled = pcall(function()
@@ -51,15 +59,10 @@ function MaidTaskUtils.doTask(job)
 				task.cancel(job)
 			end)
 		end
-	elseif typeof(job) == "RBXScriptConnection" then
+	elseif jobType == "RBXScriptConnection" then
 		job:Disconnect()
-	elseif type(job) == "table" and type(job.Destroy) == "function" then
-		job:Destroy()
-	-- selene: allow(if_same_then_else)
-	elseif typeof(job) == "Instance" then
-		job:Destroy()
 	else
-		error("Bad job")
+		error(string.format("[MaidTaskUtils.doTask] - Bad job of type %q", typeof(job)))
 	end
 end