1" Vim filetype plugin 2" Language: Ruby 3" Maintainer: Tim Pope <[email protected]> 4" URL: https://github.com/vim-ruby/vim-ruby 5" Release Coordinator: Doug Kearns <[email protected]> 6" Last Change: 2019 Nov 06 7 8if (exists("b:did_ftplugin")) 9 finish 10endif 11let b:did_ftplugin = 1 12 13let s:cpo_save = &cpo 14set cpo&vim 15 16if has("gui_running") && !has("gui_win32") 17 setlocal keywordprg=ri\ -T\ -f\ bs 18else 19 setlocal keywordprg=ri 20endif 21 22" Matchit support 23if exists("loaded_matchit") && !exists("b:match_words") 24 let b:match_ignorecase = 0 25 26 let b:match_words = 27 \ '{\|\<\%(if\|unless\|case\|while\|until\|for\|do\|class\|module\|def\|=\@<!begin\)\>=\@!' . 28 \ ':' . 29 \ '\<\%(else\|elsif\|ensure\|when\|rescue\|break\|redo\|next\|retry\)\>' . 30 \ ':' . 31 \ '}\|\%(^\|[^.\:@$=]\)\@<=\<end\:\@!\>' . 32 \ ',^=begin\>:^=end\>,' . 33 \ ',\[:\],(:)' 34 35 let b:match_skip = 36 \ "synIDattr(synID(line('.'),col('.'),0),'name') =~ '" . 37 \ "\\<ruby\\%(String\\|.\+Delimiter\\|Character\\|.\+Escape\\|" . 38 \ "Regexp\\|Interpolation\\|Comment\\|Documentation\\|" . 39 \ "ConditionalModifier\\|RepeatModifier\\|RescueModifier\\|OptionalDo\\|" . 40 \ "MethodName\\|BlockArgument\\|KeywordAsMethod\\|ClassVariable\\|" . 41 \ "InstanceVariable\\|GlobalVariable\\|Symbol\\)\\>'" 42endif 43 44setlocal formatoptions-=t formatoptions+=croql 45 46setlocal include=^\\s*\\<\\(load\\>\\\|require\\>\\\|autoload\\s*:\\=[\"']\\=\\h\\w*[\"']\\=,\\) 47setlocal suffixesadd=.rb 48 49if exists("&ofu") && has("ruby") 50 setlocal omnifunc=rubycomplete#Complete 51endif 52 53" TODO: 54"setlocal define=^\\s*def 55 56setlocal comments=:# 57setlocal commentstring=#\ %s 58 59if !exists('g:ruby_version_paths') 60 let g:ruby_version_paths = {} 61endif 62 63function! s:query_path(root) abort 64 let code = "print $:.join %q{,}" 65 if &shell =~# 'sh' && empty(&shellxquote) 66 let prefix = 'env PATH='.shellescape($PATH).' ' 67 else 68 let prefix = '' 69 endif 70 if &shellxquote == "'" 71 let path_check = prefix.'ruby --disable-gems -e "' . code . '"' 72 else 73 let path_check = prefix."ruby --disable-gems -e '" . code . "'" 74 endif 75 76 let cd = haslocaldir() ? 'lcd' : 'cd' 77 let cwd = fnameescape(getcwd()) 78 try 79 exe cd fnameescape(a:root) 80 let path = split(system(path_check),',') 81 exe cd cwd 82 return path 83 finally 84 exe cd cwd 85 endtry 86endfunction 87 88function! s:build_path(path) abort 89 let path = join(map(copy(a:path), 'v:val ==# "." ? "" : v:val'), ',') 90 if &g:path !~# '\v^%(\.,)=%(/%(usr|emx)/include,)=,$' 91 let path = substitute(&g:path,',,$',',','') . ',' . path 92 endif 93 return path 94endfunction 95 96if !exists('b:ruby_version') && !exists('g:ruby_path') && isdirectory(expand('%:p:h')) 97 let s:version_file = findfile('.ruby-version', '.;') 98 if !empty(s:version_file) && filereadable(s:version_file) 99 let b:ruby_version = get(readfile(s:version_file, '', 1), '') 100 if !has_key(g:ruby_version_paths, b:ruby_version) 101 let g:ruby_version_paths[b:ruby_version] = s:query_path(fnamemodify(s:version_file, ':p:h')) 102 endif 103 endif 104endif 105 106if exists("g:ruby_path") 107 let s:ruby_path = type(g:ruby_path) == type([]) ? join(g:ruby_path, ',') : g:ruby_path 108elseif has_key(g:ruby_version_paths, get(b:, 'ruby_version', '')) 109 let s:ruby_paths = g:ruby_version_paths[b:ruby_version] 110 let s:ruby_path = s:build_path(s:ruby_paths) 111else 112 if !exists('g:ruby_default_path') 113 if has("ruby") && has("win32") 114 ruby ::VIM::command( 'let g:ruby_default_path = split("%s",",")' % $:.join(%q{,}) ) 115 elseif executable('ruby') 116 let g:ruby_default_path = s:query_path($HOME) 117 else 118 let g:ruby_default_path = map(split($RUBYLIB,':'), 'v:val ==# "." ? "" : v:val') 119 endif 120 endif 121 let s:ruby_paths = g:ruby_default_path 122 let s:ruby_path = s:build_path(s:ruby_paths) 123endif 124 125if stridx(&l:path, s:ruby_path) == -1 126 let &l:path = s:ruby_path 127endif 128if exists('s:ruby_paths') && stridx(&l:tags, join(map(copy(s:ruby_paths),'v:val."/tags"'),',')) == -1 129 let &l:tags = &tags . ',' . join(map(copy(s:ruby_paths),'v:val."/tags"'),',') 130endif 131 132if (has("gui_win32") || has("gui_gtk")) && !exists("b:browsefilter") 133 let b:browsefilter = "Ruby Source Files (*.rb)\t*.rb\n" . 134 \ "All Files (*.*)\t*.*\n" 135endif 136 137let b:undo_ftplugin = "setl inc= sua= path= tags= fo< com< cms< kp=" 138 \."| unlet! b:browsefilter b:match_ignorecase b:match_words b:match_skip" 139 \."| if exists('&ofu') && has('ruby') | setl ofu< | endif" 140 141if get(g:, 'ruby_recommended_style', 1) 142 setlocal shiftwidth=2 softtabstop=2 expandtab 143 let b:undo_ftplugin .= ' | setl sw< sts< et<' 144endif 145 146" To activate, :set ballooneval 147if exists('+balloonexpr') && get(g:, 'ruby_balloonexpr') 148 setlocal balloonexpr=RubyBalloonexpr() 149 let b:undo_ftplugin .= "| setl bexpr=" 150endif 151 152function! s:map(mode, flags, map) abort 153 let from = matchstr(a:map, '\S\+') 154 if empty(mapcheck(from, a:mode)) 155 exe a:mode.'map' '<buffer>' a:flags a:map 156 let b:undo_ftplugin .= '|sil! '.a:mode.'unmap <buffer> '.from 157 endif 158endfunction 159 160cmap <buffer><script><expr> <Plug><ctag> substitute(RubyCursorTag(),'^$',"\022\027",'') 161cmap <buffer><script><expr> <Plug><cfile> substitute(RubyCursorFile(),'^$',"\022\006",'') 162let b:undo_ftplugin .= "| sil! cunmap <buffer> <Plug><ctag>| sil! cunmap <buffer> <Plug><cfile>" 163 164if !exists("g:no_plugin_maps") && !exists("g:no_ruby_maps") 165 nmap <buffer><script> <SID>: :<C-U> 166 nmap <buffer><script> <SID>c: :<C-U><C-R>=v:count ? v:count : ''<CR> 167 168 nnoremap <silent> <buffer> [m :<C-U>call <SID>searchsyn('\<def\>',['rubyDefine'],'b','n')<CR> 169 nnoremap <silent> <buffer> ]m :<C-U>call <SID>searchsyn('\<def\>',['rubyDefine'],'','n')<CR> 170 nnoremap <silent> <buffer> [M :<C-U>call <SID>searchsyn('\<end\>',['rubyDefine'],'b','n')<CR> 171 nnoremap <silent> <buffer> ]M :<C-U>call <SID>searchsyn('\<end\>',['rubyDefine'],'','n')<CR> 172 xnoremap <silent> <buffer> [m :<C-U>call <SID>searchsyn('\<def\>',['rubyDefine'],'b','v')<CR> 173 xnoremap <silent> <buffer> ]m :<C-U>call <SID>searchsyn('\<def\>',['rubyDefine'],'','v')<CR> 174 xnoremap <silent> <buffer> [M :<C-U>call <SID>searchsyn('\<end\>',['rubyDefine'],'b','v')<CR> 175 xnoremap <silent> <buffer> ]M :<C-U>call <SID>searchsyn('\<end\>',['rubyDefine'],'','v')<CR> 176 177 nnoremap <silent> <buffer> [[ :<C-U>call <SID>searchsyn('\<\%(class\<Bar>module\)\>',['rubyModule','rubyClass'],'b','n')<CR> 178 nnoremap <silent> <buffer> ]] :<C-U>call <SID>searchsyn('\<\%(class\<Bar>module\)\>',['rubyModule','rubyClass'],'','n')<CR> 179 nnoremap <silent> <buffer> [] :<C-U>call <SID>searchsyn('\<end\>',['rubyModule','rubyClass'],'b','n')<CR> 180 nnoremap <silent> <buffer> ][ :<C-U>call <SID>searchsyn('\<end\>',['rubyModule','rubyClass'],'','n')<CR> 181 xnoremap <silent> <buffer> [[ :<C-U>call <SID>searchsyn('\<\%(class\<Bar>module\)\>',['rubyModule','rubyClass'],'b','v')<CR> 182 xnoremap <silent> <buffer> ]] :<C-U>call <SID>searchsyn('\<\%(class\<Bar>module\)\>',['rubyModule','rubyClass'],'','v')<CR> 183 xnoremap <silent> <buffer> [] :<C-U>call <SID>searchsyn('\<end\>',['rubyModule','rubyClass'],'b','v')<CR> 184 xnoremap <silent> <buffer> ][ :<C-U>call <SID>searchsyn('\<end\>',['rubyModule','rubyClass'],'','v')<CR> 185 186 let b:undo_ftplugin = b:undo_ftplugin 187 \."| sil! exe 'unmap <buffer> [[' | sil! exe 'unmap <buffer> ]]' | sil! exe 'unmap <buffer> []' | sil! exe 'unmap <buffer> ]['" 188 \."| sil! exe 'unmap <buffer> [m' | sil! exe 'unmap <buffer> ]m' | sil! exe 'unmap <buffer> [M' | sil! exe 'unmap <buffer> ]M'" 189 190 if maparg('im','x') == '' && maparg('im','o') == '' && maparg('am','x') == '' && maparg('am','o') == '' 191 onoremap <silent> <buffer> im :<C-U>call <SID>wrap_i('[m',']M')<CR> 192 onoremap <silent> <buffer> am :<C-U>call <SID>wrap_a('[m',']M')<CR> 193 xnoremap <silent> <buffer> im :<C-U>call <SID>wrap_i('[m',']M')<CR> 194 xnoremap <silent> <buffer> am :<C-U>call <SID>wrap_a('[m',']M')<CR> 195 let b:undo_ftplugin = b:undo_ftplugin 196 \."| sil! exe 'ounmap <buffer> im' | sil! exe 'ounmap <buffer> am'" 197 \."| sil! exe 'xunmap <buffer> im' | sil! exe 'xunmap <buffer> am'" 198 endif 199 200 if maparg('iM','x') == '' && maparg('iM','o') == '' && maparg('aM','x') == '' && maparg('aM','o') == '' 201 onoremap <silent> <buffer> iM :<C-U>call <SID>wrap_i('[[','][')<CR> 202 onoremap <silent> <buffer> aM :<C-U>call <SID>wrap_a('[[','][')<CR> 203 xnoremap <silent> <buffer> iM :<C-U>call <SID>wrap_i('[[','][')<CR> 204 xnoremap <silent> <buffer> aM :<C-U>call <SID>wrap_a('[[','][')<CR> 205 let b:undo_ftplugin = b:undo_ftplugin 206 \."| sil! exe 'ounmap <buffer> iM' | sil! exe 'ounmap <buffer> aM'" 207 \."| sil! exe 'xunmap <buffer> iM' | sil! exe 'xunmap <buffer> aM'" 208 endif 209 210 call s:map('c', '', '<C-R><C-F> <Plug><cfile>') 211 212 cmap <buffer><script><expr> <SID>tagzv &foldopen =~# 'tag' ? '<Bar>norm! zv' : '' 213 call s:map('n', '<silent>', '<C-]> <SID>:exe v:count1."tag <Plug><ctag>"<SID>tagzv<CR>') 214 call s:map('n', '<silent>', 'g<C-]> <SID>:exe "tjump <Plug><ctag>"<SID>tagzv<CR>') 215 call s:map('n', '<silent>', 'g] <SID>:exe "tselect <Plug><ctag>"<SID>tagzv<CR>') 216 call s:map('n', '<silent>', '<C-W>] <SID>:exe v:count1."stag <Plug><ctag>"<SID>tagzv<CR>') 217 call s:map('n', '<silent>', '<C-W><C-]> <SID>:exe v:count1."stag <Plug><ctag>"<SID>tagzv<CR>') 218 call s:map('n', '<silent>', '<C-W>g<C-]> <SID>:exe "stjump <Plug><ctag>"<SID>tagzv<CR>') 219 call s:map('n', '<silent>', '<C-W>g] <SID>:exe "stselect <Plug><ctag>"<SID>tagzv<CR>') 220 call s:map('n', '<silent>', '<C-W>} <SID>:exe v:count1."ptag <Plug><ctag>"<CR>') 221 call s:map('n', '<silent>', '<C-W>g} <SID>:exe "ptjump <Plug><ctag>"<CR>') 222 223 call s:map('n', '<silent>', 'gf <SID>c:find <Plug><cfile><CR>') 224 call s:map('n', '<silent>', '<C-W>f <SID>c:sfind <Plug><cfile><CR>') 225 call s:map('n', '<silent>', '<C-W><C-F> <SID>c:sfind <Plug><cfile><CR>') 226 call s:map('n', '<silent>', '<C-W>gf <SID>c:tabfind <Plug><cfile><CR>') 227endif 228 229let &cpo = s:cpo_save 230unlet s:cpo_save 231 232if exists("g:did_ruby_ftplugin_functions") 233 finish 234endif 235let g:did_ruby_ftplugin_functions = 1 236 237function! RubyBalloonexpr() abort 238 if !exists('s:ri_found') 239 let s:ri_found = executable('ri') 240 endif 241 if s:ri_found 242 let line = getline(v:beval_lnum) 243 let b = matchstr(strpart(line,0,v:beval_col),'\%(\w\|[:.]\)*$') 244 let a = substitute(matchstr(strpart(line,v:beval_col),'^\w*\%([?!]\|\s*=\)\?'),'\s\+','','g') 245 let str = b.a 246 let before = strpart(line,0,v:beval_col-strlen(b)) 247 let after = strpart(line,v:beval_col+strlen(a)) 248 if str =~ '^\.' 249 let str = substitute(str,'^\.','#','g') 250 if before =~ '\]\s*$' 251 let str = 'Array'.str 252 elseif before =~ '}\s*$' 253 " False positives from blocks here 254 let str = 'Hash'.str 255 elseif before =~ "[\"'`]\\s*$" || before =~ '\$\d\+\s*$' 256 let str = 'String'.str 257 elseif before =~ '\$\d\+\.\d\+\s*$' 258 let str = 'Float'.str 259 elseif before =~ '\$\d\+\s*$' 260 let str = 'Integer'.str 261 elseif before =~ '/\s*$' 262 let str = 'Regexp'.str 263 else 264 let str = substitute(str,'^#','.','') 265 endif 266 endif 267 let str = substitute(str,'.*\.\s*to_f\s*\.\s*','Float#','') 268 let str = substitute(str,'.*\.\s*to_i\%(nt\)\=\s*\.\s*','Integer#','') 269 let str = substitute(str,'.*\.\s*to_s\%(tr\)\=\s*\.\s*','String#','') 270 let str = substitute(str,'.*\.\s*to_sym\s*\.\s*','Symbol#','') 271 let str = substitute(str,'.*\.\s*to_a\%(ry\)\=\s*\.\s*','Array#','') 272 let str = substitute(str,'.*\.\s*to_proc\s*\.\s*','Proc#','') 273 if str !~ '^\w' 274 return '' 275 endif 276 silent! let res = substitute(system("ri -f rdoc -T \"".str.'"'),'\n$','','') 277 if res =~ '^Nothing known about' || res =~ '^Bad argument:' || res =~ '^More than one method' 278 return '' 279 endif 280 return res 281 else 282 return "" 283 endif 284endfunction 285 286function! s:searchsyn(pattern, syn, flags, mode) abort 287 let cnt = v:count1 288 norm! m' 289 if a:mode ==# 'v' 290 norm! gv 291 endif 292 let i = 0 293 call map(a:syn, 'hlID(v:val)') 294 while i < cnt 295 let i = i + 1 296 let line = line('.') 297 let col = col('.') 298 let pos = search(a:pattern,'W'.a:flags) 299 while pos != 0 && index(a:syn, s:synid()) < 0 300 let pos = search(a:pattern,'W'.a:flags) 301 endwhile 302 if pos == 0 303 call cursor(line,col) 304 return 305 endif 306 endwhile 307endfunction 308 309function! s:synid() abort 310 return synID(line('.'),col('.'),0) 311endfunction 312 313function! s:wrap_i(back,forward) abort 314 execute 'norm! k' 315 execute 'norm '.a:forward 316 let line = line('.') 317 execute 'norm '.a:back 318 if line('.') == line - 1 319 return s:wrap_a(a:back,a:forward) 320 endif 321 execute 'norm! jV' 322 execute 'norm '.a:forward 323 execute 'norm! k' 324endfunction 325 326function! s:wrap_a(back,forward) abort 327 execute 'norm '.a:forward 328 if line('.') < line('$') && getline(line('.')+1) ==# '' 329 let after = 1 330 endif 331 execute 'norm '.a:back 332 while getline(line('.')-1) =~# '^\s*#' && line('.') 333 - 334 endwhile 335 if exists('after') 336 execute 'norm! V' 337 execute 'norm '.a:forward 338 execute 'norm! j' 339 elseif line('.') > 1 && getline(line('.')-1) =~# '^\s*$' 340 execute 'norm! kV' 341 execute 'norm '.a:forward 342 else 343 execute 'norm! V' 344 execute 'norm '.a:forward 345 endif 346endfunction 347 348function! RubyCursorIdentifier() abort 349 let asciicode = '\%(\w\|[]})\"'."'".']\)\@<!\%(?\%(\\M-\\C-\|\\C-\\M-\|\\M-\\c\|\\c\\M-\|\\c\|\\C-\|\\M-\)\=\%(\\\o\{1,3}\|\\x\x\{1,2}\|\\\=\S\)\)' 350 let number = '\%(\%(\w\|[]})\"'."'".']\s*\)\@<!-\)\=\%(\<[[:digit:]_]\+\%(\.[[:digit:]_]\+\)\=\%([Ee][[:digit:]_]\+\)\=\>\|\<0[xXbBoOdD][[:xdigit:]_]\+\>\)\|'.asciicode 351 let operator = '\%(\[\]\|<<\|<=>\|[!<>]=\=\|===\=\|[!=]\~\|>>\|\*\*\|\.\.\.\=\|=>\|[~^&|*/%+-]\)' 352 let method = '\%(\.[_a-zA-Z]\w*\s*=>\@!\|\<[_a-zA-Z]\w*\>[?!]\=\)' 353 let global = '$\%([!$&"'."'".'*+,./:;<=>?@\`~]\|-\=\w\+\>\)' 354 let symbolizable = '\%(\%(@@\=\)\w\+\>\|'.global.'\|'.method.'\|'.operator.'\)' 355 let pattern = '\C\s*\%('.number.'\|\%(:\@<!:\)\='.symbolizable.'\)' 356 let [lnum, col] = searchpos(pattern,'bcn',line('.')) 357 let raw = matchstr(getline('.')[col-1 : ],pattern) 358 let stripped = substitute(substitute(raw,'\s\+=$','=',''),'^\s*[:.]\=','','') 359 return stripped == '' ? expand("<cword>") : stripped 360endfunction 361 362function! RubyCursorTag() abort 363 return substitute(RubyCursorIdentifier(), '^[$@]*', '', '') 364endfunction 365 366function! RubyCursorFile() abort 367 let isfname = &isfname 368 try 369 set isfname+=: 370 let cfile = expand('<cfile>') 371 finally 372 let isfname = &isfname 373 endtry 374 let pre = matchstr(strpart(getline('.'), 0, col('.')-1), '.*\f\@<!') 375 let post = matchstr(strpart(getline('.'), col('.')), '\f\@!.*') 376 if s:synid() ==# hlID('rubyConstant') 377 let cfile = substitute(cfile,'\.\w\+[?!=]\=$','','') 378 let cfile = substitute(cfile,'^::','','') 379 let cfile = substitute(cfile,'::','/','g') 380 let cfile = substitute(cfile,'\(\u\+\)\(\u\l\)','\1_\2', 'g') 381 let cfile = substitute(cfile,'\(\l\|\d\)\(\u\)','\1_\2', 'g') 382 return tolower(cfile) . '.rb' 383 elseif getline('.') =~# '^\s*require_relative\s*\(["'']\).*\1\s*$' 384 let cfile = expand('%:p:h') . '/' . matchstr(getline('.'),'\(["'']\)\zs.\{-\}\ze\1') 385 let cfile .= cfile !~# '\.rb$' ? '.rb' : '' 386 elseif getline('.') =~# '^\s*\%(require[( ]\|load[( ]\|autoload[( ]:\w\+,\)\s*\%(::\)\=File\.expand_path(\(["'']\)\.\./.*\1,\s*__FILE__)\s*$' 387 let target = matchstr(getline('.'),'\(["'']\)\.\.\zs/.\{-\}\ze\1') 388 let cfile = expand('%:p:h') . target 389 let cfile .= cfile !~# '\.rb$' ? '.rb' : '' 390 elseif getline('.') =~# '^\s*\%(require \|load \|autoload :\w\+,\)\s*\(["'']\).*\1\s*$' 391 let cfile = matchstr(getline('.'),'\(["'']\)\zs.\{-\}\ze\1') 392 let cfile .= cfile !~# '\.rb$' ? '.rb' : '' 393 elseif pre.post =~# '\<File.expand_path[( ].*[''"]\{2\}, *__FILE__\>' && cfile =~# '^\.\.' 394 let cfile = expand('%:p:h') . strpart(cfile, 2) 395 else 396 return substitute(cfile, '\C\v^(.*):(\d+)%(:in)=$', '+\2 \1', '') 397 endif 398 let cwdpat = '^\M' . substitute(getcwd(), '[\/]', '\\[\\/]', 'g').'\ze\[\/]' 399 let cfile = substitute(cfile, cwdpat, '.', '') 400 if fnameescape(cfile) !=# cfile 401 return '+ '.fnameescape(cfile) 402 else 403 return cfile 404 endif 405endfunction 406 407" 408" Instructions for enabling "matchit" support: 409" 410" 1. Look for the latest "matchit" plugin at 411" 412" http://www.vim.org/scripts/script.php?script_id=39 413" 414" It is also packaged with Vim, in the $VIMRUNTIME/macros directory. 415" 416" 2. Copy "matchit.txt" into a "doc" directory (e.g. $HOME/.vim/doc). 417" 418" 3. Copy "matchit.vim" into a "plugin" directory (e.g. $HOME/.vim/plugin). 419" 420" 4. Ensure this file (ftplugin/ruby.vim) is installed. 421" 422" 5. Ensure you have this line in your $HOME/.vimrc: 423" filetype plugin on 424" 425" 6. Restart Vim and create the matchit documentation: 426" 427" :helptags ~/.vim/doc 428" 429" Now you can do ":help matchit", and you should be able to use "%" on Ruby 430" keywords. Try ":echo b:match_words" to be sure. 431" 432" Thanks to Mark J. Reed for the instructions. See ":help vimrc" for the 433" locations of plugin directories, etc., as there are several options, and it 434" differs on Windows. Email [email protected] if you need help. 435" 436 437" vim: nowrap sw=2 sts=2 ts=8: 438