@quenty/undostack 1.0.1-canary.303.3e5dce0.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.303.3e5dce0.0 (2022-11-08)
+
+
+### Features
+
+* Add baseline undo stack system ([ddda496](https://github.com/Quenty/NevermoreEngine/commit/ddda496b12e0f492258e7a83e65d291f3cae337c))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+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
+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 @@
+## UndoStack
+<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>
+
+Undo stack functionality for editing stuff
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/undostack">View docs →</a></div>
+
+## Installation
+```
+npm install @quenty/undostack --save
+```

package/default.project.json

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

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@quenty/undostack",
+  "version": "1.0.1-canary.303.3e5dce0.0",
+  "description": "Generalized undo stack for Roblox",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "Undo"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/undostack/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/baseobject": "6.0.1",
+    "@quenty/instanceutils": "7.1.1",
+    "@quenty/loader": "6.0.1",
+    "@quenty/promise": "6.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "3e5dce0b249a270d35586e5897a36e84611e7834"
+}

package/src/Shared/UndoStack.lua

@@ -0,0 +1,238 @@
+--[=[
+	@class UndoStack
+]=]
+
+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 DEFAULT_MAX_SIZE = 25
+
+local UndoStack = setmetatable({}, BaseObject)
+UndoStack.ClassName = "UndoStack"
+UndoStack.__index = UndoStack
+
+function UndoStack.new(maxSize)
+	local self = setmetatable(BaseObject.new(), UndoStack)
+
+	assert(type(maxSize) == "number" or maxSize == nil, "Bad maxSize")
+
+	self._maxSize = maxSize or DEFAULT_MAX_SIZE
+
+	self._undoStack = {}
+	self._redoStack = {}
+
+	self._hasUndoEntries = Instance.new("BoolValue")
+	self._hasUndoEntries.Value = false
+	self._maid:GiveTask(self._hasUndoEntries)
+
+	self._hasRedoEntries = Instance.new("BoolValue")
+	self._hasRedoEntries.Value = false
+	self._maid:GiveTask(self._hasRedoEntries)
+
+	self._isActionExecuting = Instance.new("BoolValue")
+	self._isActionExecuting.Value = false
+	self._maid:GiveTask(self._isActionExecuting)
+
+	return self
+end
+
+--[=[
+	Clears the redo stack manually. This may be required if you do an action but
+	can't push an undo.
+	@return boolean
+]=]
+function UndoStack:ClearRedoStack()
+	self._redoStack ={}
+	self:_updateHasRedoEntries()
+end
+
+--[=[
+	Returns true if an action is executing
+	@return boolean
+]=]
+function UndoStack:IsActionExecuting()
+	return self._isActionExecuting.Value
+end
+
+--[=[
+	Observes whether the stack has undo entries
+	@return Observable<boolean>
+]=]
+function UndoStack:ObserveHasUndoEntries()
+	return RxInstanceUtils.observeProperty(self._hasUndoEntries, "Value")
+end
+
+--[=[
+	Observes whether the stack has redo entries
+	@return Observable<boolean>
+]=]
+function UndoStack:ObserveHasRedoEntries()
+	return RxInstanceUtils.observeProperty(self._hasRedoEntries, "Value")
+end
+
+--[=[
+	Returns true if there are undo entries on the stack
+	@return boolean
+]=]
+function UndoStack:HasUndoEntries()
+	return self._hasUndoEntries.Value
+end
+
+--[=[
+	Returns true if there are redo entries on the stack
+	@return boolean
+]=]
+function UndoStack:HasRedoEntries()
+	return self._hasRedoEntries.Value
+end
+
+--[=[
+	Pushes an action to be undone.
+
+	```lua
+	local entry = UndoStackEntry.new()
+	entry:SetPromiseUndo(function()
+		return buildService:PromiseSellItem(item)
+	end)
+	entry:SetPromiseRedo(function()
+		return buildService:PromisePlaceItem(item)
+	end)
+
+	maid:GiveTask(undoStack:Push(entry))
+	```
+
+	@param undoStackEntry UndoStackEntry
+	@return function -- Callback that removes the action
+]=]
+function UndoStack:Push(undoStackEntry)
+	assert(UndoStackEntry.isUndoStackEntry(undoStackEntry), "Bad undoStackEntry")
+
+	table.insert(self._undoStack, undoStackEntry)
+	while #self._undoStack > self._maxSize do
+		table.remove(self._undoStack, 1)
+	end
+
+	self._redoStack = {}
+
+	self:_updateHasUndoEntries()
+	self:_updateHasRedoEntries()
+
+	return function()
+		self:Remove(undoStackEntry)
+	end
+end
+
+--[=[
+	Removes the action specified from the stack entirely. If the action was queued to run,
+	it may still run.
+
+	@param undoStackEntry The undo stack entry to remove
+]=]
+function UndoStack:Remove(undoStackEntry)
+	assert(UndoStackEntry.isUndoStackEntry(undoStackEntry), "Bad undoStackEntry")
+
+	local undoIndex = table.find(self._undoStack, undoStackEntry)
+	if undoIndex then
+		table.remove(self._undoStack, undoIndex)
+	end
+
+	local redoIndex = table.find(self._redoStack, undoStackEntry)
+	if redoIndex then
+		table.remove(self._redoStack, redoIndex)
+	end
+
+	self:_updateHasUndoEntries()
+	self:_updateHasRedoEntries()
+end
+
+--[=[
+	Undoes from the stack. If a current action is going on, it will finish running.
+
+	@return Promise
+]=]
+function UndoStack:PromiseUndo()
+	return self:_promiseCurrent(function()
+		local undoStackEntry = table.remove(self._undoStack)
+		if not undoStackEntry then
+			return Promise.resolved(false)
+		end
+
+		self:_updateHasUndoEntries()
+
+		return undoStackEntry:PromiseUndo()
+			:Then(function()
+				if undoStackEntry:HasRedo() then
+					table.insert(self._redoStack, undoStackEntry)
+					self:_updateHasRedoEntries()
+				end
+
+				return true
+			end)
+	end)
+end
+
+--[=[
+	Redoes the from the stack. If a current action is going on, it will be queued.
+
+	@return Promise
+]=]
+function UndoStack:PromiseRedo()
+	return self:_promiseCurrent(function()
+		local undoStackEntry = table.remove(self._redoStack)
+		if not undoStackEntry then
+			return Promise.resolved(false)
+		end
+
+		self:_updateHasRedoEntries()
+
+		return undoStackEntry:PromiseRedo()
+			:Then(function()
+				if undoStackEntry:HasUndo() then
+					table.insert(self._undoStack, undoStackEntry)
+					self:_updateHasUndoEntries()
+				end
+
+				return true
+			end)
+	end)
+end
+
+function UndoStack:_promiseCurrent(doNextPromise)
+	local promise
+	if self._latestPromiseChain then
+		promise = self._latestPromiseChain
+			:Finally(function()
+				return self._maid:GivePromise(doNextPromise())
+			end)
+	else
+		promise = self._maid:GivePromise(doNextPromise())
+	end
+
+	self._latestPromiseChain = promise
+
+	self._isActionExecuting.Value = true
+
+	-- Clean out the actual latest promise
+	promise:Finally(function()
+		if self._latestPromiseChain == promise then
+			self._latestPromiseChain = nil
+			self._isActionExecuting.Value = false
+		end
+	end)
+
+	return promise
+end
+
+function UndoStack:_updateHasUndoEntries()
+	self._hasUndoEntries.Value = #self._undoStack > 0
+end
+
+function UndoStack:_updateHasRedoEntries()
+	self._hasRedoEntries.Value = #self._redoStack > 0
+end
+
+return UndoStack

package/src/Shared/UndoStackEntry.lua

@@ -0,0 +1,69 @@
+--[=[
+	@class UndoStackEntry
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Promise = require("Promise")
+
+local UndoStackEntry = {}
+UndoStackEntry.ClassName = "UndoStackEntry"
+UndoStackEntry.__index = UndoStackEntry
+
+function UndoStackEntry.new()
+	local self = setmetatable({}, UndoStackEntry)
+
+	return self
+end
+
+function UndoStackEntry.isUndoStackEntry(value)
+	return type(value) == "table" and getmetatable(value) == UndoStackEntry
+end
+
+function UndoStackEntry:SetPromiseUndo(promiseUndo)
+	assert(type(promiseUndo) == "function" or promiseUndo == nil, "Bad promiseUndo")
+
+	self._promiseUndo = promiseUndo
+end
+
+function UndoStackEntry:SetPromiseRedo(promiseRedo)
+	assert(type(promiseRedo) == "function" or promiseRedo == nil, "Bad promiseRedo")
+
+	self._promiseRedo = promiseRedo
+end
+
+function UndoStackEntry:HasUndo()
+	return self._promiseUndo ~= nil
+end
+
+function UndoStackEntry:HasRedo()
+	return self._promiseRedo ~= nil
+end
+
+function UndoStackEntry:PromiseUndo()
+	if not self._promiseUndo then
+		return Promise.resolved()
+	end
+
+	local result = self._promiseUndo()
+	if Promise.isPromise(result) then
+		return result
+	else
+		return Promise.resolved(result)
+	end
+end
+
+function UndoStackEntry:PromiseRedo()
+	if not self._promiseUndo then
+		return Promise.resolved()
+	end
+
+	local result = self._promiseRedo()
+	if Promise.isPromise(result) then
+		return result
+	else
+		return Promise.resolved(result)
+	end
+end
+
+return UndoStackEntry

package/src/node_modules.project.json

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