Module:ControllerUtilities - Revision history

76561197969631737: now has an option to normalize the strings when converted into a table

2024-05-10T19:11:47Z

now has an option to normalize the strings when converted into a table

← Older revision		Revision as of 19:11, 10 May 2024
Line 29:		Line 29:
	---@param commaSeparatedStringOfIDs string the list of IDs, separated by commas		---@param commaSeparatedStringOfIDs string the list of IDs, separated by commas
	---@param needsKeyValueFlags boolean true if the list should be made of keys (IDs) and values of `true`, false if the list should be an array of IDs		---@param needsKeyValueFlags boolean true if the list should be made of keys (IDs) and values of `true`, false if the list should be an array of IDs
			---@param needsToBeNormalized boolean true if the strings should also be normalized to lower case
	---@return table the IDs now separated into elements in a table		---@return table the IDs now separated into elements in a table
	function ControllerUtilities.expandCommaSeparatedStringsIntoTable(commaSeparatedStringOfIDs, needsKeyValueFlags)		function ControllerUtilities.expandCommaSeparatedStringsIntoTable(commaSeparatedStringOfIDs, needsKeyValueFlags, needsToBeNormalized)

	if not commaSeparatedStringOfIDs or "" == commaSeparatedStringOfIDs then		if not commaSeparatedStringOfIDs or "" == commaSeparatedStringOfIDs then
Line 39:		Line 40:
	for eachID in string.gmatch(commaSeparatedStringOfIDs, PATTERN_EVERYTHING_BETWEEN_COMMAS_AND_SPACES) do		for eachID in string.gmatch(commaSeparatedStringOfIDs, PATTERN_EVERYTHING_BETWEEN_COMMAS_AND_SPACES) do
	if needsKeyValueFlags then		if needsKeyValueFlags then
	list[eachID] = true		if needsToBeNormalized then
			list[eachID:lower()] = true
			else
			list[eachID] = true
			end
	else		else
	table.insert(list, eachID)		if needsToBeNormalized then
			table.insert(list, eachID:lower())
			else
			table.insert(list, eachID)
			end
	end		end
	end		end

76561197969631737: Added method to remove extra quotes from around the description.

2024-05-10T15:14:19Z

Added method to remove extra quotes from around the description.

← Older revision		Revision as of 15:14, 10 May 2024
Line 17:		Line 17:
	local PATTERN_EVERYTHING_BETWEEN_COMMAS_AND_SPACES = "[^%s,][^,]+[^%s,]"		local PATTERN_EVERYTHING_BETWEEN_COMMAS_AND_SPACES = "[^%s,][^,]+[^%s,]"
	local PATTERN_SPRITE_NAME_CAPTURE_VALUE = '<sprite name="?([^>^"]+)"?>'		local PATTERN_SPRITE_NAME_CAPTURE_VALUE = '<sprite name="?([^>^"]+)"?>'
			local PATTERN_EVERYTHING_IN_BETWEEN_DOUBLE_QUOTES = '^"?(.-)"?$'

	--endregion		--endregion
Line 47:		Line 48:
	end		end

			--- Replaces any <sprite> XML tags in the description with Mediawiki markup using a separate template.
			---
			---@param description string anb otherwise unprocessed description from the data
			---@param currentFrame table the Mediawiki frame that can expand templates
			---@return string a modified description
	function ControllerUtilities.findAndReplaceSpriteTagsWithFiles(description, currentFrame)		function ControllerUtilities.findAndReplaceSpriteTagsWithFiles(description, currentFrame)

Line 58:		Line 64:
	return description		return description
	end		end


			--- Removes any enclosing double quotes from a description-like string.
			---
			---@param description string a description-type string, which may or may not be enclosed in double quotes
			---@return string the same string, but with any enclosing double quotes removed
			function ControllerUtilities.removeEnclosingDoubleQuotes(description)

			-- Need to store in a local variable because gsub returns two values
			local strippedString = description:gsub(PATTERN_EVERYTHING_IN_BETWEEN_DOUBLE_QUOTES, "%1")
			return strippedString
			end

	--endregion		--endregion

	return ControllerUtilities		return ControllerUtilities

76561197969631737: Added method to replace sprite tags with appropriate wiki markup

2024-05-05T23:38:09Z

Added method to replace sprite tags with appropriate wiki markup

← Older revision		Revision as of 23:38, 5 May 2024
Line 12:		Line 12:

	--region Private Constants		--region Private Constants

			local TEMPLATE_SPRITE_FINDER = "Sprite"

	local PATTERN_EVERYTHING_BETWEEN_COMMAS_AND_SPACES = "[^%s,][^,]+[^%s,]"		local PATTERN_EVERYTHING_BETWEEN_COMMAS_AND_SPACES = "[^%s,][^,]+[^%s,]"
			local PATTERN_SPRITE_NAME_CAPTURE_VALUE = '<sprite name="?([^>^"]+)"?>'

	--endregion		--endregion
Line 44:		Line 47:
	end		end

			function ControllerUtilities.findAndReplaceSpriteTagsWithFiles(description, currentFrame)

			description = description:gsub(PATTERN_SPRITE_NAME_CAPTURE_VALUE, function(name)
			return currentFrame:expandTemplate{
			title = TEMPLATE_SPRITE_FINDER,
			args = { ["id"] = name }
			}
			end)

			return description
			end
	--endregion		--endregion

	return ControllerUtilities		return ControllerUtilities

76561197969631737: Fixed some error validation

2024-05-05T01:42:43Z

Fixed some error validation

← Older revision		Revision as of 01:42, 5 May 2024
Line 21:		Line 21:
	--region Public methods		--region Public methods

	---~~expandIDList~~		--- Converts a string that represents a list of items into an array of those items. This is useful when a template parameter is used as a list and not a single value.
	---@param commaSeparatedStringOfIDs string the list of ~~ids~~, separated by commas		---
	---@param needsKeyValueFlags boolean true if the list should be made of keys and values of true, false if the list should be an array		---@param commaSeparatedStringOfIDs string the list of IDs, separated by commas
	---@return table the ~~ids~~ now as a table		---@param needsKeyValueFlags boolean true if the list should be made of keys (IDs) and values of `true`, false if the list should be an array of IDs
			---@return table the IDs now separated into elements in a table
	function ControllerUtilities.expandCommaSeparatedStringsIntoTable(commaSeparatedStringOfIDs, needsKeyValueFlags)		function ControllerUtilities.expandCommaSeparatedStringsIntoTable(commaSeparatedStringOfIDs, needsKeyValueFlags)

			if not commaSeparatedStringOfIDs or "" == commaSeparatedStringOfIDs then
			return {}
			end

	local list = {}		local list = {}

	for eachID in string.gmatch(commaSeparatedStringOfIDs, PATTERN_EVERYTHING_BETWEEN_COMMAS_AND_SPACES) do		for eachID in string.gmatch(commaSeparatedStringOfIDs, PATTERN_EVERYTHING_BETWEEN_COMMAS_AND_SPACES) do
	if needsKeyValueFlags then		if needsKeyValueFlags then

76561197969631737: Created to centralize a few methods

2024-05-05T01:31:17Z

Created to centralize a few methods

New page

---
--- Centralizes some common functionality across controllers
---
---@module ControllerUtilities
ControllerUtilities = {}

--region Public Constants

--endregion

--region Private Constants

local PATTERN_EVERYTHING_BETWEEN_COMMAS_AND_SPACES = "[^%s,][^,]+[^%s,]"

--endregion

--region Public methods

---expandIDList
---@param commaSeparatedStringOfIDs string the list of ids, separated by commas
---@param needsKeyValueFlags boolean true if the list should be made of keys and values of true, false if the list should be an array
---@return table the ids now as a table
function ControllerUtilities.expandCommaSeparatedStringsIntoTable(commaSeparatedStringOfIDs, needsKeyValueFlags)

local list = {}

for eachID in string.gmatch(commaSeparatedStringOfIDs, PATTERN_EVERYTHING_BETWEEN_COMMAS_AND_SPACES) do
if needsKeyValueFlags then
list[eachID] = true
else
table.insert(list, eachID)
end
end

return list
end

--endregion

return ControllerUtilities