Module:Check for unknown parameters: Difference between revisions

    From Nonbinary Wiki
    m>Mr. Stradivarius
    (fix substitution of "_VALUE_" when it isn't followed by a space)
    m>Mr. Stradivarius
    (various changes: add a trim function, remove unnecessary parens, don't check type for wikitext values (they are always strings), and don't use mw.ustring when the string library will do (it's a lot faster))
    Line 3: Line 3:
    -- not on the list
    -- not on the list
    local p = {}
    local p = {}
    local function trim(s)
    return s:match('^%s*(.-)%s*$')
    end


    local function isnotempty(s)
    local function isnotempty(s)
    return s and s:match( '^%s*(.-)%s*$' ) ~= ''
    return s and trim(s) ~= ''
    end
    end


    Line 24: Line 28:
    for k, v in pairs(args) do
    for k, v in pairs(args) do
    if type(k) == 'number' then
    if type(k) == 'number' then
    v = mw.ustring.gsub(v, '^%s*(.-)%s*$', '%1')
    v = trim(v)
    knownargs[v] = 1
    knownargs[v] = 1
    else
    elseif k == 'unknown' then
    if (k == 'unknown' and type(v) == 'string') then
    unknown = v
    unknown = v
    elseif k:find('^regexp[1-9][0-9]*$') then
    elseif (mw.ustring.match(k, '^regexp[%d]*$') and type(v) == 'string') then
    table.insert(regexps, '^' .. v .. '$')
    table.insert(regexps, '^' .. v .. '$')
    end
    end
    end
    end
    end


    -- adds one result to the output tables
    local function addresult(k)
    local function addresult(k)
    if k == '' then
    if k == '' then
    Line 41: Line 44:
    k = ' '
    k = ' '
    end
    end
    local r = mw.ustring.gsub(unknown, '_VALUE_', k)
    local r = unknown:gsub('_VALUE_', k)
    table.insert(res, r)
    table.insert(res, r)
    table.insert(comments, '"' .. k .. '"')
    table.insert(comments, '"' .. k .. '"')
    Line 47: Line 50:


    -- loop over the parent args, and make sure they are on the list
    -- loop over the parent args, and make sure they are on the list
    for k,v in pairs(pargs) do
    for k, v in pairs(pargs) do
    if (type(k) == 'string' and knownargs[k] == nil) then
    if type(k) == 'string' and knownargs[k] == nil then
    local knownflag = nil
    local knownflag = false
    for r = 1,#regexps do
    for i, regexp in ipairs(regexps) do
    if( mw.ustring.match(k,regexps[r]) ) then
    if mw.ustring.match(k, regexp) then
    knownflag = 1
    knownflag = true
    break
    end
    end
    end
    end
    if( (not knownflag) and ( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) ) then
    if not knownflag and ( not ignoreblank or isnotempty(v) ) then
    k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
    k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
    addresult(k)
    addresult(k)
    end
    end
    elseif(checkpos and type(k) == 'number' and knownargs[tostring(k)] == nil) then
    elseif checkpos and
    if( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) then
    type(k) == 'number' and  
    addresult(k)
    knownargs[tostring(k)] == nil and
    end
    ( not ignoreblank or isnotempty(v) )
    then
    addresult(k)
    end
    end
    end
    end


    if(#comments > 0) then
    if #comments > 0 then
    commentstr = '<!-- Module:Check for unknown parameters results: ' ..
    commentstr = '<!-- Module:Check for unknown parameters results: ' ..
    table.concat(comments, ', ') .. '-->'
    table.concat(comments, ', ') .. '-->'

    Revision as of 11:32, 2 November 2015

    Documentation for this module may be created at Module:Check for unknown parameters/doc

    -- This module may be used to compare the arguments passed to the parent
    -- with a list of arguments, returning a specified result if an argument is
    -- not on the list
    local p = {}
    
    local function trim(s)
    	return s:match('^%s*(.-)%s*$')
    end
    
    local function isnotempty(s)
    	return s and trim(s) ~= ''
    end
    
    function p.check (frame)
    	local args = frame.args
    	local pargs = frame:getParent().args
    	local ignoreblank = isnotempty(frame.args['ignoreblank'])
    	local checkpos = isnotempty(frame.args['checkpositional'])
    	local knownargs = {}
    	local unknown = 'Found _VALUE_, '
    
    	local res = {}
    	local regexps = {}
    	local comments = {}
    	local commentstr = ''
    	
    	-- create the list of known args, regular expressions, and the return string
    	for k, v in pairs(args) do
    		if type(k) == 'number' then
    			v = trim(v)
    			knownargs[v] = 1
    		elseif k == 'unknown' then
    			unknown = v
    		elseif k:find('^regexp[1-9][0-9]*$') then
    			table.insert(regexps, '^' .. v .. '$')
    		end
    	end
    
    	-- adds one result to the output tables
    	local function addresult(k)
    		if k == '' then
    			-- Fix odd bug for | = which gets stripped to the empty string and
    			-- breaks category links
    			k = ' '
    		end
    		local r = unknown:gsub('_VALUE_', k)
    		table.insert(res, r)
    		table.insert(comments, '"' .. k .. '"')
    	end
    
    	-- loop over the parent args, and make sure they are on the list
    	for k, v in pairs(pargs) do
    		if type(k) == 'string' and knownargs[k] == nil then
    			local knownflag = false
    			for i, regexp in ipairs(regexps) do
    				if mw.ustring.match(k, regexp) then
    					knownflag = true
    					break
    				end
    			end
    			if not knownflag and ( not ignoreblank or isnotempty(v) )  then
    				k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
    				addresult(k)
    			end
    		elseif checkpos and
    			type(k) == 'number' and 
    			knownargs[tostring(k)] == nil and
    			( not ignoreblank or isnotempty(v) )
    		then
    			addresult(k)
    		end
    	end
    
    	if #comments > 0 then
    		commentstr = '<!-- Module:Check for unknown parameters results: ' ..
    			table.concat(comments, ', ') .. '-->'
    	end
    	
    	return table.concat(res) .. commentstr
    end
    
    return p