Module:Template test case: Difference between revisions
(move the logic for finding the options into the exports - it seemed a bit unintuitive to have invocation objects handling argument code as well) |
(make a template class and add code to set template objects in the test case class) |
||
Line 9: | Line 9: | ||
------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ||
-- | -- Template class | ||
------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ||
local Template = {} | |||
Template.__index = Template | |||
-- | function Template.new(invocationObj, options, titleCallback) | ||
do | local obj = setmetatable({}, Template) | ||
-- Set input | |||
for k, v in pairs(options or {}) do | |||
obj[k] = v | |||
end | |||
obj.invocation = invocationObj | |||
-- Validate template | |||
if not obj.template then | |||
if titleCallback then | |||
obj.title = titleCallback() | |||
else | else | ||
template | error('no template or title callback specified', 2) | ||
end | end | ||
end | end | ||
return obj | |||
if | end | ||
function Template:getFullPage() | |||
if self.template then | |||
local strippedTemplate, hasColon = self.template:gsub('^:', '', 1) | |||
local ns = strippedTemplate:match('^(.-):') | |||
ns = ns and mw.site.namespaces[ns] | |||
if ns then | |||
return strippedTemplate | |||
elseif hasColon then | |||
return strippedTemplate -- Main namespace | |||
else | |||
return mw.site.namespaces[10].name .. ':' .. strippedTemplate | |||
end | end | ||
else | |||
return self.title.prefixedText | |||
end | end | ||
end | end | ||
function Template:getName() | |||
if self.template then | |||
return self.template | |||
local | else | ||
local | return require('Module:Template invocation').name(self.title) | ||
end | |||
return | end | ||
function Template:makeLink(display) | |||
if display then | |||
return string.format('[[:%s|%s]]', self:getFullPage(), display) | |||
else | |||
return string.format('[[:%s]]', self:getFullPage()) | |||
end | |||
end | |||
function Template:makeBraceLink(display) | |||
display = display or self:getName() | |||
local link = self:makeLink(display) | |||
return mw.text.nowiki('{{') .. link .. mw.text.nowiki('}}') | |||
end | |||
function Template:getInvocation(format) | |||
local invocation = self.invocation:getInvocation(self:getName()) | |||
invocation = mw.text.nowiki(invocation) | |||
if format == 'code' then | |||
invocation = '<code>' .. invocation .. '</code>' | |||
elseif format == 'pre' then | |||
invocation = '<pre style="white-space: pre-wrap;">' .. invocation .. '</pre>' | |||
invocation = mw.getCurrentFrame():preprocess(invocation) | |||
end | |||
return invocation | |||
end | |||
function Template:getOutput() | |||
return self.invocation:getOutput(self:getName()) | |||
end | end | ||
Line 65: | Line 98: | ||
TestCase.__index = TestCase | TestCase.__index = TestCase | ||
function TestCase.new(invocationObj | function TestCase.new(invocationObj, options) | ||
local obj = setmetatable({}, TestCase) | local obj = setmetatable({}, TestCase) | ||
-- Validate options | |||
do | |||
local highestNum = 0 | |||
for k in pairs(options) do | |||
if type(k) == 'string' then | |||
local num = k:match('([1-9][0-9]*)$') | |||
num = tonumber(num) | |||
if num > highestNum then | |||
highestNum = num | |||
end | |||
end | |||
end | |||
for i = 3, highestNum do | |||
if not options['template' .. i] then | |||
error(string.format( | |||
"one or more options ending in '%d' were " .. | |||
"detected, but no 'template%d' option was found", | |||
i, i | |||
), 2) | |||
end | |||
end | |||
end | |||
-- Separate general options from options for specific templates | |||
local templateOptions = mTableTools.numData(options, true) | |||
options = templateOptions.other | |||
templateOptions.other = nil | |||
-- Make the template objects | |||
obj.templates = {} | |||
local function templateTitleCallback() | |||
return mw.title.getCurrentTitle().basePageTitle | |||
end | |||
obj.templates[1] = Template.new( | |||
invocationObj, | |||
templateOptions[1], | |||
templateTitleCallback | |||
) | |||
obj.templates[2] = Template.new( | |||
invocationObj, | |||
options, | |||
function () | |||
return templateTitleCallback():subPageTitle('sandbox') | |||
end | |||
) | |||
for i = 3, #templateOptions do | |||
table.insert(obj.templates, Template.new( | |||
invocationObj, | |||
templateOptions[i] | |||
)) | |||
end | |||
return obj | return obj | ||
end | end | ||
------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |