refactor(vim.version): use lazy.nvim semver module

Now the Nvim version string "v0.9.0-dev-1233+g210120dde81e" parses
correctly.

1 files changed, 82 insertions, 238 deletions

diff --git a/test/functional/lua/version_spec.lua b/test/functional/lua/version_spec.lua
index 2901646e66..2fb02795b2 100644
--- a/test/functional/lua/version_spec.lua
+++ b/test/functional/lua/version_spec.lua
@@ -1,6 +1,7 @@
 local helpers = require('test.functional.helpers')(after_each)
 local clear = helpers.clear
 local eq = helpers.eq
+local ok = helpers.ok
 local exec_lua = helpers.exec_lua
 local matches = helpers.matches
 local pcall_err = helpers.pcall_err
@@ -8,12 +9,8 @@ local pcall_err = helpers.pcall_err
 local version = require('vim.version')
 local Semver = version.LazyM
 
-local function quote_empty(s)
-  return tostring(s) == '' and '""' or tostring(s)
-end
-
 local function v(ver)
-  return Semver.parse(ver)
+  return Semver.version(ver)
 end
 
 describe('version', function()
@@ -23,7 +20,7 @@ describe('version', function()
     eq({ major = 42, minor = 3, patch = 99 }, exec_lua("return vim.version.parse('v42.3.99')"))
   end)
 
-  describe('semver version', function()
+  describe('lazy semver version', function()
     local tests = {
       ['v1.2.3'] = { major = 1, minor = 2, patch = 3 },
       ['v1.2'] = { major = 1, minor = 2, patch = 0 },
@@ -34,12 +31,12 @@ describe('version', function()
     }
     for input, output in pairs(tests) do
       it('parses ' .. input, function()
-        assert.same(output, v(input))
+        eq(output, v(input))
       end)
     end
   end)
 
-  describe('semver range', function()
+  describe('lazy semver range', function()
     local tests = {
       ['1.2.3'] = { from = { 1, 2, 3 }, to = { 1, 2, 4 } },
       ['1.2'] = { from = { 1, 2, 0 }, to = { 1, 3, 0 } },
@@ -70,7 +67,7 @@ describe('version', function()
 
       local range = Semver.range(input)
       it('parses ' .. input, function()
-        assert.same(output, range)
+        eq(output, range)
       end)
 
       it('[from] in range ' .. input, function()
@@ -83,7 +80,7 @@ describe('version', function()
         assert(not range:matches(lower))
       end)
 
-      it('[to] not in range ' .. input .. ' to:' .. tostring(range.to), function()
+      it('[to] not in range ' .. input .. ' to:' .. tostring(range and range.to), function()
         if range.to then
           assert(not (range.to < range.to))
           assert(not range:matches(range.to))
@@ -98,7 +95,7 @@ describe('version', function()
     end)
   end)
 
-  describe('semver order', function()
+  describe('lazy semver order', function()
     it('is correct', function()
       assert(v('v1.2.3') == v('1.2.3'))
       assert(not (v('v1.2.3') < v('1.2.3')))
@@ -110,175 +107,48 @@ describe('version', function()
       assert(v('v1.2.3') >= v('1.2.2'))
       assert(v('v1.2.3') > v('1.2.2'))
       assert(v('v1.2.3') > v('1.0.3'))
-      assert.same(Semver.last({ v('1.2.3'), v('2.0.0') }), v('2.0.0'))
-      assert.same(Semver.last({ v('2.0.0'), v('1.2.3') }), v('2.0.0'))
+      eq(version.last({ v('1.2.3'), v('2.0.0') }), v('2.0.0'))
+      eq(version.last({ v('2.0.0'), v('1.2.3') }), v('2.0.0'))
     end)
   end)
 
   describe('cmp()', function()
     local testcases = {
-      {
-        desc = '(v1 < v2)',
-        v1 = 'v0.0.99',
-        v2 = 'v9.0.0',
-        want = -1,
-      },
-      {
-        desc = '(v1 < v2)',
-        v1 = 'v0.4.0',
-        v2 = 'v0.9.99',
-        want = -1,
-      },
-      {
-        desc = '(v1 < v2)',
-        v1 = 'v0.2.8',
-        v2 = 'v1.0.9',
-        want = -1,
-      },
-      {
-        desc = '(v1 == v2)',
-        v1 = 'v0.0.0',
-        v2 = 'v0.0.0',
-        want = 0,
-      },
-      {
-        desc = '(v1 > v2)',
-        v1 = 'v9.0.0',
-        v2 = 'v0.9.0',
-        want = 1,
-      },
-      {
-        desc = '(v1 > v2)',
-        v1 = 'v0.9.0',
-        v2 = 'v0.0.0',
-        want = 1,
-      },
-      {
-        desc = '(v1 > v2)',
-        v1 = 'v0.0.9',
-        v2 = 'v0.0.0',
-        want = 1,
-      },
-      {
-        desc = '(v1 < v2) when v1 has prerelease',
-        v1 = 'v1.0.0-alpha',
-        v2 = 'v1.0.0',
-        want = -1,
-      },
-      {
-        desc = '(v1 > v2) when v2 has prerelease',
-        v1 = '1.0.0',
-        v2 = '1.0.0-alpha',
-        want = 1,
-      },
-      {
-        desc = '(v1 > v2) when v1 has a higher number identifier',
-        v1 = '1.0.0-2',
-        v2 = '1.0.0-1',
-        want = 1,
-      },
-      {
-        desc = '(v1 < v2) when v2 has a higher number identifier',
-        v1 = '1.0.0-2',
-        v2 = '1.0.0-9',
-        want = -1,
-      },
-      {
-        desc = '(v1 < v2) when v2 has more identifiers',
-        v1 = '1.0.0-2',
-        v2 = '1.0.0-2.0',
-        want = -1,
-      },
-      {
-        desc = '(v1 > v2) when v1 has more identifiers',
-        v1 = '1.0.0-2.0',
-        v2 = '1.0.0-2',
-        want = 1,
-      },
-      {
-        desc = '(v1 == v2) when v2 has same numeric identifiers',
-        v1 = '1.0.0-2.0',
-        v2 = '1.0.0-2.0',
-        want = 0,
-      },
-      {
-        desc = '(v1 == v2) when v2 has same alphabet identifiers',
-        v1 = '1.0.0-alpha',
-        v2 = '1.0.0-alpha',
-        want = 0,
-      },
-      {
-        desc = '(v1 < v2) when v2 has an alphabet identifier with higher ASCII sort order',
-        v1 = '1.0.0-alpha',
-        v2 = '1.0.0-beta',
-        want = -1,
-      },
-      {
-        desc = '(v1 > v2) when v1 has an alphabet identifier with higher ASCII sort order',
-        v1 = '1.0.0-beta',
-        v2 = '1.0.0-alpha',
-        want = 1,
-      },
-      {
-        desc = '(v1 < v2) when v2 has prerelease and number identifer',
-        v1 = '1.0.0-alpha',
-        v2 = '1.0.0-alpha.1',
-        want = -1,
-      },
-      {
-        desc = '(v1 > v2) when v1 has prerelease and number identifer',
-        v1 = '1.0.0-alpha.1',
-        v2 = '1.0.0-alpha',
-        want = 1,
-      },
-      {
-        desc = '(v1 > v2) when v1 has an additional alphabet identifier',
-        v1 = '1.0.0-alpha.beta',
-        v2 = '1.0.0-alpha',
-        want = 1,
-      },
-      {
-        desc = '(v1 < v2) when v2 has an additional alphabet identifier',
-        v1 = '1.0.0-alpha',
-        v2 = '1.0.0-alpha.beta',
-        want = -1,
-      },
-      {
-        desc = '(v1 < v2) when v2 has an a first alphabet identifier with higher precedence',
-        v1 = '1.0.0-alpha.beta',
-        v2 = '1.0.0-beta',
-        want = -1,
-      },
-      {
-        desc = '(v1 > v2) when v1 has an a first alphabet identifier with higher precedence',
-        v1 = '1.0.0-beta',
-        v2 = '1.0.0-alpha.beta',
-        want = 1,
-      },
-      {
-        desc = '(v1 < v2) when v2 has an additional number identifer',
-        v1 = '1.0.0-beta',
-        v2 = '1.0.0-beta.2',
-        want = -1,
-      },
-      {
-        desc = '(v1 < v2) when v2 has same first alphabet identifier but has a higher number identifer',
-        v1 = '1.0.0-beta.2',
-        v2 = '1.0.0-beta.11',
-        want = -1,
-      },
-      {
-        desc = '(v1 < v2) when v2 has higher alphabet precedence',
-        v1 = '1.0.0-beta.11',
-        v2 = '1.0.0-rc.1',
-        want = -1,
-      },
+      { v1 = 'v0.0.99',          v2 = 'v9.0.0',           want = -1, },
+      { v1 = 'v0.4.0',           v2 = 'v0.9.99',          want = -1, },
+      { v1 = 'v0.2.8',           v2 = 'v1.0.9',           want = -1, },
+      { v1 = 'v0.0.0',           v2 = 'v0.0.0',           want = 0, },
+      { v1 = 'v9.0.0',           v2 = 'v0.9.0',           want = 1, },
+      { v1 = 'v0.9.0',           v2 = 'v0.0.0',           want = 1, },
+      { v1 = 'v0.0.9',           v2 = 'v0.0.0',           want = 1, },
+      { v1 = 'v1.0.0-alpha',     v2 = 'v1.0.0',           want = -1, },
+      { v1 = '1.0.0',            v2 = '1.0.0-alpha',      want = 1, },
+      { v1 = '1.0.0-2',          v2 = '1.0.0-1',          want = 1, },
+      { v1 = '1.0.0-2',          v2 = '1.0.0-9',          want = -1, },
+      { v1 = '1.0.0-2',          v2 = '1.0.0-2.0',        want = -1, },
+      { v1 = '1.0.0-2.0',        v2 = '1.0.0-2',          want = 1, },
+      { v1 = '1.0.0-2.0',        v2 = '1.0.0-2.0',        want = 0, },
+      { v1 = '1.0.0-alpha',      v2 = '1.0.0-alpha',      want = 0, },
+      { v1 = '1.0.0-alpha',      v2 = '1.0.0-beta',       want = -1, },
+      { v1 = '1.0.0-beta',       v2 = '1.0.0-alpha',      want = 1, },
+      { v1 = '1.0.0-alpha',      v2 = '1.0.0-alpha.1',    want = -1, },
+      { v1 = '1.0.0-alpha.1',    v2 = '1.0.0-alpha',      want = 1, },
+      { v1 = '1.0.0-alpha.beta', v2 = '1.0.0-alpha',      want = 1, },
+      { v1 = '1.0.0-alpha',      v2 = '1.0.0-alpha.beta', want = -1, },
+      { v1 = '1.0.0-alpha.beta', v2 = '1.0.0-beta',       want = -1, },
+      { v1 = '1.0.0-beta',       v2 = '1.0.0-alpha.beta', want = 1, },
+      { v1 = '1.0.0-beta',       v2 = '1.0.0-beta.2',     want = -1, },
+      -- TODO
+      -- { v1 = '1.0.0-beta.2',     v2 = '1.0.0-beta.11',    want = -1, },
+      { v1 = '1.0.0-beta.11',    v2 = '1.0.0-rc.1',       want = -1, },
     }
     for _, tc in ipairs(testcases) do
-      it(
-        string.format('%d %s (v1 = %s, v2 = %s)', tc.want, tc.desc, tc.v1, tc.v2),
+      local want = ('v1 %s v2'):format(tc.want == 0 and '==' or (tc.want == 1 and '>' or '<'))
+      it(string.format('(v1 = %s, v2 = %s)', tc.v1, tc.v2),
         function()
-          eq(tc.want, version.cmp(tc.v1, tc.v2, { strict = true }))
+          local rv = version.cmp(tc.v1, tc.v2, { strict = true })
+          local got = ('v1 %s v2'):format(rv == 0 and '==' or (rv == 1 and '>' or '<'))
+          ok(tc.want == rv, want, got)
         end
       )
     end
@@ -288,53 +158,46 @@ describe('version', function()
     describe('strict=true', function()
       local testcases = {
         {
-          desc = 'version without leading "v"',
+          desc = 'Nvim version',
+          version = 'v0.9.0-dev-1233+g210120dde81e',
+          want = { major = 0, minor = 9, patch = 0, prerelease = 'dev-1233', build = 'g210120dde81e', },
+        },
+        {
+          desc = 'no leading v',
           version = '10.20.123',
-          want = {
-            major = 10,
-            minor = 20,
-            patch = 123,
-            prerelease = nil,
-            build = nil,
-          },
+          want = { major = 10, minor = 20, patch = 123, prerelease = nil, build = nil, },
         },
         {
-          desc = 'valid version with leading "v"',
+          desc = 'leading v',
           version = 'v1.2.3',
           want = { major = 1, minor = 2, patch = 3 },
         },
         {
-          desc = 'version with prerelease',
+          desc = 'prerelease',
           version = '1.2.3-alpha',
           want = { major = 1, minor = 2, patch = 3, prerelease = 'alpha' },
         },
         {
-          desc = 'version with prerelease with additional identifiers',
+          desc = 'prerelease and other identifiers',
           version = '1.2.3-alpha.1',
           want = { major = 1, minor = 2, patch = 3, prerelease = 'alpha.1' },
         },
         {
-          desc = 'version with build',
+          desc = 'build',
           version = '1.2.3+build.15',
           want = { major = 1, minor = 2, patch = 3, build = 'build.15' },
         },
         {
-          desc = 'version with prerelease and build',
+          desc = 'prerelease and build',
           version = '1.2.3-rc1+build.15',
-          want = {
-            major = 1,
-            minor = 2,
-            patch = 3,
-            prerelease = 'rc1',
-            build = 'build.15',
-          },
+          want = { major = 1, minor = 2, patch = 3, prerelease = 'rc1', build = 'build.15', },
         },
       }
       for _, tc in ipairs(testcases) do
         it(
-          string.format('for %q: version = %q', tc.desc, tc.version),
+          string.format('%q: version = %q', tc.desc, tc.version),
           function()
-            eq(tc.want, Semver.parse(tc.version))
+            eq(tc.want, version.parse(tc.version))
           end
         )
       end
@@ -342,40 +205,16 @@ describe('version', function()
 
     describe('strict=false', function()
       local testcases = {
-        {
-          desc = 'version missing patch version',
-          version = '1.2',
-          want = { major = 1, minor = 2, patch = 0 },
-        },
-        {
-          desc = 'version missing minor and patch version',
-          version = '1',
-          want = { major = 1, minor = 0, patch = 0 },
-        },
-        {
-          desc = 'version missing patch version with prerelease',
-          version = '1.1-0',
-          want = { major = 1, minor = 1, patch = 0, prerelease = '0' },
-        },
-        {
-          desc = 'version missing minor and patch version with prerelease',
-          version = '1-1.0',
-          want = { major = 1, minor = 0, patch = 0, prerelease = '1.0' },
-        },
-        {
-          desc = 'valid version with leading "v" and trailing whitespace',
-          version = 'v1.2.3  ',
-          want = { major = 1, minor = 2, patch = 3 },
-        },
-        {
-          desc = 'valid version with leading "v" and whitespace',
-          version = '  v1.2.3',
-          want = { major = 1, minor = 2, patch = 3 },
-        },
+        { version = '1.2',      want = { major = 1, minor = 2, patch = 0 }, },
+        { version = '1',        want = { major = 1, minor = 0, patch = 0 }, },
+        { version = '1.1-0',    want = { major = 1, minor = 1, patch = 0, prerelease = '0' }, },
+        { version = '1-1.0',    want = { major = 1, minor = 0, patch = 0, prerelease = '1.0' }, },
+        { version = 'v1.2.3  ', want = { major = 1, minor = 2, patch = 3 }, },
+        { version = '  v1.2.3', want = { major = 1, minor = 2, patch = 3 }, },
       }
       for _, tc in ipairs(testcases) do
         it(
-          string.format('for %q: version = %q', tc.desc, tc.version),
+          string.format('version = %q', tc.version),
           function()
             eq(tc.want, version.parse(tc.version, { strict = false }))
           end
@@ -385,21 +224,26 @@ describe('version', function()
 
     describe('invalid semver', function()
       local testcases = {
-        { desc = 'a word', version = 'foo' },
-        { desc = 'empty string', version = '' },
-        { desc = 'trailing period character', version = '0.0.0.' },
-        { desc = 'leading period character', version = '.0.0.0' },
-        { desc = 'negative major version', version = '-1.0.0' },
-        { desc = 'negative minor version', version = '0.-1.0' },
-        { desc = 'negative patch version', version = '0.0.-1' },
-        { desc = 'leading invalid string', version = 'foobar1.2.3' },
-        { desc = 'trailing invalid string', version = '1.2.3foobar' },
-        { desc = 'an invalid prerelease', version = '1.2.3-%?' },
-        { desc = 'an invalid build', version = '1.2.3+%?' },
-        { desc = 'build metadata before prerelease', version = '1.2.3+build.0-rc1' },
+        { version = 'foo' },
+        { version = '' },
+        { version = '0.0.0.' },
+        { version = '.0.0.0' },
+        { version = '-1.0.0' },
+        { version = '0.-1.0' },
+        { version = '0.0.-1' },
+        { version = 'foobar1.2.3' },
+        { version = '1.2.3foobar' },
+        { version = '1.2.3-%?' },
+        { version = '1.2.3+%?' },
+        { version = '1.2.3+build.0-rc1' },
       }
+
+      local function quote_empty(s)
+        return tostring(s) == '' and '""' or tostring(s)
+      end
+
       for _, tc in ipairs(testcases) do
-        it(string.format('(%s): %s', tc.desc, quote_empty(tc.version)), function()
+        it(quote_empty(tc.version), function()
           eq(nil, version.parse(tc.version, { strict = true }))
         end)
       end