neovim 0.7.1 → 0.9.0

data/lib/neovim/tabpage.rb

@@ -3,47 +3,40 @@ require "neovim/remote_object"
 module Neovim
   # Class representing an +nvim+ tabpage.
   #
-  # The methods documented here were generated using NVIM v0.2.2
+  # The methods documented here were generated using NVIM v0.5.0
   class Tabpage < RemoteObject
 # The following methods are dynamically generated.
 =begin
-@method list_wins(tabpage)
+@method list_wins
   See +:h nvim_tabpage_list_wins()+
-  @param [Tabpage] tabpage
   @return [Array<Window>]
 
-@method get_var(tabpage, name)
+@method get_var(name)
   See +:h nvim_tabpage_get_var()+
-  @param [Tabpage] tabpage
   @param [String] name
   @return [Object]
 
-@method set_var(tabpage, name, value)
+@method set_var(name, value)
   See +:h nvim_tabpage_set_var()+
-  @param [Tabpage] tabpage
   @param [String] name
   @param [Object] value
   @return [void]
 
-@method del_var(tabpage, name)
+@method del_var(name)
   See +:h nvim_tabpage_del_var()+
-  @param [Tabpage] tabpage
   @param [String] name
   @return [void]
 
-@method get_win(tabpage)
+@method get_win
   See +:h nvim_tabpage_get_win()+
-  @param [Tabpage] tabpage
   @return [Window]
 
-@method get_number(tabpage)
+@method get_number
   See +:h nvim_tabpage_get_number()+
-  @param [Tabpage] tabpage
   @return [Integer]
 
-@method is_valid(tabpage)
+@method is_valid
   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.7.1")
+  VERSION = Gem::Version.new("0.9.0")
 end

data/lib/neovim/window.rb

@@ -3,7 +3,7 @@ require "neovim/remote_object"
 module Neovim
   # Class representing an +nvim+ window.
   #
-  # The methods documented here were generated using NVIM v0.2.2
+  # The methods documented here were generated using NVIM v0.5.0
   class Window < RemoteObject
     # Get the buffer displayed in the window
     #
@@ -64,96 +64,108 @@ module Neovim
 
 # The following methods are dynamically generated.
 =begin
-@method get_buf(window)
+@method get_buf
   See +:h nvim_win_get_buf()+
-  @param [Window] window
   @return [Buffer]
 
-@method get_cursor(window)
+@method set_buf(buffer)
+  See +:h nvim_win_set_buf()+
+  @param [Buffer] buffer
+  @return [void]
+
+@method get_cursor
   See +:h nvim_win_get_cursor()+
-  @param [Window] window
   @return [Array<Integer>]
 
-@method set_cursor(window, pos)
+@method set_cursor(pos)
   See +:h nvim_win_set_cursor()+
-  @param [Window] window
   @param [Array<Integer>] pos
   @return [void]
 
-@method get_height(window)
+@method get_height
   See +:h nvim_win_get_height()+
-  @param [Window] window
   @return [Integer]
 
-@method set_height(window, height)
+@method set_height(height)
   See +:h nvim_win_set_height()+
-  @param [Window] window
   @param [Integer] height
   @return [void]
 
-@method get_width(window)
+@method get_width
   See +:h nvim_win_get_width()+
-  @param [Window] window
   @return [Integer]
 
-@method set_width(window, width)
+@method set_width(width)
   See +:h nvim_win_set_width()+
-  @param [Window] window
   @param [Integer] width
   @return [void]
 
-@method get_var(window, name)
+@method get_var(name)
   See +:h nvim_win_get_var()+
-  @param [Window] window
   @param [String] name
   @return [Object]
 
-@method set_var(window, name, value)
+@method set_var(name, value)
   See +:h nvim_win_set_var()+
-  @param [Window] window
   @param [String] name
   @param [Object] value
   @return [void]
 
-@method del_var(window, name)
+@method del_var(name)
   See +:h nvim_win_del_var()+
-  @param [Window] window
   @param [String] name
   @return [void]
 
-@method get_option(window, name)
+@method get_option(name)
   See +:h nvim_win_get_option()+
-  @param [Window] window
   @param [String] name
   @return [Object]
 
-@method set_option(window, name, value)
+@method set_option(name, value)
   See +:h nvim_win_set_option()+
-  @param [Window] window
   @param [String] name
   @param [Object] value
   @return [void]
 
-@method get_position(window)
+@method get_position
   See +:h nvim_win_get_position()+
-  @param [Window] window
   @return [Array<Integer>]
 
-@method get_tabpage(window)
+@method get_tabpage
   See +:h nvim_win_get_tabpage()+
-  @param [Window] window
   @return [Tabpage]
 
-@method get_number(window)
+@method get_number
   See +:h nvim_win_get_number()+
-  @param [Window] window
   @return [Integer]
 
-@method is_valid(window)
+@method is_valid
   See +:h nvim_win_is_valid()+
-  @param [Window] window
   @return [Boolean]
 
+@method set_config(config)
+  See +:h nvim_win_set_config()+
+  @param [Hash] config
+  @return [void]
+
+@method get_config
+  See +:h nvim_win_get_config()+
+  @return [Hash]
+
+@method hide
+  See +:h nvim_win_hide()+
+  @return [void]
+
+@method close(force)
+  See +:h nvim_win_close()+
+  @param [Boolean] force
+  @return [void]
+
+@method call(fun)
+  See +:h nvim_win_call()+
+  @param [LuaRef] fun
+  @return [Object]
+
 =end
   end
 end

data/lib/neovim.rb

@@ -1,4 +1,5 @@
 require "neovim/client"
+require "neovim/client_info"
 require "neovim/session"
 require "neovim/event_loop"
 require "neovim/executable"
@@ -62,7 +63,7 @@ module Neovim
   # @return [Client]
   # @see EventLoop.tcp
   def self.attach_tcp(host, port)
-    Client.from_event_loop EventLoop.tcp(host, port)
+    attach(EventLoop.tcp(host, port))
   end
 
   # Connect to a running +nvim+ instance over a UNIX domain socket.
@@ -71,7 +72,7 @@ module Neovim
   # @return [Client]
   # @see EventLoop.unix
   def self.attach_unix(socket_path)
-    Client.from_event_loop EventLoop.unix(socket_path)
+    attach(EventLoop.unix(socket_path))
   end
 
   # Spawn and connect to a child +nvim+ process.
@@ -80,7 +81,7 @@ module Neovim
   # @return [Client]
   # @see EventLoop.child
   def self.attach_child(argv=[executable.path])
-    Client.from_event_loop EventLoop.child(argv)
+    attach(EventLoop.child(argv))
   end
 
   # Placeholder method for exposing the remote plugin DSL. This gets
@@ -116,4 +117,12 @@ module Neovim
   def self.logger
     Logging.logger
   end
+
+  # @api private
+  def self.attach(event_loop)
+    Client.from_event_loop(event_loop).tap do |client|
+      client.session.notify(:nvim_set_client_info, *ClientInfo.for_client.to_args)
+    end
+  end
+  private_class_method :attach
 end

data/neovim.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $:.unshift(lib) unless $:.include?(lib)
 require "neovim/version"
 
@@ -8,10 +8,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Alex Genco"]
   spec.email         = ["alexgenco@gmail.com"]
   spec.summary       = "A Ruby client for Neovim"
-  spec.homepage      = "https://github.com/alexgenco/neovim-ruby"
+  spec.homepage      = "https://github.com/neovim/neovim-ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = "exe"
   spec.executables   = ["neovim-ruby-host"]
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
@@ -21,12 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "msgpack", "~> 1.1"
   spec.add_dependency "multi_json", "~> 1.0"
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "0.52.1"
   spec.add_development_dependency "vim-flavor", "2.2.2"
 end

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.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.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

@@ -5,11 +5,13 @@ require "fileutils"
 ENV.delete("VIM")
 ENV.delete("VIMRUNTIME")
 
-acceptance_root = File.expand_path("../../spec/acceptance", __FILE__)
+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") :
@@ -17,19 +19,21 @@ themis_exe = Gem.win_platform? ?
 
 env = {
   "NVIM_RPLUGIN_MANIFEST" => manifest,
-  "THEMIS_VIM" => "nvim",
+  "THEMIS_VIM" => nvim,
   "THEMIS_HOME" => themis_home,
   "THEMIS_ARGS" => "-e -s --headless -u #{vimrc}"
 }
 
 FileUtils.rm_f(manifest)
 
-system(
-  env,
-  "nvim",
-  "-e", "-s", "--headless",
-  "-u", vimrc,
-  "+UpdateRemotePlugins", "+qa!"
-)
-
-exec(env, themis_exe, *ARGV)
+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