refactor(match2): deprecate createbody (#7969)

* refactor(match2): depricate createbody

* chore: update visual snapshots

* allow only createGames too

* lint

* restore heroes

* missing anno

* chore: update visual snapshots

* comments

---------

Co-authored-by: Rathoz <3426850+Rathoz@users.noreply.github.com>

Author: Rathoz

lua/wikis/ageofempires/MatchSummary.lua

@@ -53,7 +53,7 @@ end
 
 ---@param match MatchGroupUtilMatch
 ---@return VNode
-function CustomMatchSummary.createBody(match)
+function CustomMatchSummary.createGames(match)
 	return MatchSummaryWidgets.GamesContainer{
 		children = Array.map(match.games, function (game, gameIndex)
 			if (not game.map) and (not game.winner) and Logic.isEmpty(game.status) and Logic.isDeepEmpty(game.opponents) then

lua/wikis/brawlhalla/MatchSummary.lua

@@ -20,14 +20,14 @@ local Opponent = Lua.import('Module:Opponent/Custom')
 local CustomMatchSummary = {}
 
 ---@param args table
----@return Widget
+---@return Renderable
 function CustomMatchSummary.getByMatchId(args)
 	return MatchSummary.defaultGetByMatchId(CustomMatchSummary, args, {width = '350px', teamStyle = 'bracket'})
 end
 
 ---@param match MatchGroupUtilMatch
----@return Widget[]
-function CustomMatchSummary.createBody(match)
+---@return Renderable[]
+function CustomMatchSummary.createGames(match)
 	return WidgetUtil.collect(
 		CustomMatchSummary._isSolo(match) and Array.map(match.games, CustomMatchSummary._createGame) or nil
 	)
@@ -43,7 +43,7 @@ function CustomMatchSummary._isSolo(match)
 end
 
 ---@param game MatchGroupUtilGame
----@return Widget?
+---@return Renderable?
 function CustomMatchSummary._createGame(game)
 	if not game.map and not game.winner then return end
 

lua/wikis/commons/MatchSummary/Base.lua

@@ -30,7 +30,8 @@ local MATCH_LINK_PRIORITY = Lua.import('Module:Links/MatchPriorityGroups', {load
 local TBD = Abbreviation.make{text = 'TBD', title = 'To Be Determined'}
 
 ---@class CustomMatchSummaryInterface
----@field createBody? fun(match: MatchGroupUtilMatch): Renderable|Renderable[]
+---@field createBody? fun(match: MatchGroupUtilMatch): Renderable|Renderable[] @deprecated
+---@field createGames? fun(match: MatchGroupUtilMatch): Renderable|Renderable[]
 ---@field createGame? fun(date: string, game: table, gameIndex: integer): Renderable|Renderable[]
 ---@field createFooter? fun(match: MatchGroupUtilMatch): Renderable|Renderable[]
 
@@ -59,13 +60,22 @@ end
 
 -- Default body function
 ---@param match MatchGroupUtilMatch
----@param createGame fun(date: string, game: table, gameIndex: integer): Renderable|Renderable[]
+---@param createGames? fun(match: MatchGroupUtilMatch): Renderable|Renderable[]?
+---@param createGame? fun(date: string, game: table, gameIndex: integer): Renderable|Renderable[]
+---@param options {maxBans: integer?}?
 ---@return Renderable[]
-function MatchSummary.createDefaultBody(match, createGame)
+function MatchSummary.createDefaultBody(match, createGames, createGame, options)
+	options = options or {}
+
+	local characterBansData = MatchSummary.buildCharacterBanData(match.games, options.maxBans or 0)
+
 	return WidgetUtil.collect(
-		Array.map(match.games, FnUtil.curry(createGame, match.date)),
+		--- we assume that createGames and createGame are mutually exclusive, so we can safely call one or the other
+		---@diagnostic disable-next-line: param-type-mismatch
+		createGames and createGames(match) or Array.map(match.games, FnUtil.curry(createGame, match.date)),
 		MatchSummaryWidgets.Mvp(match.extradata.mvp),
-		MatchSummaryWidgets.MapVeto(MatchSummary.preProcessMapVeto(match.extradata.mapveto, {game = match.game}))
+		MatchSummaryWidgets.MapVeto(MatchSummary.preProcessMapVeto(match.extradata.mapveto, {game = match.game})),
+		MatchSummaryWidgets.CharacterBanTable{bans = characterBansData, date = match.date}
 	)
 end
 
@@ -167,7 +177,7 @@ end
 ---Default createMatch function for usage in Custom MatchSummary
 ---@param matchData MatchGroupUtilMatch?
 ---@param CustomMatchSummary CustomMatchSummaryInterface
----@param options {teamStyle: teamStyle?, noScore: boolean?}?
+---@param options {teamStyle: teamStyle?, noScore: boolean?, maxBans: integer?}?
 ---@return VNode?
 function MatchSummary.createMatch(matchData, CustomMatchSummary, options)
 	if not matchData then
@@ -181,7 +191,7 @@ function MatchSummary.createMatch(matchData, CustomMatchSummary, options)
 		MatchSummary.createHeader(matchData, options),
 		MatchSummaryWidgets.Body{
 			children = WidgetUtil.collect(
-				createBody(matchData, CustomMatchSummary.createGame),
+				createBody(matchData, CustomMatchSummary.createGames, CustomMatchSummary.createGame, options),
 				Html.Fragment{
 					children = {
 						MatchSummaryWidgets.Casters{casters = matchData.extradata.casters},
@@ -203,12 +213,17 @@ end
 ---Default getByMatchId function for usage in Custom MatchSummary
 ---@param CustomMatchSummary CustomMatchSummaryInterface
 ---@param args table
----@param options {teamStyle:teamStyle?, width: (fun(match: MatchGroupUtilMatch):string?)|string?, noScore:boolean?}?
+---@param options {teamStyle:teamStyle?, width: (fun(match: MatchGroupUtilMatch):string?)|string?,
+---noScore:boolean?, maxBans: integer?}?
 ---@return VNode
 function MatchSummary.defaultGetByMatchId(CustomMatchSummary, args, options)
 	assert(
-		(type(CustomMatchSummary.createBody) == 'function' or type(CustomMatchSummary.createGame) == 'function'),
-		'createBody(match) or createGame(date, game, gameIndex) must be implemented in Module:MatchSummary'
+		(
+			type(CustomMatchSummary.createBody) == 'function' or
+			type(CustomMatchSummary.createGame) == 'function' or
+			type(CustomMatchSummary.createGames) == 'function'
+		),
+		'One of createBody or createGame or createGames must be implemented in Module:MatchSummary'
 	)
 
 	options = options or {}

lua/wikis/deadlock/MatchSummary.lua

@@ -35,24 +35,20 @@ local DeadlockMatchSummaryGameRow = MatchSummaryWidgets.GameRow.createComponent(
 ---@param args table
 ---@return Renderable
 function CustomMatchSummary.getByMatchId(args)
-	return MatchSummary.defaultGetByMatchId(CustomMatchSummary, args, {width = '480px', teamStyle = 'bracket'})
+	local options = {width = '480px', teamStyle = 'bracket', maxBans = MAX_NUM_BANS}
+	return MatchSummary.defaultGetByMatchId(CustomMatchSummary, args, options)
 end
 
 ---@param match MatchGroupUtilMatch
----@return VNode[]
-function CustomMatchSummary.createBody(match)
-	local characterBansData = MatchSummary.buildCharacterBanData(match.games, MAX_NUM_BANS)
-
-	return {
-		MatchSummaryWidgets.GamesContainer{
-			children = Array.map(match.games, function (game, gameIndex)
-				if game.status == STATUS_NOT_PLAYED then
-					return
-				end
-				return DeadlockMatchSummaryGameRow{game = game, gameIndex = gameIndex}
-			end)
-		},
-		MatchSummaryWidgets.CharacterBanTable{bans = characterBansData, date = match.date}
+---@return VNode
+function CustomMatchSummary.createGames(match)
+	return MatchSummaryWidgets.GamesContainer{
+		children = Array.map(match.games, function (game, gameIndex)
+			if game.status == STATUS_NOT_PLAYED then
+				return
+			end
+			return DeadlockMatchSummaryGameRow{game = game, gameIndex = gameIndex}
+		end)
 	}
 end
 

lua/wikis/dota2/MatchSummary.lua

@@ -29,25 +29,20 @@ local Dota2MatchSummaryGameRow = MatchSummaryWidgets.GameRow.createComponent(Gam
 ---@param args table
 ---@return Renderable
 function CustomMatchSummary.getByMatchId(args)
-	return MatchSummary.defaultGetByMatchId(CustomMatchSummary, args, {width = '400px', teamStyle = 'bracket'})
+	local options = {width = '400px', teamStyle = 'bracket', maxBans = MAX_NUM_BANS}
+	return MatchSummary.defaultGetByMatchId(CustomMatchSummary, args, options)
 end
 
 ---@param match MatchGroupUtilMatch
----@return VNode[]
-function CustomMatchSummary.createBody(match)
-	local characterBansData = MatchSummary.buildCharacterBanData(match.games, MAX_NUM_BANS)
-
-	return {
-		MatchSummaryWidgets.GamesContainer{
-			children = Array.map(match.games, function (game, gameIndex)
-				if game.status == STATUS_NOT_PLAYED then
-					return
-				end
-				return Dota2MatchSummaryGameRow{game = game, gameIndex = gameIndex}
-			end)
-		},
-		MatchSummaryWidgets.Mvp(match.extradata.mvp),
-		MatchSummaryWidgets.CharacterBanTable{bans = characterBansData, date = match.date}
+---@return VNode
+function CustomMatchSummary.createGames(match)
+	return MatchSummaryWidgets.GamesContainer{
+		children = Array.map(match.games, function (game, gameIndex)
+			if game.status == STATUS_NOT_PLAYED then
+				return
+			end
+			return Dota2MatchSummaryGameRow{game = game, gameIndex = gameIndex}
+		end)
 	}
 end
 

lua/wikis/easportsfc/MatchSummary.lua

@@ -23,30 +23,28 @@ local NO_CHECK = '[[File:NoCheck.png|link=]]'
 local CustomMatchSummary = {}
 
 ---@param args table
----@return Widget
+---@return Renderable
 function CustomMatchSummary.getByMatchId(args)
 	return MatchSummary.defaultGetByMatchId(CustomMatchSummary, args)
 end
 
 ---@param match MatchGroupUtilMatch
----@return Widget[]
-function CustomMatchSummary.createBody(match)
+---@return Renderable[]
+function CustomMatchSummary.createGames(match)
 	local hasSubMatches = Logic.readBool((match.extradata or {}).hassubmatches)
 
-	local games = Array.map(match.games, function(game)
-		if hasSubMatches then
-			return CustomMatchSummary._createSubMatch(game, match)
-		end
-		return CustomMatchSummary._createGame(game)
-	end)
-
 	return WidgetUtil.collect(
-		games
+		Array.map(match.games, function(game)
+			if hasSubMatches then
+				return CustomMatchSummary._createSubMatch(game, match)
+			end
+			return CustomMatchSummary._createGame(game)
+		end)
 	)
 end
 
 ---@param game MatchGroupUtilGame
----@return MatchSummaryRow
+---@return Renderable
 function CustomMatchSummary._createGame(game)
 	return MatchSummaryWidgets.Row{
 		classes = {'brkts-popup-body-game'},
@@ -63,7 +61,7 @@ end
 
 ---@param game MatchGroupUtilGame
 ---@param match MatchGroupUtilMatch
----@return MatchSummaryRow
+---@return Renderable
 function CustomMatchSummary._createSubMatch(game, match)
 	local players = CustomMatchSummary._extractPlayersFromGame(game, match)
 
@@ -110,7 +108,7 @@ end
 
 ---@param game MatchGroupUtilGame
 ---@param opponentIndex integer
----@return string
+---@return string?
 function CustomMatchSummary._subMatchPenaltyScore(game, opponentIndex)
 	local scores = (game.extradata or {}).penaltyscores
 
@@ -137,7 +135,7 @@ function CustomMatchSummary._players(players, opponentIndex, winner)
 		:css('text-align', flip and 'right' or 'left')
 		:css('width', '35%')
 		:node(OpponentDisplay.BlockPlayers{
-			opponent = {players = players},
+			opponent = {players = players, type = 'solo', extradata = {}},
 			overflow = 'ellipsis',
 			showLink = true,
 		})

lua/wikis/fighters/MatchSummary.lua

@@ -59,7 +59,7 @@ end
 
 ---@param match MatchGroupUtilMatch
 ---@return VNode
-function CustomMatchSummary.createBody(match)
+function CustomMatchSummary.createGames(match)
 	return MatchSummaryWidgets.GamesContainer{
 		children = Array.map(match.games, function (game, gameIndex)
 			if Array.all(game.opponents, function(opponent) return Logic.isDeepEmpty(opponent.players) end) then

lua/wikis/heroes/MatchSummary.lua

@@ -13,6 +13,7 @@ local Logic = Lua.import('Module:Logic')
 
 local MatchSummary = Lua.import('Module:MatchSummary/Base')
 local MatchSummaryWidgets = Lua.import('Module:Widget/Match/Summary/All')
+
 local WidgetUtil = Lua.import('Module:Widget/Util')
 
 local MAX_NUM_BANS = 3

lua/wikis/honorofkings/MatchSummary.lua

@@ -29,14 +29,13 @@ local HoKMatchSummaryGameRow = MatchSummaryWidgets.GameRow.createComponent(GameR
 ---@param args table
 ---@return Renderable
 function CustomMatchSummary.getByMatchId(args)
-	return MatchSummary.defaultGetByMatchId(CustomMatchSummary, args, {width = '420px', teamStyle = 'bracket'})
+	local options = {width = '420px', teamStyle = 'bracket', maxBans = MAX_NUM_BANS}
+	return MatchSummary.defaultGetByMatchId(CustomMatchSummary, args, options)
 end
 
 ---@param match MatchGroupUtilMatch
----@return VNode[]
-function CustomMatchSummary.createBody(match)
-	local characterBansData = MatchSummary.buildCharacterBanData(match.games, MAX_NUM_BANS)
-
+---@return VNode
+function CustomMatchSummary.createGames(match)
 	---@param game MatchGroupUtilGame
 	---@return boolean
 	local function hasCharacterData(game)
@@ -47,17 +46,13 @@ function CustomMatchSummary.createBody(match)
 		end)
 	end
 
-	return {
-		MatchSummaryWidgets.GamesContainer{
-			children = Array.map(match.games, function (game, gameIndex)
-				if Logic.isEmpty(game.length) and Logic.isEmpty(game.winner) and not hasCharacterData(game) then
-					return
-				end
-				return HoKMatchSummaryGameRow{game = game, gameIndex = gameIndex}
-			end)
-		},
-		MatchSummaryWidgets.Mvp(match.extradata.mvp),
-		MatchSummaryWidgets.CharacterBanTable{bans = characterBansData, date = match.date}
+	return MatchSummaryWidgets.GamesContainer{
+		children = Array.map(match.games, function (game, gameIndex)
+			if Logic.isEmpty(game.length) and Logic.isEmpty(game.winner) and not hasCharacterData(game) then
+				return
+			end
+			return HoKMatchSummaryGameRow{game = game, gameIndex = gameIndex}
+		end)
 	}
 end
 

lua/wikis/lab/MatchSummary.lua

@@ -29,16 +29,12 @@ function CustomMatchSummary.getByMatchId(args)
 end
 
 ---@param match MatchGroupUtilMatch
----@return VNode[]
-function CustomMatchSummary.createBody(match)
-	return {
-		MatchSummaryWidgets.GamesContainer{
-			children = Array.map(match.games, function (game, gameIndex)
-				return LabMatchSummaryGameRow{game = game, gameIndex = gameIndex}
-			end)
-		},
-		MatchSummaryWidgets.Mvp(match.extradata.mvp),
-		MatchSummaryWidgets.MapVeto(MatchSummary.preProcessMapVeto(match.extradata.mapveto, {game = match.game}))
+---@return VNode
+function CustomMatchSummary.createGames(match)
+	return MatchSummaryWidgets.GamesContainer{
+		children = Array.map(match.games, function (game, gameIndex)
+			return LabMatchSummaryGameRow{game = game, gameIndex = gameIndex}
+		end)
 	}
 end