feat(config): ensure all options are working

Author: boltlessengineer

Makefile

@@ -16,5 +16,5 @@ docgen:
 	lemmy-help lua/rest-nvim/config/init.lua > doc/rest-nvim-config.txt
 	lemmy-help lua/rest-nvim/cookie_jar.lua > doc/rest-nvim-cookies.txt
 	lemmy-help lua/rest-nvim/script.lua > doc/rest-nvim-script.txt
-	lemmy-help lua/rest-nvim/api.lua lua/rest-nvim/utils.lua > doc/rest-nvim-api.txt
+	lemmy-help lua/rest-nvim/api.lua lua/rest-nvim/ui/result.lua lua/rest-nvim/utils.lua > doc/rest-nvim-api.txt
 	lemmy-help lua/rest-nvim/client/curl/cli.lua lua/rest-nvim/client/curl/utils.lua > doc/rest-nvim-client-curl.txt

README.md

@@ -44,7 +44,7 @@ CLI. For more information on this, please see this [blog post](https://amartin.c
 
 > [!NOTE]
 >
-> rest.nvim requires Neovim >= 0.9.2 to work.
+> rest.nvim requires Neovim >= 0.10.1 to work.
 
 ### Dependencies
 

lua/rest-nvim/client/curl/cli.lua

@@ -75,7 +75,7 @@ end
 function parser.parse_verbose_line(line)
   local prefix, str = line:match("(.) ?(.*)")
   if not prefix then
-    -- TODO: parse failed
+    log.error("Error while parsing verbose curl output:\n" .. line)
     return
   end
   return {

lua/rest-nvim/context.lua

@@ -30,10 +30,10 @@ local rest_variables = {
     return os.date("%Y-%m-%d") --[[@as string]]
   end,
   ["$timestamp"] = function()
-    return string(os.time()) or ""
+    return tostring(os.time()) or ""
   end,
   ["$randomInt"] = function()
-    return string(math.random(0, 1000))
+    return tostring(math.random(0, 1000))
   end,
 }
 

lua/rest-nvim/dotenv.lua

@@ -32,7 +32,15 @@ end
 ---@param path string file path of dotenv file
 ---@param bufnr number? buffer identifier, default to current buffer
 function M.register_file(path, bufnr)
-  -- TODO: validate file extension
+  vim.validate({
+    path = {
+      path,
+      function (p)
+        return vim.endswith(p, ".env") or vim.endswith(p, ".json")
+      end,
+      "`.env` or `.json` filetype"
+    }
+  })
   bufnr = bufnr or 0
   vim.b[bufnr]._rest_nvim_env_file = path
   vim.notify("[rest.nvim] Env file '" .. path .. "' has been registered")

lua/rest-nvim/parser/init.lua

@@ -115,7 +115,6 @@ function parser.parse_body(body_node, source, context)
     end
   elseif body.__TYPE == "external" then
     local path = assert(get_node_field_text(body_node, "path", source))
-    -- TODO: make sure expand happens in `.http` file
     path = vim.fs.normalize(vim.fs.joinpath(vim.fn.expand("%:h"), path))
     body.data = {
       name = get_node_field_text(body_node, "name", source),

lua/rest-nvim/request.lua

@@ -52,16 +52,16 @@ local function run_request(req)
     ---@cast res rest.Response
     logger.info("request success")
 
-    -- run request handler scripts
-    vim.iter(req.handlers):each(function (f) f(res) end)
-    logger.info("handler done")
-
-    -- update cookie jar
-    jar.update_jar(req.url, res)
-
     -- NOTE: wrap with schedule to do vim stuffs outside of lua callback loop (`on_exit`
     -- callback from `vim.system()` call)
     vim.schedule(function ()
+      -- run request handler scripts
+      vim.iter(req.handlers):each(function (f) f(res) end)
+      logger.info("handler done")
+
+      -- update cookie jar
+      jar.update_jar(req.url, res)
+
       _G.rest_request = req
       _G.rest_response = res
       vim.api.nvim_exec_autocmds("User", {
@@ -87,7 +87,7 @@ function M.run()
     return
   end
   local ctx = parser.create_context(0)
-  if vim.b._rest_nvim_env_file then
+  if config.env.enable and vim.b._rest_nvim_env_file then
     ctx:load_file(vim.b._rest_nvim_env_file)
   end
   local req = parser.parse(req_node, 0, ctx)
@@ -112,7 +112,7 @@ function M.run_by_name(name)
     return
   end
   local ctx = parser.create_context(0)
-  if vim.b._rest_nvim_env_file then
+  if config.env.enable and vim.b._rest_nvim_env_file then
     ctx:load_file(vim.b._rest_nvim_env_file)
   end
   local req = parser.parse(req_node, 0, ctx)

lua/rest-nvim/ui/result.lua

@@ -59,9 +59,15 @@ local panes = {
       if data.response then
         table.insert(lines, ("%d %s %s"):format(data.response.status.code, data.response.status.version, data.response.status.text))
         local content_type = data.response.headers["content-type"]
-        local body = res.try_format_body(content_type and content_type[1], data.response.body)
         table.insert(lines, "")
         table.insert(lines, "#+RES")
+        ---@type string[]
+        local body
+        if config.response.hooks.format then
+          body = res.try_format_body(content_type and content_type[1], data.response.body)
+        else
+          body = vim.split(data.response.body, "\n")
+        end
         vim.list_extend(lines, body)
         table.insert(lines, "#+END")
       else
@@ -138,6 +144,9 @@ winbar = winbar .. "%=%<"
 winbar = winbar .. "%{%v:lua.require('rest-nvim.ui.result').stat_winbar()%}"
 winbar = winbar .. " %#RestText#|%#Normal# "
 winbar = winbar .. "%#RestText#Press %#Keyword#?%#RestText# for help%#Normal# "
+
+---Winbar component showing response statistics
+---@return string
 function ui.stat_winbar()
   local content = ""
   if not data.response then
@@ -169,7 +178,9 @@ local group = paneui.create_pane_group("rest_nvim_result", panes, {
     end, { buffer = self.bufnr })
     vim.keymap.set("n", "?", help.open, { buffer = self.bufnr })
     vim.bo[self.bufnr].filetype = "rest_nvim_result"
-    utils.nvim_lazy_set_wo(self.bufnr, "winbar", winbar)
+    if config.ui.winbar then
+      utils.nvim_lazy_set_wo(self.bufnr, "winbar", winbar)
+    end
   end,
 })
 
@@ -189,6 +200,7 @@ vim.api.nvim_set_hl(0, "RestPaneTitle", {
   underline = true,
 })
 
+---Check if UI window is shown in current tabpage
 ---@return boolean
 function ui.is_open()
   local winnr = vim.iter(vim.api.nvim_tabpage_list_wins(0)):find(function(id)
@@ -203,11 +215,13 @@ function ui.enter(winnr)
   group:enter(winnr)
 end
 
+---Clear the UI
 function ui.clear()
   data = {}
   group:render()
 end
 
+---Update data and rerender the UI
 ---@param new_data rest.UIData
 function ui.update(new_data)
   data = vim.tbl_deep_extend("force", data, new_data)

spec/api_spec.lua

@@ -33,11 +33,11 @@ describe("parser", function()
     }, parser.parse(req_node, source))
   end)
   it("parse from http file", function()
-    local source = open "spec/api.http"
+    local source = open "spec/examples/basic_get.http"
     local _, tree = utils.ts_parse_source(source)
     local req_node = assert(tree:root():child(0))
     assert.same({
-      name = "api#1",
+      name = "basic_get#1",
       context = context:new(),
       method = "GET",
       url = "https://api.github.com/users/boltlessengineer",

spec/client_curl_cli_spec.lua renamed to spec/client/curl/cli_spec.lua

@@ -126,8 +126,9 @@ describe("curl cli response parser", function()
     }, response)
   end)
 end)
+
+-- don't run real request on test by default
 describe("curl cli request", function()
-  -- TODO: don't send actual request on test
   nio.tests.it("basic GET request", function()
     local response = curl
       .request({
@@ -151,4 +152,33 @@ describe("curl cli request", function()
     -- HACK: have no idea how to make sure it is table<string,string>
     assert.are_table(response.headers)
   end)
+  nio.tests.it("basic POST request", function()
+    local response = curl
+      .request({
+        context = Context:new(),
+        url = "https://reqres.in/api/register",
+        handlers = {},
+        headers = {
+          ["content-type"] = { "application/json" }
+        },
+        cookies = {},
+        method = "POST",
+        body = {
+          __TYPE = "json",
+          data = '{ "email": "[email protected]", "password": "pistol" }',
+        }
+      })
+      .wait()
+    assert.same(
+      '{"id":4,"token":"QpwL5tke4Pnpja7X4"}',
+      response.body
+    )
+    assert.same({
+        version = "HTTP/2",
+        code = 200,
+        text = ""
+    }, response.status)
+    -- HACK: have no idea how to make sure it is table<string,string>
+    assert.are_table(response.headers)
+  end)
 end)

spec/api.http renamed to spec/examples/basic_get.http

@@ -1,5 +1,2 @@
 GET https://api.github.com/users/boltlessengineer
 user-agent: neovim
-###
-GET https://api.github.com/users/NTBBloodbath
-user-agent: neovim

spec/examples/script/post_request_script.http

@@ -0,0 +1,11 @@
+### post-request script
+GET https://jsonplaceholder.typicode.com/posts/3
+
+> {%
+local body = vim.json.decode(response.body)
+client.global.set("postId", body.id)
+%}
+
+### run request with variable
+
+GET https://jsonplaceholder.typicode.com/posts/{{postId}}

spec/examples/script/pre_request_script.http

@@ -0,0 +1,7 @@
+### run request with variable set via pre-request script
+
+< {%
+request.variables.set("postId", "3")
+%}
+
+GET https://jsonplaceholder.typicode.com/posts/{{postId}}

spec/examples/variables/dynamic_vars.http

@@ -0,0 +1,14 @@
+POST https://reqres.in/api/users
+Content-Type: application/json
+
+{
+    "userid" : "{{$uuid}}",
+    "time" : "{{$timestamp}}",
+    "randomValue": "{{$randomInt}}",
+    "name": "morpheus",
+    "job": "leader",
+    "array": ["a", "b", "c"],
+    "object_ugly_closing": {
+        "some_key": "some_value"
+}
+}