Latest revision |
Your text |
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
| |
| local yesno = require('Module:Yesno') | | local yesno = require('Module:Yesno') |
| | local mTableTools = require('Module:TableTools') |
| | local libraryUtil = require('libraryUtil') |
| | local checkType = libraryUtil.checkType |
|
| |
|
| -- Set constants
| | local TEMPLATE_NAME_MAGIC_WORD = '__TEMPLATENAME__' |
| local DATA_MODULE = 'Module:Template test case/data' | | local TEMPLATE_NAME_MAGIC_WORD_ESCAPED = TEMPLATE_NAME_MAGIC_WORD:gsub('%p', '%%%0') |
| | |
| -------------------------------------------------------------------------------
| |
| -- Shared methods
| |
| -------------------------------------------------------------------------------
| |
| | |
| local function message(self, key, ...)
| |
| -- This method is added to classes that need to deal with messages from the
| |
| -- config module.
| |
| local msg = self.cfg.msg[key]
| |
| if select(1, ...) then
| |
| return mw.message.newRawMessage(msg, ...):plain()
| |
| else
| |
| return msg
| |
| end
| |
| end
| |
|
| |
|
| ------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------- |
Line 54: |
Line 20: |
| getFullPage = true, | | getFullPage = true, |
| getName = true, | | getName = true, |
| makeHeader = true, | | makeHeading = true, |
| getOutput = true | | getOutput = true |
| } | | } |
| | |
| | function Template.outputEquals(...) |
| | -- This function accepts 2 or more template objects and compares their |
| | -- output. If all the outputs are equal, it returns true, and if any of them |
| | -- are different, it returns false. |
| | local n = select('#', ...) |
| | if n < 2 then |
| | error('Template.outputEquals requires at least two arguments', 2) |
| | end |
| | local function normaliseOutput(obj) |
| | local out = obj:getOutput() |
| | -- Remove the random parts from strip markers (see [[Help:Strip markers]]) |
| | out = out:gsub('(%cUNIQ).-(QINU%c)', '%1%2') |
| | return out |
| | end |
| | local prevOutput = normaliseOutput(select(1, ...)) |
| | for i = 2, n do |
| | local output = normaliseOutput(select(i, ...)) |
| | if output ~= prevOutput then |
| | return false |
| | end |
| | prevOutput = output |
| | end |
| | return true |
| | end |
|
| |
|
| function Template.new(invocationObj, options) | | function Template.new(invocationObj, options) |
Line 94: |
Line 85: |
|
| |
|
| function Template:getFullPage() | | function Template:getFullPage() |
| if not self.template then | | if 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 110: |
Line 97: |
| 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 135: |
Line 124: |
| end | | end |
|
| |
|
| function Template:makeHeader() | | function Template:makeHeading() |
| 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{ | | local invocation = self._invocation:getInvocation(self:getName()) |
| 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 160: |
Line 144: |
|
| |
|
| function Template:getOutput() | | function Template:getOutput() |
| local protect = require('Module:Protect') | | return self._invocation:getOutput(self:getName()) |
| -- calling self._invocation:getOutput{...}
| |
| return protect(self._invocation.getOutput)(self._invocation, {
| |
| template = self:getName(),
| |
| requireMagicWord = self.requireMagicWord,
| |
| })
| |
| end | | end |
|
| |
|
Line 174: |
Line 153: |
| local TestCase = {} | | local TestCase = {} |
| TestCase.__index = TestCase | | TestCase.__index = TestCase |
| TestCase.message = message -- add the message method
| |
|
| |
| TestCase.renderMethods = {
| |
| -- Keys in this table are values of the "format" option, values are the
| |
| -- method for rendering that format.
| |
| columns = 'renderColumns',
| |
| rows = 'renderRows',
| |
| tablerows = 'renderRows',
| |
| inline = 'renderInline',
| |
| cells = 'renderCells',
| |
| default = 'renderDefault'
| |
| }
| |
|
| |
|
| function TestCase.new(invocationObj, options, cfg) | | function TestCase.new(invocationObj, options) |
| local obj = setmetatable({}, TestCase) | | local obj = setmetatable({}, TestCase) |
| obj.cfg = cfg
| |
|
| |
|
| -- Separate general options from template options. Template options are | | -- Validate options |
| -- numbered, whereas general options are not. | | do |
| local generalOptions, templateOptions = {}, {}
| | local highestNum = 0 |
| for k, v in pairs(options) do
| | for k in pairs(options) do |
| local prefix, num
| | if type(k) == 'string' then |
| if type(k) == 'string' then
| | local num = k:match('([1-9][0-9]*)$') |
| prefix, num = k:match('^(.-)([1-9][0-9]*)$')
| | num = tonumber(num) |
| | if num and num > highestNum then |
| | highestNum = num |
| | end |
| | end |
| end | | end |
| if prefix then | | for i = 3, highestNum do |
| num = tonumber(num)
| | if not options['template' .. i] then |
| templateOptions[num] = templateOptions[num] or {}
| | error(string.format( |
| templateOptions[num][prefix] = v
| | "one or more options ending in '%d' were " .. |
| else
| | "detected, but no 'template%d' option was found", |
| generalOptions[k] = v | | i, i |
| | ), 2) |
| | end |
| end | | end |
| end | | end |
|
| |
|
| -- Set general options | | -- Separate general options from options for specific templates |
| generalOptions.showcode = yesno(generalOptions.showcode) | | local templateOptions = mTableTools.numData(options, true) |
| generalOptions.showheader = yesno(generalOptions.showheader) ~= false
| | obj.options = templateOptions.other or {} |
| generalOptions.showcaption = yesno(generalOptions.showcaption) ~= false
| |
| generalOptions.collapsible = yesno(generalOptions.collapsible)
| |
| generalOptions.notcollapsed = yesno(generalOptions.notcollapsed)
| |
| generalOptions.wantdiff = yesno(generalOptions.wantdiff)
| |
| obj.options = generalOptions | |
|
| |
|
| -- Preprocess template args | | -- Normalize showcode option |
| for num, t in pairs(templateOptions) do | | obj.options.showcode = yesno(obj.options.showcode) |
| if t.showtemplate ~= nil then
| |
| t.showtemplate = yesno(t.showtemplate)
| |
| end
| |
| end
| |
|
| |
|
| -- Set up first two template options tables, so that if only the | | -- Add default template options |
| -- "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 .. '/sandbox' |
| '/' .. obj.cfg.sandboxSubpage
| |
| end | | end |
| if not templateOptions[1].template then | | if not templateOptions[1].template then |
Line 245: |
Line 197: |
| end | | end |
| if not templateOptions[2].template then | | if not templateOptions[2].template then |
| templateOptions[2].title = templateOptions[1].title:subPageTitle( | | templateOptions[2].title = templateOptions[1].title:subPageTitle('sandbox') |
| obj.cfg.sandboxSubpage
| |
| )
| |
| 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, options in ipairs(templateOptions) do | | for i, t in ipairs(templateOptions) do |
| table.insert(obj.templates, Template.new(invocationObj, options)) | | table.insert(obj.templates, Template.new(invocationObj, t)) |
| 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 316: |
Line 215: |
| end | | end |
| return output | | return output |
| end
| |
|
| |
| function TestCase:templateOutputIsEqual()
| |
| -- Returns a boolean showing whether all of the template outputs are equal.
| |
| -- The random parts of strip markers (see [[Help:Strip markers]]) are
| |
| -- removed before comparison. This means a strip marker can contain anything
| |
| -- and still be treated as equal, but it solves the problem of otherwise
| |
| -- identical wikitext not returning as exactly equal.
| |
| local function normaliseOutput(obj)
| |
| local out = obj:getOutput()
| |
| -- Remove the random parts from strip markers.
| |
| out = out:gsub('(\127\'"`UNIQ.-)%-%x+%-(QINU`"\'\127)', '%1%2')
| |
| return out
| |
| end
| |
| local firstOutput = normaliseOutput(self.templates[1])
| |
| for i = 2, #self.templates do
| |
| local output = normaliseOutput(self.templates[i])
| |
| if output ~= firstOutput then
| |
| return false
| |
| end
| |
| end
| |
| return true
| |
| end
| |
|
| |
| 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 root = mw.html.create('table')
| |
| if self.options.wantdiff then
| |
| root
| |
| :addClass('mw-collapsible')
| |
| 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('width', '100%')
| |
| :css('border', 'solid silver 1px')
| |
| :tag('tr')
| |
| :tag('th')
| |
| :css('background-color', isEqual and 'lightgreen' or 'yellow')
| |
| :wikitext(title)
| |
| :done()
| |
| :done()
| |
| :tag('tr')
| |
| :tag('td')
| |
| :newline()
| |
| :wikitext(s)
| |
| :newline()
| |
| end
| |
| return tostring(root)
| |
| end | | end |
|
| |
|
Line 408: |
Line 226: |
|
| |
|
| 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 'Side by side comparison') |
|
| |
|
| if self.options.showheader then | | -- Headings |
| -- Caption
| | local headingRow = tableroot:tag('tr') |
| if self.options.showcaption then
| | if self.options.rowheader then |
| tableroot
| | -- rowheader is correct here. We need to add another th cell if |
| :addClass(self.options.class)
| | -- rowheader is set further down, even if heading0 is missing. |
| :cssText(self.options.style)
| | headingRow:tag('th'):wikitext(self.options.heading0) |
| :tag('caption')
| | end |
| :wikitext(self.options.caption or self:message('columns-header'))
| | local width |
| end
| | if #self.templates > 0 then |
| | | width = tostring(math.floor(100 / #self.templates)) .. '%' |
| -- Headers
| | else |
| local headerRow = tableroot:tag('tr')
| | width = '100%' |
| if self.options.rowheader then
| | end |
| -- rowheader is correct here. We need to add another th cell if
| | for i, obj in ipairs(self.templates) do |
| -- rowheader is set further down, even if heading0 is missing.
| | headingRow |
| headerRow:tag('th'):wikitext(self.options.heading0)
| | :tag('th') |
| end
| | :css('width', width) |
| local width
| | :wikitext(obj:makeHeading()) |
| 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 450: |
Line 262: |
| -- Template output | | -- Template output |
| for i, obj in ipairs(self.templates) do | | for i, obj in ipairs(self.templates) do |
| if self.options.output == 'nowiki+' then | | dataRow:tag('td') |
| dataRow:tag('td')
| | :newline() |
| :newline()
| | :wikitext(self:getTemplateOutput(obj)) |
| :wikitext(self.options.before)
| | :wikitext(self.options.after) |
| :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 499: |
Line 291: |
|
| |
|
| for _, obj in ipairs(self.templates) do | | for _, obj in ipairs(self.templates) do |
| local dataRow = tableroot:tag('tr')
| | -- Build the row HTML |
|
| | tableroot |
| -- Header | | :tag('tr') |
| if self.options.showheader then | | :tag('td') |
| 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:makeHeader()) | | :wikitext(obj:makeHeading()) |
| dataRow = tableroot:tag('tr')
| | :done() |
| end
| | :done() |
| end
| | :tag('tr') |
|
| | :tag('td') |
| -- Template output
| | :newline() |
| if self.options.output == 'nowiki+' then
| | :wikitext(self:getTemplateOutput(obj)) |
| 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 | | end |
|
| |
|
Line 544: |
Line 309: |
| end | | end |
|
| |
|
| function TestCase:renderInline() | | function TestCase:renderCollapsed() |
| 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
| |
| | |
| | |
| return tostring(root)
| |
| end | | end |
|
| |
|
Line 646: |
Line 320: |
| 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>' |
| if self.options.showheader then | | ret[#ret + 1] = obj:makeBraceLink() |
| ret[#ret + 1] = obj:makeHeader()
| | ret[#ret + 1] = self:getTemplateOutput(obj) |
| 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 661: |
Line 327: |
|
| |
|
| function TestCase:__tostring() | | function TestCase:__tostring() |
| | local methods = { |
| | collapsed = 'renderCollapsed', |
| | columns = 'renderColumns', |
| | rows = 'renderRows' |
| | } |
| local format = self.options.format | | local format = self.options.format |
| local method = format and TestCase.renderMethods[format] or 'renderDefault' | | local method = format and methods[format] or 'renderDefault' |
| local ret = self[method](self) | | return self[method](self) |
| if self.options.collapsible then
| |
| ret = self:makeCollapsible(ret)
| |
| end
| |
| for cat in pairs(self.categories) do
| |
| ret = ret .. string.format('[[Category:%s]]', cat)
| |
| end
| |
| return ret
| |
| end | | end |
|
| |
|
Line 679: |
Line 343: |
| local NowikiInvocation = {} | | local NowikiInvocation = {} |
| NowikiInvocation.__index = NowikiInvocation | | NowikiInvocation.__index = NowikiInvocation |
| NowikiInvocation.message = message -- Add the message method
| |
|
| |
|
| function NowikiInvocation.new(invocation, cfg) | | function NowikiInvocation.new(invocation) |
| local obj = setmetatable({}, NowikiInvocation) | | local obj = setmetatable({}, NowikiInvocation) |
| obj.cfg = cfg
| |
| invocation = mw.text.unstrip(invocation) | | invocation = mw.text.unstrip(invocation) |
| -- Decode HTML entities for <, >, and ". This means that HTML entities in | | -- Decode HTML entities for <, >, and ". This means that HTML entities in |
Line 692: |
Line 354: |
| invocation = invocation:gsub('>', '>') | | invocation = invocation:gsub('>', '>') |
| invocation = invocation:gsub('"', '"') | | invocation = invocation:gsub('"', '"') |
| | -- Decode & only when it is used to escape <, > and " |
| | invocation = invocation:gsub('&lt;', '<') |
| | invocation = invocation:gsub('&gt;', '>') |
| | invocation = invocation:gsub('&quot;', '"') |
| obj.invocation = invocation | | obj.invocation = invocation |
| return obj | | return obj |
| end | | end |
|
| |
|
| function NowikiInvocation:getInvocation(options) | | function NowikiInvocation:getInvocation(template) |
| local template = options.template:gsub('%%', '%%%%') -- Escape "%" with "%%" | | template = template:gsub('%%', '%%%%') -- Escape "%" with "%%" |
| local invocation, count = self.invocation:gsub( | | local invocation, count = self.invocation:gsub( |
| self.cfg.templateNameMagicWordPattern, | | TEMPLATE_NAME_MAGIC_WORD_ESCAPED, |
| template | | template |
| ) | | ) |
| if options.requireMagicWord ~= false and count < 1 then | | if count < 1 then |
| error(self:message( | | error(string.format( |
| 'nowiki-magic-word-error', | | "the template invocation must include '%s' in place " .. |
| self.cfg.templateNameMagicWord | | "of the template name", |
| | TEMPLATE_NAME_MAGIC_WORD |
| )) | | )) |
| end | | end |
Line 711: |
Line 378: |
| end | | end |
|
| |
|
| function NowikiInvocation:getOutput(options) | | function NowikiInvocation:getOutput(template) |
| local invocation = self:getInvocation(options) | | local invocation = self:getInvocation(template) |
| return mw.getCurrentFrame():preprocess(invocation) | | return mw.getCurrentFrame():preprocess(invocation) |
| end | | end |
Line 722: |
Line 389: |
| local TableInvocation = {} | | local TableInvocation = {} |
| TableInvocation.__index = TableInvocation | | TableInvocation.__index = TableInvocation |
| TableInvocation.message = message -- Add the message method
| |
|
| |
|
| function TableInvocation.new(invokeArgs, nowikiCode, cfg) | | function TableInvocation.new(invokeArgs) |
| local obj = setmetatable({}, TableInvocation) | | local obj = setmetatable({}, TableInvocation) |
| obj.cfg = cfg
| |
| obj.invokeArgs = invokeArgs | | obj.invokeArgs = invokeArgs |
| obj.code = nowikiCode
| |
| return obj | | return obj |
| end | | end |
|
| |
|
| function TableInvocation:getInvocation(options) | | function TableInvocation:getInvocation(template) |
| if self.code then
| | return require('Module:Template invocation').invocation( |
| local nowikiObj = NowikiInvocation.new(self.code, self.cfg)
| | template, |
| return nowikiObj:getInvocation(options)
| | self.invokeArgs |
| else | | ) |
| return require('Module:Template invocation').invocation(
| |
| options.template,
| |
| self.invokeArgs
| |
| )
| |
| end
| |
| end | | end |
|
| |
|
| function TableInvocation:getOutput(options) | | function TableInvocation:getOutput(template) |
| 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 = options.template, | | title = template, |
| args = self.invokeArgs | | args = self.invokeArgs |
| } | | } |
Line 758: |
Line 411: |
|
| |
|
| ------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------- |
| -- Bridge functions | | -- Exports |
| --
| |
| -- These functions translate template arguments into forms that can be accepted
| |
| -- by the different classes, and return the results.
| |
| ------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------- |
|
| |
|
| local bridge = {}
| | -- Table-based exports |
|
| |
|
| function bridge.table(args, cfg) | | local function getTableArgs(frame, wrappers) |
| cfg = cfg or mw.loadData(DATA_MODULE) | | return require('Module:Arguments').getArgs(frame, { |
| | wrappers = wrappers, |
| | trim = false, |
| | removeBlanks = false |
| | }) |
| | end |
|
| |
|
| | local p = {} |
| | |
| | function p._table(args) |
| local options, invokeArgs = {}, {} | | local options, invokeArgs = {}, {} |
| for k, v in pairs(args) do | | for k, v in pairs(args) do |
Line 783: |
Line 441: |
| end | | end |
| end | | end |
| | local invocationObj = TableInvocation.new(invokeArgs) |
| | local testCaseObj = TestCase.new(invocationObj, options) |
| | return tostring(testCaseObj) |
| | end |
|
| |
|
| -- Allow passing a nowiki invocation as an option. While this means users
| | function p.table(frame) |
| -- have to pass in the code twice, whitespace is preserved and < etc. | | return p._table(getTableArgs(frame, 'Template:Test case from arguments')) |
| -- will work as intended.
| | end |
| local nowikiCode = options.code
| |
| options.code = nil
| |
|
| |
|
| local invocationObj = TableInvocation.new(invokeArgs, nowikiCode, cfg) | | function p.columns(frame) |
| local testCaseObj = TestCase.new(invocationObj, options, cfg) | | local args = getTableArgs(frame, 'Template:Testcase table') |
| return tostring(testCaseObj) | | args._format = 'columns' |
| | return p._table(args) |
| | end |
| | |
| | function p.rows(frame) |
| | local args = getTableArgs(frame, 'Template:Testcase rows') |
| | args._format = 'rows' |
| | return p._table(args) |
| end | | end |
|
| |
|
| function bridge.nowiki(args, cfg)
| | -- Nowiki-based exports |
| cfg = cfg or mw.loadData(DATA_MODULE)
| |
|
| |
|
| local code = args.code or args[1]
| | function p._nowiki(args) |
| local invocationObj = NowikiInvocation.new(code, cfg) | | local invocationObj = NowikiInvocation.new(args.code) |
| 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 |
| local testCaseObj = TestCase.new(invocationObj, args, cfg) | | local testCaseObj = TestCase.new(invocationObj, args) |
| return tostring(testCaseObj) | | return tostring(testCaseObj) |
| end | | end |
|
| |
|
| -------------------------------------------------------------------------------
| | function p.nowiki(frame) |
| -- Exports
| | local args = require('Module:Arguments').getArgs(frame, { |
| -------------------------------------------------------------------------------
| | wrappers = 'Template:Test case from invocation' |
| | |
| local p = {}
| |
| | |
| function p.main(frame, cfg) | |
| cfg = cfg or mw.loadData(DATA_MODULE)
| |
| | |
| -- Load the wrapper config, if any.
| |
| local wrapperConfig
| |
| if frame.getParent then
| |
| local title = frame:getParent():getTitle()
| |
| local template = title:gsub(cfg.sandboxSubpagePattern, '')
| |
| wrapperConfig = cfg.wrappers[template]
| |
| end
| |
| | |
| -- Work out the function we will call, use it to generate the config for
| |
| -- Module:Arguments, and use Module:Arguments to find the arguments passed
| |
| -- by the user.
| |
| local func = wrapperConfig and wrapperConfig.func or 'table' | |
| local userArgs = require('Module:Arguments').getArgs(frame, {
| |
| parentOnly = wrapperConfig, | |
| frameOnly = not wrapperConfig,
| |
| trim = func ~= 'table',
| |
| removeBlanks = func ~= 'table'
| |
| }) | | }) |
| | return p._nowiki(args) |
| | end |
|
| |
|
| -- Get default args and build the args table. User-specified args overwrite
| | -- Exports for testing |
| -- default args.
| |
| local defaultArgs = wrapperConfig and wrapperConfig.args or {}
| |
| local args = {}
| |
| for k, v in pairs(defaultArgs) do
| |
| args[k] = v
| |
| end
| |
| for k, v in pairs(userArgs) do
| |
| args[k] = v
| |
| end
| |
| | |
| return bridge[func](args, cfg)
| |
| end
| |
|
| |
|
| function p._exportClasses() -- For testing | | function p._exportClasses() |
| return { | | return { |
| Template = Template, | | Template = Template, |
| TestCase = TestCase, | | TestCase = TestCase, |
| | Invocation = Invocation, |
| NowikiInvocation = NowikiInvocation, | | NowikiInvocation = NowikiInvocation, |
| TableInvocation = TableInvocation | | TableInvocation = TableInvocation |