Skip to content

refactor: wip #7954

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Rathoz wants to merge 1 commit into from
Draft

refactor: wip #7954

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 46 additions & 92 deletions lua/wikis/commons/Features/Squad/Auto.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,8 @@

local Lua = require('Module:Lua')

local Arguments = Lua.import('Module:Arguments')
local Array = Lua.import('Module:Array')
local Class = Lua.import('Module:Class')
local FnUtil = Lua.import('Module:FnUtil')
local Info = Lua.import('Module:Info')
local Json = Lua.import('Module:Json')
local Logic = Lua.import('Module:Logic')
local Page = Lua.import('Module:Page')
Expand All @@ -24,8 +21,8 @@ local TransferRefs = Lua.import('Module:Transfer/References')

local SquadTypes = Lua.import('Module:Features/Squad/Types')
local SquadHistory = Lua.import('Module:Features/Squad/Lib/History')
local SquadTransferHistory = Lua.import('Module:Features/Squad/Api/TransferHistory')
local SquadCustom = Lua.import('Module:Features/Squad/Custom')
local SquadTransferHistory = Lua.import('Module:Features/Squad/Api/TransferHistory')

local INVALID_HISTORY_CATEGORY = 'SquadAuto with invalid player history'

Expand All @@ -35,9 +32,7 @@ local INVALID_HISTORY_CATEGORY = 'SquadAuto with invalid player history'
---@field manualPlayers table?
---@field manualTimeline table?
---@field playersTeamHistory table<string, TeamHistoryEntry[]>
local SquadAuto = Class.new(nil, function (self, frame)
self.args = Arguments.getArgs(frame)
end)
local SquadAuto = {}

---@class SquadAutoConfig
---@field team string
Expand All @@ -50,91 +45,52 @@ end)
---@field roleData RoleData[]
---@field positionData RoleData[]

---Entrypoint for SquadAuto tables
---@param frame Frame|table
---@return Renderable?
function SquadAuto.run(frame)
if not Info.config.squads.standardizedAuto then
-- Legacy mode: Call old SquadAuto
local OldSquadAuto = Lua.import('Module:SquadAuto')
local args = Arguments.getArgs(frame)

local type = SquadTypes.TypeToSquadType[(args.type or ''):lower()]
-- Old module needs special type argument
if type == SquadTypes.SquadType.STAFF then
args.type = 'Organization_' .. args.status
else
args.type = 'Player_' .. args.status
end

return OldSquadAuto[args.status](args)
end

local autosquad = SquadAuto(frame)
local entries = autosquad:build()
return autosquad:display(entries)
end

---Handles all necessary steps to fetch and sort data
function SquadAuto:build()
self:_parseConfig()
self.playersTeamHistory = SquadTransferHistory.forTeam(self.config.team, self.config.teams)
local entries = self:_selectEntries()
Array.forEach(entries, FnUtil.curry(SquadAuto._enrichEntry, self))
return entries
end

---Parses the args into a SquadAutoConfig
---@private
function SquadAuto:_parseConfig()
local args = self.args
function SquadAuto._parseConfig(args)
local type = SquadTypes.TypeToSquadType[(args.type or ''):lower()]
local status = SquadTypes.StatusToSquadStatus[(args.status or ''):lower()]
self.config = {
local config = {
team = args.team or mw.title.getCurrentTitle().text,
type = type,
status = status,
title = args.title
}

self.manualPlayers, self.enrichmentInfo = self:_readManualRowInput()

-- Override default 'Former Squad' title
if status == SquadTypes.SquadStatus.FORMER
and type == SquadTypes.SquadType.PLAYER
and not self.config.title then
self.config.title = 'Former Players'
and not config.title then
config.title = 'Former Players'
end

local historicalTemplates = TeamTemplate.queryHistorical(self.config.team) or {}
self.config.teams = Array.append(Array.extractValues(historicalTemplates), TeamTemplate.resolve(self.config.team))
local historicalTemplates = TeamTemplate.queryHistorical(config.team) or {}
config.teams = Array.append(Array.extractValues(historicalTemplates), TeamTemplate.resolve(config.team))

if Logic.isEmpty(self.config.teams) then
error(TeamTemplate.noTeamMessage(self.config.team))

if Logic.isEmpty(config.teams) then
error(TeamTemplate.noTeamMessage(config.team))
end

return config
end

---@param entries SquadAutoPerson[]
---@return Renderable?
function SquadAuto:display(entries)
if Logic.isEmpty(entries) then
return
function SquadAuto.display(config, entries)
if SquadAuto._isStatus(config, SquadTypes.SquadStatus.FORMER) or SquadAuto._isStatus(config, SquadTypes.SquadStatus.FORMER_INACTIVE) then
return SquadAuto.displayTabs(config, entries)
end

if self:_isStatus(SquadTypes.SquadStatus.FORMER) or self:_isStatus(SquadTypes.SquadStatus.FORMER_INACTIVE) then
return self:displayTabs(entries)
end

local useRankSort = self:_isStatus(SquadTypes.SquadStatus.ACTIVE)
local useRankSort = SquadAuto._isStatus(config, SquadTypes.SquadStatus.ACTIVE)
entries = SquadAuto._sortEntries(entries, useRankSort)

return SquadCustom.runAuto(entries, self.config.status, self.config.type, self.config.title)
return SquadCustom.runAuto(entries, config.status, config.type, config.title)
end

---@private
---@param entries SquadAutoPerson[]
---@return Renderable?
function SquadAuto:displayTabs(entries)
function SquadAuto.displayTabs(config, entries)
local _, groupedEntries = Array.groupBy(
entries,
---@param entry SquadAutoPerson
Expand All @@ -148,9 +104,9 @@ function SquadAuto:displayTabs(entries)
if tabCount == 1 then
return SquadCustom.runAuto(
SquadAuto._sortEntries(entries),
self.config.status,
self.config.type,
self.config.title
config.status,
config.type,
config.title
)
end

Expand All @@ -165,21 +121,20 @@ function SquadAuto:displayTabs(entries)
tabs['name' .. idx] = year
tabs['content' .. idx] = SquadCustom.runAuto(
SquadAuto._sortEntries(group),
self.config.status,
self.config.type,
self.config.title
config.status,
config.type,
config.title
)
idx = idx + 1
end

return Tabs.dynamic(tabs)
end

---@private
---@param entry SquadAutoPerson
function SquadAuto:_enrichEntry(entry)
function SquadAuto._enrichEntry(enrichmentInfo, entry)
local pagename = Page.pageifyLink(entry.link)
local enrichment = self.enrichmentInfo[pagename]
local enrichment = enrichmentInfo[pagename]
if enrichment then
Table.mergeInto(entry, enrichment)
end
Expand All @@ -199,15 +154,14 @@ function SquadAuto:_enrichEntry(entry)
--TODO: Captain from pagevar set in infobox?
end

---@private
---@return SquadAutoPerson[] manualPersons
---@return table<string, SquadAutoPerson> enrichmentInfo
function SquadAuto:_readManualRowInput()
function SquadAuto._readManualRowInput(args, config)
---@type SquadAutoPerson[]
local persons = {}
local enrichmentInfo = {}

Array.forEach(self.args, function (entry)
Array.forEach(args, function (entry)
local person = Json.parseIfString(entry)

if Logic.isEmpty(person) then
Expand All @@ -217,7 +171,7 @@ function SquadAuto:_readManualRowInput()
local link = Page.pageifyLink(person.link or person.id or person.name)
assert(link, 'Missing identifier or link for SquadAutoRow ' .. entry)

if self:_isStaffTable() and Logic.isNotEmpty(person.role) then
if SquadAuto._isStaffTable(config) and Logic.isNotEmpty(person.role) then
-- Only allow manual entries for STAFF (organization) tables
---@type SquadAutoPerson
local manualPerson = {
Expand Down Expand Up @@ -265,22 +219,21 @@ function SquadAuto:_readManualRowInput()
return persons, enrichmentInfo
end

---@private
---@return SquadAutoPerson[]
function SquadAuto:_selectEntries()
function SquadAuto._selectEntries(playersTeamHistory, manualPlayers, config)
return Array.filter(
Array.extend(
Array.flatMap(
Array.extractValues(self.playersTeamHistory),
FnUtil.curry(self._selectPersons, self)
Array.extractValues(playersTeamHistory),
FnUtil.curry(SquadAuto._selectPersons, config)
),
self.manualPlayers
manualPlayers
),
--- Selects the appropriate entries based on the role.
---@param entry SquadAutoPerson
---@return boolean
function(entry)
if self:_isStatus(SquadTypes.SquadStatus.INACTIVE) then
if SquadAuto._isStatus(config, SquadTypes.SquadStatus.INACTIVE) then
-- For SquadStatus.INACTIVE the entries are already preselected
-- and won't have the role set to Inactive.
-- This also matches manual Squad, where status is inactive and role can e.g. be "On Loan"
Expand All @@ -294,7 +247,7 @@ function SquadAuto:_selectEntries()
or role.type == RoleUtil.ROLE_TYPE.UNKNOWN -- Unknown roles are assumed to be non-player
end)

return self:_isStaffTable() == hasStaffRoles
return SquadAuto._isStaffTable(config) == hasStaffRoles
end
)
end
Expand All @@ -304,10 +257,11 @@ end
---If the status is (in)active, then at most one entry will be returned
---If the status is former(_inactive), there might be multiple entries returned
---@private
---@param config SquadAutoConfig
---@param entries TeamHistoryEntry[]
---@return SquadAutoPerson[]
function SquadAuto:_selectPersons(entries)
local selection = SquadHistory.selectStints(entries, self.config.status)
function SquadAuto._selectPersons(config, entries)
local selection = SquadHistory.selectStints(entries, config.status)
if not selection then
return {}
end
Expand All @@ -316,10 +270,10 @@ function SquadAuto:_selectPersons(entries)

if selection.hasFormerInactiveEntry then
-- FORMER_INACTIVE enables the Inactive Date display
self.config.status = SquadTypes.SquadStatus.FORMER_INACTIVE
config.status = SquadTypes.SquadStatus.FORMER_INACTIVE
end

return Array.map(selection.stints, FnUtil.curry(SquadAuto._mapToSquadPerson, self))
return Array.map(selection.stints, SquadAuto._mapToSquadPerson)
end

---Logs the transfers that could not be fitted into a person's history, and categorizes the page.
Expand All @@ -337,7 +291,7 @@ end
---@private
---@param stint SquadStint
---@return SquadAutoPerson
function SquadAuto:_mapToSquadPerson(stint)
function SquadAuto._mapToSquadPerson(stint)
local joinEntry = stint.joinEntry
local inactiveEntry = stint.inactiveEntry or {}
local leaveEntry = stint.leaveEntry or {}
Expand Down Expand Up @@ -433,15 +387,15 @@ end

---Whether the current table is for staff
---@return boolean
function SquadAuto:_isStaffTable()
return self.config.type == SquadTypes.SquadType.STAFF
function SquadAuto._isStaffTable(config)
return config.type == SquadTypes.SquadType.STAFF
end

---Whether the current table is for a specific status
---@param status SquadStatus
---@return boolean
function SquadAuto:_isStatus(status)
return self.config.status == status
function SquadAuto._isStatus(config, status)
return config.status == status
end

return SquadAuto
Empty file added lua/wikis/commons/Features/Squad/Components/TabWrapper.lua
View file
Open in desktop
Empty file.
39 changes: 32 additions & 7 deletions lua/wikis/commons/Features/Squad/Controller.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
local Context = Lua.import('Module:Widget/ComponentContext')
local FnUtil = Lua.import('Module:FnUtil')
local Info = Lua.import('Module:Info', {loadData = true})
local Logic = Lua.import('Module:Logic')
local SquadParser = Lua.import('Module:Features/Squad/Lib/Parse')
local SquadColumnAnalyser = Lua.import('Module:Features/Squad/Lib/Columns')
local SquadStore = Lua.import('Module:Features/Squad/Api/Store')
Expand All @@ -23,12 +24,16 @@
local SquadHeader = Lua.import('Module:Features/Squad/Components/Header')
local SquadPlayerDisplay = Lua.import('Module:Features/Squad/Components/Player')
local Table2 = Lua.import('Module:Widget/Table2/All')
local LegacyAdaptor = Lua.import('Module:Features/Squad/LegacyAdaptor')
local AutoSquad = Lua.import('Module:Features/Squad/Auto')
local SquadTransferHistory = Lua.import('Module:Features/Squad/Api/TransferHistory')


local SquadController = {}

---@param squadData SquadWrapper
---@param adjustLpdb function?
---@return Component
---@return Renderable
function SquadController.execute(squadData, adjustLpdb)
local squadPlayers = Array.map(squadData.players, function(player)
return SquadParser.readSquadPersonArgs(Table.merge(
Expand Down Expand Up @@ -72,7 +77,7 @@
end

---@param frame Frame
---@return Widget
---@return Renderable
function SquadController.run(frame, adjustLpdb)
if not Info.config.squads.allowManual then
error('This wiki does not use manual squad tables')
Expand All @@ -83,18 +88,38 @@
return SquadController.execute(squadData, adjustLpdb)
end

---@deprecated
---@param players table[]
---@param squadStatus SquadStatus
---@param squadType SquadType
---@param customTitle string?
---@return Widget
---@return Renderable
function SquadController.runAuto(players, squadStatus, squadType, customTitle, adjustLpdb)
-- Temporary until all wikis have enabled the new version of automated squads
if not Info.config.squads.standardizedAuto then
players = Array.map(players, SquadParser.convertAutoParameters)
end
players = Array.map(players, SquadParser.convertAutoParameters)

Check failure on line 98 in lua/wikis/commons/Features/Squad/Controller.lua

View workflow job for this annotation

GitHub Actions / luals-code-style 

Deprecated. (deprecated)
local squadData = SquadParser.createWrapperData(players, squadType, squadStatus, customTitle)
return SquadController.execute(squadData, adjustLpdb)
end

---@param frame Frame
---@return Renderable?
function SquadController.runNewAuto(frame)
local args = Arguments.getArgs(frame)

if not Info.config.squads.standardizedAuto then
return LegacyAdaptor.adapt(args)
end

local config = AutoSquad._parseConfig(args)
local manualPlayers, enrichmentInfo = AutoSquad._readManualRowInput(args, config)
local playersTeamHistory = SquadTransferHistory.forTeam(config.team, config.teams)
local entries = AutoSquad._selectEntries(playersTeamHistory, manualPlayers, config)
Array.forEach(entries, FnUtil.curry(AutoSquad._enrichEntry, enrichmentInfo))

if Logic.isEmpty(entries) then
return
end

return AutoSquad.display(config, entries)
end

return SquadController
Loading
Loading