Still landing on the old Fandom wiki? Install the HighSpell Wiki Redirector browser extension to automatically redirect all highspell.fandom.com links to highspell.wiki. Works on both Firefox and Chrome, and is open-source. → Learn more and install it now!

Module:RarityHandler

From HighSpell Wiki
Revision as of 14:01, 19 May 2025 by Ryan (talk | contribs) (Undo revision 4483 by Ryan (talk))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

local p = {}

-- Clean up the rarity string: strip ~, commas, trim
local function clean(rarity)
	if not rarity or type(rarity) ~= "string" then return nil end
	rarity = mw.text.trim(rarity)
	rarity = rarity:gsub("^~", "") -- remove ~
	rarity = rarity:gsub(",", "") -- remove commas
	return rarity
end

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

	local rarity = clean(raw)
	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 999999998
	elseif lowered == "never" then
		return 0
	end

	-- Match 1/X, return raw number (not string)
	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

-- For logic styling
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

	local prefix, num = cleaned:match("^(1/)(%d+%.?%d*)$")
	if prefix and num then
		local withCommas = mw.language.getContentLanguage():formatNum(tonumber(num))
		return (hasTilde and "~" or "") .. prefix .. withCommas
	end

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

return p