refactor: create a renderer parent class, initialize renderers in handler constructor

Author: MeanderingProgrammer

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*          For 0.10.0          Last change: 2024 August 23
+*render-markdown.txt*          For 0.10.0          Last change: 2024 August 24
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/handler/markdown.lua

@@ -2,6 +2,7 @@ local Context = require('render-markdown.context')
 local NodeInfo = require('render-markdown.node_info')
 local RenderCode = require('render-markdown.render.code')
 local RenderHeading = require('render-markdown.render.heading')
+local RenderQuote = require('render-markdown.render.quote')
 local RenderTable = require('render-markdown.render.table')
 local component = require('render-markdown.component')
 local list = require('render-markdown.list')
@@ -14,6 +15,7 @@ local str = require('render-markdown.str')
 ---@field private marks render.md.Marks
 ---@field private config render.md.BufferConfig
 ---@field private context render.md.Context
+---@field private renderers table<string, render.md.Renderer>
 local Handler = {}
 Handler.__index = Handler
 
@@ -25,6 +27,12 @@ function Handler.new(buf)
     self.marks = list.new_marks()
     self.config = state.get_config(buf)
     self.context = Context.get(buf)
+    self.renderers = {
+        code = RenderCode.new(buf, self.marks, self.config, self.context),
+        heading = RenderHeading.new(buf, self.marks, self.config, self.context),
+        quote = RenderQuote.new(buf, self.marks, self.config, self.context),
+        table = RenderTable.new(buf, self.marks, self.config, self.context),
+    }
     return self
 end
 
@@ -34,32 +42,20 @@ function Handler:parse(root)
     self.context:query(root, state.markdown_query, function(capture, node)
         local info = NodeInfo.new(self.buf, node)
         logger.debug_node_info(capture, info)
-        if capture == 'section' then
+
+        local renderer = self.renderers[capture]
+        if renderer ~= nil then
+            renderer:render(info)
+        elseif capture == 'section' then
             self:section(info)
-        elseif capture == 'heading' then
-            RenderHeading.new(self.buf, self.marks, self.config, self.context):render(info)
         elseif capture == 'dash' then
             self:dash(info)
-        elseif capture == 'code' then
-            RenderCode.new(self.buf, self.marks, self.config, self.context):render(info)
         elseif capture == 'list_marker' then
             self:list_marker(info)
         elseif capture == 'checkbox_unchecked' then
             self:checkbox(info, self.config.checkbox.unchecked)
         elseif capture == 'checkbox_checked' then
             self:checkbox(info, self.config.checkbox.checked)
-        elseif capture == 'quote' then
-            self.context:query(node, state.markdown_quote_query, function(nested_capture, nested_node)
-                local nested_info = NodeInfo.new(self.buf, nested_node)
-                logger.debug_node_info(nested_capture, nested_info)
-                if nested_capture == 'quote_marker' then
-                    self:quote_marker(nested_info, info)
-                else
-                    logger.unhandled_capture('markdown quote', nested_capture)
-                end
-            end)
-        elseif capture == 'table' then
-            RenderTable.new(self.buf, self.marks, self.config, self.context):render(info)
         else
             logger.unhandled_capture('markdown', capture)
         end
@@ -187,25 +183,6 @@ function Handler:checkbox(info, checkbox)
     })
 end
 
----@private
----@param info render.md.NodeInfo
----@param block_quote render.md.NodeInfo
-function Handler:quote_marker(info, block_quote)
-    local quote = self.config.quote
-    if not quote.enabled then
-        return
-    end
-    local callout = component.callout(self.buf, block_quote.text, 'contains')
-    local highlight = callout ~= nil and callout.highlight or 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('>', quote.icon), highlight } },
-        virt_text_pos = 'overlay',
-        virt_text_repeat_linebreak = quote.repeat_linebreak or nil,
-    })
-end
-
 ---@class render.md.handler.Markdown: render.md.Handler
 local M = {}
 

lua/render-markdown/handler/markdown_inline.lua

@@ -31,6 +31,7 @@ function Handler:parse(root)
     self.context:query(root, state.inline_query, function(capture, node)
         local info = NodeInfo.new(self.buf, node)
         logger.debug_node_info(capture, info)
+
         if capture == 'code' then
             self:code(info)
         elseif capture == 'shortcut' then

lua/render-markdown/node_info.lua

@@ -7,7 +7,7 @@ end
 
 ---@class render.md.NodeInfo
 ---@field private buf integer
----@field private node TSNode
+---@field node TSNode
 ---@field type string
 ---@field text string
 ---@field start_row integer

lua/render-markdown/render/code.lua

@@ -85,11 +85,8 @@ function Parser.get_width(config, context, widths)
     end
 end
 
----@class render.md.render.Code
----@field private buf integer
----@field private marks render.md.Marks
+---@class render.md.render.Code: render.md.Renderer
 ---@field private config render.md.Code
----@field private context render.md.Context
 local Render = {}
 Render.__index = Render
 

lua/render-markdown/render/heading.lua

@@ -3,11 +3,8 @@ local list = require('render-markdown.list')
 local str = require('render-markdown.str')
 local util = require('render-markdown.render.util')
 
----@class render.md.render.Heading
----@field private buf integer
----@field private marks render.md.Marks
+---@class render.md.render.Heading: render.md.Renderer
 ---@field private config render.md.Heading
----@field private context render.md.Context
 local Render = {}
 Render.__index = Render
 

lua/render-markdown/render/quote.lua

@@ -0,0 +1,57 @@
+local NodeInfo = require('render-markdown.node_info')
+local component = require('render-markdown.component')
+local logger = require('render-markdown.logger')
+local state = require('render-markdown.state')
+
+---@class render.md.render.Quote: render.md.Renderer
+---@field private config render.md.Quote
+local Render = {}
+Render.__index = Render
+
+---@param buf integer
+---@param marks render.md.Marks
+---@param config render.md.BufferConfig
+---@param context render.md.Context
+---@return render.md.render.Quote
+function Render.new(buf, marks, config, context)
+    local self = setmetatable({}, Render)
+    self.buf = buf
+    self.marks = marks
+    self.config = config.quote
+    self.context = context
+    return self
+end
+
+---@param info render.md.NodeInfo
+function Render:render(info)
+    self.context:query(info.node, state.markdown_quote_query, function(capture, node)
+        local nested_info = NodeInfo.new(self.buf, node)
+        logger.debug_node_info(capture, nested_info)
+
+        if capture == 'quote_marker' then
+            self:quote_marker(nested_info, info)
+        else
+            logger.unhandled_capture('markdown quote', capture)
+        end
+    end)
+end
+
+---@private
+---@param info render.md.NodeInfo
+---@param block_quote render.md.NodeInfo
+function Render:quote_marker(info, block_quote)
+    if not self.config.enabled then
+        return
+    end
+    local callout = component.callout(self.buf, block_quote.text, 'contains')
+    local highlight = callout ~= nil and callout.highlight or self.config.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.config.icon), highlight } },
+        virt_text_pos = 'overlay',
+        virt_text_repeat_linebreak = self.config.repeat_linebreak or nil,
+    })
+end
+
+return Render

lua/render-markdown/render/table.lua

@@ -176,11 +176,8 @@ function Parser.row_data(info, cell_type)
     return { pipes = pipes, cells = cells }
 end
 
----@class render.md.render.Table
----@field private buf integer
----@field private marks render.md.Marks
+---@class render.md.render.Table: render.md.Renderer
 ---@field private config render.md.PipeTable
----@field private context render.md.Context
 local Render = {}
 Render.__index = Render
 

lua/render-markdown/render/util.lua

@@ -2,6 +2,12 @@ local colors = require('render-markdown.colors')
 local state = require('render-markdown.state')
 local str = require('render-markdown.str')
 
+---@class render.md.Renderer
+---@field protected buf integer
+---@field protected marks render.md.Marks
+---@field protected context render.md.Context
+---@field render fun(self: render.md.Renderer, info: render.md.NodeInfo)
+
 ---@class render.md.render.Util
 local M = {}