Module:Class

-- This module implements [[Template:Class]], [[Template:Class/icon]] and
-- [[Template:Class/colour]].

local mArguments, mIcon -- modules to lazily load
local definitions = mw.loadData('Module:Class/importDefinitions')

local p = {}

-- Initialize helper function variables
local getDefinition, getRawArgs, makeInvokeFunction, normalizeValue

--------------------------------------------------------------------------------
-- Argument helper functions
--------------------------------------------------------------------------------

function getRawArgs(frame, wrapper)
	mArguments = mArguments or require('Module:Arguments')
	return mArguments.getArgs(frame, {
		wrappers = wrapper,
		trim = false,
		removeBlanks = false
	})
end

function makeInvokeFunction(func, wrapper)
	return function (frame)
		local args = getRawArgs(frame, wrapper)
		return func(args)
	end
end

--------------------------------------------------------------------------------
-- String helper functions
--------------------------------------------------------------------------------

function normalizeValue(val)
	if type(val) == 'string' then val = val:match('^%s*(.-)%s*$'):lower() end
	if val == '' then val = nil end
	return val
end

--------------------------------------------------------------------------------
-- Definition helper functions
--------------------------------------------------------------------------------

function getDefinition(code)
	local canonicalCode = normalizeValue(code)
	local class = definitions[canonicalCode]
	while class and class.alias do
		canonicalCode = class.alias
		class = definitions[class.alias]
	end
	if not class then
		return nil, nil
	end
	return class, canonicalCode
end

--------------------------------------------------------------------------------
-- Color functions
--------------------------------------------------------------------------------

function p._colour(code)
	local class = getDefinition(code)
	return class and class.colour or 'transparent'
	--^ no defaulting's in definition yet; "transparent"'s a placeholder
end

function p.colour(frame)
	local args = getRawArgs(frame, 'Template:Class/colour')
	local colour = p._colour(args[1])
	-- We need nowiki tags as template output beginning with "#" triggers
	-- bug 14974.
	return frame:extensionTag('nowiki', colour)
end

--------------------------------------------------------------------------------
-- Icon functions
--------------------------------------------------------------------------------

function p._icon(args)
	local class = getDefinition(args.class or args[1])
	local icon = class and class.icon
	if icon and icon.file then
		local span = mw.html.create('span')
		span
			:cssText(args.style)
			:attr('title', class.labels.full)
			:wikitext(string.format(
				'[[File:%s|%s|16px%s]]',
				icon.file,
				class.labels.full,
				icon.requiresAttribution and '' or '|link=|alt='
				--^ recall that '' is truthy in Lua
			))
		return tostring(span)
	else
		mIcon = require('Module:Icon')
		return mIcon._main{args[1]}
	end
end

p.icon = makeInvokeFunction(p._icon, 'Template:Class/icon')

--------------------------------------------------------------------------------
-- Class functions
--------------------------------------------------------------------------------

function p._class(args)
	local classDef, classCode = getDefinition(args.class or args[1])
	local cell = mw.html.create(normalizeValue(args.heading) and 'th' or 'td')
	--image=yes forces icon, image=no disables it, otherwise checks default
	local icon = (
		classDef and classDef.icon and --aren't guaranteed to exist
		classDef.icon.default and (args.image ~= 'no') or
		args.image == 'yes'
	)
	icon = icon and p.icon(args) .. '&nbsp;' or ''
	local text = classDef and classDef.labels.short or '???'
	--^ "???" is defaulting placeholder
	text = classDef and classDef.category and string.format(
			'[[:%s|%s]]',
			classDef.category,
			text
		) or text
	cell
		:addClass('assess')
		:addClass('assess-' .. (classCode or ''))
		:css('text-align', 'center')
		:css('white-space', 'nowrap')
		:css('font-weight', args.bold ~= 'no' and 'bold' or nil)
		:css('background', p._colour(classCode))
		:wikitext(icon, text)

		return tostring(cell)
end

p.class = makeInvokeFunction(p._class, 'Template:Class')

return p
[1] This is assumed to be a light-mode colour; it might be desirable to split this into light- and dark-mode properties.
[underscores-2] Underscores are probably better for file names because they're more easily used in URLs, and don't hurt anything being used in wikitext.
[lowerTitle-3] Lowercase is better for full or generic words, e.g. "featured", but title case is better for constructed values, e.g. "Start-Class".
[spaces-4] Spaces are probably better for referencing wiki pages because they're easily used as strings or in wikitext; use in URLs would have to do other transformations anyway.
[model 1]
[model 2]
[model 3]
[model 4]
Module:Class

Usage

Documentation for Module:Class/definition.json

Object model notes
