Refactor UI components and layout APIs

Author: julienvincent

lua/clojure-test/api/exceptions.lua

@@ -1,8 +1,10 @@
-local ui_exceptions = require("clojure-test.ui.exceptions")
+local components = require("clojure-test.ui.components")
 local config = require("clojure-test.config")
 local utils = require("clojure-test.utils")
 local nio = require("nio")
 
+local NuiPopup = require("nui.popup")
+
 local M = {}
 
 function M.go_to_exception(target_window, exception)
@@ -47,6 +49,34 @@ function M.go_to_exception(target_window, exception)
   end
 end
 
+local function open_exception_popup()
+  local popup = NuiPopup({
+    border = {
+      style = "rounded",
+      text = {
+        top = " Exception ",
+      },
+    },
+    position = "50%",
+    relative = "editor",
+    enter = true,
+    size = {
+      width = 120,
+      height = 30,
+    },
+  })
+
+  for _, chord in ipairs(utils.into_table(config.keys.ui.quit)) do
+    popup:map("n", chord, function()
+      popup:unmount()
+    end, { noremap = true })
+  end
+
+  popup:mount()
+
+  return popup
+end
+
 function M.render_exception(sym)
   local exceptions = config.backend:analyze_exception(sym)
   if not exceptions or exceptions == vim.NIL then
@@ -55,8 +85,8 @@ function M.render_exception(sym)
 
   local last_active_window = vim.api.nvim_get_current_win()
 
-  local popup = ui_exceptions.open_exception_popup()
-  ui_exceptions.render_exceptions_to_buf(popup.bufnr, exceptions)
+  local popup = open_exception_popup()
+  components.exception.render_exceptions_to_buf(popup.bufnr, exceptions)
 
   local event = require("nui.utils.autocmd").event
   popup:on({ event.WinLeave }, function()

lua/clojure-test/api/run.lua

@@ -1,5 +1,5 @@
 local exceptions_api = require("clojure-test.api.exceptions")
-local interface_api = require("clojure-test.ui")
+local layouts = require("clojure-test.ui.layouts")
 local config = require("clojure-test.config")
 local nio = require("nio")
 
@@ -43,25 +43,24 @@ local function handle_go_to_event(target_window, event)
   end)
 end
 
-local M = {}
-
-local active_ui = nil
+local M = {
+  active_ui = nil,
+}
 
 function M.open_reports(reports)
   local last_active_window = vim.api.nvim_get_current_win()
 
-  local ui = active_ui
+  local ui = M.active_ui
   if not ui then
-    ui = interface_api.create(function(event)
+    ui = layouts.create_layout(function(event)
       if event.type == "go-to" then
         return handle_go_to_event(last_active_window, event)
       end
     end)
-    active_ui = ui
+    M.active_ui = ui
   end
 
   ui:mount()
-
   ui:render_reports(reports)
 end
 
@@ -75,19 +74,19 @@ function M.run_tests(tests)
     unmounted = false,
   }
 
-  local ui = active_ui
+  local ui = M.active_ui
   if not ui then
-    ui = interface_api.create(function(event)
+    ui = layouts.create_layout(function(event)
       if event.type == "go-to" then
         return handle_go_to_event(state.last_active_window, event)
       end
       if event.type == "unmount" then
         state.unmounted = true
-        active_ui = nil
+        M.active_ui = nil
         return
       end
     end)
-    active_ui = ui
+    M.active_ui = ui
   end
 
   ui:mount()

lua/clojure-test/ui/components/clojure.lua

@@ -0,0 +1,15 @@
+local M = {}
+
+function M.write_clojure_to_buf(buf, contents)
+  vim.api.nvim_set_option_value("filetype", "clojure", {
+    buf = buf,
+  })
+
+  local lines = {}
+  if contents then
+    lines = vim.split(contents, "\n")
+  end
+  vim.api.nvim_buf_set_lines(buf, 0, -1, false, lines)
+end
+
+return M

lua/clojure-test/ui/exceptions.lua renamed to lua/clojure-test/ui/components/exception.lua

@@ -1,7 +1,5 @@
-local config = require("clojure-test.config")
 local utils = require("clojure-test.utils")
 
-local NuiPopup = require("nui.popup")
 local NuiLine = require("nui.line")
 local NuiText = require("nui.text")
 
@@ -67,32 +65,4 @@ function M.render_exceptions_to_buf(buf, exception_chain)
   end
 end
 
-function M.open_exception_popup()
-  local popup = NuiPopup({
-    border = {
-      style = "rounded",
-      text = {
-        top = " Exception ",
-      },
-    },
-    position = "50%",
-    relative = "editor",
-    enter = true,
-    size = {
-      width = 120,
-      height = 30,
-    },
-  })
-
-  for _, chord in ipairs(utils.into_table(config.keys.ui.quit)) do
-    popup:map("n", chord, function()
-      popup:unmount()
-    end, { noremap = true })
-  end
-
-  popup:mount()
-
-  return popup
-end
-
 return M

lua/clojure-test/ui/components/init.lua

@@ -0,0 +1,5 @@
+return {
+  exception = require("clojure-test.ui.components.exception"),
+  tree = require("clojure-test.ui.components.tree"),
+  clojure = require("clojure-test.ui.components.clojure"),
+}

lua/clojure-test/ui/report-tree.lua renamed to lua/clojure-test/ui/components/tree.lua

@@ -150,11 +150,10 @@ end
 
 local M = {}
 
-function M.create(window, on_event)
+function M.create(buf, on_event)
   local tree = NuiTree({
-    winid = window.winid,
-    bufnr = vim.api.nvim_win_get_buf(window.winid),
-    ns_id = "testns",
+    bufnr = buf,
+    ns_id = "clojure-test-report-tree",
     nodes = {},
     prepare_node = function(node)
       local line = NuiLine()
@@ -183,10 +182,14 @@ function M.create(window, on_event)
     tree = tree,
   }
 
-  local map_options = { noremap = true, nowait = true }
+  local map_options = {
+    noremap = true,
+    nowait = true,
+    buffer = buf,
+  }
 
   for _, chord in ipairs(utils.into_table(config.keys.ui.collapse_node)) do
-    window:map("n", chord, function()
+    vim.keymap.set("n", chord, function()
       local node = tree:get_node()
       if not node then
         return
@@ -206,7 +209,7 @@ function M.create(window, on_event)
   end
 
   for _, chord in ipairs(utils.into_table(config.keys.ui.expand_node)) do
-    window:map("n", chord, function()
+    vim.keymap.set("n", chord, function()
       local node = tree:get_node()
       if node and node:expand() then
         tree:render()
@@ -215,7 +218,7 @@ function M.create(window, on_event)
   end
 
   for _, chord in ipairs(utils.into_table(config.keys.ui.go_to)) do
-    window:map("n", chord, function()
+    vim.keymap.set("n", chord, function()
       local node = tree:get_node()
       if not node then
         return
@@ -228,18 +231,21 @@ function M.create(window, on_event)
     end, map_options)
   end
 
-  local event = require("nui.utils.autocmd").event
-  window:on({ event.CursorMoved }, function()
-    local node = tree:get_node()
-    if not node then
-      return
-    end
+  vim.api.nvim_create_autocmd("CursorMoved", {
+    desc = "Track cursor in report-tree",
+    buffer = buf,
+    callback = function()
+      local node = tree:get_node()
+      if not node then
+        return
+      end
 
-    on_event({
-      type = "hover",
-      node = node,
-    })
-  end, {})
+      on_event({
+        type = "hover",
+        node = node,
+      })
+    end,
+  })
 
   function ReportTree:render_reports(reports)
     tree:set_nodes(reports_to_nodes(reports, tree:get_nodes()))