Module:Params/testcases

Add links
From English Wikipedia @ Freddythechick
Here are some tools for testing {{#invoke:params}} and its sandbox version.

This is the testcases page for checking the behaviour of Module:Params.

As the module provides most of its functionalities only when called by templates, this page uses helper subtemplates to do its tests. You can find a complete list of these here. Several helper subtemplates come in two versions, one that depends on {{#invoke:params}} and one that depends on {{#invoke:params/sandbox}}. Example templates, used by the documentation page, are available at /doc/examples.

General tests

Multi-purpose helper subtemplates

Helper subtemplate {{./tmulti}}

The {{./tmulti}} subtemplate allows to simulate in one single call both the incoming parameters and the parameters manually concatenated to {{#invoke:params|...|function|...}}, using a single hyphen (-) as a delimiter between the two groups. This allows to make general experiments directly from the preview window without having to edit separate templates.

For instance, writing

<syntaxhighlight lang="wikitext">1: hello
2: world
foo: bar</syntaxhighlight>

will simulate a call with |1=hello, |2=world, and |foo=bar to a template whose content is <syntaxhighlight lang="wikitext" inline></syntaxhighlight>, thus producing:

1: hello
2: world
foo: bar

information Note: An identical subtemplate that uses Module:Params/sandbox instead of Module:Params is available at {{./tmulti sandbox}}.

Single-purpose helper subtemplates

Helper subtemplate {{./tdelimiters}}

The {{./tdelimiters}} subtemplate allows to test the behaviour of delimiter strings between the arguments it was called with, invoking several functions of the module at once. For instance,

<syntaxhighlight lang="wikitext">

list [HEADER][1=foo], [2=bar], [3=Jupiter] and [hello=world][FOOTER]
list_values [HEADER][foo], [bar], [Jupiter] and [world][FOOTER]
for_each [HEADER][1=foo], [2=bar], [3=Jupiter] and [hello=world][FOOTER]
call_for_each [HEADER][1=1][2=foo], [1=2][2=bar], [1=3][2=Jupiter] and [1=hello][2=world][FOOTER]
invoke_for_each [HEADER][1=1][2=foo], [1=2][2=bar], [1=3][2=Jupiter] and [1=hello][2=world][FOOTER]
magic_for_each [HEADER][foo], [bar], [Jupiter] and [world][FOOTER]
call_for_each_value [HEADER][1=foo], [1=bar], [1=Jupiter] and [1=world][FOOTER]
invoke_for_each_value [HEADER][1=foo], [1=bar], [1=Jupiter] and [1=world][FOOTER]
magic_for_each_value [HEADER][foo], [bar], [Jupiter] and [world][FOOTER]

</syntaxhighlight>

generates

list [HEADER][1=foo], [2=bar], [3=Jupiter] and [hello=world][FOOTER]
list_values [HEADER][foo], [bar], [Jupiter] and [world][FOOTER]
for_each [HEADER][1=foo], [2=bar], [3=Jupiter] and [hello=world][FOOTER]
call_for_each [HEADER][1=1][2=foo], [1=2][2=bar], [1=3][2=Jupiter] and [1=hello][2=world][FOOTER]
invoke_for_each [HEADER][1=1][2=foo], [1=2][2=bar], [1=3][2=Jupiter] and [1=hello][2=world][FOOTER]
magic_for_each [HEADER][foo], [bar], [Jupiter] and [world][FOOTER]
call_for_each_value [HEADER][1=foo], [1=bar], [1=Jupiter] and [1=world][FOOTER]
invoke_for_each_value [HEADER][1=foo], [1=bar], [1=Jupiter] and [1=world][FOOTER]
magic_for_each_value [HEADER][foo], [bar], [Jupiter] and [world][FOOTER]

information Note: An identical subtemplate that uses Module:Params/sandbox instead of Module:Params is available at {{./tdelimiters sandbox}}.

Helper subtemplate {{./tnumerical}}

The {{./tnumerical}} subtemplate allows to test the behaviour of functions that focus on numerical and sequential arguments. As these require at most two arguments, the template uses the |#first= and |#second= special parameters to do its tests. For instance,

<syntaxhighlight lang="wikitext">

Function name Result for |#first=2 and |#second=2
squeezing |1=minus two|2=zero|3=one|4=two|5=three|6=nineteen|7=twenty
filling_the_gaps |-2=minus two|-1=|0=zero|1=one|2=two|3=three|4=|5=|6=|7=|8=|9=|10=|11=|12=|13=|14=|15=|16=|17=|18=|19=nineteen|20=twenty
clearing |1=one|2=two|3=three
cutting|2|2] |-2=minus two|0=zero|16=nineteen|17=twenty
cropping|2|2 |0=zero|1=one|2=two|3=three
purging|2|2 |-2=minus two|0=zero|1=one|17=nineteen|18=twenty
backpurging|2|2 |-2=minus two|0=zero|1=three|17=nineteen|18=twenty
rotating |1=twenty|2=nineteen|18=three|19=two|20=one|21=zero|23=minus two
sorting_sequential_values |-2=minus two|0=zero|1=one|2=three|3=two|19=nineteen|20=twenty

</syntaxhighlight>

generates

Function name Result for |#first=2 and |#second=2
squeezing |1=minus two|2=zero|3=one|4=two|5=three|6=nineteen|7=twenty
filling_the_gaps |-2=minus two|-1=|0=zero|1=one|2=two|3=three|4=|5=|6=|7=|8=|9=|10=|11=|12=|13=|14=|15=|16=|17=|18=|19=nineteen|20=twenty
clearing |1=one|2=two|3=three
cutting|2|2] |-2=minus two|0=zero|16=nineteen|17=twenty
cropping|2|2 |0=zero|1=one|2=two|3=three
purging|2|2 |-2=minus two|0=zero|1=one|17=nineteen|18=twenty
backpurging|2|2 |-2=minus two|0=zero|1=three|17=nineteen|18=twenty
rotating |1=twenty|2=nineteen|18=three|19=two|20=one|21=zero|23=minus two
sorting_sequential_values |-2=minus two|0=zero|1=one|2=three|3=two|19=nineteen|20=twenty

information Note: An identical subtemplate that uses Module:Params/sandbox instead of Module:Params is available at {{./tnumerical sandbox}}.

Helper subtemplate {{./tmaps}}

The {{./tmaps}} subtemplate allows to test the behaviour of all the mapping_* and renaming_* class of modifiers. As the template generates a very large page its expansion is not shown here. For more information please visit its documentation page.

information Note: An identical subtemplate that uses Module:Params/sandbox instead of Module:Params is available at {{./tmaps sandbox}}.

Helper subtemplate {{./tcompare separated entries}}

The {{./tcompare separated entries}} subtemplate compares the behaviours of Module:Params with that of Module:Separated entries. For instance,

<syntaxhighlight lang="wikitext">Without a last separator:

<syntaxhighlight lang="wikitext" inline>one+two+three+foo+bar+Jupiter</syntaxhighlight>

one+two+three+foo+bar+Jupiter

<syntaxhighlight lang="wikitext" inline>one+two+three+foo+bar+Jupiter</syntaxhighlight>

one+two+three+foo+bar+Jupiter

With a last separator (::):

<syntaxhighlight lang="wikitext" inline>one+two+three+foo+bar::Jupiter</syntaxhighlight>

one+two+three+foo+bar::Jupiter

<syntaxhighlight lang="wikitext" inline>one+two+three+foo+bar::Jupiter</syntaxhighlight>

one+two+three+foo+bar::Jupiter

With a last separator (::) and cutting the first three parameters:

<syntaxhighlight lang="wikitext" inline>foo+bar::Jupiter</syntaxhighlight>

foo+bar::Jupiter

<syntaxhighlight lang="wikitext" inline>foo+bar::Jupiter</syntaxhighlight>

foo+bar::Jupiter

</syntaxhighlight>

generates

Without a last separator:

<syntaxhighlight lang="wikitext" inline>one+two+three+foo+bar+Jupiter</syntaxhighlight>

one+two+three+foo+bar+Jupiter

<syntaxhighlight lang="wikitext" inline>one+two+three+foo+bar+Jupiter</syntaxhighlight>

one+two+three+foo+bar+Jupiter

With a last separator (::):

<syntaxhighlight lang="wikitext" inline>one+two+three+foo+bar::Jupiter</syntaxhighlight>

one+two+three+foo+bar::Jupiter

<syntaxhighlight lang="wikitext" inline>one+two+three+foo+bar::Jupiter</syntaxhighlight>

one+two+three+foo+bar::Jupiter

With a last separator (::) and cutting the first three parameters:

<syntaxhighlight lang="wikitext" inline>foo+bar::Jupiter</syntaxhighlight>

foo+bar::Jupiter

<syntaxhighlight lang="wikitext" inline>foo+bar::Jupiter</syntaxhighlight>

foo+bar::Jupiter

Testing individual functions

Testing the list function

Helper subtemplate {{./techo}}

The {{./techo}} subtemplate calls the {{#invoke:params|list}} function to echo the code it was called with.

Example:

Markup Renders as 
{{module:params/testcases/techo|hello|world|foo=bar}}

{{Module:Params/testcases/techo|1=hello|2=world|foo=bar}}

Dummies

See also

Retrieved from "https://enwiki.freddythechick.net/index.php?title=Module:Params/testcases&oldid=1749704"