Port refactor custom modifiers block into toggleable blocks (#10020)

spec/System/TestCustomModControl_spec.lua

@@ -0,0 +1,240 @@
+describe("Custom modifier controls", function()
+	local initialPopupCount
+
+	before_each(function()
+		newBuild()
+		main:SelectControl()
+		initialPopupCount = #main.popups
+	end)
+
+	after_each(function()
+		main:SelectControl()
+		while #main.popups > initialPopupCount do
+			main:ClosePopup()
+		end
+	end)
+
+	local configModBrowser = require("Modules.ConfigModBrowser")
+
+	local function openModBrowser()
+		local configTab = build.configTab
+		local blockData = configTab.configSets[configTab.activeConfigSetId].customModsList[1]
+		configModBrowser.OpenAddModPopup(configTab, blockData)
+		return main.popups[1], blockData
+	end
+
+	local function getModTemplate(modText)
+		return modText
+			:gsub("([%+-]?)%((%-?%d+%.?%d*)%-(%-?%d+%.?%d*)%)", "%1#")
+			:gsub("%d+%.?%d*", "#")
+			:lower()
+	end
+
+	it("does not retain the modifier list focus after adding a mod", function()
+		local popup, blockData = openModBrowser()
+		local listControl = popup.controls.listControl
+		local selectedMod = listControl.list[1]
+
+		listControl:OnSelClick(1, selectedMod, false)
+		popup.controls.save.onClick()
+
+		assert.is_nil(main.selControl)
+		assert.are_not.equal(popup, main.popups[1])
+		assert.are.equal(selectedMod.text, blockData.text)
+	end)
+
+	it("collapses numeric tiers into a single entry and imports it", function()
+		local popup, blockData = openModBrowser()
+		local minionDamageEntries = { }
+		local minionDamageIndex
+		for index, mod in ipairs(popup.controls.listControl.list) do
+			if mod.text:match("^Minions deal .-%% increased Damage$") then
+				table.insert(minionDamageEntries, mod.text)
+				minionDamageIndex = index
+			end
+		end
+
+		assert.are.same({ "Minions deal 10% increased Damage" }, minionDamageEntries)
+		popup.controls.listControl.selIndex = minionDamageIndex
+		popup.controls.save.onClick()
+		assert.are.equal("Minions deal 10% increased Damage", blockData.text)
+	end)
+
+	it("orders modifiers alphabetically while ignoring numeric values", function()
+		local popup = openModBrowser()
+		local previousSortKey
+		for _, mod in ipairs(popup.controls.listControl.list) do
+			local sortKey = mod.text
+				:gsub("([%+-]?)%((%-?%d+%.?%d*)%-(%-?%d+%.?%d*)%)", "%1#")
+				:gsub("%d+%.?%d*", "#")
+				:lower()
+				:gsub("#", " ")
+				:gsub("[^%a]+", " ")
+				:match("^%s*(.-)%s*$")
+			assert.is_true(not previousSortKey or previousSortKey <= sortKey,
+				tostring(previousSortKey) .. " should be ordered before " .. sortKey)
+			previousSortKey = sortKey
+		end
+	end)
+
+	it("clears the modifier search with its clear button", function()
+		local popup = openModBrowser()
+		local controls = popup.controls
+		local unfilteredCount = #controls.listControl.list
+		assert.is_false(controls.search.controls.buttonClear:IsShown())
+		controls.search:SetText("minion damage", true)
+
+		assert.is_true(#controls.listControl.list < unfilteredCount)
+		assert.are.equal("minion damage", controls.search.buf)
+		assert.is_true(controls.search.controls.buttonClear:IsShown())
+
+		controls.search.controls.buttonClear.onClick()
+
+		assert.are.equal("", controls.search.buf)
+		assert.are.equal(unfilteredCount, #controls.listControl.list)
+		assert.is_false(controls.search.controls.buttonClear:IsShown())
+	end)
+
+	it("disables adding when no modifiers match the search", function()
+		local popup = openModBrowser()
+		local controls = popup.controls
+
+		controls.search:SetText("this modifier cannot possibly exist", true)
+
+		assert.are.equal("No matching modifiers found", controls.listControl.list[1].text)
+		assert.is_false(controls.save:IsEnabled())
+	end)
+
+	it("includes every supported tree modifier", function()
+		local popup = openModBrowser()
+		local displayedMods = { }
+		for _, mod in ipairs(popup.controls.listControl.list) do
+			displayedMods[mod.template] = mod
+		end
+
+		local tree = build.treeTab.specList[build.treeTab.activeSpec].tree
+		for _, node in pairs(tree.nodes) do
+			if node.type == "Mastery" and node.masteryEffects then
+				for _, masteryEffect in ipairs(node.masteryEffects) do
+					for _, statLine in ipairs(masteryEffect.stats) do
+						local modList, extra = modLib.parseMod(statLine)
+						if modList and not extra then
+							local displayed = displayedMods[getModTemplate(statLine)]
+							assert.is_not_nil(displayed, "Missing supported mastery modifier: " .. statLine)
+							assert.is_true(displayed.sources["Mastery Node"], "Missing mastery source: " .. statLine)
+						end
+					end
+				end
+			else
+				local i = 1
+				while node.stats[i] do
+					local combinedLine = node.stats[i]
+					while node.mods[i + 1] and node.mods[i + 1].combined do
+						combinedLine = combinedLine .. " " .. node.stats[i + 1]
+						i = i + 1
+					end
+					if node.mods[i].list and not node.mods[i].extra then
+						assert.is_not_nil(displayedMods[getModTemplate(combinedLine)], "Missing supported tree modifier: " .. combinedLine)
+					end
+					i = i + 1
+				end
+			end
+		end
+	end)
+
+	it("only lists modifier text accepted by the parser", function()
+		local popup = openModBrowser()
+		for _, mod in ipairs(popup.controls.listControl.list) do
+			local modList, extra = modLib.parseMod(mod.text)
+			assert.is_not_nil(modList, "Unsupported browser modifier: " .. mod.text)
+			assert.is_nil(extra, "Partially supported browser modifier: " .. mod.text)
+		end
+	end)
+
+	it("uses the expanded browser dimensions", function()
+		local popup = openModBrowser()
+		local listWidth, listHeight = popup.controls.listControl:GetSize()
+		local searchWidth = popup.controls.search:GetSize()
+
+		assert.are.equal(720, popup.width)
+		assert.are.equal(566, popup.height)
+		assert.are.equal(700, listWidth)
+		assert.are.equal(454, listHeight)
+		assert.are.equal(640, searchWidth)
+	end)
+
+	it("opens with the search field ready for typing", function()
+		local popup = openModBrowser()
+		local inputEvents = { { type = "Char", key = "m" } }
+
+		assert.are.equal(popup.controls.search, popup.selControl)
+		assert.is_true(popup.controls.search.hasFocus)
+		assert.is_nil(popup.controls.listControl.hasFocus)
+
+		popup:ProcessInput(inputEvents, { x = 0, y = 0, width = 1920, height = 1080 })
+
+		assert.are.equal("m", popup.controls.search.buf)
+	end)
+
+	it("uses the mod group title as the calculation source name", function()
+		local configTab = build.configTab
+		local blockData = configTab.configSets[configTab.activeConfigSetId].customModsList[1]
+		blockData.text = "+100 to maximum Life"
+		configTab:BuildModList()
+
+		configTab.customModsBlockControls[1].controls.titleEdit:SetText("Bossing", true)
+
+		-- mod 1 is interlude quest reward life
+		local customMods = configTab.modList:Tabulate("BASE", nil, "Life")
+		assert.are.equal(2, #customMods)
+		assert.are.equal("Custom:Bossing", customMods[2].mod.source)
+
+		build.buildFlag = true
+		runCallback("OnFrame")
+		local breakdownControl = build.calcsTab.controls.breakdown
+		breakdownControl.sectionList = { }
+		breakdownControl:AddModSection({ modName = "Life", modType = "BASE" })
+		local customRow
+		for _, row in ipairs(breakdownControl.sectionList[1].rowList) do
+			if row.mod.source == "Custom:Bossing" then
+				customRow = row
+				break
+			end
+		end
+
+		assert.is_not_nil(customRow)
+		assert.are.equal("Custom", customRow.source)
+		assert.are.equal("Bossing", customRow.sourceName)
+	end)
+
+	it("does not flag the build for rebuilding when previewing a group toggle", function()
+		local configTab = build.configTab
+		local blockData = configTab.configSets[configTab.activeConfigSetId].customModsList[1]
+		blockData.text = "+100 to maximum Life"
+		configTab:BuildModList()
+		build.buildFlag = false
+
+		configTab.customModsBlockControls[1].controls.enableCheck.tooltipFunc(new("Tooltip"):Tooltip())
+
+		assert.is_false(build.buildFlag)
+		assert.is_true(blockData.enabled)
+	end)
+
+	it("removes replaced custom modifier controls from the control host", function()
+		local configTab = build.configTab
+		local oldControl = configTab.customModsBlockControls[1]
+		local controlCount = 0
+		for _ in pairs(configTab.controls) do
+			controlCount = controlCount + 1
+		end
+
+		configTab:UpdateCustomModsControls()
+
+		local updatedControlCount = 0
+		for _, control in pairs(configTab.controls) do
+			assert.are_not.equal(oldControl, control)
+			updatedControlCount = updatedControlCount + 1
+		end
+		assert.are.equal(controlCount, updatedControlCount)
+	end)
+end)

spec/System/TestItemDBControl_spec.lua

@@ -0,0 +1,93 @@
+describe("ItemDBControl", function()
+	local originalGetCursorPos
+
+	before_each(function()
+		originalGetCursorPos = GetCursorPos
+	end)
+
+	after_each(function()
+		GetCursorPos = originalGetCursorPos
+	end)
+
+	it("sorts lower-is-better stats below zero", function()
+		local function makeItem(name)
+			return {
+				name = name,
+				base = {},
+				enchantModLines = {},
+				implicitModLines = {},
+				explicitModLines = {},
+				baseModList = {},
+			}
+		end
+		local betterItem = makeItem("Better Item")
+		local worseItem = makeItem("Worse Item")
+		local invalidItem = makeItem("Invalid Item")
+		local takenDamage = {
+			[betterItem] = 80,
+			[worseItem] = 120,
+		}
+		local itemsTab = {
+			activeItemSet = { useSecondWeaponSet = false },
+			slots = { ["Body Armour"] = {} },
+			build = {
+				calcsTab = {
+					GetMiscCalculator = function()
+						return function(args)
+							return { PhysicalTakenHit = takenDamage[args.repItem] }
+						end
+					end,
+				},
+			},
+			IsItemValidForSlot = function(_, item)
+				return item ~= invalidItem
+			end,
+		}
+		local control = new("ItemDBControl"):ItemDBControl(nil, { 0, 0, 100, 100 }, itemsTab, {
+			list = { invalidItem, betterItem, worseItem },
+		}, "RARE")
+		control.sortDetail = {
+			stat = "PhysicalTakenHit",
+			transform = function(value) return -value end,
+		}
+		control.sortOrder = { control.sortControl.STAT, control.sortControl.NAME }
+
+		control:ListBuilder()
+
+		assert.are.equal(betterItem, control.list[1])
+		assert.are.equal(worseItem, control.list[2])
+		assert.are.equal(invalidItem, control.list[3])
+		assert.are.equal(-80, betterItem.measuredPower)
+		assert.are.equal(-120, worseItem.measuredPower)
+		assert.are.equal(-math.huge, invalidItem.measuredPower)
+	end)
+
+	it("releases focus after opening an item with a double click", function()
+		local item = {
+			raw = "Rarity: Unique\nTest Item\nPlate Belt",
+		}
+		local itemsTab
+		itemsTab = {
+			CreateDisplayItemFromRaw = function(_, raw, isUnique)
+				itemsTab.displayRaw = raw
+				itemsTab.displayIsUnique = isUnique
+			end,
+		}
+		local control = new("ItemDBControl"):ItemDBControl(nil, { 0, 0, 100, 100 }, itemsTab, {
+			list = { item },
+		}, "UNIQUE")
+		control.list = { item }
+		GetCursorPos = function()
+			return 3, 3
+		end
+		control.GetRowRegion = function()
+			return { x = 0, y = 0, width = 100, height = 100 }
+		end
+
+		local selectedControl = control:OnKeyDown("LEFTBUTTON", true)
+
+		assert.is_nil(selectedControl)
+		assert.are.equal(item.raw, itemsTab.displayRaw)
+		assert.is_true(itemsTab.displayIsUnique)
+	end)
+end)

spec/System/TestItemListControl_spec.lua

@@ -0,0 +1,64 @@
+describe("ItemListControl", function()
+	local originalGetCursorPos
+
+	local function newItemListControl()
+		local activeItemSet = {
+			id = 1,
+			title = "Boss",
+			["Body Armour"] = { selItemId = 1 },
+		}
+		local itemsTab = {
+			itemOrderList = { 1, 2 },
+			items = {
+				[1] = { id = 1, type = "Body Armour", base = { subType = "" } },
+				[2] = { id = 2, type = "Jewel", base = { subType = "" } },
+			},
+			itemSets = { activeItemSet },
+			activeItemSet = activeItemSet,
+			slots = { },
+			build = {
+				treeTab = {
+					activeSpec = 1,
+					specList = { { title = "Boss", jewels = { }, nodes = { } } },
+				},
+			},
+			PopulateSlots = function() end,
+			AddUndoState = function() end,
+		}
+		local control = new("ItemListControl"):ItemListControl(nil, { 0, 0, 360, 308 }, itemsTab, true)
+		return control, itemsTab
+	end
+
+	before_each(function()
+		originalGetCursorPos = GetCursorPos
+	end)
+
+	after_each(function()
+		GetCursorPos = originalGetCursorPos
+	end)
+
+	it("releases focus after opening an item with a double click", function()
+		local control, itemsTab = newItemListControl()
+		local item = new("Item"):Item([[
+Rarity: Rare
+Test Belt
+Plate Belt
+]])
+		item.id = 1
+		itemsTab.items[1] = item
+		itemsTab.SetDisplayItem = function(_, displayItem)
+			itemsTab.displayItem = displayItem
+		end
+		GetCursorPos = function()
+			return 3, 3
+		end
+		control.GetRowRegion = function()
+			return { x = 0, y = 0, width = 360, height = 308 }
+		end
+
+		local selectedControl = control:OnKeyDown("LEFTBUTTON", true)
+
+		assert.is_nil(selectedControl)
+		assert.are.equal(1, itemsTab.displayItem.id)
+	end)
+end)