neovim 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af56f57f1cf54f8adc5229739e6bc59970b993c2
-  data.tar.gz: d9c97e2f4086a239d18cad60b0e0143df4a5b476
+  metadata.gz: f815ff4bec0348ba8b77aa4f9b04197e8a521655
+  data.tar.gz: 149067ce655eb2b13102f9d68b0ef635668a3578
 SHA512:
-  metadata.gz: a209db461c6fd40c4b43cf2dc71b0a156e2dd563d6ca3644b383cfd3a625ab6e8302de6f60e1bab216a9efd93db9ad22479687764f41346f806526356034d390
-  data.tar.gz: ea4a5ff5be12e6d6e9bf57c454d5cc8fe7d198bcb80329d2a62cad7a2202987a25575c542f51dbe3e501e5cc6a74ea9dcc5719678de4669d193262ad0a0c8b9a
+  metadata.gz: a0b76436db1b7523be49ecfb8be84785f3420a0eeeea294b38f6173b94136a5d60cd02f8c9dd3ff6d209bf728dc1e042c1faf1c5b0a24239a199a3099a5b141b
+  data.tar.gz: e7048d7300227a7effc924d3248798b0669471dfa56820eac798a0300f3cc3545bad333d14d37c682b61b67d3cbf185f9d40c356c17491ff8288706551a2da46

data/.travis.yml

@@ -15,4 +15,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: bundle exec rake --trace spec
+script: travis_retry bundle exec rake --trace spec

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 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

data/README.md

@@ -7,7 +7,7 @@
 
 Ruby bindings for [Neovim](https://github.com/neovim/neovim).
 
-*Warning*: This project is currently incomplete and unstable.
+*Warning*: This project follows [Semantic Versioning](http://semver.org/), thus its API should be considered unstable until it reaches v1.0.0 ([spec](http://semver.org/#spec-item-4)).
 
 ## Installation
 
@@ -25,20 +25,20 @@ Or install it yourself as:
 
 ## Usage
 
-You can control a running `nvim` process by connecting to `$NVIM_LISTEN_ADDRESS`. Start it up like this:
+You can control a running `nvim` process by connecting to `$NVIM_LISTEN_ADDRESS`. For example, to connect to `nvim` over a UNIX domain socket, start it up like this:
 
 ```shell
 $ NVIM_LISTEN_ADDRESS=/tmp/nvim.sock nvim
 ```
 
-You can then connect to that socket to get a `Neovim::Client`:
+You can then connect to that socket path to get a `Neovim::Client`:
 
 ```ruby
 require "neovim"
 client = Neovim.attach_unix("/tmp/nvim.sock")
 ```
 
-The client's interface is generated at runtime from the `vim_get_api_info` RPC call. Refer to the [docs](http://www.rubydoc.info/github/alexgenco/neovim-ruby/master/Neovim/Client) for details.
+Refer to the [`Neovim` docs](http://www.rubydoc.info/github/alexgenco/neovim-ruby/master/Neovim) for other ways to connect to `nvim`, and the [`Neovim::Client` docs](http://www.rubydoc.info/github/alexgenco/neovim-ruby/master/Neovim/Client) for a summary of the client interface.
 
 ### Plugins
 
@@ -68,9 +68,7 @@ Neovim.plugin do |plug|
 end
 ```
 
-After a call to `:UpdateRemotePlugins`, plugins will be auto-loaded from the `$VIMRUNTIME/rplugin/ruby` directory.
-
-Neovim also supports the legacy Vim commands `:ruby`, `:rubyfile`, and `:rubydo`. A detailed description of their usage can be found with `:help ruby`.
+Ruby plugins go in the `$VIMRUNTIME/rplugin/ruby` directory, and are auto-loaded after calling `:UpdateRemotePlugins`. Refer to the [`Neovim::Plugin::DSL` docs](http://www.rubydoc.info/github/alexgenco/neovim-ruby/master/Neovim/Plugin/DSL) for a more complete overview.
 
 ## Links
 

data/Rakefile

@@ -14,9 +14,25 @@ namespace :neovim do
     window_docs = []
     tabpage_docs = []
     session = Neovim::Session.child(%w(nvim -u NONE -n))
+    vim_defs = Neovim::Client.instance_methods(false)
+    buffer_defs = Neovim::Buffer.instance_methods(false)
+    tabpage_defs = Neovim::Tabpage.instance_methods(false)
+    window_defs = Neovim::Window.instance_methods(false)
 
     session.request(:vim_get_api_info)[1]["functions"].each do |func|
       prefix, method_name = func["name"].split("_", 2)
+
+      case prefix
+      when "vim"
+        next if vim_defs.include?(method_name.to_sym)
+      when "buffer"
+        next if buffer_defs.include?(method_name.to_sym)
+      when "tabpage"
+        next if tabpage_defs.include?(method_name.to_sym)
+      when "window"
+        next if window_defs.include?(method_name.to_sym)
+      end
+
       return_type = func["return_type"]
       params = func["parameters"]
       params.shift unless prefix == "vim"

data/lib/neovim.rb

@@ -54,16 +54,6 @@ require "neovim/version"
 # @see Client
 # @see Plugin::DSL
 module Neovim
-  class << self
-    # @api private
-    # @return [Manifest, nil]
-    attr_accessor :__configured_plugin_manifest
-
-    # @api private
-    # @return [String, nil]
-    attr_accessor :__configured_plugin_path
-  end
-
   # Connect to a running +nvim+ instance over TCP.
   #
   # @param host [String] The hostname or IP address
@@ -92,19 +82,6 @@ module Neovim
     Client.new Session.child(argv)
   end
 
-  # Define an +nvim+ remote plugin using the plugin DSL.
-  #
-  # @yield [Plugin::DSL]
-  # @return [Plugin]
-  # @see Plugin::DSL
-  def self.plugin(&block)
-    Plugin.from_config_block(__configured_plugin_path, &block).tap do |plugin|
-      if __configured_plugin_manifest.respond_to?(:register)
-        __configured_plugin_manifest.register(plugin)
-      end
-    end
-  end
-
   # Start a plugin host. This is called by the +nvim-ruby-host+ executable,
   # which is spawned by +nvim+ to discover and run Ruby plugins, and acts as
   # the bridge between +nvim+ and the plugin.
@@ -116,6 +93,15 @@ module Neovim
     Host.load_from_files(rplugin_paths).run
   end
 
+  # Placeholder method for exposing the remote plugin DSL. This gets
+  # temporarily overwritten in +Host#load_files+.
+  #
+  # @see Host#load_files
+  # @see Plugin::DSL
+  def self.plugin
+    raise "Can't call Neovim.plugin outside of a plugin host."
+  end
+
   # Set the Neovim global logger.
   #
   # @param logger [Logger] The target logger

data/lib/neovim/api.rb

@@ -1,4 +1,5 @@
 module Neovim
+  # @api private
   class API
     # Represents an unknown API. Used as a stand-in when the API hasn't been
     # discovered yet via the +vim_get_api_info+ RPC call.

data/lib/neovim/async_session.rb

@@ -6,6 +6,8 @@ module Neovim
   # Handles formatting RPC requests and writing them to the
   # +MsgpackStream+. This exposes an asynchronous API, in which responses
   # are handled in callbacks.
+  #
+  # @api private
   class AsyncSession
     include Logging
 
@@ -72,7 +74,7 @@ module Neovim
         end
       end
     rescue => e
-      fatal("got unexpected error #{e}")
+      fatal("got unexpected error #{e.inspect}")
       debug(e.backtrace.join("\n"))
     end
 

data/lib/neovim/buffer.rb

@@ -97,7 +97,11 @@ module Neovim
     # @param str [String]
     # @return [String]
     def append(index, str)
-      lines[index-1, 1] = [lines[index-1], str]
+      if index < 0
+        raise ArgumentError, "Index out of bounds"
+      else
+        lines.insert(index, str)
+      end
       str
     end
 

data/lib/neovim/client.rb

@@ -88,6 +88,10 @@ module Neovim
       end
     end
 
+    def shutdown
+      @session.shutdown
+    end
+
     private
 
     def rpc_methods
@@ -176,11 +180,6 @@ module Neovim
   @param [String] name
   @return [Object]
 
-@method set_option(name, value)
-  @param [String] name
-  @param [Object] value
-  @return [void]
-
 @method out_write(str)
   @param [String] str
   @return [void]

data/lib/neovim/current.rb

@@ -4,7 +4,9 @@ require "neovim/window"
 
 module Neovim
   # Support for +client.current+ chaining.
+  #
   # @see Client#current
+  # @api private
   class Current
     def initialize(session)
       @session = session

data/lib/neovim/event_loop.rb

@@ -3,6 +3,8 @@ require "socket"
 
 module Neovim
   # The lowest level interface to reading from and writing to +nvim+.
+  #
+  # @api private
   class EventLoop
     include Logging
 
@@ -32,7 +34,10 @@ module Neovim
     # @param argv [Array] The arguments to pass to the spawned process
     # @return [EventLoop]
     def self.child(argv)
-      io = IO.popen(argv | ["--embed"], "rb+")
+      io = IO.popen(argv | ["--embed"], "rb+").tap do |_io|
+        Process.detach(_io.pid)
+      end
+
       new(io)
     end
 
@@ -87,7 +92,7 @@ module Neovim
     rescue EOFError
       info("got EOFError")
     rescue => e
-      fatal("got unexpected error #{e}")
+      fatal("got unexpected error #{e.inspect}")
       debug(e.backtrace.join("\n"))
     end
 
@@ -109,6 +114,14 @@ module Neovim
           io.close
         rescue IOError
         end
+
+        begin
+          if pid = io.pid
+            Process.kill(:TERM, pid)
+            Process.waitpid(pid)
+          end
+        rescue IOError, Errno::ESRCH, Errno::ECHILD
+        end
       end
     end
   end

data/lib/neovim/host.rb

@@ -1,69 +1,113 @@
 require "neovim/logging"
-require "neovim/manifest"
+require "neovim/host/loader"
 
 module Neovim
+  # @api private
   class Host
     include Logging
 
-    attr_reader :manifest
+    attr_reader :handlers, :specs
 
-    # Load plugin definitions and instantiate a new +Host+. This temporarily
-    # mutates global state on the +Neovim+ module so that +Neovim.plugin+ calls
-    # will be registered correctly with the provided +Manifest+.
-    #
-    # @overload load_from_files(rplugin_paths)
-    #   @param rplugin_paths [Array<String>] The remote plugin paths.
-    #
-    # @overload load_from_files(rplugin_paths, target_manifest)
-    #   @param rplugin_paths [Array<String>] The remote plugin paths.
-    #   @param target_manifest [Manifest] The plugin manifest.
+    # Initialize and populate a +Host+ from a list of plugin paths.
     #
+    # @param rplugin_paths [Array<String>]
     # @return [Host]
-    # @see Neovim.start_host
-    # @see Neovim.plugin
-    def self.load_from_files(rplugin_paths, target_manifest=Manifest.new)
-      old_manifest = Neovim.__configured_plugin_manifest
-      old_path = Neovim.__configured_plugin_path
-
-      begin
-        Neovim.__configured_plugin_manifest = target_manifest
-
-        rplugin_paths.each do |rplugin_path|
-          Neovim.__configured_plugin_path = rplugin_path
-          Kernel.load(rplugin_path, true)
-        end
+    # @see Loader#load
+    def self.load_from_files(rplugin_paths, options={})
+      session = options.fetch(:session) { Session.stdio }
+      client = options.fetch(:client) { Client.new(session) }
 
-        new(target_manifest)
-      ensure
-        Neovim.__configured_plugin_manifest = old_manifest
-        Neovim.__configured_plugin_path = old_path
+      new(session, client).tap do |host|
+        Loader.new(host).load(rplugin_paths)
       end
     end
 
-    def initialize(manifest, session=nil)
-      @session = session || Session.stdio
-      @manifest = manifest
+    def initialize(session, client)
+      @session = session
+      @client = client
+      @handlers = {"poll" => poll_handler, "specs" => specs_handler}
+      @specs = {}
+    end
+
+    # Register a +Plugin+ to receive +Host+ messages.
+    #
+    # @param plugin [Plugin]
+    def register(plugin)
+      plugin.handlers.each do |handler|
+        @handlers[handler.qualified_name] = wrap_plugin_handler(handler)
+      end
+
+      @specs[plugin.source] = plugin.specs
     end
 
-    # Run the event loop, passing received messages to the manifest.
+    # Run the event loop, passing received messages to the appropriate handler.
     #
     # @return [void]
     def run
-      @session.discover_api
+      @session.run { |msg| handle(msg) }
+    rescue => e
+      fatal("got unexpected error #{e.inspect}")
+      debug(e.backtrace.join("\n"))
+    end
 
-      @session.run do |msg|
-        debug("received #{msg.inspect}")
-        @manifest.handle(msg, client)
-      end
+    # Handle messages received from the host. Sends a +Neovim::Client+ along
+    # with the message to be used in plugin callbacks.
+    #
+    # @param message [Neovim::Request, Neovim::Notification]
+    # @param client [Neovim::Client]
+    def handle(message)
+      debug("received #{message.inspect}")
+
+      @handlers.
+        fetch(message.method_name, default_handler).
+        call(@client, message)
     rescue => e
-      fatal("got unexpected error #{e}")
+      fatal("got unexpected error #{e.inspect}")
       debug(e.backtrace.join("\n"))
     end
 
     private
 
-    def client
-      @client ||= Client.new(@session)
+    def poll_handler
+      @poll_handler ||= Proc.new do |_, req|
+        debug("received 'poll' request #{req.inspect}")
+        req.respond("ok")
+      end
+    end
+
+    def specs_handler
+      @specs_handler ||= Proc.new do |_, req|
+        debug("received 'specs' request #{req.inspect}")
+        source = req.arguments.fetch(0)
+
+        if @specs.key?(source)
+          req.respond(@specs.fetch(source))
+        else
+          req.error("Unknown plugin #{source}")
+        end
+      end
+    end
+
+    def default_handler
+      @default_handler ||= Proc.new do |_, message|
+        if message.sync?
+          message.error("Unknown request #{message.method_name}")
+        end
+      end
+    end
+
+    def wrap_plugin_handler(handler)
+      Proc.new do |client, message|
+        begin
+          debug("received #{message.inspect}")
+          args = message.arguments.flatten(1)
+          result = handler.call(client, *args)
+          message.respond(result) if message.sync?
+        rescue => e
+          warn("got unexpected error #{e.inspect}")
+          message.error(e.message) if message.sync?
+        end
+      end
     end
   end
 end

data/lib/neovim/host/loader.rb

@@ -0,0 +1,39 @@
+module Neovim
+  class Host
+    # @api private
+    class Loader
+      def initialize(host)
+        @host = host
+      end
+
+      # Load the provided Ruby files while temporarily overriding
+      # +Neovim.plugin+ to expose the remote plugin DSL and register the result
+      # to the host.
+      #
+      # @param paths [Array<String>]
+      def load(paths)
+        paths.each do |path|
+          override_plugin_method(path) do
+            Kernel.load(path, true)
+          end
+        end
+      end
+
+      private
+
+      def override_plugin_method(path)
+        old_plugin_def = Neovim.method(:plugin)
+        at_host = @host
+
+        Neovim.define_singleton_method(:plugin) do |&block|
+          plugin = Plugin.from_config_block(path, &block)
+          at_host.register(plugin)
+        end
+
+        yield
+      ensure
+        Neovim.define_singleton_method(:plugin, &old_plugin_def)
+      end
+    end
+  end
+end