neovim 0.7.1 → 0.9.0

data/lib/neovim/client_info.rb

@@ -0,0 +1,46 @@
+require "neovim/version"
+
+module Neovim
+  # @api private
+  class ClientInfo
+    HOST_METHOD_SPEC = {poll: {}, specs: {nargs: 1}}.freeze
+
+    ATTRIBUTES = {
+      website: "https://github.com/neovim/neovim-ruby",
+      license: "MIT"
+    }.freeze
+
+    def self.for_host(host)
+      name = host.plugins.map(&:script_host?) == [true] ?
+        "ruby-script-host" :
+        "ruby-rplugin-host"
+
+      new(name, :host, HOST_METHOD_SPEC, ATTRIBUTES)
+    end
+
+    def self.for_client
+      new("ruby-client", :remote, {}, ATTRIBUTES)
+    end
+
+    def initialize(name, type, method_spec, attributes)
+      @name = name
+      @type = type
+      @method_spec = method_spec
+      @attributes = attributes
+
+      @version = ["major", "minor", "patch"]
+        .zip(Neovim::VERSION.segments)
+        .to_h
+    end
+
+    def to_args
+      [
+        @name,
+        @version,
+        @type,
+        @method_spec,
+        @attributes
+      ]
+    end
+  end
+end

data/lib/neovim/connection.rb

@@ -35,12 +35,12 @@ module Neovim
 
       @unpacker = MessagePack::Unpacker.new(@rd)
       @packer = MessagePack::Packer.new(@wr)
-      @running = false
     end
 
     def write(object)
       log(:debug) { {object: object} }
-      @packer.write(object).flush
+      @packer.write(object)
+      self
     end
 
     def read
@@ -49,6 +49,11 @@ module Neovim
       end
     end
 
+    def flush
+      @packer.flush
+      self
+    end
+
     def register_type(id)
       @unpacker.register_type(id) do |data|
         index = MessagePack.unpack(data)

data/lib/neovim/event_loop.rb

@@ -34,8 +34,9 @@ module Neovim
     end
 
     def shutdown
-      stop
+      @running = false
       @shutdown = true
+      @connection.close
     end
 
     def request(request_id, method, *args)
@@ -69,20 +70,23 @@ module Neovim
 
     def run
       @running = true
+      last_value = nil
 
       loop do
         break unless @running
         break if @shutdown
 
         begin
-          yield read
-        rescue EOFError => e
+          last_value = yield(read)
+        rescue EOFError, Errno::EPIPE => e
           log_exception(:debug, e, __method__)
           shutdown
         rescue => e
           log_exception(:error, e, __method__)
         end
       end
+
+      last_value
     ensure
       @connection.close if @shutdown
     end
@@ -102,7 +106,7 @@ module Neovim
     private
 
     def read
-      array = @connection.read
+      array = @connection.flush.read
       Message.from_array(array)
     end
 

data/lib/neovim/host/cli.rb

@@ -0,0 +1,41 @@
+require "neovim/connection"
+require "neovim/event_loop"
+require "neovim/host"
+require "neovim/version"
+require "optparse"
+
+module Neovim
+  class Host
+    # @api private
+    class CLI
+      def self.run(path, argv, inn, out, err)
+        cmd = File.basename(path)
+
+        OptionParser.new do |opts|
+          opts.on("-V", "--version") do
+            out.puts Neovim::VERSION
+            exit(0)
+          end
+
+          opts.on("-h", "--help") do
+            out.puts "Usage: #{cmd} [-hV] rplugin_path ..."
+            exit(0)
+          end
+        end.order!(argv)
+
+        if inn.tty?
+          err.puts("Can't run #{cmd} interactively.")
+          exit(1)
+        else
+          conn = Connection.new(inn, out)
+          event_loop = EventLoop.new(conn)
+
+          Host.run(argv, event_loop)
+        end
+      rescue OptionParser::InvalidOption => e
+        err.puts(e.message)
+        exit(1)
+      end
+    end
+  end
+end

data/lib/neovim/host.rb

@@ -1,5 +1,6 @@
 require "neovim"
 require "neovim/client"
+require "neovim/client_info"
 require "neovim/event_loop"
 require "neovim/host/loader"
 
@@ -78,6 +79,8 @@ module Neovim
 
     def initialize_client(request_id)
       @session.request_id = request_id
+      @session.notify(:nvim_set_client_info, *ClientInfo.for_host(self).to_args)
+
       @client = Client.from_event_loop(@event_loop, @session)
     end
 

data/lib/neovim/logging.rb

@@ -18,7 +18,7 @@ module Neovim
 
       @logger = Logger.new(env_file || STDERR)
 
-      if env_level
+      if /\S+/.match?(env_level)
         begin
           @logger.level = Integer(env_level)
         rescue ArgumentError

data/lib/neovim/message.rb

@@ -49,7 +49,7 @@ module Neovim
       end
 
       def received(handlers)
-        handlers[request_id].call(self)
+        handlers.delete(request_id).call(self)
       end
     end
 

data/lib/neovim/plugin/dsl.rb

@@ -68,6 +68,12 @@ module Neovim
 
       private
 
+      # Mark this plugin as the Ruby script host started by nvim. Should only
+      # be used in +Neovim::RubyProvider+.
+      def script_host!
+        @plugin.script_host = true
+      end
+
       # Register a setup block to run once before the host starts. The block
       # should expect to receive a single argument, a +Neovim::Client+.
       #

data/lib/neovim/plugin.rb

@@ -3,7 +3,7 @@ require "neovim/plugin/dsl"
 module Neovim
   # @api private
   class Plugin
-    attr_accessor :handlers, :setup_blocks
+    attr_accessor :handlers, :setup_blocks, :script_host
     attr_reader :source
 
     def self.from_config_block(source)
@@ -13,9 +13,10 @@ module Neovim
     end
 
     def initialize(source)
-      @handlers = []
       @source = source
+      @handlers = []
       @setup_blocks = []
+      @script_host = false
     end
 
     def specs
@@ -27,5 +28,9 @@ module Neovim
     def setup(client)
       @setup_blocks.each { |bl| bl.call(client) }
     end
+
+    def script_host?
+      !!@script_host
+    end
   end
 end

data/lib/neovim/remote_object.rb

@@ -1,3 +1,5 @@
+require "set"
+
 module Neovim
   # @abstract Superclass for all +nvim+ remote objects.
   #
@@ -37,7 +39,7 @@ module Neovim
 
     # Extend +methods+ to include RPC methods
     def methods(*args)
-      super | rpc_methods
+      super | rpc_methods.to_a
     end
 
     # Extend +==+ to only look at class and index.
@@ -48,7 +50,8 @@ module Neovim
     private
 
     def rpc_methods
-      @api.functions_for_object(self).map(&:method_name)
+      @rpc_methods ||=
+        @api.functions_for_object(self).map(&:method_name).to_set
     end
   end
 end

data/lib/neovim/ruby_provider/object_ext.rb

@@ -0,0 +1,5 @@
+class Object
+  def to_msgpack(packer)
+    packer.pack(to_s)
+  end
+end

data/lib/neovim/ruby_provider/vim.rb

@@ -15,7 +15,7 @@ module Vim
 
   # Delegate all method calls to the underlying +Neovim::Client+ object.
   def self.method_missing(method, *args, &block)
-    if @__client.respond_to?(method)
+    if @__client
       @__client.public_send(method, *args, &block).tap do
         __refresh_globals(@__client)
       end
@@ -33,13 +33,14 @@ module Vim
   end
 
   def self.__refresh_globals(client)
-    bufnr = client.evaluate("bufnr('%')")
+    bufid, winid = client.evaluate("[nvim_get_current_buf(), nvim_get_current_win()]")
+    session, api = client.session, client.api
 
-    $curbuf = @__buffer_cache.fetch(bufnr) do
-      @__buffer_cache[bufnr] = client.get_current_buf
+    $curbuf = @__buffer_cache.fetch(bufid) do
+      @__buffer_cache[bufid] = Buffer.new(bufid, session, api)
     end
 
-    $curwin = client.get_current_win
+    $curwin = Window.new(winid, session, api)
   end
 end
 

data/lib/neovim/ruby_provider.rb

@@ -1,4 +1,5 @@
 require "neovim/ruby_provider/vim"
+require "neovim/ruby_provider/object_ext"
 require "neovim/ruby_provider/buffer_ext"
 require "neovim/ruby_provider/window_ext"
 require "stringio"
@@ -14,8 +15,11 @@ module Neovim
       Thread.abort_on_exception = true
 
       Neovim.plugin do |plug|
+        plug.__send__(:script_host!)
+
         __define_setup(plug)
         __define_ruby_execute(plug)
+        __define_ruby_eval(plug)
         __define_ruby_execute_file(plug)
         __define_ruby_do_range(plug)
         __define_ruby_chdir(plug)
@@ -42,12 +46,26 @@ module Neovim
     def self.__define_ruby_execute(plug)
       plug.__send__(:rpc, :ruby_execute) do |nvim, ruby|
         __wrap_client(nvim) do
-          eval(ruby, TOPLEVEL_BINDING, "eval")
+          eval(ruby, TOPLEVEL_BINDING, "ruby_execute")
         end
+        nil
       end
     end
     private_class_method :__define_ruby_execute
 
+    # Evaluate the provided Ruby code, exposing the +Vim+ constant for
+    # interactions with the editor and returning the value.
+    #
+    # This is used by the +:rubyeval+ command.
+    def self.__define_ruby_eval(plug)
+      plug.__send__(:rpc, :ruby_eval) do |nvim, ruby|
+        __wrap_client(nvim) do
+          eval(ruby, TOPLEVEL_BINDING, "ruby_eval")
+        end
+      end
+    end
+    private_class_method :__define_ruby_eval
+
     # Evaluate the provided Ruby file, exposing the +Vim+ constant for
     # interactions with the editor.
     #
@@ -55,6 +73,7 @@ module Neovim
     def self.__define_ruby_execute_file(plug)
       plug.__send__(:rpc, :ruby_execute_file) do |nvim, path|
         __wrap_client(nvim) { load(path) }
+        nil
       end
     end
     private_class_method :__define_ruby_execute_file
@@ -73,14 +92,15 @@ module Neovim
           __start, __stop, __ruby = __args
           __buffer = __nvim.get_current_buf
 
-          __update_lines_in_chunks(__buffer, __start, __stop, 5000) do |__lines|
+          __update_lines_in_chunks(__buffer, __start, __stop, 1_000) do |__lines|
             __lines.map do |__line|
               $_ = __line
-              eval(__ruby, binding, "eval")
+              eval(__ruby, binding, "ruby_do_range")
               $_
             end
           end
         end
+        nil
       end
     end
     private_class_method :__define_ruby_do_range
@@ -101,7 +121,6 @@ module Neovim
           yield
         end
       end
-      nil
     end
     private_class_method :__wrap_client
 
@@ -120,10 +139,10 @@ module Neovim
       $stdout, $stderr = StringIO.new, StringIO.new
 
       begin
-        yield
-
-        client.out_write($stdout.string + $/) if $stdout.size > 0
-        client.err_writeln($stderr.string) if $stderr.size > 0
+        yield.tap do
+          client.out_write($stdout.string + $/) if $stdout.size > 0
+          client.err_writeln($stderr.string) if $stderr.size > 0
+        end
       ensure
         $stdout = old_stdout
         $stderr = old_stderr
@@ -134,9 +153,9 @@ module Neovim
     def self.__update_lines_in_chunks(buffer, start, stop, size)
       (start..stop).each_slice(size) do |linenos|
         start, stop = linenos[0] - 1, linenos[-1]
-        lines = buffer.get_lines(start, stop, true)
+        lines = buffer.get_lines(start, stop, false)
 
-        buffer.set_lines(start, stop, true, yield(lines))
+        buffer.set_lines(start, stop, false, yield(lines))
       end
     end
     private_class_method :__update_lines_in_chunks

data/lib/neovim/session.rb

@@ -11,6 +11,13 @@ module Neovim
 
     attr_writer :request_id
 
+    # @api private
+    class Disconnected < RuntimeError
+      def initialize
+        super("Disconnected from nvim process")
+      end
+    end
+
     def initialize(event_loop)
       @event_loop = event_loop
       @main_thread = Thread.current
@@ -21,19 +28,21 @@ module Neovim
     end
 
     def run(&block)
-      @running = true
+      block ||= ->(msg) { @pending_messages << msg }
 
-      while (pending = @pending_messages.shift)
-        Fiber.new { pending.received(@response_handlers, &block) }.resume
-      end
-
-      return unless @running
+      @running = true
 
       @event_loop.run do |message|
         Fiber.new { message.received(@response_handlers, &block) }.resume
       end
     end
 
+    def next
+      return @pending_messages.shift if @pending_messages.any?
+
+      run { |msg| stop; msg }
+    end
+
     # Make an RPC request and return its response.
     #
     # If this method is called inside a callback, we are already inside a
@@ -60,7 +69,10 @@ module Neovim
 
         @event_loop.request(@request_id, method, *args)
         response = blocking ? blocking_response : yielding_response
-        response.error ? raise(response.error) : response.value
+
+        raise(Disconnected) if response.nil?
+        raise(response.error) if response.error
+        response.value
       end
     end
 
@@ -85,15 +97,8 @@ module Neovim
     private
 
     def blocking_response
-      response = nil
-
-      @response_handlers[@request_id] = lambda do |res|
-        response = res
-        stop
-      end
-
-      run { |message| @pending_messages << message }
-      response
+      @response_handlers[@request_id] = ->(res) { stop; res }
+      run
     end
 
     def yielding_response