Module:Namespace detect/sandbox

From blackwiki
< Module:Namespace detect
Revision as of 06:09, 22 March 2014 by blackwiki>Mr. Stradivarius (add a fetchValue function, which will be used for fetching args from the args table according to keys specified in the cfg table)
Jump to navigation Jump to search

Documentation for this module may be created at Module:Namespace detect/sandbox/doc

--[[
--------------------------------------------------------------------------------
--                                                                            --
--                            NAMESPACE DETECT                                --
--                                                                            --
-- This module implements the {{namespace detect}} template in Lua, with a    --
-- few improvements: all namespaces and all namespace aliases are supported,  --
-- and namespace names are detected automatically for the local wiki. The     --
-- module can also use the corresponding subject namespace value if it is     --
-- used on a talk page. Parameter names can be configured for different wikis --
-- by altering the values in the "cfg" table in                               --
-- Module:Namespace detect/config.                                            --
--                                                                            --
--------------------------------------------------------------------------------
--]]

local data = mw.loadData('Module:Namespace detect/data')
local cfg = data.cfg
local mappings = data.mappings

local yesno = require('Module:Yesno')
local mArguments -- Lazily initialise Module:Arguments
local ustringLower = mw.ustring.lower

local p = {}

local function fetchValue(args, t)
	-- Fetches a value from the table args for the first key in array t where
	-- a non-nil value of args exists.
	for i, key in ipairs(t) do
		local value = args[key]
		if value ~= nil then
			return value
		end
	end
	return nil
end

function p.getPageObject(page)
	-- Get the page object, passing the function through pcall in case of
	-- errors, e.g. being over the expensive function count limit.
	if page then
		local success, pageObject = pcall(mw.title.new, page)
		if success then
			return pageObject
		else
			return nil
		end
	else
		return mw.title.getCurrentTitle()
	end
end

-- Provided for backward compatibility with other modules
function p.getParamMappings()
	return mappings
end

local function getNamespace(args)
	-- Gets the namespace name from the page object.
	local page = args[cfg.page]
	local demospace = args[cfg.demospace]
	local subjectns = args[cfg.subjectns]
	local ret
	if demospace then
		-- Handle "demospace = main" properly.
		if ustringLower(demospace) == cfg.main then
			ret = mw.site.namespaces[0].name
		else
			ret = demospace
		end
	else
		local pageObject = p.getPageObject(page)
		if pageObject then
			if pageObject.isTalkPage then
				-- If cfg.subjectns is set, get the subject namespace, otherwise use cfg.talk.
				if yesno(subjectns) then
					ret = mw.site.namespaces[pageObject.namespace].subject.name
				else
					ret = cfg.talk
				end
			else
				ret = pageObject.nsText
			end
		else
			return nil -- return nil if the page object doesn't exist.
		end
	end
	ret = ret:gsub('_', ' ')
	return ustringLower(ret)
end

function p._main(args)
	-- Get the namespace to compare the parameters to, and the parameter mapping table.
	local namespace = getNamespace(args)
	-- Check for any matches in the namespace arguments. The order we check them doesn't matter,
	-- as there can only be one match.
	for ns, params in pairs(mappings) do
		if ns == namespace then
			-- Check all aliases for matches. The default local namespace is checked first, as
			-- {{namespace detect}} checked these before alias names.
			for _, param in ipairs(params) do
				if args[param] ~= nil then
					return args[param]
				end
			end
		end
	end
	-- If there were no matches, return parameters for other namespaces. This happens if there
	-- was no text specified for the namespace that was detected or if the demospace parameter
	-- is not a valid namespace. Note that the parameter for the detected namespace must be
	-- completely absent for this to happen, not merely blank.
	if args[cfg.other] ~= nil then
		return args[cfg.other]
	end
end

function p.main(frame)
	mArguments = require('Module:Arguments')
	local args = mArguments.getArgs(frame, {
		valueFunc = function (key, value)
			if type(value) == 'string' then
				value = value:match('^%s*(.-)%s*$') -- trim whitespace
			end
			if key == cfg.demospace or key == cfg.page then
				if value ~= '' then
					return value
				else
					return nil
				end
			else
				return value
			end
		end
	})
	return p._main(args)
end

function p.table(frame)
	--[[ Create a wikitable of all subject namespace parameters, for documentation purposes. The talk 
	  parameter is optional, in case it needs to be excluded in the documentation.
	]]
	local useTalk = type(frame) == 'table' and type(frame.args) == 'table' and frame.args.talk == 'yes' -- Whether to use the talk parameter.
	-- Start the wikitable.
	local ret = '{| class="wikitable"'
		.. '\n|-'
		.. '\n! ' .. cfg.wikitableNamespaceHeader
		.. '\n! ' .. cfg.wikitableAliasesHeader
	
	-- Generate the row for the main namespace, as we want this to be first in the list.
	ret = ret .. '\n|-'
		.. '\n| <code>' .. cfg.main .. '</code>'
		.. '\n|'
	if useTalk then
		ret = ret .. '\n|-'
			.. '\n| <code>' .. cfg.talk .. '</code>'
			.. '\n|'
	end
	-- Generate the other wikitable rows.
	for ns, params in pairs(mappings) do
		if ns ~= mw.site.namespaces[0].name then -- Ignore the main namespace.
			for i, param in ipairs(params) do
				if i == 1 then
					ret = ret .. '\n|-'
						.. '\n| <code>' .. param .. '</code>'
						.. '\n| '
				elseif i == 2 then
					ret = ret .. '<code>' .. param .. '</code>'
				else
					ret = ret .. ', <code>' .. param .. '</code>'
				end
			end
		end
	end
	-- End the wikitable.
	ret = ret .. '\n|-'
		.. '\n|}'
	return ret
end

return p