Add in impl for easily mocking roblox classes in lune

libs/pagesutil/init.luau

@@ -1,4 +1,3 @@
---!optimize 2
 
 -- pagesutil
 -- utility for dealing with roblox page instancs easily
@@ -9,9 +8,15 @@ export type PageInfo = {
 	page: number,
 }
 
-local advance_to_next_page_err_format = "[PAGES] an error occurred while trying to advance to the next page\n\tadvance-next-page-err: %s"
+local ADVANCE_ERR_FORMAT = "[PAGES] an error occurred while trying to advance to the next page\
+\tadvance-next-page-err: %s"
 
-local function iter(pages: Pages, f: (info: PageInfo, item: { [any]: any }) -> ("continue" | "break")?)
+local pagesutil = {}
+
+function pagesutil.iter(
+	pages: Pages,
+	f: (info: PageInfo, item: { [any]: any }) -> ("continue" | "break")?
+)
 	local advance_to_next_page = pages.AdvanceToNextPageAsync
 	local page = pages:GetCurrentPage()
 	local page_info = {
@@ -51,14 +56,14 @@ local function iter(pages: Pages, f: (info: PageInfo, item: { [any]: any }) -> (
 					end
 				end
 			else
-				warn(string.format(advance_to_next_page_err_format, err))
+				warn(string.format(ADVANCE_ERR_FORMAT, err))
 				return
 			end
 		until pages.IsFinished
 	end
 end
 
-local function toarray(pages: Pages): { { [any]: any } }
+function pagesutil.toarray(pages: Pages): { { [any]: any } }
 	local advance_to_next_page = pages.AdvanceToNextPageAsync
 	local contents = pages:GetCurrentPage()
 
@@ -70,15 +75,12 @@ local function toarray(pages: Pages): { { [any]: any } }
 				local current_page = pages:GetCurrentPage()
 				table.move(current_page, 1, #current_page, #contents + 1, contents)
 			else
-				warn(string.format(advance_to_next_page_err_format, err))
+				warn(string.format(ADVANCE_ERR_FORMAT, err))
 				break
 			end
 		until pages.IsFinished
 	end
 	return contents
 end
 
-return table.freeze {
-	toarray = toarray,
-	iter = iter,
-}
+return table.freeze(pagesutil)

scripts/mock/roblox/impl.luau

@@ -0,0 +1,150 @@
+
+-- impl
+-- a wrapper for easily implementing properties and methods
+-- in lune to mock roblox stuffs
+
+local roblox = require("@lune/roblox")
+
+type GenericInstance<I> = roblox.Instance & I
+
+type PropertySetter<I, P> = (instance: GenericInstance<I>, new_value: unknown) -> P
+
+type ImplPrototype<I> = {
+	rwprop: (<P>(self: Impl<I>, name: string, setter: PropertySetter<I, P>, default: P) -> Impl<I>) &
+		(<P>(self: Impl<I>, name: string, default: P) -> Impl<I>),
+	rprop: <P>(self: Impl<I>, name: string, default: P) -> Impl<I>,
+	method: <A..., R...>(self: Impl<I>, name: string, f: (instance: GenericInstance<I>, A...) -> R...) -> Impl<I>,
+	__index: ImplPrototype<I>,
+}
+
+export type Impl<I> = typeof(setmetatable({} :: {
+	propstores: { [string]: { [GenericInstance<I>]: any } },
+	name: string,
+}, {} :: ImplPrototype<I>))
+
+local CANNOT_SET_ERR_FORMAT = "[IMPL] cannot set property \"%s\" on class \"%s\" to a value that isn't of type \"%s?\""
+local CLASSES_IMPLEMENTED = {} :: { [string]: boolean }
+
+local function rwprop<I, P, D>(
+	impl: Impl<I>,
+	propname: string,
+	default_or_setter: P | PropertySetter<I, P>,
+	default: P
+): Impl<I>
+	local propstores = impl.propstores
+	local classname = impl.name
+	local propstore = {}
+
+	propstores[propname] = propstore
+
+	if type(default_or_setter) == "function" and default then
+		roblox.implementProperty(
+			classname, 
+			propname,
+			function(instance: any)
+				local value = propstore[instance]
+
+				if value then
+					return value
+				else
+					propstore[instance] = default
+					return default
+				end
+			end,
+			function(instance: any, new_value)
+				local new_value = default_or_setter(instance, new_value)
+				propstore[instance] = new_value
+			end
+		)
+	else
+		local type = typeof(default_or_setter)
+		local cannot_set_err = string.format(
+			CANNOT_SET_ERR_FORMAT, propname, 
+			classname, type
+		)
+
+		roblox.implementProperty(
+			classname, 
+			propname,
+			function(instance: any)
+				local value = propstore[instance]
+
+				if value then
+					return value
+				else
+					propstore[instance] = default_or_setter
+					return default_or_setter
+				end
+			end,
+			function(instance: any, new_value)
+				if typeof(new_value) == type then
+					propstore[instance] = new_value
+				elseif new_value == nil then
+					propstore[instance] = nil
+				else
+					error(cannot_set_err)
+				end
+			end
+		)
+	end
+	return impl
+end
+
+local function rprop<I, P, D>(
+	impl: Impl<I>,
+	propname: string,
+	default: P
+): Impl<I>
+	local propstores = impl.propstores
+	local classname = impl.name
+	local propstore = {}
+
+	propstores[propname] = propstore
+
+	roblox.implementProperty(
+		classname, 
+		propname,
+		function(instance: any)
+			local value = propstore[instance]
+
+			if value then
+				return value
+			else
+				propstore[instance] = default
+				return default
+			end
+		end
+	)
+	return impl
+end
+
+local function method<I, P, A..., R...>(
+	impl: Impl<I>, 
+	method_name: string, 
+	f: (instance: GenericInstance<I>, A...) -> R...
+): Impl<I>
+	roblox.implementMethod(impl.name, method_name, f :: any)
+	return impl
+end
+
+local impl = {
+	method = method,
+	rwprop = rwprop,
+	rprop = rprop,
+}
+impl.__index = impl
+table.freeze(impl)
+
+local function create<I>(name: string): Impl<I>
+	if CLASSES_IMPLEMENTED[name] then
+		error(`[IMPL] class "{name}" has already been implemented`)
+	end
+	CLASSES_IMPLEMENTED[name] = true
+
+	return table.freeze(setmetatable({
+		propstores = {},
+		name = name,
+	}, impl :: any))
+end
+
+return create

scripts/mock/roblox/services/analytics.luau

@@ -0,0 +1,7 @@
+
+-- analytics
+-- implements a mock analytics service for lune
+
+local impl = require("../impl")
+
+return impl("AnalyticsService")

scripts/mock/roblox/services/collection.luau

@@ -0,0 +1,7 @@
+
+-- collection
+-- implements a mock collection service for lune
+
+local impl = require("../impl")
+
+return impl("CollectionService")

scripts/mock/roblox/services/datastore.luau

@@ -0,0 +1,7 @@
+
+-- datastore
+-- implements a mock datastore service for lune
+
+local impl = require("../impl")
+
+return impl("DatastoreService")

scripts/mock/roblox/services/http.luau

@@ -2,11 +2,8 @@
 -- httpservice
 -- implements a mock http service for lune
 
-local roblox = require("@lune/roblox")
 local net = require("@lune/net")
+local impl = require("../impl")
 
-
-
-local function impl_mock_http()
-
-end
+return impl("HttpService")
+	:rwprop("HttpEnabled", false)

scripts/mock/roblox/services/players.luau

@@ -0,0 +1,10 @@
+
+-- players
+-- implements a mock players service for lune
+
+local impl = require("../impl")
+
+return impl("Players")
+	:method("GetPlayers", function(players)
+		return players:GetChildren()
+	end)