blob: d695456a88191460e933fac83c614cd49f33cd1b [file] [log] [blame]
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +02001" Tests for fuzzy matching
2
3source shared.vim
4source check.vim
5
6" Test for matchfuzzy()
7func Test_matchfuzzy()
8 call assert_fails('call matchfuzzy(10, "abc")', 'E686:')
9 call assert_fails('call matchfuzzy(["abc"], [])', 'E730:')
10 call assert_fails("let x = matchfuzzy(test_null_list(), 'foo')", 'E686:')
11 call assert_fails('call matchfuzzy(["abc"], test_null_string())', 'E475:')
12 call assert_equal([], matchfuzzy([], 'abc'))
13 call assert_equal([], matchfuzzy(['abc'], ''))
14 call assert_equal(['abc'], matchfuzzy(['abc', 10], 'ac'))
15 call assert_equal([], matchfuzzy([10, 20], 'ac'))
16 call assert_equal(['abc'], matchfuzzy(['abc'], 'abc'))
17 call assert_equal(['crayon', 'camera'], matchfuzzy(['camera', 'crayon'], 'cra'))
18 call assert_equal(['aabbaa', 'aaabbbaaa', 'aaaabbbbaaaa', 'aba'], matchfuzzy(['aba', 'aabbaa', 'aaabbbaaa', 'aaaabbbbaaaa'], 'aa'))
19 call assert_equal(['one'], matchfuzzy(['one', 'two'], 'one'))
20 call assert_equal(['oneTwo', 'onetwo'], matchfuzzy(['onetwo', 'oneTwo'], 'oneTwo'))
Bram Moolenaare9f9f162020-10-20 19:01:30 +020021 call assert_equal(['onetwo', 'one_two'], matchfuzzy(['onetwo', 'one_two'], 'oneTwo'))
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +020022 call assert_equal(['aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'], matchfuzzy(['aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'], 'aa'))
23 call assert_equal(256, matchfuzzy([repeat('a', 256)], repeat('a', 256))[0]->len())
24 call assert_equal([], matchfuzzy([repeat('a', 300)], repeat('a', 257)))
Bram Moolenaar8ded5b62020-10-23 16:50:30 +020025 " matches with same score should not be reordered
26 let l = ['abc1', 'abc2', 'abc3']
27 call assert_equal(l, l->matchfuzzy('abc'))
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +020028
29 " Tests for match preferences
30 " preference for camel case match
31 call assert_equal(['oneTwo', 'onetwo'], ['onetwo', 'oneTwo']->matchfuzzy('onetwo'))
32 " preference for match after a separator (_ or space)
Bram Moolenaar8ded5b62020-10-23 16:50:30 +020033 call assert_equal(['onetwo', 'one_two', 'one two'], ['onetwo', 'one_two', 'one two']->matchfuzzy('onetwo'))
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +020034 " preference for leading letter match
35 call assert_equal(['onetwo', 'xonetwo'], ['xonetwo', 'onetwo']->matchfuzzy('onetwo'))
36 " preference for sequential match
37 call assert_equal(['onetwo', 'oanbectdweo'], ['oanbectdweo', 'onetwo']->matchfuzzy('onetwo'))
38 " non-matching leading letter(s) penalty
39 call assert_equal(['xonetwo', 'xxonetwo'], ['xxonetwo', 'xonetwo']->matchfuzzy('onetwo'))
40 " total non-matching letter(s) penalty
41 call assert_equal(['one', 'onex', 'onexx'], ['onexx', 'one', 'onex']->matchfuzzy('one'))
Bram Moolenaare9f9f162020-10-20 19:01:30 +020042 " prefer complete matches over separator matches
43 call assert_equal(['.vim/vimrc', '.vim/vimrc_colors', '.vim/v_i_m_r_c'], ['.vim/vimrc', '.vim/vimrc_colors', '.vim/v_i_m_r_c']->matchfuzzy('vimrc'))
Bram Moolenaar8ded5b62020-10-23 16:50:30 +020044 " gap penalty
45 call assert_equal(['xxayybxxxx', 'xxayyybxxx', 'xxayyyybxx'], ['xxayyyybxx', 'xxayyybxxx', 'xxayybxxxx']->matchfuzzy('ab'))
Bram Moolenaardcdd42a2020-10-29 18:58:01 +010046 " path separator vs word separator
47 call assert_equal(['color/setup.vim', 'color\\setup.vim', 'color setup.vim', 'color_setup.vim', 'colorsetup.vim'], matchfuzzy(['colorsetup.vim', 'color setup.vim', 'color/setup.vim', 'color_setup.vim', 'color\\setup.vim'], 'setup.vim'))
Bram Moolenaar8ded5b62020-10-23 16:50:30 +020048
49 " match multiple words (separated by space)
50 call assert_equal(['foo bar baz'], ['foo bar baz', 'foo', 'foo bar', 'baz bar']->matchfuzzy('baz foo'))
51 call assert_equal([], ['foo bar baz', 'foo', 'foo bar', 'baz bar']->matchfuzzy('one two'))
52 call assert_equal([], ['foo bar']->matchfuzzy(" \t "))
53
54 " test for matching a sequence of words
55 call assert_equal(['bar foo'], ['foo bar', 'bar foo', 'foobar', 'barfoo']->matchfuzzy('bar foo', {'matchseq' : 1}))
56 call assert_equal([#{text: 'two one'}], [#{text: 'one two'}, #{text: 'two one'}]->matchfuzzy('two one', #{key: 'text', matchseq: v:true}))
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +020057
58 %bw!
59 eval ['somebuf', 'anotherone', 'needle', 'yetanotherone']->map({_, v -> bufadd(v) + bufload(v)})
60 let l = getbufinfo()->map({_, v -> v.name})->matchfuzzy('ndl')
61 call assert_equal(1, len(l))
62 call assert_match('needle', l[0])
63
Bram Moolenaar8ded5b62020-10-23 16:50:30 +020064 " Test for fuzzy matching dicts
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +020065 let l = [{'id' : 5, 'val' : 'crayon'}, {'id' : 6, 'val' : 'camera'}]
66 call assert_equal([{'id' : 6, 'val' : 'camera'}], matchfuzzy(l, 'cam', {'text_cb' : {v -> v.val}}))
67 call assert_equal([{'id' : 6, 'val' : 'camera'}], matchfuzzy(l, 'cam', {'key' : 'val'}))
68 call assert_equal([], matchfuzzy(l, 'day', {'text_cb' : {v -> v.val}}))
69 call assert_equal([], matchfuzzy(l, 'day', {'key' : 'val'}))
70 call assert_fails("let x = matchfuzzy(l, 'cam', 'random')", 'E715:')
71 call assert_equal([], matchfuzzy(l, 'day', {'text_cb' : {v -> []}}))
72 call assert_equal([], matchfuzzy(l, 'day', {'text_cb' : {v -> 1}}))
73 call assert_fails("let x = matchfuzzy(l, 'day', {'text_cb' : {a, b -> 1}})", 'E119:')
74 call assert_equal([], matchfuzzy(l, 'cam'))
75 call assert_fails("let x = matchfuzzy(l, 'cam', {'text_cb' : []})", 'E921:')
76 call assert_fails("let x = matchfuzzy(l, 'foo', {'key' : []})", 'E730:')
77 call assert_fails("let x = matchfuzzy(l, 'cam', test_null_dict())", 'E715:')
78 call assert_fails("let x = matchfuzzy(l, 'foo', {'key' : test_null_string()})", 'E475:')
79 call assert_fails("let x = matchfuzzy(l, 'foo', {'text_cb' : test_null_function()})", 'E475:')
Bram Moolenaar8ded5b62020-10-23 16:50:30 +020080 " matches with same score should not be reordered
81 let l = [#{text: 'abc', id: 1}, #{text: 'abc', id: 2}, #{text: 'abc', id: 3}]
82 call assert_equal(l, l->matchfuzzy('abc', #{key: 'text'}))
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +020083
84 let l = [{'id' : 5, 'name' : 'foo'}, {'id' : 6, 'name' : []}, {'id' : 7}]
85 call assert_fails("let x = matchfuzzy(l, 'foo', {'key' : 'name'})", 'E730:')
86
87 " Test in latin1 encoding
88 let save_enc = &encoding
89 set encoding=latin1
90 call assert_equal(['abc'], matchfuzzy(['abc'], 'abc'))
91 let &encoding = save_enc
92endfunc
93
Bram Moolenaar8ded5b62020-10-23 16:50:30 +020094" Test for the matchfuzzypos() function
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +020095func Test_matchfuzzypos()
96 call assert_equal([['curl', 'world'], [[2,3], [2,3]]], matchfuzzypos(['world', 'curl'], 'rl'))
97 call assert_equal([['curl', 'world'], [[2,3], [2,3]]], matchfuzzypos(['world', 'one', 'curl'], 'rl'))
98 call assert_equal([['hello', 'hello world hello world'],
99 \ [[0, 1, 2, 3, 4], [0, 1, 2, 3, 4]]],
100 \ matchfuzzypos(['hello world hello world', 'hello', 'world'], 'hello'))
101 call assert_equal([['aaaaaaa'], [[0, 1, 2]]], matchfuzzypos(['aaaaaaa'], 'aaa'))
Bram Moolenaar8ded5b62020-10-23 16:50:30 +0200102 call assert_equal([['a b'], [[0, 3]]], matchfuzzypos(['a b'], 'a b'))
103 call assert_equal([['a b'], [[0, 3]]], matchfuzzypos(['a b'], 'a b'))
104 call assert_equal([['a b'], [[0]]], matchfuzzypos(['a b'], ' a '))
105 call assert_equal([[], []], matchfuzzypos(['a b'], ' '))
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +0200106 call assert_equal([[], []], matchfuzzypos(['world', 'curl'], 'ab'))
107 let x = matchfuzzypos([repeat('a', 256)], repeat('a', 256))
108 call assert_equal(range(256), x[1][0])
109 call assert_equal([[], []], matchfuzzypos([repeat('a', 300)], repeat('a', 257)))
110 call assert_equal([[], []], matchfuzzypos([], 'abc'))
111
112 " match in a long string
113 call assert_equal([[repeat('x', 300) .. 'abc'], [[300, 301, 302]]],
114 \ matchfuzzypos([repeat('x', 300) .. 'abc'], 'abc'))
115
116 " preference for camel case match
117 call assert_equal([['xabcxxaBc'], [[6, 7, 8]]], matchfuzzypos(['xabcxxaBc'], 'abc'))
118 " preference for match after a separator (_ or space)
119 call assert_equal([['xabx_ab'], [[5, 6]]], matchfuzzypos(['xabx_ab'], 'ab'))
120 " preference for leading letter match
121 call assert_equal([['abcxabc'], [[0, 1]]], matchfuzzypos(['abcxabc'], 'ab'))
122 " preference for sequential match
123 call assert_equal([['aobncedone'], [[7, 8, 9]]], matchfuzzypos(['aobncedone'], 'one'))
124 " best recursive match
125 call assert_equal([['xoone'], [[2, 3, 4]]], matchfuzzypos(['xoone'], 'one'))
126
Bram Moolenaar8ded5b62020-10-23 16:50:30 +0200127 " match multiple words (separated by space)
128 call assert_equal([['foo bar baz'], [[8, 9, 10, 0, 1, 2]]], ['foo bar baz', 'foo', 'foo bar', 'baz bar']->matchfuzzypos('baz foo'))
129 call assert_equal([[], []], ['foo bar baz', 'foo', 'foo bar', 'baz bar']->matchfuzzypos('one two'))
130 call assert_equal([[], []], ['foo bar']->matchfuzzypos(" \t "))
131 call assert_equal([['grace'], [[1, 2, 3, 4, 2, 3, 4, 0, 1, 2, 3, 4]]], ['grace']->matchfuzzypos('race ace grace'))
132
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +0200133 let l = [{'id' : 5, 'val' : 'crayon'}, {'id' : 6, 'val' : 'camera'}]
134 call assert_equal([[{'id' : 6, 'val' : 'camera'}], [[0, 1, 2]]],
135 \ matchfuzzypos(l, 'cam', {'text_cb' : {v -> v.val}}))
136 call assert_equal([[{'id' : 6, 'val' : 'camera'}], [[0, 1, 2]]],
137 \ matchfuzzypos(l, 'cam', {'key' : 'val'}))
138 call assert_equal([[], []], matchfuzzypos(l, 'day', {'text_cb' : {v -> v.val}}))
139 call assert_equal([[], []], matchfuzzypos(l, 'day', {'key' : 'val'}))
140 call assert_fails("let x = matchfuzzypos(l, 'cam', 'random')", 'E715:')
141 call assert_equal([[], []], matchfuzzypos(l, 'day', {'text_cb' : {v -> []}}))
142 call assert_equal([[], []], matchfuzzypos(l, 'day', {'text_cb' : {v -> 1}}))
143 call assert_fails("let x = matchfuzzypos(l, 'day', {'text_cb' : {a, b -> 1}})", 'E119:')
144 call assert_equal([[], []], matchfuzzypos(l, 'cam'))
145 call assert_fails("let x = matchfuzzypos(l, 'cam', {'text_cb' : []})", 'E921:')
146 call assert_fails("let x = matchfuzzypos(l, 'foo', {'key' : []})", 'E730:')
147 call assert_fails("let x = matchfuzzypos(l, 'cam', test_null_dict())", 'E715:')
148 call assert_fails("let x = matchfuzzypos(l, 'foo', {'key' : test_null_string()})", 'E475:')
149 call assert_fails("let x = matchfuzzypos(l, 'foo', {'text_cb' : test_null_function()})", 'E475:')
150
151 let l = [{'id' : 5, 'name' : 'foo'}, {'id' : 6, 'name' : []}, {'id' : 7}]
152 call assert_fails("let x = matchfuzzypos(l, 'foo', {'key' : 'name'})", 'E730:')
153endfunc
154
Bram Moolenaar8ded5b62020-10-23 16:50:30 +0200155" Test for matchfuzzy() with multibyte characters
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +0200156func Test_matchfuzzy_mbyte()
157 CheckFeature multi_lang
158 call assert_equal(['ンヹㄇヺヴ'], matchfuzzy(['ンヹㄇヺヴ'], 'ヹヺ'))
159 " reverse the order of characters
160 call assert_equal([], matchfuzzy(['ンヹㄇヺヴ'], 'ヺヹ'))
161 call assert_equal(['αβΩxxx', 'xαxβxΩx'],
162 \ matchfuzzy(['αβΩxxx', 'xαxβxΩx'], 'αβΩ'))
163 call assert_equal(['ππbbππ', 'πππbbbπππ', 'ππππbbbbππππ', 'πbπ'],
164 \ matchfuzzy(['πbπ', 'ππbbππ', 'πππbbbπππ', 'ππππbbbbππππ'], 'ππ'))
165
Bram Moolenaar8ded5b62020-10-23 16:50:30 +0200166 " match multiple words (separated by space)
167 call assert_equal(['세 마리의 작은 돼지'], ['세 마리의 작은 돼지', '마리의', '마리의 작은', '작은 돼지']->matchfuzzy('돼지 마리의'))
168 call assert_equal([], ['세 마리의 작은 돼지', '마리의', '마리의 작은', '작은 돼지']->matchfuzzy('파란 하늘'))
169
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +0200170 " preference for camel case match
171 call assert_equal(['oneĄwo', 'oneąwo'],
172 \ ['oneąwo', 'oneĄwo']->matchfuzzy('oneąwo'))
Bram Moolenaare9f9f162020-10-20 19:01:30 +0200173 " preference for complete match then match after separator (_ or space)
Bram Moolenaar8ded5b62020-10-23 16:50:30 +0200174 call assert_equal(['ⅠⅡabㄟㄠ'] + sort(['ⅠⅡa_bㄟㄠ', 'ⅠⅡa bㄟㄠ']),
Bram Moolenaare9f9f162020-10-20 19:01:30 +0200175 \ ['ⅠⅡabㄟㄠ', 'ⅠⅡa bㄟㄠ', 'ⅠⅡa_bㄟㄠ']->matchfuzzy('ⅠⅡabㄟㄠ'))
Bram Moolenaar8ded5b62020-10-23 16:50:30 +0200176 " preference for match after a separator (_ or space)
177 call assert_equal(['ㄓㄔabㄟㄠ', 'ㄓㄔa_bㄟㄠ', 'ㄓㄔa bㄟㄠ'],
178 \ ['ㄓㄔa_bㄟㄠ', 'ㄓㄔa bㄟㄠ', 'ㄓㄔabㄟㄠ']->matchfuzzy('ㄓㄔabㄟㄠ'))
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +0200179 " preference for leading letter match
180 call assert_equal(['ŗŝţũŵż', 'xŗŝţũŵż'],
181 \ ['xŗŝţũŵż', 'ŗŝţũŵż']->matchfuzzy('ŗŝţũŵż'))
182 " preference for sequential match
183 call assert_equal(['ㄞㄡㄤfffifl', 'ㄞaㄡbㄤcffdfiefl'],
184 \ ['ㄞaㄡbㄤcffdfiefl', 'ㄞㄡㄤfffifl']->matchfuzzy('ㄞㄡㄤfffifl'))
185 " non-matching leading letter(s) penalty
186 call assert_equal(['xㄞㄡㄤfffifl', 'xxㄞㄡㄤfffifl'],
187 \ ['xxㄞㄡㄤfffifl', 'xㄞㄡㄤfffifl']->matchfuzzy('ㄞㄡㄤfffifl'))
188 " total non-matching letter(s) penalty
189 call assert_equal(['ŗŝţ', 'ŗŝţx', 'ŗŝţxx'],
190 \ ['ŗŝţxx', 'ŗŝţ', 'ŗŝţx']->matchfuzzy('ŗŝţ'))
191endfunc
192
Bram Moolenaar8ded5b62020-10-23 16:50:30 +0200193" Test for matchfuzzypos() with multibyte characters
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +0200194func Test_matchfuzzypos_mbyte()
195 CheckFeature multi_lang
196 call assert_equal([['こんにちは世界'], [[0, 1, 2, 3, 4]]],
197 \ matchfuzzypos(['こんにちは世界'], 'こんにちは'))
198 call assert_equal([['ンヹㄇヺヴ'], [[1, 3]]], matchfuzzypos(['ンヹㄇヺヴ'], 'ヹヺ'))
199 " reverse the order of characters
200 call assert_equal([[], []], matchfuzzypos(['ンヹㄇヺヴ'], 'ヺヹ'))
201 call assert_equal([['αβΩxxx', 'xαxβxΩx'], [[0, 1, 2], [1, 3, 5]]],
202 \ matchfuzzypos(['αβΩxxx', 'xαxβxΩx'], 'αβΩ'))
203 call assert_equal([['ππbbππ', 'πππbbbπππ', 'ππππbbbbππππ', 'πbπ'],
204 \ [[0, 1], [0, 1], [0, 1], [0, 2]]],
205 \ matchfuzzypos(['πbπ', 'ππbbππ', 'πππbbbπππ', 'ππππbbbbππππ'], 'ππ'))
206 call assert_equal([['ααααααα'], [[0, 1, 2]]],
207 \ matchfuzzypos(['ααααααα'], 'ααα'))
208
209 call assert_equal([[], []], matchfuzzypos(['ンヹㄇ', 'ŗŝţ'], 'fffifl'))
210 let x = matchfuzzypos([repeat('Ψ', 256)], repeat('Ψ', 256))
211 call assert_equal(range(256), x[1][0])
212 call assert_equal([[], []], matchfuzzypos([repeat('✓', 300)], repeat('✓', 257)))
213
Bram Moolenaar8ded5b62020-10-23 16:50:30 +0200214 " match multiple words (separated by space)
215 call assert_equal([['세 마리의 작은 돼지'], [[9, 10, 2, 3, 4]]], ['세 마리의 작은 돼지', '마리의', '마리의 작은', '작은 돼지']->matchfuzzypos('돼지 마리의'))
216 call assert_equal([[], []], ['세 마리의 작은 돼지', '마리의', '마리의 작은', '작은 돼지']->matchfuzzypos('파란 하늘'))
217
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +0200218 " match in a long string
Bram Moolenaar8ded5b62020-10-23 16:50:30 +0200219 call assert_equal([[repeat('ぶ', 300) .. 'ẼẼẼ'], [[300, 301, 302]]],
220 \ matchfuzzypos([repeat('ぶ', 300) .. 'ẼẼẼ'], 'ẼẼẼ'))
Bram Moolenaar4f73b8e2020-09-22 20:33:50 +0200221 " preference for camel case match
222 call assert_equal([['xѳѵҁxxѳѴҁ'], [[6, 7, 8]]], matchfuzzypos(['xѳѵҁxxѳѴҁ'], 'ѳѵҁ'))
223 " preference for match after a separator (_ or space)
224 call assert_equal([['xちだx_ちだ'], [[5, 6]]], matchfuzzypos(['xちだx_ちだ'], 'ちだ'))
225 " preference for leading letter match
226 call assert_equal([['ѳѵҁxѳѵҁ'], [[0, 1]]], matchfuzzypos(['ѳѵҁxѳѵҁ'], 'ѳѵ'))
227 " preference for sequential match
228 call assert_equal([['aンbヹcㄇdンヹㄇ'], [[7, 8, 9]]], matchfuzzypos(['aンbヹcㄇdンヹㄇ'], 'ンヹㄇ'))
229 " best recursive match
230 call assert_equal([['xффйд'], [[2, 3, 4]]], matchfuzzypos(['xффйд'], 'фйд'))
231endfunc
232
233" vim: shiftwidth=2 sts=2 expandtab