@rbxts/planck 0.3.0-alpha.2 → 0.3.0-rc.2

package/src/__tests__/systems.test.luau

@@ -1,192 +1,196 @@
-local ReplicatedStorage = game:GetService("ReplicatedStorage")
-
-local root = script.Parent.Parent
-
-local Phase = require(root.Phase)
-local Scheduler = require(root.Scheduler)
-
-local JestGlobals = require(ReplicatedStorage.DevPackages.JestGlobals)
-
-local describe = JestGlobals.describe
-local expect = JestGlobals.expect
-local test = JestGlobals.test
-
-describe("systems", function()
-	test("add", function()
-		expect.assertions(1)
-
-		local myPhase = Phase.new("myPhase")
-		local myScheduler = Scheduler.new(1, 2, 3)
-			:insert(myPhase)
-			:addSystem(function(...)
-				expect({ ... }).toEqual({ 1, 2, 3 })
-			end, myPhase)
-
-		myScheduler:runAll()
-	end)
-
-	test("edit", function()
-		expect.assertions(2)
-
-		local function systemA(...)
-			expect({ ... }).toEqual({ 1, 2, 3 })
-		end
-
-		local myPhase = Phase.new("myPhase")
-		local myScheduler =
-			Scheduler.new(1, 2, 3):insert(myPhase):addSystem(systemA, myPhase)
-
-		myScheduler:runAll()
-
-		local otherPhase = Phase.new()
-		myScheduler:insert(otherPhase)
-
-		myScheduler:editSystem(systemA, otherPhase)
-		myScheduler:run(otherPhase)
-
-		-- Expect nothing to run here
-		myScheduler:run(myPhase)
-	end)
-
-	test("remove", function()
-		expect.assertions(1)
-
-		local function systemA(...)
-			expect({ ... }).toEqual({ 1, 2, 3 })
-		end
-
-		local myPhase = Phase.new("myPhase")
-		local myScheduler =
-			Scheduler.new(1, 2, 3):insert(myPhase):addSystem(systemA, myPhase)
-
-		myScheduler:runAll()
-
-		myScheduler:removeSystem(systemA)
-		myScheduler:runAll() -- Expect nothing here
-	end)
-
-	test("replace", function()
-		expect.assertions(3)
-
-		local function systemA(...)
-			expect({ ... }).toEqual({ 1, 2, 3 })
-		end
-
-		local function systemB(...)
-			-- FUTURE: Use Jest.spyOn
-			expect(true).toBe(true)
-			expect({ ... }).toEqual({ 1, 2, 3 })
-		end
-
-		local myPhase = Phase.new("myPhase")
-		local myScheduler =
-			Scheduler.new(1, 2, 3):insert(myPhase):addSystem(systemA, myPhase)
-
-		myScheduler:runAll()
-
-		myScheduler:replaceSystem(systemA, systemB)
-		myScheduler:runAll()
-	end)
-
-	test("system table", function()
-		expect.assertions(1)
-
-		local myPhase = Phase.new("myPhase")
-
-		local system = {
-			system = function(...)
-				expect({ ... }).toEqual({ 1, 2, 3 })
-			end,
-			phase = myPhase,
-		}
-
-		local myScheduler =
-			Scheduler.new(1, 2, 3):insert(myPhase):addSystem(system)
-
-		myScheduler:run(myPhase)
-	end)
-
-	test("run condition", function()
-		expect.assertions(1)
-
-		local bool = true
-
-		local system = function(...)
-			expect({ ... }).toEqual({ 1, 2, 3 })
-		end
-
-		local myPhase = Phase.new("myPhase")
-		local myScheduler = Scheduler.new(1, 2, 3)
-			:insert(myPhase)
-			:addSystem(system, myPhase)
-			:addRunCondition(system, function()
-				return bool
-			end)
-
-		myScheduler:runAll()
-
-		bool = false
-		myScheduler:runAll() -- Expect system to not run
-	end)
-
-	test("multiple run conditions", function()
-		expect.assertions(1)
-
-		local firstCondition = true
-		local secondCondition = true
-
-		local system = function(...)
-			expect({ ... }).toEqual({ 1, 2, 3 })
-		end
-
-		local myPhase = Phase.new("myPhase")
-		local myScheduler = Scheduler.new(1, 2, 3)
-			:insert(myPhase)
-			:addSystem(system, myPhase)
-			:addRunCondition(system, function()
-				return firstCondition
-			end)
-			:addRunCondition(system, function()
-				return secondCondition
-			end)
-
-		firstCondition = false
-		myScheduler:runAll()
-
-		firstCondition = true
-		secondCondition = false
-		myScheduler:runAll()
-
-		firstCondition = false
-		secondCondition = false
-		myScheduler:runAll()
-
-		firstCondition = true
-		secondCondition = true
-		myScheduler:runAll() -- Expect to run
-	end)
-
-	test("yield", function()
-		expect.assertions(1)
-
-		local system = function()
-			wait(5)
-		end
-
-		local myPhase = Phase.new("myPhase")
-		local myScheduler =
-			Scheduler.new(1, 2, 3):insert(myPhase):addSystem(system, myPhase)
-
-		local err;
-
-		(myScheduler :: any):_addHook(
-			(myScheduler :: any).Hooks.SystemError,
-			function(args)
-				err = args.error
-			end
-		)
-
-		myScheduler:runAll()
-		expect(err).toEqual(expect.stringContaining("System yielded"))
-	end)
-end)
+local ReplicatedStorage = game:GetService("ReplicatedStorage")
+
+local root = script.Parent.Parent
+
+local Phase = require(root.Phase)
+local Scheduler = require(root.Scheduler)
+
+type SystemErrorContext = Scheduler.SystemErrorContext
+
+local JestGlobals = require(ReplicatedStorage.DevPackages.JestGlobals)
+
+local describe = JestGlobals.describe
+local expect = JestGlobals.expect
+local test = JestGlobals.test
+
+describe("systems", function()
+	test("add", function()
+		expect.assertions(1)
+
+		local myPhase = Phase.new("myPhase")
+		local myScheduler = Scheduler.new(1, 2, 3)
+			:insert(myPhase)
+			:addSystem(function(...)
+				expect({ ... }).toEqual({ 1, 2, 3 })
+			end, myPhase)
+
+		myScheduler:runAll()
+	end)
+
+	test("edit", function()
+		expect.assertions(2)
+
+		local function systemA(...)
+			expect({ ... }).toEqual({ 1, 2, 3 })
+		end
+
+		local myPhase = Phase.new("myPhase")
+		local myScheduler =
+			Scheduler.new(1, 2, 3):insert(myPhase):addSystem(systemA, myPhase)
+
+		myScheduler:runAll()
+
+		local otherPhase = Phase.new()
+		myScheduler:insert(otherPhase)
+
+		myScheduler:editSystem(systemA, otherPhase)
+		myScheduler:run(otherPhase)
+
+		-- Expect nothing to run here
+		myScheduler:run(myPhase)
+	end)
+
+	test("remove", function()
+		expect.assertions(1)
+
+		local function systemA(...)
+			expect({ ... }).toEqual({ 1, 2, 3 })
+		end
+
+		local myPhase = Phase.new("myPhase")
+		local myScheduler =
+			Scheduler.new(1, 2, 3):insert(myPhase):addSystem(systemA, myPhase)
+
+		myScheduler:runAll()
+
+		myScheduler:removeSystem(systemA)
+		myScheduler:runAll() -- Expect nothing here
+	end)
+
+	test("replace", function()
+		expect.assertions(3)
+
+		local function systemA(...)
+			expect({ ... }).toEqual({ 1, 2, 3 })
+		end
+
+		local function systemB(...)
+			-- FUTURE: Use Jest.spyOn
+			expect(true).toBe(true)
+			expect({ ... }).toEqual({ 1, 2, 3 })
+		end
+
+		local myPhase = Phase.new("myPhase")
+		local myScheduler =
+			Scheduler.new(1, 2, 3):insert(myPhase):addSystem(systemA, myPhase)
+
+		myScheduler:runAll()
+
+		myScheduler:replaceSystem(systemA, systemB)
+		myScheduler:runAll()
+	end)
+
+	test("system table", function()
+		expect.assertions(1)
+
+		local myPhase = Phase.new("myPhase")
+
+		local system = {
+			system = function(...)
+				expect({ ... }).toEqual({ 1, 2, 3 })
+			end,
+			phase = myPhase,
+		}
+
+		local myScheduler =
+			Scheduler.new(1, 2, 3):insert(myPhase):addSystem(system)
+
+		myScheduler:run(myPhase)
+	end)
+
+	test("run condition", function()
+		expect.assertions(1)
+
+		local bool = true
+
+		local system = function(...)
+			expect({ ... }).toEqual({ 1, 2, 3 })
+		end
+
+		local myPhase = Phase.new("myPhase")
+		local myScheduler = Scheduler.new(1, 2, 3)
+			:insert(myPhase)
+			:addSystem(system, myPhase)
+			:addRunCondition(system, function()
+				return bool
+			end)
+
+		myScheduler:runAll()
+
+		bool = false
+		myScheduler:runAll() -- Expect system to not run
+	end)
+
+	test("multiple run conditions", function()
+		expect.assertions(1)
+
+		local firstCondition = true
+		local secondCondition = true
+
+		local system = function(...)
+			expect({ ... }).toEqual({ 1, 2, 3 })
+		end
+
+		local myPhase = Phase.new("myPhase")
+		local myScheduler = Scheduler.new(1, 2, 3)
+			:insert(myPhase)
+			:addSystem(system, myPhase)
+			:addRunCondition(system, function()
+				return firstCondition
+			end)
+			:addRunCondition(system, function()
+				return secondCondition
+			end)
+
+		firstCondition = false
+		myScheduler:runAll()
+
+		firstCondition = true
+		secondCondition = false
+		myScheduler:runAll()
+
+		firstCondition = false
+		secondCondition = false
+		myScheduler:runAll()
+
+		firstCondition = true
+		secondCondition = true
+		myScheduler:runAll() -- Expect to run
+	end)
+
+	test("yield", function()
+		expect.assertions(1)
+
+		local system = function()
+			wait(5)
+		end
+
+		local myPhase = Phase.new("myPhase")
+		local myScheduler =
+			Scheduler.new(1, 2, 3):insert(myPhase):addSystem(system, myPhase)
+
+		local err
+
+		myScheduler:addHook(
+			myScheduler.Hooks.SystemError,
+			function(context: SystemErrorContext)
+				if context.error then
+					err = context.error.log
+				end
+			end
+		)
+
+		myScheduler:runAll()
+		expect(err).toEqual(expect.stringContaining("System yielded"))
+	end)
+end)

package/src/conditions.d.ts

@@ -1,8 +1,11 @@
 import type { EventInstance, EventLike, ExtractEvents } from "./utils";
 
+/**
+ * If a Run Condition returns a falsy value (`nil`, `void`, `false`), the System/Phase/Pipeline will be prevented from running.
+ */
 export type Condition<T extends unknown[] = unknown[]> = (
   ...args: T
-) => boolean;
+) => unknown | void;
 
 /**
  * A Throttle condition which checks whether the amount of time given has passed

package/src/conditions.luau

@@ -1,5 +1,5 @@
 local utils = require(script.Parent.utils)
-local getConnectFunction = utils.getConnectFunction
+local getConnectFn = utils.getConnectFn
 
 type GenericTable = utils.GenericTable
 type SignalLike<U...> = utils.SignalLike<U...>
@@ -7,7 +7,7 @@ type ConnectionLike = utils.ConnectionLike
 type ConnectFn<T, U...> = utils.ConnectFn<T, U...>
 type Callback<U...> = utils.Callback<U...>
 
-type Condition = () -> boolean
+export type Condition<U...> = (U...) -> any
 
 --- @class Conditions
 ---
@@ -19,10 +19,11 @@ type Condition = () -> boolean
 ---
 --- A Throttle condition which checks whether the amount of
 --- time given has passed or not.
-local function timePassed(time: number): Condition
-	local storedTime
+local function timePassed<U...>(time: number): Condition<U...>
+	local storedTime: number?
 
-	return function()
+	-- selene: allow(unused_variable)
+	return function(...)
 		if storedTime == nil or os.clock() - storedTime >= time then
 			storedTime = os.clock()
 			return true
@@ -36,10 +37,11 @@ end
 --- @return hasRanOnce () -> boolean
 ---
 --- Checks whether the condition has been called once before
-local function runOnce(): Condition
+local function runOnce<U...>(): Condition<U...>
 	local hasRan = false
 
-	return function()
+	-- selene: allow(unused_variable)
+	return function(...)
 		if not hasRan then
 			hasRan = true
 			return true
@@ -53,7 +55,7 @@ type CollectEvents<U...> = () -> () -> (number, U...)
 
 local conditionToCleanupFn = {}
 
-local function cleanupCondition(condition: Condition)
+local function cleanupCondition(condition: Condition<...any>)
 	local cleanup = conditionToCleanupFn[condition]
 	if cleanup then
 		cleanup()
@@ -67,31 +69,31 @@ type OnEventFn =
 	-- RBXScriptSignal & nil
 	(<U...>(
 		RBXScriptSignal<U...>
-	) -> (Condition, CollectEvents<U...>, GetDisconnectFn))
+	) -> (Condition<U...>, CollectEvents<U...>, GetDisconnectFn))
 	-- Instance & RBXScriptSignal
 	-- Instance & string
 	& (<U...>(
 		Instance,
 		RBXScriptSignal<U...> | string
-	) -> (Condition, CollectEvents<U...>, GetDisconnectFn))
+	) -> (Condition<U...>, CollectEvents<U...>, GetDisconnectFn))
 	-- SignalLike & nil
 	& (<U...>(
 		SignalLike<U...>
-	) -> (Condition, CollectEvents<U...>, GetDisconnectFn))
+	) -> (Condition<U...>, CollectEvents<U...>, GetDisconnectFn))
 	-- table & string
 	& (<U...>(
 		GenericTable,
 		string
-	) -> (Condition, CollectEvents<U...>, GetDisconnectFn))
+	) -> (Condition<U...>, CollectEvents<U...>, GetDisconnectFn))
 	-- table & connectable method
 	& (<T, U...>(
 		GenericTable,
 		(GenericTable, Callback<U...>, ...any) -> T?
-	) -> (Condition, CollectEvents<U...>, GetDisconnectFn))
+	) -> (Condition<U...>, CollectEvents<U...>, GetDisconnectFn))
 	-- connectable function
 	& (<T, U...>(
 		(Callback<U...>, ...any) -> T?
-	) -> (Condition, CollectEvents<U...>, GetDisconnectFn))
+	) -> (Condition<U...>, CollectEvents<U...>, GetDisconnectFn))
 
 --- @within Conditions
 --- @param instance RBXScriptSignal | Instance | SignalLike<...any> | GenericTable | ((Callback<U...>,...any) -> ...any)
@@ -107,12 +109,13 @@ type OnEventFn =
 local function onEvent<U...>(
 	instance,
 	event
-): (Condition, CollectEvents<U...>, () -> () -> ())
-	local connect = getConnectFunction(instance, event)
+): (Condition<U...>, CollectEvents<U...>, (
+) -> () -> ())
+	local connect = getConnectFn(instance, event)
 	assert(connect, "Event passed to .onEvent is not valid")
 
 	local newEvent = false
-	local queue = {}
+	local queue: { { any } } = {}
 
 	local connection: ConnectionLike?
 
@@ -171,11 +174,10 @@ end
 --- @return inverseCondition () -> boolean
 ---
 --- Inverses a given condition.
-
 -- selene: allow(unused_variable)
-local function isNot(condition: Condition, ...: any): Condition
-	return function()
-		return not condition()
+local function isNot<U...>(condition: Condition<U...>, ...: unknown): Condition<U...>
+	return function(...)
+		return not condition(...)
 	end
 end