From 5fa26e2c2fcc208ca31187de4338d5b6f746f2e1 Mon Sep 17 00:00:00 2001 From: Gregory Anders Date: Thu, 29 Jul 2021 14:48:04 -0600 Subject: feat: add trimempty optional parameter to vim.split The `split()` VimL function trims empty items from the returned list by default, so that, e.g. split("\nhello\nworld\n\n", "\n") returns ["hello", "world"] The Lua implementation of vim.split does not do this. For example, vim.split("\nhello\nworld\n\n", "\n") returns {'', 'hello', 'world', '', ''} Add an optional parameter to the vim.split function that, when true, trims these empty elements from the front and back of the returned table. This is only possible for vim.split and not vim.gsplit; because vim.gsplit is an iterator, there is no way for it to know if the current item is the last non-empty item. Note that in order to preserve backward compatibility, the parameter for the Lua vim.split function is `trimempty`, while the VimL function uses `keepempty` (i.e. they are opposites). This means there is a disconnect between these two functions that may surprise users. --- test/functional/lua/vim_spec.lua | 37 ++++++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 15 deletions(-) (limited to 'test/functional/lua/vim_spec.lua') diff --git a/test/functional/lua/vim_spec.lua b/test/functional/lua/vim_spec.lua index a066cfbc10..557923f648 100644 --- a/test/functional/lua/vim_spec.lua +++ b/test/functional/lua/vim_spec.lua @@ -237,27 +237,29 @@ describe('lua stdlib', function() end) it("vim.split", function() - local split = function(str, sep, plain) - return exec_lua('return vim.split(...)', str, sep, plain) + local split = function(str, sep, plain, trimempty) + return exec_lua('return vim.split(...)', str, sep, plain, trimempty) end local tests = { - { "a,b", ",", false, { 'a', 'b' } }, - { ":aa::bb:", ":", false, { '', 'aa', '', 'bb', '' } }, - { "::ee::ff:", ":", false, { '', '', 'ee', '', 'ff', '' } }, - { "ab", ".", false, { '', '', '' } }, - { "a1b2c", "[0-9]", false, { 'a', 'b', 'c' } }, - { "xy", "", false, { 'x', 'y' } }, - { "here be dragons", " ", false, { "here", "be", "dragons"} }, - { "axaby", "ab?", false, { '', 'x', 'y' } }, - { "f v2v v3v w2w ", "([vw])2%1", false, { 'f ', ' v3v ', ' ' } }, - { "", "", false, {} }, - { "", "a", false, { '' } }, - { "x*yz*oo*l", "*", true, { 'x', 'yz', 'oo', 'l' } }, + { "a,b", ",", false, false, { 'a', 'b' } }, + { ":aa::bb:", ":", false, false, { '', 'aa', '', 'bb', '' } }, + { ":aa::bb:", ":", false, true, { 'aa', '', 'bb' } }, + { "::ee::ff:", ":", false, false, { '', '', 'ee', '', 'ff', '' } }, + { "::ee::ff:", ":", false, true, { 'ee', '', 'ff' } }, + { "ab", ".", false, false, { '', '', '' } }, + { "a1b2c", "[0-9]", false, false, { 'a', 'b', 'c' } }, + { "xy", "", false, false, { 'x', 'y' } }, + { "here be dragons", " ", false, false, { "here", "be", "dragons"} }, + { "axaby", "ab?", false, false, { '', 'x', 'y' } }, + { "f v2v v3v w2w ", "([vw])2%1", false, false, { 'f ', ' v3v ', ' ' } }, + { "", "", false, false, {} }, + { "", "a", false, false, { '' } }, + { "x*yz*oo*l", "*", true, false, { 'x', 'yz', 'oo', 'l' } }, } for _, t in ipairs(tests) do - eq(t[4], split(t[1], t[2], t[3])) + eq(t[5], split(t[1], t[2], t[3], t[4])) end local loops = { @@ -288,6 +290,11 @@ describe('lua stdlib', function() vim/shared.lua:0: in function 'gsplit' vim/shared.lua:0: in function ]]), pcall_err(split, 'string', 'string', 1)) + eq(dedent([[ + Error executing lua: vim/shared.lua:0: trimempty: expected boolean, got number + stack traceback: + vim/shared.lua:0: in function ]]), + pcall_err(split, 'string', 'string', false, 42)) end) it('vim.trim', function() -- cgit From 84f66909e4008a57da947f1640bfc24da5e41a72 Mon Sep 17 00:00:00 2001 From: Gregory Anders Date: Sat, 25 Sep 2021 20:08:36 -0600 Subject: refactor: use kwargs parameter in vim.split --- test/functional/lua/vim_spec.lua | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) (limited to 'test/functional/lua/vim_spec.lua') diff --git a/test/functional/lua/vim_spec.lua b/test/functional/lua/vim_spec.lua index 557923f648..8651a38025 100644 --- a/test/functional/lua/vim_spec.lua +++ b/test/functional/lua/vim_spec.lua @@ -237,8 +237,8 @@ describe('lua stdlib', function() end) it("vim.split", function() - local split = function(str, sep, plain, trimempty) - return exec_lua('return vim.split(...)', str, sep, plain, trimempty) + local split = function(str, sep, kwargs) + return exec_lua('return vim.split(...)', str, sep, kwargs) end local tests = { @@ -259,9 +259,12 @@ describe('lua stdlib', function() } for _, t in ipairs(tests) do - eq(t[5], split(t[1], t[2], t[3], t[4])) + eq(t[5], split(t[1], t[2], {plain=t[3], trimempty=t[4]})) end + -- Test old signature + eq({'x', 'yz', 'oo', 'l'}, split("x*yz*oo*l", "*", true)) + local loops = { { "abc", ".-" }, } @@ -285,16 +288,10 @@ describe('lua stdlib', function() vim/shared.lua:0: in function ]]), pcall_err(split, 'string', 1)) eq(dedent([[ - Error executing lua: vim/shared.lua:0: plain: expected boolean, got number + Error executing lua: vim/shared.lua:0: kwargs: expected table, got number stack traceback: - vim/shared.lua:0: in function 'gsplit' vim/shared.lua:0: in function ]]), pcall_err(split, 'string', 'string', 1)) - eq(dedent([[ - Error executing lua: vim/shared.lua:0: trimempty: expected boolean, got number - stack traceback: - vim/shared.lua:0: in function ]]), - pcall_err(split, 'string', 'string', false, 42)) end) it('vim.trim', function() -- cgit