Module:Parameter validation - Revision history

ProcrastinatingReader: doc was moved into actual doc page

2021-05-08T15:21:49Z

doc was moved into actual doc page

← Previous revision		Revision as of 15:21, 8 May 2021
Line 1:		Line 1:
	--[=[

	This module is based on idea and original code of [[User:IKhitron]].

	the source of this module is in //he.wikipedia.org/wiki/Module:ParamValidator

	main purpose: use "templatedata" to verify the parameters passed to a template

	Terminology: "numeric parameter" means order-based parameter. e.g. if the template is transcluded like so {{x \| k \| \| a = m \| b = }}
	"a" and "b" are "named" parameters, and there are 2 "numeric", or order based parameters, 1 and 2.
	we say that the value of a is "m", the value of 1 is "k", and "b" and 2 are "empty".

	This module exports two functions: calculateViolations( frame, subpages ), and validateParams( frame ).

	calculateViolations( frame, subpages ) finds templatedata, in template page or in one of its subpages in the list, if provided.
	it returns a table with the violations. if there are none, the table is empty. otherwise it has the structure
	{
	violation1 = { param1 = value1, param2 = value2 },
	violation2 = { ... },
	...
	}

	violation1, violation2 etc. are one of the names of specific violations, as described below.
	param1, param2 etc. are either the names of parameter passed to the template, or defined in templatedata.
	value1, value2 etc. are the values passed to the template, or an empty string if no such parameter was passed.

	the different violations are as follow:
	* "no-templatedata": no valid tempaltedata was found in tempalte page, or documentation subpage
	* "undeclared": named parameters with non-empty value, does not exist in templatedata
	* "empty-undeclared": named parameters with empty value, does not exist in templatedata
	* "undeclared-numeric": numeric parameters with non-empty value, does not exist in templatedata
	* "empty-undeclared-numeric": numeric parameters with empty value, does not exist in templatedata
	* "deprecated": parameters with non-empty value, marked as "deprecated" in tempaltedata
	* "empty-deprecated": parameters with empty value, marked as "deprecated" in tempaltedata
	* "empty-required": missing or empty parameter marked as "required" in tempaltedata
	* "incompatible": a non-empty parameter passed to the template, incompatible with the parameter type defined in templatedata
	* "duplicate": a value is passed for the same parameter (or any of its aliases) more than once


	The second function, validateParams( frame ), can be called from the tempalte' using #invoke.
	it expects a parameter named "options", which contains the definition of the output. typically, it's used by placing something like so:

	<includeonly>{{#invoke:ParamValidator \| validateParams \| options = {{PV default options}} }}</includeonly>

	at the top of the template (be mindful not to add extra spaces and newlines to the template).
	to bypass some mediawiki limitation, it is also possible to pass the options as "module", like so (use one of the two, but not both):
	<includeonly>{{#invoke:ParamValidator \| validateParams \| module_options = Module:PV default options}} }}</includeonly>

	the first form expects a template named "Template:PV default options" which contains the options, and the 2nd form expects a module,
	suitable for mw.loadData(), which returns a map of namespace => options (i.e. { [0] = <options>, [2] => <options> } .... )

	the options parameter should be a JSON-encoded string, defining the output, and some special behaviors.
	the example above assumes that a wiki page named [[Template:PV default options]] exists, and contains valid JSON string.
	for each of the violations defined above, "options" may define an output string, so basically, "options" looks like so:
	{
	violation1: outputstring1,
	violation2: outputstring2,
	.... ,
	behavior1: some value,
	....
	}

	not all violations have to be defined. a violation not defined in "options" will be ignored.

	when invoked, it extract "subpages" from the options parameter, and calls:
	calculateViolations( frame, subpages )
	if the returned table is empty, no violation were found, and an empty string is returned and nothing else happens.

	otherwise, for each of the violations, i.e., the keys of the returned table, when "options" contains this key,
	the corresonding value is appended to the output.

	some further processing is done:
	1) several tokens are replaced with calculated values. these are described below.
	2) some "meta" violations are calculated: when any none-ignored violation occured,
	the "any" meta-violation is added to the output in the same way,
	i.e. the string keyed by "any" in the options is appended to output with appropriate substitutions.
	similarly, "multiple" meta-violation is created when more than one type of non-ignored violations occured.
	3) if the output is not empty, a prefix and suffix strings are prepended and appended to it.

	these are the tokens and the replacement.
	* "templatename": full template name, including namespace.
	* "tname_naked": template name without namespace.
	* "paramname": comma-separated list of parameters
	* "paramandvalue": is replaced by comma-separated list of "name: value" pairs of parameters and values
	the first two are applied to the whole output, including the suffux and prefix,
	and the rest are applied to the individual violations, each with its own list of offending parameters and values.


	the rest of the if the value of some keys is null, this error condition will be ignored, and not counted when calculating "any" and "multiple" conditions.

	some other optional fields can be passed via options:
	* "doc-subpage": can be either a string, or a list (in square bracktes) of strings, indicating subpages of the template
	that may contain templatedata.
	* "ignore": list of patterns. any parameter whose name matches any pattern, will not considered in violation of any of the rules.
	* "skip-empty-numeric": if a quoted number, the module will ignore non-declared empty numeric parameters up to this number
	* "wrapper-prefix": openning wrapper element of outpot (defaults to "<div class = 'paramvalidator-wrapper'>")
	* "wrapper-suffix": closing wrapper element of output (defaults to "</div>")

	additional option parameters, named options1, options2, etc. can be passed. any entry defined in these options will
	override the previous value. a typical use may be like so:


	typically, this JSON structure will be placed in a separate template, and retrieved for the module-use as shown above.
	<includeonly>{{#invoke:ParamValidator \| validateParams \| options = {{PV default options}} \| options1 = {"key":"value"} }}</includeonly>
	"key" can override any of the options fields described above.


	]=]

	local util = {		local util = {
	empty = function( s )		empty = function( s )

ProcrastinatingReader: sync updates

2020-12-06T16:45:15Z

sync updates

← Previous revision		Revision as of 16:45, 6 December 2020
Line 208:		Line 208:
	-- allow for aliases		-- allow for aliases
	for x, p in pairs( td_params ) do for y, alias in ipairs( p.aliases or {} ) do		for x, p in pairs( td_params ) do for y, alias in ipairs( p.aliases or {} ) do
	--p['primary'] = x		p['primary'] = x
			td_params[x] = p
	all_aliases[alias] = p		all_aliases[alias] = p
	if tonumber(alias) then all_aliases[tonumber(alias)] = p end		if tonumber(alias) then all_aliases[tonumber(alias)] = p end
	end end		end end


	mw.logObject(all_aliases)

	-- handle undeclared and deprecated		-- handle undeclared and deprecated
	local already_seen = {}		local already_seen = {}
Line 241:		Line 240:
	table_name = tp_param.deprecated and hasval and 'deprecated'		table_name = tp_param.deprecated and hasval and 'deprecated'
	or tp_param.deprecated and noval and 'empty-deprecated'		or tp_param.deprecated and noval and 'empty-deprecated'
	or not compatible( tp_param.type, value ) and 'incompatible'		or not compatible( tp_param.type, value ) and 'incompatible'
	or not series and already_seen[tp_param] and hasval and 'duplicate'		or not series and already_seen[tp_param] and hasval and 'duplicate'

⚫
			if hasval and table_name ~= 'duplicate' then
	already_seen[tp_param] = ~~hasval~~		already_seen[tp_param] = p_name
			end
	end		end

Line 250:		Line 251:
	if table_name then		if table_name then
	res[table_name] = res[table_name] or {}		res[table_name] = res[table_name] or {}
	~~res[~~table_name~~][p_name]~~ = ~~value~~		if table_name == 'duplicate' then
			local primary_param = tp_param['primary']
	mw.logObject(res)
			local primaryData = res[table_name][primary_param]
			if not primaryData then
			primaryData = {}
			table.insert(primaryData, already_seen[tp_param])
			end
			table.insert(primaryData, p_name)
			res[table_name][primary_param] = primaryData
			else
			res[table_name][p_name] = value
			end
	end		end
	end		end

	-- ~~test~~ for empty/missing ~~paraeters~~ declared "required"		-- check for empty/missing parameters declared "required"
	for p_name, param in pairs( td_params ) do		for p_name, param in pairs( td_params ) do
	if param.required and util.empty( t_args[p_name] ) then		if param.required and util.empty( t_args[p_name] ) then
Line 300:		Line 311:
	end		end

	local replace_macros = function( s, param_names )		local replace_macros = function( error_type, s, param_names )
	function concat_and_escape( t )		function concat_and_escape( t , sep )
	~~local s~~ = ~~table.concat(~~ t, ', ' )		sep = sep or ', '
			local s = table.concat( t, sep )
	return ( mw.ustring.gsub( s, '%%', '%%%%' ) )		return ( mw.ustring.gsub( s, '%%', '%%%%' ) )
	end		end
Line 310:		Line 322:
	for k, v in pairs( param_names ) do		for k, v in pairs( param_names ) do
	table.insert( k_ar, k )		table.insert( k_ar, k )
	~~table.insert~~( ~~kv_ar, k ..~~ ': ' ~~.. v)~~		if type(v) == 'table' then
			v = table.concat(v, ', ')
			end
		⚫
			if error_type == 'duplicate' then
			table.insert( kv_ar, v)
			else
			table.insert( kv_ar, k .. ': ' .. v)
			end
	end		end
⚫	s = mw.ustring.gsub( s, 'paramname', concat_and_escape( k_ar ) )
⚫	s = mw.ustring.gsub( s, 'paramandvalue', concat_and_escape( kv_ar ) )

		⚫	s = mw.ustring.gsub( s, 'paramname', concat_and_escape( k_ar ) )
		⚫	s = mw.ustring.gsub( s, 'paramandvalue', concat_and_escape( kv_ar, ' AND ' ) )

	if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) ~= "" then		if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) ~= "" then
	s = mw.ustring.gsub( s, "<div.*<%/div>", "", 1 )		s = mw.ustring.gsub( s, "<div.*<%/div>", "", 1 )
Line 323:		Line 344:

	local report_params = function( key, param_names )		local report_params = function( key, param_names )
	local res = replace_macros( options[key], param_names )		local res = replace_macros( key, options[key], param_names )
	res = frame:preprocess(res or '')		res = frame:preprocess(res or '')
	report = report .. ( res or '' )		report = report .. ( res or '' )

ProcrastinatingReader at 14:27, 6 December 2020

2020-12-06T14:27:45Z

← Previous revision		Revision as of 14:27, 6 December 2020
Line 208:		Line 208:
	-- allow for aliases		-- allow for aliases
	for x, p in pairs( td_params ) do for y, alias in ipairs( p.aliases or {} ) do		for x, p in pairs( td_params ) do for y, alias in ipairs( p.aliases or {} ) do
	p['primary'] = x		--p['primary'] = x
	all_aliases[alias] = p		all_aliases[alias] = p
	if tonumber(alias) then all_aliases[tonumber(alias)] = p end		if tonumber(alias) then all_aliases[tonumber(alias)] = p end

ProcrastinatingReader: add primary alias

2020-12-06T14:25:29Z

add primary alias

← Previous revision		Revision as of 14:25, 6 December 2020
Line 115:		Line 115:
	extract_options = function ( frame, optionsPrefix )		extract_options = function ( frame, optionsPrefix )
	optionsPrefix = optionsPrefix or 'options'		optionsPrefix = optionsPrefix or 'options'
⚫

	local options, n, more = {}		local options, n, more = {}
Line 201:		Line 200:
	local td_params = templatedata and templatedata.params		local td_params = templatedata and templatedata.params
	local all_aliases, all_series = {}, {}		local all_aliases, all_series = {}, {}


	if not td_params then return { ['no-templatedata'] = { [''] = '' } } end		if not td_params then return { ['no-templatedata'] = { [''] = '' } } end
	-- from this point on, we know templatedata is valid.		-- from this point on, we know templatedata is valid.
Line 208:		Line 207:

	-- allow for aliases		-- allow for aliases
	for _, p in pairs( td_params ) do for _, alias in ipairs( p.aliases or {} ) do		for x, p in pairs( td_params ) do for y, alias in ipairs( p.aliases or {} ) do
			p['primary'] = x
	all_aliases[alias] = p		all_aliases[alias] = p
	if tonumber(alias) then all_aliases[tonumber(alias)] = p end		if tonumber(alias) then all_aliases[tonumber(alias)] = p end
Line 230:		Line 230:
	end		end
	end		end


	if not tp_param then -- not in TD: this is called undeclared		if not tp_param then -- not in TD: this is called undeclared
	-- calculate the relevant table for this undeclared parameter, based on parameter and value types		-- calculate the relevant table for this undeclared parameter, based on parameter and value types
Line 246:		Line 246:
	already_seen[tp_param] = hasval		already_seen[tp_param] = hasval
	end		end
		⚫
	-- report it.		-- report it.
	if table_name then		if table_name then
	res[table_name] = res[table_name] or {}		res[table_name] = res[table_name] or {}
	res[table_name][p_name] = value		res[table_name][p_name] = value

ProcrastinatingReader at 14:05, 6 December 2020

2020-12-06T14:05:34Z

← Previous revision		Revision as of 14:05, 6 December 2020
Line 212:		Line 212:
	if tonumber(alias) then all_aliases[tonumber(alias)] = p end		if tonumber(alias) then all_aliases[tonumber(alias)] = p end
	end end		end end


			mw.logObject(all_aliases)

	-- handle undeclared and deprecated		-- handle undeclared and deprecated
	local already_seen = {}		local already_seen = {}

ProcrastinatingReader at 14:03, 6 December 2020

2020-12-06T14:03:32Z

← Previous revision		Revision as of 14:03, 6 December 2020
Line 263:		Line 263:
	end		end
	end		end

			mw.logObject(res)

	return res		return res
Line 269:		Line 271:
	-- wraps report in hidden frame		-- wraps report in hidden frame
	function wrapReport(report, template_name, options)		function wrapReport(report, template_name, options)
			mw.logObject(report)
	if util.empty( report ) then return '' end		if util.empty( report ) then return '' end
	local naked = mw.title.new( template_name )['text']		local naked = mw.title.new( template_name )['text']

ProcrastinatingReader at 13:57, 6 December 2020

2020-12-06T13:57:33Z

← Previous revision		Revision as of 13:57, 6 December 2020
Line 318:		Line 318:
	local report_params = function( key, param_names )		local report_params = function( key, param_names )
	local res = replace_macros( options[key], param_names )		local res = replace_macros( options[key], param_names )
	res = frame:preprocess(res)		res = frame:preprocess(res or '')
	report = report .. ( res or '' )		report = report .. ( res or '' )
	return res		return res

ProcrastinatingReader at 13:56, 6 December 2020

2020-12-06T13:56:54Z

← Previous revision		Revision as of 13:56, 6 December 2020
Line 247:		Line 247:
	if table_name then		if table_name then
	res[table_name] = res[table_name] or {}		res[table_name] = res[table_name] or {}
	res[table_name][p_name] = value		res[table_name][p_name] = value
			mw.logObject(res)
	end		end
	end		end
Line 272:		Line 273:
	naked = mw.ustring.gsub(naked, 'Infobox', 'infobox', 1)		naked = mw.ustring.gsub(naked, 'Infobox', 'infobox', 1)

	mw.log(report)
	report = ( options['wrapper-prefix'] or "<div class = 'paramvalidator-wrapper'><span class='paramvalidator-error'>" )		report = ( options['wrapper-prefix'] or "<div class = 'paramvalidator-wrapper'><span class='paramvalidator-error'>" )
	.. report		.. report
Line 279:		Line 279:
	report = mw.ustring.gsub( report, 'tname_naked', naked )		report = mw.ustring.gsub( report, 'tname_naked', naked )
	report = mw.ustring.gsub( report, 'templatename', template_name )		report = mw.ustring.gsub( report, 'templatename', template_name )

	return report		return report
	end		end
Line 317:		Line 318:
	local report_params = function( key, param_names )		local report_params = function( key, param_names )
	local res = replace_macros( options[key], param_names )		local res = replace_macros( options[key], param_names )
			res = frame:preprocess(res)
	report = report .. ( res or '' )		report = report .. ( res or '' )
	return res		return res

ProcrastinatingReader: +

2020-12-06T13:42:46Z

← Previous revision		Revision as of 13:42, 6 December 2020
Line 194:		Line 194:
	template_name = mw.ustring.gsub( template_name, '/sandbox', '', 1 )		template_name = mw.ustring.gsub( template_name, '/sandbox', '', 1 )
	local td_source = util.build_namelist( template_name, subpages )		local td_source = util.build_namelist( template_name, subpages )
	if ~~t_args~~['td_source'] then		if frame.args['td_source'] then
	table.insert(td_source, ~~t_args~~['td_source'])		table.insert(td_source, frame.args['td_source'])
	end		end

ProcrastinatingReader: manual source

2020-12-06T13:37:05Z

manual source

← Previous revision		Revision as of 13:37, 6 December 2020
Line 194:		Line 194:
	template_name = mw.ustring.gsub( template_name, '/sandbox', '', 1 )		template_name = mw.ustring.gsub( template_name, '/sandbox', '', 1 )
	local td_source = util.build_namelist( template_name, subpages )		local td_source = util.build_namelist( template_name, subpages )
			if t_args['td_source'] then
			table.insert(td_source, t_args['td_source'])
			end

	local templatedata = readTemplateData( td_source )		local templatedata = readTemplateData( td_source )
	local td_params = templatedata and templatedata.params		local td_params = templatedata and templatedata.params