Skip to content

refactor: bulletproof step 2 - domain layer #8097

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

Open
Rathoz wants to merge 11 commits into from
+1,137 −752
Open

refactor: bulletproof step 2 - domain layer #8097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
46c1a35
refactor: bulletproof step 1.M
Rathoz Aug 21, 2026
0ef9b74
Merge branch 'main' into bulletproof-1.M
Rathoz Aug 21, 2026
c1b9341
refactor: bulletproof step 2
Rathoz Aug 24, 2026
57c6d7e
Merge branch 'main' into bulletproof-1.M
Rathoz Sep 16, 2026
d51ab4a
Merge branch 'bulletproof-1.M' into bulletproof-2
Rathoz Sep 16, 2026
1adea28
Merge branch 'main' into bulletproof-2
Rathoz Sep 18, 2026
203fcac
fix annos
Rathoz Sep 18, 2026
0cc5f2a
ci: annotate import rule violations on the diff
Rathoz Oct 5, 2026
d661c4c
test: move the domain specs into spec/domain
Rathoz Oct 5, 2026
acda3a9
Merge branch 'main' into bulletproof-2
Rathoz Oct 5, 2026
28b8834
Merge branch 'main' into bulletproof-2
Rathoz Oct 16, 2026
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
19 changes: 19 additions & 0 deletions .github/workflows/luacheck.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,25 @@ jobs:
check_name: 'Lint Report'
annotate_only: ${{ (github.event.pull_request.head.repo.full_name != github.repository) }}

lua-import-rules:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v7

- name: Setup python
uses: actions/setup-python@v7
with:
python-version: '3.14'

# Fails on violations coming out of Features/ and Domain/, warns for code that has not
# been restructured yet. Those warnings become errors as each area is migrated.
- name: Check import rules
run: python scripts/check_lua_imports.py
Comment thread
Rathoz marked this conversation as resolved.
env:
PYTHONUNBUFFERED: 1

lua-unit-test:
runs-on: ubuntu-latest

Expand Down
2 changes: 1 addition & 1 deletion lua/.luacheckrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ ignore = {
"212" -- unused argument
}

files["lua/spec/*_spec.lua"].read_globals = {"GoldenTest", "SetActiveWiki", "allwikis"}
files["lua/spec/**/*_spec.lua"].read_globals = {"GoldenTest", "SetActiveWiki", "allwikis"}
81 changes: 50 additions & 31 deletions lua/spec/match_group_util_bracket_spec.lua → lua/spec/domain/bracket_spec.lua
View file
Open in desktop
Comment thread
Rathoz marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,22 @@
---@diagnostic disable: missing-fields

--[[
Tests for Module:MatchGroup/Util/Bracket, the bracket model.
Tests for Module:Domain/Bracket/Model, the bracket model.

Bracket data records, topology, coordinates and the id namespace that addresses a match inside its
match group. A matchlist counts as a bracket here, which is why the flat match id forms live with
the bracket ones.
]]

insulate('MatchGroup/Util/Bracket', function()
insulate('Domain/Bracket/Model', function()
describe('bracketDataFromRecord', function()
it('returns an empty table when there is no data', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_same({}, BracketUtil.bracketDataFromRecord(nil))
end)

it('reads matchlist bracket data', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local bracketData = BracketUtil.bracketDataFromRecord{
type = 'matchlist',
header = 'Round 1',
Expand All @@ -40,12 +40,12 @@ insulate('MatchGroup/Util/Bracket', function()
end)

it('treats anything that is not a bracket as a matchlist', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_equal('matchlist', BracketUtil.bracketDataFromRecord{header = 'x'}.type)
end)

it('reads bracket bracket data', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local bracketData = BracketUtil.bracketDataFromRecord{
type = 'bracket',
header = 'Semifinals',
Expand All @@ -70,7 +70,7 @@ insulate('MatchGroup/Util/Bracket', function()
end)

it('derives the qualification flags from the advance spots', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local bracketData = BracketUtil.bracketDataFromRecord{
type = 'bracket',
qualwin = 'true',
Expand All @@ -84,7 +84,7 @@ insulate('MatchGroup/Util/Bracket', function()
end)

it('reads qualskip and skipround as numbers, including the true spelling', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local fromStrings = BracketUtil.bracketDataFromRecord{
type = 'bracket', qualskip = 'true', skipround = 'true',
}
Expand All @@ -99,7 +99,7 @@ insulate('MatchGroup/Util/Bracket', function()
end)

it('converts the coordinate indexes from zero based to one based', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local bracketData = BracketUtil.bracketDataFromRecord{
type = 'bracket',
coordinates = {roundIndex = 0, sectionIndex = 1, roundCount = 3, depth = 2},
Expand All @@ -115,7 +115,7 @@ insulate('MatchGroup/Util/Bracket', function()

describe('bracketDataToRecord', function()
it('round trips a bracket bracket data', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local record = BracketUtil.bracketDataToRecord{
type = 'bracket',
header = 'Semifinals',
Expand Down Expand Up @@ -148,7 +148,7 @@ insulate('MatchGroup/Util/Bracket', function()

describe('computeLowerMatchIdsFromLegacy', function()
it('reads toupper before tolower and skips empty ones', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_same({'R02-M001', 'R02-M002'},
BracketUtil.computeLowerMatchIdsFromLegacy{toupper = 'R02-M001', tolower = 'R02-M002'})
assert.are_same({'R02-M002'},
Expand All @@ -159,7 +159,7 @@ insulate('MatchGroup/Util/Bracket', function()

describe('autoAssignLowerEdges', function()
it('centres the lower matches when there are fewer of them than opponents', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_same({{lowerMatchIndex = 1, opponentIndex = 2}}, BracketUtil.autoAssignLowerEdges(1, 3))
assert.are_same({
{lowerMatchIndex = 1, opponentIndex = 1},
Expand All @@ -168,7 +168,7 @@ insulate('MatchGroup/Util/Bracket', function()
end)

it('hangs the excess lower matches off the last opponent', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_same({
{lowerMatchIndex = 1, opponentIndex = 1},
{lowerMatchIndex = 2, opponentIndex = 2},
Expand All @@ -177,22 +177,22 @@ insulate('MatchGroup/Util/Bracket', function()
end)

it('returns nothing when there are no lower matches', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_same({}, BracketUtil.autoAssignLowerEdges(0, 2))
end)
end)

describe('computeAdvanceSpots', function()
it('advances the winner to the upper match', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_same(
{{bg = 'up', type = 'advance', matchId = 'R02-M001'}},
BracketUtil.computeAdvanceSpots{upperMatchId = 'R02-M001'}
)
end)

it('lets winnerto and loserto override the upper match', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local spots = BracketUtil.computeAdvanceSpots{
upperMatchId = 'R02-M001',
winnerto = 'R02-M009',
Expand All @@ -203,7 +203,7 @@ insulate('MatchGroup/Util/Bracket', function()
end)

it('marks qualification spots while keeping the target match', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local spots = BracketUtil.computeAdvanceSpots{
upperMatchId = 'R02-M001',
qualwin = 'true',
Expand All @@ -214,21 +214,21 @@ insulate('MatchGroup/Util/Bracket', function()
end)

it('returns nothing for a match that goes nowhere', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_same({}, BracketUtil.computeAdvanceSpots{})
end)
end)

describe('populateAdvanceSpots', function()
it('does nothing for an empty bracket', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.is_true(pcall(function()
BracketUtil.populateAdvanceSpots{matches = {}}
end))
end)

it('sends the semifinal losers to the third place match', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local bracketDatasById = {
['R01-M001'] = {advanceSpots = {}},
['R02-M001'] = {advanceSpots = {}, lowerMatchIds = {'R01-M001'}, thirdPlaceMatchId = 'RxMTP'},
Expand All @@ -246,7 +246,7 @@ insulate('MatchGroup/Util/Bracket', function()
end)

it('applies the pbg overrides from extradata', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local bracketData = {advanceSpots = {}, lowerMatchIds = {}}
BracketUtil.populateAdvanceSpots{
matches = {{extradata = {pbg1 = 'down', pbg2 = 'stay'}, bracketData = bracketData}},
Expand All @@ -260,9 +260,28 @@ insulate('MatchGroup/Util/Bracket', function()
end)
end)

describe('resetMatch', function()
it('finds the match that replays a grand final', function()
local BracketUtil = require('Module:Domain/Bracket/Model')
local reset = {matchId = 'R03-M001'}
assert.are_equal(reset, BracketUtil.resetMatch(
{['R03-M001'] = reset}, {bracketResetMatchId = 'R03-M001'}))
end)

it('finds nothing for a match that has no reset', function()
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.is_nil(BracketUtil.resetMatch({['R03-M001'] = {}}, {}))
end)

it('finds nothing when the reset match is not in the bracket', function()
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.is_nil(BracketUtil.resetMatch({}, {bracketResetMatchId = 'R03-M001'}))
end)
end)

describe('computeRootMatchIds', function()
it('takes the matches that have no upper match, in coordinate order', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local rootMatchIds = BracketUtil.computeRootMatchIds{
['R01-M001'] = {upperMatchId = 'R02-M001'},
['R02-M001'] = {coordinates = {rootIndex = 2}},
Expand All @@ -272,7 +291,7 @@ insulate('MatchGroup/Util/Bracket', function()
end)

it('never treats a bracket reset match as a root', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_same({'R01-M001'}, BracketUtil.computeRootMatchIds{
['R01-M001'] = {coordinates = {rootIndex = 1}},
['abcdefghij_RxMBR'] = {coordinates = {rootIndex = 2}},
Expand All @@ -282,7 +301,7 @@ insulate('MatchGroup/Util/Bracket', function()

describe('backfillUpperMatchIds', function()
it('points every lower match at the match above it', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local bracketDatasById = {
['R01-M001'] = {lowerMatchIds = {}},
['R01-M002'] = {lowerMatchIds = {}},
Expand All @@ -298,7 +317,7 @@ insulate('MatchGroup/Util/Bracket', function()

describe('index table conversion', function()
it('shifts only the keys ending in Index', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local coordinates = {roundIndex = 0, sectionIndex = 2, roundCount = 4, matchId = 'R01-M001'}
local oneBased = BracketUtil.indexTableFromRecord(coordinates)

Expand All @@ -309,7 +328,7 @@ insulate('MatchGroup/Util/Bracket', function()

describe('sectionIndexToString', function()
it('names the first, last and middle sections', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_equal('upper', BracketUtil.sectionIndexToString(1, 3))
assert.are_equal('mid', BracketUtil.sectionIndexToString(2, 3))
assert.are_equal('lower', BracketUtil.sectionIndexToString(3, 3))
Expand All @@ -321,36 +340,36 @@ insulate('MatchGroup/Util/Bracket', function()
-- match ids address a match inside its match group, so they live with the bracket half
describe('match ids', function()
it('splits a match id into bracket id and base match id', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
local bracketId, baseMatchId = BracketUtil.splitMatchId('h5HXaqbSVP_R02-M002')
assert.are_equal('h5HXaqbSVP', bracketId)
assert.are_equal('R02-M002', baseMatchId)
end)

it('returns nothing for a match id it cannot split', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.is_nil(BracketUtil.splitMatchId('R02-M002'))
assert.is_nil((BracketUtil.splitMatchId('')))
end)

it('converts between the padded and short match id forms', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_equal('R1M3', BracketUtil.matchIdToKey('R01-M003'))
assert.are_equal('R12M345', BracketUtil.matchIdToKey('R12-M345'))
assert.are_equal('R01-M003', BracketUtil.matchIdFromKey('R1M3'))
assert.are_equal('R12-M345', BracketUtil.matchIdFromKey('R12M345'))
end)

it('leaves the reset and third place placeholders alone', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_equal('RxMBR', BracketUtil.matchIdToKey('RxMBR'))
assert.are_equal('RxMTP', BracketUtil.matchIdToKey('RxMTP'))
assert.are_equal('RxMBR', BracketUtil.matchIdFromKey('RxMBR'))
assert.are_equal('RxMTP', BracketUtil.matchIdFromKey('RxMTP'))
end)

it('pads a matchlist key to four digits', function()
local BracketUtil = require('Module:MatchGroup/Util/Bracket')
local BracketUtil = require('Module:Domain/Bracket/Model')
assert.are_equal('0003', BracketUtil.matchIdFromKey('3'))
end)

Expand Down
Loading
Loading