@quenty/undostack 1.14.0 → 1.15.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.
 
+# [1.15.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.14.0...@quenty/undostack@1.15.0) (2023-06-17)
+
+
+### Features
+
+* UndoStackEntry has a maid and can be removed from the stack ([d40668e](https://github.com/Quenty/NevermoreEngine/commit/d40668e07dbd00fc9b816eb7070a1d90219f8e95))
+
+
+
+
+
 # [1.14.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.13.0...@quenty/undostack@1.14.0) (2023-05-26)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/undostack",
-  "version": "1.14.0",
+  "version": "1.15.0",
   "description": "Generalized undo stack for Roblox",
   "keywords": [
     "Roblox",
@@ -26,12 +26,15 @@
   ],
   "dependencies": {
     "@quenty/baseobject": "^6.2.1",
-    "@quenty/instanceutils": "^7.14.0",
+    "@quenty/instanceutils": "^7.15.0",
     "@quenty/loader": "^6.2.1",
-    "@quenty/promise": "^6.5.0"
+    "@quenty/maid": "^2.5.0",
+    "@quenty/promise": "^6.6.0",
+    "@quenty/signal": "^2.4.0",
+    "@quenty/valueobject": "^7.16.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "11058e90e51ea83d3dad6ae9abe59cc19c36b94b"
+  "gitHead": "dc77d6de09e9eb9d3fd6dafd790c052d8393d38f"
 }

package/src/Shared/UndoStack.lua

@@ -8,6 +8,7 @@ local BaseObject = require("BaseObject")
 local Promise = require("Promise")
 local UndoStackEntry = require("UndoStackEntry")
 local ValueObject = require("ValueObject")
+local Maid = require("Maid")
 
 local DEFAULT_MAX_SIZE = 25
 
@@ -43,7 +44,7 @@ end
 	@return boolean
 ]=]
 function UndoStack:ClearRedoStack()
-	self._redoStack ={}
+	self._redoStack = {}
 	self:_updateHasRedoEntries()
 end
 
@@ -108,6 +109,23 @@ end
 function UndoStack:Push(undoStackEntry)
 	assert(UndoStackEntry.isUndoStackEntry(undoStackEntry), "Bad undoStackEntry")
 
+	if self._maid[undoStackEntry] then
+		return function()
+			self:Remove(undoStackEntry)
+		end
+	end
+
+	local maid = Maid.new()
+	maid:GiveTask(undoStackEntry)
+
+	maid:GiveTask(undoStackEntry.Destroying:Connect(function()
+		if undoStackEntry.Destroy then
+			self:Remove(undoStackEntry)
+		end
+	end))
+
+	self._maid[undoStackEntry] = maid
+
 	table.insert(self._undoStack, undoStackEntry)
 	while #self._undoStack > self._maxSize do
 		table.remove(self._undoStack, 1)
@@ -132,18 +150,25 @@ end
 function UndoStack:Remove(undoStackEntry)
 	assert(UndoStackEntry.isUndoStackEntry(undoStackEntry), "Bad undoStackEntry")
 
+	self._maid[undoStackEntry] = nil
+
+	local changed = false
 	local undoIndex = table.find(self._undoStack, undoStackEntry)
 	if undoIndex then
 		table.remove(self._undoStack, undoIndex)
+		changed = true
 	end
 
 	local redoIndex = table.find(self._redoStack, undoStackEntry)
 	if redoIndex then
 		table.remove(self._redoStack, redoIndex)
+		changed = true
 	end
 
-	self:_updateHasUndoEntries()
-	self:_updateHasRedoEntries()
+	if changed then
+		self:_updateHasUndoEntries()
+		self:_updateHasRedoEntries()
+	end
 end
 
 --[=[
@@ -160,7 +185,9 @@ function UndoStack:PromiseUndo()
 
 		self:_updateHasUndoEntries()
 
-		return undoStackEntry:PromiseUndo()
+		return self:_executePromiseWithMaid(function(maid)
+			return undoStackEntry:PromiseUndo(maid)
+		end)
 			:Then(function()
 				if undoStackEntry:HasRedo() then
 					table.insert(self._redoStack, undoStackEntry)
@@ -186,7 +213,9 @@ function UndoStack:PromiseRedo()
 
 		self:_updateHasRedoEntries()
 
-		return undoStackEntry:PromiseRedo()
+		return self:_executePromiseWithMaid(function(maid)
+			return undoStackEntry:PromiseRedo(maid)
+		end)
 			:Then(function()
 				if undoStackEntry:HasUndo() then
 					table.insert(self._undoStack, undoStackEntry)
@@ -224,6 +253,28 @@ function UndoStack:_promiseCurrent(doNextPromise)
 	return promise
 end
 
+function UndoStack:_executePromiseWithMaid(callback)
+	local maid  = Maid.new()
+
+	local promise = Promise.new()
+	maid:GiveTask(promise)
+
+	local result = callback(maid)
+
+	maid:GiveTask(function()
+		self._maid[maid] = nil
+	end)
+	self._maid[maid] = maid
+
+	promise:Finally(function()
+		self._maid[maid] = nil
+	end)
+
+	promise:Resolve(result)
+
+	return promise
+end
+
 function UndoStack:_updateHasUndoEntries()
 	self._hasUndoEntries.Value = #self._undoStack > 0
 end

package/src/Shared/UndoStackEntry.lua

@@ -1,51 +1,98 @@
 --[=[
+	Holds undo state
 	@class UndoStackEntry
 ]=]
 
 local require = require(script.Parent.loader).load(script)
 
 local Promise = require("Promise")
+local Maid = require("Maid")
+local BaseObject = require("BaseObject")
+local Signal = require("Signal")
 
-local UndoStackEntry = {}
+local UndoStackEntry = setmetatable({}, BaseObject)
 UndoStackEntry.ClassName = "UndoStackEntry"
 UndoStackEntry.__index = UndoStackEntry
 
+--[=[
+	Constructs a new undo restack entry. See [UndoStack] for usage.
+
+	@return UndoStackEntry
+]=]
 function UndoStackEntry.new()
-	local self = setmetatable({}, UndoStackEntry)
+	local self = setmetatable(BaseObject.new(), UndoStackEntry)
+
+	self.Destroying = Signal.new()
+	self._maid:GiveTask(function()
+		self.Destroying:Fire()
+		self.Destroying:Destroy()
+	end)
 
 	return self
 end
 
+--[=[
+	Returns true if the etnry is an undo stack entry
+
+	@param value any
+	@return boolean
+]=]
 function UndoStackEntry.isUndoStackEntry(value)
 	return type(value) == "table" and getmetatable(value) == UndoStackEntry
 end
 
+--[=[
+	Sets the handler that will undo the result
+
+	@param promiseUndo function | nil
+]=]
 function UndoStackEntry:SetPromiseUndo(promiseUndo)
 	assert(type(promiseUndo) == "function" or promiseUndo == nil, "Bad promiseUndo")
 
 	self._promiseUndo = promiseUndo
 end
 
+--[=[
+	Sets the handler that will redo the result
+
+	@param promiseRedo function | nil
+]=]
 function UndoStackEntry:SetPromiseRedo(promiseRedo)
 	assert(type(promiseRedo) == "function" or promiseRedo == nil, "Bad promiseRedo")
 
 	self._promiseRedo = promiseRedo
 end
 
+--[=[
+	Returns true if this entry can be undone
+	@return boolean
+]=]
 function UndoStackEntry:HasUndo()
 	return self._promiseUndo ~= nil
 end
 
+--[=[
+	Returns true if this entry can be redone
+	@return boolean
+]=]
 function UndoStackEntry:HasRedo()
 	return self._promiseRedo ~= nil
 end
 
-function UndoStackEntry:PromiseUndo()
+--[=[
+	Promises undo. Should be done via [UndoStack.PromiseUndo]
+
+	@param maid Maid
+	@return Promise
+]=]
+function UndoStackEntry:PromiseUndo(maid)
+	assert(Maid.isMaid(maid), "Bad maid")
+
 	if not self._promiseUndo then
 		return Promise.resolved()
 	end
 
-	local result = self._promiseUndo()
+	local result = maid:GivePromise(self._promiseUndo(maid))
 	if Promise.isPromise(result) then
 		return result
 	else
@@ -53,12 +100,20 @@ function UndoStackEntry:PromiseUndo()
 	end
 end
 
-function UndoStackEntry:PromiseRedo()
+--[=[
+	Promises redo execution. Should be done via [UndoStack.PromiseRedo]
+
+	@param maid Maid
+	@return Promise
+]=]
+function UndoStackEntry:PromiseRedo(maid)
+	assert(Maid.isMaid(maid), "Bad maid")
+
 	if not self._promiseUndo then
 		return Promise.resolved()
 	end
 
-	local result = self._promiseRedo()
+	local result = maid:GivePromise(self._promiseRedo(maid))
 	if Promise.isPromise(result) then
 		return result
 	else