@quenty/memoize 1.0.1-canary.468.ea8a226.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.468.ea8a226.0 (2024-05-09)
+
+
+### Features
+
+* Add memoize package ([30d4769](https://github.com/Quenty/NevermoreEngine/commit/30d476958d465763e4f97a61a3796099e0a0988f))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2024 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
+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,23 @@
+## Memoize
+
+<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>
+
+Memoization library
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/MemoizeUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/memoize --save
+```

package/default.project.json

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

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@quenty/memoize",
+  "version": "1.0.1-canary.468.ea8a226.0",
+  "description": "Memoization library",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "memoize"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/memoize/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/loader": "10.2.1-canary.468.ea8a226.0",
+    "@quenty/lrucache": "1.0.1-canary.468.ea8a226.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "ea8a2260a364aaf6d6c246a93632b789935da134"
+}

package/src/Shared/MemorizeUtils.lua

@@ -0,0 +1,101 @@
+--[=[
+	@class MemorizeUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local LRUCache = require("LRUCache")
+
+local MemorizeUtils = {}
+
+--[=[
+	Memoizes a function with a max size
+
+	@param func function
+	@param cacheConfig CacheConfig
+]=]
+function MemorizeUtils.memoize(func, cacheConfig)
+	assert(type(func) == "function", "Bad func")
+	assert(MemorizeUtils.isCacheConfig(cacheConfig) or cacheConfig == nil, "Bad cacheConfig")
+
+	cacheConfig = cacheConfig or MemorizeUtils.createCacheConfig()
+
+	local cache = MemorizeUtils._createCacheNode(cacheConfig)
+
+	return function(...)
+		local params = table.pack(...)
+
+		local results = MemorizeUtils._cache_get(cache, params)
+		if not results then
+			results = table.pack(func(...))
+			MemorizeUtils._cache_put(cache, params, results, cacheConfig)
+		end
+
+		return unpack(results, 1, results.n)
+	end
+end
+
+--[=[
+	Returns true if a valid cache config
+
+	@param value any
+	@return boolean
+]=]
+function MemorizeUtils.isCacheConfig(value)
+	return type(value) == "table" and type(value.maxSize) == "number"
+end
+
+--[=[
+	Creates a new cache config
+
+	@param cacheConfig table | nil
+	@return CacheConfig
+]=]
+function MemorizeUtils.createCacheConfig(cacheConfig)
+	assert(MemorizeUtils.isCacheConfig(cacheConfig) or cacheConfig == nil, "Bad cacheConfig")
+
+	cacheConfig = cacheConfig or {}
+
+	return {
+		maxSize = cacheConfig.maxSize or 128;
+	}
+end
+
+function MemorizeUtils._createCacheNode(cacheConfig)
+	return {
+		childrenLRUCache = LRUCache.new(cacheConfig.maxSize);
+	}
+end
+
+function MemorizeUtils._cache_get(cache, params)
+	local node = cache
+	for i=1, #params do
+		node = node.childrenLRUCache:get(params[i])
+		if not node then
+			return nil
+		end
+	end
+
+	return node.results
+end
+
+function MemorizeUtils._cache_put(cache, params, results, cacheConfig)
+	local node = cache
+
+	for i=1, params.n do
+		local param = params[i]
+
+		local paramNode = node.childrenLRUCache:get(param)
+		if paramNode then
+			node = paramNode
+		else
+			paramNode = MemorizeUtils._createCacheNode(cacheConfig)
+			node.childrenLRUCache:set(param, paramNode)
+			node = paramNode
+		end
+	end
+
+	node.results = results
+end
+
+return MemorizeUtils

package/src/node_modules.project.json

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

package/test/default.project.json

@@ -0,0 +1,11 @@
+{
+  "name": "MemoizeTest",
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "memoize": {
+        "$path": ".."
+      }
+    }
+  }
+}