Module:Data to Table

Module documentation

[view] [edit] [history] [purge]

Main

Documentation

Usage

This module implements {{Data to Table}}.

Text above can be found here (edit)
Editors can experiment in this module's draft (create |  mirror) page.
Please add categories to the documentation subpage. Subpages of this module.

local p = {}

local CleanTT = require('Module:tt').CleanTT
local lib = require('Module:Feature')
local ne = lib.isNotEmpty

local block = false

-- Check if the entry is the first on the level
local first = {true, true, true}

-- Check if the entry is right after the end of a deeper level
local previous = {false, false, false}


-- Escape characters
local function clean(txt)
	txt = txt:gsub('&(%a+;)', '&%1')
		:gsub('\'', '\\'')
		:gsub('<', '&lt;')
		:gsub('\'', '\\\'')
	return txt
end


function p.main(frame)
	local info = {}
	local dataKeys = {}
	local rawKeys = {}

	-- Parse DPL data
	if frame.args.info then
		if ne(frame.args.cleanTT) then
			frame.args.info = CleanTT(frame.args.info)
		end

		info = lib.parseTemplateFormat(
			frame.args.info,
			';;',
			'$$$',
			'=='
		)
	else
		return ''
	end

	-- Parse keys
	if frame.args.keys then
		dataKeys = p.ParseKeys(frame.args.keys)
	end

	-- Parse unquoted/raw keys
	if frame.args.unquoted then
		rawKeys = p.ParseKeys(frame.args.unquoted)
	end

	-- Block formatting
	if ne(frame.args.block) then
		block = true
	end

	local sortkey = frame.args.sortkey or 'page'
	local subtable = frame.args.subtable


	-- Check whether a key should be output as raw Lua
	local function isUnquotedKey(key)
		for _, rawKey in ipairs(rawKeys) do
			if rawKey == key then
				return true
			end
		end

		return false
	end


	-- Build result
	local result = mw.html.create('pre')
		:css({
			['min-height'] = '25px',
			['line-height'] = '16px'
		})
		:wikitext('return {\n')


	local items = {}

	for _, entry in lib.spairs(
		info,
		function(tVal, a, b)
			if sortkey == 'INPUT' then
				return a < b
			else
				return (tVal[a][sortkey] or '') < (tVal[b][sortkey] or '')
			end
		end
	) do

		if ne(entry.page) then
			entry.page = clean(entry.page)

			-- No data keys: output page as a simple string
			if #dataKeys == 0 then

				result:wikitext(
					'\t\'',
					entry.page,
					'\',\n'
				)

			else

				-- Reset formatting state for every entry
				first = {true, true, true}
				previous = {false, false, false}

				local valid = false
				local values = mw.html.create()

				-- Entry name
				values:wikitext(
					'\t[\'',
					entry.page,
					'\'] = {'
				)

				-- Build entry
				local function parseLevels(K, level)
					level = level or 1

					if type(K) == 'string' and entry[K] ~= nil then

						valid = true

						values:node(
							p.BuildEntry(
								entry[K],
								K,
								level,
								subtable,
								isUnquotedKey(K)
							)
						)

					elseif type(K) == 'table' then

						level = level + 1

						for _, K2 in ipairs(K) do
							parseLevels(K2, level)
						end

						values:wikitext(
							block
								and ('\n' .. string.rep('\t', level - 1))
								or ' ',
							'},'
						)
					end
				end

				parseLevels(dataKeys, 1)

				-- Return table if there is valid data,
				-- otherwise return the page as a plain string
				if valid then
					values:wikitext('\n')
					result:node(values)
				else
					result:wikitext(
						'\t\'',
						entry.page,
						'\',\n'
					)
				end
			end
		end
	end

	result:wikitext('}')

	-- Copy button
	if frame.args.copy then
		result = require('Module:CopyText')._main({
			tostring(result),
			frame.args.copy,
			'Copy Table'
		})
	end

	return result
end


-- Format data
function p.BuildEntry(value, key, level, subtable, unquoted)
	level = level or 1

	local container = mw.html.create()

	-- Keep empty values
	if value ~= nil then

		-- Format value
		if subtable and value:find(subtable) then

			value = lib.split(
				clean(value),
				subtable
			)

			value = '{ \'' ..
				table.concat(value, '\', \'') ..
				' }'

		elseif unquoted then

			-- Raw Lua value
			value = clean(value)

		else

			-- String value
			value = '\'' ..
				clean(value) ..
				'\''

		end


		-- Format key as ['key']
		local formattedKey =
			'[\'' .. clean(key) .. '\']'


		-- First item on this level
		if first[level] then

			container:wikitext(
				'\n',
				string.rep('\t', level),
				formattedKey,
				' = ',
				value,
				','
			)

			first[level] = false

			if level > 2 then
				first[2] = false
			end

			if level > 1 then
				first[1] = false
			end


		-- Subsequent item on this level
		else

			container:wikitext(
				'\n',
				string.rep('\t', level),
				formattedKey,
				' = ',
				value,
				','
			)

			previous[level] = false

		end
	end

	return container
end


-- Parse data keys into specified levels
function p.ParseKeys(keys)
	keys = lib.split(keys, ';;')

	for i, key in pairs(keys) do

		if key:find('//') then

			local keys2 = lib.split(key, '//')

			for i2, key2 in pairs(keys2) do

				if key2:find('@@') then
					keys2[i2] = lib.split(key, '@@')
				end

			end

			keys[i] = keys2
		end
	end

	return keys
end


return p