neovim 0.6.2 → 0.9.0.pre.1

data/script/ci/download_nvim.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+set -eu
+
+: ${RUNNER_OS:?} ${BUILD:?}
+
+case "$BUILD" in
+  latest)
+    URL_PART="latest/download"
+    ;;
+  nightly)
+    URL_PART="download/nightly"
+    ;;
+  *)
+    echo "BUILD must be 'latest' or 'nightly'." >&2
+    exit 1
+    ;;
+esac
+
+case "$(echo "$RUNNER_OS" | tr "[:upper:]" "[:lower:]")" in
+  macos)
+    wget -nv -P /tmp \
+      "https://github.com/neovim/neovim/releases/$URL_PART/nvim-macos.tar.gz"
+    tar -C /tmp -xzf /tmp/nvim-macos.tar.gz
+    mv /tmp/nvim-osx64 ./_nvim
+    ;;
+  linux)
+    mkdir -p _nvim/bin
+    wget -nv -O _nvim/bin/nvim \
+      "https://github.com/neovim/neovim/releases/$URL_PART/nvim.appimage"
+    ;;
+  *)
+    echo "Unrecognized \$RUNNER_OS" >&2
+    exit 1
+    ;;
+esac
+
+chmod u+x _nvim/bin/nvim
+
+_nvim/bin/nvim --version

data/script/{dump_api → dump_api.rb}

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path("../../lib", __FILE__)
+$:.unshift File.expand_path("../lib", __dir__)
 
 require "neovim"
 require "json"

data/script/{generate_docs → generate_docs.rb}

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path("../../lib", __FILE__)
+$:.unshift File.expand_path("../lib", __dir__)
 
 require "neovim"
 require "pathname"
@@ -19,10 +19,6 @@ buffer_defs = Neovim::Buffer.instance_methods(false)
 tabpage_defs = Neovim::Tabpage.instance_methods(false)
 window_defs = Neovim::Window.instance_methods(false)
 
-def add_method(docs, defs, method_name)
-  return if defs.include?(method_name.to_s)
-end
-
 session.request(:nvim_get_api_info)[1]["functions"].each do |func|
   func_name = func["name"]
   params = func["parameters"]
@@ -30,16 +26,18 @@ session.request(:nvim_get_api_info)[1]["functions"].each do |func|
   case func_name
   when /^nvim_buf_(.+)/
     method_name = $1
+    params.shift
     next if buffer_defs.include?(method_name.to_sym)
   when /^nvim_win_(.+)/
     method_name = $1
+    params.shift
     next if window_defs.include?(method_name.to_sym)
   when /^nvim_tabpage_(.+)/
     method_name = $1
+    params.shift
     next if tabpage_defs.include?(method_name.to_sym)
   when /^nvim_(.+)/
     method_name = $1
-    params.shift
     next if nvim_defs.include?(method_name.to_sym)
   else
     next
@@ -72,7 +70,8 @@ session.request(:nvim_get_api_info)[1]["functions"].each do |func|
   end
 end
 
-lib_dir = Pathname.new(File.expand_path("../../lib/neovim", __FILE__))
+lib_dir = Pathname.new(File.expand_path("../lib/neovim", __dir__))
+
 {
   "client.rb" => nvim_docs,
   "buffer.rb" => buffer_docs,

data/script/run_acceptance.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require "fileutils"
+
+ENV.delete("VIM")
+ENV.delete("VIMRUNTIME")
+
+root = File.expand_path("..", __dir__)
+acceptance_root = File.join(root, "spec/acceptance")
+themis_rtp = File.join(acceptance_root, "runtime")
+themis_home = File.join(themis_rtp, "flavors/thinca_vim-themis")
+manifest = File.join(themis_rtp, "rplugin_manifest.vim")
+vimrc = File.join(themis_rtp, "init.vim")
+nvim = ENV.fetch("NVIM_EXECUTABLE", "nvim")
+
+themis_exe = Gem.win_platform? ?
+  File.join(themis_home, "bin/themis.bat") :
+  File.join(themis_home, "bin/themis")
+
+env = {
+  "NVIM_RPLUGIN_MANIFEST" => manifest,
+  "THEMIS_VIM" => nvim,
+  "THEMIS_HOME" => themis_home,
+  "THEMIS_ARGS" => "-e -s --headless -u #{vimrc}"
+}
+
+FileUtils.rm_f(manifest)
+
+Dir.chdir(root) do
+  system(
+    env,
+    nvim,
+    "-e", "-s", "--headless",
+    "-u", vimrc,
+    "+UpdateRemotePlugins", "+qa!"
+  )
+
+  exec(env, themis_exe, *ARGV)
+end

data/spec/acceptance/client_info_spec.vim

@@ -0,0 +1,42 @@
+let s:suite = themis#suite("Client info")
+let s:expect = themis#helper("expect")
+
+function! s:suite.before_each() abort
+  call RPluginFunctionArgs(1, 2)
+
+  let s:client_chans = map(
+        \ filter(nvim_list_chans(), "has_key(v:val, 'client')"),
+        \ "v:val.client")
+endfunction
+
+function! s:suite.get_script_host_client_info() abort
+  let client_info = s:client_chans[1]
+
+  call s:expect(sort(keys(client_info))).to_equal(
+        \ ["attributes", "methods", "name", "type", "version"])
+
+  call s:expect(client_info.attributes).to_be_dict()
+  call s:expect(client_info.methods).to_equal({"specs": {"nargs": 1}, "poll": {}})
+  call s:expect(client_info.name).to_equal("ruby-script-host")
+  call s:expect(client_info.type).to_equal("host")
+
+  call s:expect(client_info.version.major).to_be_number()
+  call s:expect(client_info.version.minor).to_be_number()
+  call s:expect(client_info.version.patch).to_be_number()
+endfunction
+
+function! s:suite.get_rplugin_client_info() abort
+  let client_info = s:client_chans[0]
+
+  call s:expect(sort(keys(client_info))).to_equal(
+        \ ["attributes", "methods", "name", "type", "version"])
+
+  call s:expect(client_info.attributes).to_be_dict()
+  call s:expect(client_info.methods).to_equal({"specs": {"nargs": 1}, "poll": {}})
+  call s:expect(client_info.name).to_equal("ruby-rplugin-host")
+  call s:expect(client_info.type).to_equal("host")
+
+  call s:expect(client_info.version.major).to_be_number()
+  call s:expect(client_info.version.minor).to_be_number()
+  call s:expect(client_info.version.patch).to_be_number()
+endfunction

data/spec/acceptance/rplugin_autocmd_spec.vim

@@ -1,18 +1,28 @@
-Before (Generate rplugin manifest):
-  silent UpdateRemotePlugins
+let s:suite = themis#suite("Remote plugin autocmd")
+let s:expect = themis#helper("expect")
 
-Execute (Trigger event for matching patterns):
+function! s:suite.has_nvim() abort
+  call s:expect(has("nvim")).to_equal(1)
+endfunction
+
+function! s:suite.triggers_for_matched_pattern() abort
   silent split file.rb
-  sleep 50m
-  AssertEqual v:true, b:rplugin_autocmd_BufEnter
+  call s:expect(b:rplugin_autocmd_BufEnter).to_equal(v:true)
+endfunction
 
-Execute (Don't trigger event for non-matching patterns):
+function! s:suite.doesnt_trigger_for_unmatched_pattern() abort
   silent split file.py
-  sleep 50m
-  AssertEqual 0, exists("b:rplugin_autocmd_BufEnter")
+  call s:expect(exists('b:rplugin_autocmd_BufEnter')).to_equal(0)
+endfunction
 
-Execute (Trigger event with eval):
+function! s:suite.supports_eval() abort
   let g:to_eval = {'a': 42}
   silent split file.c
+  call s:expect(g:rplugin_autocmd_BufEnter_eval).to_equal({'a': 42, 'b': 43})
+endfunction
+
+function! s:suite.supports_async() abort
+  silent split file.async
   sleep 50m
-  AssertEqual {'a': 42, 'b': 43}, g:rplugin_autocmd_BufEnter_eval
+  call s:expect(g:rplugin_autocmd_BufEnter_async).to_equal(v:true)
+endfunction

data/spec/acceptance/rplugin_command_spec.vim

@@ -1,7 +1,17 @@
-Before (Generate rplugin manifest):
-  silent UpdateRemotePlugins
+let s:suite = themis#suite("Remote plugin command")
+let s:expect = themis#helper("expect")
 
-Execute (Call rplugin commands with arguments):
+function! s:suite.before_each() abort
+  1,$delete
+  call append(0, ["one", "two", "three"])
+  normal gg
+endfunction
+
+function! s:suite.has_nvim() abort
+  call s:expect(has("nvim")).to_equal(1)
+endfunction
+
+function! s:suite.supports_arguments() abort
   RPluginCommandNargs0
   RPluginCommandNargs1 1
   RPluginCommandNargsN
@@ -11,91 +21,79 @@ Execute (Call rplugin commands with arguments):
   RPluginCommandNargsQ 1
   RPluginCommandNargsP 1
   RPluginCommandNargsP 1 2
-  sleep 100m
-
-Then:
-  AssertEqual v:true,     g:rplugin_command_nargs_0
-  AssertEqual "1",        g:rplugin_command_nargs_1
-  AssertEqual ["1", "2"], g:rplugin_command_nargs_n
-  AssertEqual "1",        g:rplugin_command_nargs_q
-  AssertEqual ["1", "2"], g:rplugin_command_nargs_p
 
-Given:
-  one
-  two
-  three
+  call s:expect(g:rplugin_command_nargs_0).to_equal(v:true)
+  call s:expect(g:rplugin_command_nargs_1).to_equal("1")
+  call s:expect(g:rplugin_command_nargs_n).to_equal(["1", "2"])
+  call s:expect(g:rplugin_command_nargs_q).to_equal("1")
+  call s:expect(g:rplugin_command_nargs_p).to_equal(["1", "2"])
+endfunction
 
-Execute (Call rplugin commands with a range):
+function! s:suite.supports_line_range() abort
   RPluginCommandRange
-  sleep 50m
-  AssertEqual [1, 1], g:rplugin_command_range
+  call s:expect(g:rplugin_command_range).to_equal([1, 1])
 
   1,2RPluginCommandRange
-  sleep 50m
-  AssertEqual [1, 2], g:rplugin_command_range
+  call s:expect(g:rplugin_command_range).to_equal([1, 2])
 
   %RPluginCommandRange
-  sleep 50m
-  AssertEqual [1, 3], g:rplugin_command_range
+  call s:expect(g:rplugin_command_range).to_equal([1, 4])
 
   RPluginCommandRangeP
-  sleep 50m
-  AssertEqual [1, 3], g:rplugin_command_range_p
+  call s:expect(g:rplugin_command_range_p).to_equal([1, 4])
 
   1,2RPluginCommandRangeP
-  sleep 50m
-  AssertEqual [1, 2], g:rplugin_command_range_p
+  call s:expect(g:rplugin_command_range_p).to_equal([1, 2])
 
   %RPluginCommandRangeP
-  sleep 50m
-  AssertEqual [1, 3], g:rplugin_command_range_p
+  call s:expect(g:rplugin_command_range_p).to_equal([1, 4])
 
   RPluginCommandRangeN
-  sleep 50m
-  AssertEqual [1], g:rplugin_command_range_n
+  call s:expect(g:rplugin_command_range_n).to_equal([1])
 
   2RPluginCommandRangeN
-  sleep 50m
-  AssertEqual [2], g:rplugin_command_range_n
+  call s:expect(g:rplugin_command_range_n).to_equal([2])
+endfunction
 
-Execute (Call rplugin commands with a count):
+function! s:suite.supports_count() abort
   RPluginCommandCountN
-  sleep 50m
-  AssertEqual [1], g:rplugin_command_count_n
+  call s:expect(g:rplugin_command_count_n).to_equal([1])
 
   2RPluginCommandCountN
-  sleep 50m
-  AssertEqual [2], g:rplugin_command_count_n
+  call s:expect(g:rplugin_command_count_n).to_equal([2])
+endfunction
 
-Execute (Call rplugin commands with a bang):
+function! s:suite.supports_bang() abort
   RPluginCommandBang
-  sleep 50m
-  AssertEqual 0, g:rplugin_command_bang
+  call s:expect(g:rplugin_command_bang).to_equal(0)
 
   RPluginCommandBang!
-  sleep 50m
-  AssertEqual 1, g:rplugin_command_bang
+  call s:expect(g:rplugin_command_bang).to_equal(1)
+endfunction
 
-Execute (Call rplugin commands with a register):
+function! s:suite.supports_register() abort
   RPluginCommandRegister a
-  sleep 50m
-  AssertEqual "a", g:rplugin_command_register
+  call s:expect(g:rplugin_command_register).to_equal("a")
+endfunction
 
-Execute (Call rplugin commands with completion):
+function! s:suite.supports_completion() abort
   RPluginCommandCompletion
-  sleep 50m
-  AssertEqual "buffer", g:rplugin_command_completion
+  call s:expect(g:rplugin_command_completion).to_equal("buffer")
+endfunction
 
-Execute (Call rplugin commands with eval):
+function! s:suite.supports_eval() abort
   let g:to_eval = {'a': 42}
   RPluginCommandEval
-  sleep 50m
-  AssertEqual {'a': 42, 'b': 43}, g:rplugin_command_eval
+  call s:expect(g:rplugin_command_eval).to_equal({'a': 42, 'b': 43})
+endfunction
 
-Execute (Call synchronous rplugin commands):
-  RPluginCommandSync
-  AssertEqual v:true, g:rplugin_command_sync
+function! s:suite.supports_asynchronous_commands() abort
+  RPluginCommandAsync
+  sleep 50m
+  call s:expect(g:rplugin_command_async).to_equal(v:true)
+endfunction
 
-Execute (Call recursive rplugin commands):
+function! s:suite.supports_recursion() abort
   RPluginCommandRecursive 0
-  AssertEqual "10", g:rplugin_command_recursive
+  call s:expect(g:rplugin_command_recursive).to_equal("10")
+endfunction

data/spec/acceptance/rplugin_function_spec.vim

@@ -1,29 +1,35 @@
-Before (Generate rplugin manifest):
-  silent UpdateRemotePlugins
+let s:suite = themis#suite("Remote plugin function")
+let s:expect = themis#helper("expect")
 
-Execute (Call rplugin functions with arguments):
-  call RPluginFunctionArgs(1, 2)
-  sleep 50m
-  AssertEqual [1, 2], g:rplugin_function_args
+function! s:suite.before_each() abort
+  1,$delete
+  call append(0, ["one", "two", "three"])
+endfunction
 
-Given:
-  one
-  two
-  three
+function! s:suite.has_nvim() abort
+  call s:expect(has("nvim")).to_equal(1)
+endfunction
 
-Execute (Call rplugin functions with a range):
-  1,2call RPluginFunctionRange()
-  sleep 50m
-  AssertEqual [1, 2], g:rplugin_function_range
+function! s:suite.supports_arguments() abort
+  call s:expect(RPluginFunctionArgs(1, 2)).to_equal([1, 2])
+endfunction
+
+function! s:suite.supports_line_range() abort
+  3,4call RPluginFunctionRange()
+  call s:expect(g:rplugin_function_range).to_equal([3, 4])
+endfunction
 
-Execute (Call rplugin functions with eval):
+function! s:suite.supports_eval() abort
   let g:to_eval = {'a': 42}
-  call RPluginFunctionEval()
-  sleep 50m
-  AssertEqual {'a': 42, 'b': 43}, g:rplugin_function_eval
+  call s:expect(RPluginFunctionEval()).to_equal({"a": 42, "b": 43})
+endfunction
 
-Execute (Call synchronous rplugin functions):
-  AssertEqual v:true, RPluginFunctionSync()
+function! s:suite.supports_asynchronous_functions() abort
+  call RPluginFunctionAsync()
+  sleep 50m
+  call s:expect(g:rplugin_function_async).to_equal(v:true)
+endfunction
 
-Execute (Call recursive rplugin functions):
-  AssertEqual 10, RPluginFunctionRecursive(0)
+function! s:suite.supports_recursion() abort
+  call s:expect(RPluginFunctionRecursive(0)).to_equal(10)
+endfunction

data/spec/acceptance/ruby_spec.vim

@@ -1,92 +1,91 @@
-Execute (Set nvim_version):
-  if has('nvim')
-    let g:nvim_version = api_info()['version']
-  else
-    let g:nvim_version = {'major': 99, 'minor': 99, 'patch': 99}
-  endif
-
-Given:
-  one
-  two
-
-Execute (Define a Ruby method):
-  ruby def foo; Vim.command("let g:called = 1"); end
-
-Execute (Call a Ruby method):
+let s:suite = themis#suite(":ruby")
+let s:expect = themis#helper("expect")
+
+function! s:suite.before_each() abort
+  let s:pwd = getcwd()
+  1,$delete
+  call append(0, ["one", "two"])
+  unlet! s:var
+endfunction
+
+function! s:suite.after_each() abort
+  execute("cd " . s:pwd)
+endfunction
+
+function! s:suite.has_nvim() abort
+  call s:expect(has("nvim")).to_equal(1)
+endfunction
+
+function! s:suite.defines_a_ruby_method() abort
+  ruby def foo; Vim.command("let s:var = 1"); end
   ruby foo
 
-Then:
-  AssertEqual 1, g:called
+  call s:expect(s:var).to_equal(1)
+endfunction
 
-Execute (Update instance state on `$curbuf`):
+function! s:suite.persists_curbuf_state() abort
   ruby $curbuf.instance_variable_set(:@foo, 123)
-  ruby Vim.command("let g:foo = #{$curbuf.instance_variable_get(:@foo)}")
+  ruby Vim.command("let s:var = #{$curbuf.instance_variable_get(:@foo)}")
 
-Then:
-  AssertEqual 123, g:foo
+  call s:expect(s:var).to_equal(123)
+endfunction
 
-Execute (Change the working directory explicitly):
+function! s:suite.updates_working_directory() abort
   cd /
-  ruby Vim.command("let g:ruby_pwd = '#{Dir.pwd.sub(/^C:/, '')}'")
+  ruby Vim.command("let s:var = '#{Dir.pwd.sub(/^[A-Z]:/, "")}'")
   cd -
 
-Then:
-  if g:nvim_version['major'] > 0 || g:nvim_version['minor'] >= 2
-    AssertEqual "/", g:ruby_pwd
-  endif
+  call s:expect(s:var).to_equal("/")
+endfunction
 
-Execute (Change the working directory implicitly):
+function! s:suite.updates_working_directory_implicitly() abort
   split | lcd /
-  ruby Vim.command("let g:before_pwd = '#{Dir.pwd}'")
+  ruby Vim.command("let s:var = ['#{Dir.pwd}']")
   wincmd p
-  ruby Vim.command("let g:after_pwd = '#{Dir.pwd}'")
+  ruby Vim.command("call add(s:var, '#{Dir.pwd}')")
   wincmd p | lcd -
 
-Then:
-  if g:nvim_version['major'] > 0 || g:nvim_version['minor'] >= 2
-    AssertNotEqual g:before_pwd, g:after_pwd
-  endif
+  call s:expect(len(s:var)).to_equal(2)
+  call s:expect(s:var[0]).not.to_equal(s:var[1])
+endfunction
 
-Execute (Run nested Ruby commands):
-  ruby Vim.command("ruby Vim.command('let g:ruby_nested = 123')")
+function! s:suite.supports_nesting() abort
+  ruby Vim.command("ruby Vim.command('let s:var = 123')")
 
-Then:
-  AssertEqual 123, g:ruby_nested
+  call s:expect(s:var).to_equal(123)
+endfunction
 
-Execute (Raise a Ruby standard error):
+function! s:suite.handles_standard_error() abort
   try
     ruby raise "BOOM"
     throw "Nothing raised"
   catch /BOOM/
   endtry
 
-  ruby $curbuf[1] = "still works"
+  call s:suite.defines_a_ruby_method()
+endfunction
 
-Expect:
-  still works
-  two
-
-Execute (Raise a Ruby syntax error):
+function! s:suite.handles_syntax_error() abort
   try
     ruby puts[
     throw "Nothing raised"
   catch /SyntaxError/
   endtry
 
-  ruby $curbuf[1] = "still works"
-
-Expect:
-  still works
-  two
+  call s:suite.defines_a_ruby_method()
+endfunction
 
-Execute (Access Vim interface):
+function! s:suite.exposes_Vim() abort
   ruby expect(Vim).to eq(VIM)
   ruby expect(Vim.strwidth("hi")).to eq(2)
+endfunction
 
-Execute (Access Vim::Buffer interface):
+function! s:suite.exposes_Buffer() abort
   ruby expect($curbuf).to be_a(Neovim::Buffer)
   ruby expect(Vim::Buffer.current).to eq($curbuf)
+endfunction
 
-Execute (Access Vim::Window interface):
+function! s:suite.exposes_Window() abort
   ruby expect($curwin).to be_a(Neovim::Window)
   ruby expect(Vim::Window.current).to eq($curwin)
+endfunction