cluaupp 0.1.0

package/runtime/FormatNumber/_impl/Simple/init.lua

@@ -0,0 +1,76 @@
+-- Configuration
+-- The suffixes for abbreviation in every power of thousands.
+local COMPACT_SUFFIX = {
+	"K", "M", "B", "T", "Qa", "Qi", "Sx", "Sp", "Oc", "No",
+}
+local CACHED_SKELETON_SETTINGS = true
+--
+
+local MainAPI = require(script.Parent.Main)
+local FormatNumberSimpleAPI = { }
+
+local SKELETON_CACHE = if CACHED_SKELETON_SETTINGS then { } else nil
+local COMPACT_SKELETON_CACHE = if CACHED_SKELETON_SETTINGS then { } else nil
+
+function FormatNumberSimpleAPI.Format(value: number, skeleton: string?): string
+	local success
+	local formatter = nil
+
+	assert(type(value) == "number", "Value provided must be a number")
+
+	if skeleton == nil then
+		skeleton = ""
+	end
+	assert(type(skeleton) == "string", "Skeleton provided must be a string")
+
+	if CACHED_SKELETON_SETTINGS then
+		formatter = SKELETON_CACHE[skeleton]
+	end
+
+	if not formatter then
+		success, formatter =
+			MainAPI.NumberFormatter.forSkeleton(skeleton)
+		assert(success, formatter :: string)
+
+		if CACHED_SKELETON_SETTINGS then
+			SKELETON_CACHE[skeleton] = formatter
+		end
+	end
+
+	return (formatter :: MainAPI.NumberFormatter):Format(value)
+end
+
+function FormatNumberSimpleAPI.FormatCompact(value: number, skeleton: string?): string
+	local success
+	local formatter = nil
+
+	assert(type(value) == "number", "Value provided must be a number")
+
+	if skeleton == nil then
+		skeleton = ""
+	end
+	assert(type(skeleton) == "string", "Skeleton provided must be a string")
+
+	if CACHED_SKELETON_SETTINGS then
+		formatter = COMPACT_SKELETON_CACHE[skeleton]
+	end
+
+	if not formatter then
+		success, formatter =
+			MainAPI.NumberFormatter.forSkeleton(skeleton)
+		assert(success, formatter :: string)
+
+		formatter = (formatter :: MainAPI.NumberFormatter)
+			:Notation(MainAPI.Notation.compactWithSuffixThousands(COMPACT_SUFFIX))
+
+		if CACHED_SKELETON_SETTINGS then
+			COMPACT_SKELETON_CACHE[skeleton] = formatter
+		end
+	end
+
+	assert(#COMPACT_SUFFIX ~= 0, "Please provide the suffix abbreviations for FormatCompact at the top of the Simple ModuleScript")
+
+	return formatter:Format(value)
+end
+
+return table.freeze(FormatNumberSimpleAPI)

package/runtime/FormatNumber/_impl/Version.lua

@@ -0,0 +1,82 @@
+--[[
+FormatNumber
+Version 31.1
+BSD 2-Clause Licence
+Copyright 2022 - Blockzez (https://devforum.roblox.com/u/Blockzez and https://github.com/Blockzez)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+]]
+local FormatNumberVersion = { }
+export type FormatNumberVersion = {
+	Major: number,
+	Minor: number,
+}
+
+local function version_tostring(self)
+	return string.format("%d.%d", self.Major, self.Minor)
+end
+
+local function version_lt(lhs, rhs)
+	return if lhs.Major == rhs.Major
+	then lhs.Minor < rhs.Minor
+	else lhs.Major < rhs.Major
+end
+
+local function version_eq(lhs, rhs)
+	return lhs.Major == rhs.Major and lhs.Minor == rhs.Minor
+end
+
+local function double_to_int32(value: number): number
+	-- relying on UDim.new integer conversion semantic
+	-- if you get weird behaviour for values out of the int32 range
+	-- or you put the wrong value in, it's on you.
+	if math.clamp(tonumber(value) or 0, -0x80000000, 0x7FFFFFFF) ~= value then
+		return UDim.new(nil, value).Offset
+	elseif value <= -1 then
+		return math.ceil(value)
+	elseif value >= 1 then
+		return math.floor(value)
+	end
+	return 0
+end
+
+function FormatNumberVersion.new(major: number, minor: number): FormatNumberVersion
+	local object = newproxy(true)
+	local object_meta = getmetatable(object)
+
+	object_meta.__index = {
+		Major = double_to_int32(major),
+		Minor = double_to_int32(minor),
+	}
+	object_meta.__metatable = "The metatable is locked"
+	object_meta.__tostring = version_tostring
+	object_meta.__lt = version_lt
+	object_meta.__eq = version_eq
+	table.freeze(object_meta)
+
+	return object
+end
+
+FormatNumberVersion.current = FormatNumberVersion.new(31, 1)
+
+return table.freeze(FormatNumberVersion)

package/runtime/FormatNumber/_impl/_internal/class.lua

@@ -0,0 +1,204 @@
+local class = { }
+local type_parents = { }
+local proxy_meta = setmetatable({ }, { __mode = "k" })
+
+local function proxy_tostring(self)
+	return proxy_meta[self].type_name .. ": " .. proxy_meta[self].as_string
+end
+
+local ImmutabilityType = table.freeze({
+	DEFAULT = 0,
+	NUMBER_FORMATTER = 1,
+	SYMBOLS = 2,
+})
+class.ImmutabilityType = ImmutabilityType
+
+function class.create_init_function(
+	type_name: string, parent_type_name: string?,
+	methods, parent_methods,
+	immutable: number
+)
+	local result_methods
+
+	if parent_methods then
+		result_methods = setmetatable(table.clone(parent_methods), { __index = methods })
+	else
+		result_methods = methods
+	end
+
+	type_parents[type_name] = parent_type_name or "FormatNumberObject"
+
+	return function(data, as_string)
+		local result_object = newproxy(true)
+		local result_object_meta = getmetatable(result_object)
+
+		if immutable ~= ImmutabilityType.SYMBOLS and type(data) == "table" then
+			table.freeze(data)
+		end
+
+		result_object_meta.data = data
+		result_object_meta.resolved_data = nil
+		result_object_meta.type_name = type_name
+		result_object_meta.as_string = as_string
+			or string.sub(tostring(result_object), 11)
+		result_object_meta.__index = result_methods
+		result_object_meta.__tostring = proxy_tostring
+		result_object_meta.__metatable = "The metatable is locked"
+
+		if immutable ~= ImmutabilityType.NUMBER_FORMATTER then
+			table.freeze(result_object_meta)
+		end
+
+		proxy_meta[result_object] = result_object_meta
+
+		return result_object
+	end
+end
+
+function class.is_a(object, type_name)
+	local selected_meta = proxy_meta[object]
+	local compared_type_name = selected_meta and selected_meta.type_name
+	local target_type_name = type_name
+	local result = false
+
+	if compared_type_name == target_type_name then
+		result = true
+	elseif compared_type_name then
+		repeat
+			compared_type_name = type_parents[compared_type_name]
+			result = compared_type_name == target_type_name
+		until not compared_type_name or result
+	end
+
+	return result
+end
+
+function class.get_data(object)
+	return proxy_meta[object].data
+end
+
+function class.get_resolved_data(object, call_if_not_resolved)
+	local proxy_meta_object = proxy_meta[object]
+	local resolved_data = proxy_meta_object.resolved_data
+
+	if not resolved_data then
+		resolved_data = call_if_not_resolved(proxy_meta_object.data)
+		proxy_meta_object.resolved_data = resolved_data
+		if resolved_data then
+			table.freeze(proxy_meta_object)
+		end
+	end
+
+	return resolved_data
+end
+
+function class.try_coerce(argument_no, value, type_name, default)
+	local success = false
+	local coerced_value = nil
+
+	if value == nil and default ~= nil then
+		coerced_value = default
+		success = true
+	elseif type_name == "string" then
+		if type(value) == "string" then
+			coerced_value = value
+			success = true
+		elseif type(value) == "number" then
+			coerced_value = tostring(value)
+			success = true
+		else
+			success = false
+		end
+	elseif type_name == "number" then
+		coerced_value = tonumber(value)
+		if coerced_value then
+			success = true
+		else
+			success = false
+			type_name ..= " object"
+		end
+	elseif string.sub(type_name, 1, 1) == "{" then
+		local t = string.sub(type_name, 2, -2)
+		if type(value) == "table" then
+			-- only copy the array part
+			-- no metamethods are respected
+			coerced_value = table.move(value, 1, rawlen(value), 1, table.create(rawlen(value)))
+			for i, v in coerced_value do
+				if type(v) ~= t then
+					error(string.format("Values inside the table argument must be a %s, index %d got %s", t, i, type(v)), 3)
+				end
+			end
+			success = true
+		else
+			type_name = "table"
+		end
+	elseif class.is_a(value, type_name) then
+		coerced_value = proxy_meta[value].data
+		success = true
+	end
+
+	if not success then
+		error(string.format("Argument #%d provided must be a %s", argument_no, type_name), 3)
+	end
+
+	return coerced_value
+end
+
+function class.try_coerce_range(argument_no, value, min, max, default)
+	local coerced_value
+
+	if value == nil then
+		coerced_value = default
+	else
+		local converted_integer = tonumber(value)
+		if converted_integer then
+			converted_integer = class.double_to_int32(converted_integer)
+
+			if converted_integer >= min and converted_integer <= max then
+				coerced_value = converted_integer
+			end
+		end
+	end
+
+	return coerced_value or error(string.format(
+		"Argument #%d provided must be an integer that is in the range of %d to (and including) %d",
+		argument_no, min, max
+	), 3)
+end
+
+function class.try_coerce_enum(argument_no, value, enum_tbl, default)
+	local coerced_value
+
+	if value == nil then
+		coerced_value = default
+	else
+		local enum_value_to_try = tonumber(value)
+		if enum_value_to_try then
+			enum_value_to_try = class.double_to_int32(value)
+			for k, v in enum_tbl do
+				if enum_value_to_try == v then
+					coerced_value = v
+					break
+				end
+			end
+		end
+	end
+
+	return coerced_value or error(string.format("Argument #%d provided is out of range", argument_no), 3)
+end
+
+function class.double_to_int32(value: number): number
+	if not (value > -0x80000001 and value < 0x80000000) then
+		-- Double to int32 conversion
+		-- cvttsd2si on x86
+		-- fcvtzs on aarch64
+		return UDim.new(nil, value).Offset
+	elseif value <= -1 then
+		return math.ceil(value)
+	elseif value >= 1 then
+		return math.floor(value)
+	end
+	return 0
+end
+
+return table.freeze(class)

package/runtime/FormatNumber/_impl/_internal/decimal_conversion.lua

@@ -0,0 +1,30 @@
+local decimal_conversion = { }
+local NUMBER_BYTE_CONVERSION = table.freeze({
+	["0"] = "\x00", ["1"] = "\x01", ["2"] = "\x02", ["3"] = "\x03",
+	["4"] = "\x04", ["5"] = "\x05", ["6"] = "\x06", ["7"] = "\x07",
+	["8"] = "\x08", ["9"] = "\x09",
+})
+
+function decimal_conversion.from_double(double: number): ({ number }, number, number)
+	local result_fmt
+	local result_n
+	local result_scale
+
+	local sigt_int, sigt_frac, expt = string.match(
+		tostring(double), "^(%d+)%.?(%d*)e?([+-]?%d*)$"
+	)
+	local sigt, sigt_incr = string.match(
+		sigt_int .. sigt_frac, "^0*(%d-)(0*)$"
+	)
+
+	result_fmt = {string.byte(
+		string.gsub(sigt, ".", NUMBER_BYTE_CONVERSION),
+		1, -1
+	)}
+	result_n = #result_fmt
+	result_scale = (tonumber(expt) or 0) - #sigt_frac + #sigt_incr
+
+	return result_fmt, result_n, result_scale
+end
+
+return table.freeze(decimal_conversion)

package/runtime/FormatNumber/_impl/_internal/enums.lua

@@ -0,0 +1,55 @@
+return table.freeze({
+	RoundingMode = table.freeze({
+		CEILING = 0,
+		FLOOR = 1,
+		DOWN = 2,
+		UP = 3,
+		HALF_EVEN = 4,
+		HALF_DOWN = 5,
+		HALF_UP = 6,
+	}),
+	GroupingStrategy = table.freeze({
+		OFF = 0,
+		MIN2 = 1,
+		ON_ALIGNED = 3,
+	}),
+	ENumberFormatSymbols = table.freeze({
+		kDecimalSeparatorSymbol = 0,
+		kGroupingSeparatorSymbol = 1,
+		kMinusSignSymbol = 6,
+		kPlusSignSymbol = 7,
+		kExponentialSymbol = 11,
+		kInfinitySymbol = 14,
+		kNaNSymbol = 15,
+	}),
+	SignDisplay = table.freeze({
+		AUTO = 0,
+		ALWAYS = 1,
+		NEVER = 2,
+		EXCEPT_ZERO = 5,
+		NEGATIVE = 7,
+	}),
+	DecimalSeparatorDisplay = table.freeze({
+		AUTO = 0,
+		ALWAYS = 1,
+	}),
+	RoundingPriority = table.freeze({
+		RELAXED = 0,
+		STRICT = 1,
+	}),
+
+	_Internal = table.freeze({
+		NotationType = table.freeze({
+			SIMPLE = 0,
+			SCIENTIFIC = 1,
+			COMPACT = 2,
+		}),
+
+		PrecisionType = table.freeze({
+			FRACTION = 0,
+			SIGNFICANT = 1,
+			FRACTION_SIGNIFICANT = 2,
+			UNLIMITED = 3,
+		}),
+	}),
+})