Module:Common/Debug

Module documentation[view][edit][history][purge]

This documentation is transcluded from Module:Common/Debug/doc. Changes can be proposed in the talk page.

Module:Common/Debug is shared across the Star Citizen Wikis.

This module is shared across the Star Citizen Wikis. Any changes should also be relayed to the GitHub repository.

Function list
L 10 — Common.convertSmwQueryObject L 49 — Common.collapsedDebugSections

👌 All tests passed.

Unit tests
	Name	Expected	Actual
👌	testFormatNum
👌	testFormatNumberString
👌	testFormatNumberStringFail
👌	testRemoveTypeSuffix
👌	testRemoveTypeSuffixNoMatch
👌	testToNumberNum
👌	testToNumberString
👌	testToNumberStringFail

require( 'strict' )

local Common = {}


--- Converts a SMW Query table into a string representation
---
--- @param queryObject table
--- @return string
function Common.convertSmwQueryObject( queryObject )
    if type( queryObject ) ~= 'table' then
        return 'Arg "queryObject" is not a table.'
    end

    local queryParts = {
        restrictions = {},
        output = {},
        other = {}
    }

    for _, part in ipairs( queryObject ) do
        if mw.ustring.sub( part, 1, 1 ) == '?' then
            table.insert( queryParts.output, part )
        elseif mw.ustring.sub( part, 1, 5 ) == '+lang' then
            local index = #queryParts.output
            queryParts.output[ index ] = mw.ustring.format( '%s|%s', queryParts.output[ index ], part )
        elseif mw.ustring.sub( part, 1, 2 ) == '[[' then
            table.insert( queryParts.restrictions, mw.getCurrentFrame():callParserFunction( '#tag', { 'nowiki', part } ) )
        elseif #part > 0 and part ~= nil then
            table.insert( queryParts.other, part )
        end
    end

    local queryString = mw.ustring.format(
        'Restrictions:<pre>%s</pre>Outputs:<pre>%s</pre>Other:<pre>%s</pre>',
        table.concat( queryParts.restrictions, "\n" ),
        table.concat( queryParts.output, "\n"),
        table.concat( queryParts.other, "\n")
    )

    return queryString
end


--- Creates collapsed sections containing debug data
---
--- @param sections table Table of tables containing 'title' and 'content' keys
--- @return string
function Common.collapsedDebugSections( sections )
    local html = ''

    for _, section in ipairs( sections ) do
        local content = section.content or 'No content set on the "content" key.'
        if type( content ) == 'table' then
            content = mw.dumpObject( content )
        end

        local tag = 'div'
        if section.tag then
            tag = section.tag
        end

        local sectionOutput = mw.html.create( 'div' )
            :addClass( 'mw-collapsible' )
            :addClass( 'mw-collapsed' )
            :tag( 'h3' ):wikitext( section.title or '' ):done()
            :tag( tag ):addClass( 'mw-collapsible-content' ):wikitext( content ):done()
            :allDone()

        html = html .. tostring( sectionOutput )
    end

    if #html > 0 then
        html = mw.html.create( 'div' )
            :addClass( 'debug' )
            :addClass( 'mw-collapsible' )
            :addClass( 'mw-collapsed' )
            :node( html )
            :done()
    end

    return tostring( html )
end


return Common