@quenty/blend 2.2.0 → 2.3.0

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/blend@2.2.1...@quenty/blend@2.3.0) (2022-01-17)
+
+
+### Features
+
+* Add a SpringObject to blend, which is a much heavier object than a spring, but simplifies API usage significantly ([cb59db0](https://github.com/Quenty/NevermoreEngine/commit/cb59db0ed4297ecec842b0820a485e1aa0c8ad70))
+* Add Blend.Attached and fix children not being unsubscribed correctly (memory leak fix) ([f4fa4c2](https://github.com/Quenty/NevermoreEngine/commit/f4fa4c2ebce9be6e16a7ab1492afaf87fe81b8aa))
+
+
+
+
+
+## [2.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/blend@2.2.0...@quenty/blend@2.2.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/blend
+
+
+
+
+
 # [2.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/blend@2.1.1...@quenty/blend@2.2.0) (2022-01-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/blend",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Declarative UI system.",
   "keywords": [
     "Roblox",
@@ -27,23 +27,23 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/acceltween": "^2.0.1",
-    "@quenty/brio": "^3.7.0",
-    "@quenty/instanceutils": "^3.7.0",
-    "@quenty/loader": "^3.3.0",
-    "@quenty/maid": "^2.0.2",
-    "@quenty/promise": "^3.5.0",
-    "@quenty/rx": "^3.7.0",
+    "@quenty/acceltween": "^2.1.0",
+    "@quenty/brio": "^3.8.0",
+    "@quenty/instanceutils": "^3.8.0",
+    "@quenty/loader": "^3.4.0",
+    "@quenty/maid": "^2.1.0",
+    "@quenty/promise": "^3.6.0",
+    "@quenty/rx": "^3.8.0",
     "@quenty/signal": "^2.1.0",
-    "@quenty/spring": "^3.2.0",
+    "@quenty/spring": "^3.3.0",
     "@quenty/steputils": "^3.0.1",
     "@quenty/string": "^2.2.1",
-    "@quenty/valuebaseutils": "^3.7.0",
-    "@quenty/valueobject": "^3.7.0"
+    "@quenty/valuebaseutils": "^3.8.0",
+    "@quenty/valueobject": "^3.8.0"
   },
   "devDependencies": {
-    "@quenty/contentproviderutils": "^3.5.0",
-    "@quenty/playerthumbnailutils": "^3.6.0"
+    "@quenty/contentproviderutils": "^3.6.0",
+    "@quenty/playerthumbnailutils": "^3.7.0"
   },
-  "gitHead": "5a3f3fb6c908fd3874f5ceacc70b404780275119"
+  "gitHead": "c094ba8f4e128cdff08919d89de226d3d65247ce"
 }

package/src/Shared/Blend/Blend.lua

@@ -9,9 +9,11 @@ local AccelTween = require("AccelTween")
 local BlendDefaultProps = require("BlendDefaultProps")
 local Brio = require("Brio")
 local Maid = require("Maid")
+local MaidTaskUtils = require("MaidTaskUtils")
 local Observable = require("Observable")
 local Promise = require("Promise")
 local Rx = require("Rx")
+local BrioUtils = require("BrioUtils")
 local RxInstanceUtils = require("RxInstanceUtils")
 local RxValueBaseUtils = require("RxValueBaseUtils")
 local Signal = require("Signal")
@@ -21,8 +23,6 @@ local StepUtils = require("StepUtils")
 local ValueBaseUtils = require("ValueBaseUtils")
 local ValueObject = require("ValueObject")
 local ValueObjectUtils = require("ValueObjectUtils")
-local MaidTaskUtils = require("MaidTaskUtils")
-local RxBrioUtils = require("RxBrioUtils")
 
 local Blend = {}
 
@@ -114,9 +114,9 @@ end
 		return verb .. " " .. name
 	end)
 
-	computed:Subscribe(function(sentence)
+	maid:GiveTask(computed:Subscribe(function(sentence)
 		print(sentence)
-	end) --> "hi alice"
+	end)) --> "hi alice"
 
 	nameState.Value = "bob" --> "hi bob"
 	verbState.Value = "bye" --> "bye bob"
@@ -212,6 +212,30 @@ function Blend.OnEvent(eventName)
 	end
 end
 
+--[=[
+	Uses the constructor to attach a class or resource to the actual object
+	for the lifetime of the subscription of that object.
+	@param constructor T
+	@return (parent: Instance) -> Observable<T>
+]=]
+function Blend.Attached(constructor)
+	return function(parent)
+		return Observable.new(function(sub)
+			local maid = Maid.new()
+
+			local resource = constructor(parent)
+
+			if MaidTaskUtils.isValidTask(resource) then
+				maid:GiveTask(resource)
+			end
+
+			sub:Fire(resource)
+
+			return maid
+		end)
+	end;
+end
+
 --[=[
 	Similiar to Fusion's ComputedPairs, where the changes are cached, and the lifetime limited.
 	@param source Observable<T> | any
@@ -427,7 +451,7 @@ end
 function Blend.toEventObservable(value)
 	if Observable.isObservable(value) then
 		return value
-	elseif typeof(value) == "RBXScriptSignal" then
+	elseif typeof(value) == "RBXScriptSignal" or Signal.isSignal(value) then
 		return Rx.fromSignal(value)
 	else
 		return nil
@@ -451,7 +475,11 @@ function Blend.toEventHandler(value)
 			end
 		end
 	elseif type(value) == "table" then
-		if value.ClassName == "ValueObject" then
+		if Signal.isSignal(value) then
+			return function(...)
+				value:Fire(...)
+			end
+		elseif value.ClassName == "ValueObject" then
 			return function(result)
 				value.Value = result
 			end
@@ -520,6 +548,48 @@ function Blend.Children(parent, value)
 	end
 end
 
+--[=[
+	An event emitter that emits the instance that was actually created. This is
+	useful for a variety of things.
+
+	Using this to track an instance
+
+	```lua
+	local currentCamera = Blend.State()
+
+	return Blend.New "ViewportFrame" {
+		CurrentCamera = currentCamera;
+		[Blend.Children] = {
+			self._current;
+			Blend.New "Camera" {
+				[Blend.Instance] = currentCamera;
+			};
+		};
+	};
+	```
+
+	You can also use this to execute code against an instance.
+
+	```lua
+	return Blend.New "Frame" {
+		[Blend.Instance] = function(frame)
+			print("We got a new frame!")
+		end;
+	};
+	```
+
+	Note that if you subscribe twice to the resulting observable, the internal function
+	will execute twice.
+
+	@param parent Instance
+	@return Observable<Instance>
+]=]
+function Blend.Instance(parent)
+	return Observable.new(function(sub)
+		sub:Fire(parent)
+	end)
+end
+
 --[=[
 	Ensures the computed version of a value is limited by lifetime instead
 	of multiple. Used in conjunction with [Blend.Children] and [Blend.Computed].
@@ -532,7 +602,7 @@ end
 	Blend.New "ScreenGui" {
 		Parent = game.Players.LocalPlayer.PlayerGui;
 		[Blend.Children] = {
-			Blend.Single(percentVisible, Blend.Computed(function()
+			Blend.Single(Blend.Computed(percentVisible, function()
 				-- you generally would not want to do this anyway because this reconstructs a new frame
 				-- every frame.
 
@@ -550,7 +620,28 @@ end
 	@return Observable<Brio<Instance>>
 	@within Blend
 ]=]
-Blend.Single = RxBrioUtils.switchToBrio
+function Blend.Single(observable)
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		maid:GiveTask(observable:Subscribe(function(result)
+			if Brio.isBrio(result) then
+				local copy = BrioUtils.clone(result)
+				maid._current = copy
+				sub:Fire(copy)
+				return copy
+			end
+
+			local current = Brio.new(result)
+			maid._current = current
+			sub:Fire(current)
+
+			return current
+		end))
+
+		return maid
+	end)
+end
 
 --[=[
 	Observes children and ensures that the value is cleaned up
@@ -676,7 +767,7 @@ function Blend._observeChildren(value)
 		return Observable.new(function(sub)
 			local maid = Maid.new()
 
-			value:Subscribe(function(result)
+			maid:GiveTask(value:Subscribe(function(result)
 				if typeof(result) == "Instance" then
 					-- lifetime of subscription
 					maid:GiveTask(result)
@@ -710,7 +801,7 @@ function Blend._observeChildren(value)
 				sub:Fire(...)
 			end, function()
 				-- Drop completion, other inner components may have completed.
-			end)
+			end))
 
 			return maid
 		end)

package/src/Shared/Blend/BlendDefaultProps.lua

@@ -29,109 +29,103 @@ SOFTWARE.
 
 ]]
 
-local ENABLE_SENSIBLE_DEFAULTS = true
-
-if ENABLE_SENSIBLE_DEFAULTS then
-	return {
-		ScreenGui = {
-			ResetOnSpawn = false,
-			ZIndexBehavior = "Sibling"
-		},
-
-		BillboardGui = {
-			ResetOnSpawn = false,
-			ZIndexBehavior = "Sibling"
-		},
-
-		SurfaceGui = {
-			ResetOnSpawn = false,
-			ZIndexBehavior = "Sibling",
-
-			SizingMode = "PixelsPerStud",
-			PixelsPerStud = 50
-		},
-
-		Frame = {
-			BackgroundColor3 = Color3.new(1, 1, 1),
-			BorderColor3 = Color3.new(0, 0, 0),
-			BorderSizePixel = 0
-		},
-
-		ScrollingFrame = {
-			BackgroundColor3 = Color3.new(1, 1, 1),
-			BorderColor3 = Color3.new(0, 0, 0),
-			BorderSizePixel = 0,
-
-			ScrollBarImageColor3 = Color3.new(0, 0, 0)
-		},
-
-		TextLabel = {
-			BackgroundColor3 = Color3.new(1, 1, 1),
-			BorderColor3 = Color3.new(0, 0, 0),
-			BorderSizePixel = 0,
-
-			Font = "SourceSans",
-			Text = "",
-			TextColor3 = Color3.new(0, 0, 0),
-			TextSize = 14
-		},
-
-		TextButton = {
-			BackgroundColor3 = Color3.new(1, 1, 1),
-			BorderColor3 = Color3.new(0, 0, 0),
-			BorderSizePixel = 0,
-
-			AutoButtonColor = false,
-
-			Font = "SourceSans",
-			Text = "",
-			TextColor3 = Color3.new(0, 0, 0),
-			TextSize = 14
-		},
-
-		TextBox = {
-			BackgroundColor3 = Color3.new(1, 1, 1),
-			BorderColor3 = Color3.new(0, 0, 0),
-			BorderSizePixel = 0,
-
-			ClearTextOnFocus = false,
-
-			Font = "SourceSans",
-			Text = "",
-			TextColor3 = Color3.new(0, 0, 0),
-			TextSize = 14
-		},
-
-		ImageLabel = {
-			BackgroundColor3 = Color3.new(1, 1, 1),
-			BorderColor3 = Color3.new(0, 0, 0),
-			BorderSizePixel = 0
-		},
-
-		ImageButton = {
-			BackgroundColor3 = Color3.new(1, 1, 1),
-			BorderColor3 = Color3.new(0, 0, 0),
-			BorderSizePixel = 0,
-
-			AutoButtonColor = false
-		},
-
-		ViewportFrame = {
-			BackgroundColor3 = Color3.new(1, 1, 1),
-			BorderColor3 = Color3.new(0, 0, 0),
-			BorderSizePixel = 0
-		},
-
-		VideoFrame = {
-			BackgroundColor3 = Color3.new(1, 1, 1),
-			BorderColor3 = Color3.new(0, 0, 0),
-			BorderSizePixel = 0
-		},
-
-		UIListLayout = {
-			SortOrder = Enum.SortOrder.LayoutOrder;
-		},
-	}
-else
-	return {}
-end
+return {
+	ScreenGui = {
+		ResetOnSpawn = false,
+		ZIndexBehavior = "Sibling"
+	},
+
+	BillboardGui = {
+		ResetOnSpawn = false,
+		ZIndexBehavior = "Sibling"
+	},
+
+	SurfaceGui = {
+		ResetOnSpawn = false,
+		ZIndexBehavior = "Sibling",
+
+		SizingMode = "PixelsPerStud",
+		PixelsPerStud = 50
+	},
+
+	Frame = {
+		BackgroundColor3 = Color3.new(1, 1, 1),
+		BorderColor3 = Color3.new(0, 0, 0),
+		BorderSizePixel = 0
+	},
+
+	ScrollingFrame = {
+		BackgroundColor3 = Color3.new(1, 1, 1),
+		BorderColor3 = Color3.new(0, 0, 0),
+		BorderSizePixel = 0,
+
+		ScrollBarImageColor3 = Color3.new(0, 0, 0)
+	},
+
+	TextLabel = {
+		BackgroundColor3 = Color3.new(1, 1, 1),
+		BorderColor3 = Color3.new(0, 0, 0),
+		BorderSizePixel = 0,
+
+		Font = "SourceSans",
+		Text = "",
+		TextColor3 = Color3.new(0, 0, 0),
+		TextSize = 14
+	},
+
+	TextButton = {
+		BackgroundColor3 = Color3.new(1, 1, 1),
+		BorderColor3 = Color3.new(0, 0, 0),
+		BorderSizePixel = 0,
+
+		AutoButtonColor = false,
+
+		Font = "SourceSans",
+		Text = "",
+		TextColor3 = Color3.new(0, 0, 0),
+		TextSize = 14
+	},
+
+	TextBox = {
+		BackgroundColor3 = Color3.new(1, 1, 1),
+		BorderColor3 = Color3.new(0, 0, 0),
+		BorderSizePixel = 0,
+
+		ClearTextOnFocus = false,
+
+		Font = "SourceSans",
+		Text = "",
+		TextColor3 = Color3.new(0, 0, 0),
+		TextSize = 14
+	},
+
+	ImageLabel = {
+		BackgroundColor3 = Color3.new(1, 1, 1),
+		BorderColor3 = Color3.new(0, 0, 0),
+		BorderSizePixel = 0
+	},
+
+	ImageButton = {
+		BackgroundColor3 = Color3.new(1, 1, 1),
+		BorderColor3 = Color3.new(0, 0, 0),
+		BorderSizePixel = 0,
+
+		AutoButtonColor = false
+	},
+
+	ViewportFrame = {
+		BackgroundColor3 = Color3.new(1, 1, 1),
+		BorderColor3 = Color3.new(0, 0, 0),
+		BorderSizePixel = 0
+	},
+
+	VideoFrame = {
+		BackgroundColor3 = Color3.new(1, 1, 1),
+		BorderColor3 = Color3.new(0, 0, 0),
+		BorderSizePixel = 0
+	},
+
+	UIListLayout = {
+		SortOrder = Enum.SortOrder.LayoutOrder;
+	},
+}

package/src/Shared/Blend/SpringObject.lua

@@ -0,0 +1,227 @@
+--[=[
+	@class SpringObject
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RunService= game:GetService("RunService")
+
+local Spring = require("Spring")
+local Maid = require("Maid")
+local Signal = require("Signal")
+local StepUtils = require("StepUtils")
+local Observable = require("Observable")
+local SpringUtils = require("SpringUtils")
+local Blend = require("Blend")
+local Rx = require("Rx")
+
+local SpringObject = {}
+SpringObject.ClassName = "SpringObject"
+SpringObject.__index = SpringObject
+
+--[=[
+	Constructs a new SpringObject.
+	@param target T
+	@param speed number | Observable<number> | ValueObject<number> | NumberValue | any
+	@param damper number | Observable<number> | NumberValue | any
+	@return Spring<T>
+]=]
+function SpringObject.new(target, speed, damper)
+	local self = setmetatable({
+		_maid = Maid.new();
+		Changed = Signal.new();
+	}, SpringObject)
+
+--[=[
+	Event fires when the spring value changes
+	@prop Changed Signal<()> -- Fires whenever the spring initially changes state
+	@within ValueObject
+]=]
+	self._maid:GiveTask(self.Changed)
+
+	if target then
+		self.Target = target
+	else
+		self:_getSpringForType(0)
+	end
+
+	if speed then
+		self.Speed = speed
+	end
+
+	if damper then
+		self.Damper = damper
+	end
+
+	return self
+end
+
+--[=[
+	Returns whether an object is a SpringObject.
+	@param value any
+	@return boolean
+]=]
+function SpringObject.isSpringObject(value)
+	return type(value) == "table" and getmetatable(value) == SpringObject
+end
+
+--[=[
+	Observes the spring animating
+	@return Observable<T>
+]=]
+function SpringObject:ObserveRenderStepped()
+	return self:ObserveOnSignal(RunService.RenderStepped)
+end
+
+--[=[
+	Observes the spring animating
+	@param signal RBXScriptSignal
+	@return Observable<T>
+]=]
+function SpringObject:ObserveOnSignal(signal)
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		local startAnimate, stopAnimate = StepUtils.bindToSignal(signal, function()
+			local animating, position = SpringUtils.animating(self._currentSpring)
+			sub:Fire(SpringUtils.fromLinearIfNeeded(position))
+			return animating
+		end)
+
+		maid:GiveTask(stopAnimate)
+		maid:GiveTask(self.Changed:Connect(startAnimate))
+		startAnimate()
+
+		return maid
+	end)
+
+end
+
+--[=[
+	Impulses the spring, increasing velocity by the amount given. This is useful to make something shake,
+	like a Mac password box failing.
+
+	@param velocity T -- The velocity to impulse with
+	@return ()
+]=]
+function SpringObject:Impulse(velocity)
+	self._currentSpring:Impulse(SpringUtils.toLinearIfNeeded(velocity))
+	self.Changed:Fire()
+end
+
+--[=[
+	Instantly skips the spring forwards by that amount time
+	@param delta number -- Time to skip forwards
+	@return ()
+]=]
+function SpringObject:TimeSkip(delta)
+	assert(type(delta) == "number", "Bad delta")
+
+	self._currentSpring:TimeSkip(delta)
+	self.Changed:Fire()
+end
+
+function SpringObject:__index(index)
+	if index == "Value" or index == "Position" or index == "p" then
+		return SpringUtils.fromLinearIfNeeded(self._currentSpring.Value)
+	elseif index == "Velocity" or index == "v" then
+		return SpringUtils.fromLinearIfNeeded(self._currentSpring.Velocity)
+	elseif index == "Target" or index == "t" then
+		return SpringUtils.fromLinearIfNeeded(self._currentSpring.Target)
+	elseif index == "Damper" or index == "d" then
+		return self._currentSpring.Damper
+	elseif index == "Speed" or index == "s" then
+		return self._currentSpring.Speed
+	elseif index == "Clock" then
+		return self._currentSpring.Clock
+	elseif SpringObject[index] then
+		return SpringObject[index]
+	else
+		error(("%q is not a member of SpringObject"):format(tostring(index)))
+	end
+end
+
+function SpringObject:__newindex(index, value)
+	if index == "Value" or index == "Position" or index == "p" then
+		local observable = Blend.toPropertyObservable(value) or Rx.of(value)
+
+		self._maid._valueSub = observable:Subscribe(function(unconverted)
+			local converted = SpringUtils.toLinearIfNeeded(unconverted)
+			self:_getSpringForType(converted).Value = converted
+			self.Changed:Fire()
+		end)
+	elseif index == "Velocity" or index == "v" then
+		local observable = Blend.toPropertyObservable(value) or Rx.of(value)
+
+		self._maid._velocitySub = observable:Subscribe(function(unconverted)
+			local converted = SpringUtils.toLinearIfNeeded(unconverted)
+
+			self:_getSpringForType(0*converted).Velocity = converted
+			self.Changed:Fire()
+		end)
+	elseif index == "Target" or index == "t" then
+		local observable = Blend.toPropertyObservable(value) or Rx.of(value)
+
+		self._maid._targetSub = observable:Subscribe(function(unconverted)
+			local converted = SpringUtils.toLinearIfNeeded(unconverted)
+			self:_getSpringForType(converted).Target = converted
+
+			self.Changed:Fire()
+		end)
+	elseif index == "Damper" or index == "d" then
+		local observable = assert(Blend.toNumberObservable(value), "Invalid damper")
+
+		self._maid._damperSub = observable:Subscribe(function(unconverted)
+			assert(type(unconverted) == "number", "Bad damper")
+
+			self._currentSpring.Damper = unconverted
+			self.Changed:Fire()
+		end)
+	elseif index == "Speed" or index == "s" then
+		local observable = assert(Blend.toNumberObservable(value), "Invalid speed")
+
+		self._maid._speedSub = observable:Subscribe(function(unconverted)
+			assert(type(unconverted) == "number", "Bad damper")
+
+			self._currentSpring.Speed = unconverted
+			self.Changed:Fire()
+		end)
+	elseif index == "Clock" then
+		assert(type(value) == "function", "Bad clock value")
+		self._currentSpring.Clock = value
+		self.Changed:Fire()
+	else
+		error(("%q is not a member of SpringObject"):format(tostring(index)))
+	end
+end
+
+function SpringObject:_getSpringForType(converted)
+	if rawget(self, "_currentSpring") == nil then
+		-- only happens on init
+		rawset(self, "_currentSpring", Spring.new(converted))
+		return self._currentSpring
+	else
+		local currentType = typeof(SpringUtils.fromLinearIfNeeded(self._currentSpring.Value))
+		if currentType == typeof(converted) then
+			return self._currentSpring
+		else
+			local oldDamper = self._currentSpring.d
+			local oldSpeed = self._currentSpring.s
+
+			self._currentSpring = Spring.new(converted)
+			self._currentSpring.Speed = oldSpeed
+			self._currentSpring.Damper = oldDamper
+			return self._currentSpring
+		end
+	end
+end
+
+--[=[
+	Cleans up the BaseObject and sets the metatable to nil
+]=]
+function SpringObject:Destroy()
+	self._maid:DoCleaning()
+	setmetatable(self, nil)
+end
+
+return SpringObject

package/src/Shared/Test/BlendSingle.story.lua

@@ -0,0 +1,45 @@
+--[[
+	@class BlendSingle.story
+]]
+
+local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).load(script)
+
+local Maid = require("Maid")
+local Observable = require("Observable")
+local Blend = require("Blend")
+
+return function(target)
+	local maid = Maid.new()
+
+	local state = Blend.State("a")
+
+	local result = Blend.Single(Blend.Dynamic(state, function(text)
+		return Blend.New "TextLabel" {
+			Parent = target;
+			Text = text;
+			Size = UDim2.new(1, 0, 1, 0);
+			BackgroundTransparency = 0.5;
+			[function()
+				return Observable.new(function()
+					local internal = Maid.new()
+
+					print("Made for", text)
+					internal:GiveTask(function()
+						print("Cleaning up", text)
+					end)
+
+					return internal
+				end)
+			end] = true;
+		}
+	end))
+
+
+	maid:GiveTask(result:Subscribe())
+
+	state.Value = "b"
+
+	return function()
+		maid:DoCleaning()
+	end
+end

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

@@ -1,5 +1,6 @@
--- Main injection point
--- @script ServerMain
+--[[
+	@class ServerMain
+]]
 
 local ServerScriptService = game:GetService("ServerScriptService")