@quenty/lrucache 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 LRUCache package ([f5ded94](https://github.com/Quenty/NevermoreEngine/commit/f5ded9480dc991105dfdb3c36d9152329a18882a))

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 @@
+## Lrucache
+
+<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>
+
+LRUCache library
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/LrucacheUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/lrucache --save
+```

package/default.project.json

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

package/package.json

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

package/src/Shared/LRUCache.lua

@@ -0,0 +1,181 @@
+-- lua-lru, LRU cache in Lua
+-- Copyright (c) 2015 Boris Nagaev
+--[[
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Boris Nagaev
+
+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.
+]]
+
+local LRUCache = {}
+LRUCache.ClassName = "LRUCache"
+
+function LRUCache.new(max_size, max_bytes)
+    assert(max_size >= 1, "max_size must be >= 1")
+    assert(not max_bytes or max_bytes >= 1, "max_bytes must be >= 1")
+
+    -- current size
+    local size = 0
+    local bytes_used = 0
+
+    -- map is a hash map from keys to tuples
+    -- tuple: value, prev, next, key
+    -- prev and next are pointers to tuples
+    local map = {}
+
+    -- indices of tuple
+    local VALUE = 1
+    local PREV = 2
+    local NEXT = 3
+    local KEY = 4
+    local BYTES = 5
+
+    -- newest and oldest are ends of double-linked list
+    local newest = nil -- first
+    local oldest = nil -- last
+
+    local removed_tuple -- created in del(), removed in set()
+
+    -- remove a tuple from linked list
+    local function cut(tuple)
+        local tuple_prev = tuple[PREV]
+        local tuple_next = tuple[NEXT]
+        tuple[PREV] = nil
+        tuple[NEXT] = nil
+        if tuple_prev and tuple_next then
+            tuple_prev[NEXT] = tuple_next
+            tuple_next[PREV] = tuple_prev
+        elseif tuple_prev then
+            -- tuple is the oldest element
+            tuple_prev[NEXT] = nil
+            oldest = tuple_prev
+        elseif tuple_next then
+            -- tuple is the newest element
+            tuple_next[PREV] = nil
+            newest = tuple_next
+        else
+            -- tuple is the only element
+            newest = nil
+            oldest = nil
+        end
+    end
+
+    -- insert a tuple to the newest end
+    local function setNewest(tuple)
+        if not newest then
+            newest = tuple
+            oldest = tuple
+        else
+            tuple[NEXT] = newest
+            newest[PREV] = tuple
+            newest = tuple
+        end
+    end
+
+    local function del(key, tuple)
+        map[key] = nil
+        cut(tuple)
+        size = size - 1
+        bytes_used = bytes_used - (tuple[BYTES] or 0)
+        removed_tuple = tuple
+    end
+
+    -- removes elemenets to provide enough memory
+    -- returns last removed element or nil
+    local function makeFreeSpace(bytes)
+        while size + 1 > max_size or
+            (max_bytes and bytes_used + bytes > max_bytes)
+        do
+            assert(oldest, "not enough storage for cache")
+            del(oldest[KEY], oldest)
+        end
+    end
+
+    local function get(_, key)
+        local tuple = map[key]
+        if not tuple then
+            return nil
+        end
+        cut(tuple)
+        setNewest(tuple)
+        return tuple[VALUE]
+    end
+
+    local function set(_, key, value, bytes)
+        local tuple = map[key]
+        if tuple then
+            del(key, tuple)
+        end
+        if value ~= nil then
+            -- the value is not removed
+            bytes = max_bytes and (bytes or #value) or 0
+            makeFreeSpace(bytes)
+            local tuple1 = removed_tuple or {}
+            map[key] = tuple1
+            tuple1[VALUE] = value
+            tuple1[KEY] = key
+            tuple1[BYTES] = max_bytes and bytes
+            size = size + 1
+            bytes_used = bytes_used + bytes
+            setNewest(tuple1)
+        else
+            assert(key ~= nil, "Key may not be nil")
+        end
+        removed_tuple = nil
+    end
+
+    local function delete(_, key)
+        return set(nil, key, nil)
+    end
+
+    local function mynext(_, prev_key)
+        local tuple
+        if prev_key then
+            tuple = map[prev_key][NEXT]
+        else
+            tuple = newest
+        end
+        if tuple then
+            return tuple[KEY], tuple[VALUE]
+        else
+            return nil
+        end
+    end
+
+    -- returns iterator for keys and values
+    local function lru_pairs()
+        return mynext, nil, nil
+    end
+
+    local mt = {
+        __index = {
+            get = get,
+            set = set,
+            delete = delete,
+            pairs = lru_pairs,
+        },
+        __pairs = lru_pairs,
+    }
+
+    return setmetatable({}, mt)
+end
+
+return LRUCache

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": "LrucacheTest",
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "lrucache": {
+        "$path": ".."
+      }
+    }
+  }
+}