Improve PlugDiff: 'X' key to revert the update

- Display load status
- Load plugin with 'L' key

(This commit also allows not loading a plugin with `'for': []`. It used
to load ftdetect files.)

.travis.yml

@@ -1,4 +1,7 @@
-language: vim
+language: ruby
+rvm:
+  - 1.8.7
+  - 2.0.0
 
 before_script: |
   hg clone https://code.google.com/p/vim/

README.md

@@ -25,7 +25,8 @@ and put it in ~/.vim/autoload
 
 ```sh
 mkdir -p ~/.vim/autoload
-curl -fLo ~/.vim/autoload/plug.vim https://raw.github.com/junegunn/vim-plug/master/plug.vim
+curl -fLo ~/.vim/autoload/plug.vim \
+    https://raw.github.com/junegunn/vim-plug/master/plug.vim
 ```
 
 Edit your .vimrc
@@ -61,13 +62,13 @@ Reload .vimrc and `:PlugInstall` to install plugins.
 ### Commands
 
 | Command                             | Description                                                        |
-| --------------------------------- | ------------------------------------------------------------------ |
+| ----------------------------------- | ------------------------------------------------------------------ |
-| PlugInstall [name ...] [#threads] | Install plugins                                                    |
+| `PlugInstall [name ...] [#threads]` | Install plugins                                                    |
-| PlugUpdate [name ...] [#threads]  | Install or update plugins                                          |
+| `PlugUpdate [name ...] [#threads]`  | Install or update plugins                                          |
-| PlugClean[!]                      | Remove unused directories (bang version will clean without prompt) |
+| `PlugClean[!]`                      | Remove unused directories (bang version will clean without prompt) |
-| PlugUpgrade                       | Upgrade vim-plug itself                                            |
+| `PlugUpgrade`                       | Upgrade vim-plug itself                                            |
-| PlugStatus                        | Check the status of plugins                                        |
+| `PlugStatus`                        | Check the status of plugins                                        |
-| PlugDiff                          | See the updated changes from the previous PlugUpdate               |
+| `PlugDiff`                          | See the updated changes from the previous PlugUpdate               |
 
 ### `Plug` options
 
@@ -95,6 +96,10 @@ Reload .vimrc and `:PlugInstall` to install plugins.
 - `S` - `PlugStatus`
 - `R` - Retry failed update or installation tasks
 - `q` - Close the window
+- `:PlugStatus`
+    - `L` - Load plugin
+- `:PlugDiff`
+    - `X` - Revert the update
 
 ### Example: A small [sensible](https://github.com/tpope/vim-sensible) Vim configuration
 
@@ -151,8 +156,9 @@ and only run when the repository has changed, but you can force it to run
 unconditionally with the bang-versions of the commands: `PlugInstall!` and
 `PlugUpdate!`.
 
-Make sure to escape BARs when you write `do` option inline as they are
+Make sure to escape BARs and double-quotes when you write `do` option inline
-mistakenly recognized as command separator for Plug command.
+as they are mistakenly recognized as command separator or the start of the
+trailing comment.
 
 ```vim
 Plug 'junegunn/fzf', { 'do': 'yes \| ./install' }

plug.vim

@@ -69,7 +69,7 @@ let s:cpo_save = &cpo
 set cpo&vim
 
 let s:plug_source = 'https://raw.github.com/junegunn/vim-plug/master/plug.vim'
-let s:plug_buf = -1
+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:me = expand('<sfile>:p')
@@ -80,6 +80,7 @@ let s:TYPE = {
 \   'dict':    type({}),
 \   'funcref': type(function('call'))
 \ }
+let s:loaded = get(s:, 'loaded', {})
 
 function! plug#begin(...)
   if a:0 > 0
@@ -92,13 +93,6 @@ function! plug#begin(...)
     return s:err('Unable to determine plug home. Try calling plug#begin() with a path argument.')
   endif
 
-  if !isdirectory(home)
-    try
-      call mkdir(home, 'p')
-    catch
-      return s:err('Invalid plug directory: '. home)
-    endtry
-  endif
   if !executable('git')
     return s:err('`git` executable not found. vim-plug requires git.')
   endif
@@ -108,17 +102,20 @@ function! plug#begin(...)
   " we want to keep track of the order plugins where registered.
   let g:plugs_order = []
 
-  command! -nargs=+ -bar Plug   call s:add(<args>)
+  call s:define_commands()
-  command! -nargs=* -bang -complete=customlist,s:names PlugInstall call s:install(!empty('<bang>'), <f-args>)
-  command! -nargs=* -bang -complete=customlist,s:names PlugUpdate  call s:update(!empty('<bang>'), <f-args>)
-  command! -nargs=0 -bang PlugClean call s:clean('<bang>' == '!')
-  command! -nargs=0 PlugUpgrade if s:upgrade() | call s:upgrade_specs() | execute 'source '. s:me | endif
-  command! -nargs=0 PlugStatus  call s:status()
-  command! -nargs=0 PlugDiff    call s:diff()
-
   return 1
 endfunction
 
+function! s:define_commands()
+  command! -nargs=+ -bar Plug   call s:add(<args>)
+  command! -nargs=* -bar -bang -complete=customlist,s:names PlugInstall call s:install('<bang>' == '!', <f-args>)
+  command! -nargs=* -bar -bang -complete=customlist,s:names PlugUpdate  call s:update('<bang>' == '!', <f-args>)
+  command! -nargs=0 -bar -bang PlugClean call s:clean('<bang>' == '!')
+  command! -nargs=0 -bar PlugUpgrade if s:upgrade() | execute 'source '. s:me | endif
+  command! -nargs=0 -bar PlugStatus  call s:status()
+  command! -nargs=0 -bar PlugDiff    call s:diff()
+endfunction
+
 function! s:to_a(v)
   return type(a:v) == s:TYPE.list ? a:v : [a:v]
 endfunction
@@ -152,9 +149,8 @@ function! plug#end()
   " need to loop through the plugins in reverse
   for name in reverse(copy(g:plugs_order))
     let plug = g:plugs[name]
-    if !has_key(plug, 'on') && !has_key(plug, 'for')
+    if get(s:loaded, plug.dir, 0) || !has_key(plug, 'on') && !has_key(plug, 'for')
-      let rtp = s:rtp(plug)
+      let rtp = s:add_rtp(plug)
-      call s:add_rtp(rtp)
       if reload
         call s:source(rtp, 'plugin/**/*.vim', 'after/plugin/**/*.vim')
       endif
@@ -181,8 +177,11 @@ function! plug#end()
     endif
 
     if has_key(plug, 'for')
+      let types = s:to_a(plug.for)
+      if !empty(types)
         call s:source(s:rtp(plug), 'ftdetect/**/*.vim', 'after/ftdetect/**/*.vim')
-      for key in s:to_a(plug.for)
+      endif
+      for key in types
         if !has_key(lod, key)
           let lod[key] = []
         endif
@@ -251,12 +250,15 @@ function! s:esc(path)
   return substitute(a:path, ' ', '\\ ', 'g')
 endfunction
 
-function! s:add_rtp(rtp)
+function! s:add_rtp(plug)
-  execute 'set rtp^='.s:esc(a:rtp)
+  let rtp = s:rtp(a:plug)
-  let after = globpath(a:rtp, 'after')
+  execute 'set rtp^='.s:esc(rtp)
+  let after = globpath(rtp, 'after')
   if isdirectory(after)
     execute 'set rtp+='.s:esc(after)
   endif
+  let s:loaded[a:plug.dir] = 1
+  return rtp
 endfunction
 
 function! s:reorg_rtp()
@@ -270,9 +272,28 @@ function! s:reorg_rtp()
   endif
 endfunction
 
+function! plug#load(...)
+  if a:0 == 0
+    return s:err('Argument missing: plugin name(s) required')
+  endif
+  if !exists('g:plugs')
+    return s:err('plug#begin was not called')
+  endif
+  let unknowns = filter(copy(a:000), '!has_key(g:plugs, v:val)')
+  if !empty(unknowns)
+    let s = len(unknowns) > 1 ? 's' : ''
+    return s:err(printf('Unknown plugin%s: %s', s, join(unknowns, ', ')))
+  end
+  for name in a:000
+    call s:lod(g:plugs[name], ['ftdetect', 'after/ftdetect', 'plugin', 'after/plugin'])
+  endfor
+  call s:reorg_rtp()
+  silent! doautocmd BufRead
+  return 1
+endfunction
+
 function! s:lod(plug, types)
-  let rtp = s:rtp(a:plug)
+  let rtp = s:add_rtp(a:plug)
-  call s:add_rtp(rtp)
   for dir in a:types
     call s:source(rtp, dir.'/**/*.vim')
   endfor
@@ -323,6 +344,7 @@ function! s:add(repo, ...)
                     \ a:0 == 1 ? s:parse_options(a:1) : s:base_spec)
     let g:plugs[name] = spec
     let g:plugs_order += [name]
+    let s:loaded[spec.dir] = 0
   catch
     return s:err(v:exception)
   endtry
@@ -373,13 +395,17 @@ function! s:update(force, ...)
   call s:update_impl(1, a:force, a:000)
 endfunction
 
-function! s:helptags()
+function! plug#helptags()
+  if !exists('g:plugs')
+    return s:err('plug#begin was not called')
+  endif
   for spec in values(g:plugs)
     let docd = join([spec.dir, 'doc'], '/')
     if isdirectory(docd)
       silent! execute 'helptags '. s:esc(docd)
     endif
   endfor
+  return 1
 endfunction
 
 function! s:syntax()
@@ -399,6 +425,7 @@ function! s:syntax()
   syn match plugCommit /^  [0-9a-z]\{7} .*/ contains=plugRelDate,plugSha
   syn match plugSha /\(^  \)\@<=[0-9a-z]\{7}/ contained
   syn match plugRelDate /([^)]*)$/ contained
+  syn match plugNotLoaded /(not loaded)$/
   syn match plugError /^x.*/
   syn keyword Function PlugInstall PlugStatus PlugUpdate PlugClean
   hi def link plug1       Title
@@ -419,6 +446,8 @@ function! s:syntax()
   hi def link plugError   Error
   hi def link plugRelDate Comment
   hi def link plugSha     Identifier
+
+  hi def link plugNotLoaded Comment
 endfunction
 
 function! s:lpad(str, len)
@@ -439,6 +468,7 @@ function! s:prepare()
     else
       execute winnr . 'wincmd w'
     endif
+    setlocal modifiable
     silent %d _
   else
     vertical topleft new
@@ -453,7 +483,9 @@ function! s:prepare()
     call s:assign_name()
   endif
   silent! unmap <buffer> <cr>
-  setlocal buftype=nofile bufhidden=wipe nobuflisted noswapfile nowrap cursorline
+  silent! unmap <buffer> L
+  silent! unmap <buffer> X
+  setlocal buftype=nofile bufhidden=wipe nobuflisted noswapfile nowrap cursorline modifiable
   setf vim-plug
   call s:syntax()
 endfunction
@@ -512,7 +544,7 @@ endfunction
 function! s:finish(pull)
   call append(3, '- Finishing ... ')
   redraw
-  call s:helptags()
+  call plug#helptags()
   call plug#end()
   call setline(4, getline(4) . 'Done!')
   normal! gg
@@ -561,15 +593,21 @@ function! s:update_impl(pull, force, args) abort
     return
   endif
 
+  if !isdirectory(g:plug_home)
+    try
+      call mkdir(g:plug_home, 'p')
+    catch
+      return s:err(printf('Invalid plug directory: %s.'
+                        \ 'Try to call plug#begin with a valid directory', g:plug_home))
+    endtry
+  endif
+
   call s:prepare()
   call append(0, a:pull ? 'Updating plugins' : 'Installing plugins')
   call append(1, '['. s:lpad('', len(todo)) .']')
   normal! 2G
   redraw
 
-  if !isdirectory(g:plug_home)
-    call mkdir(g:plug_home, 'p')
-  endif
   let s:prev_update = { 'errors': [], 'pull': a:pull, 'force': a:force, 'new': {}, 'threads': threads }
   if has('ruby') && threads > 1
     try
@@ -1004,15 +1042,12 @@ function! s:upgrade()
     call system(printf(
       \ 'curl -fLo %s %s && '.cp.' %s %s.old && '.mv.' %s %s',
       \ new, s:plug_source, mee, mee, new, mee))
-    if v:shell_error == 0
+    if v:shell_error
-      unlet g:loaded_plug
-      echo 'Downloaded '. s:plug_source
-      return 1
-    else
       return s:err('Error upgrading vim-plug')
     endif
   elseif has('ruby')
     echo 'Downloading '. s:plug_source
+    try
       ruby << EOF
       require 'open-uri'
       require 'fileutils'
@@ -1025,12 +1060,16 @@ function! s:upgrade()
       FileUtils.cp me, old
       File.rename  new, me
 EOF
-    unlet g:loaded_plug
+    catch
-    echo 'Downloaded '. s:plug_source
+      return s:err('Error upgrading vim-plug')
-    return 1
+    endtry
   else
     return s:err('curl executable or ruby support not found')
   endif
+
+  unlet g:loaded_plug
+  echo 'Downloaded '. s:plug_source
+  return 1
 endfunction
 
 function! s:upgrade_specs()
@@ -1045,6 +1084,7 @@ function! s:status()
   call append(1, '')
 
   let ecnt = 0
+  let unloaded = 0
   let [cnt, total] = [0, len(g:plugs)]
   for [name, spec] in items(g:plugs)
     if has_key(spec, 'uri')
@@ -1062,6 +1102,11 @@ function! s:status()
     endif
     let cnt += 1
     let ecnt += !valid
+    " `s:loaded` entry can be missing if PlugUpgraded
+    if valid && get(s:loaded, spec.dir, -1) == 0
+      let unloaded = 1
+      let msg .= ' (not loaded)'
+    endif
     call s:progress_bar(2, repeat('=', cnt), total)
     call append(3, s:format_message(valid, name, msg))
     normal! 2G
@@ -1069,6 +1114,24 @@ function! s:status()
   endfor
   call setline(1, 'Finished. '.ecnt.' error(s).')
   normal! gg
+  setlocal nomodifiable
+  if unloaded
+    echo "Press 'L' on each line to load plugin"
+    nnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
+    xnoremap <silent> <buffer> L :call <SID>status_load(line('.'))<cr>
+  end
+endfunction
+
+function! s:status_load(lnum)
+  let line = getline(a:lnum)
+  let matches = matchlist(line, '^- \([^:]*\):.*(not loaded)$')
+  if !empty(matches)
+    let name = matches[1]
+    call plug#load(name)
+    setlocal modifiable
+    call setline(a:lnum, substitute(line, ' (not loaded)$', '', ''))
+    setlocal nomodifiable
+  endif
 endfunction
 
 function! s:is_preview_window_open()
@@ -1080,22 +1143,36 @@ function! s:is_preview_window_open()
   return 0
 endfunction
 
+function! s:find_name(lnum)
+  for lnum in reverse(range(1, a:lnum))
+    let line = getline(lnum)
+    if empty(line)
+      return ''
+    endif
+    let name = matchstr(line, '\(^- \)\@<=[^:]\+')
+    if !empty(name)
+      return name
+    endif
+  endfor
+  return ''
+endfunction
+
 function! s:preview_commit()
   if b:plug_preview < 0
     let b:plug_preview = !s:is_preview_window_open()
   endif
 
   let sha = matchstr(getline('.'), '\(^  \)\@<=[0-9a-z]\{7}')
-  if !empty(sha)
+  if empty(sha)
-    let lnum = line('.')
+    return
-    while lnum > 1
+  endif
-      let lnum -= 1
+
-      let line = getline(lnum)
+  let name = s:find_name(line('.'))
-      let name = matchstr(line, '\(^- \)\@<=[^:]\+')
+  if empty(name) || !has_key(g:plugs, name) || !isdirectory(g:plugs[name].dir)
-      if !empty(name)
+    return
-        let dir = g:plugs[name].dir
+  endif
-        if isdirectory(dir)
+
-          execute 'cd '.s:esc(dir)
+  execute 'cd '.s:esc(g:plugs[name].dir)
   execute 'pedit '.sha
   wincmd P
   setlocal filetype=git buftype=nofile nobuflisted
@@ -1103,11 +1180,6 @@ function! s:preview_commit()
   normal! ggdd
   wincmd p
   cd -
-        endif
-        break
-      endif
-    endwhile
-  endif
 endfunction
 
 function! s:section(flags)
@@ -1141,12 +1213,39 @@ function! s:diff()
 
   call setline(1, cnt == 0 ? 'No updates.' : 'Last update:')
   nnoremap <silent> <buffer> <cr> :silent! call <SID>preview_commit()<cr>
+  nnoremap <silent> <buffer> X    :call <SID>revert()<cr>
   normal! gg
+  setlocal nomodifiable
+  if cnt > 0
+    echo "Press 'X' on each block to revert the update"
+  endif
+endfunction
+
+function! s:revert()
+  let name = s:find_name(line('.'))
+  if empty(name) || !has_key(g:plugs, name) ||
+    \ input(printf('Revert the update of %s? (Y/N) ', name)) !~? '^y'
+    return
+  endif
+
+  execute 'cd '.s:esc(g:plugs[name].dir)
+  call system('git reset --hard HEAD@{1} && git checkout '.s:esc(g:plugs[name].branch))
+  cd -
+  setlocal modifiable
+  normal! dap
+  setlocal nomodifiable
+  echo 'Reverted.'
 endfunction
 
 let s:first_rtp = s:esc(get(split(&rtp, ','), 0, ''))
 let s:last_rtp = s:esc(get(split(&rtp, ','), -1, ''))
 
+if exists('g:plugs')
+  let g:plugs_order = get(g:, 'plugs_order', keys(g:plugs))
+  call s:upgrade_specs()
+  call s:define_commands()
+endif
+
 let &cpo = s:cpo_save
 unlet s:cpo_save
 

test/run

@@ -21,15 +21,23 @@ make_dirs() {
   for d in *; do
     cat > $d/xxx.vim << EOF
     " echom expand('<sfile>')
-    let g:xxx = get(g:, 'xxx', [])
+    let g:$2 = get(g:, '$2', [])
-    call add(g:xxx, '${1:4}/$d')
+    call add(g:$2, '${1:4}/$d')
 EOF
   done
   cd - > /dev/null
 }
 
-make_dirs xxx/
+make_dirs xxx/ xxx
-make_dirs xxx/after
+make_dirs xxx/after xxx
+mkdir xxx/doc
+cat > xxx/doc/xxx.txt << DOC
+hello *xxx*
+DOC
+
+make_dirs yyy/ yyy
+make_dirs z1/ z1
+make_dirs z2/ z2
 
 cat > /tmp/mini-vimrc << VIMRC
 set rtp+=vader.vim

test/workflow.vader

@@ -33,6 +33,12 @@ Execute (Initialize test environment):
   endfunction
   command! -nargs=+ -bang AssertExpect call AssertExpect('<bang>' == '!', <args>)
 
+Execute (Print Ruby version):
+  redir => out
+  silent ruby puts RUBY_VERSION
+  redir END
+  Log substitute(out, '\n', '', 'g')
+
 Execute (plug#end() before plug#begin() should fail):
   redir => out
   AssertEqual 0, plug#end()
@@ -301,6 +307,13 @@ Execute (Rollback recent updates, PlugUpdate, then PlugDiff):
   AssertEqual lnum, line('.')
   AssertEqual 3, col('.')
 
+  " X key to revert the update
+  AssertExpect '^- ', 2
+  execute "normal Xn\<cr>"
+  AssertExpect '^- ', 2
+  execute "normal Xy\<cr>"
+  AssertExpect '^- ', 1
+
   " q will close preview window as well
   normal q
 
@@ -311,6 +324,7 @@ Execute (Rollback recent updates, PlugUpdate, then PlugDiff):
   " q should not close preview window if it's already open
   pedit
   PlugDiff
+  AssertExpect '^- ', 1
   execute "normal ]]j\<cr>"
   normal q
 
@@ -324,8 +338,8 @@ Execute (Plug window in a new tab):
   set buftype=nofile
   PlugUpdate
   normal D
-  AssertEqual 'No updates.', getline(1)
+  AssertExpect '^- ', 1
-  q
+  normal q
   AssertEqual 'new-tab', expand('%')
   q
   q
@@ -506,15 +520,15 @@ Execute (Frozen plugin are not installed nor updated):
   Plug 'junegunn/vim-easy-align', { 'frozen': 1 }
   call plug#end()
 
-  redir => output
+  redir => out
   silent PlugInstall
   redir END
-  Assert output =~ 'No plugin to install'
+  Assert out =~ 'No plugin to install'
 
-  redir => output
+  redir => out
   silent PlugUpdate
   redir END
-  Assert output =~ 'No plugin to update'
+  Assert out =~ 'No plugin to update'
 
 Execute (But you can still install it if the name is given as the argument):
   PlugInstall vim-easy-align
@@ -756,6 +770,84 @@ Execute (Filetype-based on-demand loading):
   AssertEqual ['/ftdetect', 'after/ftdetect', '/plugin', 'after/plugin', '/ftplugin', 'after/ftplugin', '/indent', 'after/indent', '/syntax', 'after/syntax'], g:xxx
 
 Before:
+
+**********************************************************************
+~ plug#helptags()
+**********************************************************************
+
+Execute (plug#helptags):
+  silent! call delete(expand('$PWD/xxx/doc/tags'))
+  Assert !filereadable(expand('$PWD/xxx/doc/tags'))
+  AssertEqual 1, plug#helptags()
+  Assert filereadable(expand('$PWD/xxx/doc/tags'))
+
+**********************************************************************
+~ Manual loading
+**********************************************************************
+
+Execute (plug#load - invalid arguments):
+  AssertEqual 0, plug#load()
+  AssertEqual 0, plug#load('non-existent-plugin')
+  AssertEqual 0, plug#load('non-existent-plugin', 'another-non-existent-plugin')
+  AssertEqual 1, plug#load('xxx')
+  AssertEqual 0, plug#load('xxx', 'non-existent-plugin')
+  AssertEqual 0, plug#load('non-existent-plugin', 'xxx')
+
+Execute (on: []):
+  call plug#begin()
+  Plug 'junegunn/rust.vim', { 'on': [] }
+  call plug#end()
+  PlugInstall
+  q
+
+Execute (PlugStatus reports (not loaded)):
+  PlugStatus
+  AssertExpect 'not loaded', 1
+  q
+
+Execute (plug#load to load it):
+  tabnew test.rs
+  " Vader will switch tab to [Vader-workbench] after Log
+  " Log &filetype
+  AssertEqual 1, plug#load('rust.vim')
+  AssertEqual 'rust', &filetype
+  q
+
+Execute (PlugStatus should not contain (not loaded)):
+  PlugStatus
+  AssertExpect 'not loaded', 0
+  q
+
+Execute (Load plugin from PlugStatus screen with L key in normal mode):
+  call plug#begin()
+  Plug '$PWD/yyy', { 'on': [] }
+  call plug#end()
+
+  PlugStatus
+  AssertExpect 'not loaded', 1
+  Assert !exists('g:yyy'), 'yyy not loaded'
+  /not loaded
+  normal L
+  AssertExpect 'not loaded', 0
+  Assert exists('g:yyy'), 'yyy loaded'
+  q
+
+Execute (Load plugin from PlugStatus screen with L key in visual mode):
+  call plug#begin()
+  Plug '$PWD/z1', { 'on':  [] }
+  Plug '$PWD/z2', { 'for': [] }
+  call plug#end()
+
+  PlugStatus
+  AssertExpect 'not loaded', 2
+  Assert !exists('g:z1'), 'z1 not loaded'
+  Assert !exists('g:z2'), 'z2 not loaded'
+  normal ggVGL
+  AssertExpect 'not loaded', 0
+  Assert exists('g:z1'), 'z1 loaded'
+  Assert exists('g:z2'), 'z2 loaded'
+  q
+
 Execute (Cleanup):
   silent! call system('rm -rf '.temp_plugged)
   silent! call rename('fzf', 'fzf-staged')