add gs

RCCService2020/ExtraContent/LuaPackages/AppTempCommon/LuaApp/Models/.robloxrc

@@ -0,0 +1,5 @@
+{
+	"language": {
+		"mode": "nonstrict"
+	}
+}

RCCService2020/ExtraContent/LuaPackages/AppTempCommon/LuaApp/Models/Thumbnail.lua

@@ -0,0 +1,39 @@
+--[[
+	{
+		universeId : string,
+		state : string,
+		url : string,
+	}
+]]
+
+local Thumbnail = {}
+
+function Thumbnail.new()
+	local self = {}
+
+	return self
+end
+
+function Thumbnail.fromThumbnailData(thumbnailData, size)
+	local self = Thumbnail.new()
+
+	self.universeId = tostring(thumbnailData.targetId)
+	self.state = thumbnailData.state
+	self.url = thumbnailData.imageUrl
+	self.size = size
+
+	return self
+end
+
+function Thumbnail.isCompleteThumbnailData(thumbnailData)
+	return type(thumbnailData) == "table"
+		and type(thumbnailData.targetId) == "number"
+		and type(thumbnailData.state) == "string"
+		and (type(thumbnailData.imageUrl) == "string" or thumbnailData.imageUrl == nil)
+end
+
+function Thumbnail.checkStateIsFinal(thumbnailState)
+	return thumbnailState ~= "Pending"
+end
+
+return Thumbnail

RCCService2020/ExtraContent/LuaPackages/AppTempCommon/LuaApp/Models/Thumbnail.spec.lua

@@ -0,0 +1,20 @@
+return function()
+	local Thumbnail = require(script.Parent.Thumbnail)
+
+	it("should set fields without errors", function()
+		local testData =
+		{
+			targetId = 123456,
+			state = "Completed",
+			imageUrl = "a url",
+		}
+
+		local thumbnail = Thumbnail.fromThumbnailData(testData)
+
+		expect(thumbnail).to.be.a("table")
+		expect(thumbnail.universeId).to.equal("123456")
+		expect(thumbnail.state).to.equal("Completed")
+		expect(thumbnail.url).to.equal("a url")
+	end)
+
+end

RCCService2020/ExtraContent/LuaPackages/AppTempCommon/LuaApp/Models/ThumbnailRequest.lua

@@ -0,0 +1,18 @@
+local ThumbnailRequest = {}
+
+function ThumbnailRequest.new()
+	local self = {}
+
+	return self
+end
+
+function ThumbnailRequest.fromData(thumbnailType, thumbnailSize)
+	local self = ThumbnailRequest.new()
+
+	self.thumbnailType = thumbnailType
+	self.thumbnailSize = thumbnailSize
+
+	return self
+end
+
+return ThumbnailRequest

RCCService2020/ExtraContent/LuaPackages/AppTempCommon/LuaApp/Models/User.lua

@@ -0,0 +1,134 @@
+local CorePackages = game:GetService("CorePackages")
+local Players = game:GetService("Players")
+
+local MockId = require(CorePackages.AppTempCommon.LuaApp.MockId)
+
+local User = {}
+
+User.PresenceType = {
+	OFFLINE = "OFFLINE",
+	ONLINE = "ONLINE",
+	IN_GAME = "IN_GAME",
+	IN_STUDIO = "IN_STUDIO",
+}
+
+function User.new()
+	local self = {}
+
+	return self
+end
+
+function User.mock()
+	local self = User.new()
+
+	self.id = MockId()
+
+	self.isFetching = false
+	self.isFriend = false
+	self.lastLocation = nil
+	self.name = "USER NAME"
+	self.universeId = nil
+	self.placeId = nil
+	self.rootPlaceId = nil
+	self.gameInstanceId = nil
+	self.presence = User.PresenceType.OFFLINE
+	self.membership = nil
+	self.thumbnails = nil
+	self.lastOnline = nil
+	self.displayName = "DN+" .. self.name
+
+	return self
+end
+
+-- Note: Going forward, leverage User.fromDataTable() instead.
+-- It accepts a more flexible parameter than User.fromData() and constructs the same User model
+function User.fromData(id, name, isFriend)
+	local self = User.new()
+
+	self.id = tostring(id)
+
+	self.isFetching = false
+	self.isFriend = isFriend
+	self.lastLocation = nil
+	self.name = name
+	self.universeId = nil
+	self.placeId = nil
+	self.rootPlaceId = nil
+	self.gameInstanceId = nil
+
+	self.presence = (Players.LocalPlayer and self.id == tostring(Players.LocalPlayer.UserId))
+		and User.PresenceType.ONLINE or nil
+	self.thumbnails = nil
+	self.lastOnline = nil
+
+	return self
+end
+
+function User.fromDataTable(data)
+	local self = User.new()
+
+	self.id = tostring(data.id)
+	self.isFriend = data.isFriend
+	self.presence = (Players.LocalPlayer
+		and self.id == tostring(Players.LocalPlayer.UserId)) and User.PresenceType.ONLINE or nil
+	self.isFetching = false
+	self.lastLocation = nil
+	self.name = data.name
+	self.displayName = data.displayName or data.name
+	self.universeId = nil
+	self.placeId = nil
+	self.rootPlaceId = nil
+	self.gameInstanceId = nil
+	self.thumbnails = nil
+	self.lastOnline = nil
+
+	return self
+end
+
+function User.compare(user1, user2)
+	assert(not(user1 == nil and user2 == nil))
+	assert(user1 == nil or typeof(user1) == "table")
+	assert(user2 == nil or typeof(user2) == "table")
+
+	-- Return false if any of the provided input is nil(empty).
+	if not user1 or not user2 then
+		return false
+	end
+
+	for field, valueInUser2 in pairs(user2) do
+		if user1[field] ~= valueInUser2 then
+			return false
+		end
+	end
+
+	for field, valueInUser1 in pairs(user1) do
+		if user2[field] ~= valueInUser1 then
+			return false
+		end
+	end
+
+	return true
+end
+
+function User.userPresenceToText(localization, user)
+	local presence = user.presence
+	local lastLocation = user.lastLocation
+
+	if not presence then
+		return ''
+	end
+
+	if presence == User.PresenceType.OFFLINE then
+		return localization:Format("Common.Presence.Label.Offline")
+	elseif presence == User.PresenceType.ONLINE then
+		return localization:Format("Common.Presence.Label.Online")
+	elseif (presence == User.PresenceType.IN_GAME) or (presence == User.PresenceType.IN_STUDIO) then
+		if lastLocation ~= nil then
+			return lastLocation
+		else
+			return localization:Format("Common.Presence.Label.Online")
+		end
+	end
+end
+
+return User

RCCService2020/ExtraContent/LuaPackages/AppTempCommon/LuaApp/Models/User.spec.lua

@@ -0,0 +1,98 @@
+return function()
+	local CorePackages = game:GetService("CorePackages")
+	local Immutable = require(CorePackages.AppTempCommon.Common.Immutable)
+	local User = require(CorePackages.AppTempCommon.LuaApp.Models.User)
+
+	it("should detect if provided users are identical", function()
+		local clone1 = User.fromData(1, "Andy", true)
+		local clone2 = Immutable.Set(clone1, "isFriend", true)
+
+		local result = User.compare(clone1, clone2)
+		expect(result).to.equal(true)
+
+		result = User.compare(clone2, clone1)
+		expect(result).to.equal(true)
+	end)
+
+	it("should detect when there is one or more fields with different values", function()
+		local andy = User.fromData(1, "Andy", true)
+		local ollie = Immutable.Set(andy, "name", "Ollie")
+
+		local result = User.compare(andy, ollie)
+		expect(result).to.equal(false)
+
+		result = User.compare(ollie, andy)
+		expect(result).to.equal(false)
+	end)
+
+	it("should detect descrepancy when one user model contains more fields than the other", function()
+		local andy = User.fromData(1, "Andy", true)
+		local secretlyNotAndy = Immutable.Set(andy, "someDifferentField", "I'm Ollie!")
+
+		local result = User.compare(andy, secretlyNotAndy)
+		expect(result).to.equal(false)
+
+		result = User.compare(secretlyNotAndy, andy)
+		expect(result).to.equal(false)
+	end)
+
+	it("should throw if invalid input is provided", function()
+		local aString = "I'm not a table."
+		local teddy = User.fromData(1, "Teddy", true)
+
+		expect(function() User.compare(nil, nil) end).to.throw()
+		expect(function() User.compare(aString, nil) end).to.throw()
+		expect(function() User.compare(nil, aString) end).to.throw()
+		expect(function() User.compare(aString, aString) end).to.throw()
+		expect(function() User.compare(teddy, aString) end).to.throw()
+		expect(function() User.compare(aString, teddy) end).to.throw()
+	end)
+
+	it("should return false if any one of the input is empty or nil)", function()
+		local emptyTable = {}
+		local teddy = User.fromData(1, "Teddy", true)
+
+		local result = User.compare(teddy, nil)
+		expect(result).to.equal(false)
+
+		result = User.compare(nil, teddy)
+		expect(result).to.equal(false)
+
+		result = User.compare(teddy, emptyTable)
+		expect(result).to.equal(false)
+
+		result = User.compare(emptyTable, teddy)
+		expect(result).to.equal(false)
+	end)
+
+	describe("fromDataTable", function()
+		it("should properly set user data", function()
+			local data = {
+				id = 1,
+				name = "FooBar",
+				displayName = "FooBar+DN",
+				isFriend = false,
+			}
+			local user = User.fromDataTable(data)
+
+			expect(user.id).to.equal("1")
+			expect(user.name).to.equal("FooBar")
+			expect(user.displayName).to.equal("FooBar+DN")
+			expect(user.isFriend).to.equal(false)
+		end)
+
+		it("should still set user data without a displayName property", function()
+			local data = {
+				id = 1,
+				name = "FooBar",
+				isFriend = false,
+			}
+			local user = User.fromDataTable(data)
+
+			expect(user.id).to.equal("1")
+			expect(user.name).to.equal("FooBar")
+			expect(user.displayName).to.equal("FooBar")
+			expect(user.isFriend).to.equal(false)
+		end)
+	end)
+end