Module:JsonUtils - Revision history

76561197969631737: A bit of adjusting comments; no material change

2025-03-08T17:27:38Z

A bit of adjusting comments; no material change

← Older revision		Revision as of 17:27, 8 March 2025
Line 1:		Line 1:
	---		---
	--- Uses mw.text.jsonDecode to convert ~~a named~~ wiki ~~page~~ into a Lua table.		---Uses mw.text.jsonDecode to convert the specified JSON file on the wiki into a Lua table.
	---		---
	--- The page must contain properly formatted JSON data and only the JSON data, without any explanation, wiki markup, or other content.		---The page must contain properly formatted JSON data and only the JSON data, without any explanation, wiki markup, or other content.
	---		---
	--- The table returned may have missing fields where they would otherwise be expected if the JSON data contained nil values for those fields.		---The table returned may have missing fields where they would otherwise be expected if the JSON data contained nil values for those fields.
	---		---
	---@module JsonUtils		---@module JsonUtils
Line 50:		Line 50:
	--region Public methods		--region Public methods

	--- Loads JSON data from a wiki ~~page~~ into a Lua table.		---Loads JSON data from the specified page on the wiki into a Lua table.
	---@param wikiPageName string the title of the wiki page, including		---@param wikiPageName string the title of the wiki page, including
	---@return table		---@return table
Line 57:		Line 57:
	-- Verify the parameter.		-- Verify the parameter.
	if not wikiPageName or "" == wikiPageName then		if not wikiPageName or "" == wikiPageName then
	error(ERROR_MESSAGE_PARAMETER_MISSING);		error(ERROR_MESSAGE_PARAMETER_MISSING)
	end		end

76561197969631737: Just a bit of reformatting messages

2024-10-20T01:22:56Z

Just a bit of reformatting messages

76561197969631737: Added a couple comments, also renamed main method more descriptive

2024-04-29T13:15:23Z

Added a couple comments, also renamed main method more descriptive

← Older revision		Revision as of 13:15, 29 April 2024
Line 8:		Line 8:
	---@module JsonUtils		---@module JsonUtils
	local JsonUtils = {}		local JsonUtils = {}



			--region Dependencies
			-- none
			--endregion


Line 26:		Line 32:
	local MINIMUM_LENGTH_THAT_SUGGESTS_VALID_CONTENT = 4		local MINIMUM_LENGTH_THAT_SUGGESTS_VALID_CONTENT = 4

			--endregion



			--region Private member variables
			-- none
	--endregion		--endregion

Line 41:		Line 53:
	---@param wikiPageName string the title of the wiki page, including		---@param wikiPageName string the title of the wiki page, including
	---@return table		---@return table
	function JsonUtils.~~main~~(wikiPageName)		function JsonUtils.convertJSONToLuaTable(wikiPageName)

	-- Verify the parameter.		-- Verify the parameter.

76561197969631737: Finished to decode json pages into lua tables

2024-04-29T04:03:57Z

Finished to decode json pages into lua tables

@@ Line 1: / Line 1: @@
 ---
---- asdf
+--- Uses mw.text.jsonDecode to convert a named wiki page into a Lua table.
 ---
 ---@module JsonUtils
@@ Line 8: / Line 12: @@
 --region Private constants
 --endregion
@@ Line 13: / Line 31: @@
 --region Private methods
 --endregion
@@ Line 19: / Line 38: @@
 --region Public methods
-function JsonUtils.convertJsonToLuaTable(wikiPageName)
+--- Loads JSON data from a wiki page into a Lua table.
-     local jsonContent = mw.loadJsonData(wikiPageName)
+    -- Verify that the data is valid and useful JSON.
-     return jsonContent
+     return decodedTable
 end
 --endregion
 return JsonUtils

76561197969631737: Created to handle json data files

2024-04-27T23:55:04Z

Created to handle json data files

New page

---
--- asdf
---
---@module JsonUtils
local JsonUtils = {}

--region Private constants
--endregion

--region Private methods
--endregion

--region Public methods

function JsonUtils.convertJsonToLuaTable(wikiPageName)

local jsonContent = mw.loadJsonData(wikiPageName)

return jsonContent
end

--endregion

return JsonUtils

← Older revision		Revision as of 01:22, 20 October 2024
Line 63:		Line 63:
	local titleObject = mw.title.new(wikiPageName)		local titleObject = mw.title.new(wikiPageName)
	if not titleObject then		if not titleObject then
	error(ERROR_PREFIX_TITLE_INVALID_NAME .. wikiPageName ~~.. "."~~)		error(ERROR_PREFIX_TITLE_INVALID_NAME .. wikiPageName)
	end		end
	if not titleObject.exists then		if not titleObject.exists then
	error(ERROR_PREFIX_TITLE_PAGE_DOES_NOT_EXIST .. wikiPageName ~~.. "."~~)		error(ERROR_PREFIX_TITLE_PAGE_DOES_NOT_EXIST .. wikiPageName)
	end		end

Line 72:		Line 72:
	local unparsedContent = titleObject:getContent()		local unparsedContent = titleObject:getContent()
	if not unparsedContent then		if not unparsedContent then
	error(ERROR_PREFIX_CONTENT_NOT_FOUND .. wikiPageName ~~.. "."~~)		error(ERROR_PREFIX_CONTENT_NOT_FOUND .. wikiPageName)
	end		end
	if #unparsedContent < MINIMUM_LENGTH_THAT_SUGGESTS_VALID_CONTENT then		if #unparsedContent < MINIMUM_LENGTH_THAT_SUGGESTS_VALID_CONTENT then
	error(ERROR_PREFIX_CONTENT_NOT_LONG_ENOUGH .. wikiPageName ~~.. "."~~)		error(ERROR_PREFIX_CONTENT_NOT_LONG_ENOUGH .. wikiPageName)
	end		end

Line 81:		Line 81:
	local success, decodedTable = pcall(mw.text.jsonDecode, unparsedContent)		local success, decodedTable = pcall(mw.text.jsonDecode, unparsedContent)
	if not success or not decodedTable then		if not success or not decodedTable then
	error(ERROR_PREFIX_JSON_DATA_NOT_USABLE .. wikiPageName ~~.. "."~~)		error(ERROR_PREFIX_JSON_DATA_NOT_USABLE .. wikiPageName)
	end		end
	if #decodedTable < 1 then		if #decodedTable < 1 then
	error(ERROR_PREFIX_JSON_NO_DATA .. wikiPageName ~~.. "."~~)		error(ERROR_PREFIX_JSON_NO_DATA .. wikiPageName)
	end		end