From 8e55f7ca68657fb273f87efe7b1562fb9cbde2dc Mon Sep 17 00:00:00 2001
From: Riley Bruins <ribru17@hotmail.com>
Date: Fri, 30 Aug 2024 19:27:18 -0700
Subject: [PATCH] test(treesitter): add a simple testutil file

The util file, for now, just abstracts the common `run_query` function.
---
 test/functional/treesitter/parser_spec.lua | 59 ++++------------------
 test/functional/treesitter/testutil.lua    | 25 +++++++++
 2 files changed, 36 insertions(+), 48 deletions(-)
 create mode 100644 test/functional/treesitter/testutil.lua

diff --git a/test/functional/treesitter/parser_spec.lua b/test/functional/treesitter/parser_spec.lua
index e0e0b543e4..f8cb1013e6 100644
--- a/test/functional/treesitter/parser_spec.lua
+++ b/test/functional/treesitter/parser_spec.lua
@@ -1,5 +1,6 @@
 local t = require('test.testutil')
 local n = require('test.functional.testnvim')()
+local ts_t = require('test.functional.treesitter.testutil')
 
 local clear = n.clear
 local dedent = t.dedent
@@ -8,6 +9,7 @@ local insert = n.insert
 local exec_lua = n.exec_lua
 local pcall_err = t.pcall_err
 local feed = n.feed
+local run_query = ts_t.run_query
 
 describe('treesitter parser API', function()
   before_each(function()
@@ -686,26 +688,13 @@ print()
         vim.treesitter.start(0, 'lua')
       end)
 
-      local function run_query()
-        return exec_lua(function(query_str)
-          local query = vim.treesitter.query.parse('lua', query_str)
-          local parser = vim.treesitter.get_parser()
-          local tree = parser:parse()[1]
-          local res = {}
-          for id, _, metadata in query:iter_captures(tree:root(), 0) do
-            table.insert(res, { query.captures[id], metadata[id].range })
-          end
-          return res
-        end, query_text)
-      end
-
       eq({
         { 'str', { 2, 12, 6, 10 } },
         { 'str', { 11, 10, 11, 10 } },
         { 'str', { 17, 10, 17, 10 } },
         { 'str', { 19, 10, 19, 10 } },
         { 'str', { 22, 15, 22, 25 } },
-      }, run_query())
+      }, run_query('lua', query_text))
     end)
 
     it('trims only empty lines by default (backwards compatible)', function()
@@ -728,23 +717,10 @@ print()
         vim.treesitter.start(0, 'markdown')
       end)
 
-      local function run_query()
-        return exec_lua(function(query_str)
-          local query = vim.treesitter.query.parse('markdown', query_str)
-          local parser = vim.treesitter.get_parser()
-          local tree = parser:parse()[1]
-          local res = {}
-          for id, _, metadata in query:iter_captures(tree:root(), 0) do
-            table.insert(res, { query.captures[id], metadata[id].range })
-          end
-          return res
-        end, query_text)
-      end
-
       eq({
         { 'fold', { 0, 0, 3, 0 } },
         { 'fold', { 4, 0, 7, 0 } },
-      }, run_query())
+      }, run_query('markdown', query_text))
     end)
   end)
 
@@ -763,32 +739,19 @@ print()
       vim.treesitter.start(0, 'c')
     end)
 
-    local function run_query()
-      return exec_lua(function(query_str)
-        local query = vim.treesitter.query.parse('c', query_str)
-        local parser = vim.treesitter.get_parser()
-        local tree = parser:parse()[1]
-        local res = {}
-        for id, node in query:iter_captures(tree:root()) do
-          table.insert(res, { query.captures[id], node:range() })
-        end
-        return res
-      end, query0)
-    end
-
     eq({
-      { 'function', 0, 0, 2, 1 },
-      { 'declaration', 1, 2, 1, 12 },
-    }, run_query())
+      { 'function', { 0, 0, 2, 1 } },
+      { 'declaration', { 1, 2, 1, 12 } },
+    }, run_query('c', query0))
 
     n.command 'normal ggO'
     insert('int a;')
 
     eq({
-      { 'declaration', 0, 0, 0, 6 },
-      { 'function', 1, 0, 3, 1 },
-      { 'declaration', 2, 2, 2, 12 },
-    }, run_query())
+      { 'declaration', { 0, 0, 0, 6 } },
+      { 'function', { 1, 0, 3, 1 } },
+      { 'declaration', { 2, 2, 2, 12 } },
+    }, run_query('c', query0))
   end)
 
   it('handles ranges when source is a multiline string (#20419)', function()
diff --git a/test/functional/treesitter/testutil.lua b/test/functional/treesitter/testutil.lua
new file mode 100644
index 0000000000..f8934f06c3
--- /dev/null
+++ b/test/functional/treesitter/testutil.lua
@@ -0,0 +1,25 @@
+local n = require('test.functional.testnvim')()
+
+local exec_lua = n.exec_lua
+
+local M = {}
+
+---@param language string
+---@param query_string string
+function M.run_query(language, query_string)
+  return exec_lua(function(lang, query_str)
+    local query = vim.treesitter.query.parse(lang, query_str)
+    local parser = vim.treesitter.get_parser()
+    local tree = parser:parse()[1]
+    local res = {}
+    for id, node, metadata in query:iter_captures(tree:root(), 0) do
+      table.insert(
+        res,
+        { query.captures[id], metadata[id] and metadata[id].range or { node:range() } }
+      )
+    end
+    return res
+  end, language, query_string)
+end
+
+return M