Module:RaritySort

From HighSpell Wiki
Revision as of 21:10, 18 May 2025 by Ryan (talk | contribs)
Jump to navigation Jump to search

Documentation for this module may be created at Module:RaritySort/doc

local p = {}

-- Clean and extract processing info
local function clean(rarity)
    if not rarity or type(rarity) ~= "string" then return nil, false end
    rarity = mw.text.trim(rarity)
    local hasTilde = rarity:sub(1, 1) == "~"
    if hasTilde then
        rarity = rarity:sub(2)
    end
    return rarity, hasTilde
end

-- RaritySort for sorting
function p.getSortValue(frame)
    local rarityRaw = frame.args[1]
    local rarity, _ = clean(rarityRaw)
    if not rarity then return 999999999 end

    local lowered = rarity:lower()

    if lowered == "1" or lowered == "always" then
        return 1
    elseif lowered == "rare" then
        return 999999
    elseif lowered == "never" then
        return 0
    end

    -- Match 1/X and round down (floor)
    local numStr = lowered:match("^1/(%d+%.?%d*)$")
    if numStr then
        local num = tonumber(numStr)
        if num then
            return math.floor(num)
        end
    end

    return 999999999
end

-- Normalize display text
function p.normalizeDisplay(frame)
    local original = frame.args[1]
    if not original or type(original) ~= "string" then return "Unknown" end

    local trimmed = mw.text.trim(original)
    local hasTilde = trimmed:sub(1, 1) == "~"
    local raw = hasTilde and trimmed:sub(2) or trimmed

    if raw == "1" then
        return "Always"
    end

    return hasTilde and ("~" .. raw) or raw
end

return p