Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(trove): add metatable alternatives for Trackables #200

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(trove): add metatable alternatives for Trackables #200

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
88fc9f7
feat(trove): add metatable alternatives for Trackables
damondriscoll Jul 3, 2024
6e07aae
Merge remote-tracking branch 'upstream/main'
damondriscoll Jul 10, 2024
d6e87c1
Merge branch 'main' into main
damondriscoll Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 126 additions & 18 deletions modules/trove/init.luau
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@ export type Trove = {
Extend: (self: Trove) -> Trove,
Clone: <T>(self: Trove, instance: T & Instance) -> T,
Construct: <T, A...>(self: Trove, class: Constructable<T, A...>, A...) -> T,
Connect: (self: Trove, signal: SignalLike | RBXScriptSignal, fn: (...any) -> ...any) -> ConnectionLike,
Connect: (
self: Trove,
signal: SignalLike | SignalLikeMetatable | RBXScriptSignal,
fn: (...any) -> ...any
) -> ConnectionLike | ConnectionLikeMetatable,
BindToRenderStep: (self: Trove, name: string, priority: number, fn: (dt: number) -> ()) -> (),
AddPromise: <T>(self: Trove, promise: T & PromiseLike) -> T,
AddPromise: <T>(self: Trove, promise: (T & PromiseLike) | (T & PromiseLikeMetatable)) -> T,
Add: <T>(self: Trove, object: T & Trackable, cleanupMethod: string?) -> T,
Remove: <T>(self: Trove, object: T & Trackable) -> boolean,
Clean: (self: Trove) -> (),
Expand All @@ -25,20 +29,28 @@ type TroveInternal = Trove & {

--[=[
@within Trove
@type Trackable Instance | RBXScriptConnection | ConnectionLike | PromiseLike | thread | ((...any) -> ...any) | Destroyable | DestroyableLowercase | Disconnectable | DisconnectableLowercase
@type Trackable Instance | RBXScriptConnection | ConnectionLike | ConnectLikeMetatable | PromiseLike | PromiseLikeMetatable | thread | ((...any) -> ...any) | Destroyable | DestroyableMetatable | DestroyableLowercase | DestroyableLowercaseMetatable | Disconnectable | DisconnectableMetatable | DisconnectableLowercase | DisconnectableLowercaseMetatable | SignalLike | SignalLikeMetatable
Represents all trackable objects by Trove.
]=]
export type Trackable =
Instance
| RBXScriptConnection
| ConnectionLike
| ConnectionLikeMetatable
| PromiseLike
| PromiseLikeMetatable
| thread
| ((...any) -> ...any)
| Destroyable
| DestroyableMetatable
| DestroyableLowercase
| DestroyableLowercaseMetatable
| Disconnectable
| DisconectableMetatable
| DisconnectableLowercase
| DisconnectableLowercaseMetatable
| SignalLike
| SignalLikeMetatable

--[=[
@within Trove
Expand All @@ -51,17 +63,44 @@ type ConnectionLike = {
Disconnect: (self: ConnectionLike) -> (),
}

--[=[
@within Trove
@interface ConnectionLikeMetatable
.Connected boolean
.Disconnect (self) -> ()
@tag Metatable
]=]
type ConnectionLikeMetatable = typeof(setmetatable(
{},
{} :: { Connected: boolean, Disconnect: (self: ConnectionLikeMetatable) -> () }
))

--[=[
@within Trove
@interface SignalLike
.Connect (self, callback: (...any) -> ...any) -> ConnectionLike
.Once (self, callback: (...any) -> ...any) -> ConnectionLike
]=]
type SignalLike = {
Connect: (self: SignalLike, callback: (...any) -> ...any) -> ConnectionLike,
Once: (self: SignalLike, callback: (...any) -> ...any) -> ConnectionLike,
Connect: (self: SignalLike, callback: (...any) -> ...any) -> ConnectionLike | ConnectionLikeMetatable,
Once: (self: SignalLike, callback: (...any) -> ...any) -> ConnectionLike | ConnectionLikeMetatable,
}

--[=[
@within Trove
@interface SignalLikeMetatable
.Connect (self, callback: (...any) -> ...any) -> ConnectionLike
.Once (self, callback: (...any) -> ...any) -> ConnectionLike
@tag Metatable
]=]
type SignalLikeMetatable = typeof(setmetatable(
{},
{} :: {
Connect: (self: SignalLikeMetatable, callback: (...any) -> ...any) -> ConnectionLike | ConnectionLikeMetatable,
Once: (self: SignalLikeMetatable, callback: (...any) -> ...any) -> ConnectionLike | ConnectionLikeMetatable,
}
))

--[=[
@within Trove
@interface PromiseLike
Expand All @@ -71,10 +110,27 @@ type SignalLike = {
]=]
type PromiseLike = {
getStatus: (self: PromiseLike) -> string,
finally: (self: PromiseLike, callback: (...any) -> ...any) -> PromiseLike,
finally: (self: PromiseLike, callback: (...any) -> ...any) -> PromiseLike | PromiseLikeMetatable,
cancel: (self: PromiseLike) -> (),
}

--[=[
@within Trove
@interface PromiseLikeMetatable
.getStatus (self) -> string
.finally (self, callback: (...any) -> ...any) -> PromiseLike
.cancel (self) -> ()
@tag Metatable
]=]
type PromiseLikeMetatable = typeof(setmetatable(
{},
{} :: {
getStatus: (self: any) -> string,
finally: (self: PromiseLikeMetatable, callback: (...any) -> ...any) -> PromiseLike | PromiseLikeMetatable,
cancel: (self: PromiseLikeMetatable) -> (),
}
))

--[=[
@within Trove
@type Constructable { new: (A...) -> T } | (A...) -> T
Expand All @@ -84,30 +140,57 @@ type Constructable<T, A...> = { new: (A...) -> T } | (A...) -> T
--[=[
@within Trove
@interface Destroyable
.disconnect (self) -> ()
.Destroy (self) -> ()
]=]
type Destroyable = {
Destroy: (self: Destroyable) -> (),
}

--[=[
@within Trove
@interface DestroyableMetatable
.Destroy (self) -> ()
@tag Metatable
]=]
type DestroyableMetatable = typeof(setmetatable({}, {} :: { Destroy: (self: DestroyableMetatable) -> () }))

--[=[
@within Trove
@interface DestroyableLowercase
.disconnect (self) -> ()
.destroy (self) -> ()
]=]
type DestroyableLowercase = {
destroy: (self: DestroyableLowercase) -> (),
}

--[=[
@within Trove
@interface DestroyableLowercaseMetatable
.destroy (self) -> ()
@tag Metatable
]=]
type DestroyableLowercaseMetatable = typeof(setmetatable(
{},
{} :: { destroy: (self: DestroyableLowercaseMetatable) -> () }
))

--[=[
@within Trove
@interface Disconnectable
.disconnect (self) -> ()
.Disconnect (self) -> ()
]=]
type Disconnectable = {
Disconnect: (self: Disconnectable) -> (),
}

--[=[
@within Trove
@interface DisconectableMetatable
.Disconnect (self) -> ()
@tag Metatable
]=]
type DisconectableMetatable = typeof(setmetatable({}, {} :: { Disconnect: (self: DisconectableMetatable) -> () }))

--[=[
@within Trove
@interface DisconnectableLowercase
Expand All @@ -117,6 +200,17 @@ type DisconnectableLowercase = {
disconnect: (self: DisconnectableLowercase) -> (),
}

--[=[
@within Trove
@interface DisconnectableLowercaseMetatable
.disconnect (self) -> ()
@tag Metatable
]=]
type DisconnectableLowercaseMetatable = typeof(setmetatable(
{},
{} :: { disconnect: (self: DisconnectableLowercaseMetatable) -> () }
))

local FN_MARKER = newproxy()
local THREAD_MARKER = newproxy()
local GENERIC_OBJECT_CLEANUP_METHODS = table.freeze({ "Destroy", "Disconnect", "destroy", "disconnect" })
Expand Down Expand Up @@ -160,6 +254,12 @@ local function AssertPromiseLike(object: any)
end
end

local function AssertSignalLike(object: any)
if typeof(object) ~= "table" or typeof(object.Connect) ~= "function" or typeof(object.Once) ~= "function" then
error("did not receive a signal as an argument", 3)
end
end

--[=[
@class Trove
A Trove is helpful for tracking any sort of object during
Expand Down Expand Up @@ -280,7 +380,7 @@ end

If a function is given, the function will
be called with the given arguments.

The result from either of the two options
will be added to the trove.

Expand Down Expand Up @@ -333,12 +433,19 @@ end
end)
```
]=]
function Trove.Connect(self: TroveInternal, signal: SignalLike, fn: (...any) -> ...any)
function Trove.Connect(
self: TroveInternal,
signal: SignalLike | SignalLikeMetatable | RBXScriptSignal,
fn: (...any) -> ...any
)
if self._cleaning then
error("Cannot call trove:Connect() while cleaning", 2)
end
AssertSignalLike(signal)

local confirmedSignal = signal :: SignalLike

return self:Add(signal:Connect(fn))
return self:Add(confirmedSignal:Connect(fn))
end

--[=[
Expand Down Expand Up @@ -393,24 +500,25 @@ end
This is only compatible with the [roblox-lua-promise](https://eryn.io/roblox-lua-promise/) library, version 4.
:::
]=]
function Trove.AddPromise(self: TroveInternal, promise: PromiseLike)
function Trove.AddPromise(self: TroveInternal, promise: PromiseLike | PromiseLikeMetatable)
if self._cleaning then
error("cannot call trove:AddPromise() while cleaning", 2)
end
AssertPromiseLike(promise)
local confirmedPromise = promise :: PromiseLike

if promise:getStatus() == "Started" then
promise:finally(function()
if confirmedPromise:getStatus() == "Started" then
confirmedPromise:finally(function()
if self._cleaning then
return
end
self:_findAndRemoveFromObjects(promise, false)
self:_findAndRemoveFromObjects(confirmedPromise, false)
end)

self:Add(promise, "cancel")
self:Add(confirmedPromise, "cancel")
end

return promise
return confirmedPromise
end

--[=[
Expand Down