feat: save response to file (close #359)

Author: boltlessengineer

Diff for: lua/rest-nvim/parser/init.lua

@@ -314,6 +314,41 @@ function parser.parse_request_handler(node, source, context)
     return script.load_post_req_hook(str, context)
 end
 
+---@param node TSNode
+---@param source Source
+---@param ctx rest.Context
+---@return function?
+function parser.parse_redirect_path(node, source, ctx)
+    local force = vim.treesitter.get_node_text(node, source):match("^>>!")
+    local path = get_node_field_text(node, "path", source)
+    if path then
+        path = expand_variables(path, ctx)
+        return function (res)
+            if not res.body then
+                return
+            end
+            logger.debug("save response body to:", path)
+            if not force then
+                local suffix_idx = 1
+                while utils.file_exists(path) do
+                    local pathname, pathext = path:match("([^.]+)(.*)")
+                    path = ("%s_%d%s"):format(pathname, suffix_idx, pathext)
+                    suffix_idx = suffix_idx + 1
+                end
+            end
+            local respfile, openerr = io.open(path, "w+")
+            if not respfile then
+                local err_msg = string.format("Failed to open response file (%s): %s", path, openerr)
+                vim.notify(err_msg, vim.log.levels.ERROR, { title = "rest.nvim" })
+                return
+            end
+            respfile:write(res.body)
+            respfile:close()
+            logger.debug("response body saved done")
+        end
+    end
+end
+
 ---@param source Source
 ---@return string[]
 function parser.get_request_names(source)
@@ -433,10 +468,17 @@ function parser.parse(node, source, ctx)
     for child, _ in req_node:iter_children() do
         local child_type = child:type()
         if child_type == "res_handler_script" then
+            logger.debug("find request node child:", child_type)
             local handler = parser.parse_request_handler(child, source, ctx)
             if handler then
                 table.insert(handlers, handler)
             end
+        elseif child_type == "res_redirect" then
+            logger.debug("find request node child:", child_type)
+            local handler = parser.parse_redirect_path(child, source, ctx)
+            if handler then
+                table.insert(handlers, handler)
+            end
         end
     end
     if not name then

Diff for: lua/rest-nvim/request.lua

@@ -73,6 +73,7 @@ local function run_request(req)
         logger.info("request success")
 
         -- run request handler scripts
+        logger.debug(("run %d handers"):format(#req.handlers))
         vim.iter(req.handlers):each(function(f)
             f(res)
         end)

Diff for: spec/parser/http_parser_spec.lua

@@ -311,6 +311,14 @@ Authorization: Bearer {{TOKEN}}
         }, c.lv)
     end)
 
+    it("parse response-redirect syntax", function ()
+        local source = "GET localhost:3000\n\n>> path/to/file.json\n"
+        local _, tree = utils.ts_parse_source(source)
+        local node = assert(tree:root():child(0))
+        local req = assert(parser.parse(node, source))
+        assert.same(1, #req.handlers)
+    end)
+
     -- TODO: update this testcase
     --   it("create context from source", function()
     --     local source = [[