@quenty/tie 10.6.0 → 10.7.0

package/src/Shared/Definition/Types/TieRealmUtils.lua

@@ -1,60 +0,0 @@
---[=[
-	@class TieRealmUtils
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local RunService = game:GetService("RunService")
-local TieRealms = require("TieRealms")
-
-local TieRealmUtils = {}
-
-function TieRealmUtils.isRequired(tieRealm)
-	if tieRealm == TieRealms.CLIENT then
-		-- Hack: TODO: Maybe we should contextualize the realm throughout all callers.
-		-- But otherwise, we'll need to do this
-		if not RunService:IsRunning() then
-			return false
-		end
-
-		return RunService:IsClient()
-	elseif tieRealm == TieRealms.SERVER then
-		-- Hack: TODO: Maybe we should contextualize the realm throughout all callers.
-		-- But otherwise, we'll need to do this
-		if not RunService:IsRunning() then
-			return false
-		end
-
-		return RunService:IsServer()
-	elseif tieRealm == TieRealms.SHARED then
-		return true
-	else
-		error("Unknown tieRealm")
-	end
-end
-
-function TieRealmUtils.isAllowed(tieRealm)
-	if tieRealm == TieRealms.CLIENT then
-		-- Hack: TODO: Maybe we should contextualize the realm throughout all callers.
-		-- But otherwise, we'll need to do this
-		if not RunService:IsRunning() then
-			return true
-		end
-
-		return RunService:IsClient()
-	elseif tieRealm == TieRealms.SERVER then
-		-- Hack: TODO: Maybe we should contextualize the realm throughout all callers.
-		-- But otherwise, we'll need to do this
-		if not RunService:IsRunning() then
-			return true
-		end
-
-		return RunService:IsServer()
-	elseif tieRealm == TieRealms.SHARED then
-		return true
-	else
-		error("Unknown tieRealm")
-	end
-end
-
-return TieRealmUtils

package/src/Shared/Implementation/TieImplementation.lua

@@ -1,129 +0,0 @@
---[=[
-	This class represents the implementation for a given definition. For the lifetime
-	of the class, this implementation will be exposed to consumption by both someone
-	using the tie interface, and anyone invoking its methods via the normal Roblox API.
-
-	@class TieImplementation
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local BaseObject = require("BaseObject")
-local TieRealms = require("TieRealms")
-
-local TieImplementation = setmetatable({}, BaseObject)
-TieImplementation.ClassName = "TieImplementation"
-TieImplementation.__index = TieImplementation
-
-function TieImplementation.new(tieDefinition, adornee, implementer)
-	local self = setmetatable(BaseObject.new(), TieImplementation)
-
-	self._definition = assert(tieDefinition, "No definition")
-	self._adornee = assert(adornee, "No adornee")
-	self._actualSelf = implementer or {}
-
-	self._folder = self._maid:Add(Instance.new("Folder"))
-	self._folder.Archivable = false
-
-	self._memberImplementations = {}
-	self._memberMap = self._definition:GetMemberMap()
-
-	self:_buildMemberImplementations(implementer)
-
-	self._folder.Parent = self._adornee
-
-	return self
-end
-
-function TieImplementation:GetFolder()
-	return self._folder
-end
-
-function TieImplementation:__index(index)
-	if TieImplementation[index] then
-		return TieImplementation[index]
-	end
-
-	if index == "_folder"
-		or index == "_adornee"
-		or index == "_definition"
-		or index == "_memberImplementations"
-		or index == "_memberMap"
-		or index == "_actualSelf" then
-
-		return rawget(self, index)
-	end
-
-	local memberMap = rawget(self, "_memberMap")
-	local memberDefinition = memberMap[index]
-	if memberDefinition then
-		if memberDefinition:IsAllowed() then
-			return memberDefinition:GetInterface(self._folder, self)
-		else
-			error(string.format("%q is not a valid member", tostring(index)))
-		end
-	else
-		error(string.format("Bad index %q for TieImplementation", tostring(index)))
-	end
-end
-
-function TieImplementation:__newindex(index, value)
-	if index == "_folder"
-		or index == "_adornee"
-		or index == "_definition"
-		or index == "_memberImplementations"
-		or index == "_memberMap"
-		or index == "_actualSelf" then
-
-		rawset(self, index, value)
-	elseif self._memberImplementations[index] then
-		self._memberImplementations[index]:SetImplementation(value, self._actualSelf)
-	elseif TieImplementation[index] then
-		error(string.format("Cannot set %q in TieImplementation", tostring(index)))
-	else
-		error(string.format("Bad index %q for TieImplementation", tostring(index)))
-	end
-end
-
-function TieImplementation:_buildMemberImplementations(implementer)
-	local allClientImplemented = true
-
-	for _, memberDefinition in pairs(self._memberMap) do
-		if not memberDefinition:IsAllowed() then
-			if memberDefinition:GetTieRealm() == TieRealms.CLIENT then
-				allClientImplemented = false
-			end
-			continue
-		end
-
-		local initialValue
-		if implementer then
-			local memberName = memberDefinition:GetMemberName()
-			initialValue = implementer[memberName]
-			if not initialValue then
-				if memberDefinition:IsRequired() then
-					error(string.format("Missing member %q on %q", memberName, self._adornee:GetFullName()))
-				else
-					if memberDefinition:GetTieRealm() == TieRealms.CLIENT then
-						allClientImplemented = false
-					end
-					continue
-				end
-			end
-		else
-			initialValue = nil
-		end
-
-		local memberImplementation = self._maid:Add(memberDefinition:Implement(self._folder, initialValue, self._actualSelf))
-		self._memberImplementations[memberDefinition:GetMemberName()] = memberImplementation
-	end
-
-	-- Hack to make server objects look like server
-	if allClientImplemented then
-		self._folder.Name = self._definition:GetContainerName()
-	else
-		self._folder.Name = self._definition:GetContainerNameForServer()
-	end
-end
-
-return TieImplementation

package/src/Shared/Interface/TieInterface.lua

@@ -1,122 +0,0 @@
---[=[
-	@class TieInterface
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local TieSignalInterface = require("TieSignalInterface")
-local TiePropertyInterface = require("TiePropertyInterface")
-local TieMethodInterfaceUtils = require("TieMethodInterfaceUtils")
-
-local TieInterface = {}
-TieInterface.ClassName = "TieInterface"
-TieInterface.__index = TieInterface
-
-function TieInterface.new(definition, folder, adornee)
-	local self = setmetatable({}, TieInterface)
-
-	assert(folder or adornee, "Folder or adornee required")
-
-	self._definition = assert(definition, "No definition")
-	self._folder = folder -- could be nil
-	self._adornee = adornee -- could be nil
-	self._memberDefinitionMap = self._definition:GetMemberMap()
-
-	return self
-end
-
---[=[
-	Returns whether this version of the definition is implemented to standard or not.
-
-	@return boolean
-]=]
-function TieInterface:IsImplemented()
-	local folder = rawget(self, "_folder")
-	local adornee = rawget(self, "_adornee")
-	local definition = rawget(self, "_definition")
-
-	if folder then
-		if adornee then
-			if folder.Parent ~= adornee then
-				return false
-			end
-
-			if folder.Name ~= self:GetContainerName() then
-				return false
-			end
-		end
-
-		return definition:IsImplementation(folder)
-	end
-
-	return definition:HasImplementation(adornee)
-end
-
---[=[
-	Gets the adornee the tie interface is on if it can be found.
-
-	@return Instance | nil
-]=]
-function TieInterface:GetTieAdornee()
-	local adornee = rawget(self, "_adornee")
-	if adornee then
-		return adornee
-	end
-
-	local folder = rawget(self, "_folder")
-	if folder then
-		return folder.Parent
-	end
-
-	return nil
-end
-
---[=[
-	@return Observable<boolean>
-]=]
-function TieInterface:ObserveIsImplemented()
-	local folder = rawget(self, "_folder")
-	local adornee = rawget(self, "_adornee")
-	local definition = rawget(self, "_definition")
-
-	if folder then
-		if adornee then
-			return definition:ObserveIsImplementationOn(folder, adornee)
-		else
-			return definition:ObserveIsImplementation(folder)
-		end
-	end
-
-	return definition:ObserveIsImplemented(adornee)
-end
-
-function TieInterface:__index(index)
-	local member = rawget(self, "_memberDefinitionMap")[index]
-	local definition = rawget(self, "_definition")
-	if member and member:IsAllowed() then
-		if member.ClassName == "TieMethodDefinition" then
-			local adornee = rawget(self, "_adornee")
-			local folder = rawget(self, "_folder")
-
-			return TieMethodInterfaceUtils.get(self, definition, member, folder, adornee)
-		elseif member.ClassName == "TieSignalDefinition" then
-			local adornee = rawget(self, "_adornee")
-			local folder = rawget(self, "_folder")
-
-			return TieSignalInterface.new(folder, adornee, member)
-		elseif member.ClassName == "TiePropertyDefinition" then
-			local adornee = rawget(self, "_adornee")
-			local folder = rawget(self, "_folder")
-
-			return TiePropertyInterface.new(folder, adornee, member)
-		else
-			error(string.format("Unknown member definition %q", tostring(member.ClassName)))
-		end
-	elseif TieInterface[index] then
-		return TieInterface[index]
-	else
-		error(string.format("Bad %q is not a member of %s", tostring(index), definition:GetContainerName()))
-	end
-end
-
-return TieInterface

package/src/Shared/Interface/TieInterfaceUtils.lua

@@ -1,70 +0,0 @@
---[=[
-	@class TieInterfaceUtils
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local RxInstanceUtils = require("RxInstanceUtils")
-local Rx = require("Rx")
-local RxBrioUtils = require("RxBrioUtils")
-
-local TieInterfaceUtils = {}
-
-function TieInterfaceUtils.observeFolderBrio(tieDefinition, folder, adornee)
-	if folder and adornee then
-		local containerName = tieDefinition:GetContainerName()
-		return Rx.combineLatest({
-			Parent = RxInstanceUtils.observeProperty(folder, "Parent");
-			Name = RxInstanceUtils.observeProperty(folder, "Name");
-		})
-		:Pipe({
-			Rx.map(function(state)
-				if state.Name == containerName and state.Parent == adornee then
-					return folder
-				else
-					return nil
-				end
-			end);
-			Rx.distinct();
-			RxBrioUtils.toBrio();
-			RxBrioUtils.onlyLastBrioSurvives();
-		})
-	elseif folder then
-		local containerName = tieDefinition:GetContainerName()
-		return RxInstanceUtils.observePropertyBrio(folder, "Name", function(name)
-			return name == containerName
-		end):Pipe({
-			RxBrioUtils.map(function()
-				return folder
-			end);
-		})
-	elseif adornee then
-		local containerName = tieDefinition:GetContainerName()
-		return RxInstanceUtils.observeLastNamedChildBrio(adornee, "Folder", containerName)
-	else
-		error("No folder or adornee")
-	end
-end
-
-function TieInterfaceUtils.getFolder(tieDefinition, folder, adornee)
-	if folder and adornee then
-		if folder.Parent == adornee and folder.Name == tieDefinition:GetContainerName() then
-			return folder
-		else
-			return nil
-		end
-	elseif folder then
-		if folder.Name == tieDefinition:GetContainerName() then
-			return folder
-		else
-			return nil
-		end
-	elseif adornee then
-		local folderName = tieDefinition:GetContainerName()
-		return adornee:FindFirstChild(folderName)
-	else
-		error("Must have folder or adornee")
-	end
-end
-
-return TieInterfaceUtils

package/src/Shared/Interface/TieMethodInterfaceUtils.lua

@@ -1,43 +0,0 @@
---[=[
-	@class TieMethodInterfaceUtils
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local TieUtils = require("TieUtils")
-
-local TieMethodInterfaceUtils = {}
-
-function TieMethodInterfaceUtils.get(aliasSelf, definition, member, folder, adornee)
-	return function(firstArg, ...)
-		if firstArg ~= aliasSelf then
-			error(("Must call methods with self as first parameter (Hint use `%s:%s()` instead of `%s.%s()`)"):format(
-				definition:GetName(),
-				member:GetMemberName(),
-				definition:GetName(),
-				member:GetMemberName()))
-		end
-
-		if folder and adornee then
-			if folder.Parent ~= adornee then
-				error("Folder is not a parent of the adornee")
-			end
-		elseif folder then
-			folder = folder
-		elseif adornee then
-			folder = adornee:FindFirstChild(definition:GetContainerName())
-			if not folder then
-				error("No folder")
-			end
-		end
-
-		local bindableFunction = folder:FindFirstChild(member:GetMemberName())
-		if not bindableFunction then
-			error(string.format("No bindableFunction implemented for %s on %q", member:GetMemberName(), folder:GetFullName()))
-		end
-
-		return TieUtils.decode(bindableFunction:Invoke(TieUtils.encode(...)))
-	end;
-end
-
-return TieMethodInterfaceUtils

package/src/Shared/Interface/TieSignalConnection.lua

@@ -1,89 +0,0 @@
---[=[
-	@class TieSignalConnection
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local Maid = require("Maid")
-local TieInterfaceUtils = require("TieInterfaceUtils")
-local RxBrioUtils = require("RxBrioUtils")
-local RxInstanceUtils = require("RxInstanceUtils")
-local TieUtils = require("TieUtils")
-
-local TieSignalConnection = {}
-TieSignalConnection.ClassName = "TieSignalConnection"
-TieSignalConnection.__index = TieSignalConnection
-
-function TieSignalConnection.new(memberDefinition, folder, adornee, callback)
-	local self = setmetatable({}, TieSignalConnection)
-
-	assert(folder or adornee, "Folder or adornee required")
-
-	self._maid = Maid.new()
-
-	self._memberDefinition = assert(memberDefinition, "No memberDefinition")
-	self._folder = folder
-	self._adornee = adornee
-	self._callback = assert(callback, "No callback")
-
-	self._connected = true
-	self._tieDefinition = self._memberDefinition:GetTieDefinition()
-
-	self:_connect()
-
-	return self
-end
-
-function TieSignalConnection:Disconnect()
-	self:Destroy()
-end
-
-function TieSignalConnection:_connect()
-	self._maid:GiveTask(self:_observeBindableEvent():Subscribe(function(brio)
-		if brio:IsDead() then
-			return
-		end
-
-		local maid = brio:ToMaid()
-		local bindableEvent = brio:GetValue()
-
-		maid:GiveTask(bindableEvent.Event:Connect(function(...)
-			task.spawn(self._callback, TieUtils.decode(...))
-		end))
-	end))
-end
-
-function TieSignalConnection:_observeFolderBrio()
-	return TieInterfaceUtils.observeFolderBrio(self._tieDefinition, self._folder, self._adornee)
-end
-
-function TieSignalConnection:_observeBindableEvent()
-	local name = self._memberDefinition:GetMemberName()
-
-	return self:_observeFolderBrio():Pipe({
-		RxBrioUtils.switchMapBrio(function(folder)
-			return RxInstanceUtils.observeLastNamedChildBrio(folder, "BindableEvent", name)
-		end);
-		RxBrioUtils.onlyLastBrioSurvives();
-	})
-end
-
-function TieSignalConnection:__index(index)
-	if index == "_adornee" or index == "_folder" then
-		return rawget(self, index)
-	elseif index == "IsConnected" then
-		return self._connected
-	elseif TieSignalConnection[index] then
-		return TieSignalConnection[index]
-	else
-		error(("Bad index %q for TieSignalConnection"):format(tostring(index)))
-	end
-end
-
-function TieSignalConnection:Destroy()
-	self._connected = false
-	self._maid:DoCleaning()
-	-- Avoid setting the metatable so calling methods is always valid
-end
-
-return TieSignalConnection

package/src/Shared/Interface/TieSignalInterface.lua

@@ -1,61 +0,0 @@
---[=[
-	@class TieSignalInterface
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local TieSignalConnection = require("TieSignalConnection")
-local TieUtils = require("TieUtils")
-local TieInterfaceUtils = require("TieInterfaceUtils")
-
-local TieSignalInterface = {}
-TieSignalInterface.ClassName = "TieSignalInterface"
-TieSignalInterface.__index = TieSignalInterface
-
-function TieSignalInterface.new(folder, adornee, memberDefinition)
-	local self = setmetatable({}, TieSignalInterface)
-
-	assert(folder or adornee, "Folder or adornee required")
-
-	self._folder = folder
-	self._adornee = adornee
-	self._memberDefinition = assert(memberDefinition, "No memberDefinition")
-	self._tieDefinition = self._memberDefinition:GetTieDefinition()
-
-	return self
-end
-
-function TieSignalInterface:Fire(...)
-	local bindableEvent = self:_getBindableEvent()
-	if not bindableEvent then
-		warn(("[TieSignalInterface] - No bindableEvent for %q"):format(self._memberDefinition:GetMemberName()))
-	end
-
-	bindableEvent:Fire(TieUtils.encode(...))
-end
-
-function TieSignalInterface:Connect(callback)
-	assert(type(callback) == "function", "Bad callback")
-
-	return TieSignalConnection.new(self._memberDefinition, self._folder, self._adornee, callback)
-end
-
-function TieSignalInterface:_getBindableEvent()
-	local folder = self:_getFolder()
-	if not folder then
-		return nil
-	end
-
-	local implementation = folder:FindFirstChild(self._memberDefinition:GetMemberName())
-	if implementation and implementation:IsA("BindableEvent") then
-		return implementation
-	else
-		return nil
-	end
-end
-
-function TieSignalInterface:_getFolder()
-	return TieInterfaceUtils.getFolder(self._tieDefinition, self._folder, self._adornee)
-end
-
-return TieSignalInterface