Module:Variables

Documentation for Module:Variables Jump to code ↴ [ edit | purge ]

See also: Extension:Variables

This module provides a Lua interface for the parser functions provided by Extension:Variables.

Usage

Function names are identical to the parser function names.

Variables.vardefineecho

Returns the value as it was stored (as a string). Should only be used to verify the stored value, not for inline declarations.

Differences

• Returns nil instead of empty strings (use p.varexists() to check for variables holding an empty string).
• varexists() returns a boolean instead of 1 or nil.

Tests

N 4 tests failed.

	Name	Expected	Actual
Y	test_var_defined
Y	test_var_defined_empty
N	test_var_defined_empty_default	Module:Variables/testcases:126:Failed to assert that nil equals expected 5
Y	test_var_not_defined
N	test_var_not_defined_default	Module:Variables/testcases:134:Failed to assert that nil equals expected 5
Y	test_vardefine_boolean
Y	test_vardefine_function_throws
N	test_vardefine_nil	Lua error -- Module:Variables/testcases:35: bad argument #2 to 'vardefine' (boolean, string or number expected, got nil)
Y	test_vardefine_number
Y	test_vardefine_string
Y	test_vardefine_table_throws
Y	test_vardefineecho_boolean
Y	test_vardefineecho_function_throws
N	test_vardefineecho_nil	Lua error -- Module:Variables/testcases:89: bad argument #2 to 'vardefineecho' (boolean, string or number expected, got nil)
Y	test_vardefineecho_number
Y	test_vardefineecho_returns
Y	test_vardefineecho_string
Y	test_vardefineecho_table_throws
Y	test_varexists_false
Y	test_varexists_true

--------------------------------------------------------------------------------
-- Imports
--------------------------------------------------------------------------------

local libraryUtil = require( 'libraryUtil' )

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local h = {}

function h.parser_function( func, args )
  local frame = frame
  if not frame then
    mw.log( 'Frame generated.' )
    frame = mw.getCurrentFrame()
  end

  return frame:callParserFunction( func, args )
end

--------------------------------------------------------------------------------
-- Functions
--------------------------------------------------------------------------------

local p = {}

function p.vardefine( name, value )
  libraryUtil.checkType( 'vardefine', 1, name, 'string' )
  libraryUtil.checkTypeMulti( 'vardefine', 2, value, { 'boolean', 'string', 'number' }, true )

  h.parser_function( '#vardefine', { name, tostring(value) } )
end

function p.vardefineecho( name, value )
  libraryUtil.checkType( 'vardefineecho', 1, name, 'string' )
  libraryUtil.checkTypeMulti( 'vardefineecho', 2, value, { 'boolean', 'string', 'number' }, true )

  return h.parser_function( '#vardefineecho', { name, tostring(value) } )
end

function p.varexists( name )
  libraryUtil.checkType( 'varexists', 1, name, 'string' )

  return ( h.parser_function( '#varexists', name ) == '1' )
end

function p.var( name )
  libraryUtil.checkType( 'var', 1, name, 'string' )

  if p.varexists( name ) then
    return h.parser_function( '#var', name )
  end
end

--------------------------------------------------------------------------------
-- Return
--------------------------------------------------------------------------------

return p