Module:PerkSearchResultsView - Revision history

76561197987591703: Fixed bug in previous edit

2023-12-13T05:59:29Z

Fixed bug in previous edit

← Older revision		Revision as of 05:59, 13 December 2023
Line 79:		Line 79:
	--- Set absolute height of border span to stop it being bigger than the image		--- Set absolute height of border span to stop it being bigger than the image
	if iconSize == imgS then		if iconSize == imgS then
	displayStyle = displayStyle .. "height:~~" .. imgS .. "~~;"		displayStyle = displayStyle .. "height: 18px;"
	end		end

76561197987591703: Fix: changed perkLink function to correctly render the image inside its containing border when smaller than line height

2023-12-13T05:58:32Z

Fix: changed perkLink function to correctly render the image inside its containing border when smaller than line height

← Older revision		Revision as of 05:58, 13 December 2023
Line 76:		Line 76:

	local displayStyle = "display: inline-block;"		local displayStyle = "display: inline-block;"
	if iconSize == imgS then
	displayStyle = "~~display~~: ~~inline~~;"		--- Set absolute height of border span to stop it being bigger than the image
	end		if iconSize == imgS then
			displayStyle = displayStyle .. "height:" .. imgS .. ";"
			end

	local startBorderSpan = "<span style=\" " .. displayStyle ..		local startBorderSpan = "<span style=\" " .. displayStyle ..
	" border: " .. BORDER_SIZES[iconSize] .. " solid " .. borderColor .. "\">"		" border: " .. BORDER_SIZES[iconSize] .. " solid " .. borderColor .. "\">"
	local endBorderSpan = "</span>"		local endBorderSpan = "</span>"

			--- Hacky fix for weird image offset
			if iconSize == imgS then
			--- Add a second containing span to move the image into position
			startBorderSpan = startBorderSpan ..
			"<span style=\"display: block; transform: translateY(-4px)\">"
			endBorderSpan = "</span></span>"
			end

	local iconPart = "[[File:" .. perkIcon .. "\|" .. iconSize ..		local iconPart = "[[File:" .. perkIcon .. "\|" .. iconSize ..

76561197969631737: making description and sources columns unsortable

2023-12-04T04:01:31Z

making description and sources columns unsortable

← Older revision		Revision as of 04:01, 4 December 2023
Line 31:		Line 31:
	local CLASS_WIKITABLE_SORTABLE_COLLAPSIBLE = "wikitable sortable mw-collapsible"		local CLASS_WIKITABLE_SORTABLE_COLLAPSIBLE = "wikitable sortable mw-collapsible"
	local CSS_TD_SHRINK_TO_FIT = "max-width: 20em"		local CSS_TD_SHRINK_TO_FIT = "max-width: 20em"
			local CLASS_UNSORTABLE = "unsortable"

	local RARITY_COLORS = {		local RARITY_COLORS = {
Line 104:		Line 105:
	row:tag("th"):wikitext("Perk"):done()		row:tag("th"):wikitext("Perk"):done()
	row:tag("th"):wikitext("Rarity"):done()		row:tag("th"):wikitext("Rarity"):done()
	row:tag("th"):wikitext("Description"):done()		row:tag("th"):addClass(CLASS_UNSORTABLE):wikitext("Description"):done()
	row:tag("th"):wikitext("Source(s)"):done()		row:tag("th"):addClass(CLASS_UNSORTABLE):wikitext("Source(s)"):done()
	if needsPriceColumn then		if needsPriceColumn then
	row:tag("th"):wikitext("Price"):done()		row:tag("th"):wikitext("Price"):done()

76561197969631737: support for "none" rarity

2023-12-04T03:58:17Z

support for "none" rarity

← Older revision		Revision as of 03:58, 4 December 2023
Line 36:		Line 36:
	[PerksData.RARITY_RARE] = "#015db9",		[PerksData.RARITY_RARE] = "#015db9",
	[PerksData.RARITY_EPIC] = "#7f27b9",		[PerksData.RARITY_EPIC] = "#7f27b9",
	[PerksData.RARITY_LEGENDARY] = "#da6d00"		[PerksData.RARITY_LEGENDARY] = "#da6d00",
			[PerksData.NONE] = "#444444"
	}		}

Line 48:		Line 49:
	local NBSP = " "		local NBSP = " "
	local BLANK = "—"		local BLANK = "—"
	~~local BOLD = "'''"~~

	--endregion		--endregion

76561197969631737: should now draw a dash in last column where n/a

2023-12-04T03:23:20Z

should now draw a dash in last column where n/a

← Older revision		Revision as of 03:23, 4 December 2023
Line 47:		Line 47:
	-- Shortcut markup that's easier for Lua string concatenations		-- Shortcut markup that's easier for Lua string concatenations
	local NBSP = " "		local NBSP = " "
			local BLANK = "—"
	local BOLD = "'''"		local BOLD = "'''"

Line 352:		Line 353:
	---@param isFromOrder boolean whether this perk is earned from an Order		---@param isFromOrder boolean whether this perk is earned from an Order
	---@param isFromTrader boolean whether this perk is purchasable		---@param isFromTrader boolean whether this perk is purchasable
			---@param hasLastColumn boolean whether to render the last column (regardless of isFromTrader)
	function PerkSearchResultsView.addRowForPerk(displayOverride, perkName,		function PerkSearchResultsView.addRowForPerk(displayOverride, perkName,
	description, iconFilename, rarity, price,		description, iconFilename, rarity, price,
	isFromCornerstone, isFromEvent, isFromOrder, isFromTrader)		isFromCornerstone, isFromEvent, isFromOrder, isFromTrader,
			hasLastColumn)

	local newNode		local newNode
Line 367:		Line 370:
	makeDescriptionColumn(newNode, description)		makeDescriptionColumn(newNode, description)
	makeSourcesColumn(newNode, isFromCornerstone, isFromEvent, isFromOrder, isFromTrader)		makeSourcesColumn(newNode, isFromCornerstone, isFromEvent, isFromOrder, isFromTrader)
	if isFromTrader then		if hasLastColumn then
	makePriceColumn(newNode, price)		if isFromTrader then
			makePriceColumn(newNode, price)
			else
			newNode:tag("td"):wikitext(BLANK):done()
			end
	end		end
	end		end

76561197969631737: Added ability to make tables for generic search results

2023-12-03T15:09:17Z

Added ability to make tables for generic search results

@@ Line 32: / Line 32: @@
 local CSS_TD_SHRINK_TO_FIT = "max-width: 20em"
-local BORDER_COLORS = {
+local RARITY_COLORS = {
 	[PerksData.RARITY_UNCOMMON] = "#15cf00",
 	[PerksData.RARITY_RARE] = "#015db9",
@@ Line 282: / Line 282: @@
 		newNode = startNewWikiTable()
 		newNode:tag("caption"):wikitext(number .. " perks named " .. perkName .. "."):done():newline()
 		makeStandardPerkTableHeaderRow(newNode, needsPriceColumn)
@@ Line 316: / Line 359: @@
 	if displayOverride == PARAMETER_DISPLAY_OVERRIDE_LIST then
 		-- List version.
-		newNode = mw.html.create("li"):wikitext(perkLink(perkName, iconFilename, imgS, BORDER_COLORS[rarity]))
+		newNode = mw.html.create("li"):wikitext(perkLink(perkName, iconFilename, imgS, RARITY_COLORS[rarity]))
 	else
 		-- Table version.
 		newNode = mw.html.create("tr"):newline()
-		makeNameColumn(newNode, perkName, iconFilename, BORDER_COLORS[rarity])
+		makeNameColumn(newNode, perkName, iconFilename, RARITY_COLORS[rarity])
 		makeRarityColumn(newNode, rarity)
 		makeDescriptionColumn(newNode, description)

76561197969631737: Small modifications to display better

2023-12-03T14:45:52Z

Small modifications to display better

← Older revision		Revision as of 14:45, 3 December 2023
Line 30:		Line 30:
	-- wikitable classes for tables		-- wikitable classes for tables
	local CLASS_WIKITABLE_SORTABLE_COLLAPSIBLE = "wikitable sortable mw-collapsible"		local CLASS_WIKITABLE_SORTABLE_COLLAPSIBLE = "wikitable sortable mw-collapsible"
	local CSS_TD_SHRINK_TO_FIT = { "max-width~~", "~~20em" }		local CSS_TD_SHRINK_TO_FIT = "max-width: 20em"

	local BORDER_COLORS = {		local BORDER_COLORS = {
Line 42:		Line 42:
	[imgS] = "1.5px",		[imgS] = "1.5px",
	[imgM] = "2px",		[imgM] = "2px",
	[imgL] = "~~3px~~"		[imgL] = "4px"
	}		}

Line 162:		Line 162:
	local function makeDescriptionColumn(htmlTableRow, description)		local function makeDescriptionColumn(htmlTableRow, description)

	htmlTableRow:tag("td"):~~css~~(CSS_TD_SHRINK_TO_FIT)		htmlTableRow:tag("td"):cssText(CSS_TD_SHRINK_TO_FIT)
	:wikitext(description):done():newline()		:wikitext(description):done():newline()
	end		end

76561197969631737: Created to render search results for perks for PerkSearchController

2023-12-03T14:07:30Z

Created to render search results for perks for PerkSearchController

New page

--- @module PerkSearchResultsView
local PerkSearchResultsView = {}

local PerksData = require("Module:PerksData")

--region Private member variables

beginning = ""
middle = ""
ending = ""

local imgS = mw.getCurrentFrame():expandTemplate{ title = "ImgS" }
local imgM = mw.getCurrentFrame():expandTemplate{ title = "ImgM" }
local imgL = mw.getCurrentFrame():expandTemplate{ title = "ImgL" }

local amberIcon = mw.getCurrentFrame():expandTemplate{ title= "Amber" }

--endregion

--region Private constants

local PARAMETER_DISPLAY_OVERRIDE_LIST = "list"

-- wikitable classes for tables
local CLASS_WIKITABLE_SORTABLE_COLLAPSIBLE = "wikitable sortable mw-collapsible"
local CSS_TD_SHRINK_TO_FIT = { "max-width", "20em" }

local BORDER_COLORS = {
[PerksData.RARITY_UNCOMMON] = "#15cf00",
[PerksData.RARITY_RARE] = "#015db9",
[PerksData.RARITY_EPIC] = "#7f27b9",
[PerksData.RARITY_LEGENDARY] = "#da6d00"
}

local BORDER_SIZES = {
[imgS] = "1.5px",
[imgM] = "2px",
[imgL] = "3px"
}

-- Shortcut markup that's easier for Lua string concatenations
local NBSP = " "
local BOLD = "'''"

--endregion

--region Private methods

---
--- Formats a standard link to a perk. Does not invoke the template, but it
--- could be modified to do so in the future.
---
---@param perkName string the display name of the perk
---@param perkIcon string the filename for the icon
---@param iconSize string representing the desired size of the icon
---@param borderColor string the color of the border to put on the icon
---@return string an assembled link, with icon and text
local function perkLink(perkName, perkIcon, iconSize, borderColor)

if not perkName or not perkIcon or not iconSize then
error("Perk parameters cannot be nil.")
end

local displayStyle = "display: inline-block;"
if iconSize == imgS then
displayStyle = "display: inline;"
end

local startBorderSpan = "<span style=\" " .. displayStyle ..
" border: " .. BORDER_SIZES[iconSize] .. " solid " .. borderColor .. "\">"
local endBorderSpan = "</span>"

local iconPart = "[[File:" .. perkIcon .. "|" .. iconSize ..
"|alt=" .. perkName .. "|link=" .. perkName .. "]]"

local linkPart = NBSP .. "[[" .. perkName .. "]]"

return startBorderSpan .. iconPart .. endBorderSpan .. linkPart
end

---
--- Creates a header row under the provided MediaWiki HTML table entity.
---
---@param tableNode table MediaWiki HTML table entity
---@param needsPriceColumn boolean if the table need to include a price column
local function makeStandardPerkTableHeaderRow(tableNode, needsPriceColumn)

local row = tableNode:tag("tr")

row:tag("th"):wikitext("Perk"):done()
row:tag("th"):wikitext("Rarity"):done()
row:tag("th"):wikitext("Description"):done()
row:tag("th"):wikitext("Source(s)"):done()
if needsPriceColumn then
row:tag("th"):wikitext("Price"):done()
end

row:done():newline()
end

---
--- Returns a standard MediaWiki HTML table entity created with standard
--- display and interactivity classes.
---
---@return table standard MediaWiki HTML table entity
local function startNewWikiTable()

return mw.html.create("table"):addClass(CLASS_WIKITABLE_SORTABLE_COLLAPSIBLE):newline()
end

---
--- Makes the content of the name column under the provided HTML table row
--- entity.
---
---@param htmlTableRow table MediaWiki HTML table row entity
---@param perkName string the name of the building
---@param perkIcon string the filename for the icon
---@param borderColor string the color of the border to put on the icon
local function makeNameColumn(htmlTableRow, perkName, perkIcon, borderColor)

htmlTableRow:tag("td"):wikitext(perkLink(perkName, perkIcon, imgL, borderColor)):done():newline()
end

---
--- Makes the content of the name column under the provided HTML table row
--- entity.
---
---@param htmlTableRow table MediaWiki HTML table row entity
---@param rarity string the rarity of the perk
local function makeRarityColumn(htmlTableRow, rarity)

htmlTableRow:tag("td"):wikitext(rarity):done():newline()
end

---
--- Makes the content of the description column under the provided HTML table
--- row node.
---
---@param htmlTableRow table MediaWiki HTML table row entity
---@param description string the long description
local function makeDescriptionColumn(htmlTableRow, description)

htmlTableRow:tag("td"):css(CSS_TD_SHRINK_TO_FIT)
:wikitext(description):done():newline()
end

---
--- Builds an unordered bulleted list based on the specified perk's sources.
---
---@param htmlTableRow table the MediaWiki html node we're building on
---@param isFromCornerstone boolean whether the perk is a Cornerstone
---@param isFromEvent boolean whether the perk is a reward from an Event
---@param isFromOrder boolean whether the perk is a reward from an Order
---@param isFromTrader boolean whether the perk is purchasable from a Trader
local function makeSourcesColumn(htmlTableRow, isFromCornerstone, isFromEvent, isFromOrder, isFromTrader)

local td = htmlTableRow:tag("td")
local list = td:tag("ul")

if isFromCornerstone then
list:tag("li"):wikitext("as a Cornerstone"):done()
end
if isFromEvent then
list:tag("li"):wikitext("from Glade Event rewards"):done()
end
if isFromOrder then
list:tag("li"):wikitext("from Order rewards"):done()
end
if isFromTrader then
list:tag("li"):wikitext("purchased from a Trader"):done()
end

list:done()
td:done()
end

---
--- Adds a table cell containing the price and the amber icon
---
---@param htmlTableRow table the Mediawiki HTML node we're building on
---@param price number value in amber
local function makePriceColumn(htmlTableRow, price)

htmlTableRow:tag("td"):wikitext(price .. NBSP .. amberIcon):done()
end

--endregion

--region Public methods

---
--- Initializes the table, populates the caption, and writes and header row,
--- all appropriate for a table focusing on one perk.
---
--- The default is a wikitable output. With the displayOverride flag, this
--- method will instead make a list.
---
---@param perkName string the name of the perk this table is built for
---@param displayOverride string a flag for the output type if not the default
---@param needsPriceColumn boolean whether this perk needs a price column
function PerkSearchResultsView.startViewForPerk(perkName, displayOverride, needsPriceColumn)

-- These should never be nil at runtime.
if not perkName then
error("Parameter is invalid for perk name.")
end

local newNode
if displayOverride == PARAMETER_DISPLAY_OVERRIDE_LIST then
newNode = mw.html.create("ul")
else
newNode = startNewWikiTable()
newNode:tag("caption"):wikitext("Perk: " .. perkName .. "."):done():newline()

makeStandardPerkTableHeaderRow(newNode, needsPriceColumn)
end

beginning = newNode
-- Return value is not used by the Controller, but for debugging.
return newNode
end

---
--- Initializes the table, populates the caption, and writes and header row,
--- all appropriate for a table focusing on one perk.
---
--- The default is a wikitable output. With the displayOverride flag, this
--- method will instead make a list.
---
---@param perkName string the name of the perk this table is built for
---@param displayOverride string a flag for the output type if not the default
---@param numPerks number of perks that will be shown
---@param needsPriceColumn boolean whether this perk needs a price column
function PerkSearchResultsView.startViewForName(perkName, displayOverride, numPerks, needsPriceColumn)

-- These should never be nil at runtime.
if not perkName then
error("Parameter is invalid for perk name.")
end
if not numPerks then
error("Parameter is invalid for number of perks.")
end

local number = tonumber(numPerks)
if not number then
error("Number of perks could not be converted to a number: " .. numPerks)
end

local newNode
if displayOverride == PARAMETER_DISPLAY_OVERRIDE_LIST then
newNode = mw.html.create("ul")
else
newNode = startNewWikiTable()
newNode:tag("caption"):wikitext(number .. " perks named " .. perkName .. "."):done():newline()

makeStandardPerkTableHeaderRow(newNode, needsPriceColumn)
end

beginning = newNode
-- Return value is not used by the Controller, but for debugging.
return newNode
end

---
--- Adds a new row to the content being built. This is typically called from a
--- Controller that knows how many rows to add. PerkSearchResultsView maintains
--- the output in-progress while rows are added, so that layout and formatting
--- can be owned by this module instead of the Controller.
---
---@param displayOverride string a flag for the output type if not the default
---@param perkName string the name of the perk
---@param description string the flavor text description
---@param iconFilename string the icon of the perk
---@param rarity string the rarity
---@param price number price of the perk at a trader
---@param isFromCornerstone boolean whether this perk is earned as a Cornerstone
---@param isFromEvent boolean whether this perk is rewarded from an event
---@param isFromOrder boolean whether this perk is earned from an Order
---@param isFromTrader boolean whether this perk is purchasable
function PerkSearchResultsView.addRowForPerk(displayOverride, perkName,
description, iconFilename, rarity, price,
isFromCornerstone, isFromEvent, isFromOrder, isFromTrader)

local newNode
if displayOverride == PARAMETER_DISPLAY_OVERRIDE_LIST then
-- List version.
newNode = mw.html.create("li"):wikitext(perkLink(perkName, iconFilename, imgS, BORDER_COLORS[rarity]))
else
-- Table version.
newNode = mw.html.create("tr"):newline()
makeNameColumn(newNode, perkName, iconFilename, BORDER_COLORS[rarity])
makeRarityColumn(newNode, rarity)
makeDescriptionColumn(newNode, description)
makeSourcesColumn(newNode, isFromCornerstone, isFromEvent, isFromOrder, isFromTrader)
if isFromTrader then
makePriceColumn(newNode, price)
end
end

newNode:done()
middle = middle .. tostring(newNode)

return newNode
end

---
--- Wraps up anything outstanding for the view, then returns the entire
--- MediaWiki entity originally started in the respective method.
---
---@return string the HTML markup of the completed view
function PerkSearchResultsView.endView()

beginning:node(middle)
beginning:done()

middle = ""

return beginning
end

--endregion

return PerkSearchResultsView