tests: add tests for ALEFindReferences -contents feature

Author: bretello

test/test_find_references.vader

@@ -3,6 +3,7 @@ Before:
   call ale#test#SetFilename('dummy.txt')
 
   Save g:ale_default_navigation
+  Save g:ale_references_show_contents
 
   let g:old_filename = expand('%:p')
   let g:Callback = ''
@@ -15,6 +16,7 @@ Before:
   let g:conn_id = v:null
   let g:InitCallback = v:null
   let g:ale_default_navigation = 'buffer'
+  let g:ale_references_show_contents = 1
 
   runtime autoload/ale/lsp_linter.vim
   runtime autoload/ale/lsp.vim
@@ -378,11 +380,13 @@ Execute(LSP reference responses should be handled):
   \     'filename': ale#path#Simplify(g:dir . '/completion_dummy_file'),
   \     'line': 3,
   \     'column': 8,
+  \     'match': '',
   \   },
   \   {
   \     'filename': ale#path#Simplify(g:dir . '/other_file'),
   \     'line': 8,
   \     'column': 16,
+  \     'match': '',
   \   },
   \ ],
   \ g:item_list
@@ -415,6 +419,163 @@ Execute(LSP reference responses should be put to quickfix):
   \ 2,
   \ len(getqflist())
 
+Execute(LSP reference responses should contain line contents):
+  let tempfile = tempname()
+  let contents = ['line1 sometext', 'line2 othertext', 'line3 moretext']
+  call writefile(contents, tempfile)
+
+  call ale#references#SetMap({3: { 'show_contents': 1 }})
+
+  call ale#references#HandleLSPResponse(
+  \ 1,
+  \ {
+  \   'id': 3,
+  \   'result': [
+  \     {
+  \       'uri': ale#path#ToFileURI(tempfile),
+  \       'range': {
+  \         'start': {'line': 0, 'character': 6},
+  \       },
+  \     },
+  \     {
+  \       'uri': ale#path#ToFileURI(tempfile),
+  \       'range': {
+  \         'start': {'line': 2, 'character': 1},
+  \       },
+  \     },
+  \   ],
+  \ }
+  \)
+  AssertEqual
+  \ 2,
+  \ len(g:item_list)
+
+  AssertEqual contents[0], g:item_list[0]['match']
+  AssertEqual contents[2], g:item_list[1]['match']
+
+  call ale#references#SetMap({3: { 'show_contents': 1, 'open_in': 'quickfix' }})
+
+  call ale#references#HandleLSPResponse(
+  \ 1,
+  \ {
+  \   'id': 3,
+  \   'result': [
+  \     {
+  \       'uri': ale#path#ToFileURI(tempfile),
+  \       'range': {
+  \         'start': {'line': 0, 'character': 6},
+  \       },
+  \     },
+  \     {
+  \       'uri': ale#path#ToFileURI(tempfile),
+  \       'range': {
+  \         'start': {'line': 2, 'character': 1},
+  \       },
+  \     },
+  \   ],
+  \ }
+  \)
+
+  AssertEqual
+  \ 2,
+  \ len(getqflist())
+
+  AssertEqual contents[0], getqflist()[0]['text']
+  AssertEqual contents[2], getqflist()[1]['text']
+
+Execute(LSP reference responses should not contain line contents when disabled):
+  call ale#references#SetMap({3: { 'show_contents': 0 }})
+
+  call ale#references#HandleLSPResponse(
+  \ 1,
+  \ {
+  \   'id': 3,
+  \   'result': [
+  \     {
+  \       'uri': ale#path#ToFileURI('dummy'),
+  \       'range': {
+  \         'start': {'line': 0, 'character': 6},
+  \       },
+  \     },
+  \     {
+  \       'uri': ale#path#ToFileURI('dummy'),
+  \       'range': {
+  \         'start': {'line': 2, 'character': 1},
+  \       },
+  \     },
+  \   ],
+  \ }
+  \)
+  AssertEqual
+  \ 2,
+  \ len(g:item_list)
+
+  AssertEqual '', g:item_list[0]['match']
+  AssertEqual '', g:item_list[1]['match']
+  call ale#references#SetMap({3: { 'show_contents': 0, 'open_in': 'quickfix' }} )
+
+  call ale#references#HandleLSPResponse(
+  \ 1,
+  \ {
+  \   'id': 3,
+  \   'result': [
+  \     {
+  \       'uri': ale#path#ToFileURI('dummy'),
+  \       'range': {
+  \         'start': {'line': 0, 'character': 6},
+  \       },
+  \     },
+  \     {
+  \       'uri': ale#path#ToFileURI('dummy'),
+  \       'range': {
+  \         'start': {'line': 2, 'character': 1},
+  \       },
+  \     },
+  \   ],
+  \ }
+  \)
+  AssertEqual
+  \ 2,
+  \ len(getqflist())
+
+  AssertEqual '', getqflist()[0]['text']
+  AssertEqual '', getqflist()[1]['text']
+
+Execute(LSP reference responses should respect the global configuration):
+  let g:ale_references_show_contents = 0
+  call ale#references#SetMap({3: {}})
+
+  let tempfile = tempname()
+  let contents = ['line1 sometext', 'line2 othertext', 'line3 moretext']
+  call writefile(contents, tempfile)
+
+  call ale#references#HandleLSPResponse(
+  \ 1,
+  \ {
+  \   'id': 3,
+  \   'result': [
+  \     {
+  \       'uri': ale#path#ToFileURI(tempfile),
+  \       'range': {
+  \         'start': {'line': 0, 'character': 6},
+  \       },
+  \     },
+  \     {
+  \       'uri': ale#path#ToFileURI(tempfile),
+  \       'range': {
+  \         'start': {'line': 2, 'character': 1},
+  \       },
+  \     },
+  \   ],
+  \ }
+  \)
+  AssertEqual
+  \ 2,
+  \ len(g:item_list)
+
+  AssertEqual '', g:item_list[0]['match']
+  AssertEqual '', g:item_list[1]['match']
+
 Execute(Preview windows should not be opened for empty LSP reference responses):
   call ale#references#SetMap({3: {}})
   call ale#references#HandleLSPResponse(1, {'id': 3, 'result': []})