ਮੌਡਿਊਲ:ConvertTestcase

This module allows testing of module:convert. Current testcases are listed at Template:Convert/testcases.

Usage

Here's an example test for {{convert|100|in|cm|disp=sqbr}}. You take the "100|in|cm|abbr=out|disp=sqbr" and change the | to ! and then pass it over to ConvertTestcaseGiven as below.

• Adding a single row: {{#invoke:ConvertTestcase|ConvertTestcaseGiven|1=100!in!cm!disp=sqbr}} →

Convert Code	Convert (Old)	Convert (Sandboxlua)	Result
{{convert|100|in|cm|disp=sqbr}}	100 inches [250 cm]	100 inches [250 cm]	Exact Match

color codes

Code	Description
Exact Match	Means an exact match (apart from possible non-visible HTML differences)
Link	Means that one of the links of the units if different between the two versions being tested.
Span	Means that there are some differences in the HTML spans used in the HTML code. Should be investigated to determine if the difference is relevant.
Link & Span	There are both Link and Span differences
Different	There is a difference between the two versions. Should be investigated to determine which version is better.
	A blank is shown if there is an error in the template version.

Notes

There are some problems using Module:UnitTests though. Visually the results are the same a lot of the time but they never match as there is slightly different HTML behind the scenes with   being placed in slightly different places. -- WOSlinker (talk) 19:46, 21 September 2013 (UTC)

---

-- Used to compare the current version of the convert template with the sandboxlua version

local function bag()
    -- Return a table to hold lines of text.
    return {
        n = 0,
        add = function (self, s)
            self.n = self.n + 1
            self[self.n] = s
        end,
        join = function (self, sep)
            return table.concat(self, sep or '\n')
        end,
    }
end

local function clean(s)
    -- 2013-04-08: Template:Convert now appends text like
    -- "[[Category:Pages using Template Convert]]" to its output,
    -- so remove that also.
    s = s:gsub(" ", " ")
    s = s:gsub(" ", " ")
    s = s:gsub("_", " ")
    s = s:gsub("—", "—")
    s = s:gsub("–", "–")
    s = s:gsub("²", "<sup>2</sup>")
    s = s:gsub("³", "<sup>3</sup>")
    s = s:lower()
    s = s:gsub("%[%[category:.-%]%]", "")

    -- convert links with descriptions the same as the link to just a link
    -- for example [[acre|acre]] to [[acre]]
    -- and [[acre|acres]] to [[acre]]s
    s = s:gsub("%[%[([^%[%]]-)|%1]]", "[[%1]]")
    s = s:gsub("%[%[([^%[%]]-)|%1s]]", "[[%1]]s")
    return s
end

local function nolinks(s)
    -- Remove wikilink target to test if difference is due to a link disagreement.
    -- Change, for example, "[[acre]]" to "acre", then "[[hectare|ha]]" to "ha".
    s = s:gsub("%[%[([^%[%]|]-)%]%]", "%1")
    return s:gsub("%[%[[^%[%]]-|(.-)%]%]", "%1")
end

local function nospans(s)
    -- Remove any html spans to test if difference is due to a span disagreement.
    return s:gsub("</?span.->", "")
end

local function showconvert(args)
    return "&#123;{convert" .. "&#124;" .. table.concat(args, "&#124;") .. "}}"  -- 123="{", 124="|"
end

local function statusbox(label, color, align)
    return "| style=\"text-align:" .. align .. ";color:white;background:" .. color .. ";\" | " .. label
end

local function statusboxlinkspan(label)
    return "| style=\"text-align:center;color:white;background-image: -moz-linear-gradient(left, olive, teal); background-image: -ms-linear-gradient(left, olive, teal); background-image: -webkit-linear-gradient(left, olive, teal); background-image: linear-gradient(left, olive, teal);\" | " .. label
end

local function addresults(frame, voutput, template, args, vunit, title, args2)
    local v1 = frame:expandTemplate{ title = title or "convert/old", args = args }
    local v2 = frame:expandTemplate{ title = "convert/sandboxlua", args = args2 or args }
    if vunit then
        voutput:add("| [[Template:Convert/" .. vunit .. "|" .. vunit .. "]]")
    end
    voutput:add("| " .. template)
    voutput:add("| " .. v1)
    voutput:add("| " .. v2)
    v1 = clean(v1)
    v2 = clean(v2)
    if v1 == v2 then
        voutput:add(statusbox("Exact&nbsp;Match", "green", "center"))
    elseif nolinks(v1) == nolinks(v2) then
        voutput:add(statusbox("Link", "olive", "left"))
    elseif nospans(v1) == nospans(v2) then
        voutput:add(statusbox("Span", "teal", "right"))
    elseif nospans(nolinks(v1)) == nospans(nolinks(v2)) then
        voutput:add(statusboxlinkspan("Link&nbsp;&&nbsp;Span"))
    else
        if mw.ustring.find(v1, "template:convert", 1, true ) then
            voutput:add(statusbox("", "white", "center"))
        else
            voutput:add(statusbox("Different", "red", "center"))
        end
    end
end

local function onerow(frame, voutput, vunit, vunit2, vbaseunit)
    local insert = table.insert
    local args = {}
    insert(args, "1")
    if vbaseunit then
        insert(args, vbaseunit)
    end
    insert(args, vunit)
    if vunit2 then
        insert(args, "5")
        insert(args, vunit2)
    end
    local template = showconvert(args)
    args.lk = "on"
    addresults(frame, voutput, template, args, vunit)
    voutput:add("|-")
end

local i = {}

function i.ConvertTestcaseHeader(frame)
    local want_unit = frame.args.unit
    want_unit = (want_unit == nil or want_unit == 'yes')
    local colspan = frame.args.colspan or ''
    if colspan ~= '' then
        colspan = " colspan=2"
    end
    local voutput = bag()
    voutput:add("{| class=\"wikitable\"")
    if want_unit then
        voutput:add("! style=\"text-align:left;\" | Unit")
    end
    voutput:add("! style=\"text-align:left;\" | Convert Code")
    voutput:add("! style=\"text-align:left;\" " .. colspan .. "| Convert (Old)")
    voutput:add("! style=\"text-align:left;\" " .. colspan .. "| Convert (Sandboxlua)")
    voutput:add("! style=\"text-align:left;\" | Result")
    voutput:add("|-")
    return voutput:join()
end

function i.ConvertTestcaseFooter(frame)
    return "|}\n"
end

function i.ConvertTestcase(frame)
    local vtype = frame.args["type"]
    local vtoonly = frame.args["toonly"]
    local vfromonly = frame.args["fromonly"]
    local vunit = frame.args["unit"]
    local vunit2 = frame.args["unit2"]
    local voutput = bag()
    local vunits = {
          ["acceleration"] = "m/s2",
          ["area"] = "m2",
          ["density"] = "kg/m3",
          ["energy"] = "kJ",
          ["energypermass"] = "kJ/kg",
          ["energypervolume"] = "kJ/l",
          ["energyperlength"] = "kJ/km",
          ["exhaustemission"] = "kg/km",
          ["flow"] = "m3/s",
          ["force"] = "N",
          ["fuelconsumption"] = "l/km",
          ["gradient"] = "m/km",
          ["length"] = "m",
          ["lineardensity"] = "kg/m",
          ["mass"] = "g",
          ["power"] = "W",
          ["pressure"] = "Pa",
          ["population-density"] = "PD/km2",
          ["radioactivity"] = "Ci",
          ["speed"] = "m/s",
          ["temperature"] = "C",
          ["temperature-change"] = "C-change",
          ["time"] = "s",
          ["torque"] = "Nm",
          ["volume"] = "m3"
    }
    if vtoonly ~= "yes" then
        onerow(frame, voutput, vunit, vunit2)
    end
    if vfromonly ~= "yes" then
        local vbaseunit = vunits[vtype]
        if vbaseunit ~= nil and vbaseunit ~= vunit then
            onerow(frame, voutput, vunit, vunit2, vbaseunit)
       end
    end
    return voutput:join()
end

local function make_given(argstr)
    local insert = table.insert
    local args, show = {}, {}
    argstr = argstr .. "!"
    for item in argstr:gmatch( "(.-)!") do
        local p = item:find('=', 1, true)
        if p then
            args[item:sub(1, p-1)] = item:sub(p+1)
        else
            insert(args, item)
        end
        insert(show, item)
    end
    return showconvert(show), args
end

function i.ConvertTestcaseGiven(frame)
    -- Return a test case row from template arguments given in the form
    -- "100!in!cm!abbr=on" which means "{{convert|100|in|cm|abbr=on}}".
    local given = frame.args[1]
    if given == nil or given == '' then
        return ""
    end
    local voutput = bag()
    local template, args = make_given(given)
    addresults(frame, voutput, template, args)
    voutput:add("|-")
    return voutput:join()
end

function i.ConvertTestcaseExtra(frame)
    -- Return a test case row from template arguments given like
    -- "|x=spell |1=0.5!ha!acre |2=0.5!ha!acre!spell=in" which invokes:
    --     {{convert/spell|0.5|ha|acre}}
    --     {{convert/sandboxlua|0.5|ha|acre|spell=in}}
    -- or like
    -- "|x=3 |1=1!x!2!x!3!ft!mm |2=1!*!2!*!3!ft!mm" which invokes:
    --     {{convert/3|1!x!2!x!3!ft!mm}}
    --     {{convert/sandboxlua|1!*!2!*!3!ft!mm}}
    local extra, lhs, rhs = frame.args.x, frame.args[1], frame.args[2]
    if extra == nil or extra == '' or lhs == nil or lhs == '' or rhs == nil or rhs == '' then
        return ""
    end
    local voutput = bag()
    local template1, args1 = make_given(lhs)
    local template2, args2 = make_given(rhs)
    addresults(frame, voutput, template2, args1, nil, "convert/" .. extra, args2)
    voutput:add("|-")
    return voutput:join()
end

return i