Module:Outils/Test
Ce module contient différentes fonctions pratiques.
Résumé des fonctions
modifierFonctions exportables :
trim( texte )
– similaire à mw.text.trim mais retourne nil lorsque la chaine est vide ou lorsque le paramètre n'est pas une chaine (ne génère pas d'erreur).extractArgs( frame )
– retourne une table avec les paramètres, à partir d'un objet frame ou d'une table.validTextArg( args, name, ... )
– retourne le premier paramètre chaine non vide à partir de la table des paramètres et d'une liste de noms de paramètres.notEmpty( var, ... )
– retourne le premier élément non vide.
Détail par fonction
modifierextractArgs
modifierSyntaxe
modifierOutils.extractArgs( frame )
- Si frame est une table simple et non un objet Frame, retourne
frame
- Si frame est un objet créé par
#invoke:
, retourne les paramètres passés à #invoke: (en priorité) et ceux passés au modèle.
Attention : cette fonction peut modifier la table frame.getParent().args
. S'il est probable qu'un autre module passe un objet frame
à votre fonction, il est préférable de l'indiquer dans la documentation.
Exemple
modifierfunction p.maFonction( frame )
local args = Outils.extractArgs( frame )
return ( args[1] or 'nil' ) .. ' ' .. ( args[2] or 'nil' ) .. ' ' .. ( args['nom'] or 'nil' )
end
- appel par table :
p.maFonction{ 'oui', 'deux', nom = 'Zebulon84' }
→ « oui deux Zebulon84 » - appel par
#invoke:
:{{#invoke:p |maFonction |oui |2 |nom = Zebulon84}}
→ « oui deux Zebulon84 » - appel par modèle
{{Ma fonction}}
:- le modèle contient
{{#invoke:p |maFonction}}
,{{Ma fonction|oui | deux |nom= Zebulon84}}
→ « oui deux Zebulon84 »
- le modèle contient
{{#invoke:p |maFonction |nom = Zebulon84}}
{{Ma fonction |oui | deux }}
→ « oui deux Zebulon84 »{{Ma fonction |oui | deux |nom = Hexasoft}}
→ « oui deux Zebulon84 »
- le modèle contient
{{#invoke:p |maFonction |nom = {{{nom|Zebulon84}}} }}
{{Ma fonction |oui | deux }}
→ « oui deux Zebulon84 »{{Ma fonction |oui | deux |nom = Hexasoft}}
→ « oui deux Hexasoft »{{Ma fonction |oui | deux |nom = }}
→ « oui deux nil »
- le modèle contient
validTextArg
modifierSyntaxe
modifierOutils.validTextArg( args, name, ... )
Retourne args.name si c'est un texte valide.
Sinon teste les autres éléments transmis à la fonction. S'il n'y en a pas ou s'ils ne correspondent pas à un texte valide dans la table args, retourne nil
Cette fonction est pratique pour obtenir le contenu d'un paramètre pouvant avoir plusieurs noms.
Attention : les nombres (type 'number') ne sont pas considérés comme un texte valide.
exemple
modifierlocal args = { '1', '2', 3, nom1 = nil, nom2 = '', nom3 = 'a' }
local v1 = Outils.validTextArg( args, 'nom1' } -- v1 = nil
local v2 = Outils.validTextArg( args, 'nom1', 'nom2', 'nom3' ) -- v2 = 'a'
local v3 = Outils.validTextArg( args, 3, 2, 1 ) -- v3 = '2'
local function validArg( ... )
return Outils.validTextArg( args, ... }
end
local v4 = validArg( 'nom' ) -- v4 = nil
local v5 = validArg( 'nom2', 'nom3' ) -- v5 = 'a'
notEmpty
modifierOutils.notEmpty( var, ... )
Retourne le premier élément non vide, sinon retourne nil.
- Sont considérés comme vide :
nil, false, '', ' \t \n ', 0, { }
- Sont considérés comme non vide :
true, 'blabla', ' ', 1, { '' }, { {} }, function () end
La documentation de ce module est générée par le modèle {{Documentation module}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (modifier).
Voir les statistiques d'appel depuis le wikicode sur l'outil wstat et les appels depuis d'autres modules.
local p = require( 'Module:UnitTests' )
local Outils = require( 'Module:Outils/Bac à sable' )
function p:test01_trim()
self:equals('rien', Outils.trim(), nil)
self:equals('nil', Outils.trim( nil ), nil)
self:equals('chaine vide', Outils.trim( '' ), nil)
self:equals('nombre', Outils.trim( 5 ), nil)
self:equals('table', Outils.trim( { 'bla bla' } ), nil)
self:equals('fonction', Outils.trim( function() return 'bla bla' end ), nil)
self:equals('chaine simple : blabla', Outils.trim( 'bla bla' ), 'bla bla' )
self:equals('espace avant', Outils.trim( ' bla bla' ), 'bla bla' )
self:equals('espace après', Outils.trim( 'bla bla ' ), 'bla bla' )
self:equals('espace avant / après', Outils.trim( ' bla bla ' ), 'bla bla' )
self:equals('\\n\\f\\r\\n\\t bla bla \\n\\f\\r\\n\\t', Outils.trim( '\n\f\r\n\t bla bla \n\f\r\n\t' ), 'bla bla' )
self:equals('\\194\\160bla bla .. mw.ustring.char( 8195 )', Outils.trim( '\194\160bla bla' .. mw.ustring.char( 8195 ) ), '\194\160bla bla' .. mw.ustring.char( 8195 ) )
end
function p:test02_notEmpty()
self:equals('nil', Outils.notEmpty( nil ), nil )
self:equals('nil, "", {}', Outils.notEmpty( nil, "", {} ), nil )
self:equals('"\\n ", "", 5', Outils.notEmpty( "\n ", "", 5 ), 5 )
self:equals_deep('"\\n ", "", { 5 }', Outils.notEmpty( "\n ", "", { 5 } ), { 5 } )
self:equals_deep('false, 0, { {} }', Outils.notEmpty( false, 0, { {} } ), { {} } )
self:equals( 'function', Outils.notEmpty( p.test01_trim ), p.test01_trim )
self:equals( '" ", true', Outils.notEmpty( " ", true ), true )
end
return p