neovim 0.4.0 → 0.5.0

data/lib/neovim/tabpage.rb

@@ -3,37 +3,47 @@ require "neovim/remote_object"
 module Neovim
   # Class representing an +nvim+ tabpage.
   #
-  # The methods documented here were generated using NVIM v0.1.7
+  # The methods documented here were generated using NVIM v0.2.0
   class Tabpage < RemoteObject
-
 # The following methods are dynamically generated.
 =begin
-@method set_var(name, value)
-  Send the +tabpage_set_var+ RPC to +nvim+
-  @param [String] name
-  @param [Object] value
-  @return [Object]
+@method list_wins(tabpage)
+  See +:h nvim_tabpage_list_wins()+
+  @param [Tabpage] tabpage
+  @return [Array<Window>]
 
-@method del_var(name)
-  Send the +tabpage_del_var+ RPC to +nvim+
+@method get_var(tabpage, name)
+  See +:h nvim_tabpage_get_var()+
+  @param [Tabpage] tabpage
   @param [String] name
   @return [Object]
 
-@method get_windows
-  Send the +tabpage_get_windows+ RPC to +nvim+
-  @return [Array<Window>]
+@method set_var(tabpage, name, value)
+  See +:h nvim_tabpage_set_var()+
+  @param [Tabpage] tabpage
+  @param [String] name
+  @param [Object] value
+  @return [void]
 
-@method get_var(name)
-  Send the +tabpage_get_var+ RPC to +nvim+
+@method del_var(tabpage, name)
+  See +:h nvim_tabpage_del_var()+
+  @param [Tabpage] tabpage
   @param [String] name
-  @return [Object]
+  @return [void]
 
-@method get_window
-  Send the +tabpage_get_window+ RPC to +nvim+
+@method get_win(tabpage)
+  See +:h nvim_tabpage_get_win()+
+  @param [Tabpage] tabpage
   @return [Window]
 
-@method is_valid
-  Send the +tabpage_is_valid+ RPC to +nvim+
+@method get_number(tabpage)
+  See +:h nvim_tabpage_get_number()+
+  @param [Tabpage] tabpage
+  @return [Integer]
+
+@method is_valid(tabpage)
+  See +:h nvim_tabpage_is_valid()+
+  @param [Tabpage] tabpage
   @return [Boolean]
 
 =end

data/lib/neovim/version.rb

@@ -1,3 +1,3 @@
 module Neovim
-  VERSION = Gem::Version.new("0.4.0")
+  VERSION = Gem::Version.new("0.5.0")
 end

data/lib/neovim/window.rb

@@ -3,13 +3,13 @@ require "neovim/remote_object"
 module Neovim
   # Class representing an +nvim+ window.
   #
-  # The methods documented here were generated using NVIM v0.1.7
+  # The methods documented here were generated using NVIM v0.2.0
   class Window < RemoteObject
     # Get the buffer displayed in the window
     #
     # @return [Buffer]
     def buffer
-      get_buffer
+      get_buf
     end
 
     # Get the height of the window
@@ -59,79 +59,99 @@ module Neovim
       _x, _y = coords
       x = [_x, 1].max
       y = [_y, 0].max + 1
-      @session.request(:vim_eval, "cursor(#{x}, #{y})")
+      @session.request(:nvim_eval, "cursor(#{x}, #{y})")
     end
 
 # The following methods are dynamically generated.
 =begin
-@method set_var(name, value)
-  Send the +window_set_var+ RPC to +nvim+
-  @param [String] name
-  @param [Object] value
-  @return [Object]
-
-@method del_var(name)
-  Send the +window_del_var+ RPC to +nvim+
-  @param [String] name
-  @return [Object]
-
-@method get_buffer
-  Send the +window_get_buffer+ RPC to +nvim+
+@method get_buf(window)
+  See +:h nvim_win_get_buf()+
+  @param [Window] window
   @return [Buffer]
 
-@method get_cursor
-  Send the +window_get_cursor+ RPC to +nvim+
+@method get_cursor(window)
+  See +:h nvim_win_get_cursor()+
+  @param [Window] window
   @return [Array<Integer>]
 
-@method set_cursor(pos)
-  Send the +window_set_cursor+ RPC to +nvim+
+@method set_cursor(window, pos)
+  See +:h nvim_win_set_cursor()+
+  @param [Window] window
   @param [Array<Integer>] pos
   @return [void]
 
-@method get_height
-  Send the +window_get_height+ RPC to +nvim+
+@method get_height(window)
+  See +:h nvim_win_get_height()+
+  @param [Window] window
   @return [Integer]
 
-@method set_height(height)
-  Send the +window_set_height+ RPC to +nvim+
+@method set_height(window, height)
+  See +:h nvim_win_set_height()+
+  @param [Window] window
   @param [Integer] height
   @return [void]
 
-@method get_width
-  Send the +window_get_width+ RPC to +nvim+
+@method get_width(window)
+  See +:h nvim_win_get_width()+
+  @param [Window] window
   @return [Integer]
 
-@method set_width(width)
-  Send the +window_set_width+ RPC to +nvim+
+@method set_width(window, width)
+  See +:h nvim_win_set_width()+
+  @param [Window] window
   @param [Integer] width
   @return [void]
 
-@method get_var(name)
-  Send the +window_get_var+ RPC to +nvim+
+@method get_var(window, name)
+  See +:h nvim_win_get_var()+
+  @param [Window] window
   @param [String] name
   @return [Object]
 
-@method get_option(name)
-  Send the +window_get_option+ RPC to +nvim+
+@method set_var(window, name, value)
+  See +:h nvim_win_set_var()+
+  @param [Window] window
+  @param [String] name
+  @param [Object] value
+  @return [void]
+
+@method del_var(window, name)
+  See +:h nvim_win_del_var()+
+  @param [Window] window
+  @param [String] name
+  @return [void]
+
+@method get_option(window, name)
+  See +:h nvim_win_get_option()+
+  @param [Window] window
   @param [String] name
   @return [Object]
 
-@method set_option(name, value)
-  Send the +window_set_option+ RPC to +nvim+
+@method set_option(window, name, value)
+  See +:h nvim_win_set_option()+
+  @param [Window] window
   @param [String] name
   @param [Object] value
   @return [void]
 
-@method get_position
-  Send the +window_get_position+ RPC to +nvim+
+@method get_position(window)
+  See +:h nvim_win_get_position()+
+  @param [Window] window
   @return [Array<Integer>]
 
-@method get_tabpage
-  Send the +window_get_tabpage+ RPC to +nvim+
+@method get_tabpage(window)
+  See +:h nvim_win_get_tabpage()+
+  @param [Window] window
   @return [Tabpage]
 
-@method is_valid
-  Send the +window_is_valid+ RPC to +nvim+
+@method get_number(window)
+  See +:h nvim_win_get_number()+
+  @param [Window] window
+  @return [Integer]
+
+@method is_valid(window)
+  See +:h nvim_win_is_valid()+
+  @param [Window] window
   @return [Boolean]
 
 =end

data/script/dump_api

@@ -7,4 +7,4 @@ require "pp"
 
 nvim_exe = ENV.fetch("NVIM_EXECUTABLE", "nvim")
 session = Neovim::Session.child([nvim_exe, "-u", "NONE", "-n"])
-pp session.request(:vim_get_api_info)
+pp session.request(:nvim_get_api_info)

data/script/generate_docs

@@ -5,7 +5,7 @@ $:.unshift File.expand_path("../../lib", __FILE__)
 require "neovim"
 require "pathname"
 
-vim_docs = []
+nvim_docs = []
 buffer_docs = []
 window_docs = []
 tabpage_docs = []
@@ -13,54 +13,67 @@ nvim_exe = ENV.fetch("NVIM_EXECUTABLE", "nvim")
 nvim_vrs = %x(#{nvim_exe} --version).split("\n").first
 
 session = Neovim::Session.child([nvim_exe, "-u", "NONE", "-n"])
-vim_defs = Neovim::Client.instance_methods(false)
+nvim_defs = Neovim::Client.instance_methods(false)
 buffer_defs = Neovim::Buffer.instance_methods(false)
 tabpage_defs = Neovim::Tabpage.instance_methods(false)
 window_defs = Neovim::Window.instance_methods(false)
 
-session.request(:vim_get_api_info)[1]["functions"].each do |func|
-  prefix, method_name = func["name"].split("_", 2)
+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"]
 
-  case prefix
-  when "vim"
-    next if vim_defs.include?(method_name.to_sym)
-  when "buffer"
+  case func_name
+  when /^nvim_buf_(.+)/
+    method_name = $1
     next if buffer_defs.include?(method_name.to_sym)
-  when "tabpage"
-    next if tabpage_defs.include?(method_name.to_sym)
-  when "window"
+  when /^nvim_win_(.+)/
+    method_name = $1
     next if window_defs.include?(method_name.to_sym)
+  when /^nvim_tabpage_(.+)/
+    method_name = $1
+    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
   end
 
   return_type = func["return_type"]
-  params = func["parameters"]
-  params.shift unless prefix == "vim"
   param_names = params.map(&:last)
   param_str = params.empty? ? "" : "(#{param_names.join(", ")})"
   method_decl = "@method #{method_name}#{param_str}"
-  method_desc = "  Send the +#{prefix}_#{method_name}+ RPC to +nvim+"
+  method_desc = "  See +:h #{func_name}()+"
   param_docs = params.map do |type, name|
     "  @param [#{type}] #{name}"
   end
   return_doc = "  @return [#{return_type}]\n"
   method_doc = [method_decl, method_desc, *param_docs, return_doc].join("\n")
   method_doc.gsub!(/ArrayOf\((\w+)[^)]*\)/, 'Array<\1>')
+  method_doc.gsub!(/Dictionary/, "Hash")
 
-  case prefix
-  when "vim"
-    vim_docs << method_doc
-  when "buffer"
+  case func_name
+  when /nvim_buf_(.+)/
     buffer_docs << method_doc
-  when "tabpage"
-    tabpage_docs << method_doc
-  when "window"
+  when /nvim_win_(.+)/
     window_docs << method_doc
+  when /nvim_tabpage_(.+)/
+    tabpage_docs << method_doc
+  when /nvim_(.+)/
+    nvim_docs << method_doc
+  else
+    raise "Unexpected function #{func_name.inspect}"
   end
 end
 
 lib_dir = Pathname.new(File.expand_path("../../lib/neovim", __FILE__))
 {
-  "client.rb" => vim_docs,
+  "client.rb" => nvim_docs,
   "buffer.rb" => buffer_docs,
   "tabpage.rb" => tabpage_docs,
   "window.rb" => window_docs,

data/spec/helper.rb

@@ -22,12 +22,14 @@ RSpec.configure do |config|
   config.disable_monkey_patching!
   config.order = :random
   config.color = true
+  config.filter_run_excluding :embedded
 
   config.around(:example) do |spec|
     Support.setup_workspace
+    timeout = spec.metadata.fetch(:timeout, 3)
 
     begin
-      Timeout.timeout(5) { spec.run }
+      Timeout.timeout(timeout) { spec.run }
     ensure
       Support.teardown_workspace
     end

data/spec/integration/rplugin_autocmd_spec.vim

@@ -0,0 +1,18 @@
+Before (Generate rplugin manifest):
+  silent UpdateRemotePlugins
+
+Execute (Trigger event for matching patterns):
+  silent split file.rb
+  sleep 50m
+  AssertEqual v:true, b:rplugin_autocmd_BufEnter
+
+Execute (Don't trigger event for non-matching patterns):
+  silent split file.py
+  sleep 50m
+  AssertEqual 0, exists("b:rplugin_autocmd_BufEnter")
+
+Execute (Trigger event with eval):
+  let g:to_eval = {'a': 42}
+  silent split file.c
+  sleep 50m
+  AssertEqual {'a': 42}, g:rplugin_autocmd_BufEnter_eval

data/spec/integration/rplugin_command_spec.vim

@@ -0,0 +1,97 @@
+Before (Generate rplugin manifest):
+  silent UpdateRemotePlugins
+
+Execute (Call rplugin commands with arguments):
+  RPluginCommandNargs0
+  RPluginCommandNargs1 1
+  RPluginCommandNargsN
+  RPluginCommandNargsN 1
+  RPluginCommandNargsN 1 2
+  RPluginCommandNargsQ
+  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
+
+Execute (Call rplugin commands with a range):
+  RPluginCommandRange
+  sleep 50m
+  AssertEqual [1, 1], g:rplugin_command_range
+
+  1,2RPluginCommandRange
+  sleep 50m
+  AssertEqual [1, 2], g:rplugin_command_range
+
+  %RPluginCommandRange
+  sleep 50m
+  AssertEqual [1, 3], g:rplugin_command_range
+
+  RPluginCommandRangeP
+  sleep 50m
+  AssertEqual [1, 3], g:rplugin_command_range_p
+
+  1,2RPluginCommandRangeP
+  sleep 50m
+  AssertEqual [1, 2], g:rplugin_command_range_p
+
+  %RPluginCommandRangeP
+  sleep 50m
+  AssertEqual [1, 3], g:rplugin_command_range_p
+
+  RPluginCommandRangeN
+  sleep 50m
+  AssertEqual [1], g:rplugin_command_range_n
+
+  2RPluginCommandRangeN
+  sleep 50m
+  AssertEqual [2], g:rplugin_command_range_n
+
+Execute (Call rplugin commands with a count):
+  RPluginCommandCountN
+  sleep 50m
+  AssertEqual [1], g:rplugin_command_count_n
+
+  2RPluginCommandCountN
+  sleep 50m
+  AssertEqual [2], g:rplugin_command_count_n
+
+Execute (Call rplugin commands with a bang):
+  RPluginCommandBang
+  sleep 50m
+  AssertEqual 0, g:rplugin_command_bang
+
+  RPluginCommandBang!
+  sleep 50m
+  AssertEqual 1, g:rplugin_command_bang
+
+Execute (Call rplugin commands with a register):
+  RPluginCommandRegister a
+  sleep 50m
+  AssertEqual "a", g:rplugin_command_register
+
+Execute (Call rplugin commands with completion):
+  RPluginCommandCompletion
+  sleep 50m
+  AssertEqual "buffer", g:rplugin_command_completion
+
+Execute (Call rplugin commands with eval):
+  let g:to_eval = {'n': 42}
+  RPluginCommandEval
+  sleep 50m
+  AssertEqual {'n': 42}, g:rplugin_command_eval
+
+Execute (Call synchronous rplugin commands):
+  RPluginCommandSync
+  AssertEqual v:true, g:rplugin_command_sync