neovim 0.5.1 → 0.6.0

data/spec/acceptance/runtime/init.vim

@@ -0,0 +1,8 @@
+let s:lib_path = getcwd() . "/../../lib/"
+let s:bin_path = getcwd() . "/../../bin/neovim-ruby-host"
+let g:ruby_host_prog = printf("ruby -I %s %s", s:lib_path, s:bin_path)
+
+ruby require "rspec/expectations"
+ruby include ::RSpec::Matchers.dup
+
+set rtp=./runtime,./runtime/vader.vim,$VIMRUNTIME

data/spec/acceptance/runtime/rplugin.vim

@@ -0,0 +1,37 @@
+" python3 plugins
+
+
+" ruby plugins
+call remote#host#RegisterPlugin('ruby', './runtime/rplugin/ruby/autocmds.rb', [
+      \ {'sync': v:false, 'name': 'BufEnter', 'type': 'autocmd', 'opts': {'pattern': '*.rb'}},
+      \ {'sync': v:false, 'name': 'BufEnter', 'type': 'autocmd', 'opts': {'pattern': '*.c', 'eval': 'g:to_eval'}},
+     \ ])
+call remote#host#RegisterPlugin('ruby', './runtime/rplugin/ruby/commands.rb', [
+      \ {'sync': v:false, 'name': 'RPluginCommandNargs0', 'type': 'command', 'opts': {}},
+      \ {'sync': v:false, 'name': 'RPluginCommandNargs1', 'type': 'command', 'opts': {'nargs': 1}},
+      \ {'sync': v:false, 'name': 'RPluginCommandNargsN', 'type': 'command', 'opts': {'nargs': '*'}},
+      \ {'sync': v:false, 'name': 'RPluginCommandNargsQ', 'type': 'command', 'opts': {'nargs': '?'}},
+      \ {'sync': v:false, 'name': 'RPluginCommandNargsP', 'type': 'command', 'opts': {'nargs': '+'}},
+      \ {'sync': v:false, 'name': 'RPluginCommandRange', 'type': 'command', 'opts': {'range': ''}},
+      \ {'sync': v:false, 'name': 'RPluginCommandRangeP', 'type': 'command', 'opts': {'range': '%'}},
+      \ {'sync': v:false, 'name': 'RPluginCommandRangeN', 'type': 'command', 'opts': {'range': '1'}},
+      \ {'sync': v:false, 'name': 'RPluginCommandCountN', 'type': 'command', 'opts': {'count': 1}},
+      \ {'sync': v:false, 'name': 'RPluginCommandBang', 'type': 'command', 'opts': {'bang': ''}},
+      \ {'sync': v:false, 'name': 'RPluginCommandRegister', 'type': 'command', 'opts': {'register': ''}},
+      \ {'sync': v:false, 'name': 'RPluginCommandCompletion', 'type': 'command', 'opts': {'complete': 'buffer'}},
+      \ {'sync': v:false, 'name': 'RPluginCommandEval', 'type': 'command', 'opts': {'eval': 'g:to_eval'}},
+      \ {'sync': v:true, 'name': 'RPluginCommandSync', 'type': 'command', 'opts': {}},
+      \ {'sync': v:true, 'name': 'RPluginCommandRecursive', 'type': 'command', 'opts': {'nargs': 1}},
+     \ ])
+call remote#host#RegisterPlugin('ruby', './runtime/rplugin/ruby/functions.rb', [
+      \ {'sync': v:false, 'name': 'RPluginFunctionArgs', 'type': 'function', 'opts': {}},
+      \ {'sync': v:false, 'name': 'RPluginFunctionRange', 'type': 'function', 'opts': {'range': ''}},
+      \ {'sync': v:false, 'name': 'RPluginFunctionEval', 'type': 'function', 'opts': {'eval': 'g:to_eval'}},
+      \ {'sync': v:true, 'name': 'RPluginFunctionSync', 'type': 'function', 'opts': {}},
+      \ {'sync': v:true, 'name': 'RPluginFunctionRecursive', 'type': 'function', 'opts': {'nargs': 1}},
+     \ ])
+
+
+" python plugins
+
+

data/spec/{integration → acceptance}/runtime/rplugin/ruby/autocmds.rb

@@ -4,6 +4,6 @@ Neovim.plugin do |plug|
   end
 
   plug.autocmd(:BufEnter, :pattern => "*.c", :eval => "g:to_eval") do |nvim, to_eval|
-    nvim.set_var("rplugin_autocmd_BufEnter_eval", to_eval)
+    nvim.set_var("rplugin_autocmd_BufEnter_eval", to_eval.merge(:b => 43))
   end
 end

data/spec/{integration → acceptance}/runtime/rplugin/ruby/commands.rb

@@ -50,10 +50,18 @@ Neovim.plugin do |plug|
   end
 
   plug.command(:RPluginCommandEval, :eval => "g:to_eval") do |nvim, to_eval|
-    nvim.set_var("rplugin_command_eval", to_eval)
+    nvim.set_var("rplugin_command_eval", to_eval.merge(:b => 43))
   end
 
   plug.command(:RPluginCommandSync, :sync => true) do |nvim|
     nvim.set_var("rplugin_command_sync", true)
   end
+
+  plug.command(:RPluginCommandRecursive, :sync => true, :nargs => 1) do |nvim, n|
+    if Integer(n) >= 10
+      nvim.set_var("rplugin_command_recursive", n)
+    else
+      nvim.command("RPluginCommandRecursive #{n.succ}")
+    end
+  end
 end

data/spec/{integration → acceptance}/runtime/rplugin/ruby/functions.rb

@@ -8,10 +8,18 @@ Neovim.plugin do |plug|
   end
 
   plug.function(:RPluginFunctionEval, :eval => "g:to_eval") do |nvim, to_eval|
-    nvim.set_var("rplugin_function_eval", to_eval)
+    nvim.set_var("rplugin_function_eval", to_eval.merge(:b => 43))
   end
 
   plug.function(:RPluginFunctionSync, :sync => true) do |nvim|
     true
   end
+
+  plug.function(:RPluginFunctionRecursive, :sync => true, :nargs => 1) do |nvim, n|
+    if n >= 10
+      n
+    else
+      nvim.evaluate("RPluginFunctionRecursive(#{n + 1})")
+    end
+  end
 end

data/spec/acceptance_spec.rb

@@ -0,0 +1,74 @@
+ENV.delete("VIM")
+ENV.delete("VIMRUNTIME")
+
+require "json"
+require "net/http"
+require "open-uri"
+require "tempfile"
+
+RSpec.describe "Acceptance", :timeout => 10 do
+  let(:root) { File.expand_path("../acceptance", __FILE__) }
+  let(:init) { File.join(root, "runtime/init.vim") }
+  let(:manifest) { File.join(root, "runtime/rplugin.vim") }
+
+  around do |spec|
+    Dir.chdir(root) { spec.run }
+  end
+
+  describe "Vim compatibility" do
+    ["ruby", "rubyfile", "rubydo"].each do |feature|
+      specify ":#{feature}" do
+        run_vader("#{feature}_spec.vim") do |status, output|
+          expect(status).to be_success, lambda { output.read }
+        end
+      end
+    end
+  end
+
+  describe "Remote plugin DSL" do
+    ["command", "function", "autocmd"].each do |feature|
+      specify "##{feature}" do
+        run_vader("rplugin_#{feature}_spec.vim") do |status, output|
+          expect(status).to be_success, lambda { output.read }
+        end
+      end
+    end
+  end
+
+  describe "Generated documentation" do
+    it "is up to date" do
+      begin
+        url = "https://api.github.com/repos/neovim/neovim/releases/latest"
+        response = open(url) { |json| JSON.load(json) }
+
+        client_file = File.read(
+          File.expand_path("../../lib/neovim/client.rb", __FILE__)
+        )
+        docs_version = client_file[
+          /The methods documented here were generated using (.+)$/,
+          1
+        ]
+
+        expect(docs_version).to eq(response["name"])
+      rescue SocketError, OpenURI::HTTPError => e
+        skip "Skipping: #{e}"
+      end
+    end
+  end
+
+  def run_nvim(env, *opts)
+    nvim = env.fetch("NVIM_EXECUTABLE", "nvim")
+    system(env, nvim, "--headless", "-n", "-u", init, *opts)
+  end
+
+  def run_vader(test_path)
+    Tempfile.open("vader.out") do |out|
+      run_nvim(
+        {"NVIM_RPLUGIN_MANIFEST" => manifest, "VADER_OUTPUT_FILE" => out.path},
+        "-c", "Vader! #{test_path}"
+      )
+
+      yield $?, out
+    end
+  end
+end

data/spec/helper.rb

@@ -11,6 +11,8 @@ require "pry"
 require "rubygems"
 require "stringio"
 require "timeout"
+require "securerandom"
+require "msgpack"
 
 require File.expand_path("../support.rb", __FILE__)
 
@@ -22,7 +24,6 @@ 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
@@ -35,37 +36,6 @@ RSpec.configure do |config|
     end
   end
 
-  config.around(:example, :silence_warnings) do |spec|
-    old_logger = Neovim.logger
-    log_target = StringIO.new
-    Neovim.logger = Logger.new(log_target)
-    Neovim.logger.level = Logger::WARN
-
-    begin
-      spec.run
-
-      expect(log_target.string).not_to be_empty,
-        ":silence_warnings used but nothing logged at WARN level"
-    ensure
-      Neovim.logger = old_logger
-    end
-  end
-
-  config.before(:example, :nvim_version) do |spec|
-    req = Gem::Requirement.new(spec.metadata[:nvim_version])
-
-    begin
-      nvim_vrs = Support.nvim_version
-      vrs = Gem::Version.new(nvim_vrs)
-    rescue ArgumentError
-      vrs = Gem::Version.new(nvim_vrs.gsub("-", "."))
-    end
-
-    unless req.satisfied_by?(vrs.release)
-      pending "Pending: Installed nvim (#{vrs}) doesn't satisfy '#{req}'."
-    end
-  end
-
   Kernel.srand config.seed
 end
 

data/spec/neovim/api_spec.rb

@@ -0,0 +1,59 @@
+require "helper"
+
+module Neovim
+  RSpec.describe API do
+    let(:client) { Neovim.attach_child(Support.child_argv) }
+
+    let(:api) do
+      API.new(
+        [
+          nil,
+          {
+            "functions" => [
+              {"name" => "nvim_func"},
+              {"name" => "nvim_buf_func"},
+              {"name" => "nvim_win_func"},
+              {"name" => "nvim_tabpage_func"},
+            ]
+          }
+        ]
+      )
+    end
+
+    describe "#functions_for_object_method" do
+      it "returns relevant functions" do
+        function = api.function_for_object_method(client, :func)
+        expect(function.name).to eq("nvim_func")
+
+        function = api.function_for_object_method(client.get_current_buf, :func)
+        expect(function.name).to eq("nvim_buf_func")
+
+        function = api.function_for_object_method(client.get_current_win, :func)
+        expect(function.name).to eq("nvim_win_func")
+
+        function = api.function_for_object_method(client.get_current_tabpage, :func)
+        expect(function.name).to eq("nvim_tabpage_func")
+      end
+    end
+
+    describe "#functions_for_object" do
+      it "returns relevant functions" do
+        functions = api.functions_for_object(client)
+        expect(functions.size).to be(1)
+        expect(functions.first.name).to eq("nvim_func")
+
+        functions = api.functions_for_object(client.get_current_buf)
+        expect(functions.size).to be(1)
+        expect(functions.first.name).to eq("nvim_buf_func")
+
+        functions = api.functions_for_object(client.get_current_win)
+        expect(functions.size).to be(1)
+        expect(functions.first.name).to eq("nvim_win_func")
+
+        functions = api.functions_for_object(client.get_current_tabpage)
+        expect(functions.size).to be(1)
+        expect(functions.first.name).to eq("nvim_tabpage_func")
+      end
+    end
+  end
+end

data/spec/neovim/buffer_spec.rb

@@ -4,6 +4,13 @@ module Neovim
   RSpec.describe Buffer do
     let(:client) { Neovim.attach_child(Support.child_argv) }
     let(:buffer) { client.current.buffer }
+
+    before do
+      client.command("normal ione")
+      client.command("normal otwo")
+      client.command("normal gg")
+    end
+
     after { client.shutdown }
 
     describe "#lines" do
@@ -14,8 +21,160 @@ module Neovim
 
     describe "#lines=" do
       it "updates the buffer's lines" do
-        buffer.lines = ["one", "two"]
-        expect(buffer.lines.to_a).to eq(["one", "two"])
+        expect do
+          buffer.lines = ["two", "three"]
+        end.to change { buffer.lines.to_a }.to(["two", "three"])
+      end
+    end
+
+    describe "#set_name", "#name" do
+      it "updates the buffer name" do
+        expect do
+          buffer.set_name("test_buf")
+        end.to change { buffer.name }.to(/test_buf$/)
+      end
+    end
+
+    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)
+      end
+    end
+
+    describe "#count" do
+      it "returns the number of lines" do
+        expect do
+          buffer.append(0, "zero")
+        end.to change { buffer.count }.from(2).to(3)
+      end
+    end
+
+    describe "#length" do
+      it "returns the number of lines" do
+        expect do
+          buffer.append(0, "zero")
+        end.to change { buffer.length }.from(2).to(3)
+      end
+    end
+
+    describe "#[]" do
+      it "returns the line at the line number" do
+        expect(buffer[1]).to eq("one")
+      end
+
+      it "raises on out of bounds" do
+        expect do
+          buffer[-1]
+        end.to raise_error(/out of bounds/)
+
+        expect do
+          buffer[4]
+        end.to raise_error(/out of bounds/)
+      end
+    end
+
+    describe "#[]=" do
+      it "sets the line at the line number" do
+        expect do
+          buffer[1] = "first"
+        end.to change { buffer[1] }.from("one").to("first")
+      end
+
+      it "raises on out of bounds" do
+        expect do
+          buffer[4] = "line"
+        end.to raise_error(/out of bounds/)
+
+        expect do
+          buffer[-1] = "line"
+        end.to raise_error(/out of bounds/)
+      end
+    end
+
+    describe "#delete" do
+      it "deletes at the line number" do
+        expect do
+          buffer.delete(2)
+        end.to change { buffer.lines.to_a }.to(["one"])
+      end
+
+      it "raises on out of bounds" do
+        expect do
+          buffer.delete(-1)
+        end.to raise_error(/out of bounds/)
+
+        expect do
+          buffer.delete(4)
+        end.to raise_error(/out of bounds/)
+      end
+    end
+
+    describe "#append" do
+      it "appends after the line" do
+        expect do
+          buffer.append(2, "last")
+        end.to change { buffer.lines.to_a }.to(["one", "two", "last"])
+      end
+
+      it "inserts before the first line" do
+        expect do
+          buffer.append(0, "first")
+        end.to change { buffer.lines.to_a }.to(["first", "one", "two"])
+      end
+
+      it "doesn't move the cursor" do
+        expect do
+          buffer.append(0, "first")
+        end.not_to change { client.get_current_win.cursor }
+      end
+
+      it "raises on out of bounds" do
+        expect do
+          buffer.append(-1, "line")
+        end.to raise_error(/out of bounds/)
+
+        expect do
+          buffer.append(4, "line")
+        end.to raise_error(/out of bounds/)
+      end
+    end
+
+    describe "#line_number" do
+      it "returns the current line number" do
+        expect do
+          client.command("normal j")
+        end.to change { buffer.line_number }.from(1).to(2)
+      end
+
+      it "returns nil on inactive buffers" do
+        expect do
+          client.command("new")
+        end.to change { buffer.line_number }.from(1).to(nil)
+      end
+    end
+
+    describe "#line" do
+      before { buffer.lines = ["one", "two"] }
+
+      it "returns the current line" do
+        expect do
+          client.command("normal j")
+        end.to change { buffer.line }.from("one").to("two")
+      end
+
+      it "returns nil for inactive buffers" do
+        client.command("new")
+        expect(buffer.line).to eq(nil)
+      end
+    end
+
+    describe "#line=" do
+      it "updates the current line" do
+        expect do
+          buffer.line = "first"
+        end.to change { buffer.line }.to("first")
       end
     end
   end