@quenty/undostack 2.0.0-canary.331.7eefa75.0 → 2.0.0

package/CHANGELOG.md

@@ -3,7 +3,157 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [2.0.0-canary.331.7eefa75.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.6.0...@quenty/undostack@2.0.0-canary.331.7eefa75.0) (2023-02-27)
+# [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.23.0...@quenty/undostack@2.0.0) (2023-10-11)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.23.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.22.0...@quenty/undostack@1.23.0) (2023-09-21)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.22.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.21.0...@quenty/undostack@1.22.0) (2023-09-04)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.21.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.20.0...@quenty/undostack@1.21.0) (2023-08-23)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.19.0...@quenty/undostack@1.20.0) (2023-08-01)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.18.0...@quenty/undostack@1.19.0) (2023-07-28)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.17.0...@quenty/undostack@1.18.0) (2023-07-23)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.16.0...@quenty/undostack@1.17.0) (2023-07-15)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.16.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.15.0...@quenty/undostack@1.16.0) (2023-07-10)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [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)
+
+
+### Features
+
+* Initial refactor of guis to use ValueObject instead of ValueObject ([723aba0](https://github.com/Quenty/NevermoreEngine/commit/723aba0208cae7e06c9d8bf2d8f0092d042d70ea))
+
+
+
+
+
+# [1.13.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.12.0...@quenty/undostack@1.13.0) (2023-05-08)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.12.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.11.1...@quenty/undostack@1.12.0) (2023-04-10)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+## [1.11.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.11.0...@quenty/undostack@1.11.1) (2023-04-07)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.11.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.10.0...@quenty/undostack@1.11.0) (2023-04-06)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.10.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.9.0...@quenty/undostack@1.10.0) (2023-04-03)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.8.0...@quenty/undostack@1.9.0) (2023-03-31)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.7.0...@quenty/undostack@1.8.0) (2023-03-05)
+
+**Note:** Version bump only for package @quenty/undostack
+
+
+
+
+
+# [1.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@1.6.0...@quenty/undostack@1.7.0) (2023-02-27)
 
 **Note:** Version bump only for package @quenty/undostack
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2022 Quenty
+Copyright (c) 2014-2023 James Onnen (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/undostack",
-  "version": "2.0.0-canary.331.7eefa75.0",
+  "version": "2.0.0",
   "description": "Generalized undo stack for Roblox",
   "keywords": [
     "Roblox",
@@ -25,13 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "6.1.0",
-    "@quenty/instanceutils": "8.0.0-canary.331.7eefa75.0",
-    "@quenty/loader": "6.1.0",
-    "@quenty/promise": "7.0.0-canary.331.7eefa75.0"
+    "@quenty/baseobject": "^7.0.0",
+    "@quenty/instanceutils": "^8.0.0",
+    "@quenty/loader": "^7.0.0",
+    "@quenty/maid": "^2.6.0",
+    "@quenty/promise": "^7.0.0",
+    "@quenty/signal": "^3.0.0",
+    "@quenty/valueobject": "^8.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7eefa756f8bd892b1210349a8133d6d56992dffb"
+  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
 }

package/src/Shared/UndoStack.lua

@@ -7,7 +7,8 @@ local require = require(script.Parent.loader).load(script)
 local BaseObject = require("BaseObject")
 local Promise = require("Promise")
 local UndoStackEntry = require("UndoStackEntry")
-local RxInstanceUtils = require("RxInstanceUtils")
+local ValueObject = require("ValueObject")
+local Maid = require("Maid")
 
 local DEFAULT_MAX_SIZE = 25
 
@@ -25,16 +26,13 @@ function UndoStack.new(maxSize)
 	self._undoStack = {}
 	self._redoStack = {}
 
-	self._hasUndoEntries = Instance.new("BoolValue")
-	self._hasUndoEntries.Value = false
+	self._hasUndoEntries = ValueObject.new(false, "boolean")
 	self._maid:GiveTask(self._hasUndoEntries)
 
-	self._hasRedoEntries = Instance.new("BoolValue")
-	self._hasRedoEntries.Value = false
+	self._hasRedoEntries = ValueObject.new(false, "boolean")
 	self._maid:GiveTask(self._hasRedoEntries)
 
-	self._isActionExecuting = Instance.new("BoolValue")
-	self._isActionExecuting.Value = false
+	self._isActionExecuting = ValueObject.new(false, "boolean")
 	self._maid:GiveTask(self._isActionExecuting)
 
 	return self
@@ -46,7 +44,7 @@ end
 	@return boolean
 ]=]
 function UndoStack:ClearRedoStack()
-	self._redoStack ={}
+	self._redoStack = {}
 	self:_updateHasRedoEntries()
 end
 
@@ -63,7 +61,7 @@ end
 	@return Observable<boolean>
 ]=]
 function UndoStack:ObserveHasUndoEntries()
-	return RxInstanceUtils.observeProperty(self._hasUndoEntries, "Value")
+	return self._hasUndoEntries:Observe()
 end
 
 --[=[
@@ -71,7 +69,7 @@ end
 	@return Observable<boolean>
 ]=]
 function UndoStack:ObserveHasRedoEntries()
-	return RxInstanceUtils.observeProperty(self._hasRedoEntries, "Value")
+	return self._hasRedoEntries:Observe()
 end
 
 --[=[
@@ -111,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)
@@ -135,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
 
 --[=[
@@ -163,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)
@@ -189,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)
@@ -227,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