Module:RarityHandler

Revision as of 18:28, 15 May 2025 by Ryan (talk | contribs)

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

local p = {}

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

function p.getSortValue(frame)
    local rarity = frame.args[1]
    if not rarity or type(rarity) ~= "string" then
        return 999999999
    end

    -- Trim whitespace and strip leading ~
    rarity = mw.text.trim(rarity)
    if rarity:sub(1, 1) == "~" then
        rarity = rarity:sub(2)
    end

    -- Normalize lowercase
    local lowered = rarity:lower()

    -- Handle special values
    if lowered == "1" or lowered == "always" then
        return 1
    elseif lowered == "rare" then
        return 999999998
    elseif lowered == "never" then
        return 0
    end

    -- Match and convert fractional chance like "1/2.5", "1/128"
    local num = lowered:match("^1/(%d+%.?%d*)$")
    if num then
        local n = tonumber(num)
        if n then
            return n
        end
    end

    -- Unknown or badly formatted
    return 999999999
end

-- For class logic: cleaned string, lowercase
function p.getCleanValue(frame)
    local rarity = clean(frame.args[1])
    if not rarity then return "Unknown" end

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

    return rarity
end

-- For display
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 cleaned = hasTilde and trimmed:sub(2) or trimmed

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

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

return p