refactor(widget): improve building part 4 - Html[] into string (#…

…4717)

* refactor(widget): improve building part 4 - `Html[]` into `Html`

* reorder

* update usages

* unused code

* change from `Html` to `string`

* fix annos

* ensure we don't tostring nils

components/infobox/commons/infobox.lua

@@ -86,11 +86,7 @@ function Infobox:build(widgets)
 			error('Infobox:build can only accept Widgets')
 		end
 
-		local contentItems = WidgetFactory.work(widget, self.injector)
-
-		for _, node in ipairs(contentItems or {}) do
-			self.content:node(node)
-		end
+		self.content:node(WidgetFactory.work(widget, self.injector))
 	end
 
 	self.root:node(self.content)

components/prize_pool/commons/prize_pool_base.lua

@@ -608,9 +608,7 @@ function BasePrizePool:_buildTable(isAward)
 	end
 
 	local tableNode = mw.html.create('div'):css('overflow-x', 'auto')
-	for _, node in ipairs(WidgetFactory.work(tbl, self._widgetInjector)) do
-		tableNode:node(node)
-	end
+	tableNode:node(WidgetFactory.work(tbl, self._widgetInjector))
 
 	return tableNode
 end

components/squad/commons/squad.lua

@@ -9,7 +9,6 @@
 local Arguments = require('Module:Arguments')
 local Array = require('Module:Array')
 local Class = require('Module:Class')
-local FnUtil = require('Module:FnUtil')
 local Logic = require('Module:Logic')
 local Lua = require('Module:Lua')
 local String = require('Module:StringUtils')
@@ -102,16 +101,14 @@ function Squad:row(row)
 	return self
 end
 
----@return Html
+---@return string
 function Squad:create()
 	local dataTable = Widget.TableNew{
 		css = {['margin-bottom'] = '10px'},
 		classes = {'wikitable-striped', 'roster-card'},
 		children = self.rows,
 	}
-	local wrapper = mw.html.create()
-	Array.forEach(WidgetFactory.work(dataTable, self.injector), FnUtil.curry(wrapper.node, wrapper))
-	return wrapper
+	return WidgetFactory.work(dataTable, self.injector)
 end
 
 return Squad

components/squad/commons/squad_utils.lua

@@ -181,7 +181,7 @@ end
 ---@param squadClass Squad
 ---@param personFunction fun(player: table, squadType: integer):WidgetTableRowNew
 ---@param injector WidgetInjector?
----@return Html
+---@return string
 function SquadUtils.defaultRunManual(frame, squadClass, personFunction, injector)
 	local args = Arguments.getArgs(frame)
 	local injectorInstance = (injector and injector()) or
@@ -210,7 +210,7 @@ end
 ---@param customTitle string?
 ---@param injector? WidgetInjector
 ---@param personMapper? fun(person: table): table
----@return Html?
+---@return string?
 function SquadUtils.defaultRunAuto(players, squadType, squadClass, rowCreator, customTitle, injector, personMapper)
 	local args = {type = squadType, title = customTitle}
 	local injectorInstance = (injector and injector()) or

components/squad/wikis/dota2/squad_custom.lua

@@ -55,7 +55,7 @@ function ExtendedSquadRow:activeteam()
 end
 
 ---@param frame Frame
----@return Html
+---@return string
 function CustomSquad.run(frame)
 	return SquadUtils.defaultRunManual(frame, Squad, CustomSquad._playerRow, CustomInjector)
 end

components/squad/wikis/overwatch/squad_custom.lua

@@ -48,7 +48,7 @@ function ExtendedSquadRow:number()
 end
 
 ---@param frame Frame
----@return Html
+---@return string
 function CustomSquad.run(frame)
 	local args = Arguments.getArgs(frame)
 	local squad = Squad(args, CustomInjector()):title()
@@ -69,7 +69,7 @@ end
 ---@param playerList table[]
 ---@param squadType integer
 ---@param customTitle string?
----@return Html?
+---@return string?
 function CustomSquad.runAuto(playerList, squadType, customTitle)
 	return SquadUtils.defaultRunAuto(playerList, squadType, Squad, SquadUtils.defaultRow(SquadRow), customTitle)
 end

components/squad/wikis/smash/squad_custom.lua

@@ -54,7 +54,7 @@ function ExtendedSquadRow:mains()
 end
 
 ---@param frame Frame
----@return Html
+---@return string
 function CustomSquad.run(frame)
 	local args = Arguments.getArgs(frame)
 	local squad = Squad(args, CustomInjector()):title():header()

components/squad/wikis/starcraft/squad_custom.lua

@@ -59,7 +59,7 @@ function ExtendedSquadRow:elo()
 end
 
 ---@param frame Frame
----@return Html
+---@return string
 function CustomSquad.run(frame)
 	local args = Arguments.getArgs(frame)
 	local tlpd = Logic.readBool(args.tlpd)

components/squad/wikis/starcraft2/squad_custom.lua

@@ -18,15 +18,15 @@ local SquadUtils = Lua.import('Module:Squad/Utils')
 local CustomSquad = {}
 
 ---@param frame Frame
----@return Html
+---@return string
 function CustomSquad.run(frame)
 	return SquadUtils.defaultRunManual(frame, Squad, CustomSquad._playerRow)
 end
 
 ---@param playerList table[]
 ---@param squadType integer
 ---@param customTitle string?
----@return Html?
+---@return string?
 function CustomSquad.runAuto(playerList, squadType, customTitle)
 	return SquadUtils.defaultRunAuto(
 		playerList,

components/squad/wikis/stormgate/squad_custom.lua

@@ -17,15 +17,15 @@ local SquadUtils = Lua.import('Module:Squad/Utils')
 local CustomSquad = {}
 
 ---@param frame Frame
----@return Html
+---@return string
 function CustomSquad.run(frame)
 	return SquadUtils.defaultRunManual(frame, Squad, CustomSquad._playerRow)
 end
 
 ---@param playerList table[]
 ---@param squadType integer
 ---@param customTitle string?
----@return Html?
+---@return string?
 function CustomSquad.runAuto(playerList, squadType, customTitle)
 	return SquadUtils.defaultRunAuto(
 		playerList,

components/widget/widget.lua

@@ -22,13 +22,13 @@ function Widget:assertExistsAndCopy(value)
 end
 
 ---@param injector WidgetInjector?
----@return Widget[]|Html[]|nil
+---@return Widget[]|string|nil
 function Widget:make(injector)
 	error('A Widget must override the make() function!')
 end
 
 ---@param injector WidgetInjector?
----@return Widget[]|Html[]|nil
+---@return Widget[]|string|nil
 function Widget:tryMake(injector)
 	return Logic.tryOrElseLog(
 		function() return self:make(injector) end,

components/widget/widget_breakdown.lua

@@ -26,15 +26,15 @@ local Breakdown = Class.new(
 )
 
 ---@param injector WidgetInjector?
----@return {[1]: Html?}
+---@return string?
 function Breakdown:make(injector)
-	return {Breakdown:_breakdown(self.contents, self.classes, self.contentClasses)}
+	return Breakdown:_breakdown(self.contents, self.classes, self.contentClasses)
 end
 
 ---@param contents (string|number)[]
 ---@param classes string[]
 ---@param contentClasses table<integer, string[]> --can have gaps in the outer table
----@return Html?
+---@return string?
 function Breakdown:_breakdown(contents, classes, contentClasses)
 	if type(contents) ~= 'table' or contents == {} then
 		return nil
@@ -54,7 +54,7 @@ function Breakdown:_breakdown(contents, classes, contentClasses)
 		div:node(infoboxCustomCell)
 	end
 
-	return div
+	return tostring(div)
 end
 
 return Breakdown

components/widget/widget_builder.lua

@@ -6,7 +6,6 @@
 -- Please see https://github.com/Liquipedia/Lua-Modules to contribute
 --
 
-local Array = require('Module:Array')
 local Class = require('Module:Class')
 local Lua = require('Module:Lua')
 
@@ -24,14 +23,14 @@ local Builder = Class.new(
 )
 
 ---@param injector WidgetInjector?
----@return Widget[]
+---@return string
 function Builder:make(injector)
 	local children = self.builder()
-	local widgets = {}
+	local builtChildren = mw.html.create()
 	for _, child in ipairs(children or {}) do
-		Array.extendWith(widgets, WidgetFactory.work(child, injector))
+		builtChildren:node(WidgetFactory.work(child, injector))
 	end
-	return widgets
+	return tostring(builtChildren)
 end
 
 return Builder

components/widget/widget_cell.lua

@@ -90,21 +90,19 @@ function Cell:_content(...)
 end
 
 ---@param injector WidgetInjector?
----@return {[1]: Html?}
+---@return string?
 function Cell:make(injector)
 	self:_new(self.name)
 	self:_class(unpack(self.classes or {}))
 	self:_content(unpack(self.content))
 
 	if self.contentDiv == nil then
-		return {}
+		return
 	end
 
 	self.root	:node(self.description)
 				:node(self.contentDiv)
-	return {
-		self.root
-	}
+	return tostring(self.root)
 end
 
 return Cell

components/widget/widget_center.lua

@@ -25,14 +25,14 @@ local Center = Class.new(
 )
 
 ---@param injector WidgetInjector?
----@return {[1]: Html?}
+---@return string?
 function Center:make(injector)
-	return {Center:_create(self.content, self.classes)}
+	return Center:_create(self.content, self.classes)
 end
 
 ---@param content (string|number)[]
 ---@param classes string[]
----@return Html?
+---@return string?
 function Center:_create(content, classes)
 	if Table.isEmpty(content) then
 		return nil
@@ -47,7 +47,7 @@ function Center:_create(content, classes)
 		centered:wikitext(item)
 	end
 
-	return mw.html.create('div'):node(centered)
+	return tostring(mw.html.create('div'):node(centered))
 end
 
 return Center

components/widget/widget_chronology.lua

@@ -23,33 +23,33 @@ local Chronology = Class.new(
 )
 
 ---@param injector WidgetInjector?
----@return Html[]
+---@return string?
 function Chronology:make(injector)
 	return Chronology:_chronology(self.links)
 end
 
 ---@param links table<string, string|number|nil>
----@return Html[]
+---@return string?
 function Chronology:_chronology(links)
 	if links == nil or Table.size(links) == 0 then
-		return self
+		return
 	end
 
-	local chronologyContent = {}
-	chronologyContent[1] = self:_createChronologyRow(links['previous'], links['next'])
+	local chronologyContent = mw.html.create()
+	chronologyContent:node(self:_createChronologyRow(links['previous'], links['next']))
 
 	local index = 2
 	local previous = links['previous' .. index]
 	local next = links['next' .. index]
 	while (previous ~= nil or next ~= nil) do
-		chronologyContent[index] = self:_createChronologyRow(previous, next)
+		chronologyContent:node(self:_createChronologyRow(previous, next))
 
 		index = index + 1
 		previous = links['previous' .. index]
 		next = links['next' .. index]
 	end
 
-	return chronologyContent
+	return tostring(chronologyContent)
 end
 
 ---@param previous string|number|nil

components/widget/widget_factory.lua

@@ -8,34 +8,27 @@
 
 local Array = require('Module:Array')
 local Class = require('Module:Class')
-local Lua = require('Module:Lua')
-
-local Widget = Lua.import('Module:Widget')
 
 ---@class WidgetFactory
 local WidgetFactory = Class.new()
 
 ---@param widget Widget
 ---@param injector WidgetInjector?
----@return Html[]
+---@return string
 function WidgetFactory.work(widget, injector)
-	local convertedWidgets = {} ---@type Html[]
+	local children = widget:tryMake(injector)
 
-	if widget == nil then
-		return {}
+	if not children then
+		return ''
 	end
 
-	for _, child in ipairs(widget:tryMake(injector) or {}) do
-		if type(child) == 'table' and type(child['is_a']) == 'function' and child:is_a(Widget) then
-			---@cast child Widget
-			Array.extendWith(convertedWidgets, WidgetFactory.work(child, injector))
-		else
-			---@cast child Html
-			table.insert(convertedWidgets, child)
-		end
+	if type(children) == 'string' then
+		return children
 	end
 
-	return convertedWidgets
+	return table.concat(Array.map(children, function(child)
+		return WidgetFactory.work(child, injector)
+	end))
 end
 
 return WidgetFactory

components/widget/widget_header.lua

@@ -36,7 +36,7 @@ local Header = Class.new(
 )
 
 ---@param injector WidgetInjector?
----@return Html[]
+---@return string
 function Header:make(injector)
 	local header = {
 		Header:_name(self.name),
@@ -59,7 +59,11 @@ function Header:make(injector)
 		table.insert(header, 2, subHeader)
 	end
 
-	return header
+	local wrapper = mw.html.create()
+	for _, element in ipairs(header) do
+		wrapper:node(element)
+	end
+	return tostring(wrapper)
 end
 
 ---@param name string?