refactor(typval)!: remove distinction of binary and nonbinary strings

This is a breaking change which will make refactor of typval and shada
code a lot easier. In particular, code that would use or check for
v:msgpack_types.binary in the wild would be broken. This appears to be
rarely used in existing plugins.

Also some cases where v:msgpack_type.string would be used to represent a
binary string of "string" type, we use a BLOB instead, which is
vimscripts native type for binary blobs, and already was used for BIN
formats when necessary.

msgpackdump(msgpackparse(data)) no longer preserves the distinction
of BIN and STR strings. This is very common behavior for
language-specific msgpack bindings. Nvim uses msgpack as a tool to
serialize its data. Nvim is not a tool to bit-perfectly manipulate
arbitrary msgpack data out in the wild.

The changed tests should indicate how behavior changes in various edge
cases.

1 files changed, 11 insertions, 54 deletions

diff --git a/test/functional/plugin/msgpack_spec.lua b/test/functional/plugin/msgpack_spec.lua
index 1d5d20ec02..61ab730da8 100644
--- a/test/functional/plugin/msgpack_spec.lua
+++ b/test/functional/plugin/msgpack_spec.lua
@@ -58,23 +58,11 @@ describe('autoload/msgpack.vim', function()
       msgpack_eq(1, '"abc\\ndef"', '"abc\\ndef"')
       msgpack_eq(0, '"abc\\ndef"', '"abc\\nghi"')
     end)
-    it('compares binary specials correctly', function()
-      msgpack_eq(1, sp('binary', '["abc\\n", "def"]'), sp('binary', '["abc\\n", "def"]'))
-      msgpack_eq(0, sp('binary', '["abc", "def"]'), sp('binary', '["abc\\n", "def"]'))
-    end)
-    it('compares binary specials with raw binaries correctly', function()
-      msgpack_eq(1, sp('binary', '["abc", "def"]'), '"abc\\ndef"')
-      msgpack_eq(0, sp('binary', '["abc", "def"]'), '"abcdef"')
-    end)
     it('compares string specials correctly', function()
       msgpack_eq(1, sp('string', '["abc\\n", "def"]'), sp('string', '["abc\\n", "def"]'))
       msgpack_eq(0, sp('string', '["abc", "def"]'), sp('string', '["abc\\n", "def"]'))
-    end)
-    it('compares string specials with binary correctly', function()
-      msgpack_eq(0, sp('string', '["abc\\n", "def"]'), sp('binary', '["abc\\n", "def"]'))
-      msgpack_eq(0, sp('string', '["abc", "def"]'), '"abc\\ndef"')
-      msgpack_eq(0, sp('binary', '["abc\\n", "def"]'), sp('string', '["abc\\n", "def"]'))
-      msgpack_eq(0, '"abc\\ndef"', sp('string', '["abc", "def"]'))
+      msgpack_eq(1, sp('string', '["abc", "def"]'), '"abc\\ndef"')
+      msgpack_eq(1, '"abc\\ndef"', sp('string', '["abc", "def"]'))
     end)
     it('compares ext specials correctly', function()
       msgpack_eq(1, sp('ext', '[1, ["", "ac"]]'), sp('ext', '[1, ["", "ac"]]'))
@@ -92,20 +80,16 @@ describe('autoload/msgpack.vim', function()
     end)
     it('compares map specials correctly', function()
       msgpack_eq(1, mapsp(), mapsp())
-      msgpack_eq(1, mapsp(sp('binary', '[""]'), '""'), mapsp(sp('binary', '[""]'), '""'))
       msgpack_eq(
         1,
         mapsp(mapsp('1', '1'), mapsp('1', '1')),
         mapsp(mapsp('1', '1'), mapsp('1', '1'))
       )
       msgpack_eq(0, mapsp(), mapsp('1', '1'))
-      msgpack_eq(0, mapsp(sp('binary', '["a"]'), '""'), mapsp(sp('binary', '[""]'), '""'))
-      msgpack_eq(0, mapsp(sp('binary', '[""]'), '"a"'), mapsp(sp('binary', '[""]'), '""'))
-      msgpack_eq(0, mapsp(sp('binary', '["a"]'), '"a"'), mapsp(sp('binary', '[""]'), '""'))
       msgpack_eq(
         0,
         mapsp(mapsp('1', '1'), mapsp('1', '1')),
-        mapsp(sp('binary', '[""]'), mapsp('1', '1'))
+        mapsp(sp('string', '[""]'), mapsp('1', '1'))
       )
       msgpack_eq(
         0,
@@ -138,7 +122,7 @@ describe('autoload/msgpack.vim', function()
       msgpack_eq(1, mapsp(sp('string', '["1"]'), '1'), '{"1": 1}')
       msgpack_eq(1, mapsp(sp('string', '["1"]'), sp('integer', '[1, 0, 0, 1]')), '{"1": 1}')
       msgpack_eq(0, mapsp(sp('integer', '[1, 0, 0, 1]'), sp('string', '["1"]')), '{1: "1"}')
-      msgpack_eq(0, mapsp('"1"', sp('integer', '[1, 0, 0, 1]')), '{"1": 1}')
+      msgpack_eq(1, mapsp('"1"', sp('integer', '[1, 0, 0, 1]')), '{"1": 1}')
       msgpack_eq(0, mapsp(sp('string', '["1"]'), '1', sp('string', '["2"]'), '2'), '{"1": 1}')
       msgpack_eq(0, mapsp(sp('string', '["1"]'), '1'), '{"1": 1, "2": 2}')
     end)
@@ -290,7 +274,6 @@ describe('autoload/msgpack.vim', function()
 
     it('works for special dictionaries', function()
       type_eq('string', sp('string', '[""]'))
-      type_eq('binary', sp('binary', '[""]'))
       type_eq('ext', sp('ext', '[1, [""]]'))
       type_eq('array', sp('array', '[]'))
       type_eq('map', sp('map', '[]'))
@@ -301,7 +284,7 @@ describe('autoload/msgpack.vim', function()
     end)
 
     it('works for regular values', function()
-      type_eq('binary', '""')
+      type_eq('string', '""')
       type_eq('array', '[]')
       type_eq('map', '{}')
       type_eq('integer', '1')
@@ -319,7 +302,6 @@ describe('autoload/msgpack.vim', function()
 
     it('works for special dictionaries', function()
       sp_type_eq('string', sp('string', '[""]'))
-      sp_type_eq('binary', sp('binary', '[""]'))
       sp_type_eq('ext', sp('ext', '[1, [""]]'))
       sp_type_eq('array', sp('array', '[]'))
       sp_type_eq('map', sp('map', '[]'))
@@ -347,12 +329,9 @@ describe('autoload/msgpack.vim', function()
     end
 
     it('works for special dictionaries', function()
-      string_eq('=""', sp('string', '[""]'))
-      string_eq('="\\n"', sp('string', '["", ""]'))
-      string_eq('="ab\\0c\\nde"', sp('string', '["ab\\nc", "de"]'))
-      string_eq('""', sp('binary', '[""]'))
-      string_eq('"\\n"', sp('binary', '["", ""]'))
-      string_eq('"ab\\0c\\nde"', sp('binary', '["ab\\nc", "de"]'))
+      string_eq('""', sp('string', '[""]'))
+      string_eq('"\\n"', sp('string', '["", ""]'))
+      string_eq('"ab\\0c\\nde"', sp('string', '["ab\\nc", "de"]'))
       string_eq('+(2)""', sp('ext', '[2, [""]]'))
       string_eq('+(2)"\\n"', sp('ext', '[2, ["", ""]]'))
       string_eq('+(2)"ab\\0c\\nde"', sp('ext', '[2, ["ab\\nc", "de"]]'))
@@ -397,8 +376,8 @@ describe('autoload/msgpack.vim', function()
       string_eq('[]', '[]')
       string_eq('[[[{}]]]', '[[[{}]]]')
       string_eq('{}', '{}')
-      string_eq('{="2": 10}', '{2: 10}')
-      string_eq('{="2": [{}]}', '{2: [{}]}')
+      string_eq('{"2": 10}', '{2: 10}')
+      string_eq('{"2": [{}]}', '{2: [{}]}')
       string_eq('1', '1')
       string_eq('0.0', '0.0')
       string_eq('inf', '(1.0/0.0)')
@@ -422,7 +401,6 @@ describe('autoload/msgpack.vim', function()
       nvim_command('let spflt = ' .. sp('float', '1.0'))
       nvim_command('let spext = ' .. sp('ext', '[2, ["abc", "def"]]'))
       nvim_command('let spstr = ' .. sp('string', '["abc", "def"]'))
-      nvim_command('let spbin = ' .. sp('binary', '["abc", "def"]'))
       nvim_command('let spbln = ' .. sp('boolean', '0'))
       nvim_command('let spnil = ' .. sp('nil', '0'))
 
@@ -432,7 +410,6 @@ describe('autoload/msgpack.vim', function()
       nvim_command('let spflt2 = msgpack#deepcopy(spflt)')
       nvim_command('let spext2 = msgpack#deepcopy(spext)')
       nvim_command('let spstr2 = msgpack#deepcopy(spstr)')
-      nvim_command('let spbin2 = msgpack#deepcopy(spbin)')
       nvim_command('let spbln2 = msgpack#deepcopy(spbln)')
       nvim_command('let spnil2 = msgpack#deepcopy(spnil)')
 
@@ -442,7 +419,6 @@ describe('autoload/msgpack.vim', function()
       eq('float', nvim_eval('msgpack#type(spflt2)'))
       eq('ext', nvim_eval('msgpack#type(spext2)'))
       eq('string', nvim_eval('msgpack#type(spstr2)'))
-      eq('binary', nvim_eval('msgpack#type(spbin2)'))
       eq('boolean', nvim_eval('msgpack#type(spbln2)'))
       eq('nil', nvim_eval('msgpack#type(spnil2)'))
 
@@ -457,7 +433,6 @@ describe('autoload/msgpack.vim', function()
       nvim_command('let spext._VAL[0] = 3')
       nvim_command('let spext._VAL[1][0] = "gh"')
       nvim_command('let spstr._VAL[0] = "gh"')
-      nvim_command('let spbin._VAL[0] = "gh"')
       nvim_command('let spbln._VAL = 1')
       nvim_command('let spnil._VAL = 1')
 
@@ -467,7 +442,6 @@ describe('autoload/msgpack.vim', function()
       eq({ _TYPE = {}, _VAL = 1.0 }, nvim_eval('spflt2'))
       eq({ _TYPE = {}, _VAL = { 2, { 'abc', 'def' } } }, nvim_eval('spext2'))
       eq({ _TYPE = {}, _VAL = { 'abc', 'def' } }, nvim_eval('spstr2'))
-      eq({ _TYPE = {}, _VAL = { 'abc', 'def' } }, nvim_eval('spbin2'))
       eq({ _TYPE = {}, _VAL = 0 }, nvim_eval('spbln2'))
       eq({ _TYPE = {}, _VAL = 0 }, nvim_eval('spnil2'))
 
@@ -477,7 +451,6 @@ describe('autoload/msgpack.vim', function()
       nvim_command('let spflt._TYPE = []')
       nvim_command('let spext._TYPE = []')
       nvim_command('let spstr._TYPE = []')
-      nvim_command('let spbin._TYPE = []')
       nvim_command('let spbln._TYPE = []')
       nvim_command('let spnil._TYPE = []')
 
@@ -487,7 +460,6 @@ describe('autoload/msgpack.vim', function()
       eq('float', nvim_eval('msgpack#special_type(spflt2)'))
       eq('ext', nvim_eval('msgpack#special_type(spext2)'))
       eq('string', nvim_eval('msgpack#special_type(spstr2)'))
-      eq('binary', nvim_eval('msgpack#special_type(spbin2)'))
       eq('boolean', nvim_eval('msgpack#special_type(spbln2)'))
       eq('nil', nvim_eval('msgpack#special_type(spnil2)'))
     end)
@@ -509,7 +481,7 @@ describe('autoload/msgpack.vim', function()
       eq('map', nvim_eval('msgpack#type(map2)'))
       eq('integer', nvim_eval('msgpack#type(int2)'))
       eq('float', nvim_eval('msgpack#type(flt2)'))
-      eq('binary', nvim_eval('msgpack#type(bin2)'))
+      eq('string', nvim_eval('msgpack#type(bin2)'))
 
       nvim_command('call add(arr, 0)')
       nvim_command('call add(arr[0], 0)')
@@ -566,21 +538,6 @@ describe('autoload/msgpack.vim', function()
       nvim_command('unlet g:__val')
     end
 
-    it('correctly loads binary strings', function()
-      eval_eq('binary', { 'abcdef' }, '"abcdef"')
-      eval_eq('binary', { 'abc', 'def' }, '"abc\\ndef"')
-      eval_eq('binary', { 'abc\ndef' }, '"abc\\0def"')
-      eval_eq('binary', { '\nabc\ndef\n' }, '"\\0abc\\0def\\0"')
-      eval_eq('binary', { 'abc\n\n\ndef' }, '"abc\\0\\0\\0def"')
-      eval_eq('binary', { 'abc\n', '\ndef' }, '"abc\\0\\n\\0def"')
-      eval_eq('binary', { 'abc', '', '', 'def' }, '"abc\\n\\n\\ndef"')
-      eval_eq('binary', { 'abc', '', '', 'def', '' }, '"abc\\n\\n\\ndef\\n"')
-      eval_eq('binary', { '', 'abc', '', '', 'def' }, '"\\nabc\\n\\n\\ndef"')
-      eval_eq('binary', { '' }, '""')
-      eval_eq('binary', { '"' }, '"\\""')
-      eval_eq('binary', { 'py3 print(sys.version_info)' }, '"py3 print(sys.version_info)"')
-    end)
-
     it('correctly loads strings', function()
       eval_eq('string', { 'abcdef' }, '="abcdef"')
       eval_eq('string', { 'abc', 'def' }, '="abc\\ndef"')