@quenty/tie 10.6.0 → 10.7.0

package/src/Shared/TieImplementation.lua

@@ -0,0 +1,167 @@
+--[=[
+	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 TieRealmUtils = require("TieRealmUtils")
+local TieRealms = require("TieRealms")
+local String = require("String")
+
+local TieImplementation = setmetatable({}, BaseObject)
+TieImplementation.ClassName = "TieImplementation"
+TieImplementation.__index = TieImplementation
+
+function TieImplementation.new(tieDefinition, adornee, implementer, implementationTieRealm)
+	assert(TieRealmUtils.isTieRealm(implementationTieRealm), "Bad implementationTieRealm")
+
+	local self = setmetatable(BaseObject.new(), TieImplementation)
+
+	self._tieDefinition = assert(tieDefinition, "No definition")
+	self._adornee = assert(adornee, "No adornee")
+	self._actualSelf = implementer or {}
+	self._implementationTieRealm = assert(implementationTieRealm, "Bad implementationTieRealm")
+
+	self._implParent = self._maid:Add(Instance.new(tieDefinition:GetImplClass()))
+	self._implParent.Archivable = false
+
+	self._memberImplementations = {}
+	self._memberMap = self._tieDefinition:GetMemberMap()
+
+	self:_buildMemberImplementations(implementer)
+
+	self._implParent.Parent = self._adornee
+
+	return self
+end
+
+function TieImplementation:GetImplementationTieRealm()
+	return self._implementationTieRealm
+end
+
+function TieImplementation:GetImplParent()
+	return self._implParent
+end
+
+function TieImplementation:__index(index)
+	if TieImplementation[index] then
+		return TieImplementation[index]
+	end
+
+	if index == "_implParent"
+		or index == "_adornee"
+		or index == "_tieDefinition"
+		or index == "_memberImplementations"
+		or index == "_implementationTieRealm"
+		or index == "_memberMap"
+		or index == "_actualSelf" then
+
+		return rawget(self, index)
+	end
+
+	local memberMap = rawget(self, "_memberMap")
+	local memberDefinition = memberMap[index]
+	local implementationTieRealm = rawget(self, "_implementationTieRealm")
+
+	if memberDefinition then
+		if memberDefinition:IsAllowedForImplementation(self._implementationTieRealm) then
+			return memberDefinition:GetInterface(self._implParent, self, implementationTieRealm)
+		else
+			error(string.format("[TieImplementation] - %q is not available on %s", memberDefinition:GetFriendlyName(), self._implementationTieRealm))
+		end
+	else
+		error(string.format("Bad index %q for TieImplementation", tostring(index)))
+	end
+end
+
+function TieImplementation:__newindex(index, value)
+	if index == "_implParent"
+		or index == "_adornee"
+		or index == "_tieDefinition"
+		or index == "_memberImplementations"
+		or index == "_implementationTieRealm"
+		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)
+	for _, memberDefinition in pairs(self._memberMap) do
+		local memberName = memberDefinition:GetMemberName()
+		local found = nil
+
+		if implementer then
+			found = implementer[memberName]
+		end
+
+		if memberDefinition:IsRequiredForImplementation(self._implementationTieRealm) then
+			if not found then
+				error(self:_getErrorMessageRequiredMember(memberDefinition))
+			end
+		end
+
+		if found then
+			if not memberDefinition:IsAllowedForImplementation(self._implementationTieRealm) then
+				error(self:_getErrorMessageForNotAllowedMember(memberDefinition))
+			end
+		end
+
+		local memberImplementation = self._maid:Add(memberDefinition:Implement(self._implParent, found, self._actualSelf, self._implementationTieRealm))
+		self._memberImplementations[memberDefinition:GetMemberName()] = memberImplementation
+	end
+
+	self._implParent.Name = self._tieDefinition:GetNewContainerName(self._implementationTieRealm)
+end
+
+function TieImplementation:_getErrorMessageForNotAllowedMember(memberDefinition)
+	local errorMessage = string.format("[TieImplementation] - Member implements %s only member %s (we are a %s implementation)",
+		memberDefinition:GetMemberTieRealm(),
+		memberDefinition:GetFriendlyName(),
+		self._implementationTieRealm)
+
+	if self._implementationTieRealm == TieRealms.SHARED then
+		if memberDefinition:GetMemberTieRealm() ~= TieRealms.SHARED then
+			errorMessage = string.format("%s\n\tHINT: This is declared as a %s implementation. %s is only allowed on %s.",
+				errorMessage,
+				self._implementationTieRealm,
+				memberDefinition:GetFriendlyName(),
+				memberDefinition:GetMemberTieRealm())
+		end
+	end
+
+	return errorMessage
+end
+
+function TieImplementation:_getErrorMessageRequiredMember(memberDefinition)
+	local errorMessage = string.format("[TieImplementation] - Missing %s member %s (we are a %s implementation)",
+		memberDefinition:GetMemberTieRealm(),
+		memberDefinition:GetFriendlyName(),
+		self._implementationTieRealm)
+
+	if self._implementationTieRealm == TieRealms.SHARED then
+		if memberDefinition:GetMemberTieRealm() ~= TieRealms.SHARED then
+			errorMessage = string.format("%s\n\tHINT: This is declared as a %s implementation. Shared implements require both client and server components. You could also specify the implementation realm by writing %sInterface.%s:Implement(...)",
+				errorMessage,
+				self._implementationTieRealm,
+				self._tieDefinition:GetName(),
+				String.uppercaseFirstLetter(memberDefinition:GetMemberTieRealm()))
+		end
+	end
+
+	return errorMessage
+end
+
+return TieImplementation

package/src/Shared/TieInterface.lua

@@ -0,0 +1,129 @@
+--[=[
+	Tie interfaces can be retrieved from an implementation and allow access to a specific call into the interface
+
+	@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, implParent, adornee, interfaceTieRealm)
+	local self = setmetatable({}, TieInterface)
+
+	assert(implParent or adornee, "ImplParent or adornee required")
+
+	self._definition = assert(definition, "No definition")
+	self._interfaceTieRealm = assert(interfaceTieRealm, "No interfaceTieRealm")
+	self._implParent = implParent -- 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 implParent = rawget(self, "_implParent")
+	local adornee = rawget(self, "_adornee")
+	local definition = rawget(self, "_definition")
+	local interfaceTieRealm = rawget(self, "_interfaceTieRealm")
+
+	if implParent then
+		if adornee then
+			if implParent.Parent ~= adornee then
+				return false
+			end
+
+			if definition:GetValidContainerNameSet(interfaceTieRealm)[implParent.Name] then
+				return false
+			end
+		end
+
+		return definition:IsImplementation(implParent, interfaceTieRealm)
+	end
+
+	return definition:HasImplementation(adornee, interfaceTieRealm)
+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 implParent = rawget(self, "_implParent")
+	if implParent then
+		return implParent.Parent
+	end
+
+	return nil
+end
+
+--[=[
+	Observes if the interface is implemented
+
+	@return Observable<boolean>
+]=]
+function TieInterface:ObserveIsImplemented()
+	local implParent = rawget(self, "_implParent")
+	local adornee = rawget(self, "_adornee")
+	local definition = rawget(self, "_definition")
+	local interfaceTieRealm = rawget(self, "_interfaceTieRealm")
+
+	if implParent then
+		if adornee then
+			return definition:ObserveIsImplementationOn(implParent, adornee, interfaceTieRealm)
+		else
+			return definition:ObserveIsImplementation(implParent, interfaceTieRealm)
+		end
+	end
+
+	return definition:ObserveIsImplemented(adornee, interfaceTieRealm)
+end
+
+function TieInterface:__index(index)
+	local interfaceTieRealm = rawget(self, "_interfaceTieRealm")
+
+	local member = rawget(self, "_memberDefinitionMap")[index]
+	local definition = rawget(self, "_definition")
+	local adornee = rawget(self, "_adornee")
+	local implParent = rawget(self, "_implParent")
+
+	if member then
+		if member:IsAllowedOnInterface(interfaceTieRealm) then
+			if member.ClassName == "TieMethodDefinition" then
+				return TieMethodInterfaceUtils.get(self, member, implParent, adornee, interfaceTieRealm)
+			elseif member.ClassName == "TieSignalDefinition" then
+				return TieSignalInterface.new(implParent, adornee, member, interfaceTieRealm)
+			elseif member.ClassName == "TiePropertyDefinition" then
+				return TiePropertyInterface.new(implParent, adornee, member, interfaceTieRealm)
+			else
+				error(string.format("Unknown member definition %q", tostring(member.ClassName)))
+			end
+		else
+			error(string.format("[TieInterface] - %s is not allowed in realm '%s'. Specify realm to %s.", member:GetFriendlyName(), interfaceTieRealm, member:GetMemberTieRealm()))
+		end
+	elseif TieInterface[index] then
+		return TieInterface[index]
+	else
+		error(string.format("[TieInterface] - Bad %q is not a member of %s", tostring(index), definition:GetName()))
+	end
+end
+
+return TieInterface

package/src/Shared/{Encoding → Utils}/TieUtils.lua

@@ -14,7 +14,10 @@ function TieUtils.encode(...)
 	local results = table.pack(...)
 
 	for i=1, results.n do
-		if type(results[i]) == "table" or type(results[i])  == "function" then
+		if type(results[i]) == "table"
+			or type(results[i])  == "function"
+			or typeof(results[i]) == "userdata" then -- newproxy() symbols
+
 			local saved = results[i]
 			results[i] = function()
 				return saved -- Pack into a callback so we can transfer data.

package/test/modules/Server/Action/Action.lua

@@ -15,18 +15,15 @@ Action.__index = Action
 function Action.new(obj)
 	local self = setmetatable(BaseObject.new(obj), Action)
 
-	self.Activated = Signal.new()
-	self._maid:GiveTask(self.Activated)
+	self.Activated = self._maid:Add(Signal.new())
 
-	self.DisplayName = Instance.new("StringValue")
+	self.DisplayName = self._maid:Add(Instance.new("StringValue"))
 	self.DisplayName.Value = "Action"
-	self._maid:GiveTask(self.DisplayName)
 
-	self.IsEnabled = Instance.new("BoolValue")
+	self.IsEnabled = self._maid:Add(Instance.new("BoolValue"))
 	self.IsEnabled.Value = false
-	self._maid:GiveTask(self.IsEnabled)
 
-	self._maid:GiveTask(ActionInterface:Implement(self._obj, self))
+	self._maid:GiveTask(ActionInterface.Server:Implement(self._obj, self))
 
 	return self
 end

package/test/modules/Server/Door.lua

@@ -17,20 +17,15 @@ Door.__index = Door
 function Door.new(obj)
 	local self = setmetatable(BaseObject.new(obj), Door)
 
-	self.Opening = Signal.new()
-	self._maid:GiveTask(self.Opening)
+	self.Opening = self._maid:Add(Signal.new())
+	self.Closing = self._maid:Add(Signal.new())
 
-	self.Closing = Signal.new()
-	self._maid:GiveTask(self.Closing)
-
-	self.IsOpen = Instance.new("BoolValue")
+	self.IsOpen = self._maid:Add(Instance.new("BoolValue"))
 	self.IsOpen.Value = false
-	self._maid:GiveTask(self.IsOpen)
 
-	self.LastPromise = ValueObject.new()
-	self._maid:GiveTask(self.LastPromise)
+	self.LastPromise = self._maid:Add(ValueObject.new())
 
-	self._maid:GiveTask(OpenableInterface:Implement(self._obj, self))
+	self._maid:GiveTask(OpenableInterface.Server:Implement(self._obj, self))
 
 	return self
 end

package/test/scripts/Server/ServerMain.server.lua

@@ -25,7 +25,7 @@ if DO_DOOR_WINDOW_TEST then
 	window.Parent = workspace
 	Window.new(window)
 
-	local doorInterface = OpenableInterface:Get(door)
+	local doorInterface = OpenableInterface:Find(door)
 	doorInterface.Opening:Connect(function()
 		print("Opening event fired")
 	end)
@@ -47,7 +47,7 @@ if DO_DOOR_WINDOW_TEST then
 	doorInterface:PromiseClose()
 
 	print("door:IsImplemented()", doorInterface:IsImplemented())
-	print("door:IsImplemented()", OpenableInterface:Get(workspace):IsImplemented())
+	print("door:IsImplemented()", OpenableInterface:Find(workspace) ~= nil)
 
 	door.Openable.PromiseOpen:Invoke()():Then(function()
 		print("Opened promise resolved")
@@ -73,7 +73,7 @@ do
 
 	-- Implement via interface calls
 	do
-		local thrust = ActionInterface:Implement(adornee)
+		local thrust = ActionInterface.Server:Implement(adornee)
 		-- thrust:GetFolder().Name = "Action_Thrust"
 		thrust.DisplayName.Value = "Thrust"