Module:Episode list/sandbox

local p = {}

-- This module requires the use of the following modules:

local colorContrastModule = require('Module:Color contrast')

local htmlColor = mw.loadData('Module:Color contrast/colors')

local langModule = require("Module:Lang")

local mathModule = require('Module:Math')

local tableEmptyCellModule = require('Module:Table empty cell')

local yesNoModule = require('Module:Yesno')

-- mw.html object for the generated row.

local row

-- Variable that will decide the colspan= of the Short Summary cell.

local nonNilParams = 0

-- Variable that will keep track if a TBA value was entered.

local cellValueTBA = false

-- Variable that handles the assigned tracking categories.

local trackingCategories = ""

-- List of tracking categories.

local trackingCategoryList = {

["air_dates"] = "Category:Episode lists with unformatted air dates",

["alt_air_dates"] = "Category:Episode lists with incorrectly formatted alternate air dates",

["faulty_line_colors"] = "Category:Episode lists with faulty line colors",

["non_compliant_line_colors"] = "Category:Episode lists with non-compliant line colors",

["default_line_colors"] = "Category:Episode list using the default LineColor",

["row_deviations"] = "Category:Episode lists with row deviations",

["invalid_top_colors"] = "Category:Episode lists with invalid top colors",

["tba_values"] = "Category:Episode lists with TBA values",

["nonmatching_numbered_parameters"] = "Category:Episode lists with a non-matching set of numbered parameters",

["raw_unformatted_storyteleplay"] = "Category:Episode lists with unformatted story or teleplay credits",

}

-- List of parameter names in this order.

local cellNameList = {

'EpisodeNumber',

'EpisodeNumber2',

'Title',

'Aux1',

'DirectedBy',

'WrittenBy',

'Aux2',

'Aux3',

'OriginalAirDate',

'AltDate',

'Guests',

'MusicalGuests',

'ProdCode',

'Viewers',

'Aux4'

}

-- List of pairs which cannot be used together

local excludeList = {

['Guests'] = 'Aux1',

['MusicalGuests'] = 'Aux2'

}

-- List of cells that have parameter groups

local parameterGroupCells = {}

local firstParameterGroupCell

local parameterGroupCellsAny = false

-- List of title parameter names in this order.

-- List used for multi title lists.

local titleList = {

'Title',

'RTitle',

'AltTitle',

'RAltTitle',

'NativeTitle',

'TranslitTitle',

}

-- Local function which is used to retrieve the episode number or production code number,

-- without any additional text.

local function idTrim(val, search)

local valFind = string.find(val, search)

if (valFind == nil) then

return val

else

return string.sub(val, 0, valFind-1)

end

end

-- Local function which is used to validate that a parameter has an actual value.

local function hasValue(param)

if (param ~= nil and param ~= "") then

return true

else

return false

end

end

-- Local function which is used to create a table data cell.

local function createTableData(text, rowSpan, textAlign)

if (rowSpan ~= nil and tonumber(rowSpan) > 1) then

row:tag('td')

:attr('rowspan', rowSpan)

:wikitext(text)

else

row:tag('td')

:css('text-align', textAlign)

:wikitext(text)

end

end

-- Local function which is used to add a tracking category to the page.

local function addTrackingCategory(category)

trackingCategories = trackingCategories .. category

end

-- Local function which is used to create a Short Summary row.

local function createShortSummaryRow(args, lineColor)

-- fix for lists in the Short Summary

local shortSummaryText = args.ShortSummary

if (shortSummaryText:match('^[*:;#]') or shortSummaryText:match('^{|')) then

shortSummaryText = '\n' .. shortSummaryText

end

if (shortSummaryText:match('\n[*:;#]')) then

shortSummaryText = shortSummaryText .. '\n'

end

local shortSummaryDiv = mw.html.create('div')

:addClass('shortSummaryText')

:css('max-width', '90vw')

:css('position', 'sticky')

:css('left', '0.2em')

:newline()

:wikitext(shortSummaryText)

local shortSummaryCell = mw.html.create('td')

:addClass('description')

:css('border-bottom', 'solid 3px ' .. lineColor)

:attr('colspan', nonNilParams)

:newline()

:node(shortSummaryDiv)

return mw.html.create('tr')

:addClass('expand-child')

:node(shortSummaryCell)

end

-- Local function which is used to add tracking categories for Top Color issues.

local function addTopColorTrackingCategories(args)

if (hasValue(args.TopColor)) then

addTrackingCategory(trackingCategoryList["row_deviations"])

-- Track top colors that have a color contrast rating below AAA with

-- respect to text color, link color, or visited link color. See

-- WP:COLOR for more about color contrast requirements.

local textContrastRatio = colorContrastModule._ratio{args.TopColor, 'black', ['error'] = 0}

local linkContrastRatio = colorContrastModule._ratio{args.TopColor, '#0B0080', ['error'] = 0}

local visitedLinkContrastRatio = colorContrastModule._ratio{args.TopColor, '#0645AD', ['error'] = 0}

if (textContrastRatio < 7 or linkContrastRatio < 7 or visitedLinkContrastRatio < 7) then

addTrackingCategory(trackingCategoryList["invalid_top_colors"])

end

end

end

-- Local function which is used to add tracking categories for Line Color issues.

local function addLineColorTrackingCategories(args)

if (hasValue(args.LineColor)) then

local blackContrastRatio = colorContrastModule._ratio{args.LineColor, 'black', ['error'] = 0}

local whiteContrastRatio = colorContrastModule._ratio{'white', args.LineColor, ['error'] = 0}

if (colorContrastModule._lum(args.LineColor) == '') then

addTrackingCategory(trackingCategoryList["faulty_line_colors"])

elseif (blackContrastRatio < 7 and whiteContrastRatio < 7) then

addTrackingCategory(trackingCategoryList["non_compliant_line_colors"])

end

else

addTrackingCategory(trackingCategoryList["default_line_colors"])

end

end

-- Local function which is used to set the text of an empty cell

-- with either "TBD" or "N/A".

-- Set to N/A if viewers haven't been available for four weeks, else set it as TBD.

local function setTBDStatus(args, awaitingText, expiredText, weeks)

if args.OriginalAirDate == nil or args.OriginalAirDate == '' then

return tableEmptyCellModule._main({alt_text = awaitingText, title_text = awaitingText})

end

-- If it hasn't aired, change to "N/A".

if string.match(args.OriginalAirDate, '^Unaired') then

return tableEmptyCellModule._main({alt_text = "N/A"})

end

local month, day, year = args.OriginalAirDate:gsub(" ", " "):match("(%a+) (%d+), (%d+)")

if (month == nil) then

day, month, year = args.OriginalAirDate:gsub(" ", " "):match("(%d+) (%a+) (%d+)")

end

if (day == nil) then

return tableEmptyCellModule._main({alt_text = "TBD"})

else

-- List of months.

local monthList = {

['January'] = 1,

['February'] = 2,

['March'] = 3,

['April'] = 4,

['May'] = 5,

['June'] = 6,

['July'] = 7,

['August'] = 8,

['September'] = 9,

['October'] = 10,

['November'] = 11,

['December'] = 12

}

if not monthList[month] then

error('Invalid month ' .. month)

end

local seconds = os.time() - os.time({year = year, month = monthList[month], day = day, hour = 0, min = 0, sec = 0})

if (seconds >= 60 * 60 * 24 * 7 * weeks) then

return tableEmptyCellModule._main({alt_text = expiredText, title_text = expiredText})

else

return tableEmptyCellModule._main({alt_text = awaitingText, title_text = awaitingText})

end

end

end

-- Local function which is used to create an empty cell.

local function createEmptyCell(args, v, unsetParameterGroup)

if (unsetParameterGroup) then

args[v] = tableEmptyCellModule._main({alt_text = "N/A"})

elseif (v == 'Viewers' and hasValue(args.OriginalAirDate)) then

args[v] = setTBDStatus(args, "TBD", "N/A", 4)

elseif (v == 'DirectedBy' or v == 'WrittenBy') then

args[v] = setTBDStatus(args, "TBA", "Unknown", 4)

else

args[v] = tableEmptyCellModule._main({})

end

end

-- Air dates that don't use {{Start date}}

local function checkUsageOfDateTemplates(args, v, onInitialPage, title)

if v == 'OriginalAirDate'

and args[v] ~= ''

and string.match(args[v], '%d%d%d%d') -- Ensure it contains a four-digit number (likely a year)

and string.match(args[v], '2C2C2C') == nil -- Avoids this specific pattern

and not string.match(args[v], '^Unaired') -- Exclude anything starting with "Unaired"

and string.find(args[v], 'itvstart') == nil -- Avoids a {{Start date}} unique class

and onInitialPage

and title.namespace == 0

then

addTrackingCategory(trackingCategoryList["air_dates"])

end

-- Alternate air dates that do use {{Start date}}

if (v == 'AltDate' and args[v] ~= '' and string.find(args[v], 'dtstart') ~= nil and onInitialPage and title.namespace == 0) then

addTrackingCategory(trackingCategoryList["alt_air_dates"])

end

end

-- Local function which is used to create a Production Code cell.

local function createProductionCodeCell(args, v, numberOfParameterGroups)

local thisRowspan

if (not parameterGroupCells[v] and parameterGroupCellsAny) then

thisRowspan = numberOfParameterGroups

else

thisRowspan = 1

end

if (hasValue(args.ProdCode) and string.find(args.ProdCode, 'TBA') == nil) then

row:tag('td')

:attr('id', 'pc' .. idTrim(idTrim(args.ProdCode, ' ----'), '<'))

:attr('rowspan', thisRowspan)

:css('text-align', 'center')

:wikitext(args.ProdCode)

elseif (args.ProdCode == or string.find(args.ProdCode or , 'TBA') ~= nil) then

createEmptyCell(args, v, false)

createTableData(args.ProdCode, thisRowspan, "center")

else

-- ProductionCode parameter not used; Do nothing.

end

nonNilParams = nonNilParams + 1

end

--[[

Local function which is used to extract data

from the numbered serial parameters (Title1, Aux1, etc.), and then convert them to

use the non-numbered parameter names (Title, Aux).

The function returns the args as non-numbered prameter names.

]]--

local function extractDataFromNumberedSerialArgs(args, i, numberOfParameterGroups, title)

for _, v in ipairs(cellNameList) do

local parameter = v

local numberedParameter = v .. "_" .. i

local excludeParameter = excludeList[parameter] or 'NULL' .. parameter

local excludeNumberParameter = (excludeList[numberedParameter] or 'NULL' .. parameter) .. "_" .. i

if (not hasValue(args[numberedParameter]) and not hasValue(args[excludeNumberParameter])

and hasValue(parameterGroupCells[parameter]) and not hasValue(args[excludeParameter])) then

if (v ~= 'ProdCode') then

createEmptyCell(args, parameter, true)

else

args[parameter] = ''

end

if (title.namespace == 0) then

addTrackingCategory(trackingCategoryList["nonmatching_numbered_parameters"])

end

elseif (hasValue(args[numberedParameter]) and not hasValue(args[excludeNumberParameter])) then

args[parameter] = args[numberedParameter]

end

end

return args

end

--[[

Local function which is used to create the Title cell text.

The title text will be handled in the following way:

Line 1: