Merge pull request #541 from junegunn/vim8

Asynchronous +job installer on Vim 8

.travis.yml

@@ -20,6 +20,7 @@ matrix:
     - env: ENV=ruby20
       rvm: 2.0.0
     - env: ENV=neovim
+    - env: ENV=vim8
 install: |
   git config --global user.email "you@example.com"
   git config --global user.name "Your Name"

README.md

@@ -10,7 +10,7 @@ A minimalist Vim plugin manager.
 - Easier to setup: Single file. No boilerplate code required.
 - Easier to use: Concise, intuitive syntax
 - [Super-fast][40/4] parallel installation/update
-  (with any of `+python`, `+python3`, `+ruby`, or [Neovim][nv])
+  (with any of `+job`, `+python`, `+python3`, `+ruby`, or [Neovim][nv])
 - Creates shallow clones to minimize disk space usage and download time
 - On-demand loading for [faster startup time][startup-time]
 - Can review and rollback updates

plug.vim

@@ -98,6 +98,7 @@ let s:plug_buf = get(s:, 'plug_buf', -1)
 let s:mac_gui = has('gui_macvim') && has('gui_running')
 let s:is_win = has('win32') || has('win64')
 let s:nvim = has('nvim') && exists('*jobwait') && !s:is_win
+let s:vim8 = has('patch-8.0.0039') && exists('*job_start')
 let s:me = resolve(expand('<sfile>:p'))
 let s:base_spec = { 'branch': 'master', 'frozen': 0 }
 let s:TYPE = {
@@ -948,8 +949,9 @@ function! s:update_impl(pull, force, args) abort
     call s:warn('echom', '[vim-plug] Update Neovim for parallel installer')
   endif
 
-  let python = (has('python') || has('python3')) && !s:nvim
+  let use_job = s:nvim || s:vim8
-  let ruby = has('ruby') && !s:nvim && (v:version >= 703 || v:version == 702 && has('patch374')) && !(s:is_win && has('gui_running')) && s:check_ruby()
+  let python = (has('python') || has('python3')) && !use_job
+  let ruby = has('ruby') && !use_job && (v:version >= 703 || v:version == 702 && has('patch374')) && !(s:is_win && has('gui_running')) && s:check_ruby()
 
   let s:update = {
     \ 'start':   reltime(),
@@ -959,7 +961,7 @@ function! s:update_impl(pull, force, args) abort
     \ 'pull':    a:pull,
     \ 'force':   a:force,
     \ 'new':     {},
-    \ 'threads': (python || ruby || s:nvim) ? min([len(todo), threads]) : 1,
+    \ 'threads': (python || ruby || use_job) ? min([len(todo), threads]) : 1,
     \ 'bar':     '',
     \ 'fin':     0
   \ }
@@ -973,7 +975,7 @@ function! s:update_impl(pull, force, args) abort
         \ '--depth 1' . (s:git_version_requirement(1, 7, 10) ? ' --no-single-branch' : '') : ''
 
   " Python version requirement (>= 2.7)
-  if python && !has('python3') && !ruby && !s:nvim && s:update.threads > 1
+  if python && !has('python3') && !ruby && !use_job && s:update.threads > 1
     redir => pyv
     silent python import platform; print platform.python_version()
     redir END
@@ -1014,7 +1016,7 @@ function! s:update_impl(pull, force, args) abort
     endtry
   else
     call s:update_vim()
-    while s:nvim && has('vim_starting')
+    while use_job && has('vim_starting')
       sleep 100m
       if s:update.fin
         break
@@ -1035,7 +1037,7 @@ function! s:update_finish()
   if s:switch_in()
     call append(3, '- Updating ...') | 4
     for [name, spec] in items(filter(copy(s:update.all), 'index(s:update.errors, v:key) < 0 && (s:update.force || s:update.pull || has_key(s:update.new, v:key))'))
-      let pos = s:logpos(name)
+      let [pos, _] = s:logpos(name)
       if !pos
         continue
       endif
@@ -1091,12 +1093,16 @@ function! s:update_finish()
 endfunction
 
 function! s:job_abort()
-  if !s:nvim || !exists('s:jobs')
+  if (!s:nvim && !s:vim8) || !exists('s:jobs')
     return
   endif
 
   for [name, j] in items(s:jobs)
-    silent! call jobstop(j.jobid)
+    if s:nvim
+      silent! call jobstop(j.jobid)
+    elseif s:vim8
+      silent! call job_stop(j.jobid)
+    endif
     if j.new
       call s:system('rm -rf ' . s:shellesc(g:plugs[name].dir))
     endif
@@ -1104,59 +1110,88 @@ function! s:job_abort()
   let s:jobs = {}
 endfunction
 
-" When a:event == 'stdout', data = list of strings
+function! s:last_non_empty_line(lines)
-" When a:event == 'exit', data = returncode
+  let len = len(a:lines)
-function! s:job_handler(job_id, data, event) abort
+  for idx in range(len)
-  if !s:plug_window_exists() " plug window closed
+    let line = a:lines[len-idx-1]
-    return s:job_abort()
+    if !empty(line)
-  endif
+      return line
+    endif
+  endfor
+  return ''
+endfunction
 
-  if a:event == 'stdout'
+function! s:job_out_cb(self, data) abort
-    let complete = empty(a:data[-1])
+  let self = a:self
-    let lines = map(filter(a:data, 'v:val =~ "[^\r\n]"'), 'split(v:val, "[\r\n]")[-1]')
+  let data = remove(self.lines, -1) . a:data
-    call extend(self.lines, lines)
+  let lines = map(split(data, "\n", 1), 'split(v:val, "\r", 1)[-1]')
-    let self.result = join(self.lines, "\n")
+  call extend(self.lines, lines)
-    if !complete
+  " To reduce the number of buffer updates
-      call remove(self.lines, -1)
+  let self.tick = get(self, 'tick', -1) + 1
-    endif
+  if !self.running || self.tick % len(s:jobs) == 0
-    " To reduce the number of buffer updates
+    let bullet = self.running ? (self.new ? '+' : '*') : (self.error ? 'x' : '-')
-    let self.tick = get(self, 'tick', -1) + 1
+    let result = self.error ? join(self.lines, "\n") : s:last_non_empty_line(self.lines)
-    if self.tick % len(s:jobs) == 0
+    call s:log(bullet, self.name, result)
-      call s:log(self.new ? '+' : '*', self.name, self.result)
-    endif
-  elseif a:event == 'exit'
-    let self.running = 0
-    if a:data != 0
-      let self.error = 1
-    endif
-    call s:reap(self.name)
-    call s:tick()
   endif
 endfunction
 
+function! s:job_exit_cb(self, data) abort
+  let a:self.running = 0
+  let a:self.error = a:data != 0
+  call s:reap(a:self.name)
+  call s:tick()
+endfunction
+
+function! s:job_cb(fn, job, ch, data)
+  if !s:plug_window_exists() " plug window closed
+    return s:job_abort()
+  endif
+  call call(a:fn, [a:job, a:data])
+endfunction
+
+function! s:nvim_cb(job_id, data, event) abort
+  return a:event == 'stdout' ?
+    \ s:job_cb('s:job_out_cb',  self, 0, join(a:data, "\n")) :
+    \ s:job_cb('s:job_exit_cb', self, 0, a:data)
+endfunction
+
 function! s:spawn(name, cmd, opts)
-  let job = { 'name': a:name, 'running': 1, 'error': 0, 'lines': [], 'result': '',
+  let job = { 'name': a:name, 'running': 1, 'error': 0, 'lines': [''],
-            \ 'new': get(a:opts, 'new', 0),
+            \ 'new': get(a:opts, 'new', 0) }
-            \ 'on_stdout': function('s:job_handler'),
-            \ 'on_exit' : function('s:job_handler'),
-            \ }
   let s:jobs[a:name] = job
+  let argv = add(s:is_win ? ['cmd', '/c'] : ['sh', '-c'],
+               \ has_key(a:opts, 'dir') ? s:with_cd(a:cmd, a:opts.dir) : a:cmd)
 
   if s:nvim
-    let argv = [ 'sh', '-c',
+    call extend(job, {
-               \ (has_key(a:opts, 'dir') ? s:with_cd(a:cmd, a:opts.dir) : a:cmd) ]
+    \ 'on_stdout': function('s:nvim_cb'),
+    \ 'on_exit':   function('s:nvim_cb'),
+    \ })
     let jid = jobstart(argv, job)
     if jid > 0
       let job.jobid = jid
     else
       let job.running = 0
       let job.error   = 1
-      let job.result  = jid < 0 ? 'sh is not executable' :
+      let job.lines   = [jid < 0 ? argv[0].' is not executable' :
-            \ 'Invalid arguments (or job table is full)'
+            \ 'Invalid arguments (or job table is full)']
+    endif
+  elseif s:vim8
+    let jid = job_start(argv, {
+    \ 'out_cb':   function('s:job_cb', ['s:job_out_cb',  job]),
+    \ 'exit_cb':  function('s:job_cb', ['s:job_exit_cb', job]),
+    \ 'out_mode': 'raw'
+    \})
+    if job_status(jid) == 'run'
+      let job.jobid = jid
+    else
+      let job.running = 0
+      let job.error   = 1
+      let job.lines   = ['Failed to start job']
     endif
   else
     let params = has_key(a:opts, 'dir') ? [a:cmd, a:opts.dir] : [a:cmd]
-    let job.result = call('s:system', params)
+    let job.lines = s:lines(call('s:system', params))
     let job.error = v:shell_error != 0
     let job.running = 0
   endif
@@ -1171,7 +1206,9 @@ function! s:reap(name)
   endif
   let s:update.bar .= job.error ? 'x' : '='
 
-  call s:log(job.error ? 'x' : '-', a:name, empty(job.result) ? 'OK' : job.result)
+  let bullet = job.error ? 'x' : '-'
+  let result = job.error ? join(job.lines, "\n") : s:last_non_empty_line(job.lines)
+  call s:log(bullet, a:name, empty(result) ? 'OK' : result)
   call s:bar()
 
   call remove(s:jobs, a:name)
@@ -1190,23 +1227,31 @@ endfunction
 function! s:logpos(name)
   for i in range(4, line('$'))
     if getline(i) =~# '^[-+x*] '.a:name.':'
-      return i
+      for j in range(i + 1, line('$'))
+        if getline(j) !~ '^ '
+          return [i, j - 1]
+        endif
+      endfor
+      return [i, i]
     endif
   endfor
+  return [0, 0]
 endfunction
 
 function! s:log(bullet, name, lines)
   if s:switch_in()
-    let pos = s:logpos(a:name)
+    let [b, e] = s:logpos(a:name)
-    if pos > 0
+    if b > 0
-      silent execute pos 'd _'
+      silent execute printf('%d,%d d _', b, e)
-      if pos > winheight('.')
+      if b > winheight('.')
-        let pos = 4
+        let b = 4
       endif
     else
-      let pos = 4
+      let b = 4
     endif
-    call append(pos - 1, s:format_message(a:bullet, a:name, a:lines))
+    " FIXME For some reason, nomodifiable is set after :d in vim8
+    setlocal modifiable
+    call append(b - 1, s:format_message(a:bullet, a:name, a:lines))
     call s:switch_out()
   endif
 endfunction
@@ -1220,7 +1265,7 @@ endfunction
 
 function! s:tick()
   let pull = s:update.pull
-  let prog = s:progress_opt(s:nvim)
+  let prog = s:progress_opt(s:nvim || s:vim8)
 while 1 " Without TCO, Vim stack is bound to explode
   if empty(s:update.todo)
     if empty(s:jobs) && !s:update.fin
@@ -1245,10 +1290,10 @@ while 1 " Without TCO, Vim stack is bound to explode
         let fetch_opt = (has_tag && !empty(globpath(spec.dir, '.git/shallow'))) ? '--depth 99999999' : ''
         call s:spawn(name, printf('git fetch %s %s 2>&1', fetch_opt, prog), { 'dir': spec.dir })
       else
-        let s:jobs[name] = { 'running': 0, 'result': 'Already installed', 'error': 0 }
+        let s:jobs[name] = { 'running': 0, 'lines': ['Already installed'], 'error': 0 }
       endif
     else
-      let s:jobs[name] = { 'running': 0, 'result': error, 'error': 1 }
+      let s:jobs[name] = { 'running': 0, 'lines': s:lines(error), 'error': 1 }
     endif
   else
     call s:spawn(name,

test/test.vader

@@ -14,9 +14,15 @@ Execute (Initialize test environment):
 
   " Temporarily patch plug.vim
   call system('cp "$PLUG_SRC" "$PLUG_TMP"')
-  call writefile(extend(readfile($PLUG_TMP),
+  let patch =
   \ ['function! ResetPlug()', 'let s:loaded = {}', 'endfunction',
-  \  'function! CompareURI(a, b)', 'return s:compare_git_uri(a:a, a:b)', 'endfunction']), $PLUG_TMP)
+  \  'function! CompareURI(a, b)', 'return s:compare_git_uri(a:a, a:b)', 'endfunction']
+
+  if $ENV != 'vim8'
+    call add(patch, 'let s:vim8 = 0')
+  endif
+
+  call writefile(extend(readfile($PLUG_TMP), patch), $PLUG_TMP)
 
   set t_Co=256
   colo default