chore(tests): more unit test updates

Author: MeanderingProgrammer

tests/ad_hoc_spec.lua

@@ -5,7 +5,7 @@ local util = require('tests.util')
 ---@param start_row integer
 ---@param end_row integer
 ---@param level integer
----@return render.md.MarkInfo[]
+---@return render.md.test.MarkInfo[]
 local function setext_heading(start_row, end_row, level)
     local sign_mark, icon_mark, background_mark = unpack(util.heading(start_row, level))
     local icon, highlight = unpack(icon_mark.virt_text[1])
@@ -38,34 +38,34 @@ describe('ad_hoc.md', function()
 
         marks:add(util.bullet(row:inc(), 0, 1))
         marks:add(util.conceal(row:get(), { 2, 3 }))
-        marks:add(util.inline(row:get(), { 3, 14 }, { '󱗖 ', 'RenderMarkdownWikiLink' }))
+        marks:add(util.inline(row:get(), { 3, 14 }, { '󱗖 ', 'RmWikiLink' }))
         marks:add(util.conceal(row:get(), { 14, 15 }))
 
         marks:add(util.bullet(row:inc(), 0, 1))
         marks:add(util.conceal(row:get(), { 2, 3 }))
-        marks:add(util.inline(row:get(), { 3, 24 }, { '󱗖 ', 'RenderMarkdownWikiLink' }))
+        marks:add(util.inline(row:get(), { 3, 24 }, { '󱗖 ', 'RmWikiLink' }))
         marks:add(util.conceal(row:get(), { 4, 13 }))
         marks:add(util.conceal(row:get(), { 24, 25 }))
 
         marks:add(util.bullet(row:inc(), 0, 1))
         marks:add(util.conceal(row:get(), { 2, 3 }))
-        marks:add(util.inline(row:get(), { 2, 20 }, { '󰀓 ', 'RenderMarkdownLink' }))
+        marks:add(util.inline(row:get(), { 2, 20 }, { '󰀓 ', 'RmLink' }))
         marks:add(util.highlight(row:get(), { 2, 20 }, 'link'))
         marks:add(util.conceal(row:get(), { 19, 20 }))
 
         marks:add(util.bullet(row:inc(), 0, 1))
         marks:add(util.conceal(row:get(), { 2, 3 }))
-        marks:add(util.inline(row:get(), { 2, 26 }, { '󰊤 ', 'RenderMarkdownLink' }))
+        marks:add(util.inline(row:get(), { 2, 26 }, { '󰊤 ', 'RmLink' }))
         marks:add(util.highlight(row:get(), { 2, 26 }, 'link'))
         marks:add(util.conceal(row:get(), { 25, 26 }))
 
         marks:add(util.bullet(row:inc(), 0, 1))
-        marks:add(util.inline(row:get(), { 2, 61 }, { '󰗃 ', 'RenderMarkdownLink' }))
+        marks:add(util.inline(row:get(), { 2, 61 }, { '󰗃 ', 'RmLink' }))
 
         marks:add(util.bullet(row:inc(), 0, 1))
-        marks:add(util.inline(row:get(), { 16, 25 }, { '¹ ᴵⁿᶠᵒ', 'RenderMarkdownLink' }, ''))
+        marks:add(util.inline(row:get(), { 16, 25 }, { '¹ ᴵⁿᶠᵒ', 'RmLink' }, ''))
         marks:add(util.conceal(row:inc(2), { 0, 16 }))
-        marks:add(util.inline(row:inc(2), { 0, 9 }, { '¹ ᴵⁿᶠᵒ', 'RenderMarkdownLink' }, ''))
+        marks:add(util.inline(row:inc(2), { 0, 9 }, { '¹ ᴵⁿᶠᵒ', 'RmLink' }, ''))
 
         util.assert_view(marks, {
             '󰫎   1 󰲡 Heading',

tests/box_dash_quote_spec.lua

@@ -11,17 +11,17 @@ describe('box_dash_quote.md', function()
         marks:extend(util.heading(row:get(), 1))
 
         marks:add(util.conceal(row:inc(2), { 0, 2 }))
-        marks:add(util.inline(row:get(), { 2, 5 }, { '󰄱 ', 'RenderMarkdownUnchecked' }, ''))
+        marks:add(util.inline(row:get(), { 2, 5 }, { '󰄱 ', 'RmUnchecked' }, ''))
         marks:add(util.conceal(row:inc(), { 0, 2 }))
-        marks:add(util.inline(row:get(), { 2, 5 }, { '󰱒 ', 'RenderMarkdownChecked' }, ''))
+        marks:add(util.inline(row:get(), { 2, 5 }, { '󰱒 ', 'RmChecked' }, ''))
         marks:add(util.conceal(row:inc(), { 0, 2 }))
-        marks:add(util.inline(row:get(), { 2, 5 }, { '󰥔 ', 'RenderMarkdownTodo' }, ''))
+        marks:add(util.inline(row:get(), { 2, 5 }, { '󰥔 ', 'RmTodo' }, ''))
         marks:add(util.bullet(row:inc(), 0, 1))
 
-        marks:add(util.overlay(row:inc(2), { 0 }, { string.rep('─', vim.o.columns), 'RenderMarkdownDash' }))
+        marks:add(util.overlay(row:inc(2), { 0 }, { string.rep('─', vim.o.columns), 'RmDash' }))
 
-        marks:add(util.quote(row:inc(2), '  %s ', 'RenderMarkdownQuote'))
-        marks:add(util.quote(row:inc(), '  %s ', 'RenderMarkdownQuote'))
+        marks:add(util.quote(row:inc(2), '  %s ', 'RmQuote'))
+        marks:add(util.quote(row:inc(), '  %s ', 'RmQuote'))
 
         util.assert_view(marks, {
             '󰫎   1 󰲡 Checkbox / Dash / Quote',

tests/callout_spec.lua

@@ -8,7 +8,7 @@ describe('callout.md', function()
 
         local marks, row = util.marks(), util.row()
 
-        local info = 'RenderMarkdownInfo'
+        local info = 'RmInfo'
         marks:extend(util.heading(row:get(), 1))
         marks:add(util.quote(row:inc(2), '%s ', info))
         marks:add(util.overlay(row:get(), { 2, 9 }, { '󰋽 Note', info }))
@@ -17,7 +17,7 @@ describe('callout.md', function()
         marks:add(util.quote(row:inc(), '%s', info))
         marks:add(util.quote(row:inc(), '%s ', info))
 
-        local ok = 'RenderMarkdownSuccess'
+        local ok = 'RmSuccess'
         marks:extend(util.heading(row:inc(2), 1))
         marks:add(util.quote(row:inc(2), '%s ', ok))
         marks:add(util.overlay(row:get(), { 2, 8 }, { '󰌶 Tip', ok }))
@@ -30,19 +30,19 @@ describe('callout.md', function()
         marks:add(util.quote(row:inc(), '%s ', ok))
         marks:add(util.code_border(row:get(), 2, false))
 
-        local hint = 'RenderMarkdownHint'
+        local hint = 'RmHint'
         marks:extend(util.heading(row:inc(2), 1))
         marks:add(util.quote(row:inc(2), '%s ', hint))
         marks:add(util.overlay(row:get(), { 2, 14 }, { '󰅾 Important', hint }))
         marks:add(util.quote(row:inc(), '%s ', hint))
 
-        local warn = 'RenderMarkdownWarn'
+        local warn = 'RmWarn'
         marks:extend(util.heading(row:inc(2), 1))
         marks:add(util.quote(row:inc(2), '%s ', warn))
         marks:add(util.overlay(row:get(), { 2, 12 }, { '󰀪 Custom Title', warn }, ''))
         marks:add(util.quote(row:inc(), '%s ', warn))
 
-        local err = 'RenderMarkdownError'
+        local err = 'RmError'
         marks:extend(util.heading(row:inc(2), 1))
         marks:add(util.quote(row:inc(2), '%s ', err))
         marks:add(util.overlay(row:get(), { 2, 12 }, { '󰳦 Caution', err }))

tests/code_spec.lua

@@ -7,16 +7,16 @@ local util = require('tests.util')
 ---@param offset integer
 ---@param left integer
 ---@param priority integer
----@return render.md.MarkInfo
+---@return render.md.test.MarkInfo
 local function padding(row, col, offset, left, priority)
     local virt_text = {}
     if offset > 0 then
         table.insert(virt_text, { string.rep(' ', offset), 'Normal' })
     end
     if left > 0 then
-        table.insert(virt_text, { string.rep(' ', left), 'RenderMarkdownCode' })
+        table.insert(virt_text, { string.rep(' ', left), 'RmCode' })
     end
-    ---@type render.md.MarkInfo
+    ---@type render.md.test.MarkInfo
     return {
         row = { row },
         col = { col },

tests/helpers/details.lua

@@ -0,0 +1,108 @@
+---@class render.md.test.MarkDetails: render.md.test.MarkInfo
+local MarkDetails = {}
+MarkDetails.__index = MarkDetails
+
+---@param row integer
+---@param col integer
+---@param details vim.api.keyset.extmark_details
+---@return render.md.test.MarkDetails
+function MarkDetails.new(row, col, details)
+    local self = setmetatable({}, MarkDetails)
+    self.row = { row, details.end_row }
+    self.col = { col, details.end_col }
+    self.hl_eol = details.hl_eol
+    self.hl_group = details.hl_group
+    if self.hl_group ~= nil then
+        self.hl_group = MarkDetails.simplify(self.hl_group)
+    end
+    ---@diagnostic disable-next-line: assign-type-mismatch
+    self.conceal = details.conceal
+    self.virt_text = details.virt_text
+    if self.virt_text ~= nil then
+        for _, text in ipairs(self.virt_text) do
+            text[2] = MarkDetails.simplify(text[2])
+        end
+    end
+    self.virt_text_pos = details.virt_text_pos
+    self.virt_text_win_col = details.virt_text_win_col
+    self.virt_lines = details.virt_lines
+    if self.virt_lines ~= nil then
+        for _, line in ipairs(self.virt_lines) do
+            for _, text in ipairs(line) do
+                text[2] = MarkDetails.simplify(text[2])
+            end
+        end
+    end
+    self.virt_lines_above = details.virt_lines_above
+    self.sign_text = details.sign_text
+    self.sign_hl_group = details.sign_hl_group
+    if self.sign_hl_group ~= nil then
+        self.sign_hl_group = MarkDetails.simplify(self.sign_hl_group)
+    end
+    if details.priority ~= 4096 then
+        self.priority = details.priority
+    end
+    return self
+end
+
+---@param highlights number|string|string[]
+---@return string
+function MarkDetails.simplify(highlights)
+    if type(highlights) == 'number' then
+        return tostring(highlights)
+    end
+    if type(highlights) == 'string' then
+        highlights = { highlights }
+    end
+    local result = {}
+    for _, highlight in ipairs(highlights) do
+        highlight = string.gsub(highlight, 'RenderMarkdown', 'Rm')
+        table.insert(result, highlight)
+    end
+    return table.concat(result, ':')
+end
+
+---@return integer[]
+function MarkDetails:priorities()
+    local result = {}
+
+    local row_offset = 0
+    if self.virt_lines ~= nil then
+        row_offset = self.virt_lines_above and -0.5 or 0.5
+    end
+    table.insert(result, self.row[1] + row_offset)
+    table.insert(result, (self.row[2] or self.row[1]) + row_offset)
+
+    local col = self.virt_text_win_col or 0
+    table.insert(result, math.max(self.col[1], col))
+    table.insert(result, math.max((self.col[2] or self.col[1]), col))
+
+    -- Inline text comes first
+    table.insert(result, self.virt_text_pos == 'inline' and 0 or 1)
+    -- Signs come later
+    table.insert(result, self.sign_text == nil and 0 or 1)
+
+    -- Fewer text entries comes first
+    local text = #(self.virt_text or {})
+    for _, line in ipairs(self.virt_lines or {}) do
+        text = text + #line
+    end
+    table.insert(result, text)
+
+    return result
+end
+
+---@param a render.md.test.MarkDetails
+---@param b render.md.test.MarkDetails
+---@return boolean
+function MarkDetails.__lt(a, b)
+    local as, bs = a:priorities(), b:priorities()
+    for i = 1, math.max(#as, #bs) do
+        if as[i] ~= bs[i] then
+            return as[i] < bs[i]
+        end
+    end
+    return false
+end
+
+return MarkDetails

tests/helpers/marks.lua

@@ -0,0 +1,28 @@
+---@class render.md.test.Marks
+---@field private marks render.md.test.MarkInfo[]
+local Marks = {}
+Marks.__index = Marks
+
+---@return render.md.test.Marks
+function Marks.new()
+    local self = setmetatable({}, Marks)
+    self.marks = {}
+    return self
+end
+
+---@return render.md.test.MarkInfo[]
+function Marks:get()
+    return self.marks
+end
+
+---@param mark render.md.test.MarkInfo
+function Marks:add(mark)
+    table.insert(self.marks, mark)
+end
+
+---@param marks render.md.test.MarkInfo[]
+function Marks:extend(marks)
+    vim.list_extend(self.marks, marks)
+end
+
+return Marks

tests/helpers/row.lua

@@ -0,0 +1,25 @@
+---@class render.md.test.Row
+---@field private value integer
+local Row = {}
+Row.__index = Row
+
+---@return render.md.test.Row
+function Row.new()
+    local self = setmetatable({}, Row)
+    self.value = 0
+    return self
+end
+
+---@return integer
+function Row:get()
+    return self.value
+end
+
+---@param n? integer
+---@return integer
+function Row:inc(n)
+    self.value = self.value + (n or 1)
+    return self.value
+end
+
+return Row

tests/indent_spec.lua

@@ -5,17 +5,17 @@ local util = require('tests.util')
 ---@param row integer
 ---@param level integer
 ---@param position 'above'|'below'
----@return render.md.MarkInfo
+---@return render.md.test.MarkInfo
 local function border(row, level, position)
-    local background = string.format('RenderMarkdown_bgtofg_RenderMarkdownH%dBg', level)
+    local background = string.format('Rm_bgtofg_RmH%dBg', level)
     local icon = position == 'above' and '▄' or '▀'
     local virtual = row == 0 and position == 'above'
     local line = {}
     if virtual then
         table.insert(line, { '  ', 'Normal' })
     end
     table.insert(line, { icon:rep(vim.o.columns), background })
-    ---@type render.md.MarkInfo
+    ---@type render.md.test.MarkInfo
     return {
         row = { row },
         col = { 0 },
@@ -32,7 +32,7 @@ local function indent_line(lengths)
     local result = {}
     for _, length in ipairs(lengths) do
         if length == 1 then
-            table.insert(result, { '▎', 'RenderMarkdownIndent' })
+            table.insert(result, { '▎', 'RmIndent' })
         else
             table.insert(result, { string.rep(' ', length), 'Normal' })
         end
@@ -42,9 +42,9 @@ end
 
 ---@param row integer
 ---@param lengths integer[]
----@return render.md.MarkInfo
+---@return render.md.test.MarkInfo
 local function indent(row, lengths)
-    ---@type render.md.MarkInfo
+    ---@type render.md.test.MarkInfo
     return {
         row = { row },
         col = { 0 },
@@ -54,9 +54,9 @@ local function indent(row, lengths)
     }
 end
 
----@param mark render.md.MarkInfo
+---@param mark render.md.test.MarkInfo
 ---@param lengths integer[]
----@return render.md.MarkInfo
+---@return render.md.test.MarkInfo
 local function indent_mark(mark, lengths)
     local line = indent_line(lengths)
     vim.list_extend(line, mark.virt_lines[1])

tests/latex_spec.lua

@@ -20,14 +20,14 @@ end
 
 ---@param row integer
 ---@param lines string[]
----@return render.md.MarkInfo
+---@return render.md.test.MarkInfo
 local function latex(row, lines)
     local virt_lines = vim.iter(lines)
         :map(function(line)
-            return { { line, 'RenderMarkdownMath' } }
+            return { { line, 'RmMath' } }
         end)
         :totable()
-    ---@type render.md.MarkInfo
+    ---@type render.md.test.MarkInfo
     return {
         row = { row },
         col = { 0 },

tests/list_table_spec.lua

@@ -2,8 +2,8 @@
 
 local util = require('tests.util')
 
----@param mark render.md.MarkInfo
----@return render.md.MarkInfo[]
+---@param mark render.md.test.MarkInfo
+---@return render.md.test.MarkInfo[]
 local function padded(mark)
     local col = mark.col[2]
     assert(col ~= nil)