Module:Goodbox

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

---
--- Module to create an infobox for displaying on a good's wiki page.
---
--- Shows the facts from the data about the specified good in an easy-to-read
--- table, with a large icon, information, categories, and the flavor text.
---
--- This should be invoked from Template:Goodbox with the parameter of the
--- good whose infobox should be shown. See the template documentation for
--- more information about parameters and errors and to see examples.
---
--- @module Goodbox
local Goodbox = {}



local Infobox = require("Module:Infobox")
local GoodsData = require("Module:GoodsData")



--region  Private constants

local ARG_NAME = "name"
local ARG_PURPOSE = "purpose"
local ARG_SPECIES_PREFERENCE = "species_preference"

local NBSP = " "

--endregion



--region Private methods

---
--- Builds using the provided wikiInfobox a subtable to lay out headers and
--- fields.
---
---@param wikiInfobox table mw.html object into which we're building this
---@param goodName string the name of the good the infobox is about
---@param purpose string the parameter provided to the template
---@param speciesPref string the parameter provided to the template
---@return table the Mediawiki html object into which we've been adding things
local function makeInnerTable(wikiInfobox, goodName, purpose, speciesPref)

	-- Grab the data we'll use to populate this.
	local goodID = GoodsData.getGoodID(goodName)
	local goodCategory = GoodsData.getGoodCategory(goodName)
	local goodIsEatable = GoodsData.isGoodEatable(goodName)
	local goodIsBurnable = GoodsData.isGoodBurnable(goodName)
	local goodBurnTime = GoodsData.getGoodBurnTime(goodName)
	local goodSellValue, goodBuyValue = GoodsData.getGoodValue(goodName)

	-- Start the inner table
	local innerTable = wikiInfobox:tag("tr"):tag("td"):newline():tag("table"):css(Infobox.CSS_INNER_TABLE)
	innerTable:newline()

	-- Start with the things not provided by the data.
	if purpose and purpose ~= "" then

		Infobox.buildStandardRow(innerTable, "",
				Infobox.toTitleCase(ARG_PURPOSE), purpose)
	end
	if speciesPref and speciesPref ~= "" then

		Infobox.buildStandardRow(innerTable, Infobox.CSS_TR_BORDER_BOT,
				Infobox.toTitleCase(ARG_SPECIES_PREFERENCE), speciesPref)
	end

	-- Storage category (this is the same as the subtitle for now)
	if goodCategory then

		local categoryIcon = "[[File:" .. Infobox.ICON_FILENAMES_CATEGORIES[goodCategory] .. "|" .. Infobox.ICONSIZE_MED .. "|alt=" .. goodCategory .. "]]"

		Infobox.buildStandardRow(innerTable, Infobox.CSS_TR_BORDER_TOP,
				Infobox.TITLE_CATEGORY, categoryIcon .. NBSP .. goodCategory)
	end
	-- Since false is a valid value, have to directly check if it's nil.
	if goodIsEatable ~= nil then

		Infobox.buildStandardRow(innerTable, "",
				Infobox.TITLE_EATABLE, goodIsEatable and "Yes" or "No")
	end
	if goodIsBurnable ~= nil then

		Infobox.buildStandardRow(innerTable, "",
				Infobox.TITLE_BURNABLE, goodIsBurnable and "Yes" or "No")
	end
	if goodIsBurnable and goodBurnTime then

		Infobox.buildStandardRow(innerTable, Infobox.CSS_TR_BORDER_BOT,
				Infobox.TITLE_BURN_TIME, goodBurnTime)
	end
	-- Trade values.
	if goodSellValue then

		Infobox.buildStandardRow(innerTable, Infobox.CSS_TR_BORDER_TOP,
				Infobox.TITLE_SELL_VALUE, Infobox.toTwoDecimalPlaces(goodSellValue))
	end
	if goodBuyValue then

		Infobox.buildStandardRow(innerTable, Infobox.CSS_TR_BORDER_BOT,
				Infobox.TITLE_BUY_VALUE, Infobox.toTwoDecimalPlaces(goodBuyValue))
	end
	-- End with the ID.
	if goodID then

		Infobox.buildStandardRow(innerTable, Infobox.CSS_TR_BORDER_TOP,
				Infobox.TITLE_ID, "\'" .. goodID .. "\'")
	end

	-- Close the table.
	innerTable:done():newline()
	-- Close the table cell and row the inner table is in.
	wikiInfobox:done():done():newline()
end

--endregion



--region Public methods

---
--- Creates an html and wiki markup to display the data in an infobox.
---
--- @param frame table from template's calling context
--- @return string of html and wiki markup
function Goodbox.renderGoodbox(frame)

	-- Every good must have a name.
	local goodName = frame.args[ARG_NAME]
	if not goodName or goodName == "" then
		return "You must specify the name of the good. See [[Template:Goodbox]] for examples."
	end

	-- Use this method here to check to see whether the provided name is valid.
	if not GoodsData.getGoodID(goodName) then
		return "Goodbox can't find the specified good: " .. goodName .. "."
	end

	-- Additional template parameters, may or may not be present.
	local purpose = frame.args[ARG_PURPOSE]
	local speciesPref = frame.args[ARG_SPECIES_PREFERENCE]

	-- Get the data.
	local goodDescription = GoodsData.getGoodDescription(goodName)
	local goodCategory = GoodsData.getGoodCategory(goodName)
	local goodIconFilename = GoodsData.getGoodIcon(goodName)

	-- Make the top of the infobox that every item has...
	local wikiInfobox = mw.html.create("table"):css(Infobox.CSS_MAIN):newline()
	-- with a title...
	wikiInfobox:tag("tr")
			:tag("th"):wikitext(goodName):done()
		:done():newline()
	-- and a subtitle, showing the category...
	if goodCategory then
		wikiInfobox:tag("tr")
				:tag("td"):wikitext(goodCategory):done()
			:done():newline()
	end
	-- and a large icon.
	if goodIconFilename then
		wikiInfobox:tag("tr")
				:tag("td"):wikitext("[[File:" .. goodIconFilename .. "]]"):done()
			:done():newline()
		wikiInfobox:tag("tr"):css(Infobox.CSS_TR_BORDER_BOT)
				:tag("td"):wikitext(goodName .. ", as seen in-game"):done()
			:done():newline()
	end

	makeInnerTable(wikiInfobox, goodName, purpose, speciesPref)

	-- Finish with the flavor text.
	if goodDescription then
		wikiInfobox:tag("tr"):css(Infobox.CSS_TR_BORDER_TOP)
				:tag("td"):wikitext(goodDescription):done()
			:done():newline()
	end

	return wikiInfobox
end

--endregion

return Goodbox