neovim 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6717c82510d557b7fc3f15bd291654a609ffc53d
-  data.tar.gz: e263dccd48b0a244cd67ea6c690eeddd06def246
+SHA256:
+  metadata.gz: 3699ba73810bb643b4a8412a6469d6c0ec95fb138248e4f9a391b7637681cb06
+  data.tar.gz: 9d4e6c4513864df909a791eb23420918fe0426aeeb8d2f2929e6d52cb2b2f48e
 SHA512:
-  metadata.gz: 6b5b1452da5d319b6587a1dba774de9123df333f9793d3f59cde1f730282f6334193174fd812f68d4c9b90117d39252ffaa9ba16b10db4802fe504516022b0e7
-  data.tar.gz: 2b190ba96a1383acbf3ca2b6e968b7ac0a7ffdb9655b3605a2741ab6c7e213f681d178aa2543484501aeef603b9eb0ba8dfd885dbe322851ee7f0f3562cea997
+  metadata.gz: bf087be0814ddb1a5d765e84e462991bccef0ba8135691da379a22393d3743dcbef9cd65307f54cdbb16a8a87e5ccca72c7dbc845714b3035818f2f2108f121c
+  data.tar.gz: e5b78dde7090c6ade20a1869ffacee5f3e1cefdd764be149a6db81fe2f3564c26f570f99b9f048ed3eb1fe9b8f5119febfa11fc01d42bad93a21f9a52caffda0

data/.gitignore

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

data/.travis.yml

@@ -6,16 +6,15 @@ branches:
   only: master
 
 rvm:
-  - 1.9
-  - 2.0
-  - 2.1
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
   - ruby-head
 
 before_install:
   - eval "$(curl -Ss https://raw.githubusercontent.com/neovim/bot-ci/master/scripts/travis-setup.sh) nightly-x64"
+  - gem update --system
   - gem update bundler
   - bundle --version
 

data/CHANGELOG.md

@@ -1,22 +1,36 @@
+# 0.7.0
+
+- Drop support for Ruby < 2.2.0, update syntax accordingly
+- Use msgpack gem for all reading/writing
+- Make provider std stream capturing more robust
+- Lazily instantiate Host client on 'poll' request
+- Fix windows by setting all IOs to binmode
+- Refactor/simplify session and event loop logic
+
 # 0.6.2
+
 - Put IOs into binary mode (fixes windows bugs)
 - Various build fixes for appveyor
 - Update generated docs to v0.2.2
 
 # 0.6.1
+
 - Add `multi_json` dependency to fix load error in certain envs
 
 # 0.6.0
+
 - Refactor: consolidate "run" logic into EventLoop class to simplify middleware
   layers
 - Add JSON structured logging
 - Regenerated docs for nvim 0.2.1
 
 # 0.5.1
+
 - Convert vader.vim from submodule to subtree so it is included in gem
   installations
 
 # 0.5.0
+
 - Breaking API changes:
   - Update generated methods to map to `nvim_` RPC functions, rather than the
     deprecated `vim_` ones
@@ -25,18 +39,22 @@
 - Fix support for `:bang` and `:register` plugin DSL options
 
 # 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
 
 # 0.3.2
+
 - Fix directory tracking in Ruby provider
 
 # 0.3.1
+
 - Remove window caching to fix incompatibilities with command-t
 - Add `Vim` module alias
 - Fix `Window.count` and `Window.[]` to work with tabpages
@@ -45,6 +63,7 @@
 - Make `Neovim.attach_child` have default argv of `["nvim"]`
 
 # 0.3.0
+
 - Mark `Plugin::DSL#rpc` private
 - Rename Session constants:
   - `Neovim::EventLoop` -> `Neovim::Session::EventLoop`
@@ -55,28 +74,34 @@
   - `Neovim::Notification` -> `Neovim::Session::Notification`
 
 # 0.2.5
+
 - Optimize remote function lookup
 - Fix bug where $curbuf and $curwin weren't persisting instance state between
   requests
 
 # 0.2.4
+
 - Maintain cursor position on Buffer#append for compatibility with vim
 - Fix excessive fetching of API metadata
 
 # 0.2.3
+
 - Detach child processes in `Neovim::EventLoop.child`
 - Improve performance/compatibility of `Buffer#append`
 - Various improvements around `Host` loading
 
 # 0.2.2
+
 - Make `VIM` constant a module instead of a class
 - Make `Client#set_option` accept a single string argument
 
 # 0.2.1
+
 - Fix race condition in Fiber handling
 - General improvements to ruby\_provider.rb
 
 # 0.2.0
+
 - Backwards incompatible, but we're pre-1.0.0 so going with minor bump instead
 - Make vim ruby functions 1-indexed
 - Add Client#evaluate and Client#message
@@ -86,6 +111,7 @@
 - Remove race condition in Session fiber handling
 
 # 0.1.0
+
 - Add --version, -V to neovim-ruby-host executable
 - Update object interfaces to be compatible with Vim :ruby API
 - `NVIM_RUBY_LOG_LEVEL` now takes strings, e.g. `DEBUG`
@@ -95,17 +121,20 @@
 - Remove vendored `neovim`
 
 # 0.0.6
+
 - Update Session with improved Fiber coordination
 - Documentation
 - Rename APIInfo -> API
 - Rename Object -> RemoteObject
 
 # 0.0.5
+
 - Various fixes for Ruby remote plugins
 - Move Current#range and #range= methods to Buffer
 - Add better logging
 
 # 0.0.4
+
 - Add support for loading Ruby remote plugins from nvim
 - Add Current#range to return a LineRange enumerable object
 - Support sending large messages

data/Gemfile

@@ -1,13 +1,2 @@
 source "https://rubygems.org"
 gemspec
-
-group :development do
-  if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new("2.0.0")
-    gem "coveralls"
-    gem "pry-byebug"
-  else
-    gem "term-ansicolor", "1.3.2"
-    gem "coveralls", "0.8.13"
-    gem "pry-debugger"
-  end
-end

data/README.md

@@ -54,18 +54,18 @@ Neovim.plugin do |plug|
   # Define a command called "SetLine" which sets the contents of the current
   # line. This command is executed asynchronously, so the return value is
   # ignored.
-  plug.command(:SetLine, :nargs => 1) do |nvim, str|
+  plug.command(:SetLine, nargs: 1) do |nvim, str|
     nvim.current.line = str
   end
 
   # Define a function called "Sum" which adds two numbers. This function is
   # executed synchronously, so the result of the block will be returned to nvim.
-  plug.function(:Sum, :nargs => 2, :sync => true) do |nvim, x, y|
+  plug.function(:Sum, nargs: 2, sync: true) do |nvim, x, y|
     x + y
   end
 
   # Define an autocmd for the BufEnter event on Ruby files.
-  plug.autocmd(:BufEnter, :pattern => "*.rb") do |nvim|
+  plug.autocmd(:BufEnter, pattern: "*.rb") do |nvim|
     nvim.command("echom 'Ruby file, eh?'")
   end
 end

data/Rakefile

@@ -24,4 +24,4 @@ namespace :spec do
   end
 end
 
-task :default => ["spec:functional", "spec:acceptance"]
+task default: ["spec:functional", "spec:acceptance"]

data/appveyor.yml

@@ -1,5 +1,13 @@
+version: '{build}'
+
+environment:
+  matrix:
+    - RUBY_VERSION: 24
+    - RUBY_VERSION: 23
+    - RUBY_VERSION: 22
+
 install:
-  - set PATH=C:\Ruby24-x64\bin;C:\tools\neovim\Neovim\bin;%PATH%
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;C:\tools\neovim\Neovim\bin;%PATH%
   - set NVIM_RUBY_LOG_LEVEL=DEBUG
   - set NVIM_RUBY_LOG_FILE=%cd%\ci.log
   - choco install neovim --pre -fy --ignore-dependencies

data/lib/neovim.rb

@@ -35,19 +35,19 @@ require "neovim/version"
 #     # Define a command called "SetLine" which sets the contents of the
 #     # current line. This command is executed asynchronously, so the return
 #     # value is ignored.
-#     plug.command(:SetLine, :nargs => 1) do |nvim, str|
+#     plug.command(:SetLine, nargs: 1) do |nvim, str|
 #       nvim.current.line = str
 #     end
 #
 #     # Define a function called "Sum" which adds two numbers. This function is
 #     # executed synchronously, so the result of the block will be returned to
 #     # nvim.
-#     plug.function(:Sum, :nargs => 2, :sync => true) do |nvim, x, y|
+#     plug.function(:Sum, nargs: 2, sync: true) do |nvim, x, y|
 #       x + y
 #     end
 #
 #     # Define an autocmd for the BufEnter event on Ruby files.
-#     plug.autocmd(:BufEnter, :pattern => "*.rb") do |nvim|
+#     plug.autocmd(:BufEnter, pattern: "*.rb") do |nvim|
 #       nvim.command("echom 'Ruby file, eh?'")
 #     end
 #   end

data/lib/neovim/client.rb

@@ -16,8 +16,7 @@ module Neovim
   class Client
     attr_reader :session, :api
 
-    def self.from_event_loop(event_loop)
-      session = Session.new(event_loop)
+    def self.from_event_loop(event_loop, session=Session.new(event_loop))
       api = API.new(session.request(:nvim_get_api_info))
       event_loop.register_types(api, session)
 
@@ -39,7 +38,7 @@ module Neovim
     end
 
     # Extend +respond_to?+ to support RPC methods.
-    def respond_to?(method_name)
+    def respond_to?(method_name, *)
       super || rpc_methods.include?(method_name.to_sym)
     end
 

data/lib/neovim/connection.rb

@@ -0,0 +1,69 @@
+require "neovim/logging"
+require "socket"
+require "msgpack"
+
+module Neovim
+  # @api private
+  class Connection
+    include Logging
+
+    def self.tcp(host, port)
+      socket = Socket.tcp(host, port)
+      new(socket, socket)
+    end
+
+    def self.unix(path)
+      socket = Socket.unix(path)
+      new(socket, socket)
+    end
+
+    def self.child(_argv)
+      argv = _argv.include?("--embed") ? _argv : _argv + ["--embed"]
+
+      io = ::IO.popen(argv, "rb+").tap do |_io|
+        Process.detach(_io.pid)
+      end
+
+      new(io, io)
+    end
+
+    def self.stdio
+      new(STDIN, STDOUT)
+    end
+
+    def initialize(rd, wr)
+      @rd, @wr = [rd, wr].each { |io| io.binmode.sync = true }
+
+      @unpacker = MessagePack::Unpacker.new(@rd)
+      @packer = MessagePack::Packer.new(@wr)
+      @running = false
+    end
+
+    def write(object)
+      log(:debug) { {object: object} }
+      @packer.write(object).flush
+    end
+
+    def read
+      @unpacker.read.tap do |object|
+        log(:debug) { {object: object} }
+      end
+    end
+
+    def register_type(id, &block)
+      @unpacker.register_type(id) do |data|
+        index = MessagePack.unpack(data)
+        block.call(index)
+      end
+    end
+
+    def close
+      [@rd, @wr].each do |io|
+        begin
+          io.close
+        rescue ::IOError
+        end
+      end
+    end
+  end
+end

data/lib/neovim/event_loop.rb

@@ -1,29 +1,24 @@
 require "neovim/logging"
-require "neovim/event_loop/connection"
-require "neovim/event_loop/message_builder"
-require "neovim/event_loop/serializer"
+require "neovim/connection"
+require "neovim/message"
 
 module Neovim
+  # @api private
   class EventLoop
     include Logging
 
-    # Connect to a TCP socket.
     def self.tcp(host, port)
       new Connection.tcp(host, port)
     end
 
-    # Connect to a UNIX domain socket.
     def self.unix(path)
       new Connection.unix(path)
     end
 
-    # Spawn and connect to a child +nvim+ process.
     def self.child(argv)
       new Connection.child(argv)
     end
 
-    # Connect to the current process's standard streams. This is used to
-    # promote the current process to a Ruby plugin host.
     def self.stdio
       new Connection.stdio
     end
@@ -32,8 +27,6 @@ module Neovim
       @running = false
       @shutdown = false
       @connection = connection
-      @serializer = Serializer.new
-      @message_builder = MessageBuilder.new
     end
 
     def stop
@@ -45,25 +38,32 @@ module Neovim
       @shutdown = true
     end
 
-    def request(method, *args, &response_handler)
-      log(:debug) { {:name => method, :arguments => arg} }
-      write(:request, method, args, response_handler)
+    def request(request_id, method, *args)
+      log(:debug) do
+        {
+          request_id: request_id,
+          method: method,
+          arguments: args
+        }
+      end
+
+      write(:request, request_id, method, args)
     end
 
     def respond(request_id, return_value, error)
       log(:debug) do
         {
-          :request_id => request_id,
-          :return_value => return_value,
-          :error => error
+          request_id: request_id,
+          return_value: return_value,
+          error: error
         }
       end
 
-      write(:response, request_id, return_value, error)
+      write(:response, request_id, error, return_value)
     end
 
     def notify(method, *args)
-      log(:debug) { {:name => method, :arguments => args} }
+      log(:debug) { {name: method, arguments: args} }
       write(:notification, method, args)
     end
 
@@ -74,28 +74,26 @@ module Neovim
         break if !@running
         break if @shutdown
 
-        @connection.read do |bytes|
-          @serializer.read(bytes) do |obj|
-            @message_builder.read(obj, &callback)
-          end
+        begin
+          callback.call(read)
+        rescue EOFError => e
+          log_exception(:debug, e, __method__)
+          shutdown
+        rescue => e
+          log_exception(:error, e, __method__)
         end
       end
-    rescue EOFError => ex
-      log_exception(:debug, ex, __method__)
-    rescue => ex
-      log_exception(:fatal, ex, __method__)
     ensure
       @connection.close if @shutdown
     end
 
-    # Register msgpack ext types using the provided API and session
     def register_types(api, session)
       api.types.each do |type, info|
         id = info.fetch("id")
         klass = Neovim.const_get(type)
-        log(:debug) { {:type => type, :id => id} }
+        log(:debug) { {type: type, id: id} }
 
-        @serializer.register_type(id) do |index|
+        @connection.register_type(id) do |index|
           klass.new(index, session, api)
         end
       end
@@ -103,12 +101,14 @@ module Neovim
 
     private
 
+    def read
+      array = @connection.read
+      Message.from_array(array)
+    end
+
     def write(type, *args)
-      @message_builder.write(type, *args) do |arr|
-        @serializer.write(arr) do |bytes|
-          @connection.write(bytes)
-        end
-      end
+      message = Message.public_send(type, *args)
+      @connection.write(message.to_a)
     end
   end
 end