Repository navigation
Expand file tree
/
Copy pathtest_pick.lua
More file actions
5134 lines (4115 loc) · 161 KB
/
Copy pathtest_pick.lua
File metadata and controls
5134 lines (4115 loc) · 161 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
local helpers = dofile('tests/helpers.lua')
local child = helpers.new_child_neovim()
local expect, eq = helpers.expect, helpers.expect.equality
local new_set = MiniTest.new_set
-- Helpers with child processes
--stylua: ignore start
local load_module = function(config) child.mini_load('pick', config) end
local unload_module = function() child.mini_unload('pick') end
local set_cursor = function(...) return child.set_cursor(...) end
local get_cursor = function(...) return child.get_cursor(...) end
local type_keys = function(...) return child.type_keys(...) end
local poke_eventloop = function() child.api.nvim_eval('1') end
local sleep = function(ms) vim.loop.sleep(ms); poke_eventloop() end
--stylua: ignore end
-- Tweak `expect_screenshot()` to test only on Neovim=0.9 (as it introduced
-- titles and 0.10 introduced footer).
-- Use `child.expect_screenshot_orig()` for original testing.
child.expect_screenshot_orig = child.expect_screenshot
child.expect_screenshot = function(opts, allow_past_09)
-- TODO: Regenerate all screenshots with 0.10 after its stable release
if child.fn.has('nvim-0.9') == 0 or child.fn.has('nvim-0.10') == 1 then return end
child.expect_screenshot_orig(opts)
end
child.has_float_footer = function()
-- https://github.com/neovim/neovim/pull/24739
return child.fn.has('nvim-0.10') == 1
end
-- Test paths helpers
local test_dir = 'tests/dir-pick'
local real_files_dir = 'tests/dir-pick/real-files'
local join_path = function(...) return table.concat({ ... }, '/') end
local full_path = function(x)
local res = vim.fn.fnamemodify(x, ':p'):gsub('/$', '')
return res
end
local real_file = function(basename) return join_path(real_files_dir, basename) end
local setup_windows_pair = function()
child.cmd('botright wincmd v')
local win_id_1 = child.api.nvim_get_current_win()
child.cmd('wincmd h')
local win_id_2 = child.api.nvim_get_current_win()
child.api.nvim_set_current_win(win_id_1)
return win_id_1, win_id_2
end
-- Common test wrappers
local forward_lua = function(fun_str)
local lua_cmd = fun_str .. '(...)'
return function(...) return child.lua_get(lua_cmd, { ... }) end
end
local forward_lua_notify = function(fun_str)
local lua_cmd = fun_str .. '(...)'
return function(...) return child.lua_notify(lua_cmd, { ... }) end
end
local stop = forward_lua('MiniPick.stop')
local get_picker_items = forward_lua('MiniPick.get_picker_items')
local get_picker_stritems = forward_lua('MiniPick.get_picker_stritems')
local get_picker_matches = forward_lua('MiniPick.get_picker_matches')
local get_picker_state = forward_lua('MiniPick.get_picker_state')
local get_picker_query = forward_lua('MiniPick.get_picker_query')
local set_picker_items = forward_lua('MiniPick.set_picker_items')
local set_picker_query = forward_lua('MiniPick.set_picker_query')
local get_querytick = forward_lua('MiniPick.get_querytick')
local is_picker_active = forward_lua('MiniPick.is_picker_active')
-- Use `child.api_notify` to allow user input while child process awaits for
-- `start()` to return a value
local start = function(...) child.lua_notify('MiniPick.start(...)', { ... }) end
local start_with_items = function(items, name) start({ source = { items = items, name = name } }) end
-- Common test helpers
local validate_buf_option =
function(buf_id, option_name, option_value) eq(child.api.nvim_buf_get_option(buf_id, option_name), option_value) end
local validate_win_option =
function(win_id, option_name, option_value) eq(child.api.nvim_win_get_option(win_id, option_name), option_value) end
local validate_buf_name = function(buf_id, name)
buf_id = buf_id or child.api.nvim_get_current_buf()
name = name ~= '' and full_path(name) or ''
name = name:gsub('/+$', '')
eq(child.api.nvim_buf_get_name(buf_id), name)
end
local validate_contains_all = function(base, to_be_present)
local is_present_map, is_all_present = {}, true
for _, x in pairs(to_be_present) do
is_present_map[x] = vim.tbl_contains(base, x)
is_all_present = is_all_present and is_present_map[x]
end
if is_all_present then return end
local err_msg = string.format(
'Not all elements are present:\nActual: %s\nReference map: %s',
vim.inspect(base),
vim.inspect(is_present_map)
)
error(err_msg)
end
local validate_picker_option = function(string_index, ref)
local value = child.lua_get('MiniPick.get_picker_opts().' .. string_index)
eq(value, ref)
end
local validate_picker_view =
function(view_name) eq(child.api.nvim_get_current_buf(), get_picker_state().buffers[view_name]) end
local validate_current_ind = function(ref_ind) eq(get_picker_matches().current_ind, ref_ind) end
local seq_along = function(x)
local res = {}
for i = 1, #x do
res[i] = i
end
return res
end
local make_match_with_count = function()
child.lua('_G.match_n_calls = 0')
local validate_match_calls = function(n_calls_ref, match_inds_ref)
eq(child.lua_get('_G.match_n_calls'), n_calls_ref)
eq(get_picker_matches().all_inds, match_inds_ref)
end
child.lua_notify([[_G.match_with_count = function(...)
_G.match_n_calls = _G.match_n_calls + 1
return MiniPick.default_match(...)
end]])
return validate_match_calls
end
local make_event_log = function()
child.lua([[
_G.event_log = {}
_G.track_event = function()
local buf_id = MiniPick.get_picker_state().buffers.main
local entry
if not vim.api.nvim_buf_is_valid(buf_id) then
entry = 'Main buffer is invalid'
else
entry = #vim.api.nvim_buf_get_lines(buf_id, 0, -1, false)
end
table.insert(_G.event_log, entry)
end]])
end
-- Common mocks
local mock_fn_executable = function(available_executables)
local lua_cmd = string.format(
'vim.fn.executable = function(x) return vim.tbl_contains(%s, x) and 1 or 0 end',
vim.inspect(available_executables)
)
child.lua(lua_cmd)
end
local mock_picker_cwd = function(cwd)
child.lua('vim.fn.fnamemodify = function(x) return x end')
child.lua(string.format('MiniPick.set_picker_opts({ source = { cwd = %s } })', vim.inspect(cwd)))
end
local mock_spawn = function()
local mock_file = join_path(test_dir, 'mocks', 'spawn.lua')
local lua_cmd = string.format('dofile(%s)', vim.inspect(mock_file))
child.lua(lua_cmd)
end
local mock_stdout_feed = function(feed) child.lua('_G.stdout_data_feed = ' .. vim.inspect(feed)) end
local mock_cli_return = function(items) mock_stdout_feed({ table.concat(items, '\n') }) end
local get_spawn_log = function() return child.lua_get('_G.spawn_log') end
local clear_spawn_log = function() child.lua('_G.spawn_log = {}') end
local validate_spawn_log = function(ref, index)
local present = get_spawn_log()
if type(index) == 'number' then present = present[index] end
eq(present, ref)
end
local get_process_log = function() return child.lua_get('_G.process_log') end
local clear_process_log = function() child.lua('_G.process_log = {}') end
-- Data =======================================================================
local test_items = { 'a_b_c', 'abc', 'a_b_b', 'c_a_a', 'b_c_c' }
local many_items = {}
for i = 1, 1000000 do
many_items[3 * i - 2] = 'ab'
many_items[3 * i - 1] = 'ac'
many_items[3 * i] = 'bb'
end
-- Output test set ============================================================
local T = new_set({
hooks = {
pre_case = function()
child.setup()
-- Make more comfortable screenshots
child.set_size(15, 40)
child.o.laststatus = 0
child.o.ruler = false
load_module()
-- Make border differentiable in screenshots
child.cmd('hi MiniPickBorder ctermfg=2')
end,
post_once = child.stop,
},
})
-- Unit tests =================================================================
T['setup()'] = new_set()
T['setup()']['creates side effects'] = function()
-- Global variable
eq(child.lua_get('type(_G.MiniPick)'), 'table')
-- Autocommand group
eq(child.fn.exists('#MiniPick'), 1)
-- Highlight groups
local validate_hl_group = function(name, ref) expect.match(child.cmd_capture('hi ' .. name), ref) end
-- - Make sure to clear highlight groups defined for better screenshots
child.cmd('hi clear MiniPickBorder')
load_module()
validate_hl_group('MiniPickBorder', 'links to FloatBorder')
validate_hl_group('MiniPickBorderBusy', 'links to DiagnosticFloatingWarn')
validate_hl_group('MiniPickBorderText', 'links to FloatTitle')
validate_hl_group('MiniPickIconDirectory', 'links to Directory')
validate_hl_group('MiniPickIconFile', 'links to MiniPickNormal')
validate_hl_group('MiniPickHeader', 'links to DiagnosticFloatingHint')
validate_hl_group('MiniPickMatchCurrent', 'links to CursorLine')
validate_hl_group('MiniPickMatchMarked', 'links to Visual')
validate_hl_group('MiniPickMatchRanges', 'links to DiagnosticFloatingHint')
validate_hl_group('MiniPickNormal', 'links to NormalFloat')
validate_hl_group('MiniPickPreviewLine', 'links to CursorLine')
validate_hl_group('MiniPickPreviewRegion', 'links to IncSearch')
validate_hl_group('MiniPickPrompt', 'links to DiagnosticFloatingInfo')
end
T['setup()']['creates `config` field'] = function()
eq(child.lua_get('type(_G.MiniPick.config)'), 'table')
-- Check default values
local expect_config = function(field, value) eq(child.lua_get('MiniPick.config.' .. field), value) end
expect_config('delay.async', 10)
expect_config('delay.busy', 50)
expect_config('mappings.caret_left', '<Left>')
expect_config('mappings.caret_right', '<Right>')
expect_config('mappings.choose', '<CR>')
expect_config('mappings.choose_in_split', '<C-s>')
expect_config('mappings.choose_in_tabpage', '<C-t>')
expect_config('mappings.choose_in_vsplit', '<C-v>')
expect_config('mappings.choose_marked', '<M-CR>')
expect_config('mappings.delete_char', '<BS>')
expect_config('mappings.delete_char_right', '<Del>')
expect_config('mappings.delete_left', '<C-u>')
expect_config('mappings.delete_word', '<C-w>')
expect_config('mappings.mark', '<C-x>')
expect_config('mappings.mark_all', '<C-a>')
expect_config('mappings.move_down', '<C-n>')
expect_config('mappings.move_start', '<C-g>')
expect_config('mappings.move_up', '<C-p>')
expect_config('mappings.paste', '<C-r>')
expect_config('mappings.refine', '<C-Space>')
expect_config('mappings.refine_marked', '<M-Space>')
expect_config('mappings.scroll_down', '<C-f>')
expect_config('mappings.scroll_left', '<C-h>')
expect_config('mappings.scroll_right', '<C-l>')
expect_config('mappings.scroll_up', '<C-b>')
expect_config('mappings.stop', '<Esc>')
expect_config('mappings.toggle_info', '<S-Tab>')
expect_config('mappings.toggle_preview', '<Tab>')
expect_config('options.content_from_bottom', false)
expect_config('options.use_cache', false)
expect_config('source.items', vim.NIL)
expect_config('source.name', vim.NIL)
expect_config('source.cwd', vim.NIL)
expect_config('source.match', vim.NIL)
expect_config('source.show', vim.NIL)
expect_config('source.preview', vim.NIL)
expect_config('source.choose', vim.NIL)
expect_config('source.choose_marked', vim.NIL)
expect_config('window.config', vim.NIL)
end
T['setup()']['respects `config` argument'] = function()
unload_module()
load_module({ options = { use_cache = true } })
eq(child.lua_get('MiniPick.config.options.use_cache'), true)
end
T['setup()']['validates `config` argument'] = function()
unload_module()
local expect_config_error = function(config, name, target_type)
expect.error(load_module, vim.pesc(name) .. '.*' .. vim.pesc(target_type), config)
end
expect_config_error('a', 'config', 'table')
expect_config_error({ delay = 'a' }, 'delay', 'table')
expect_config_error({ delay = { async = 'a' } }, 'delay.async', 'number')
expect_config_error({ delay = { busy = 'a' } }, 'delay.busy', 'number')
expect_config_error({ mappings = 'a' }, 'mappings', 'table')
expect_config_error({ mappings = { caret_left = 1 } }, 'mappings.caret_left', 'string')
expect_config_error({ mappings = { caret_right = 1 } }, 'mappings.caret_right', 'string')
expect_config_error({ mappings = { choose = 1 } }, 'mappings.choose', 'string')
expect_config_error({ mappings = { choose_in_split = 1 } }, 'mappings.choose_in_split', 'string')
expect_config_error({ mappings = { choose_in_tabpage = 1 } }, 'mappings.choose_in_tabpage', 'string')
expect_config_error({ mappings = { choose_in_vsplit = 1 } }, 'mappings.choose_in_vsplit', 'string')
expect_config_error({ mappings = { choose_marked = 1 } }, 'mappings.choose_marked', 'string')
expect_config_error({ mappings = { delete_char = 1 } }, 'mappings.delete_char', 'string')
expect_config_error({ mappings = { delete_char_right = 1 } }, 'mappings.delete_char_right', 'string')
expect_config_error({ mappings = { delete_left = 1 } }, 'mappings.delete_left', 'string')
expect_config_error({ mappings = { delete_word = 1 } }, 'mappings.delete_word', 'string')
expect_config_error({ mappings = { mark = 1 } }, 'mappings.mark', 'string')
expect_config_error({ mappings = { mark_all = 1 } }, 'mappings.mark_all', 'string')
expect_config_error({ mappings = { move_down = 1 } }, 'mappings.move_down', 'string')
expect_config_error({ mappings = { move_start = 1 } }, 'mappings.move_start', 'string')
expect_config_error({ mappings = { move_up = 1 } }, 'mappings.move_up', 'string')
expect_config_error({ mappings = { paste = 1 } }, 'mappings.paste', 'string')
expect_config_error({ mappings = { refine = 1 } }, 'mappings.refine', 'string')
expect_config_error({ mappings = { refine_marked = 1 } }, 'mappings.refine_marked', 'string')
expect_config_error({ mappings = { scroll_down = 1 } }, 'mappings.scroll_down', 'string')
expect_config_error({ mappings = { scroll_left = 1 } }, 'mappings.scroll_left', 'string')
expect_config_error({ mappings = { scroll_right = 1 } }, 'mappings.scroll_right', 'string')
expect_config_error({ mappings = { scroll_up = 1 } }, 'mappings.scroll_up', 'string')
expect_config_error({ mappings = { stop = 1 } }, 'mappings.stop', 'string')
expect_config_error({ mappings = { toggle_info = 1 } }, 'mappings.toggle_info', 'string')
expect_config_error({ mappings = { toggle_preview = 1 } }, 'mappings.toggle_preview', 'string')
expect_config_error({ options = 'a' }, 'options', 'table')
expect_config_error({ options = { content_from_bottom = 1 } }, 'options.content_from_bottom', 'boolean')
expect_config_error({ options = { use_cache = 1 } }, 'options.use_cache', 'boolean')
expect_config_error({ source = 'a' }, 'source', 'table')
expect_config_error({ source = { items = 1 } }, 'source.items', 'table')
expect_config_error({ source = { name = 1 } }, 'source.name', 'string')
expect_config_error({ source = { cwd = 1 } }, 'source.cwd', 'string')
expect_config_error({ source = { match = 1 } }, 'source.match', 'function')
expect_config_error({ source = { show = 1 } }, 'source.show', 'function')
expect_config_error({ source = { preview = 1 } }, 'source.preview', 'function')
expect_config_error({ source = { choose = 1 } }, 'source.choose', 'function')
expect_config_error({ source = { choose_marked = 1 } }, 'source.choose_marked', 'function')
expect_config_error({ window = 'a' }, 'window', 'table')
expect_config_error({ window = { config = 1 } }, 'window.config', 'table or callable')
end
-- This set mostly contains general function testing which doesn't fit into
-- more specialized integration tests later
T['start()'] = new_set()
T['start()']['works'] = function()
child.lua_notify('_G.picked_item = MiniPick.start(...)', { { source = { items = test_items } } })
child.expect_screenshot()
-- Should focus on floating window
eq(child.api.nvim_get_current_win(), get_picker_state().windows.main)
-- Should close window after an item and print it (as per `default_choose()`)
type_keys('<CR>')
child.expect_screenshot()
-- Should return picked value
eq(child.lua_get('_G.picked_item'), test_items[1])
end
T['start()']['returns `nil` when there is no current match'] = function()
child.lua_notify('_G.picked_item = MiniPick.start(...)', { { source = { items = test_items } } })
type_keys('x')
type_keys('<CR>')
eq(child.lua_get('_G.picked_item'), vim.NIL)
end
T['start()']['works with window footer'] = function()
-- TODO: Use this as primary test after support for Neovim<=0.9 is dropped
if not child.has_float_footer() then return end
child.lua_notify('_G.picked_item = MiniPick.start(...)', { { source = { items = test_items } } })
child.expect_screenshot_orig()
eq(child.api.nvim_get_current_win(), get_picker_state().windows.main)
type_keys('<CR>')
child.expect_screenshot_orig()
eq(child.lua_get('_G.picked_item'), test_items[1])
end
T['start()']['works on Neovim<0.9'] = function()
if child.fn.has('nvim-0.9') == 1 then return end
child.lua_notify('_G.picked_item = MiniPick.start(...)', { { source = { items = test_items } } })
child.expect_screenshot_orig()
-- Should focus on floating window
eq(child.api.nvim_get_current_win(), get_picker_state().windows.main)
-- Should close window after an item and print it (as per `default_choose()`)
type_keys('<CR>')
child.expect_screenshot_orig()
-- Should return picked value
eq(child.lua_get('_G.picked_item'), test_items[1])
end
T['start()']['can be started without explicit items'] = function()
child.lua_notify('_G.picked_item = MiniPick.start()')
child.expect_screenshot()
type_keys('<CR>')
eq(child.lua_get('_G.picked_item'), vim.NIL)
end
T['start()']['creates proper window'] = function()
start_with_items(test_items)
local win_id = get_picker_state().windows.main
eq(child.api.nvim_win_is_valid(win_id), true)
local win_config = child.api.nvim_win_get_config(win_id)
eq(win_config.relative, 'editor')
eq(win_config.focusable, true)
validate_win_option(win_id, 'list', true)
validate_win_option(win_id, 'listchars', 'extends:…')
validate_win_option(win_id, 'wrap', false)
end
T['start()']['creates proper main buffer'] = function()
start_with_items(test_items)
local buf_id = get_picker_state().buffers.main
eq(child.api.nvim_buf_is_valid(buf_id), true)
validate_buf_option(buf_id, 'filetype', 'minipick')
validate_buf_option(buf_id, 'buflisted', false)
validate_buf_option(buf_id, 'buftype', 'nofile')
end
T['start()']['tracks lost focus'] = function()
child.lua_notify([[MiniPick.start({
source = { items = { 'a', 'b' } },
mappings = { error = { char = 'e', func = function() error() end } },
})]])
child.expect_screenshot()
type_keys('e')
-- By default it checks inside a timer with 1 second period
sleep(1000 + 50)
child.expect_screenshot()
end
T['start()']['validates `opts`'] = function()
local validate = function(opts, error_pattern)
expect.error(function() child.lua('MiniPick.start(...)', { opts }) end, error_pattern)
end
validate(1, 'Picker options.*table')
validate({ delay = { async = 'a' } }, '`delay.async`.*number')
validate({ delay = { async = 0 } }, '`delay.async`.*positive')
validate({ delay = { busy = 'a' } }, '`delay.busy`.*number')
validate({ delay = { busy = 0 } }, '`delay.busy`.*positive')
validate({ options = { content_from_bottom = 1 } }, '`options%.content_from_bottom`.*boolean')
validate({ options = { use_cache = 1 } }, '`options%.use_cache`.*boolean')
validate({ mappings = { [1] = '<C-f>' } }, '`mappings`.*only string fields')
validate({ mappings = { choose = 1 } }, 'Mapping for built%-in action "choose".*string')
expect.error(
function() child.lua('MiniPick.start({ mappings = { choose = { char = "a", func = function() end } } })') end,
'built%-in action.*string'
)
validate(
{ mappings = { ['Custom action'] = 1 } },
'Mapping for custom action "Custom action".*table with `char` and `func`'
)
validate({ source = { items = 1 } }, '`source%.items`.*array or callable')
validate({ source = { cwd = 1 } }, '`source%.cwd`.*valid directory path')
validate({ source = { cwd = 'not-existing-path' } }, '`source%.cwd`.*valid directory path')
validate({ source = { match = 1 } }, '`source%.match`.*callable')
validate({ source = { show = 1 } }, '`source%.show`.*callable')
validate({ source = { preview = 1 } }, '`source%.preview`.*callable')
validate({ source = { choose = 1 } }, '`source%.choose`.*callable')
validate({ source = { choose_marked = 1 } }, '`source%.choose_marked`.*callable')
validate({ window = { config = 1 } }, '`window%.config`.*table or callable')
end
T['start()']['respects `source.items`'] = function()
-- Array
start_with_items({ 'a', 'b' })
child.expect_screenshot()
stop()
-- Callable returning array of items
child.lua([[_G.items_callable_return = function() return { 'c', 'd' } end]])
child.lua_notify('MiniPick.start({ source = { items = _G.items_callable_return } })')
child.expect_screenshot()
stop()
-- Callable setting items manually
child.lua([[_G.items_callable_later = function() MiniPick.set_picker_items({ 'e', 'f' }) end]])
child.lua_notify('MiniPick.start({ source = { items = _G.items_callable_later } })')
poke_eventloop()
child.expect_screenshot()
stop()
-- Callable setting items manually *later*
child.lua([[_G.items_callable_later = function()
vim.schedule(function() MiniPick.set_picker_items({ 'g', 'h' }) end)
end]])
child.lua_notify('MiniPick.start({ source = { items = _G.items_callable_later } })')
poke_eventloop()
child.expect_screenshot()
stop()
end
T['start()']['correctly computes stritems'] = function()
child.set_size(15, 80)
child.lua_notify([[MiniPick.start({ source = { items = {
'string_item',
{ text = 'table_item' },
{ a = 'fallback item', b = 1 },
function() return 'string_item_from_callable' end,
function() return { text = 'table_item_from_callable' } end,
function() return { c = 'fallback item from callable', d = 1 } end,
} } })]])
child.expect_screenshot()
end
T['start()']['resolves items after making picker active'] = function()
child.lua_notify([[MiniPick.start({ source = {
items = function()
_G.picker_is_active = MiniPick.is_picker_active()
_G.picker_name = MiniPick.get_picker_opts().source.name
return { 'a', 'b' }
end,
name = 'This picker'
} })]])
eq(get_picker_stritems(), { 'a', 'b' })
eq(child.lua_get('_G.picker_is_active'), true)
eq(child.lua_get('_G.picker_name'), 'This picker')
end
T['start()']['respects `source.name`'] = function()
start({ source = { items = test_items, name = 'Hello' } })
validate_picker_option('source.name', 'Hello')
if child.has_float_footer() then child.expect_screenshot_orig() end
end
T['start()']['respects `source.cwd`'] = function()
local lua_cmd = string.format(
[[MiniPick.start({ source = {
items = function() return { MiniPick.get_picker_opts().source.cwd } end,
cwd = %s,
} })]],
vim.inspect(test_dir)
)
child.lua_notify(lua_cmd)
local actual_cwd = get_picker_stritems()[1]
eq(actual_cwd, full_path(test_dir))
eq(actual_cwd:find('/$'), nil)
end
T['start()']['respects `source.match`'] = function()
child.lua_notify([[MiniPick.start({ source = {
items = { 'a', 'b', 'c' },
match = function(...)
_G.match_args = { ... }
return { 2 }
end,
} })]])
child.expect_screenshot()
eq(get_picker_matches().all, { 'b' })
eq(child.lua_get('_G.match_args'), { { 'a', 'b', 'c' }, { 1, 2, 3 }, {} })
type_keys('x')
eq(get_picker_matches().all, { 'b' })
eq(child.lua_get('_G.match_args'), { { 'a', 'b', 'c' }, { 2 }, { 'x' } })
end
T['start()']['respects `source.show`'] = function()
child.lua_notify([[MiniPick.start({ source = {
items = { 'a', { text = 'b' }, 'bb' },
show = function(buf_id, items_to_show, query, ...)
_G.show_args = { buf_id, items_to_show, query, ... }
local lines = vim.tbl_map(
function(x) return '__' .. (type(x) == 'table' and x.text or x) end,
items_to_show
)
vim.api.nvim_buf_set_lines(buf_id, 0, -1, false, lines)
end,
} })]])
local buf_id = get_picker_state().buffers.main
child.expect_screenshot()
eq(child.lua_get('_G.show_args'), { buf_id, { 'a', { text = 'b' }, 'bb' }, {} })
type_keys('b')
child.expect_screenshot()
eq(child.lua_get('_G.show_args'), { buf_id, { { text = 'b' }, 'bb' }, { 'b' } })
end
T['start()']['respects `source.preview`'] = function()
child.lua_notify([[MiniPick.start({ source = {
items = { 'a', { text = 'b' }, 'bb' },
preview = function(buf_id, item, ...)
_G.preview_args = { buf_id, item, ... }
local stritem = type(item) == 'table' and item.text or item
vim.api.nvim_buf_set_lines(buf_id, 0, -1, false, { 'Preview: ' .. stritem })
end,
} })]])
local validate_preview_args = function(item_ref)
local preview_args = child.lua_get('_G.preview_args')
eq(child.api.nvim_buf_is_valid(preview_args[1]), true)
eq(preview_args[2], item_ref)
end
type_keys('<Tab>')
child.expect_screenshot()
validate_preview_args('a')
local preview_buf_id_1 = child.lua_get('_G.preview_args')[1]
type_keys('<C-n>')
child.expect_screenshot()
validate_preview_args({ text = 'b' })
eq(preview_buf_id_1 ~= child.lua_get('_G.preview_args')[1], true)
end
T['start()']['respects `source.choose`'] = function()
child.lua_notify([[MiniPick.start({ source = {
items = { 'a', { text = 'b' }, 'bb' },
choose = function(...) _G.choose_args = { ... } end,
} })]])
type_keys('<C-n>', '<CR>')
eq(child.lua_get('_G.choose_args'), { { text = 'b' } })
eq(is_picker_active(), false)
end
T['start()']['respects `source.choose_marked`'] = function()
child.lua_notify([[MiniPick.start({ source = {
items = { 'a', { text = 'b' }, 'bb' },
choose_marked = function(...) _G.choose_marked_args = { ... } end,
} })]])
type_keys('<C-x>', '<C-n>', '<C-x>', '<M-CR>')
eq(child.lua_get('_G.choose_marked_args'), { { 'a', { text = 'b' } } })
eq(is_picker_active(), false)
end
T['start()']['respects `delay.async`'] = function()
child.set_size(15, 15)
child.lua_notify([[
_G.buf_id, _G.n = vim.api.nvim_get_current_buf(), 0
local timer = vim.loop.new_timer()
local f = vim.schedule_wrap(function()
_G.n = _G.n + 1
vim.fn.appendbufline(_G.buf_id, '$', { 'Line ' .. _G.n })
end)
timer:start(50, 50, f)
]])
local validate = function(n, lines)
eq(child.lua_get('_G.n'), n)
eq(child.lua_get('vim.api.nvim_buf_get_lines(_G.buf_id, 0, -1, false)'), lines)
child.expect_screenshot({ redraw = false })
end
child.lua_notify([[MiniPick.start({ source = { items = { 'a' } }, delay = { async = 80 } })]])
validate(0, { '' })
-- Callback should have already been executed, but not redraw
sleep(50 + 5)
validate(1, { '', 'Line 1' })
-- No new callback should have been executed, but redraw should
sleep(30)
validate(1, { '', 'Line 1' })
-- Test that redraw is done repeatedly
sleep(80)
validate(3, { '', 'Line 1', 'Line 2', 'Line 3' })
end
T['start()']['respects `delay.busy`'] = function()
local validate = function(is_busy)
local win_id = get_picker_state().windows.main
local ref_winhl = 'FloatBorder:MiniPickBorder' .. (is_busy and 'Busy' or '')
expect.match(child.api.nvim_win_get_option(win_id, 'winhighlight'), ref_winhl)
end
local new_busy_delay = math.floor(0.5 * child.lua_get('MiniPick.config.delay.busy'))
child.lua_notify(string.format('MiniPick.start({ delay = { busy = %d } })', new_busy_delay))
validate(false)
sleep(new_busy_delay + 10)
validate(true)
end
T['start()']['respects `mappings`'] = function()
start({ source = { items = { 'a', 'b' } }, mappings = { stop = 'c' } })
eq(is_picker_active(), true)
type_keys('a')
eq(is_picker_active(), true)
type_keys('c')
eq(is_picker_active(), false)
end
T['start()']['respects `options.content_from_bottom`'] = function()
start({ source = { items = { 'a', 'b' } }, options = { content_from_bottom = true } })
child.expect_screenshot()
end
T['start()']['respects `options.use_cache`'] = function()
local validate_match_calls = make_match_with_count()
child.lua_notify([[MiniPick.start({
source = { items = { 'a', 'b', 'bb' }, match = _G.match_with_count },
options = { use_cache = true },
})]])
validate_match_calls(0, { 1, 2, 3 })
type_keys('b')
validate_match_calls(1, { 2, 3 })
type_keys('b')
validate_match_calls(2, { 3 })
type_keys('<BS>')
validate_match_calls(2, { 2, 3 })
type_keys('<BS>')
validate_match_calls(2, { 1, 2, 3 })
type_keys('b')
validate_match_calls(2, { 2, 3 })
type_keys('x')
validate_match_calls(3, {})
end
T['start()']['allows custom mappings'] = function()
-- Both in global and local config
child.lua([[MiniPick.config.mappings.custom_global = {
char = '<C-d>',
func = function(...) _G.args_global = { ... } end,
}]])
child.lua_notify([[MiniPick.start({
source = { items = { 'a', 'b' } },
mappings = {
-- Return value is treated as "should stop picker after execution"
custom = { char = 'm', func = function(...) _G.args_local = { ... }; return true end },
},
})]])
type_keys('<C-d>')
eq(child.lua_get('_G.args_global'), {})
eq(is_picker_active(), true)
type_keys('m')
eq(child.lua_get('_G.args_local'), {})
eq(is_picker_active(), false)
end
T['start()']['allows overriding built-in mappings'] = function()
-- Both in global/local config **but** only as strings
child.lua([[MiniPick.config.mappings.caret_left = '<C-e>']])
child.lua_notify([[MiniPick.start({
source = { items = { 'a', 'b' } },
mappings = { caret_right = 'm' },
})]])
type_keys('a')
eq(get_picker_state().caret, 2)
type_keys('<C-e>')
eq(get_picker_state().caret, 1)
type_keys('m')
eq(get_picker_state().caret, 2)
end
T['start()']['respects `window.config`'] = function()
-- As table
start({ source = { items = { 'a', 'b', 'c' } }, window = { config = { border = 'double' } } })
child.expect_screenshot()
stop()
-- As callable
child.lua_notify([[MiniPick.start({
source = { items = { 'a', 'b', 'c' } },
window = { config = function() return { anchor = 'NW', row = 2, width = vim.o.columns } end },
})]])
child.expect_screenshot()
stop()
end
T['start()']['stops currently active picker'] = function()
start_with_items({ 'a', 'b', 'c' })
eq(is_picker_active(), true)
start_with_items({ 'd', 'e', 'f' })
sleep(2)
child.expect_screenshot()
end
T['start()']['stops impoperly aborted previous picker'] = function()
child.lua_notify([[MiniPick.start({
source = { items = { 'a', 'b', 'c' } },
mappings = { error = { char = 'e', func = function() error() end } },
})]])
child.expect_screenshot()
type_keys('e')
start({ source = { items = { 'd', 'e', 'f' } }, window = { config = { width = 10 } } })
child.expect_screenshot()
end
T['start()']['triggers `MiniPickStart` User event'] = function()
make_event_log()
child.cmd('au User MiniPickStart lua _G.track_event()')
start_with_items(test_items)
-- User event should be triggered when all elements are usually set
eq(child.lua_get('_G.event_log'), { #test_items })
end
T['start()']['respects global config'] = function()
child.lua([[MiniPick.config.window.config = { anchor = 'NW', row = 1 }]])
start_with_items({ 'a', 'b', 'c' })
child.expect_screenshot()
end
T['start()']['respects `vim.b.minipick_config`'] = function()
child.lua([[MiniPick.config.window.config = { anchor = 'NW', row = 1 }]])
child.b.minipick_config = { window = { config = { row = 3, width = 10 } } }
start_with_items({ 'a', 'b', 'c' })
child.expect_screenshot()
end
T['stop()'] = new_set()
T['stop()']['works'] = function()
start_with_items(test_items)
child.expect_screenshot()
stop()
child.expect_screenshot()
eq(is_picker_active(), false)
end
T['stop()']['can be called without active picker'] = function() expect.no_error(stop) end
T['stop()']['triggers `MiniPickStop` User event'] = function()
make_event_log()
child.cmd('au User MiniPickStop lua _G.track_event()')
start_with_items(test_items)
stop()
-- User event should be triggered while buffer is still valid
eq(child.lua_get('_G.event_log'), { #test_items })
end
T['refresh()'] = new_set()
local refresh = forward_lua('MiniPick.refresh')
T['refresh()']['works'] = function()
start_with_items(test_items)
child.expect_screenshot()
child.lua('MiniPick.set_picker_opts({ window = { config = { width = 10 } } })')
refresh()
child.expect_screenshot()
end
T['refresh()']['is called on `VimResized`'] = function()
child.set_size(15, 40)
start_with_items(test_items)
child.expect_screenshot()
child.set_size(15, 20)
child.expect_screenshot()
end
T['refresh()']['can be called without active picker'] = function() expect.no_error(refresh) end
T['refresh()']['recomputes window config'] = function()
child.lua([[
_G.width = 0
_G.win_config = function()
_G.width = _G.width + 10
return { width = _G.width }
end
]])
child.lua_notify([[MiniPick.start({ source = { items = { 'a', 'b', 'c' } }, window = { config = _G.win_config } })]])
child.expect_screenshot()
refresh()
child.expect_screenshot()
end
T['default_match()'] = new_set()
local default_match = forward_lua('MiniPick.default_match')
local validate_match =
function(stritems, query, output_ref) eq(default_match(stritems, seq_along(stritems), query), output_ref) end
T['default_match()']['works with active picker'] = function()
start_with_items(test_items)
type_keys('a')
child.expect_screenshot()
type_keys('b')
child.expect_screenshot()
end
T['default_match()']['does not block query update'] = function()
child.lua([[
_G.log = {}
_G.default_match_wrapper = function(stritems, inds, query)
table.insert(_G.log, { n_match_inds = #inds, query = vim.deepcopy(query) })
MiniPick.default_match(stritems, inds, query)
end
]])
child.lua_notify('MiniPick.start({ source = { match = _G.default_match_wrapper }, delay = { async = 1 } })')
-- Set many items and wait until it completely sets
set_picker_items(many_items)
for i = 1, 50 do
sleep(100)
if child.lua_get([[type(MiniPick.get_picker_items()) == 'table']]) then break end
end
-- Type three characters very quickly. If `default_match()` were blocking,
-- each press would lead to calling `source.match` with the result of
-- matching on prior query. In this test every key press should interrupt
-- currently active matching and start a new one with the latest available
-- set of `match_inds` (which should be all inds as match is, hopefully,
-- never finishes).
type_keys('a')
sleep(1)
type_keys('b')
sleep(1)
type_keys('c')
sleep(1)
child.expect_screenshot()
eq(child.lua_get('_G.log'), {
{ n_match_inds = #many_items, query = {} },
{ n_match_inds = #many_items, query = { 'a' } },
{ n_match_inds = #many_items, query = { 'a', 'b' } },
{ n_match_inds = #many_items, query = { 'a', 'b', 'c' } },
})
end
T['default_match()']['works without active picker'] = function()
local stritems, query = { 'aab', 'ac', 'ab' }, { 'a', 'b' }
eq(default_match(stritems, { 1, 2, 3 }, query), { 3, 1 })
eq(default_match(stritems, { 2, 3 }, query), { 3 })
end
T['default_match()']['works with empty inputs'] = function()
local match_inds, stritems, query = seq_along(test_items), { 'ab', 'cd' }, { 'a' }
eq(default_match(stritems, {}, query), {})
eq(default_match({}, {}, query), {})
eq(default_match(stritems, match_inds, {}), seq_along(stritems))
end
T['default_match()']['filters items that match query with gaps'] = function()
-- Regular cases
validate_match({ 'a__', 'b' }, { 'a' }, { 1 })
validate_match({ '_a_', 'b' }, { 'a' }, { 1 })
validate_match({ '__a', 'b' }, { 'a' }, { 1 })
validate_match({ 'b', 'a__' }, { 'a' }, { 2 })
validate_match({ 'b', '_a_' }, { 'a' }, { 2 })
validate_match({ 'b', '__a' }, { 'a' }, { 2 })
validate_match({ 'a', 'ab', 'a_b', 'a_b_b', 'ba' }, { 'a', 'b' }, { 2, 3, 4 })
validate_match({ 'a', 'ab', 'a_b', 'a_b_b', 'ba' }, { 'a', 'b', 'b' }, { 4 })
validate_match({ 'a', 'ab', 'axb', 'a?b', 'a\tb' }, { 'a', 'b' }, { 2, 3, 4, 5 })