Module:Lua banner

Documentation for this module may be created at Module:Lua banner/doc

-- <pre>
--------------------------------------------------------------------------------
-- This module implements the {{Lua}} template.
--
-- Adapted from the Fandom original, which required the shared Dev: modules
-- (Arguments, Config, I18n, List, Message box, TableTools, Yesno). Those exist
-- only on Fandom, so this version uses the equivalent local modules, reads
-- Module:Lua banner/config directly, and carries its English strings inline.
--
-- @attribution [[mw:Module:Lua banner|Module:Lua banner]] (MediaWiki)
-- @attribution [[wikipedia:Module:Lua banner|Module:Lua banner]] (Wikipedia)
-- @see [[Template:Lua]]
--------------------------------------------------------------------------------

local libraryUtil = require("libraryUtil");
local checkType = libraryUtil.checkType;
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg;

local getArgs = require("Module:Arguments").getArgs;
local list = require("Module:List");
local messageBox = require("Module:Message box");
local tableTools = require("Module:TableTools");
local yesno = require("Module:Yesno");

local cfg = mw.loadData("Module:Lua banner/config");

-- Target for the "Lua" link in the banner text.
local luaLink = "mw:Lua";

local i18n = {
	["error"] = "Error: no modules specified",
	["wishtext"] = "This template should use [[$1|Lua]].",
	["header"] = "This template uses [[$1|Lua]]:",
	["header-module"] = "This module uses [[$1|Lua]]:",
	["header-user"] = "This user page uses [[$1|Lua]]:",
};

local function msg(key, ...)
	return mw.message.newRawMessage(i18n[key], ...):plain();
end

local function noEmptyString(value)
	if (type(value) == "string" and value == "") then
		return nil;
	end
	return value;
end

local p = {};

function p.main(frame, ...)
	return p._main(getArgs(frame), ...);
end

function p._main(args, title)
	checkType('main', 1, args, 'table');
	checkType('main', 2, title, 'table', true);

	title = title or mw.title.getCurrentTitle();
	local modules = tableTools.compressSparseArray(args);

	local box = p.renderBox(modules, title);
	local trackingCategories = p.renderTrackingCategories(args, modules, title);

	return box .. trackingCategories;
end

function p.renderBox(modules, title)
	checkType('renderBox', 1, modules, 'table');
	checkType('renderBox', 2, title, 'table', true);

	title = title or mw.title.getCurrentTitle();
	if (title.subpageText == "doc") then
		title = title.basePageTitle;
	end

	local boxArgs = {};

	if (#modules < 1) then
		if (cfg["allow_wishes"] == true and title.contentModel ~= "Scribunto") then
			boxArgs.text = msg("wishtext", luaLink);
		else
			boxArgs.text = tostring(
				mw.html.create("strong")
					:addClass("error")
					:wikitext(msg("error"))
			);
		end
	else
		local moduleLinks = {};
		for i, module in ipairs(modules) do
			moduleLinks[i] = string.format("[[:Module:%s]]", module);
		end

		local moduleList = list.makeList("bulleted", moduleLinks);

		local header;
		if (title.contentModel == "Scribunto") then
			header = "header-module";
		elseif (title.namespace == 2) then
			header = "header-user";
		else
			header = "header";
		end

		boxArgs.text = msg(header, luaLink) .. "\n" .. moduleList;
	end

	boxArgs.type = "notice";
	boxArgs.small = true;
	-- No icon: File:Lua logo.svg has never been uploaded to this wiki.
	boxArgs.image = "none";
	boxArgs.class = 'msgbox';

	return messageBox.main("mbox", boxArgs);
end

function p.renderTrackingCategories(args, modules, title)
	checkType('renderTrackingCategories', 1, args, 'table');
	checkType('renderTrackingCategories', 2, modules, 'table');
	checkType('renderTrackingCategories', 3, title, 'table', true);

	title = title or mw.title.getCurrentTitle();

	local category = args.category;
	checkTypeForNamedArg('renderTrackingCategories', 'category', category, 'string', true);

	if yesno(args.nocat) then
		return '';
	end

	local allowWishes = cfg["allow_wishes"];
	local cats = {};

	-- Error category
	local errorCategory = noEmptyString(cfg["error_category"]);
	if (
		#modules < 1
		and errorCategory
		and (
			not allowWishes
			or (title.subpageText == "doc" and title.basePageTitle or title).contentModel == "Scribunto"
		)
	) then
		cats[#cats + 1] = errorCategory;
	end

	-- Lua templates category
	local subpageBlacklist = cfg["subpage_blacklist"];
	if (title.namespace == 10 and not subpageBlacklist[title.subpageText]) then
		if (not category) then
			local moduleCategories = cfg["module_categories"];
			local pagename = modules[1] and mw.title.new(modules[1]);
			category = pagename and moduleCategories[pagename.text];

			if (not category) then
				category = noEmptyString(
					cfg[
						(allowWishes and #modules < 1)
							and "wish_category"
							or "default_category"
					]
				);
			end
		end

		if (category) then
			cats[#cats + 1] = category;
		end
	end

	for i, cat in ipairs(cats) do
		cats[i] = string.format('[[Category:%s]]', cat);
	end

	return table.concat(cats);
end

return p;
-- </pre>