Difference between revisions of "Module:Namespace detect/sandbox"

From blackwiki
Jump to navigation Jump to search
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)
blackwiki>Mr. Stradivarius
(allow multiple parameters in the cfg table, avoid using for loops in the p._main function, and move the checks for blank page and demospace args to the main function so that we don't have to check them every time)
Line 16: Line 16:
  
 
local data = mw.loadData('Module:Namespace detect/data')
 
local data = mw.loadData('Module:Namespace detect/data')
 +
local argKeys = data.argKeys
 
local cfg = data.cfg
 
local cfg = data.cfg
 
local mappings = data.mappings
 
local mappings = data.mappings
Line 25: Line 26:
 
local p = {}
 
local p = {}
  
local function fetchValue(args, t)
+
local function fetchValue(t1, t2)
-- Fetches a value from the table args for the first key in array t where
+
-- Fetches a value from the table t1 for the first key in array t2 where
-- a non-nil value of args exists.
+
-- a non-nil value of t1 exists.
for i, key in ipairs(t) do
+
for i, key in ipairs(t2) do
local value = args[key]
+
local value = t1[key]
 
if value ~= nil then
 
if value ~= nil then
 
return value
 
return value
Line 35: Line 36:
 
end
 
end
 
return nil
 
return nil
 +
end
 +
 +
local function equalsArrayValue(t, value)
 +
-- Returns true if value equals a value in the array t. Otherwise
 +
-- returns false.
 +
for i, arrayValue in ipairs(t) do
 +
if value == arrayValue then
 +
return true
 +
end
 +
end
 +
return false
 
end
 
end
  
Line 58: Line 70:
  
 
local function getNamespace(args)
 
local function getNamespace(args)
-- Gets the namespace name from the page object.
+
-- This function gets the namespace name from the page object.
local page = args[cfg.page]
+
local page = fetchValue(args, argKeys.page)
local demospace = args[cfg.demospace]
+
if page == '' then
local subjectns = args[cfg.subjectns]
+
page = nil
 +
end
 +
local demospace = fetchValue(args, argKeys.demospace)
 +
if demospace == '' then
 +
demospace = nil
 +
end
 +
local subjectns = fetchValue(args, argKeys.subjectns)
 
local ret
 
local ret
 
if demospace then
 
if demospace then
 
-- Handle "demospace = main" properly.
 
-- Handle "demospace = main" properly.
if ustringLower(demospace) == cfg.main then
+
if equalsArrayValue(argKeys.main, ustringLower(demospace)) then
 
ret = mw.site.namespaces[0].name
 
ret = mw.site.namespaces[0].name
 
else
 
else
Line 74: Line 92:
 
if pageObject then
 
if pageObject then
 
if pageObject.isTalkPage then
 
if pageObject.isTalkPage then
-- If cfg.subjectns is set, get the subject namespace, otherwise use cfg.talk.
+
-- Get the subject namespace if the option is set,
 +
-- otherwise use "talk".
 
if yesno(subjectns) then
 
if yesno(subjectns) then
 
ret = mw.site.namespaces[pageObject.namespace].subject.name
 
ret = mw.site.namespaces[pageObject.namespace].subject.name
 
else
 
else
ret = cfg.talk
+
ret = 'talk'
 
end
 
end
 
else
 
else
Line 92: Line 111:
  
 
function p._main(args)
 
function p._main(args)
-- Get the namespace to compare the parameters to, and the parameter mapping table.
+
-- Check the parameters stored in the mappings table for any matches.
local namespace = getNamespace(args)
+
local namespace = getNamespace(args) or 'other' -- "other" avoids nil table keys
-- Check for any matches in the namespace arguments. The order we check them doesn't matter,
+
local params = mappings[namespace] or {}
-- as there can only be one match.
+
local ret = fetchValue(args, params)
for ns, params in pairs(mappings) do
+
--[[
if ns == namespace then
+
-- If there were no matches, return parameters for other namespaces.
-- Check all aliases for matches. The default local namespace is checked first, as
+
-- This happens if there was no text specified for the namespace that
-- {{namespace detect}} checked these before alias names.
+
-- was detected or if the demospace parameter is not a valid
for _, param in ipairs(params) do
+
-- namespace. Note that the parameter for the detected namespace must be
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.
 
-- completely absent for this to happen, not merely blank.
if args[cfg.other] ~= nil then
+
--]]
return args[cfg.other]
+
if ret == nil then
 +
ret = fetchValue(args, argKeys.other)
 
end
 
end
 +
return ret
 
end
 
end
  
 
function p.main(frame)
 
function p.main(frame)
 
mArguments = require('Module:Arguments')
 
mArguments = require('Module:Arguments')
local args = mArguments.getArgs(frame, {
+
local args = mArguments.getArgs(frame, {removeBlanks = false})
valueFunc = function (key, value)
+
local ret = p._main(args)
if type(value) == 'string' then
+
return ret or ''
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
 
end
  

Revision as of 10:00, 22 March 2014

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 argKeys = data.argKeys
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(t1, t2)
	-- Fetches a value from the table t1 for the first key in array t2 where
	-- a non-nil value of t1 exists.
	for i, key in ipairs(t2) do
		local value = t1[key]
		if value ~= nil then
			return value
		end
	end
	return nil
end

local function equalsArrayValue(t, value)
	-- Returns true if value equals a value in the array t. Otherwise
	-- returns false.
	for i, arrayValue in ipairs(t) do
		if value == arrayValue then
			return true
		end
	end
	return false
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)
	-- This function gets the namespace name from the page object.
	local page = fetchValue(args, argKeys.page)
	if page == '' then
		page = nil
	end
	local demospace = fetchValue(args, argKeys.demospace)
	if demospace == '' then
		demospace = nil
	end
	local subjectns = fetchValue(args, argKeys.subjectns)
	local ret
	if demospace then
		-- Handle "demospace = main" properly.
		if equalsArrayValue(argKeys.main, ustringLower(demospace)) then
			ret = mw.site.namespaces[0].name
		else
			ret = demospace
		end
	else
		local pageObject = p.getPageObject(page)
		if pageObject then
			if pageObject.isTalkPage then
				-- Get the subject namespace if the option is set,
				-- otherwise use "talk".
				if yesno(subjectns) then
					ret = mw.site.namespaces[pageObject.namespace].subject.name
				else
					ret = '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)
	-- Check the parameters stored in the mappings table for any matches.
	local namespace = getNamespace(args) or 'other' -- "other" avoids nil table keys
	local params = mappings[namespace] or {}
	local ret = fetchValue(args, params)
	--[[
	-- 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 ret == nil then
		ret = fetchValue(args, argKeys.other)
	end
	return ret
end

function p.main(frame)
	mArguments = require('Module:Arguments')
	local args = mArguments.getArgs(frame, {removeBlanks = false})
	local ret = p._main(args)
	return ret or ''
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