@quenty/tuple 1.0.1-canary.478.34e8ede.0 → 1.1.0

package/CHANGELOG.md

@@ -3,9 +3,36 @@
 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.478.34e8ede.0 (2024-08-27)
+# 1.1.0 (2024-09-12)
+
+
+### Bug Fixes
+
+* Fix tuple string conversion ([9b907d5](https://github.com/Quenty/NevermoreEngine/commit/9b907d5d068e2b73fb9de6a8aef89504b30ccb22))
 
 
 ### Features
 
 * Add tuple package and fix tie signal ([134f90c](https://github.com/Quenty/NevermoreEngine/commit/134f90c03b265b9d2232198475ca27f4d5e87071))
+* Add TupleLookup ([4de1c5f](https://github.com/Quenty/NevermoreEngine/commit/4de1c5fcd226fdcb5f23f26cd0b3ec31005a5330))
+
+
+
+
+
+# v1.1.0 (Thu Sep 12 2024)
+
+#### 🚀 Enhancement
+
+- feat: Support hot-reloading from a hoarcekat story [#478](https://github.com/Quenty/NevermoreEngine/pull/478) ([@Quenty](https://github.com/Quenty))
+- feat: Add TupleLookup ([@Quenty](https://github.com/Quenty))
+- feat: Add tuple package and fix tie signal ([@Quenty](https://github.com/Quenty))
+
+#### 🐛 Bug Fix
+
+- style: Fix linting docs ([@Quenty](https://github.com/Quenty))
+- fix: Fix tuple string conversion ([@Quenty](https://github.com/Quenty))
+
+#### Authors: 1
+
+- James Onnen ([@Quenty](https://github.com/Quenty))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/tuple",
-  "version": "1.0.1-canary.478.34e8ede.0",
+  "version": "1.1.0",
   "description": "Tuple utility package",
   "keywords": [
     "Roblox",
@@ -25,10 +25,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "10.3.1-canary.478.34e8ede.0"
+    "@quenty/loader": "^10.4.0",
+    "@quenty/lrucache": "^1.2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "34e8edee97fa93a0a5bd84442b85826082444f2a"
+  "gitHead": "fb172906f3ee725269ec1e5f4daf9dca227e729d"
 }

package/src/Shared/Tuple.lua

@@ -8,10 +8,22 @@ local Tuple = {}
 Tuple.ClassName = "Tuple"
 Tuple.__index = Tuple
 
+--[=[
+	Constructs a new tuple
+
+	@param ... any
+	@return Tuple<T>
+]=]
 function Tuple.new(...)
 	return setmetatable(table.pack(...), Tuple)
 end
 
+--[=[
+	Returns true of the value is a tuple
+
+	@param value any
+	@return boolean
+]=]
 function Tuple.isTuple(value)
 	return getmetatable(value) == Tuple
 end
@@ -34,14 +46,30 @@ function Tuple:ToArray()
 	return { self:Unpack() }
 end
 
+--[=[
+	Converts the tuple to a string for easy debugging
+]=]
 function Tuple:__tostring()
-	return table.concat(self, ", ")
+	local converted = {}
+	for i=1, self.n do
+		converted[i] = tostring(self[i])
+	end
+	return table.concat(converted, ", ")
 end
 
+--[=[
+	Returns the length of the tuple
+
+	@return number
+]=]
 function Tuple:__len()
 	return self.n
 end
 
+--[=[
+	Compares the tuple to another tuple
+	@param other Tuple
+]=]
 function Tuple:__eq(other)
 	if not Tuple.isTuple(other) then
 		return false
@@ -60,6 +88,10 @@ function Tuple:__eq(other)
 	return true
 end
 
+--[=[
+	Combines the tuple
+	@param other Tuple
+]=]
 function Tuple:__add(other)
 	assert(Tuple.isTuple(other), "Can only add tuples")
 
@@ -72,6 +104,11 @@ function Tuple:__add(other)
 	return result
 end
 
+--[=[
+	Unpacks the tuple
+
+	@return ...
+]=]
 function Tuple:__call()
 	return table.unpack(self, 1, self.n)
 end

package/src/Shared/TupleLookup.lua

@@ -0,0 +1,43 @@
+--[=[
+	Helps look up tuples that can be used as keys
+
+	@class TupleLookup
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Tuple = require("Tuple")
+
+local TupleLookup = {}
+TupleLookup.ClassName = "TupleLookup"
+TupleLookup.__index = TupleLookup
+
+function TupleLookup.new()
+	local self = setmetatable({}, TupleLookup)
+
+	self._tuples = setmetatable({}, { __mode = "k"})
+
+	return self
+end
+
+--[=[
+	Gets a shared tuple with a weak table
+
+	@param ... any
+	@return Tuple<T>
+]=]
+function TupleLookup:ToTuple(...)
+	local created = Tuple.new(...)
+
+	for item, _ in pairs(self._tuples) do
+		if item == created then
+			return item
+		end
+	end
+
+	self._tuples[created] = true
+
+	return created
+end
+
+return TupleLookup