roblox-opencode 1.0.0 → 1.0.2

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 (246) hide show
  1. package/README.md +112 -122
  2. package/commands/setup-game.md +108 -108
  3. package/commands/sync-check.md +53 -53
  4. package/core/roblox-core.md +93 -93
  5. package/dist/server.js +189 -167
  6. package/package.json +35 -35
  7. package/skills/roblox-analytics/SKILL.md +277 -277
  8. package/skills/roblox-analytics/references/event-batcher.luau +75 -75
  9. package/skills/roblox-animation-vfx/SKILL.md +1325 -1325
  10. package/skills/roblox-architecture/SKILL.md +877 -863
  11. package/skills/roblox-architecture/references/combat-systems.md +1381 -1381
  12. package/skills/roblox-code-review/SKILL.md +686 -686
  13. package/skills/roblox-data/SKILL.md +889 -889
  14. package/skills/roblox-data/references/inventory-systems.md +1729 -1729
  15. package/skills/roblox-debug/SKILL.md +98 -98
  16. package/skills/roblox-gui/SKILL.md +1103 -1103
  17. package/skills/roblox-gui-fusion/SKILL.md +150 -150
  18. package/skills/roblox-gui-fusion/references/inventory.luau +427 -427
  19. package/skills/roblox-gui-fusion/references/settings-menu.luau +579 -579
  20. package/skills/roblox-gui-fusion/references/shop.luau +411 -411
  21. package/skills/roblox-luau-mastery/SKILL.md +1618 -1519
  22. package/skills/roblox-monetization/SKILL.md +1084 -1084
  23. package/skills/roblox-monetization/references/process-receipt.luau +131 -131
  24. package/skills/roblox-networking/SKILL.md +669 -669
  25. package/skills/roblox-networking/references/remote-validator.luau +193 -193
  26. package/skills/roblox-publish-checklist/SKILL.md +127 -127
  27. package/skills/roblox-runtime/SKILL.md +753 -753
  28. package/skills/roblox-sharp-edges/SKILL.md +294 -294
  29. package/skills/roblox-sync/SKILL.md +126 -126
  30. package/skills/roblox-testing/SKILL.md +943 -943
  31. package/skills/roblox-tooling/SKILL.md +149 -149
  32. package/vendor/LICENSES/ProfileStore-LICENSE +201 -201
  33. package/vendor/LICENSES/RbxUtil-LICENSE +7 -7
  34. package/vendor/LICENSES/promise-LICENSE +20 -20
  35. package/vendor/LICENSES/t-LICENSE +21 -21
  36. package/vendor/LICENSES/testez-LICENSE +200 -200
  37. package/vendor/README.md +83 -83
  38. package/vendor/fusion/Animation/ExternalTime.luau +83 -83
  39. package/vendor/fusion/Animation/Spring.luau +321 -321
  40. package/vendor/fusion/Animation/Stopwatch.luau +127 -127
  41. package/vendor/fusion/Animation/Tween.luau +187 -187
  42. package/vendor/fusion/Animation/getTweenDuration.luau +27 -27
  43. package/vendor/fusion/Animation/getTweenRatio.luau +47 -47
  44. package/vendor/fusion/Animation/lerpType.luau +163 -163
  45. package/vendor/fusion/Animation/packType.luau +99 -99
  46. package/vendor/fusion/Animation/springCoefficients.luau +80 -80
  47. package/vendor/fusion/Animation/unpackType.luau +102 -102
  48. package/vendor/fusion/Colour/Oklab.luau +70 -70
  49. package/vendor/fusion/Colour/sRGB.luau +54 -54
  50. package/vendor/fusion/External.luau +167 -167
  51. package/vendor/fusion/ExternalDebug.luau +69 -69
  52. package/vendor/fusion/Graph/Observer.luau +113 -113
  53. package/vendor/fusion/Graph/castToGraph.luau +28 -28
  54. package/vendor/fusion/Graph/change.luau +80 -80
  55. package/vendor/fusion/Graph/depend.luau +32 -32
  56. package/vendor/fusion/Graph/evaluate.luau +55 -55
  57. package/vendor/fusion/Instances/Attribute.luau +57 -57
  58. package/vendor/fusion/Instances/AttributeChange.luau +46 -46
  59. package/vendor/fusion/Instances/AttributeOut.luau +63 -63
  60. package/vendor/fusion/Instances/Child.luau +21 -21
  61. package/vendor/fusion/Instances/Children.luau +147 -147
  62. package/vendor/fusion/Instances/Hydrate.luau +32 -32
  63. package/vendor/fusion/Instances/New.luau +52 -52
  64. package/vendor/fusion/Instances/OnChange.luau +49 -49
  65. package/vendor/fusion/Instances/OnEvent.luau +53 -53
  66. package/vendor/fusion/Instances/Out.luau +69 -69
  67. package/vendor/fusion/Instances/applyInstanceProps.luau +148 -148
  68. package/vendor/fusion/Instances/defaultProps.luau +194 -194
  69. package/vendor/fusion/LICENSE +21 -21
  70. package/vendor/fusion/Logging/formatError.luau +48 -48
  71. package/vendor/fusion/Logging/messages.luau +51 -51
  72. package/vendor/fusion/Logging/parseError.luau +24 -24
  73. package/vendor/fusion/Memory/checkLifetime.luau +133 -133
  74. package/vendor/fusion/Memory/deriveScope.luau +23 -23
  75. package/vendor/fusion/Memory/deriveScopeImpl.luau +44 -44
  76. package/vendor/fusion/Memory/doCleanup.luau +78 -78
  77. package/vendor/fusion/Memory/innerScope.luau +33 -33
  78. package/vendor/fusion/Memory/legacyCleanup.luau +17 -17
  79. package/vendor/fusion/Memory/needsDestruction.luau +16 -16
  80. package/vendor/fusion/Memory/poisonScope.luau +33 -33
  81. package/vendor/fusion/Memory/scopePool.luau +54 -54
  82. package/vendor/fusion/Memory/scoped.luau +26 -26
  83. package/vendor/fusion/Memory/whichLivesLonger.luau +74 -74
  84. package/vendor/fusion/RobloxExternal.luau +97 -97
  85. package/vendor/fusion/State/Computed.luau +138 -138
  86. package/vendor/fusion/State/For/Disassembly.luau +210 -210
  87. package/vendor/fusion/State/For/ForTypes.luau +30 -30
  88. package/vendor/fusion/State/For/init.luau +109 -109
  89. package/vendor/fusion/State/ForKeys.luau +93 -93
  90. package/vendor/fusion/State/ForPairs.luau +96 -96
  91. package/vendor/fusion/State/ForValues.luau +93 -93
  92. package/vendor/fusion/State/Value.luau +87 -87
  93. package/vendor/fusion/State/castToState.luau +25 -25
  94. package/vendor/fusion/State/peek.luau +30 -30
  95. package/vendor/fusion/Types.luau +314 -314
  96. package/vendor/fusion/Utility/Contextual.luau +90 -90
  97. package/vendor/fusion/Utility/Safe.luau +22 -22
  98. package/vendor/fusion/Utility/isSimilar.luau +29 -29
  99. package/vendor/fusion/Utility/merge.luau +35 -35
  100. package/vendor/fusion/Utility/nameOf.luau +34 -34
  101. package/vendor/fusion/Utility/never.luau +13 -13
  102. package/vendor/fusion/Utility/nicknames.luau +10 -10
  103. package/vendor/fusion/Utility/xtypeof.luau +26 -26
  104. package/vendor/fusion/init.luau +82 -82
  105. package/vendor/profilestore/init.luau +2242 -2242
  106. package/vendor/promise/init.luau +1982 -1982
  107. package/vendor/rbxutil/buffer-util/Buffer.test.luau +25 -25
  108. package/vendor/rbxutil/buffer-util/BufferReader.luau +228 -228
  109. package/vendor/rbxutil/buffer-util/BufferWriter.luau +269 -269
  110. package/vendor/rbxutil/buffer-util/DataTypeBuffer.luau +223 -223
  111. package/vendor/rbxutil/buffer-util/Types.luau +60 -60
  112. package/vendor/rbxutil/buffer-util/index.d.ts +153 -153
  113. package/vendor/rbxutil/buffer-util/init.luau +41 -41
  114. package/vendor/rbxutil/buffer-util/package.json +16 -16
  115. package/vendor/rbxutil/buffer-util/wally.toml +9 -9
  116. package/vendor/rbxutil/comm/Client/ClientComm.luau +232 -232
  117. package/vendor/rbxutil/comm/Client/ClientRemoteProperty.luau +156 -156
  118. package/vendor/rbxutil/comm/Client/ClientRemoteSignal.luau +109 -109
  119. package/vendor/rbxutil/comm/Client/init.luau +135 -135
  120. package/vendor/rbxutil/comm/Server/RemoteProperty.luau +295 -295
  121. package/vendor/rbxutil/comm/Server/RemoteSignal.luau +211 -211
  122. package/vendor/rbxutil/comm/Server/ServerComm.luau +211 -211
  123. package/vendor/rbxutil/comm/Server/init.luau +140 -140
  124. package/vendor/rbxutil/comm/Types.luau +18 -18
  125. package/vendor/rbxutil/comm/Util.luau +27 -27
  126. package/vendor/rbxutil/comm/init.luau +35 -35
  127. package/vendor/rbxutil/comm/wally.toml +13 -13
  128. package/vendor/rbxutil/component/init.luau +759 -759
  129. package/vendor/rbxutil/component/init.test.luau +311 -311
  130. package/vendor/rbxutil/component/wally.toml +14 -14
  131. package/vendor/rbxutil/concur/init.luau +542 -542
  132. package/vendor/rbxutil/concur/init.test.luau +364 -364
  133. package/vendor/rbxutil/concur/wally.toml +8 -8
  134. package/vendor/rbxutil/enum-list/init.luau +101 -101
  135. package/vendor/rbxutil/enum-list/init.test.luau +91 -91
  136. package/vendor/rbxutil/enum-list/wally.toml +8 -8
  137. package/vendor/rbxutil/find/index.d.ts +20 -20
  138. package/vendor/rbxutil/find/init.luau +44 -44
  139. package/vendor/rbxutil/find/package.json +17 -17
  140. package/vendor/rbxutil/find/wally.toml +8 -8
  141. package/vendor/rbxutil/input/Gamepad.luau +559 -559
  142. package/vendor/rbxutil/input/Keyboard.luau +124 -124
  143. package/vendor/rbxutil/input/Mouse.luau +278 -278
  144. package/vendor/rbxutil/input/PreferredInput.luau +91 -91
  145. package/vendor/rbxutil/input/Touch.luau +120 -120
  146. package/vendor/rbxutil/input/init.luau +33 -33
  147. package/vendor/rbxutil/input/wally.toml +12 -12
  148. package/vendor/rbxutil/loader/index.d.ts +15 -15
  149. package/vendor/rbxutil/loader/init.luau +137 -137
  150. package/vendor/rbxutil/loader/wally.toml +8 -8
  151. package/vendor/rbxutil/log/index.d.ts +38 -38
  152. package/vendor/rbxutil/log/init.luau +746 -746
  153. package/vendor/rbxutil/log/wally.toml +8 -8
  154. package/vendor/rbxutil/net/init.luau +190 -190
  155. package/vendor/rbxutil/net/wally.toml +8 -8
  156. package/vendor/rbxutil/option/index.d.ts +44 -44
  157. package/vendor/rbxutil/option/init.luau +489 -489
  158. package/vendor/rbxutil/option/init.test.luau +342 -342
  159. package/vendor/rbxutil/option/wally.toml +8 -8
  160. package/vendor/rbxutil/pid/index.d.ts +53 -53
  161. package/vendor/rbxutil/pid/init.luau +195 -195
  162. package/vendor/rbxutil/pid/package.json +16 -16
  163. package/vendor/rbxutil/pid/wally.toml +9 -9
  164. package/vendor/rbxutil/quaternion/index.d.ts +117 -117
  165. package/vendor/rbxutil/quaternion/init.luau +570 -570
  166. package/vendor/rbxutil/quaternion/package.json +16 -16
  167. package/vendor/rbxutil/quaternion/wally.toml +9 -9
  168. package/vendor/rbxutil/query/index.d.ts +43 -43
  169. package/vendor/rbxutil/query/init.luau +117 -117
  170. package/vendor/rbxutil/query/package.json +18 -18
  171. package/vendor/rbxutil/query/wally.toml +9 -9
  172. package/vendor/rbxutil/sequent/index.d.ts +28 -28
  173. package/vendor/rbxutil/sequent/init.luau +340 -340
  174. package/vendor/rbxutil/sequent/package.json +16 -16
  175. package/vendor/rbxutil/sequent/wally.toml +9 -9
  176. package/vendor/rbxutil/ser/init.luau +175 -175
  177. package/vendor/rbxutil/ser/init.test.luau +50 -50
  178. package/vendor/rbxutil/ser/wally.toml +11 -11
  179. package/vendor/rbxutil/shake/index.d.ts +36 -36
  180. package/vendor/rbxutil/shake/init.luau +532 -532
  181. package/vendor/rbxutil/shake/init.test.luau +267 -267
  182. package/vendor/rbxutil/shake/package.json +16 -16
  183. package/vendor/rbxutil/shake/wally.toml +9 -9
  184. package/vendor/rbxutil/signal/index.d.ts +100 -100
  185. package/vendor/rbxutil/signal/init.luau +432 -432
  186. package/vendor/rbxutil/signal/init.test.luau +190 -190
  187. package/vendor/rbxutil/signal/package.json +17 -17
  188. package/vendor/rbxutil/signal/wally.toml +9 -9
  189. package/vendor/rbxutil/silo/TableWatcher.luau +65 -65
  190. package/vendor/rbxutil/silo/Util.luau +55 -55
  191. package/vendor/rbxutil/silo/init.luau +338 -338
  192. package/vendor/rbxutil/silo/init.test.luau +215 -215
  193. package/vendor/rbxutil/silo/wally.toml +8 -8
  194. package/vendor/rbxutil/spring/index.d.ts +40 -40
  195. package/vendor/rbxutil/spring/init.luau +97 -97
  196. package/vendor/rbxutil/spring/package.json +17 -17
  197. package/vendor/rbxutil/spring/wally.toml +8 -8
  198. package/vendor/rbxutil/stream/index.d.ts +88 -88
  199. package/vendor/rbxutil/stream/init.luau +597 -597
  200. package/vendor/rbxutil/stream/package.json +18 -18
  201. package/vendor/rbxutil/stream/wally.toml +9 -9
  202. package/vendor/rbxutil/streamable/Streamable.luau +202 -202
  203. package/vendor/rbxutil/streamable/StreamableUtil.luau +80 -80
  204. package/vendor/rbxutil/streamable/init.luau +8 -8
  205. package/vendor/rbxutil/streamable/wally.toml +12 -12
  206. package/vendor/rbxutil/symbol/init.luau +56 -56
  207. package/vendor/rbxutil/symbol/init.test.luau +37 -37
  208. package/vendor/rbxutil/symbol/wally.toml +8 -8
  209. package/vendor/rbxutil/table-util/init.luau +938 -938
  210. package/vendor/rbxutil/table-util/init.test.luau +439 -439
  211. package/vendor/rbxutil/task-queue/index.d.ts +27 -27
  212. package/vendor/rbxutil/task-queue/init.luau +97 -97
  213. package/vendor/rbxutil/task-queue/wally.toml +8 -8
  214. package/vendor/rbxutil/timer/index.d.ts +81 -81
  215. package/vendor/rbxutil/timer/init.luau +249 -249
  216. package/vendor/rbxutil/timer/init.test.luau +73 -73
  217. package/vendor/rbxutil/timer/wally.toml +11 -11
  218. package/vendor/rbxutil/tree/index.d.ts +15 -15
  219. package/vendor/rbxutil/tree/init.luau +137 -137
  220. package/vendor/rbxutil/tree/wally.toml +8 -8
  221. package/vendor/rbxutil/trove/index.d.ts +46 -46
  222. package/vendor/rbxutil/trove/init.luau +787 -787
  223. package/vendor/rbxutil/trove/init.test.luau +203 -203
  224. package/vendor/rbxutil/trove/wally.toml +8 -8
  225. package/vendor/rbxutil/typed-remote/init.luau +196 -196
  226. package/vendor/rbxutil/typed-remote/wally.toml +8 -8
  227. package/vendor/rbxutil/wait-for/index.d.ts +17 -17
  228. package/vendor/rbxutil/wait-for/init.luau +257 -257
  229. package/vendor/rbxutil/wait-for/init.test.luau +182 -182
  230. package/vendor/rbxutil/wait-for/wally.toml +11 -11
  231. package/vendor/t/t.lua +1350 -1350
  232. package/vendor/testez/Context.lua +26 -26
  233. package/vendor/testez/Expectation.lua +311 -311
  234. package/vendor/testez/ExpectationContext.lua +38 -38
  235. package/vendor/testez/LifecycleHooks.lua +89 -89
  236. package/vendor/testez/Reporters/TeamCityReporter.lua +101 -101
  237. package/vendor/testez/Reporters/TextReporter.lua +105 -105
  238. package/vendor/testez/Reporters/TextReporterQuiet.lua +96 -96
  239. package/vendor/testez/TestBootstrap.lua +146 -146
  240. package/vendor/testez/TestEnum.lua +27 -27
  241. package/vendor/testez/TestPlan.lua +304 -304
  242. package/vendor/testez/TestPlanner.lua +39 -39
  243. package/vendor/testez/TestResults.lua +111 -111
  244. package/vendor/testez/TestRunner.lua +188 -188
  245. package/vendor/testez/TestSession.lua +243 -243
  246. package/vendor/testez/init.lua +39 -39
@@ -1,26 +1,26 @@
1
- --[[
2
- The Context object implements a write-once key-value store. It also allows
3
- for a new Context object to inherit the entries from an existing one.
4
- ]]
5
- local Context = {}
6
-
7
- function Context.new(parent)
8
- local meta = {}
9
- local index = {}
10
- meta.__index = index
11
-
12
- if parent then
13
- for key, value in pairs(getmetatable(parent).__index) do
14
- index[key] = value
15
- end
16
- end
17
-
18
- function meta.__newindex(_obj, key, value)
19
- assert(index[key] == nil, string.format("Cannot reassign %s in context", tostring(key)))
20
- index[key] = value
21
- end
22
-
23
- return setmetatable({}, meta)
24
- end
25
-
26
- return Context
1
+ --[[
2
+ The Context object implements a write-once key-value store. It also allows
3
+ for a new Context object to inherit the entries from an existing one.
4
+ ]]
5
+ local Context = {}
6
+
7
+ function Context.new(parent)
8
+ local meta = {}
9
+ local index = {}
10
+ meta.__index = index
11
+
12
+ if parent then
13
+ for key, value in pairs(getmetatable(parent).__index) do
14
+ index[key] = value
15
+ end
16
+ end
17
+
18
+ function meta.__newindex(_obj, key, value)
19
+ assert(index[key] == nil, string.format("Cannot reassign %s in context", tostring(key)))
20
+ index[key] = value
21
+ end
22
+
23
+ return setmetatable({}, meta)
24
+ end
25
+
26
+ return Context
@@ -1,311 +1,311 @@
1
- --[[
2
- Allows creation of expectation statements designed for behavior-driven
3
- testing (BDD). See Chai (JS) or RSpec (Ruby) for examples of other BDD
4
- frameworks.
5
-
6
- The Expectation class is exposed to tests as a function called `expect`:
7
-
8
- expect(5).to.equal(5)
9
- expect(foo()).to.be.ok()
10
-
11
- Expectations can be negated using .never:
12
-
13
- expect(true).never.to.equal(false)
14
-
15
- Expectations throw errors when their conditions are not met.
16
- ]]
17
-
18
- local Expectation = {}
19
-
20
- --[[
21
- These keys don't do anything except make expectations read more cleanly
22
- ]]
23
- local SELF_KEYS = {
24
- to = true,
25
- be = true,
26
- been = true,
27
- have = true,
28
- was = true,
29
- at = true,
30
- }
31
-
32
- --[[
33
- These keys invert the condition expressed by the Expectation.
34
- ]]
35
- local NEGATION_KEYS = {
36
- never = true,
37
- }
38
-
39
- --[[
40
- Extension of Lua's 'assert' that lets you specify an error level.
41
- ]]
42
- local function assertLevel(condition, message, level)
43
- message = message or "Assertion failed!"
44
- level = level or 1
45
-
46
- if not condition then
47
- error(message, level + 1)
48
- end
49
- end
50
-
51
- --[[
52
- Returns a version of the given method that can be called with either . or :
53
- ]]
54
- local function bindSelf(self, method)
55
- return function(firstArg, ...)
56
- if firstArg == self then
57
- return method(self, ...)
58
- else
59
- return method(self, firstArg, ...)
60
- end
61
- end
62
- end
63
-
64
- local function formatMessage(result, trueMessage, falseMessage)
65
- if result then
66
- return trueMessage
67
- else
68
- return falseMessage
69
- end
70
- end
71
-
72
- --[[
73
- Create a new expectation
74
- ]]
75
- function Expectation.new(value)
76
- local self = {
77
- value = value,
78
- successCondition = true,
79
- condition = false,
80
- matchers = {},
81
- _boundMatchers = {},
82
- }
83
-
84
- setmetatable(self, Expectation)
85
-
86
- self.a = bindSelf(self, self.a)
87
- self.an = self.a
88
- self.ok = bindSelf(self, self.ok)
89
- self.equal = bindSelf(self, self.equal)
90
- self.throw = bindSelf(self, self.throw)
91
- self.near = bindSelf(self, self.near)
92
-
93
- return self
94
- end
95
-
96
- function Expectation.checkMatcherNameCollisions(name)
97
- if SELF_KEYS[name] or NEGATION_KEYS[name] or Expectation[name] then
98
- return false
99
- end
100
-
101
- return true
102
- end
103
-
104
- function Expectation:extend(matchers)
105
- self.matchers = matchers or {}
106
-
107
- for name, implementation in pairs(self.matchers) do
108
- self._boundMatchers[name] = bindSelf(self, function(_self, ...)
109
- local result = implementation(self.value, ...)
110
- local pass = result.pass == self.successCondition
111
-
112
- assertLevel(pass, result.message, 3)
113
- self:_resetModifiers()
114
- return self
115
- end)
116
- end
117
-
118
- return self
119
- end
120
-
121
- function Expectation.__index(self, key)
122
- -- Keys that don't do anything except improve readability
123
- if SELF_KEYS[key] then
124
- return self
125
- end
126
-
127
- -- Invert your assertion
128
- if NEGATION_KEYS[key] then
129
- local newExpectation = Expectation.new(self.value):extend(self.matchers)
130
- newExpectation.successCondition = not self.successCondition
131
-
132
- return newExpectation
133
- end
134
-
135
- if self._boundMatchers[key] then
136
- return self._boundMatchers[key]
137
- end
138
-
139
- -- Fall back to methods provided by Expectation
140
- return Expectation[key]
141
- end
142
-
143
- --[[
144
- Called by expectation terminators to reset modifiers in a statement.
145
-
146
- This makes chains like:
147
-
148
- expect(5)
149
- .never.to.equal(6)
150
- .to.equal(5)
151
-
152
- Work as expected.
153
- ]]
154
- function Expectation:_resetModifiers()
155
- self.successCondition = true
156
- end
157
-
158
- --[[
159
- Assert that the expectation value is the given type.
160
-
161
- expect(5).to.be.a("number")
162
- ]]
163
- function Expectation:a(typeName)
164
- local result = (type(self.value) == typeName) == self.successCondition
165
-
166
- local message = formatMessage(self.successCondition,
167
- ("Expected value of type %q, got value %q of type %s"):format(
168
- typeName,
169
- tostring(self.value),
170
- type(self.value)
171
- ),
172
- ("Expected value not of type %q, got value %q of type %s"):format(
173
- typeName,
174
- tostring(self.value),
175
- type(self.value)
176
- )
177
- )
178
-
179
- assertLevel(result, message, 3)
180
- self:_resetModifiers()
181
-
182
- return self
183
- end
184
-
185
- -- Make alias public on class
186
- Expectation.an = Expectation.a
187
-
188
- --[[
189
- Assert that our expectation value is truthy
190
- ]]
191
- function Expectation:ok()
192
- local result = (self.value ~= nil) == self.successCondition
193
-
194
- local message = formatMessage(self.successCondition,
195
- ("Expected value %q to be non-nil"):format(
196
- tostring(self.value)
197
- ),
198
- ("Expected value %q to be nil"):format(
199
- tostring(self.value)
200
- )
201
- )
202
-
203
- assertLevel(result, message, 3)
204
- self:_resetModifiers()
205
-
206
- return self
207
- end
208
-
209
- --[[
210
- Assert that our expectation value is equal to another value
211
- ]]
212
- function Expectation:equal(otherValue)
213
- local result = (self.value == otherValue) == self.successCondition
214
-
215
- local message = formatMessage(self.successCondition,
216
- ("Expected value %q (%s), got %q (%s) instead"):format(
217
- tostring(otherValue),
218
- type(otherValue),
219
- tostring(self.value),
220
- type(self.value)
221
- ),
222
- ("Expected anything but value %q (%s)"):format(
223
- tostring(otherValue),
224
- type(otherValue)
225
- )
226
- )
227
-
228
- assertLevel(result, message, 3)
229
- self:_resetModifiers()
230
-
231
- return self
232
- end
233
-
234
- --[[
235
- Assert that our expectation value is equal to another value within some
236
- inclusive limit.
237
- ]]
238
- function Expectation:near(otherValue, limit)
239
- assert(type(self.value) == "number", "Expectation value must be a number to use 'near'")
240
- assert(type(otherValue) == "number", "otherValue must be a number")
241
- assert(type(limit) == "number" or limit == nil, "limit must be a number or nil")
242
-
243
- limit = limit or 1e-7
244
-
245
- local result = (math.abs(self.value - otherValue) <= limit) == self.successCondition
246
-
247
- local message = formatMessage(self.successCondition,
248
- ("Expected value to be near %f (within %f) but got %f instead"):format(
249
- otherValue,
250
- limit,
251
- self.value
252
- ),
253
- ("Expected value to not be near %f (within %f) but got %f instead"):format(
254
- otherValue,
255
- limit,
256
- self.value
257
- )
258
- )
259
-
260
- assertLevel(result, message, 3)
261
- self:_resetModifiers()
262
-
263
- return self
264
- end
265
-
266
- --[[
267
- Assert that our functoid expectation value throws an error when called.
268
- An optional error message can be passed to assert that the error message
269
- contains the given value.
270
- ]]
271
- function Expectation:throw(messageSubstring)
272
- local ok, err = pcall(self.value)
273
- local result = ok ~= self.successCondition
274
-
275
- if messageSubstring and not ok then
276
- if self.successCondition then
277
- result = err:find(messageSubstring, 1, true) ~= nil
278
- else
279
- result = err:find(messageSubstring, 1, true) == nil
280
- end
281
- end
282
-
283
- local message
284
-
285
- if messageSubstring then
286
- message = formatMessage(self.successCondition,
287
- ("Expected function to throw an error containing %q, but it %s"):format(
288
- messageSubstring,
289
- err and ("threw: %s"):format(err) or "did not throw."
290
- ),
291
- ("Expected function to never throw an error containing %q, but it threw: %s"):format(
292
- messageSubstring,
293
- tostring(err)
294
- )
295
- )
296
- else
297
- message = formatMessage(self.successCondition,
298
- "Expected function to throw an error, but it did not throw.",
299
- ("Expected function to succeed, but it threw an error: %s"):format(
300
- tostring(err)
301
- )
302
- )
303
- end
304
-
305
- assertLevel(result, message, 3)
306
- self:_resetModifiers()
307
-
308
- return self
309
- end
310
-
311
- return Expectation
1
+ --[[
2
+ Allows creation of expectation statements designed for behavior-driven
3
+ testing (BDD). See Chai (JS) or RSpec (Ruby) for examples of other BDD
4
+ frameworks.
5
+
6
+ The Expectation class is exposed to tests as a function called `expect`:
7
+
8
+ expect(5).to.equal(5)
9
+ expect(foo()).to.be.ok()
10
+
11
+ Expectations can be negated using .never:
12
+
13
+ expect(true).never.to.equal(false)
14
+
15
+ Expectations throw errors when their conditions are not met.
16
+ ]]
17
+
18
+ local Expectation = {}
19
+
20
+ --[[
21
+ These keys don't do anything except make expectations read more cleanly
22
+ ]]
23
+ local SELF_KEYS = {
24
+ to = true,
25
+ be = true,
26
+ been = true,
27
+ have = true,
28
+ was = true,
29
+ at = true,
30
+ }
31
+
32
+ --[[
33
+ These keys invert the condition expressed by the Expectation.
34
+ ]]
35
+ local NEGATION_KEYS = {
36
+ never = true,
37
+ }
38
+
39
+ --[[
40
+ Extension of Lua's 'assert' that lets you specify an error level.
41
+ ]]
42
+ local function assertLevel(condition, message, level)
43
+ message = message or "Assertion failed!"
44
+ level = level or 1
45
+
46
+ if not condition then
47
+ error(message, level + 1)
48
+ end
49
+ end
50
+
51
+ --[[
52
+ Returns a version of the given method that can be called with either . or :
53
+ ]]
54
+ local function bindSelf(self, method)
55
+ return function(firstArg, ...)
56
+ if firstArg == self then
57
+ return method(self, ...)
58
+ else
59
+ return method(self, firstArg, ...)
60
+ end
61
+ end
62
+ end
63
+
64
+ local function formatMessage(result, trueMessage, falseMessage)
65
+ if result then
66
+ return trueMessage
67
+ else
68
+ return falseMessage
69
+ end
70
+ end
71
+
72
+ --[[
73
+ Create a new expectation
74
+ ]]
75
+ function Expectation.new(value)
76
+ local self = {
77
+ value = value,
78
+ successCondition = true,
79
+ condition = false,
80
+ matchers = {},
81
+ _boundMatchers = {},
82
+ }
83
+
84
+ setmetatable(self, Expectation)
85
+
86
+ self.a = bindSelf(self, self.a)
87
+ self.an = self.a
88
+ self.ok = bindSelf(self, self.ok)
89
+ self.equal = bindSelf(self, self.equal)
90
+ self.throw = bindSelf(self, self.throw)
91
+ self.near = bindSelf(self, self.near)
92
+
93
+ return self
94
+ end
95
+
96
+ function Expectation.checkMatcherNameCollisions(name)
97
+ if SELF_KEYS[name] or NEGATION_KEYS[name] or Expectation[name] then
98
+ return false
99
+ end
100
+
101
+ return true
102
+ end
103
+
104
+ function Expectation:extend(matchers)
105
+ self.matchers = matchers or {}
106
+
107
+ for name, implementation in pairs(self.matchers) do
108
+ self._boundMatchers[name] = bindSelf(self, function(_self, ...)
109
+ local result = implementation(self.value, ...)
110
+ local pass = result.pass == self.successCondition
111
+
112
+ assertLevel(pass, result.message, 3)
113
+ self:_resetModifiers()
114
+ return self
115
+ end)
116
+ end
117
+
118
+ return self
119
+ end
120
+
121
+ function Expectation.__index(self, key)
122
+ -- Keys that don't do anything except improve readability
123
+ if SELF_KEYS[key] then
124
+ return self
125
+ end
126
+
127
+ -- Invert your assertion
128
+ if NEGATION_KEYS[key] then
129
+ local newExpectation = Expectation.new(self.value):extend(self.matchers)
130
+ newExpectation.successCondition = not self.successCondition
131
+
132
+ return newExpectation
133
+ end
134
+
135
+ if self._boundMatchers[key] then
136
+ return self._boundMatchers[key]
137
+ end
138
+
139
+ -- Fall back to methods provided by Expectation
140
+ return Expectation[key]
141
+ end
142
+
143
+ --[[
144
+ Called by expectation terminators to reset modifiers in a statement.
145
+
146
+ This makes chains like:
147
+
148
+ expect(5)
149
+ .never.to.equal(6)
150
+ .to.equal(5)
151
+
152
+ Work as expected.
153
+ ]]
154
+ function Expectation:_resetModifiers()
155
+ self.successCondition = true
156
+ end
157
+
158
+ --[[
159
+ Assert that the expectation value is the given type.
160
+
161
+ expect(5).to.be.a("number")
162
+ ]]
163
+ function Expectation:a(typeName)
164
+ local result = (type(self.value) == typeName) == self.successCondition
165
+
166
+ local message = formatMessage(self.successCondition,
167
+ ("Expected value of type %q, got value %q of type %s"):format(
168
+ typeName,
169
+ tostring(self.value),
170
+ type(self.value)
171
+ ),
172
+ ("Expected value not of type %q, got value %q of type %s"):format(
173
+ typeName,
174
+ tostring(self.value),
175
+ type(self.value)
176
+ )
177
+ )
178
+
179
+ assertLevel(result, message, 3)
180
+ self:_resetModifiers()
181
+
182
+ return self
183
+ end
184
+
185
+ -- Make alias public on class
186
+ Expectation.an = Expectation.a
187
+
188
+ --[[
189
+ Assert that our expectation value is truthy
190
+ ]]
191
+ function Expectation:ok()
192
+ local result = (self.value ~= nil) == self.successCondition
193
+
194
+ local message = formatMessage(self.successCondition,
195
+ ("Expected value %q to be non-nil"):format(
196
+ tostring(self.value)
197
+ ),
198
+ ("Expected value %q to be nil"):format(
199
+ tostring(self.value)
200
+ )
201
+ )
202
+
203
+ assertLevel(result, message, 3)
204
+ self:_resetModifiers()
205
+
206
+ return self
207
+ end
208
+
209
+ --[[
210
+ Assert that our expectation value is equal to another value
211
+ ]]
212
+ function Expectation:equal(otherValue)
213
+ local result = (self.value == otherValue) == self.successCondition
214
+
215
+ local message = formatMessage(self.successCondition,
216
+ ("Expected value %q (%s), got %q (%s) instead"):format(
217
+ tostring(otherValue),
218
+ type(otherValue),
219
+ tostring(self.value),
220
+ type(self.value)
221
+ ),
222
+ ("Expected anything but value %q (%s)"):format(
223
+ tostring(otherValue),
224
+ type(otherValue)
225
+ )
226
+ )
227
+
228
+ assertLevel(result, message, 3)
229
+ self:_resetModifiers()
230
+
231
+ return self
232
+ end
233
+
234
+ --[[
235
+ Assert that our expectation value is equal to another value within some
236
+ inclusive limit.
237
+ ]]
238
+ function Expectation:near(otherValue, limit)
239
+ assert(type(self.value) == "number", "Expectation value must be a number to use 'near'")
240
+ assert(type(otherValue) == "number", "otherValue must be a number")
241
+ assert(type(limit) == "number" or limit == nil, "limit must be a number or nil")
242
+
243
+ limit = limit or 1e-7
244
+
245
+ local result = (math.abs(self.value - otherValue) <= limit) == self.successCondition
246
+
247
+ local message = formatMessage(self.successCondition,
248
+ ("Expected value to be near %f (within %f) but got %f instead"):format(
249
+ otherValue,
250
+ limit,
251
+ self.value
252
+ ),
253
+ ("Expected value to not be near %f (within %f) but got %f instead"):format(
254
+ otherValue,
255
+ limit,
256
+ self.value
257
+ )
258
+ )
259
+
260
+ assertLevel(result, message, 3)
261
+ self:_resetModifiers()
262
+
263
+ return self
264
+ end
265
+
266
+ --[[
267
+ Assert that our functoid expectation value throws an error when called.
268
+ An optional error message can be passed to assert that the error message
269
+ contains the given value.
270
+ ]]
271
+ function Expectation:throw(messageSubstring)
272
+ local ok, err = pcall(self.value)
273
+ local result = ok ~= self.successCondition
274
+
275
+ if messageSubstring and not ok then
276
+ if self.successCondition then
277
+ result = err:find(messageSubstring, 1, true) ~= nil
278
+ else
279
+ result = err:find(messageSubstring, 1, true) == nil
280
+ end
281
+ end
282
+
283
+ local message
284
+
285
+ if messageSubstring then
286
+ message = formatMessage(self.successCondition,
287
+ ("Expected function to throw an error containing %q, but it %s"):format(
288
+ messageSubstring,
289
+ err and ("threw: %s"):format(err) or "did not throw."
290
+ ),
291
+ ("Expected function to never throw an error containing %q, but it threw: %s"):format(
292
+ messageSubstring,
293
+ tostring(err)
294
+ )
295
+ )
296
+ else
297
+ message = formatMessage(self.successCondition,
298
+ "Expected function to throw an error, but it did not throw.",
299
+ ("Expected function to succeed, but it threw an error: %s"):format(
300
+ tostring(err)
301
+ )
302
+ )
303
+ end
304
+
305
+ assertLevel(result, message, 3)
306
+ self:_resetModifiers()
307
+
308
+ return self
309
+ end
310
+
311
+ return Expectation