refactor: move setup fields into data class

MeanderingProgrammer · MeanderingProgrammer · commit 8fdfc320ce89 · 2024-08-27T16:24:20.000-07:00
diff --git a/lua/render-markdown/core/node_info.lua b/lua/render-markdown/core/node_info.lua
@@ -35,6 +35,7 @@ function NodeInfo.new(buf, node)
 end
 
 ---@param infos render.md.NodeInfo[]
+---@return render.md.NodeInfo[]
 function NodeInfo.sort_inplace(infos)
     table.sort(infos, function(a, b)
         if a.start_row ~= b.start_row then
@@ -43,6 +44,7 @@ function NodeInfo.sort_inplace(infos)
             return a.start_col < b.start_col
         end
     end)
+    return infos
 end
 
 ---@return boolean
diff --git a/lua/render-markdown/render/code.lua b/lua/render-markdown/render/code.lua
@@ -3,16 +3,19 @@ local icons = require('render-markdown.core.icons')
 local str = require('render-markdown.core.str')
 local util = require('render-markdown.render.util')
 
+---@class render.md.data.Code
+---@field col integer
+---@field start_row integer
+---@field end_row integer
+---@field code_info? render.md.NodeInfo
+---@field language_info? render.md.NodeInfo
+---@field language? string
+---@field max_width integer
+---@field empty_rows integer[]
+
 ---@class render.md.render.Code: render.md.Renderer
 ---@field private code render.md.Code
----@field private col integer
----@field private start_row integer
----@field private end_row integer
----@field private code_info? render.md.NodeInfo
----@field private language_info? render.md.NodeInfo
----@field private language? string
----@field private width integer
----@field private empty_rows integer[]
+---@field private data render.md.data.Code
 local Render = {}
 Render.__index = Render
 
@@ -31,44 +34,49 @@ function Render:setup()
     if not self.code.enabled or self.code.style == 'none' then
         return false
     end
-
     -- Do not attempt to render single line code block
-    self.col, self.start_row, self.end_row = self.info.start_col, self.info.start_row, self.info.end_row
-    if self.end_row - self.start_row <= 1 then
+    if self.info.end_row - self.info.start_row <= 1 then
         return false
     end
 
-    self.code_info = self.info:child('info_string')
-    self.language_info = self.code_info ~= nil and self.code_info:child('language') or nil
-    self.language = (self.language_info or {}).text
+    local code_info = self.info:child('info_string')
+    local language_info = code_info ~= nil and code_info:child('language') or nil
 
     -- Account for language padding in first row
     local widths = vim.tbl_map(str.width, self.info:lines())
     widths[1] = widths[1] + self.code.language_pad
-
-    self.width = self.code.left_pad + vim.fn.max(widths) + self.code.right_pad
-    self.width = math.max(self.width, self.code.min_width)
-
-    self.empty_rows = {}
+    local max_width = self.code.left_pad + vim.fn.max(widths) + self.code.right_pad
+    local empty_rows = {}
     for row, width in ipairs(widths) do
         if width == 0 then
-            table.insert(self.empty_rows, self.start_row + row - 1)
+            table.insert(empty_rows, self.info.start_row + row - 1)
         end
     end
 
+    self.data = {
+        col = self.info.start_col,
+        start_row = self.info.start_row,
+        end_row = self.info.end_row,
+        code_info = code_info,
+        language_info = language_info,
+        language = (language_info or {}).text,
+        max_width = math.max(max_width, self.code.min_width),
+        empty_rows = empty_rows,
+    }
+
     return true
 end
 
 function Render:render()
-    local disabled_language = vim.tbl_contains(self.code.disable_background, self.language)
+    local disabled_language = vim.tbl_contains(self.code.disable_background, self.data.language)
     local add_background = vim.tbl_contains({ 'normal', 'full' }, self.code.style) and not disabled_language
 
     local icon_added = self:language_hint(add_background)
     if add_background then
         self:background(icon_added)
     end
     if icon_added then
-        self.start_row = self.start_row + 1
+        self.data.start_row = self.data.start_row + 1
     end
     self:left_pad(add_background)
 end
@@ -80,7 +88,7 @@ function Render:language_hint(add_background)
     if not vim.tbl_contains({ 'language', 'full' }, self.code.style) then
         return false
     end
-    local info = self.language_info
+    local info = self.data.language_info
     if info == nil then
         return false
     end
@@ -109,7 +117,7 @@ function Render:language_hint(add_background)
         })
     elseif self.code.position == 'right' then
         local icon_text = icon .. ' ' .. info.text
-        local win_col = self.width - self.code.language_pad
+        local win_col = self.data.max_width - self.code.language_pad
         if self.code.width == 'block' then
             win_col = win_col - str.width(icon_text)
         end
@@ -125,36 +133,36 @@ end
 ---@private
 ---@param icon_added boolean
 function Render:background(icon_added)
-    local width = self.code.width == 'block' and self.width or self.context:get_width()
+    local width = self.code.width == 'block' and self.data.max_width or self.context:get_width()
 
     if self.code.border == 'thin' then
-        local border_width = width - self.col
-        if not icon_added and self.context:hidden(self.code_info) and self:delim_hidden(self.start_row) then
-            self.marks:add(true, self.start_row, self.col, {
+        local border_width = width - self.data.col
+        if not icon_added and self.context:hidden(self.data.code_info) and self:delim_hidden(self.data.start_row) then
+            self.marks:add(true, self.data.start_row, self.data.col, {
                 virt_text = { { self.code.above:rep(border_width), colors.inverse(self.code.highlight) } },
                 virt_text_pos = 'overlay',
             })
-            self.start_row = self.start_row + 1
+            self.data.start_row = self.data.start_row + 1
         end
-        if self:delim_hidden(self.end_row - 1) then
-            self.marks:add(true, self.end_row - 1, self.col, {
+        if self:delim_hidden(self.data.end_row - 1) then
+            self.marks:add(true, self.data.end_row - 1, self.data.col, {
                 virt_text = { { self.code.below:rep(border_width), colors.inverse(self.code.highlight) } },
                 virt_text_pos = 'overlay',
             })
-            self.end_row = self.end_row - 1
+            self.data.end_row = self.data.end_row - 1
         end
     end
 
     local padding = str.spaces(vim.o.columns * 2)
-    for row = self.start_row, self.end_row - 1 do
-        self.marks:add(false, row, self.col, {
+    for row = self.data.start_row, self.data.end_row - 1 do
+        self.marks:add(false, row, self.data.col, {
             end_row = row + 1,
             hl_group = self.code.highlight,
             hl_eol = true,
         })
         if self.code.width == 'block' then
             -- Overwrite anything beyond width with Normal
-            self.marks:add(false, row, self.col, {
+            self.marks:add(false, row, self.data.col, {
                 priority = 0,
                 virt_text = { { padding, 'Normal' } },
                 virt_text_win_col = width,
@@ -173,25 +181,25 @@ end
 ---@private
 ---@param add_background boolean
 function Render:left_pad(add_background)
-    if (self.col == 0 or #self.empty_rows == 0) and self.code.left_pad <= 0 then
+    if (self.data.col == 0 or #self.data.empty_rows == 0) and self.code.left_pad <= 0 then
         return
     end
 
     -- Use low priority to include other marks in padding when code block is at edge
-    local priority = self.col == 0 and 0 or nil
-    local outer_text = { str.spaces(self.col), 'Normal' }
+    local priority = self.data.col == 0 and 0 or nil
+    local outer_text = { str.spaces(self.data.col), 'Normal' }
     local left_text = { str.spaces(self.code.left_pad), add_background and self.code.highlight or 'Normal' }
 
-    for row = self.start_row, self.end_row - 1 do
+    for row = self.data.start_row, self.data.end_row - 1 do
         local virt_text = {}
-        if self.col > 0 and vim.tbl_contains(self.empty_rows, row) then
+        if self.data.col > 0 and vim.tbl_contains(self.data.empty_rows, row) then
             table.insert(virt_text, outer_text)
         end
         if self.code.left_pad > 0 then
             table.insert(virt_text, left_text)
         end
         if #virt_text > 0 then
-            self.marks:add(false, row, self.col, {
+            self.marks:add(false, row, self.data.col, {
                 priority = priority,
                 virt_text = virt_text,
                 virt_text_pos = 'inline',
diff --git a/lua/render-markdown/render/heading.lua b/lua/render-markdown/render/heading.lua
@@ -3,14 +3,17 @@ local list = require('render-markdown.core.list')
 local str = require('render-markdown.core.str')
 local util = require('render-markdown.render.util')
 
+---@class render.md.data.Heading
+---@field level integer
+---@field icon? string
+---@field sign? string
+---@field foreground string
+---@field background string
+---@field heading_width render.md.heading.Width
+
 ---@class render.md.render.Heading: render.md.Renderer
 ---@field private heading render.md.Heading
----@field private level integer
----@field private icon? string
----@field private sign? string
----@field private foreground string
----@field private background string
----@field private heading_width render.md.heading.Width
+---@field private data render.md.data.Heading
 local Render = {}
 Render.__index = Render
 
@@ -30,36 +33,38 @@ function Render:setup()
         return false
     end
 
-    self.level = str.width(self.info.text)
-    self.icon = list.cycle(self.heading.icons, self.level)
-    self.sign = list.cycle(self.heading.signs, self.level)
-    self.foreground = list.clamp(self.heading.foregrounds, self.level)
-    self.background = list.clamp(self.heading.backgrounds, self.level)
-
+    local level = str.width(self.info.text)
     local heading_width = self.heading.width
     if type(heading_width) == 'table' then
-        heading_width = list.clamp(heading_width, self.level)
+        heading_width = list.clamp(heading_width, level)
     end
-    self.heading_width = heading_width
+    self.data = {
+        level = level,
+        icon = list.cycle(self.heading.icons, level),
+        sign = list.cycle(self.heading.signs, level),
+        foreground = list.clamp(self.heading.foregrounds, level),
+        background = list.clamp(self.heading.backgrounds, level),
+        heading_width = heading_width,
+    }
 
     return true
 end
 
 function Render:render()
     local icon_width = self:start_icon()
     if self.heading.sign then
-        util.sign(self.config, self.marks, self.info, self.sign, self.foreground)
+        util.sign(self.config, self.marks, self.info, self.data.sign, self.data.foreground)
     end
 
     self.marks:add(true, self.info.start_row, 0, {
         end_row = self.info.end_row + 1,
         end_col = 0,
-        hl_group = self.background,
+        hl_group = self.data.background,
         hl_eol = true,
     })
 
     local width = self:width(icon_width)
-    if self.heading_width == 'block' then
+    if self.data.heading_width == 'block' then
         -- Overwrite anything beyond width with Normal
         self.marks:add(true, self.info.start_row, 0, {
             priority = 0,
@@ -75,7 +80,7 @@ function Render:render()
     if self.heading.left_pad > 0 then
         self.marks:add(false, self.info.start_row, 0, {
             priority = 0,
-            virt_text = { { str.spaces(self.heading.left_pad), self.background } },
+            virt_text = { { str.spaces(self.heading.left_pad), self.data.background } },
             virt_text_pos = 'inline',
         })
     end
@@ -87,26 +92,26 @@ function Render:start_icon()
     -- Available width is level + 1 - concealed, where level = number of `#` characters, one
     -- is added to account for the space after the last `#` but before the heading title,
     -- and concealed text is subtracted since that space is not usable
-    local width = self.level + 1 - self.context:concealed(self.info)
-    if self.icon == nil then
+    local width = self.data.level + 1 - self.context:concealed(self.info)
+    if self.data.icon == nil then
         return width
     end
 
-    local padding = width - str.width(self.icon)
+    local padding = width - str.width(self.data.icon)
     if self.heading.position == 'inline' or padding < 0 then
         self.marks:add(true, self.info.start_row, self.info.start_col, {
             end_row = self.info.end_row,
             end_col = self.info.end_col,
-            virt_text = { { self.icon, { self.foreground, self.background } } },
+            virt_text = { { self.data.icon, { self.data.foreground, self.data.background } } },
             virt_text_pos = 'inline',
             conceal = '',
         })
-        return str.width(self.icon)
+        return str.width(self.data.icon)
     else
         self.marks:add(true, self.info.start_row, self.info.start_col, {
             end_row = self.info.end_row,
             end_col = self.info.end_col,
-            virt_text = { { str.pad(padding, self.icon), { self.foreground, self.background } } },
+            virt_text = { { str.pad(padding, self.data.icon), { self.data.foreground, self.data.background } } },
             virt_text_pos = 'overlay',
         })
         return width
@@ -117,7 +122,7 @@ end
 ---@param icon_width integer
 ---@return integer
 function Render:width(icon_width)
-    if self.heading_width == 'block' then
+    if self.data.heading_width == 'block' then
         local width = self.heading.left_pad + icon_width + self.heading.right_pad
         local content = self.info:sibling('inline')
         if content ~= nil then
@@ -132,12 +137,12 @@ end
 ---@private
 ---@param width integer
 function Render:border(width)
-    local background = colors.inverse(self.background)
-    local prefix = self.heading.border_prefix and self.level or 0
+    local background = colors.inverse(self.data.background)
+    local prefix = self.heading.border_prefix and self.data.level or 0
 
     local line_above = {
         { self.heading.above:rep(self.heading.left_pad), background },
-        { self.heading.above:rep(prefix), self.foreground },
+        { self.heading.above:rep(prefix), self.data.foreground },
         { self.heading.above:rep(width - self.heading.left_pad - prefix), background },
     }
     if str.width(self.info:line('above')) == 0 and self.info.start_row - 1 ~= self.context.last_heading then
@@ -154,7 +159,7 @@ function Render:border(width)
 
     local line_below = {
         { self.heading.below:rep(self.heading.left_pad), background },
-        { self.heading.below:rep(prefix), self.foreground },
+        { self.heading.below:rep(prefix), self.data.foreground },
         { self.heading.below:rep(width - self.heading.left_pad - prefix), background },
     }
     if str.width(self.info:line('below')) == 0 then
diff --git a/lua/render-markdown/render/quote.lua b/lua/render-markdown/render/quote.lua
@@ -4,6 +4,7 @@ local state = require('render-markdown.state')
 
 ---@class render.md.render.Quote: render.md.Renderer
 ---@field private quote render.md.Quote
+---@field private highlight string
 local Render = {}
 Render.__index = Render
 
@@ -23,6 +24,9 @@ function Render:setup()
         return false
     end
 
+    local callout = component.callout(self.config, self.info.text, 'contains')
+    self.highlight = callout ~= nil and callout.highlight or self.quote.highlight
+
     return true
 end
 
@@ -39,12 +43,10 @@ end
 ---@private
 ---@param info render.md.NodeInfo
 function Render:quote_marker(info)
-    local callout = component.callout(self.config, self.info.text, 'contains')
-    local highlight = callout ~= nil and callout.highlight or self.quote.highlight
     self.marks:add(true, info.start_row, info.start_col, {
         end_row = info.end_row,
         end_col = info.end_col,
-        virt_text = { { info.text:gsub('>', self.quote.icon), highlight } },
+        virt_text = { { info.text:gsub('>', self.quote.icon), self.highlight } },
         virt_text_pos = 'overlay',
         virt_text_repeat_linebreak = self.quote.repeat_linebreak or nil,
     })
diff --git a/lua/render-markdown/render/table.lua b/lua/render-markdown/render/table.lua
