roblox-opencode 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (248) hide show
  1. package/README.md +122 -0
  2. package/commands/setup-game.md +108 -0
  3. package/commands/sync-check.md +53 -0
  4. package/core/roblox-core.md +93 -0
  5. package/dist/server.js +167 -0
  6. package/package.json +35 -0
  7. package/skills/roblox-analytics/SKILL.md +277 -0
  8. package/skills/roblox-analytics/references/event-batcher.luau +75 -0
  9. package/skills/roblox-animation-vfx/SKILL.md +1325 -0
  10. package/skills/roblox-architecture/SKILL.md +863 -0
  11. package/skills/roblox-architecture/references/combat-systems.md +1381 -0
  12. package/skills/roblox-code-review/SKILL.md +687 -0
  13. package/skills/roblox-data/SKILL.md +889 -0
  14. package/skills/roblox-data/references/inventory-systems.md +1729 -0
  15. package/skills/roblox-debug/SKILL.md +99 -0
  16. package/skills/roblox-gui/SKILL.md +1103 -0
  17. package/skills/roblox-gui-fusion/SKILL.md +150 -0
  18. package/skills/roblox-gui-fusion/references/inventory.luau +427 -0
  19. package/skills/roblox-gui-fusion/references/settings-menu.luau +579 -0
  20. package/skills/roblox-gui-fusion/references/shop.luau +411 -0
  21. package/skills/roblox-luau-mastery/SKILL.md +1519 -0
  22. package/skills/roblox-monetization/SKILL.md +1084 -0
  23. package/skills/roblox-monetization/references/process-receipt.luau +131 -0
  24. package/skills/roblox-networking/SKILL.md +669 -0
  25. package/skills/roblox-networking/references/remote-validator.luau +193 -0
  26. package/skills/roblox-publish-checklist/SKILL.md +128 -0
  27. package/skills/roblox-runtime/SKILL.md +753 -0
  28. package/skills/roblox-sharp-edges/SKILL.md +295 -0
  29. package/skills/roblox-sync/SKILL.md +126 -0
  30. package/skills/roblox-testing/SKILL.md +943 -0
  31. package/skills/roblox-tooling/SKILL.md +150 -0
  32. package/vendor/LICENSES/ProfileStore-LICENSE +201 -0
  33. package/vendor/LICENSES/RbxUtil-LICENSE +7 -0
  34. package/vendor/LICENSES/promise-LICENSE +21 -0
  35. package/vendor/LICENSES/t-LICENSE +21 -0
  36. package/vendor/LICENSES/testez-LICENSE +201 -0
  37. package/vendor/README.md +84 -0
  38. package/vendor/fusion/Animation/ExternalTime.luau +84 -0
  39. package/vendor/fusion/Animation/Spring.luau +322 -0
  40. package/vendor/fusion/Animation/Stopwatch.luau +128 -0
  41. package/vendor/fusion/Animation/Tween.luau +187 -0
  42. package/vendor/fusion/Animation/getTweenDuration.luau +27 -0
  43. package/vendor/fusion/Animation/getTweenRatio.luau +47 -0
  44. package/vendor/fusion/Animation/lerpType.luau +164 -0
  45. package/vendor/fusion/Animation/packType.luau +100 -0
  46. package/vendor/fusion/Animation/springCoefficients.luau +80 -0
  47. package/vendor/fusion/Animation/unpackType.luau +103 -0
  48. package/vendor/fusion/Colour/Oklab.luau +70 -0
  49. package/vendor/fusion/Colour/sRGB.luau +55 -0
  50. package/vendor/fusion/External.luau +168 -0
  51. package/vendor/fusion/ExternalDebug.luau +70 -0
  52. package/vendor/fusion/Graph/Observer.luau +114 -0
  53. package/vendor/fusion/Graph/castToGraph.luau +29 -0
  54. package/vendor/fusion/Graph/change.luau +81 -0
  55. package/vendor/fusion/Graph/depend.luau +33 -0
  56. package/vendor/fusion/Graph/evaluate.luau +56 -0
  57. package/vendor/fusion/Instances/Attribute.luau +58 -0
  58. package/vendor/fusion/Instances/AttributeChange.luau +47 -0
  59. package/vendor/fusion/Instances/AttributeOut.luau +63 -0
  60. package/vendor/fusion/Instances/Child.luau +21 -0
  61. package/vendor/fusion/Instances/Children.luau +148 -0
  62. package/vendor/fusion/Instances/Hydrate.luau +33 -0
  63. package/vendor/fusion/Instances/New.luau +53 -0
  64. package/vendor/fusion/Instances/OnChange.luau +50 -0
  65. package/vendor/fusion/Instances/OnEvent.luau +54 -0
  66. package/vendor/fusion/Instances/Out.luau +69 -0
  67. package/vendor/fusion/Instances/applyInstanceProps.luau +149 -0
  68. package/vendor/fusion/Instances/defaultProps.luau +194 -0
  69. package/vendor/fusion/LICENSE +21 -0
  70. package/vendor/fusion/Logging/formatError.luau +49 -0
  71. package/vendor/fusion/Logging/messages.luau +52 -0
  72. package/vendor/fusion/Logging/parseError.luau +25 -0
  73. package/vendor/fusion/Memory/checkLifetime.luau +134 -0
  74. package/vendor/fusion/Memory/deriveScope.luau +24 -0
  75. package/vendor/fusion/Memory/deriveScopeImpl.luau +45 -0
  76. package/vendor/fusion/Memory/doCleanup.luau +79 -0
  77. package/vendor/fusion/Memory/innerScope.luau +34 -0
  78. package/vendor/fusion/Memory/legacyCleanup.luau +18 -0
  79. package/vendor/fusion/Memory/needsDestruction.luau +17 -0
  80. package/vendor/fusion/Memory/poisonScope.luau +34 -0
  81. package/vendor/fusion/Memory/scopePool.luau +55 -0
  82. package/vendor/fusion/Memory/scoped.luau +27 -0
  83. package/vendor/fusion/Memory/whichLivesLonger.luau +75 -0
  84. package/vendor/fusion/RobloxExternal.luau +98 -0
  85. package/vendor/fusion/State/Computed.luau +139 -0
  86. package/vendor/fusion/State/For/Disassembly.luau +211 -0
  87. package/vendor/fusion/State/For/ForTypes.luau +30 -0
  88. package/vendor/fusion/State/For/init.luau +110 -0
  89. package/vendor/fusion/State/ForKeys.luau +94 -0
  90. package/vendor/fusion/State/ForPairs.luau +97 -0
  91. package/vendor/fusion/State/ForValues.luau +94 -0
  92. package/vendor/fusion/State/Value.luau +88 -0
  93. package/vendor/fusion/State/castToState.luau +26 -0
  94. package/vendor/fusion/State/peek.luau +31 -0
  95. package/vendor/fusion/State/updateAll.luau +1 -0
  96. package/vendor/fusion/Types.luau +314 -0
  97. package/vendor/fusion/Utility/Contextual.luau +91 -0
  98. package/vendor/fusion/Utility/Safe.luau +23 -0
  99. package/vendor/fusion/Utility/isSimilar.luau +29 -0
  100. package/vendor/fusion/Utility/merge.luau +35 -0
  101. package/vendor/fusion/Utility/nameOf.luau +35 -0
  102. package/vendor/fusion/Utility/never.luau +14 -0
  103. package/vendor/fusion/Utility/nicknames.luau +11 -0
  104. package/vendor/fusion/Utility/xtypeof.luau +27 -0
  105. package/vendor/fusion/init.luau +82 -0
  106. package/vendor/profilestore/init.luau +2243 -0
  107. package/vendor/promise/init.luau +1982 -0
  108. package/vendor/rbxutil/buffer-util/Buffer.test.luau +25 -0
  109. package/vendor/rbxutil/buffer-util/BufferReader.luau +228 -0
  110. package/vendor/rbxutil/buffer-util/BufferWriter.luau +269 -0
  111. package/vendor/rbxutil/buffer-util/DataTypeBuffer.luau +223 -0
  112. package/vendor/rbxutil/buffer-util/Types.luau +60 -0
  113. package/vendor/rbxutil/buffer-util/index.d.ts +153 -0
  114. package/vendor/rbxutil/buffer-util/init.luau +41 -0
  115. package/vendor/rbxutil/buffer-util/package.json +16 -0
  116. package/vendor/rbxutil/buffer-util/wally.toml +9 -0
  117. package/vendor/rbxutil/comm/Client/ClientComm.luau +232 -0
  118. package/vendor/rbxutil/comm/Client/ClientRemoteProperty.luau +156 -0
  119. package/vendor/rbxutil/comm/Client/ClientRemoteSignal.luau +109 -0
  120. package/vendor/rbxutil/comm/Client/init.luau +135 -0
  121. package/vendor/rbxutil/comm/Server/RemoteProperty.luau +295 -0
  122. package/vendor/rbxutil/comm/Server/RemoteSignal.luau +211 -0
  123. package/vendor/rbxutil/comm/Server/ServerComm.luau +211 -0
  124. package/vendor/rbxutil/comm/Server/init.luau +140 -0
  125. package/vendor/rbxutil/comm/Types.luau +18 -0
  126. package/vendor/rbxutil/comm/Util.luau +27 -0
  127. package/vendor/rbxutil/comm/init.luau +35 -0
  128. package/vendor/rbxutil/comm/wally.toml +13 -0
  129. package/vendor/rbxutil/component/init.luau +759 -0
  130. package/vendor/rbxutil/component/init.test.luau +311 -0
  131. package/vendor/rbxutil/component/wally.toml +14 -0
  132. package/vendor/rbxutil/concur/init.luau +542 -0
  133. package/vendor/rbxutil/concur/init.test.luau +364 -0
  134. package/vendor/rbxutil/concur/wally.toml +8 -0
  135. package/vendor/rbxutil/enum-list/init.luau +101 -0
  136. package/vendor/rbxutil/enum-list/init.test.luau +91 -0
  137. package/vendor/rbxutil/enum-list/wally.toml +8 -0
  138. package/vendor/rbxutil/find/index.d.ts +20 -0
  139. package/vendor/rbxutil/find/init.luau +44 -0
  140. package/vendor/rbxutil/find/package.json +17 -0
  141. package/vendor/rbxutil/find/wally.toml +8 -0
  142. package/vendor/rbxutil/input/Gamepad.luau +559 -0
  143. package/vendor/rbxutil/input/Keyboard.luau +124 -0
  144. package/vendor/rbxutil/input/Mouse.luau +278 -0
  145. package/vendor/rbxutil/input/PreferredInput.luau +91 -0
  146. package/vendor/rbxutil/input/Touch.luau +120 -0
  147. package/vendor/rbxutil/input/init.luau +33 -0
  148. package/vendor/rbxutil/input/wally.toml +12 -0
  149. package/vendor/rbxutil/loader/index.d.ts +15 -0
  150. package/vendor/rbxutil/loader/init.luau +137 -0
  151. package/vendor/rbxutil/loader/wally.toml +8 -0
  152. package/vendor/rbxutil/log/index.d.ts +38 -0
  153. package/vendor/rbxutil/log/init.luau +746 -0
  154. package/vendor/rbxutil/log/wally.toml +8 -0
  155. package/vendor/rbxutil/net/init.luau +190 -0
  156. package/vendor/rbxutil/net/wally.toml +8 -0
  157. package/vendor/rbxutil/option/index.d.ts +44 -0
  158. package/vendor/rbxutil/option/init.luau +489 -0
  159. package/vendor/rbxutil/option/init.test.luau +342 -0
  160. package/vendor/rbxutil/option/wally.toml +8 -0
  161. package/vendor/rbxutil/pid/index.d.ts +53 -0
  162. package/vendor/rbxutil/pid/init.luau +195 -0
  163. package/vendor/rbxutil/pid/package.json +16 -0
  164. package/vendor/rbxutil/pid/wally.toml +9 -0
  165. package/vendor/rbxutil/quaternion/index.d.ts +117 -0
  166. package/vendor/rbxutil/quaternion/init.luau +570 -0
  167. package/vendor/rbxutil/quaternion/package.json +16 -0
  168. package/vendor/rbxutil/quaternion/wally.toml +9 -0
  169. package/vendor/rbxutil/query/index.d.ts +43 -0
  170. package/vendor/rbxutil/query/init.luau +117 -0
  171. package/vendor/rbxutil/query/package.json +18 -0
  172. package/vendor/rbxutil/query/wally.toml +9 -0
  173. package/vendor/rbxutil/sequent/index.d.ts +28 -0
  174. package/vendor/rbxutil/sequent/init.luau +340 -0
  175. package/vendor/rbxutil/sequent/package.json +16 -0
  176. package/vendor/rbxutil/sequent/wally.toml +9 -0
  177. package/vendor/rbxutil/ser/init.luau +175 -0
  178. package/vendor/rbxutil/ser/init.test.luau +50 -0
  179. package/vendor/rbxutil/ser/wally.toml +11 -0
  180. package/vendor/rbxutil/shake/index.d.ts +36 -0
  181. package/vendor/rbxutil/shake/init.luau +532 -0
  182. package/vendor/rbxutil/shake/init.test.luau +267 -0
  183. package/vendor/rbxutil/shake/package.json +16 -0
  184. package/vendor/rbxutil/shake/wally.toml +9 -0
  185. package/vendor/rbxutil/signal/index.d.ts +100 -0
  186. package/vendor/rbxutil/signal/init.luau +432 -0
  187. package/vendor/rbxutil/signal/init.test.luau +190 -0
  188. package/vendor/rbxutil/signal/package.json +17 -0
  189. package/vendor/rbxutil/signal/wally.toml +9 -0
  190. package/vendor/rbxutil/silo/TableWatcher.luau +65 -0
  191. package/vendor/rbxutil/silo/Util.luau +55 -0
  192. package/vendor/rbxutil/silo/init.luau +338 -0
  193. package/vendor/rbxutil/silo/init.test.luau +215 -0
  194. package/vendor/rbxutil/silo/wally.toml +8 -0
  195. package/vendor/rbxutil/spring/index.d.ts +40 -0
  196. package/vendor/rbxutil/spring/init.luau +97 -0
  197. package/vendor/rbxutil/spring/package.json +17 -0
  198. package/vendor/rbxutil/spring/wally.toml +8 -0
  199. package/vendor/rbxutil/stream/index.d.ts +88 -0
  200. package/vendor/rbxutil/stream/init.luau +597 -0
  201. package/vendor/rbxutil/stream/package.json +18 -0
  202. package/vendor/rbxutil/stream/wally.toml +9 -0
  203. package/vendor/rbxutil/streamable/Streamable.luau +202 -0
  204. package/vendor/rbxutil/streamable/StreamableUtil.luau +80 -0
  205. package/vendor/rbxutil/streamable/init.luau +8 -0
  206. package/vendor/rbxutil/streamable/wally.toml +12 -0
  207. package/vendor/rbxutil/symbol/init.luau +56 -0
  208. package/vendor/rbxutil/symbol/init.test.luau +37 -0
  209. package/vendor/rbxutil/symbol/wally.toml +8 -0
  210. package/vendor/rbxutil/table-util/init.luau +938 -0
  211. package/vendor/rbxutil/table-util/init.test.luau +439 -0
  212. package/vendor/rbxutil/table-util/wally.toml +8 -0
  213. package/vendor/rbxutil/task-queue/index.d.ts +27 -0
  214. package/vendor/rbxutil/task-queue/init.luau +97 -0
  215. package/vendor/rbxutil/task-queue/wally.toml +8 -0
  216. package/vendor/rbxutil/timer/index.d.ts +81 -0
  217. package/vendor/rbxutil/timer/init.luau +249 -0
  218. package/vendor/rbxutil/timer/init.test.luau +73 -0
  219. package/vendor/rbxutil/timer/wally.toml +11 -0
  220. package/vendor/rbxutil/tree/index.d.ts +15 -0
  221. package/vendor/rbxutil/tree/init.luau +137 -0
  222. package/vendor/rbxutil/tree/wally.toml +8 -0
  223. package/vendor/rbxutil/trove/index.d.ts +46 -0
  224. package/vendor/rbxutil/trove/init.luau +787 -0
  225. package/vendor/rbxutil/trove/init.test.luau +203 -0
  226. package/vendor/rbxutil/trove/wally.toml +8 -0
  227. package/vendor/rbxutil/typed-remote/init.luau +196 -0
  228. package/vendor/rbxutil/typed-remote/wally.toml +8 -0
  229. package/vendor/rbxutil/wait-for/index.d.ts +17 -0
  230. package/vendor/rbxutil/wait-for/init.luau +257 -0
  231. package/vendor/rbxutil/wait-for/init.test.luau +182 -0
  232. package/vendor/rbxutil/wait-for/wally.toml +11 -0
  233. package/vendor/t/t.lua +1350 -0
  234. package/vendor/testez/Context.lua +26 -0
  235. package/vendor/testez/Expectation.lua +311 -0
  236. package/vendor/testez/ExpectationContext.lua +38 -0
  237. package/vendor/testez/LifecycleHooks.lua +89 -0
  238. package/vendor/testez/Reporters/TeamCityReporter.lua +102 -0
  239. package/vendor/testez/Reporters/TextReporter.lua +106 -0
  240. package/vendor/testez/Reporters/TextReporterQuiet.lua +97 -0
  241. package/vendor/testez/TestBootstrap.lua +147 -0
  242. package/vendor/testez/TestEnum.lua +28 -0
  243. package/vendor/testez/TestPlan.lua +304 -0
  244. package/vendor/testez/TestPlanner.lua +40 -0
  245. package/vendor/testez/TestResults.lua +112 -0
  246. package/vendor/testez/TestRunner.lua +188 -0
  247. package/vendor/testez/TestSession.lua +243 -0
  248. package/vendor/testez/init.lua +40 -0
@@ -0,0 +1,439 @@
1
+ local ServerScriptService = game:GetService("ServerScriptService")
2
+
3
+ local Test = require(ServerScriptService.TestRunner.Test)
4
+
5
+ return function(ctx: Test.TestContext)
6
+ local TableUtil = require(script.Parent)
7
+
8
+ ctx:Describe("Copy (Deep)", function()
9
+ ctx:Test("should create a deep table copy", function()
10
+ local tbl = { a = { b = { c = { d = 32 } } } }
11
+ local tblCopy = TableUtil.Copy(tbl, true)
12
+ ctx:Expect(tbl):Not():ToBe(tblCopy)
13
+ ctx:Expect(tbl.a):Not():ToBe(tblCopy.a)
14
+ ctx:Expect(tblCopy.a.b.c.d):ToBe(tbl.a.b.c.d)
15
+ end)
16
+ end)
17
+
18
+ ctx:Describe("Copy (Shallow)", function()
19
+ ctx:Test("should create a shallow dictionary copy", function()
20
+ local tbl = { a = { b = { c = { d = 32 } } } }
21
+ local tblCopy = TableUtil.Copy(tbl)
22
+ ctx:Expect(tblCopy):Not():ToBe(tbl)
23
+ ctx:Expect(tblCopy.a):ToBe(tbl.a)
24
+ ctx:Expect(tblCopy.a.b.c.d):ToBe(tbl.a.b.c.d)
25
+ end)
26
+
27
+ ctx:Test("should create a shallow array copy", function()
28
+ local tbl = { 10, 20, 30, 40 }
29
+ local tblCopy = TableUtil.Copy(tbl)
30
+ ctx:Expect(tblCopy):Not():ToBe(tbl)
31
+ for i, v in ipairs(tbl) do
32
+ ctx:Expect(tblCopy[i]):ToBe(v)
33
+ end
34
+ end)
35
+ end)
36
+
37
+ ctx:Describe("Sync", function()
38
+ ctx:Test("should sync tables", function()
39
+ local template = { a = 32, b = 64, c = 128, e = { h = 1 } }
40
+ local tblSrc = { a = 32, b = 10, d = 1, e = { h = 2, n = 2 }, f = { x = 10 } }
41
+ local tbl = TableUtil.Sync(tblSrc, template)
42
+ ctx:Expect(tbl.a):ToBe(template.a)
43
+ ctx:Expect(tbl.b):ToBe(10)
44
+ ctx:Expect(tbl.c):ToBe(template.c)
45
+ ctx:Expect(tbl.d):ToBeNil()
46
+ ctx:Expect(tbl.e.h):ToBe(2)
47
+ ctx:Expect(tbl.e.n):ToBeNil()
48
+ ctx:Expect(tbl.f):ToBeNil()
49
+ end)
50
+ end)
51
+
52
+ ctx:Describe("Reconcile", function()
53
+ ctx:Test("should reconcile table", function()
54
+ local template = { kills = 0, deaths = 0, xp = 10, stuff = {}, stuff2 = "abc", stuff3 = { "data" } }
55
+ local data =
56
+ { kills = 10, deaths = 4, stuff = { "abc", "xyz" }, extra = 5, stuff2 = { abc = 10 }, stuff3 = true }
57
+ local reconciled = TableUtil.Reconcile(data, template)
58
+ ctx:Expect(reconciled):Not():ToBe(data)
59
+ ctx:Expect(reconciled):Not():ToBe(template)
60
+ ctx:Expect(reconciled.kills):ToBe(10)
61
+ ctx:Expect(reconciled.deaths):ToBe(4)
62
+ ctx:Expect(reconciled.xp):ToBe(10)
63
+ ctx:Expect(reconciled.stuff[1]):ToBe("abc")
64
+ ctx:Expect(reconciled.stuff[2]):ToBe("xyz")
65
+ ctx:Expect(reconciled.extra):ToBe(5)
66
+ ctx:Expect(type(reconciled.stuff2)):ToBe("table")
67
+ ctx:Expect(reconciled.stuff2):Not():ToBe(data.stuff2)
68
+ ctx:Expect(reconciled.stuff2.abc):ToBe(10)
69
+ ctx:Expect(type(reconciled.stuff3)):ToBe("boolean")
70
+ ctx:Expect(reconciled.stuff3):ToBe(true)
71
+ end)
72
+ end)
73
+
74
+ ctx:Describe("SwapRemove", function()
75
+ ctx:Test("should swap remove index", function()
76
+ local tbl = { 1, 2, 3, 4, 5 }
77
+ TableUtil.SwapRemove(tbl, 3)
78
+ ctx:Expect(#tbl):ToBe(4)
79
+ ctx:Expect(tbl[3]):ToBe(5)
80
+ end)
81
+ end)
82
+
83
+ ctx:Describe("SwapRemoveFirstValue", function()
84
+ ctx:Test("should swap remove first value given", function()
85
+ local tbl = { "hello", "world", "goodbye", "planet" }
86
+ TableUtil.SwapRemoveFirstValue(tbl, "world")
87
+ ctx:Expect(#tbl):ToBe(3)
88
+ ctx:Expect(tbl[2]):ToBe("planet")
89
+ end)
90
+ end)
91
+
92
+ ctx:Describe("Map", function()
93
+ ctx:Test("should map table", function()
94
+ local tbl = {
95
+ { FirstName = "John", LastName = "Doe" },
96
+ { FirstName = "Jane", LastName = "Smith" },
97
+ }
98
+ local tblMapped = TableUtil.Map(tbl, function(person)
99
+ return person.FirstName .. " " .. person.LastName
100
+ end)
101
+ ctx:Expect(tblMapped[1]):ToBe("John Doe")
102
+ ctx:Expect(tblMapped[2]):ToBe("Jane Smith")
103
+ end)
104
+ end)
105
+
106
+ ctx:Describe("Filter", function()
107
+ ctx:Test("should filter table", function()
108
+ local tbl = { 10, 20, 30, 40, 50, 60, 70, 80, 90 }
109
+ local tblFiltered = TableUtil.Filter(tbl, function(n)
110
+ return (n >= 30 and n <= 60)
111
+ end)
112
+ ctx:Expect(#tblFiltered):ToBe(4)
113
+ ctx:Expect(tblFiltered[1]):ToBe(30)
114
+ ctx:Expect(tblFiltered[#tblFiltered]):ToBe(60)
115
+ end)
116
+ end)
117
+
118
+ ctx:Describe("Reduce", function()
119
+ ctx:Test("should reduce table with numbers", function()
120
+ local tbl = { 1, 2, 3, 4, 5 }
121
+ local reduced = TableUtil.Reduce(tbl, function(accum, value)
122
+ return accum + value
123
+ end)
124
+ ctx:Expect(reduced):ToBe(15)
125
+ end)
126
+
127
+ ctx:Test("should reduce table", function()
128
+ local tbl = { { Score = 10 }, { Score = 20 }, { Score = 30 } }
129
+ local reduced = TableUtil.Reduce(tbl, function(accum, value)
130
+ return accum + value.Score
131
+ end, 0)
132
+ ctx:Expect(reduced):ToBe(60)
133
+ end)
134
+
135
+ ctx:Test("should reduce table with initial value", function()
136
+ local tbl = { { Score = 10 }, { Score = 20 }, { Score = 30 } }
137
+ local reduced = TableUtil.Reduce(tbl, function(accum, value)
138
+ return accum + value.Score
139
+ end, 40)
140
+ ctx:Expect(reduced):ToBe(100)
141
+ end)
142
+
143
+ ctx:Test("should reduce functions", function()
144
+ local function Square(x)
145
+ return x * x
146
+ end
147
+ local function Double(x)
148
+ return x * 2
149
+ end
150
+ local Func = TableUtil.Reduce({ Square, Double }, function(a, b)
151
+ return function(x)
152
+ return a(b(x))
153
+ end
154
+ end)
155
+ local result = Func(10)
156
+ ctx:Expect(result):ToBe(400)
157
+ end)
158
+ end)
159
+
160
+ ctx:Describe("Assign", function()
161
+ ctx:Test("should assign tables", function()
162
+ local target = { a = 32, x = 100 }
163
+ local t1 = { b = 64, c = 128 }
164
+ local t2 = { a = 10, c = 100, d = 200 }
165
+ local tbl = TableUtil.Assign(target, t1, t2)
166
+ ctx:Expect(tbl.a):ToBe(10)
167
+ ctx:Expect(tbl.b):ToBe(64)
168
+ ctx:Expect(tbl.c):ToBe(100)
169
+ ctx:Expect(tbl.d):ToBe(200)
170
+ ctx:Expect(tbl.x):ToBe(100)
171
+ end)
172
+ end)
173
+
174
+ ctx:Describe("Extend", function()
175
+ ctx:Test("should extend tables", function()
176
+ local tbl = { "a", "b", "c" }
177
+ local extension = { "d", "e", "f" }
178
+ local extended = TableUtil.Extend(tbl, extension)
179
+ ctx:Expect(table.concat(extended)):ToBe("abcdef")
180
+ end)
181
+ end)
182
+
183
+ ctx:Describe("Reverse", function()
184
+ ctx:Test("should create a table in reverse", function()
185
+ local tbl = { 1, 2, 3 }
186
+ local tblRev = TableUtil.Reverse(tbl)
187
+ ctx:Expect(table.concat(tblRev)):ToBe("321")
188
+ end)
189
+ end)
190
+
191
+ ctx:Describe("Shuffle", function()
192
+ ctx:Test("should shuffle a table", function()
193
+ local tbl = { 1, 2, 3, 4, 5 }
194
+ ctx:Expect(function()
195
+ TableUtil.Shuffle(tbl)
196
+ end)
197
+ :Not()
198
+ :ToThrow()
199
+ end)
200
+ end)
201
+
202
+ ctx:Describe("Sample", function()
203
+ ctx:Test("should sample a table", function()
204
+ local tbl = { 1, 2, 3, 4, 5 }
205
+ local sample = TableUtil.Sample(tbl, 3)
206
+ ctx:Expect(#sample):ToBe(3)
207
+ end)
208
+ end)
209
+
210
+ ctx:Describe("Flat", function()
211
+ ctx:Test("should flatten table", function()
212
+ local tbl = { 1, 2, 3, { 4, 5, { 6, 7 } } }
213
+ local tblFlat = TableUtil.Flat(tbl, 3)
214
+ ctx:Expect(table.concat(tblFlat)):ToBe("1234567")
215
+ end)
216
+ end)
217
+
218
+ ctx:Describe("FlatMap", function()
219
+ ctx:Test("should map and flatten table", function()
220
+ local tbl = { 1, 2, 3, 4, 5, 6, 7 }
221
+ local tblFlat = TableUtil.FlatMap(tbl, function(n)
222
+ return { n, n * 2 }
223
+ end)
224
+ ctx:Expect(table.concat(tblFlat)):ToBe("12243648510612714")
225
+ end)
226
+ end)
227
+
228
+ ctx:Describe("Keys", function()
229
+ ctx:Test("should give all keys of table", function()
230
+ local tbl = { a = 1, b = 2, c = 3 }
231
+ local keys = TableUtil.Keys(tbl)
232
+ ctx:Expect(#keys):ToBe(3)
233
+ ctx:Expect(table.find(keys, "a")):ToBeOk()
234
+ ctx:Expect(table.find(keys, "b")):ToBeOk()
235
+ ctx:Expect(table.find(keys, "c")):ToBeOk()
236
+ end)
237
+ end)
238
+
239
+ ctx:Describe("Values", function()
240
+ ctx:Test("should give all values of table", function()
241
+ local tbl = { a = 1, b = 2, c = 3 }
242
+ local values = TableUtil.Values(tbl)
243
+ ctx:Expect(#values):ToBe(3)
244
+ ctx:Expect(table.find(values, 1)):ToBeOk()
245
+ ctx:Expect(table.find(values, 2)):ToBeOk()
246
+ ctx:Expect(table.find(values, 3)):ToBeOk()
247
+ end)
248
+ end)
249
+
250
+ ctx:Describe("Find", function()
251
+ ctx:Test("should find item in array", function()
252
+ local tbl = { 10, 20, 30 }
253
+ local item, index = TableUtil.Find(tbl, function(value)
254
+ return (value == 20)
255
+ end)
256
+ ctx:Expect(item):ToBeOk()
257
+ ctx:Expect(index):ToBe(2)
258
+ ctx:Expect(item):ToBe(20)
259
+ end)
260
+
261
+ ctx:Test("should find item in dictionary", function()
262
+ local tbl = { { Score = 10 }, { Score = 20 }, { Score = 30 } }
263
+ local item, index = TableUtil.Find(tbl, function(value)
264
+ return (value.Score == 20)
265
+ end)
266
+ ctx:Expect(item):ToBeOk()
267
+ ctx:Expect(index):ToBe(2)
268
+ ctx:Expect(item.Score):ToBe(20)
269
+ end)
270
+ end)
271
+
272
+ ctx:Describe("Every", function()
273
+ ctx:Test("should see every value is above 20", function()
274
+ local tbl = { 21, 40, 200 }
275
+ local every = TableUtil.Every(tbl, function(n)
276
+ return (n > 20)
277
+ end)
278
+ ctx:Expect(every):ToBe(true)
279
+ end)
280
+
281
+ ctx:Test("should see every value is not above 20", function()
282
+ local tbl = { 20, 40, 200 }
283
+ local every = TableUtil.Every(tbl, function(n)
284
+ return (n > 20)
285
+ end)
286
+ ctx:Expect(every):Not():ToBe(true)
287
+ end)
288
+ end)
289
+
290
+ ctx:Describe("Some", function()
291
+ ctx:Test("should see some value is above 20", function()
292
+ local tbl = { 5, 40, 1 }
293
+ local every = TableUtil.Some(tbl, function(n)
294
+ return (n > 20)
295
+ end)
296
+ ctx:Expect(every):ToBe(true)
297
+ end)
298
+
299
+ ctx:Test("should see some value is not above 20", function()
300
+ local tbl = { 5, 15, 1 }
301
+ local every = TableUtil.Some(tbl, function(n)
302
+ return (n > 20)
303
+ end)
304
+ ctx:Expect(every):Not():ToBe(true)
305
+ end)
306
+ end)
307
+
308
+ ctx:Describe("Truncate", function()
309
+ ctx:Test("should truncate an array", function()
310
+ local t1 = { 1, 2, 3, 4, 5 }
311
+ local t2 = TableUtil.Truncate(t1, 3)
312
+ ctx:Expect(#t2):ToBe(3)
313
+ ctx:Expect(t2[1]):ToBe(t1[1])
314
+ ctx:Expect(t2[2]):ToBe(t1[2])
315
+ ctx:Expect(t2[3]):ToBe(t1[3])
316
+ end)
317
+
318
+ ctx:Test("should truncate an array with out of bounds sizes", function()
319
+ local t1 = { 1, 2, 3, 4, 5 }
320
+ ctx:Expect(function()
321
+ TableUtil.Truncate(t1, -1)
322
+ end)
323
+ :Not()
324
+ :ToThrow()
325
+ ctx:Expect(function()
326
+ TableUtil.Truncate(t1, #t1 + 1)
327
+ end)
328
+ :Not()
329
+ :ToThrow()
330
+ local t2 = TableUtil.Truncate(t1, #t1 + 10)
331
+ ctx:Expect(#t2):ToBe(#t1)
332
+ ctx:Expect(t2):Not():ToBe(t1)
333
+ end)
334
+ end)
335
+
336
+ ctx:Describe("Lock", function()
337
+ ctx:Test("should lock a table", function()
338
+ local t = { abc = { xyz = { num = 32 } } }
339
+ ctx:Expect(function()
340
+ t.abc.xyz.num = 64
341
+ end)
342
+ :Not()
343
+ :ToThrow()
344
+ local t2 = TableUtil.Lock(t)
345
+ ctx:Expect(t.abc.xyz.num):ToBe(64)
346
+ ctx:Expect(t):ToBe(t2)
347
+ ctx:Expect(function()
348
+ t.abc.xyz.num = 10
349
+ end):ToThrow()
350
+ end)
351
+ end)
352
+
353
+ ctx:Describe("Zip", function()
354
+ ctx:Test("should zip arrays together", function()
355
+ local t1 = { 1, 2, 3, 4, 5 }
356
+ local t2 = { 9, 8, 7, 6, 5 }
357
+ local t3 = { 1, 1, 1, 1, 1 }
358
+ local lastIndex = 0
359
+ for i, v in TableUtil.Zip(t1, t2, t3) do
360
+ lastIndex = i
361
+ ctx:Expect(v[1]):ToBe(t1[i])
362
+ ctx:Expect(v[2]):ToBe(t2[i])
363
+ ctx:Expect(v[3]):ToBe(t3[i])
364
+ end
365
+ ctx:Expect(lastIndex):ToBe(math.min(#t1, #t2, #t3))
366
+ end)
367
+
368
+ ctx:Test("should zip arrays of different lengths together", function()
369
+ local t1 = { 1, 2, 3, 4, 5 }
370
+ local t2 = { 9, 8, 7, 6 }
371
+ local t3 = { 1, 1, 1 }
372
+ local lastIndex = 0
373
+ for i, v in TableUtil.Zip(t1, t2, t3) do
374
+ lastIndex = i
375
+ ctx:Expect(v[1]):ToBe(t1[i])
376
+ ctx:Expect(v[2]):ToBe(t2[i])
377
+ ctx:Expect(v[3]):ToBe(t3[i])
378
+ end
379
+ ctx:Expect(lastIndex):ToBe(math.min(#t1, #t2, #t3))
380
+ end)
381
+
382
+ ctx:Test("should zip maps together", function()
383
+ local t1 = { a = 10, b = 20, c = 30 }
384
+ local t2 = { a = 100, b = 200, c = 300 }
385
+ local t3 = { a = 3000, b = 2000, c = 3000 }
386
+ for k, v in TableUtil.Zip(t1, t2, t3) do
387
+ ctx:Expect(v[1]):ToBe(t1[k])
388
+ ctx:Expect(v[2]):ToBe(t2[k])
389
+ ctx:Expect(v[3]):ToBe(t3[k])
390
+ end
391
+ end)
392
+
393
+ ctx:Test("should zip maps of different keys together", function()
394
+ local t1 = { a = 10, b = 20, c = 30, d = 40 }
395
+ local t2 = { a = 100, b = 200, c = 300, z = 10 }
396
+ local t3 = { a = 3000, b = 2000, c = 3000, x = 0 }
397
+ for k, v in TableUtil.Zip(t1, t2, t3) do
398
+ ctx:Expect(v[1]):ToBe(t1[k])
399
+ ctx:Expect(v[2]):ToBe(t2[k])
400
+ ctx:Expect(v[3]):ToBe(t3[k])
401
+ end
402
+ end)
403
+ end)
404
+
405
+ ctx:Describe("IsEmpty", function()
406
+ ctx:Test("should detect that table is empty", function()
407
+ local tbl = {}
408
+ local isEmpty = TableUtil.IsEmpty(tbl)
409
+ ctx:Expect(isEmpty):ToBe(true)
410
+ end)
411
+
412
+ ctx:Test("should detect that array is not empty", function()
413
+ local tbl = { 10, 20, 30 }
414
+ local isEmpty = TableUtil.IsEmpty(tbl)
415
+ ctx:Expect(isEmpty):ToBe(false)
416
+ end)
417
+
418
+ ctx:Test("should detect that dictionary is not empty", function()
419
+ local tbl = { a = 10, b = 20, c = 30 }
420
+ local isEmpty = TableUtil.IsEmpty(tbl)
421
+ ctx:Expect(isEmpty):ToBe(false)
422
+ end)
423
+ end)
424
+
425
+ ctx:Describe("JSON", function()
426
+ ctx:Test("should encode json", function()
427
+ local tbl = { hello = "world" }
428
+ local json = TableUtil.EncodeJSON(tbl)
429
+ ctx:Expect(json):ToBe('{"hello":"world"}')
430
+ end)
431
+
432
+ ctx:Test("should decode json", function()
433
+ local json = '{"hello":"world"}'
434
+ local tbl = TableUtil.DecodeJSON(json)
435
+ ctx:Expect(tbl):ToBeA("table")
436
+ ctx:Expect(tbl.hello):ToBe("world")
437
+ end)
438
+ end)
439
+ end
@@ -0,0 +1,8 @@
1
+ [package]
2
+ name = "sleitnick/table-util"
3
+ description = "Table utility functions"
4
+ version = "1.2.1"
5
+ license = "MIT"
6
+ authors = ["Stephen Leitnick"]
7
+ registry = "https://github.com/UpliftGames/wally-index"
8
+ realm = "shared"
@@ -0,0 +1,27 @@
1
+ declare namespace TaskQueue {
2
+ interface Constructor {
3
+ new <T>(onFlush: (items: T[]) => void): TaskQueue<T>;
4
+ }
5
+ }
6
+
7
+ interface TaskQueue<T> {
8
+ /**
9
+ * Add an item to the queue.
10
+ */
11
+ Add(item: T): void;
12
+
13
+ /**
14
+ * Clears items in the queue (except for items currently being flushed,
15
+ * which would only occur if the flushing function yielded).
16
+ */
17
+ Clear(): void;
18
+
19
+ /**
20
+ * Alias for `Clear()`.
21
+ */
22
+ Destroy(): void;
23
+ }
24
+
25
+ declare const TaskQueue: TaskQueue.Constructor;
26
+
27
+ export = TaskQueue;
@@ -0,0 +1,97 @@
1
+ -- TaskQueue
2
+ -- Stephen Leitnick
3
+ -- November 20, 2021
4
+
5
+ --[=[
6
+ @class TaskQueue
7
+ A queue that flushes all objects at the end of the current
8
+ execution step. This works by scheduling all tasks with
9
+ `task.defer`.
10
+
11
+ A possible use-case is to batch all requests being sent through
12
+ a RemoteEvent to help prevent calling it too many times on
13
+ the same frame.
14
+
15
+ ```lua
16
+ local bulletQueue = TaskQueue.new(function(bullets)
17
+ bulletRemoteEvent:FireAllClients(bullets)
18
+ end)
19
+
20
+ -- Add 3 bullets. Because they're all added on the same
21
+ -- execution step, they will all be grouped together on
22
+ -- the next queue flush, which the above function will
23
+ -- handle.
24
+ bulletQueue:Add(someBullet)
25
+ bulletQueue:Add(someBullet)
26
+ bulletQueue:Add(someBullet)
27
+ ```
28
+ ]=]
29
+ local TaskQueue = {}
30
+ TaskQueue.__index = TaskQueue
31
+
32
+ --[=[
33
+ @param onFlush ({T}) -> ()
34
+ @return TaskQueue<T>
35
+ Constructs a new TaskQueue.
36
+ ]=]
37
+ function TaskQueue.new<T>(onFlush: ({ T }) -> ())
38
+ local self = setmetatable({}, TaskQueue)
39
+
40
+ self._queue = {}
41
+ self._flushing = false
42
+ self._scheduled = nil
43
+ self._onFlush = onFlush
44
+
45
+ return self
46
+ end
47
+
48
+ --[=[
49
+ @param object T
50
+ Add an object to the queue.
51
+ ]=]
52
+ function TaskQueue:Add<T>(object: T)
53
+ table.insert(self._queue, object)
54
+
55
+ if self._scheduled == nil then
56
+ self._scheduled = task.defer(function()
57
+ self._flushing = true
58
+ self._onFlush(self._queue)
59
+ table.clear(self._queue)
60
+ self._flushing = false
61
+ self._scheduled = nil
62
+ end)
63
+ end
64
+ end
65
+
66
+ --[=[
67
+ Clears the TaskQueue. This will clear any tasks
68
+ that were scheduled to be flushed on the current
69
+ execution frame.
70
+
71
+ ```lua
72
+ queue:Add(something1)
73
+ queue:Add(something2)
74
+ queue:Clear()
75
+ ```
76
+ ]=]
77
+ function TaskQueue:Clear()
78
+ if self._flushing then
79
+ return
80
+ end
81
+
82
+ if self._scheduled ~= nil then
83
+ task.cancel(self._scheduled)
84
+ self._scheduled = nil
85
+ end
86
+
87
+ table.clear(self._queue)
88
+ end
89
+
90
+ --[=[
91
+ Destroys the TaskQueue. Just an alias for `Clear()`.
92
+ ]=]
93
+ function TaskQueue:Destroy()
94
+ self:Clear()
95
+ end
96
+
97
+ return TaskQueue
@@ -0,0 +1,8 @@
1
+ [package]
2
+ name = "sleitnick/task-queue"
3
+ description = "Batches tasks that occur on the same execution step"
4
+ version = "1.0.0"
5
+ license = "MIT"
6
+ authors = ["Stephen Leitnick"]
7
+ registry = "https://github.com/UpliftGames/wally-index"
8
+ realm = "shared"
@@ -0,0 +1,81 @@
1
+ declare namespace Timer {
2
+ interface Constructor {
3
+ /**
4
+ * Creates a new timer.
5
+ *
6
+ * @param interval The interval for the timer tick.
7
+ */
8
+ new (interval: number): Timer;
9
+
10
+ /**
11
+ * Creates a simple-to-use timer without having to interface
12
+ * with the rest of the class.
13
+ * @param interval The interval for the timer tick.
14
+ * @param callback The tick callback.
15
+ * @param startNow Whether or not it should tick immediately (defaults to `false`).
16
+ * @param updateSignal The update signal (defaults to `RunService.Heartbeat`).
17
+ * @param timeFn The time function (defaults to `time`).
18
+ */
19
+ simple: (
20
+ interval: number,
21
+ callback: () => void,
22
+ startNow?: boolean,
23
+ updateSignal?: RBXScriptSignal,
24
+ timeFn?: () => number,
25
+ ) => Timer;
26
+
27
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
28
+ is: (obj: any) => obj is Timer;
29
+ }
30
+ }
31
+
32
+ interface Timer {
33
+ /** The tick interval. */
34
+ readonly Interval: number;
35
+
36
+ /** The signal which is fired every tick. */
37
+ readonly Tick: RBXScriptSignal;
38
+
39
+ /** The function used to grab the current time. */
40
+ TimeFunction: () => number;
41
+
42
+ /** The signal used to update the timer. */
43
+ UpdateSignal: RBXScriptSignal;
44
+
45
+ /**
46
+ * Allow the timer to drift (`true` by default). A timer
47
+ * that drifts is much more simple. If the timer must keep
48
+ * from drifting, more logic must be performed.
49
+ */
50
+ AllowDrift: boolean;
51
+
52
+ /**
53
+ * Starts the timer. If already running, this does nothing.
54
+ */
55
+ Start(): void;
56
+
57
+ /**
58
+ * Starts the timer and ticks immediately. If already running,
59
+ * this does nothing.
60
+ */
61
+ StartNow(): void;
62
+
63
+ /**
64
+ * Stops the timer. If already stopped, this does nothing.
65
+ */
66
+ Stop(): void;
67
+
68
+ /**
69
+ * Returns `true` if the timer has been started.
70
+ */
71
+ IsRunning(): boolean;
72
+
73
+ /**
74
+ * Stops the timer and disconnects any connections to the `Tick` signal.
75
+ */
76
+ Destroy(): void;
77
+ }
78
+
79
+ declare const Timer: Timer.Constructor;
80
+
81
+ export = Timer;