Nonbinary Wiki

Module:Template test case: Difference between revisions

Module Discussion

Module:Template test case (edit)

Revision as of 12:00, 21 May 2021

9,951 bytes added ,  3 years ago
m
87 revisions imported from wikipedia:Module:Template_test_case
(add more messages and use the sandboxSubpage config value to generate sandbox template names)
m (87 revisions imported from wikipedia:Module:Template_test_case)
 
(46 intermediate revisions by 11 users not shown)
Line 1: Line 1:
-- This module provides several methods to generate test cases.
--[[
  A module for generating test case templates.
 
  This module incorporates code from the English Wikipedia's "Testcase table"
  module,[1] written by Frietjes [2] with contributions by Mr. Stradivarius [3]
  and Jackmcbarn,[4] and the English Wikipedia's "Testcase rows" module,[5]
  written by Mr. Stradivarius.
 
  The "Testcase table" and "Testcase rows" modules are released under the
  CC BY-SA 3.0 License [6] and the GFDL.[7]
 
  License: CC BY-SA 3.0 and the GFDL
  Author: Mr. Stradivarius
 
  [1] https://en.wikipedia.org/wiki/Module:Testcase_table
  [2] https://en.wikipedia.org/wiki/User:Frietjes
  [3] https://en.wikipedia.org/wiki/User:Mr._Stradivarius
  [4] https://en.wikipedia.org/wiki/User:Jackmcbarn
  [5] https://en.wikipedia.org/wiki/Module:Testcase_rows
  [6] https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License
  [7] https://en.wikipedia.org/wiki/Wikipedia:Text_of_the_GNU_Free_Documentation_License
]]


-- Load required modules
-- Load required modules
local yesno = require('Module:Yesno')
local yesno = require('Module:Yesno')
local mTableTools = require('Module:TableTools')


-- Set constants
-- Set constants
Line 34: Line 54:
getFullPage = true,
getFullPage = true,
getName = true,
getName = true,
makeHeading = true,
makeHeader = true,
getOutput = true
getOutput = true
}
}
Line 74: Line 94:


function Template:getFullPage()
function Template:getFullPage()
if self.template then
if not self.template then
return self.title.prefixedText
elseif self.template:sub(1, 7) == '#invoke' then
return 'Module' .. self.template:sub(8):gsub('|.*', '')
else
local strippedTemplate, hasColon = self.template:gsub('^:', '', 1)
local strippedTemplate, hasColon = self.template:gsub('^:', '', 1)
hasColon = hasColon > 0
hasColon = hasColon > 0
Line 86: Line 110:
return mw.site.namespaces[10].name .. ':' .. strippedTemplate
return mw.site.namespaces[10].name .. ':' .. strippedTemplate
end
end
else
return self.title.prefixedText
end
end
end
end
Line 113: Line 135:
end
end


function Template:makeHeading()
function Template:makeHeader()
return self.heading or self:makeBraceLink()
return self.heading or self:makeBraceLink()
end
end


function Template:getInvocation(format)
function Template:getInvocation(format)
local invocation = self._invocation:getInvocation(self:getName())
local invocation = self._invocation:getInvocation{
template = self:getName(),
requireMagicWord = self.requireMagicWord,
}
if format == 'code' then
if format == 'code' then
invocation = '<code>' .. mw.text.nowiki(invocation) .. '</code>'
invocation = '<code>' .. mw.text.nowiki(invocation) .. '</code>'
elseif format == 'kbd' then
invocation = '<kbd>' .. mw.text.nowiki(invocation) .. '</kbd>'
elseif format == 'plain' then
elseif format == 'plain' then
invocation = mw.text.nowiki(invocation)
invocation = mw.text.nowiki(invocation)
Line 133: Line 160:


function Template:getOutput()
function Template:getOutput()
return self._invocation:getOutput(self:getName())
local protect = require('Module:Protect')
-- calling self._invocation:getOutput{...}
return protect(self._invocation.getOutput)(self._invocation, {
template = self:getName(),
requireMagicWord = self.requireMagicWord,
})
end
end


Line 149: Line 181:
columns = 'renderColumns',
columns = 'renderColumns',
rows = 'renderRows',
rows = 'renderRows',
tablerows = 'renderRows',
inline = 'renderInline',
cells = 'renderCells',
default = 'renderDefault'
default = 'renderDefault'
}
}
Line 156: Line 191:
obj.cfg = cfg
obj.cfg = cfg


-- Validate options
-- Separate general options from template options. Template options are
do
-- numbered, whereas general options are not.
local highestNum = 0
local generalOptions, templateOptions = {}, {}
for k in pairs(options) do
for k, v in pairs(options) do
if type(k) == 'string' then
local prefix, num
local num = k:match('([1-9][0-9]*)$')
if type(k) == 'string' then
num = tonumber(num)
prefix, num = k:match('^(.-)([1-9][0-9]*)$')
if num and num > highestNum then
highestNum = num
end
end
end
end
for i = 3, highestNum do
if prefix then
if not options['template' .. i] then
num = tonumber(num)
error(self:message(
templateOptions[num] = templateOptions[num] or {}
'missing-template-option-error',
templateOptions[num][prefix] = v
i, i
else
), 2)
generalOptions[k] = v
end
end
end
end
end


-- Separate general options from options for specific templates
-- Set general options
local templateOptions = mTableTools.numData(options, true)
generalOptions.showcode = yesno(generalOptions.showcode)
obj.options = templateOptions.other or {}
generalOptions.showheader = yesno(generalOptions.showheader) ~= false
generalOptions.showcaption = yesno(generalOptions.showcaption) ~= false
generalOptions.collapsible = yesno(generalOptions.collapsible)
generalOptions.notcollapsed = yesno(generalOptions.notcollapsed)
generalOptions.wantdiff = yesno(generalOptions.wantdiff)  
obj.options = generalOptions


-- Normalize boolean options
-- Preprocess template args
obj.options.showcode = yesno(obj.options.showcode)
for num, t in pairs(templateOptions) do
obj.options.collapsible = yesno(obj.options.collapsible)
if t.showtemplate ~= nil then
t.showtemplate = yesno(t.showtemplate)
end
end


-- Add default template options
-- Set up first two template options tables, so that if only the
-- "template3" is specified it isn't made the first template when the
-- the table options array is compressed.
templateOptions[1] = templateOptions[1] or {}
templateOptions[1] = templateOptions[1] or {}
templateOptions[2] = templateOptions[2] or {}
templateOptions[2] = templateOptions[2] or {}
-- Allow the "template" option to override the "template1" option for
-- backwards compatibility with [[Module:Testcase table]].
if generalOptions.template then
templateOptions[1].template = generalOptions.template
end
-- Add default template options
if templateOptions[1].template and not templateOptions[2].template then
if templateOptions[1].template and not templateOptions[2].template then
templateOptions[2].template = templateOptions[1].template
templateOptions[2].template = templateOptions[1].template ..
.. '/' .. obj.cfg.sandboxSubpage
'/' .. obj.cfg.sandboxSubpage
end
end
if not templateOptions[1].template then
if not templateOptions[1].template then
Line 201: Line 249:
)
)
end
end
-- Remove template options for any templates where the showtemplate
-- argument is false. This prevents any output for that template.
for num, t in pairs(templateOptions) do
if t.showtemplate == false then
templateOptions[num] = nil
end
end
-- Check for missing template names.
for num, t in pairs(templateOptions) do
if not t.template and not t.title then
error(obj:message(
'missing-template-option-error',
num, num
), 2)
end
end
-- Compress templateOptions table so we can iterate over it with ipairs.
templateOptions = (function (t)
local nums = {}
for num in pairs(t) do
nums[#nums + 1] = num
end
table.sort(nums)
local ret = {}
for i, num in ipairs(nums) do
ret[i] = t[num]
end
return ret
end)(templateOptions)
-- Don't require the __TEMPLATENAME__ magic word for nowiki invocations if
-- there is only one template being output.
if #templateOptions <= 1 then
templateOptions[1].requireMagicWord = false
end
mw.logObject(templateOptions)


-- Make the template objects
-- Make the template objects
obj.templates = {}
obj.templates = {}
for i, t in ipairs(templateOptions) do
for i, options in ipairs(templateOptions) do
table.insert(obj.templates, Template.new(invocationObj, t))
table.insert(obj.templates, Template.new(invocationObj, options))
end
 
-- Add tracking categories. At the moment we are only tracking templates
-- that use any "heading" parameters or an "output" parameter.
obj.categories = {}
for k, v in pairs(options) do
if type(k) == 'string' and k:find('heading') then
obj.categories['Test cases using heading parameters'] = true
elseif k == 'output' then
obj.categories['Test cases using output parameter'] = true
end
end
end


Line 228: Line 327:
local out = obj:getOutput()
local out = obj:getOutput()
-- Remove the random parts from strip markers.
-- Remove the random parts from strip markers.
out = out:gsub('(%cUNIQ).-(QINU%c)', '%1%2')
out = out:gsub('(\127\'"`UNIQ.-)%-%x+%-(QINU`"\'\127)', '%1%2')
return out
return out
end
end
Line 242: Line 341:


function TestCase:makeCollapsible(s)
function TestCase:makeCollapsible(s)
local title = self.options.title or self.templates[1]:makeHeader()
if self.options.titlecode then
title = self.templates[1]:getInvocation('kbd')
end
local isEqual = self:templateOutputIsEqual()
local isEqual = self:templateOutputIsEqual()
local root = mw.html.create('table')
local root = mw.html.create('table')
if self.options.wantdiff then
root
root
:addClass('collapsible')
:addClass('mw-collapsible')
:addClass(isEqual and 'collapsed' or nil)
if self.options.notcollapsed == false then
root
:addClass('mw-collapsed')
end
root
:css('background-color', 'transparent')
:css('width', '100%')
:css('border', 'solid silver 1px')
:tag('tr')
:tag('th')
:css('background-color', isEqual and 'yellow' or '#90a8ee')
:wikitext(title)
:done()
:done()
:tag('tr')
:tag('td')
:newline()
:wikitext(s)
:newline()
else
root
:addClass('mw-collapsible')
if self.options.notcollapsed == false then
root
:addClass('mw-collapsed')
end
if self.options.notcollapsed ~= true or false then
root
:addClass(isEqual and 'mw-collapsed' or nil)
end
root
:css('background-color', 'transparent')
:css('background-color', 'transparent')
:css('width', '100%')
:css('width', '100%')
Line 253: Line 387:
:tag('th')
:tag('th')
:css('background-color', isEqual and 'lightgreen' or 'yellow')
:css('background-color', isEqual and 'lightgreen' or 'yellow')
:wikitext(self.options.title or self.templates[1]:makeHeading())
:wikitext(title)
:done()
:done()
:done()
:done()
:tag('tr')
:tag('tr')
:tag('td')
:tag('td')
:newline()
:wikitext(s)
:wikitext(s)
:newline()
end
return tostring(root)
return tostring(root)
end
end
Line 271: Line 408:


local tableroot = root:tag('table')
local tableroot = root:tag('table')
tableroot
:addClass(self.options.class)
:cssText(self.options.style)
:tag('caption')
:wikitext(self.options.caption or self:message('columns-header'))


-- Headings
if self.options.showheader then
local headingRow = tableroot:tag('tr')
-- Caption
if self.options.rowheader then
if self.options.showcaption then
-- rowheader is correct here. We need to add another th cell if
tableroot
-- rowheader is set further down, even if heading0 is missing.
:addClass(self.options.class)
headingRow:tag('th'):wikitext(self.options.heading0)
:cssText(self.options.style)
end
:tag('caption')
local width
:wikitext(self.options.caption or self:message('columns-header'))
if #self.templates > 0 then
end
width = tostring(math.floor(100 / #self.templates)) .. '%'
 
else
-- Headers
width = '100%'
local headerRow = tableroot:tag('tr')
end
if self.options.rowheader then
for i, obj in ipairs(self.templates) do
-- rowheader is correct here. We need to add another th cell if
headingRow
-- rowheader is set further down, even if heading0 is missing.
:tag('th')
headerRow:tag('th'):wikitext(self.options.heading0)
:css('width', width)
end
:wikitext(obj:makeHeading())
local width
if #self.templates > 0 then
width = tostring(math.floor(100 / #self.templates)) .. '%'
else
width = '100%'
end
for i, obj in ipairs(self.templates) do
headerRow
:tag('th')
:css('width', width)
:wikitext(obj:makeHeader())
end
end
end


Line 307: Line 450:
-- Template output
-- Template output
for i, obj in ipairs(self.templates) do
for i, obj in ipairs(self.templates) do
dataRow:tag('td')
if self.options.output == 'nowiki+' then
:newline()
dataRow:tag('td')
:wikitext(self:getTemplateOutput(obj))
:newline()
:wikitext(self.options.after)
:wikitext(self.options.before)
:wikitext(self:getTemplateOutput(obj))
:wikitext(self.options.after)
:wikitext('<pre style="white-space: pre-wrap;">')
:wikitext(mw.text.nowiki(self.options.before or ""))
:wikitext(mw.text.nowiki(self:getTemplateOutput(obj)))
:wikitext(mw.text.nowiki(self.options.after or ""))
:wikitext('</pre>')
elseif self.options.output == 'nowiki' then
dataRow:tag('td')
:newline()
:wikitext(mw.text.nowiki(self.options.before or ""))
:wikitext(mw.text.nowiki(self:getTemplateOutput(obj)))
:wikitext(mw.text.nowiki(self.options.after or ""))
else
dataRow:tag('td')
:newline()
:wikitext(self.options.before)
:wikitext(self:getTemplateOutput(obj))
:wikitext(self.options.after)
end
end
end
Line 336: Line 499:


for _, obj in ipairs(self.templates) do
for _, obj in ipairs(self.templates) do
-- Build the row HTML
local dataRow = tableroot:tag('tr')
tableroot
:tag('tr')
-- Header
:tag('td')
if self.options.showheader then
if self.options.format == 'tablerows' then
dataRow:tag('th')
:attr('scope', 'row')
:css('vertical-align', 'top')
:css('text-align', 'left')
:wikitext(obj:makeHeader())
dataRow:tag('td')
:css('vertical-align', 'top')
:css('padding', '0 1em')
:wikitext('→')
else
dataRow:tag('td')
:css('text-align', 'center')
:css('text-align', 'center')
:css('font-weight', 'bold')
:css('font-weight', 'bold')
:wikitext(obj:makeHeading())
:wikitext(obj:makeHeader())
:done()
dataRow = tableroot:tag('tr')
:done()
end
:tag('tr')
end
:tag('td')
:newline()
-- Template output
:wikitext(self:getTemplateOutput(obj))
if self.options.output == 'nowiki+' then
dataRow:tag('td')
:newline()
:wikitext(self:getTemplateOutput(obj))
:wikitext('<pre style="white-space: pre-wrap;">')
:wikitext(mw.text.nowiki(self:getTemplateOutput(obj)))
:wikitext('</pre>')
elseif self.options.output == 'nowiki' then
dataRow:tag('td')
:newline()
:wikitext(mw.text.nowiki(self:getTemplateOutput(obj)))
else
dataRow:tag('td')
:newline()
:wikitext(self:getTemplateOutput(obj))
end
end
 
return tostring(root)
end
 
function TestCase:renderInline()
local arrow = mw.language.getContentLanguage():getArrow('forwards')
local ret = {}
for i, obj in ipairs(self.templates) do
local line = {}
line[#line + 1] = self.options.prefix or '* '
if self.options.showcode then
line[#line + 1] = obj:getInvocation('code')
line[#line + 1] = ' '
line[#line + 1] = arrow
line[#line + 1] = ' '
end
if self.options.output == 'nowiki+' then
line[#line + 1] = self:getTemplateOutput(obj)
line[#line + 1] = '<pre style="white-space: pre-wrap;">'
line[#line + 1] = mw.text.nowiki(self:getTemplateOutput(obj))
line[#line + 1] = '</pre>'
elseif self.options.output == 'nowiki' then
line[#line + 1] = mw.text.nowiki(self:getTemplateOutput(obj))
else
line[#line + 1] = self:getTemplateOutput(obj)
end
ret[#ret + 1] = table.concat(line)
end
if self.options.addline then
local line = {}
line[#line + 1] = self.options.prefix or '* '
line[#line + 1] = self.options.addline
ret[#ret + 1] = table.concat(line)
end
return table.concat(ret, '\n')
end
 
function TestCase:renderCells()
local root = mw.html.create()
local dataRow = root:tag('tr')
dataRow
:css('vertical-align', 'top')
:addClass(self.options.class)
:cssText(self.options.style)
 
-- Row header
if self.options.rowheader then
dataRow:tag('th')
:attr('scope', 'row')
:newline()
:wikitext(self.options.rowheader or self:message('row-header'))
end
-- Caption
if self.options.showcaption then
dataRow:tag('th')
:attr('scope', 'row')
:newline()
:wikitext(self.options.caption or self:message('columns-header'))
end
 
-- Show code
if self.options.showcode then
dataRow:tag('td')
:newline()
:wikitext(self:getInvocation('code'))
end
 
-- Template output
for i, obj in ipairs(self.templates) do
if self.options.output == 'nowiki+' then
dataRow:tag('td')
:newline()
:wikitext(self.options.before)
:wikitext(self:getTemplateOutput(obj))
:wikitext(self.options.after)
:wikitext('<pre style="white-space: pre-wrap;">')
:wikitext(mw.text.nowiki(self.options.before or ""))
:wikitext(mw.text.nowiki(self:getTemplateOutput(obj)))
:wikitext(mw.text.nowiki(self.options.after or ""))
:wikitext('</pre>')
elseif self.options.output == 'nowiki' then
dataRow:tag('td')
:newline()
:wikitext(mw.text.nowiki(self.options.before or ""))
:wikitext(mw.text.nowiki(self:getTemplateOutput(obj)))
:wikitext(mw.text.nowiki(self.options.after or ""))
else
dataRow:tag('td')
:newline()
:wikitext(self.options.before)
:wikitext(self:getTemplateOutput(obj))
:wikitext(self.options.after)
end
end
end


return tostring(root)
return tostring(root)
Line 361: Line 646:
for i, obj in ipairs(self.templates) do
for i, obj in ipairs(self.templates) do
ret[#ret + 1] = '<div style="clear: both;"></div>'
ret[#ret + 1] = '<div style="clear: both;"></div>'
ret[#ret + 1] = obj:makeBraceLink()
if self.options.showheader then
ret[#ret + 1] = self:getTemplateOutput(obj)
ret[#ret + 1] = obj:makeHeader()
end
if self.options.output == 'nowiki+' then
ret[#ret + 1] = self:getTemplateOutput(obj) .. '<pre style="white-space: pre-wrap;">' .. mw.text.nowiki(self:getTemplateOutput(obj)) .. '</pre>'
elseif self.options.output == 'nowiki' then
ret[#ret + 1] = mw.text.nowiki(self:getTemplateOutput(obj))
else
ret[#ret + 1] = self:getTemplateOutput(obj)
end
end
end
return table.concat(ret, '\n\n')
return table.concat(ret, '\n\n')
Line 373: Line 666:
if self.options.collapsible then
if self.options.collapsible then
ret = self:makeCollapsible(ret)
ret = self:makeCollapsible(ret)
end
for cat in pairs(self.categories) do
ret = ret .. string.format('[[Category:%s]]', cat)
end
end
return ret
return ret
Line 400: Line 696:
end
end


function NowikiInvocation:getInvocation(template)
function NowikiInvocation:getInvocation(options)
template = template:gsub('%%', '%%%%') -- Escape "%" with "%%"
local template = options.template:gsub('%%', '%%%%') -- Escape "%" with "%%"
local invocation, count = self.invocation:gsub(
local invocation, count = self.invocation:gsub(
self.cfg.templateNameMagicWordPattern,
self.cfg.templateNameMagicWordPattern,
template
template
)
)
if count < 1 then
if options.requireMagicWord ~= false and count < 1 then
error(self:message(
error(self:message(
'nowiki-magic-word-error',
'nowiki-magic-word-error',
Line 415: Line 711:
end
end


function NowikiInvocation:getOutput(template)
function NowikiInvocation:getOutput(options)
local invocation = self:getInvocation(template)
local invocation = self:getInvocation(options)
return mw.getCurrentFrame():preprocess(invocation)
return mw.getCurrentFrame():preprocess(invocation)
end
end
Line 436: Line 732:
end
end


function TableInvocation:getInvocation(template)
function TableInvocation:getInvocation(options)
if self.code then
if self.code then
local nowikiObj = NowikiInvocation(self.code, self.cfg)
local nowikiObj = NowikiInvocation.new(self.code, self.cfg)
return nowikiObj:getInvocation(template)
return nowikiObj:getInvocation(options)
else
else
return require('Module:Template invocation').invocation(
return require('Module:Template invocation').invocation(
template,
options.template,
self.invokeArgs
self.invokeArgs
)
)
Line 448: Line 744:
end
end


function TableInvocation:getOutput(template)
function TableInvocation:getOutput(options)
if (options.template:sub(1, 7) == '#invoke') then
local moduleCall = mw.text.split(options.template, '|', true)
local args = mw.clone(self.invokeArgs)
table.insert(args, 1, moduleCall[2])
return mw.getCurrentFrame():callParserFunction(moduleCall[1], args)
end
return mw.getCurrentFrame():expandTemplate{
return mw.getCurrentFrame():expandTemplate{
title = template,
title = options.template,
args = self.invokeArgs
args = self.invokeArgs
}
}
Line 456: Line 758:


-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
-- Exports
-- Bridge functions
--
-- These functions translate template arguments into forms that can be accepted
-- by the different classes, and return the results.
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------


local p = {}
local bridge = {}


function p.table(args, cfg)
function bridge.table(args, cfg)
cfg = cfg or mw.loadData(DATA_MODULE)
cfg = cfg or mw.loadData(DATA_MODULE)


Line 490: Line 795:
end
end


function p.nowiki(args, cfg)
function bridge.nowiki(args, cfg)
cfg = cfg or mw.loadData(DATA_MODULE)
cfg = cfg or mw.loadData(DATA_MODULE)


local invocationObj = NowikiInvocation.new(args.code, cfg)
local code = args.code or args[1]
local invocationObj = NowikiInvocation.new(code, cfg)
args.code = nil
args.code = nil
args[1] = nil
-- Assume we want to see the code as we already passed it in.
-- Assume we want to see the code as we already passed it in.
args.showcode = args.showcode or true
args.showcode = args.showcode or true
Line 500: Line 807:
return tostring(testCaseObj)
return tostring(testCaseObj)
end
end
-------------------------------------------------------------------------------
-- Exports
-------------------------------------------------------------------------------
local p = {}


function p.main(frame, cfg)
function p.main(frame, cfg)
Line 534: Line 847:
end
end


return p[func](args, cfg)
return bridge[func](args, cfg)
end
end


Retrieved from "https://nonbinary.wiki/wiki/Special:MobileDiff/31328...31375"