Merge branch 'nvim-lua:master' into scan_symlink

Author: SunPodder

.github/workflows/default.yml

@@ -17,7 +17,7 @@ jobs:
           - os: ubuntu-22.04
             rev: v0.8.3/nvim-linux64.tar.gz
           - os: ubuntu-22.04
-            rev: v0.9.0/nvim-linux64.tar.gz
+            rev: v0.9.1/nvim-linux64.tar.gz
     steps:
       - uses: actions/checkout@v3
       - run: date +%F > todays-date

.luacheckrc

@@ -27,7 +27,6 @@ read_globals = {
 exclude_files = {
   "lua/plenary/profile/lua_profiler.lua",
   "lua/plenary/profile/memory_profiler.lua",
-  "lua/plenary/vararg/rotate.lua",
   "lua/plenary/async_lib/*.lua",
 }
 

Makefile

@@ -1,6 +1,6 @@
 .PHONY: test generate_filetypes lint luarocks_upload test_luarocks_install
 test:
-	nvim --headless --noplugin -u scripts/minimal.vim -c "PlenaryBustedDirectory tests/plenary/ {minimal_init = 'tests/minimal_init.vim'}"
+	nvim --headless --noplugin -u scripts/minimal.vim -c "PlenaryBustedDirectory tests/plenary/ {minimal_init = 'tests/minimal_init.vim', sequential = true}"
 
 generate_filetypes:
 	nvim --headless -c 'luafile scripts/update_filetypes_from_github.lua' -c 'qa!'

README.md

@@ -28,15 +28,15 @@ use "nvim-lua/plenary.nvim"
 
 ## Modules
 
-- `plenary.async`
-- `plenary.async_lib`
-- `plenary.job`
-- `plenary.path`
-- `plenary.scandir`
-- `plenary.context_manager`
-- `plenary.test_harness`
-- `plenary.filetype`
-- `plenary.strings`
+- [plenary.async](#plenaryasync)
+- [plenary.async_lib](#plenaryasync_lib)
+- [plenary.job](#plenaryjob)
+- [plenary.path](#plenarypath)
+- [plenary.scandir](#plenaryscandir)
+- [plenary.context_manager](#plenarycontext_manager)
+- [plenary.test_harness](#plenarytest_harness)
+- [plenary.filetype](#plenaryfiletype)
+- [plenary.strings](#plenarystrings)
 
 ### plenary.async
 
@@ -99,7 +99,6 @@ end
 #### Plugins using this
 
 - [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
-- [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim)
 - [vgit.nvim](https://github.com/tanvirtin/vgit.nvim)
 - [neogit](https://github.com/TimUntersberger/neogit)
 - [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim)

data/plenary/filetypes/builtin.lua

@@ -36,6 +36,8 @@ return {
     ['graphql'] = 'graphql',
     ['hbs'] = 'handlebars',
     ['hdbs'] = 'handlebars',
+    ['hlsl'] = 'hlsl',
+    ['jai'] = 'jai',
     ['janet'] = 'janet',
     ['jl'] = 'julia',
     ['jsx'] = 'javascriptreact',

lua/plenary/async/api.lua

@@ -8,7 +8,7 @@ return setmetatable({}, {
         util.scheduler()
       end
 
-      vim.api[k](...)
+      return vim.api[k](...)
     end
   end,
 })

lua/plenary/async/async.lua

@@ -7,7 +7,7 @@ local f = require "plenary.functional"
 local M = {}
 
 local function is_callable(fn)
-  return type(fn) == "function" or type(getmetatable(fn)["__call"]) == "function"
+  return type(fn) == "function" or (type(fn) == "table" and type(getmetatable(fn)["__call"]) == "function")
 end
 
 ---because we can't store varargs

lua/plenary/async/control.lua

@@ -32,10 +32,10 @@ function Condvar:notify_all()
     callback()
   end
 
-  for i = 1, len do
+  for _ = 1, len do
     -- table.remove will ensure that indexes are correct and make "ipairs" safe,
     -- which is not the case for "self.handles[i] = nil"
-    table.remove(self.handles, i)
+    table.remove(self.handles)
   end
 end
 

lua/plenary/async/util.lua

@@ -22,7 +22,8 @@ M.sleep = a.wrap(defer_swapped, 2)
 M.block_on = function(async_function, timeout)
   async_function = M.protected(async_function)
 
-  local stat, ret
+  local stat
+  local ret = {}
 
   a.run(async_function, function(stat_, ...)
     stat = stat_
@@ -75,14 +76,14 @@ M.join = function(async_fns)
   return results
 end
 
----Returns a future that when run will select the first async_function that finishes
----@param async_funs table: The async_function that you want to select
+---Returns a result from the future that finishes at the first
+---@param async_functions table: The futures that you want to select
 ---@return ...
-M.run_first = a.wrap(function(async_funs, step)
+M.run_first = a.wrap(function(async_functions, step)
   local ran = false
 
-  for _, future in ipairs(async_funs) do
-    assert(type(future) == "function", "type error :: future must be function")
+  for _, async_function in ipairs(async_functions) do
+    assert(type(async_function) == "function", "type error :: future must be function")
 
     local callback = function(...)
       if not ran then
@@ -91,10 +92,22 @@ M.run_first = a.wrap(function(async_funs, step)
       end
     end
 
-    future(callback)
+    async_function(callback)
   end
 end, 2)
 
+---Returns a result from the functions that finishes at the first
+---@param funcs table: The async functions that you want to select
+---@return ...
+M.race = function(funcs)
+  local async_functions = vim.tbl_map(function(func)
+    return function(callback)
+      a.run(func, callback)
+    end
+  end, funcs)
+  return M.run_first(async_functions)
+end
+
 M.run_all = function(async_fns, callback)
   a.run(function()
     M.join(async_fns)

lua/plenary/busted.lua

@@ -59,13 +59,13 @@ local pop_description = function()
 end
 
 local add_new_each = function()
-  current_before_each[current_description[#current_description]] = {}
-  current_after_each[current_description[#current_description]] = {}
+  current_before_each[#current_description] = {}
+  current_after_each[#current_description] = {}
 end
 
 local clear_last_each = function()
-  current_before_each[current_description[#current_description]] = nil
-  current_after_each[current_description[#current_description]] = nil
+  current_before_each[#current_description] = nil
+  current_after_each[#current_description] = nil
 end
 
 local call_inner = function(desc, func)
@@ -140,11 +140,11 @@ mod.inner_describe = function(desc, func)
 end
 
 mod.before_each = function(fn)
-  table.insert(current_before_each[current_description[#current_description]], fn)
+  table.insert(current_before_each[#current_description], fn)
 end
 
 mod.after_each = function(fn)
-  table.insert(current_after_each[current_description[#current_description]], fn)
+  table.insert(current_after_each[#current_description], fn)
 end
 
 mod.clear = function()
@@ -161,7 +161,7 @@ local indent = function(msg, spaces)
 end
 
 local run_each = function(tbl)
-  for _, v in pairs(tbl) do
+  for _, v in ipairs(tbl) do
     for _, w in ipairs(v) do
       if type(w) == "function" then
         w()
@@ -215,6 +215,8 @@ clear = mod.clear
 assert = require "luassert"
 
 mod.run = function(file)
+  file = file:gsub("\\", "/")
+
   print("\n" .. HEADER)
   print("Testing: ", file)
 

lua/plenary/curl.lua

@@ -3,15 +3,16 @@ Curl Wrapper
 
 all curl methods accepts
 
-  url     = "The url to make the request to.", (string)
-  query   = "url query, append after the url", (table)
-  body    = "The request body" (string/filepath/table)
-  auth    = "Basic request auth, 'user:pass', or {"user", "pass"}" (string/array)
-  form    = "request form" (table)
-  raw     = "any additonal curl args, it must be an array/list." (array)
-  dry_run = "whether to return the args to be ran through curl." (boolean)
-  output  = "where to download something." (filepath)
-  timeout = "request timeout in mseconds" (number)
+  url          = "The url to make the request to.", (string)
+  query        = "url query, append after the url", (table)
+  body         = "The request body" (string/filepath/table)
+  auth         = "Basic request auth, 'user:pass', or {"user", "pass"}" (string/array)
+  form         = "request form" (table)
+  raw          = "any additonal curl args, it must be an array/list." (array)
+  dry_run      = "whether to return the args to be ran through curl." (boolean)
+  output       = "where to download something." (filepath)
+  timeout      = "request timeout in mseconds" (number)
+  http_version = "HTTP version to use: 'HTTP/0.9', 'HTTP/1.0', 'HTTP/1.1', 'HTTP/2', or 'HTTP/3'" (string)
 
 and returns table:
 
@@ -179,6 +180,19 @@ parse.accept_header = function(s)
   return { "-H", "Accept: " .. s }
 end
 
+parse.http_version = function(s)
+  if not s then
+    return
+  end
+  if s == "HTTP/0.9" or s == "HTTP/1.0" or s == "HTTP/1.1" or s == "HTTP/2" or s == "HTTP/3" then
+    s = s:lower()
+    s = s:gsub("/", "")
+    return { "--" .. s }
+  else
+    error "Unknown HTTP version."
+  end
+end
+
 -- Parse Request -------------------------------------------
 ------------------------------------------------------------
 parse.request = function(opts)
@@ -215,6 +229,7 @@ parse.request = function(opts)
   append(parse.form(opts.form))
   append(parse.file(opts.in_file))
   append(parse.auth(opts.auth))
+  append(parse.http_version(opts.http_version))
   append(opts.raw)
   if opts.output then
     table.insert(result, { "-o", opts.output })
@@ -244,7 +259,7 @@ end
 local request = function(specs)
   local response = {}
   local args, opts = parse.request(vim.tbl_extend("force", {
-    compressed = true,
+    compressed = package.config:sub(1, 1) ~= "\\",
     dry_run = false,
     dump = util.gen_dump_path(),
   }, specs))

lua/plenary/fun.lua

@@ -1,20 +1,6 @@
-local tbl = require "plenary.tbl"
-
 local M = {}
 
-function M.bind(fn, ...)
-  if select("#", ...) == 1 then
-    local arg = ...
-    return function(...)
-      fn(arg, ...)
-    end
-  end
-
-  local args = tbl.pack(...)
-  return function(...)
-    fn(tbl.unpack(args), ...)
-  end
-end
+M.bind = require("plenary.functional").partial
 
 function M.arify(fn, argc)
   return function(...)

lua/plenary/functional.lua

@@ -16,11 +16,17 @@ function f.join(array, sep)
   return table.concat(vim.tbl_map(tostring, array), sep)
 end
 
-function f.partial(fun, ...)
-  local args = { ... }
-  return function(...)
-    return fun(unpack(args), ...)
+local function bind_n(fn, n, a, ...)
+  if n == 0 then
+    return fn
   end
+  return bind_n(function(...)
+    return fn(a, ...)
+  end, n - 1, ...)
+end
+
+function f.partial(fun, ...)
+  return bind_n(fun, select("#", ...), ...)
 end
 
 function f.any(fun, iterable)

lua/plenary/job.lua

@@ -4,20 +4,21 @@ local uv = vim.loop
 local F = require "plenary.functional"
 
 ---@class Job
----@field command string          : Command to run
----@field args Array              : List of arguments to pass
----@field cwd string              : Working directory for job
----@field env Map|Array           : Environment looking like: { ['VAR'] = 'VALUE } or { 'VAR=VALUE' }
----@field skip_validation boolean : Skip validating the arguments
----@field enable_handlers boolean : If set to false, disables all callbacks associated with output
----@field on_start function       : Run when starting job
----@field on_stdout function      : (error: string, data: string, self? Job)
----@field on_stderr function      : (error: string, data: string, self? Job)
----@field on_exit function        : (self, code: number, signal: number)
----@field maximum_results number  : stop processing results after this number
----@field writer Job|table|string : Job that writes to stdin of this job.
----@field detached boolean        : Spawn the child in a detached state making it a process group leader
----@field enabled_recording boolean
+---@field command string Command to run
+---@field args? string[] List of arguments to pass
+---@field cwd? string Working directory for job
+---@field env? table<string, string>|string[] Environment looking like: { ['VAR'] = 'VALUE' } or { 'VAR=VALUE' }
+---@field interactive? boolean
+---@field detached? boolean Spawn the child in a detached state making it a process group leader
+---@field skip_validation? boolean Skip validating the arguments
+---@field enable_handlers? boolean If set to false, disables all callbacks associated with output (default: true)
+---@field enabled_recording? boolean
+---@field on_start? fun()
+---@field on_stdout? fun(error: string, data: string, self?: Job)
+---@field on_stderr? fun(error: string, data: string, self?: Job)
+---@field on_exit? fun(self: Job, code: number, signal: number)
+---@field maximum_results? number Stop processing results after this number
+---@field writer? Job|table|string Job that writes to stdin of this job.
 local Job = {}
 Job.__index = Job
 
@@ -65,7 +66,7 @@ local function expand(path)
     return assert(uv.fs_realpath(path), string.format("Path must be valid: %s", path))
   else
     -- TODO: Probably want to check that this is valid here... otherwise that's weird.
-    return vim.fn.expand(vim.fn.escape(path, "$"), true)
+    return vim.fn.expand(vim.fn.escape(path, "[]$"), true)
   end
 end
 

lua/plenary/log.lua

@@ -7,6 +7,8 @@
 -- This library is free software; you can redistribute it and/or modify it
 -- under the terms of the MIT license. See LICENSE for details.
 
+local Path = require "plenary.path"
+
 local p_debug = vim.fn.getenv "DEBUG_PLENARY"
 if p_debug == vim.NIL then
   p_debug = false
@@ -79,7 +81,7 @@ log.new = function(config, standalone)
 
   local outfile = vim.F.if_nil(
     config.outfile,
-    string.format("%s/%s.log", vim.api.nvim_call_function("stdpath", { "cache" }), config.plugin)
+    Path:new(vim.api.nvim_call_function("stdpath", { "cache" }), config.plugin .. ".log").filename
   )
 
   local obj
@@ -159,7 +161,7 @@ log.new = function(config, standalone)
 
     -- Output to log file
     if config.use_file then
-      local outfile_parent_path = require("plenary.path"):new(outfile):parent()
+      local outfile_parent_path = Path:new(outfile):parent()
       if not outfile_parent_path:exists() then
         outfile_parent_path:mkdir { parents = true }
       end