Module:Road data/sandbox

This is the module sandbox page for Module:Road data (diff).
See also the companion subpage for test cases (run).
local p = {}

local parserModule = require("Module:Road data/parser")
local sizeModule = require("Module:Road data/size/sandbox") -- REMOVE SANDBOX

local concat = table.concat
local insert = table.insert
local format = mw.ustring.format
local trim = mw.text.trim
local parser = parserModule.parser

-- Shields
local function addContextBanner(route, name, suffix, bannerSpec, sizeStyle)
	local bannerModule = 'Module:Road data/banners/' .. string.upper(route.country)
	local shieldfield = name .. 'shield'
	local shield = parser(route, shieldfield)

	if shield == nil then
		-- This route type does not define shield.
		-- Find shield in the default banner table.
		shield = parser(route, 'shield', name, bannerModule)
		if shield and shield ~= '' then
			if suffix == nil then
				suffix = parser(route, 'shield', 'suffix', bannerModule)
			end

			if suffix and suffix ~= '' then
				shield = shield .. " " .. suffix
			end

			shield = shield .. ".svg"
		end
	end

	if shield and shield ~= '' then
		local shieldSize = sizeModule._size({
			style = sizeStyle,
			type = 'banner'
		})

		-- Add banner plate.
		insert(bannerSpec, {shield, shieldSize})
	end
end

local function bannerSpec(banner, bannerSize, bannerSuffix, route, sizeStyle)
	local banners = {}

	if type(banner) == "table" then
		local bannerSizeIsNotTable = type(bannerSize) ~= "table"

		for i, filename in ipairs(banner) do
			local bannersize = bannerSizeIsNotTable and bannerSize or bannerSize[i]
			insert(banners, {filename, bannersize})
		end
	elseif banner ~= '' then
		insert(banners, {banner, bannerSize})
	end

	if route.dir then
		addContextBanner(route, 'dir', bannerSuffix, banners, sizeStyle)
	end

	if route.to then
		addContextBanner(route, 'to', bannerSuffix, banners, sizeStyle)
	end

	return banners
end

local function shieldSpec(route, shieldStyle, sizeStyle)
	local shieldSpec = {}

	local shield
	if route.to and shieldStyle == 'main' then shield = parser(route, 'shieldtomain') end
	if not shield and route.to then shield = parser(route, 'shieldto') end
	if not shield and shieldStyle == 'main' then shield = parser(route, 'shieldmain') end
	if not shield and shieldStyle == 'list' then shield = parser(route, 'shieldlist') end
	if not shield then shield = parser(route, 'shield') or '' end
	if shield == '' then return shieldSpec end

	local orientation = parser(route, 'orientation')
	local size
	local sizeIsNotTable

	if type(orientation) == "table" then
		size = {}
		sizeIsNotTable = false

		for i, shieldOrientation in ipairs(orientation) do
			insert(size, sizeModule._size({
				style = sizeStyle,
				type = shieldOrientation
			}))
		end
	else
		size = sizeModule._size({
			style = sizeStyle,
			type = orientation
		})
		sizeIsNotTable = true
	end
	
	local banner = parser(route, 'banner') or {}
	local bannerIsNotTable = type(banner) ~= "table"

	local bannerSize = sizeModule._size({
		style = sizeStyle,
		type = 'banner'
	})

	local bannerSuffix = parser(route, 'bannersuffix')
	local bannerSuffixIsNotTable = type(bannerSuffix) ~= "table"

	if type(shield) == "table" then
		for i, filename in ipairs(shield) do
			-- Fallback to default size for the size style
			local shieldSize = sizeIsNotTable and size or size[i]
				or sizeModule._size({style = sizeStyle})

			-- banner.all describes banners that apply to all multiple shields.
			local shieldBanner = bannerIsNotTable and banner or (banner[i] or banner.all or {})
			local shieldBannerSuffix = bannerSuffix and (bannerSuffixIsNotTable and bannerSuffix or bannerSuffix[i])

			insert(shieldSpec, {
				shield = {filename, shieldSize},
				banners = bannerSpec(shieldBanner, bannerSize, shieldBannerSuffix, route, sizeStyle),
				route = route
			})
		end
	elseif shield ~= '' then
		insert(shieldSpec, {
			shield = {shield, size},
			banners = bannerSpec(banner, bannerSize, bannerSuffix, route, sizeStyle),
			route = route
		})
	end

	return shieldSpec
end

local missingShields
local shieldExistsCache = {}

-- Return up to two booleans.
-- The first boolean is false if `shield` does not exist, and true otherwise.
-- If the first boolean is true, the second boolean is true if the shield is
-- landscape (width >= height), and false otherwise.
local function shieldExists(shield)
	local result = shieldExistsCache[shield]
	if result == nil then
		local file = mw.title.new(shield, 'Media').file
		-- Cache result.
		local exists = file.exists
		result = {exists}
		if exists then result[2] = file.width >= file.height end
		shieldExistsCache[shield] = result
	end

	if result[1] then return true, result[2] end
	insert(missingShields, shield)
	return false
end

local function render(shieldEntry, nonDecorative)
	local shield = shieldEntry.shield
	local banners = shieldEntry.banners
	
	local alt = ''
	if nonDecorative then
		alt = (parser(shieldEntry.route, 'abbr') or '') .. ' marker'
	end

	local shieldCode = format("[[File:%s|%s|link=|alt=%s]]", shield[1], shield[2], alt)
	if not banners[1] then return shieldCode end

	for _,banner in ipairs(banners) do
		shieldCode = format(
			"[[File:%s|%s|link=|alt=%s]]<br>%s",
			banner[1],
			banner[2],
			alt,
			shieldCode
		)
	end

	return '<span style="display: inline-block; vertical-align: baseline; line-height: 0; text-align: center;">'
		.. shieldCode
		.. '</span>'
end

function p.shield(route, shieldStyle, sizeStyle, nonDecorative)
	missingShields = {}

	local rendered = {}
	for _,entry in ipairs(shieldSpec(route, shieldStyle, sizeStyle)) do
		insert(rendered, render(entry, nonDecorative))
	end
	
	return concat(rendered, '&thinsp;'), missingShields
end

-- Links
function p.link(route, useName)
	local abbr, errMsg = parser(route, useName and 'name' or 'abbr')

	if not abbr then
		route.typeerror = true
		return util.err(errMsg or format("Invalid type: %s", route.type or "(nil)"))
	end

	if route.nolink then return abbr, abbr end

	local link = parser(route, 'link') or ''
	if link == '' then return abbr, abbr end

	return format("[[%s|%s]]", link, abbr), abbr
end

return p
Module:Road data/sandbox

Usage

Submodules

Data modules

String modules

Banner modules

Mask modules
