neovim 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fc40ef389b3a8f14b2f8c732553d9e4c02f0ce2
-  data.tar.gz: f99653d06b7373c3c05021d3f1d9db6e26a60185
+  metadata.gz: 421a9bb0ec7f5498ee9f00e98a191abf1972c46e
+  data.tar.gz: b6bdeee0789c0c59cb1337a36826534c1f6a2bb3
 SHA512:
-  metadata.gz: b2f8af36212e0abd4ad2663b4a288452072fd761e017d5e33c19b17dcac93befa562ac4439c69e7d5764fa59013fb5aab321db8836e4f9db4834b0150d1c3c96
-  data.tar.gz: 6ac9d1e4d97870f26dbd28cad4dde0c556d9cb301cec0c3a78775b36db585026d8249e852b71482c5fb65f81ecc2e6702580f776a6a8f8d24ca12f62bc8e8dde
+  metadata.gz: '079597075fd27fd08cd707bbbb5243579db5bf8fe59ea4fc594fa4eca271864f3bc90e4d318527209c161669c150d214d7abeec4aadafbcb0b20d1359b987f97'
+  data.tar.gz: ad2c5fc451b6b86825edc84d2780e28b5a3a525a1ebaa191e078fa03893fd77a199e10d1265a6dac92fd53c29353b9abbe36847be420afd19f08a6cbe56c88cf

data/.gitignore

@@ -17,4 +17,5 @@ test/tmp
 test/version_tmp
 tmp
 spec/workspace
+spec/acceptance/runtime/rplugin.vim
 vendor/bundle

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/vader.vim"]
+	path = vendor/vader.vim
+	url = https://github.com/junegunn/vader.vim.git

data/.travis.yml

@@ -17,4 +17,4 @@ before_install:
   - eval "$(curl -Ss https://raw.githubusercontent.com/neovim/bot-ci/master/scripts/travis-setup.sh) nightly-x64"
 
 env: REPORT_COVERAGE=1
-script: travis_retry bundle exec rake --trace spec
+script: travis_retry bundle exec rake --trace

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.4.0
+- Add `Neovim.executable` for accessing `nvim` info
+- Fix bug where `$curwin` and `$curbuf` got out of sync after `Vim.command`
+  invocations
+- Use vader.vim for running vimscript acceptance tests
+
 # 0.3.3
 - Hotfix older nvim clients' inability to hook into DirChanged
 

data/Rakefile

@@ -1,9 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
-
 desc "Generate Neovim remote API docs"
 task :docs do
   sh File.expand_path("../script/generate_docs", __FILE__)
@@ -13,3 +10,17 @@ desc "Dump nvim remote API"
 task :api do
   sh File.expand_path("../script/dump_api", __FILE__)
 end
+
+namespace :spec do
+  desc "Run functional tests"
+  RSpec::Core::RakeTask.new(:functional)
+
+  desc "Run acceptance tests"
+  task :acceptance do
+    sh "git submodule update --init"
+    sh File.expand_path("../script/acceptance_tests", __FILE__)
+  end
+end
+
+task :spec => "spec:functional"
+task :default => ["spec:acceptance", "spec:functional"]

data/lib/neovim.rb

@@ -1,4 +1,5 @@
 require "neovim/client"
+require "neovim/executable"
 require "neovim/logging"
 require "neovim/session"
 require "neovim/version"
@@ -77,7 +78,7 @@ module Neovim
   # @param argv [Array] The arguments to pass to the spawned process
   # @return [Client]
   # @see Session.child
-  def self.attach_child(argv=["nvim"])
+  def self.attach_child(argv=[executable.path])
     Client.new Session.child(argv)
   end
 
@@ -90,6 +91,14 @@ module Neovim
     raise "Can't call Neovim.plugin outside of a plugin host."
   end
 
+  # Return a +Neovim::Executable+ representing the active +nvim+ executable.
+  #
+  # @return [Executable]
+  # @see Executable
+  def self.executable
+    @executable ||= Executable.from_env
+  end
+
   # Set the Neovim global logger.
   #
   # @param logger [Logger] The target logger

data/lib/neovim/buffer.rb

@@ -3,6 +3,8 @@ require "neovim/line_range"
 
 module Neovim
   # Class representing an +nvim+ buffer.
+  #
+  # The methods documented here were generated using NVIM v0.1.7
   class Buffer < RemoteObject
     # A +LineRange+ object representing the buffer's lines.
     #

data/lib/neovim/client.rb

@@ -6,6 +6,8 @@ module Neovim
   # +RemoteObject+ subclasses (i.e. +Buffer+, +Window+, or +Tabpage+),
   # which similarly have dynamically generated interfaces.
   #
+  # The methods documented here were generated using NVIM v0.1.7
+  #
   # @see Buffer
   # @see Window
   # @see Tabpage

data/lib/neovim/executable.rb

@@ -0,0 +1,33 @@
+module Neovim
+  class Executable
+    VERSION_PATTERN = /\ANVIM v?(.+)$/
+
+    class Error < RuntimeError; end
+
+    # Load the current executable from the +NVIM_EXECUTABLE+ environment
+    # variable.
+    #
+    # @param env [Hash]
+    # @return [Executable]
+    def self.from_env(env=ENV)
+      new(env.fetch("NVIM_EXECUTABLE", "nvim"))
+    end
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    # Fetch the +nvim+ version.
+    #
+    # @return [String]
+    def version
+      @version ||= IO.popen([path, "--version"]) do |io|
+        io.gets[VERSION_PATTERN, 1]
+      end
+    rescue => e
+      raise Error, "Couldn't load #{path}: #{e}"
+    end
+  end
+end

data/lib/neovim/ruby_provider.rb

@@ -9,12 +9,11 @@ module Neovim
   #
   # @api private
   module RubyProvider
-    @__buffer_cache = {}
-
     def self.__define_plugin!
       Thread.abort_on_exception = true
 
       Neovim.plugin do |plug|
+        __define_setup(plug)
         __define_ruby_execute(plug)
         __define_ruby_execute_file(plug)
         __define_ruby_do_range(plug)
@@ -22,6 +21,30 @@ module Neovim
       end
     end
 
+    # Bootstrap the provider client:
+    #
+    # 1. Monkeypatch +$stdout+ and +$stderr+ to write to +nvim+.
+    # 2. Define the +DirChanged+ event to update the provider's pwd.
+    def self.__define_setup(plug)
+      plug.__send__(:setup) do |client|
+        $stdout.define_singleton_method(:write) do |string|
+          client.out_write(string)
+        end
+
+        $stderr.define_singleton_method(:write) do |string|
+          client.report_error(string)
+        end
+
+        begin
+          cid = client.channel_id
+          client.command("au DirChanged * call rpcrequest(#{cid}, 'ruby_chdir', v:event)")
+        rescue ArgumentError
+          # Swallow this exception for now. This means the nvim installation is
+          # from before DirChanged was implemented.
+        end
+      end
+    end
+
     # Evaluate the provided Ruby code, exposing the +Vim+ constant for
     # interactions with the editor.
     #
@@ -73,76 +96,27 @@ module Neovim
     private_class_method :__define_ruby_do_range
 
     def self.__define_ruby_chdir(plug)
-      plug.__send__(:setup) do |client|
-        begin
-          cid = client.channel_id
-          client.command("au DirChanged * call rpcrequest(#{cid}, 'ruby_chdir', v:event)")
-        rescue ArgumentError
-          # Swallow this exception for now. This means the nvim installation is
-          # from before DirChanged was implemented.
-        end
-      end
-
-      plug.__send__(:rpc, :ruby_chdir) do |nvim, event|
+      plug.__send__(:rpc, :ruby_chdir) do |_, event|
         Dir.chdir(event.fetch("cwd"))
       end
     end
     private_class_method :__define_ruby_chdir
 
     def self.__wrap_client(client)
-      __with_globals(client) do
-        __with_vim_constant(client) do
-          __with_redirect_streams(client) do
-            __with_exception_handling(client) do
-              yield
-            end
-          end
-        end
+      Vim.__client = client
+      Vim.__refresh_globals(client)
+
+      __with_exception_handling(client) do
+        yield
       end
       nil
     end
     private_class_method :__wrap_client
 
-    def self.__with_globals(client)
-      bufnr = client.evaluate("bufnr('%')")
-
-      $curbuf = @__buffer_cache.fetch(bufnr) do
-        @__buffer_cache[bufnr] = client.get_current_buffer
-      end
-
-      $curwin = client.get_current_window
-
-      yield
-    end
-    private_class_method :__with_globals
-
-    def self.__with_vim_constant(client)
-      ::Vim.__client = client
-      yield
-    end
-    private_class_method :__with_vim_constant
-
-    def self.__with_redirect_streams(client)
-      @__with_redirect_streams ||= begin
-        $stdout.define_singleton_method(:write) do |string|
-          client.out_write(string)
-        end
-
-        $stderr.define_singleton_method(:write) do |string|
-          client.report_error(string)
-        end
-
-        true
-      end
-
-      yield
-    end
-    private_class_method :__with_redirect_streams
-
     def self.__with_exception_handling(client)
       begin
         yield
-      rescue SyntaxError, StandardError => e
+      rescue SyntaxError, LoadError, StandardError => e
         msg = [e.class, e.message].join(": ")
         client.report_error(msg.lines.first.strip)
       end

data/lib/neovim/ruby_provider/vim.rb

@@ -7,13 +7,27 @@ module Vim
   Buffer = ::Neovim::Buffer
   Window = ::Neovim::Window
 
+  @__buffer_cache = {}
+
   def self.__client=(client)
     @__client = client
   end
 
   # Delegate all method calls to the underlying +Neovim::Client+ object.
   def self.method_missing(method, *args, &block)
-    @__client.public_send(method, *args, &block)
+    @__client.public_send(method, *args, &block).tap do
+      __refresh_globals(@__client)
+    end
+  end
+
+  def self.__refresh_globals(client)
+    bufnr = client.evaluate("bufnr('%')")
+
+    $curbuf = @__buffer_cache.fetch(bufnr) do
+      @__buffer_cache[bufnr] = client.get_current_buffer
+    end
+
+    $curwin = client.get_current_window
   end
 end
 

data/lib/neovim/tabpage.rb

@@ -1,6 +1,9 @@
 require "neovim/remote_object"
 
 module Neovim
+  # Class representing an +nvim+ tabpage.
+  #
+  # The methods documented here were generated using NVIM v0.1.7
   class Tabpage < RemoteObject
 
 # The following methods are dynamically generated.

data/lib/neovim/version.rb

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

data/lib/neovim/window.rb

@@ -1,6 +1,9 @@
 require "neovim/remote_object"
 
 module Neovim
+  # Class representing an +nvim+ window.
+  #
+  # The methods documented here were generated using NVIM v0.1.7
   class Window < RemoteObject
     # Get the buffer displayed in the window
     #

data/script/acceptance_tests

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "neovim"
+require "shellwords"
+require "tempfile"
+require File.expand_path("../../spec/support.rb", __FILE__)
+
+nvim = Neovim.executable.path
+vader = File.expand_path("../../vendor/vader.vim", __FILE__)
+specs = File.expand_path("../../spec/acceptance/*_spec.vim", __FILE__)
+root = File.expand_path("../..", __FILE__)
+exitstatus = 0
+
+Dir.glob(specs) do |vader_spec|
+  Tempfile.open("vader.out") do |tmp|
+    Dir.chdir(root) do
+      system(
+        {
+          "VADER_OUTPUT_FILE" => tmp.path,
+          "NVIM_RPLUGIN_MANIFEST" => "spec/acceptance/runtime/rplugin.vim"
+        },
+        "bash", "-c",
+        "#{nvim} --headless -nu spec/acceptance/runtime/init.vim +'Vader! #{vader_spec}'"
+      )
+    end
+
+    if $?.success?
+      puts "[✔] #{vader_spec}"
+    else
+      exitstatus = $?.exitstatus
+      IO.copy_stream(tmp, $stderr)
+      puts "[✘] #{vader_spec}"
+    end
+  end
+end
+
+if exitstatus == 0
+  puts "[✔] Acceptance tests passed."
+else
+  puts "[✘] Acceptance tests failed."
+end
+
+exit(exitstatus)

data/script/generate_docs

@@ -10,6 +10,7 @@ buffer_docs = []
 window_docs = []
 tabpage_docs = []
 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)
@@ -68,5 +69,11 @@ lib_dir = Pathname.new(File.expand_path("../../lib/neovim", __FILE__))
   contents = File.read(path)
   doc_str = ["=begin", *docs, "=end"].join("\n")
 
-  File.write(path, contents.sub(/=begin.+=end/m, doc_str))
+  contents.sub!(/=begin.+=end/m, doc_str)
+  contents.sub!(
+    /# The methods documented here were generated using .+$/,
+    "# The methods documented here were generated using #{nvim_vrs}"
+  )
+
+  File.write(path, contents)
 end

data/spec/acceptance/rplugin_spec.vim

@@ -0,0 +1,19 @@
+Given:
+  one
+  two
+
+Execute (Update remote plugins):
+  silent UpdateRemotePlugins
+
+Execute (Call rplugin command):
+  PlugSetFoo bar
+  sleep 100m
+  AssertEqual "bar", g:PlugFoo
+
+Execute (Call rplugin function):
+  AssertEqual 3, PlugAdd(1, 2)
+
+Execute (Trigger rplugin autocmd):
+  silent edit foo.rb
+  sleep 100m
+  AssertEqual 1, g:PlugInRuby

data/spec/acceptance/ruby_spec.vim

@@ -0,0 +1,94 @@
+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 (Access `Vim` and `VIM` constants):
+  ruby Vim.command('1normal! Sfirst')
+  ruby VIM.command('2normal! Ssecond')
+
+Expect:
+  first
+  second
+
+Execute (Access `$curbuf` global variable):
+  ruby $curbuf[1] = "first"
+
+Expect:
+  first
+  two
+
+Execute (Access `$curwin` global variable):
+  ruby $curwin.buffer[1] = "first"
+
+Expect:
+  first
+  two
+
+Execute (Define a Ruby method):
+  ruby def foo; Vim.command("let g:called = 1"); end
+
+Execute (Call a Ruby method):
+  ruby foo
+
+Then:
+  AssertEqual 1, g:called
+
+Execute (Update instance state on `$curbuf`):
+  ruby $curbuf.instance_variable_set(:@foo, 123)
+  ruby Vim.command("let g:foo = #{$curbuf.instance_variable_get(:@foo)}")
+
+Then:
+  AssertEqual 123, g:foo
+
+Execute (Change the working directory explicitly):
+  cd /
+  ruby Vim.command("let g:ruby_pwd = '#{Dir.pwd}'")
+  cd -
+
+Then:
+  if g:nvim_version['major'] > 0 || g:nvim_version['minor'] >= 2
+    AssertEqual "/", g:ruby_pwd
+  endif
+
+Execute (Change the working directory implicitly):
+  split | lcd /
+  ruby Vim.command("let g:before_pwd = '#{Dir.pwd}'")
+  wincmd p
+  ruby Vim.command("let g:after_pwd = '#{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
+
+Execute (Raise a Ruby standard error):
+  try
+    ruby raise "BOOM"
+  catch /BOOM/
+  endtry
+
+  ruby $curbuf[1] = "still works"
+
+Expect:
+  still works
+  two
+
+Execute (Raise a Ruby syntax error):
+  try
+    ruby puts[
+  catch /SyntaxError/
+  endtry
+
+  ruby $curbuf[1] = "still works"
+
+Expect:
+  still works
+  two