neovim 0.6.2 → 0.9.0.pre.1

data/spec/acceptance/runtime/rplugin/ruby/functions.rb

@@ -1,21 +1,21 @@
 Neovim.plugin do |plug|
-  plug.function(:RPluginFunctionArgs) do |nvim, *args|
-    nvim.set_var("rplugin_function_args", args)
+  plug.function(:RPluginFunctionArgs, sync: true) do |nvim, *args|
+    args
   end
 
-  plug.function(:RPluginFunctionRange, :range => true) do |nvim, *range|
-    nvim.set_var("rplugin_function_range", range)
+  plug.function(:RPluginFunctionRange, range: true, sync: true) do |nvim, start, stop|
+    nvim.set_var("rplugin_function_range", [start, stop])
   end
 
-  plug.function(:RPluginFunctionEval, :eval => "g:to_eval") do |nvim, to_eval|
-    nvim.set_var("rplugin_function_eval", to_eval.merge(:b => 43))
+  plug.function(:RPluginFunctionEval, eval: "g:to_eval", sync: true) do |nvim, to_eval|
+    to_eval.merge(b: 43)
   end
 
-  plug.function(:RPluginFunctionSync, :sync => true) do |nvim|
-    true
+  plug.function(:RPluginFunctionAsync) do |nvim|
+    nvim.set_var("rplugin_function_async", true)
   end
 
-  plug.function(:RPluginFunctionRecursive, :sync => true, :nargs => 1) do |nvim, n|
+  plug.function(:RPluginFunctionRecursive, sync: true, nargs: 1) do |nvim, n|
     if n >= 10
       n
     else

data/spec/helper.rb

@@ -1,20 +1,17 @@
 require "bundler/setup"
 
-if ENV["REPORT_COVERAGE"]
-  require "coveralls"
-  Coveralls.wear!
-end
-
 require "fileutils"
+require "msgpack"
 require "neovim"
 require "pry"
 require "rubygems"
+require "securerandom"
 require "stringio"
 require "timeout"
-require "securerandom"
-require "msgpack"
 
-require File.expand_path("../support.rb", __FILE__)
+require File.expand_path("support.rb", __dir__)
+
+ENV["NVIM_RUBY_LOG_LEVEL"] ||= "FATAL"
 
 RSpec.configure do |config|
   config.expect_with :rspec do |exp|
@@ -25,17 +22,49 @@ RSpec.configure do |config|
   config.order = :random
   config.color = true
 
+  config.around(:example, :silence_thread_exceptions) do |spec|
+    if Thread.respond_to?(:report_on_exception)
+      original = Thread.report_on_exception
+
+      begin
+        Thread.report_on_exception = false
+        spec.run
+      ensure
+        Thread.report_on_exception = original
+      end
+    else
+      spec.run
+    end
+  end
+
   config.around(:example) do |spec|
     Support.setup_workspace
     timeout = spec.metadata.fetch(:timeout, 3)
 
     begin
-      Timeout.timeout(timeout) { spec.run }
+      Timeout.timeout(timeout) do
+        Support.clean_persistent_client
+        spec.run
+      end
     ensure
       Support.teardown_workspace
     end
   end
 
+  config.before(:example, :nvim_version) do |spec|
+    comparator = spec.metadata.fetch(:nvim_version)
+    requirement = Gem::Requirement.create(comparator)
+    nvim_version = Gem::Version.new(Support.nvim_version)
+
+    if !requirement.satisfied_by?(nvim_version)
+      skip "Skipping on nvim #{nvim_version} (requires #{comparator})"
+    end
+  end
+
+  config.after(:suite) do
+    Support.persistent_client.shutdown
+  end
+
   Kernel.srand config.seed
 end
 

data/spec/neovim/api_spec.rb

@@ -2,7 +2,7 @@ require "helper"
 
 module Neovim
   RSpec.describe API do
-    let(:client) { Neovim.attach_child(Support.child_argv) }
+    let(:client) { Support.persistent_client }
 
     let(:api) do
       API.new(
@@ -13,7 +13,7 @@ module Neovim
               {"name" => "nvim_func"},
               {"name" => "nvim_buf_func"},
               {"name" => "nvim_win_func"},
-              {"name" => "nvim_tabpage_func"},
+              {"name" => "nvim_tabpage_func"}
             ]
           }
         ]

data/spec/neovim/buffer_spec.rb

@@ -2,7 +2,7 @@ require "helper"
 
 module Neovim
   RSpec.describe Buffer do
-    let(:client) { Neovim.attach_child(Support.child_argv) }
+    let(:client) { Support.persistent_client }
     let(:buffer) { client.current.buffer }
 
     before do
@@ -11,8 +11,6 @@ module Neovim
       client.command("normal gg")
     end
 
-    after { client.shutdown }
-
     describe "#lines" do
       it "returns a LineRange" do
         expect(buffer.lines).to be_a(LineRange)
@@ -37,9 +35,9 @@ module Neovim
 
     describe "#number" do
       it "returns the buffer number" do
-        expect(buffer.number).to eq(1)
-        client.command("new")
-        expect(client.get_current_buf.number).to eq(2)
+        expect do
+          client.command("new")
+        end.to change { client.get_current_buf.number }
       end
     end
 
@@ -124,6 +122,12 @@ module Neovim
         end.to change { buffer.lines.to_a }.to(["first", "one", "two"])
       end
 
+      it "allows newlines" do
+        expect do
+          buffer.append(0, "first\nsecond")
+        end.to change { buffer.lines.to_a }.to(["first", "second", "one", "two"])
+      end
+
       it "doesn't move the cursor" do
         expect do
           buffer.append(0, "first")

data/spec/neovim/client_info_spec.rb

@@ -0,0 +1,77 @@
+require "neovim/client_info"
+require "neovim/host"
+require "neovim/plugin"
+
+module Neovim
+  RSpec.describe ClientInfo do
+    describe "#to_args" do
+      context ".for_host" do
+        it "returns script-host info" do
+          plugin = double(Plugin, script_host?: true)
+          host = double(Host, plugins: [plugin])
+          info = ClientInfo.for_host(host)
+
+          expect(info.to_args).to match(
+            [
+              "ruby-script-host",
+              {
+                "major" => duck_type(:to_int),
+                "minor" => duck_type(:to_int),
+                "patch" => duck_type(:to_int)
+              },
+              :host,
+              {
+                poll: {},
+                specs: {nargs: 1}
+              },
+              duck_type(:to_hash)
+            ]
+          )
+        end
+
+        it "returns rplugin info" do
+          plugin = double(Plugin, script_host?: false)
+          host = double(Host, plugins: [plugin])
+          info = ClientInfo.for_host(host)
+
+          expect(info.to_args).to match(
+            [
+              "ruby-rplugin-host",
+              {
+                "major" => duck_type(:to_int),
+                "minor" => duck_type(:to_int),
+                "patch" => duck_type(:to_int)
+              },
+              :host,
+              {
+                poll: {},
+                specs: {nargs: 1}
+              },
+              duck_type(:to_hash)
+            ]
+          )
+        end
+      end
+
+      context ".for_client" do
+        it "returns remote client info" do
+          info = ClientInfo.for_client
+
+          expect(info.to_args).to match(
+            [
+              "ruby-client",
+              {
+                "major" => duck_type(:to_int),
+                "minor" => duck_type(:to_int),
+                "patch" => duck_type(:to_int)
+              },
+              :remote,
+              {},
+              duck_type(:to_hash)
+            ]
+          )
+        end
+      end
+    end
+  end
+end

data/spec/neovim/client_spec.rb

@@ -2,26 +2,33 @@ require "helper"
 
 module Neovim
   RSpec.describe Client do
-    let(:client) { Neovim.attach_child(Support.child_argv) }
-    after { client.shutdown }
+    let(:client) { Support.persistent_client }
 
     describe "#set_option" do
       it "sets an option from two arguments" do
-        expect {
+        expect do
           client.set_option("makeprg", "rake")
-        }.to change { client.evaluate("&makeprg") }.to("rake")
+        end.to change { client.evaluate("&makeprg") }.to("rake")
       end
 
       it "sets an option from a string" do
-        expect {
+        expect do
           client.set_option("timeoutlen=0")
-        }.to change { client.evaluate("&timeoutlen") }.to(0)
+        end.to change { client.evaluate("&timeoutlen") }.to(0)
       end
 
       it "sets a boolean option" do
-        expect {
+        expect do
           client.set_option("expandtab")
-        }.to change { client.evaluate("&expandtab") }.to(1)
+        end.to change { client.evaluate("&expandtab") }.to(1)
+      end
+    end
+
+    describe "#shutdown" do
+      it "causes nvim to exit" do
+        client = Neovim.attach_child(Support.child_argv)
+        client.shutdown
+        expect { client.strwidth("hi") }.to raise_error(Neovim::Session::Disconnected)
       end
     end
 
@@ -45,15 +52,15 @@ module Neovim
       end
 
       it "raises exceptions for unknown methods" do
-        expect {
+        expect do
           client.foobar
-        }.to raise_error(NoMethodError)
+        end.to raise_error(NoMethodError)
       end
 
       it "raises exceptions for incorrect usage" do
-        expect {
+        expect do
           client.strwidth("too", "many")
-        }.to raise_error("Wrong number of arguments: expecting 1 but got 2")
+        end.to raise_error("Wrong number of arguments: expecting 1 but got 2")
       end
     end
 

data/spec/neovim/connection_spec.rb

@@ -0,0 +1,106 @@
+require "helper"
+
+module Neovim
+  RSpec.describe Connection do
+    let(:nil_io) { StringIO.new }
+
+    describe "#write" do
+      it "writes msgpack to the underlying file descriptor" do
+        rd, wr = IO.pipe
+        Connection.new(nil_io, wr).write("some data").flush
+        data = rd.readpartial(1024)
+
+        expect(MessagePack.unpack(data)).to eq("some data")
+      end
+    end
+
+    describe "#flush" do
+      it "flushes writes to the underlying file descriptor" do
+        rd, wr = IO.pipe
+        connection = Connection.new(nil_io, wr).write("some data")
+
+        expect { rd.read_nonblock(16) }.to raise_error(IO::WaitReadable)
+
+        connection.flush
+
+        expect(rd.read_nonblock(16)).to eq(MessagePack.pack("some data"))
+      end
+
+      it "throws an exception when the file is closed" do
+        _, wr = IO.pipe
+        connection = Connection.new(nil_io, wr).write("some data")
+        wr.close
+
+        expect { connection.flush }.to raise_error(IOError)
+      end
+    end
+
+    describe "#read" do
+      it "reads msgpack from the underlying file descriptor" do
+        rd, wr = IO.pipe
+        wr.write(MessagePack.pack("some data"))
+        wr.flush
+
+        connection = Connection.new(rd, nil_io)
+        expect(connection.read).to eq("some data")
+      end
+
+      it "throws an exception when the file is closed" do
+        rd, wr = IO.pipe
+        wr.close
+
+        connection = Connection.new(rd, nil_io)
+        expect { connection.read }.to raise_error(EOFError)
+      end
+    end
+
+    describe "#register_type" do
+      it "registers a msgpack ext type" do
+        ext_class = Struct.new(:id) do
+          def self.from_msgpack_ext(data)
+            new(data.unpack("N")[0])
+          end
+
+          def to_msgpack_ext
+            [id].pack("C")
+          end
+        end
+
+        client_rd, server_wr = IO.pipe
+        _, client_wr = IO.pipe
+
+        connection = Connection.new(client_rd, client_wr)
+
+        connection.register_type(42) do |id|
+          ext_class.new(id)
+        end
+
+        factory = MessagePack::Factory.new
+        factory.register_type(42, ext_class)
+        obj = ext_class.new(1)
+        factory.packer(server_wr).write(obj).flush
+
+        expect(connection.read).to eq(obj)
+      end
+    end
+
+    describe "#close" do
+      it "closes IO handles" do
+        rd, wr = ::IO.pipe
+        Connection.new(rd, wr).close
+
+        expect(rd).to be_closed
+        expect(wr).to be_closed
+      end
+
+      it "kills spawned processes" do
+        io = ::IO.popen("cat", "rb+")
+        pid = io.pid
+        thr = Process.detach(pid)
+
+        Connection.new(io, nil_io).close
+        expect(thr.join.pid).to eq(pid)
+      end
+    end
+  end
+end

data/spec/neovim/current_spec.rb

@@ -2,9 +2,8 @@ require "helper"
 
 module Neovim
   RSpec.describe Current do
-    let(:client) { Neovim.attach_child(Support.child_argv) }
+    let(:client) { Support.persistent_client }
     let(:current) { client.current }
-    after { client.shutdown }
 
     describe "#line" do
       it "returns an empty string if the current line is empty" do
@@ -35,9 +34,9 @@ module Neovim
         initial_index = current.buffer.index
         client.command("vnew")
 
-        expect {
+        expect do
           current.buffer = initial_index
-        }.to change { current.buffer.index }.to(initial_index)
+        end.to change { current.buffer.index }.to(initial_index)
       end
 
       it "sets the current buffer from a Buffer" do
@@ -45,9 +44,9 @@ module Neovim
         client.command("vnew")
         b1 = current.buffer
 
-        expect {
+        expect do
           current.buffer = b0
-        }.to change { current.buffer }.from(b1).to(b0)
+        end.to change { current.buffer }.from(b1).to(b0)
       end
 
       it "returns an integer" do
@@ -72,9 +71,9 @@ module Neovim
         start_index = current.window.index
         client.command("vsp")
 
-        expect {
+        expect do
           current.window = start_index
-        }.to change { current.window.index }.to(start_index)
+        end.to change { current.window.index }.to(start_index)
       end
 
       it "sets the current window from a Window" do
@@ -82,9 +81,9 @@ module Neovim
         client.command("vsp")
         w1 = current.window
 
-        expect {
+        expect do
           current.window = w0
-        }.to change { current.window }.from(w1).to(w0)
+        end.to change { current.window }.from(w1).to(w0)
       end
 
       it "returns an integer" do
@@ -110,9 +109,9 @@ module Neovim
         client.command("tabnew")
         expect(current.tabpage.index).not_to eq(initial_index)
 
-        expect {
+        expect do
           current.tabpage = initial_index
-        }.to change { current.tabpage.index }.to(initial_index)
+        end.to change { current.tabpage.index }.to(initial_index)
       end
 
       it "sets the current tabpage from a Tabpage" do
@@ -120,9 +119,9 @@ module Neovim
         client.command("tabnew")
         tp1 = current.tabpage
 
-        expect {
+        expect do
           current.tabpage = tp0
-        }.to change { current.tabpage }.from(tp1).to(tp0)
+        end.to change { current.tabpage }.from(tp1).to(tp0)
       end
 
       it "returns an integer" do