@quenty/tuple 1.0.1-canary.478.34e8ede.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.478.34e8ede.0 (2024-08-27)
+
+
+### Features
+
+* Add tuple package and fix tie signal ([134f90c](https://github.com/Quenty/NevermoreEngine/commit/134f90c03b265b9d2232198475ca27f4d5e87071))

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 @@
+## Tuple
+
+<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>
+
+Tuple utility package
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/TupleUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/tuple --save
+```

package/default.project.json

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

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@quenty/tuple",
+  "version": "1.0.1-canary.478.34e8ede.0",
+  "description": "Tuple utility package",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "tuple"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/tuple/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/loader": "10.3.1-canary.478.34e8ede.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "34e8edee97fa93a0a5bd84442b85826082444f2a"
+}

package/src/Shared/Tuple.lua

@@ -0,0 +1,79 @@
+--[=[
+	Tuple class for Lua
+
+	@class Tuple
+]=]
+
+local Tuple = {}
+Tuple.ClassName = "Tuple"
+Tuple.__index = Tuple
+
+function Tuple.new(...)
+	return setmetatable(table.pack(...), Tuple)
+end
+
+function Tuple.isTuple(value)
+	return getmetatable(value) == Tuple
+end
+
+--[=[
+	Unpacks the tuple
+
+	@return T
+]=]
+function Tuple:Unpack()
+	return table.unpack(self, 1, self.n)
+end
+
+--[=[
+	Converts to array
+
+	@return { T }
+]=]
+function Tuple:ToArray()
+	return { self:Unpack() }
+end
+
+function Tuple:__tostring()
+	return table.concat(self, ", ")
+end
+
+function Tuple:__len()
+	return self.n
+end
+
+function Tuple:__eq(other)
+	if not Tuple.isTuple(other) then
+		return false
+	end
+
+	if self.n ~= other.n then
+		return false
+	end
+
+	for i=1, self.n do
+		if self[i] ~= other[i] then
+			return false
+		end
+	end
+
+	return true
+end
+
+function Tuple:__add(other)
+	assert(Tuple.isTuple(other), "Can only add tuples")
+
+	local result = Tuple.new(self:Unpack())
+	local count = self.n
+	for i=1, other.n do
+		result[count + i] = other[i]
+	end
+	result.n = count + other.n
+	return result
+end
+
+function Tuple:__call()
+	return table.unpack(self, 1, self.n)
+end
+
+return Tuple

package/src/Shared/Tuple.story.lua

@@ -0,0 +1,32 @@
+--[[
+	@class Tuple.story
+]]
+
+local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
+
+local Tuple = require("Tuple")
+
+return function(_target)
+	local a = Tuple.new(1, 2, 3)
+	local b = Tuple.new(1, 2, 3)
+	local c = Tuple.new(3, 4, "d")
+
+	assert(tostring(a) == "1, 2, 3", "Bad a")
+	assert(tostring(c) == "3, 4, d", "Bad c")
+	assert(#a == 3, "Bad a")
+	assert(a == b, "a == b")
+	assert(b == b, "b == b")
+	assert(a ~= c, "b == b")
+
+	-- Addition
+	assert(tostring(a + c) == "1, 2, 3, 3, 4, d", "Bad addition")
+	assert(#a:ToArray() == 3, "Bad toArray")
+
+	local lookupTable = {}
+	lookupTable[a] = true
+
+	assert(lookupTable[b] == false, "Lookup should not be equivalent")
+
+	return function()
+	end
+end

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,12 @@
+{
+  "name": "TupleTest",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "tuple": {
+        "$path": ".."
+      }
+    }
+  }
+}