neovim 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65ebef25a57b7d4e244b65fbceb840bd8b1102f3
-  data.tar.gz: 152c9fbe48f7a50594be2abe6551e41a576808a1
+  metadata.gz: 94299b85fc9c539d812062822342c89a47b0d829
+  data.tar.gz: 225a197bab993d300596743292de0823ee994e9a
 SHA512:
-  metadata.gz: 8da3e2b81089bf418c16900e0db39144b7f0bb39a9cbebd2bed4d6a5f4272940ccc02d65b8b55a629a38c121522caa46dda963145311fc052cf2d6be01dc2514
-  data.tar.gz: af51998f0fbe47a2f7e97e576d7e22fb9721ad81cf84c73d8bb6052487c1e1cbb795d62a0d88058924f28b60270c2a1429ed2551b8c0c1c591570e2b28a0d663
+  metadata.gz: c641e29939e3f02a8e788cbf88e7b6eb4c4310a19b0825f86cebef93a33bbe62658fa48518c46c3d43a8d270eda169ec3e45355fc7becd38235189d637c18b0b
+  data.tar.gz: 83d1e66f8ff9fa729223a12a063e3b3268894d7a1d004b2bedb0c9da8e416cb7043f955f5d1bfc8c05ccf88e6a88c10567949f237c7fb3f5f127d37f74289f6f

data/CHANGELOG.md

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

data/README.md

@@ -70,6 +70,8 @@ end
 
 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.
 
+The Neovim gem also acts as a compatibility layer for Ruby plugins written for legacy `vim`. The `:ruby`, `:rubyfile`, and `:rubydo` commands are intended to behave the same as they did in `vim`, and their documentation can be found [here](https://neovim.io/doc/user/if_ruby.html).
+
 ## Links
 
 * Source: <http://github.com/alexgenco/neovim-ruby>

data/lib/neovim/api.rb

@@ -1,6 +1,8 @@
 module Neovim
   # @api private
   class API
+    attr_reader :channel_id
+
     # 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.
     #
@@ -9,17 +11,19 @@ module Neovim
       new([nil, {"functions" => [], "types" => []}])
     end
 
-    def initialize(data)
-      @data = data
+    def initialize(api_info)
+      @channel_id, @api_info = api_info
     end
 
-    # Return all functions defined by the API, as +Function+ objects.
+    # Return all functions defined by the API.
     #
-    # @return [Array<Function>]
+    # @return [Hash{String => Function}] A +Hash+ mapping function names to
+    #   +Function+ objects.
     # @see Function
     def functions
-      @functions ||= @data.fetch(1).fetch("functions").map do |func|
-        Function.new(func["name"], func["async"])
+      @functions ||= @api_info.fetch("functions").inject({}) do |acc, func|
+        name, async = func.values_at("name", "async")
+        acc.merge(name => Function.new(name, async))
       end
     end
 
@@ -28,14 +32,7 @@ module Neovim
     #
     # @return [Hash]
     def types
-      @types ||= @data.fetch(1).fetch("types")
-    end
-
-    # Return the channel ID of the current RPC session.
-    #
-    # @return [Fixnum, nil]
-    def channel_id
-      @channel_id ||= @data.fetch(0)
+      @types ||= @api_info.fetch("types")
     end
 
     # Return a list of functions with the given name prefix.
@@ -43,8 +40,8 @@ module Neovim
     # @param prefix [String] The function prefix
     # @return [Array<Function>]
     def functions_with_prefix(prefix)
-      functions.select do |function|
-        function.name =~ /\A#{prefix}/
+      functions.inject([]) do |acc, (name, function)|
+        name =~ /\A#{prefix}/ ? acc.push(function) : acc
       end
     end
 
@@ -53,9 +50,7 @@ module Neovim
     # @param name [String] The name of the function
     # @return [Function, nil]
     def function(name)
-      functions.find do |func|
-        func.name == name.to_s
-      end
+      functions[name.to_s]
     end
 
     # Truncate the output of inspect so console sessions are more pleasant.

data/lib/neovim/plugin/dsl.rb

@@ -3,51 +3,65 @@ require "neovim/plugin/handler"
 module Neovim
   class Plugin
     # The DSL exposed in +Neovim.plugin+ blocks.
+    #
+    # @api public
     class DSL < BasicObject
       def initialize(plugin)
         @plugin = plugin
       end
 
-      # Register an +nvim+ command.
+      # Register an +nvim+ command. See +:h command+.
       #
-      # @param name [String]
-      # @param options [Hash]
-      # @param &block [Proc, nil]
+      # @param name [String] The name of the command.
+      # @param options [Hash] Command options.
+      # @param &block [Proc, nil] The body of the command.
       #
-      # @option options [Fixnum] :nargs
-      # @option options [Fixnum] :count
-      # @option options [String] :eval
-      # @option options [Boolean] :sync (false)
-      # @option options [Boolean] :bang
-      # @option options [Boolean] :register
-      # @option options [Boolean] :complete
-      # @option options [String, Boolean] :range
+      # @option options [Fixnum] :nargs The number of arguments to accept. See
+      #   +:h command-nargs+.
+      # @option options [String, Boolean] :range The range argument.
+      #   See +:h command-range+.
+      # @option options [Fixnum] :count The default count argument.
+      #   See +:h command-count+.
+      # @option options [Boolean] :bang Whether the command can take a +!+
+      #   modifier. See +:h command-bang+.
+      # @option options [Boolean] :register Whether the command can accept a
+      #   register name. See +:h command-register+.
+      # @option options [Boolean] :complete Set the completion attributes of
+      #   the command. See +:h command-completion+.
+      # @option options [String] :eval An +nvim+ expression. Gets evaluated and
+      #   passed as an argument to the block.
+      # @option options [Boolean] :sync (false) Whether +nvim+ should receive
+      #   the return value of the block.
       def command(name, options={}, &block)
         register_handler(:command, name, options, block)
       end
 
-      # Register an +nvim+ function.
+      # Register an +nvim+ function. See +:h function+.
       #
-      # @param name [String]
-      # @param options [Hash]
-      # @param &block [Proc, nil]
+      # @param name [String] The name of the function.
+      # @param options [Hash] Function options.
+      # @param &block [Proc, nil] The body of the function.
       #
-      # @option options [String] :eval
-      # @option options [Boolean] :sync (false)
-      # @option options [String, Boolean] :range
+      # @option options [String, Boolean] :range The range argument. 
+      #   See +:h command-range+.
+      # @option options [String] :eval An +nvim+ expression. Gets evaluated and
+      #   passed as an argument to the block.
+      # @option options [Boolean] :sync (false) Whether +nvim+ should receive
+      #   the return value of the block.
       def function(name, options={}, &block)
         register_handler(:function, name, options, block)
       end
 
-      # Register an +nvim+ autocmd.
+      # Register an +nvim+ autocmd. See +:h autocmd+.
       #
-      # @param event [String]
-      # @param options [Hash]
-      # @param &block [Proc, nil]
+      # @param event [String] The event type. See +:h autocmd-events+
+      # @param options [Hash] Autocmd options.
+      # @param &block [Proc, nil] The body of the autocmd.
       #
-      # @option options [String] :pattern
-      # @option options [String] :eval
-      # @option options [Boolean] :sync (false)
+      # @option options [String] :pattern The buffer name pattern.
+      #   See +:h autocmd-patterns+.
+      # @option options [String] :eval An +nvim+ expression. Gets evaluated and
+      #   passed as an argument to the block.
       def autocmd(event, options={}, &block)
         register_handler(:autocmd, event, options, block)
       end
@@ -57,7 +71,8 @@ module Neovim
       # This can be used to directly expose an RPC call without a namespace.
       # This is used primarily for exposing legacy ruby provider calls.
       #
-      # @option options [Boolean] :sync (false)
+      # @option options [Boolean] :sync (false) Whether +nvim+ should receive
+      #   the return value of the block.
       def rpc(name, options={}, &block)
         sync = options.delete(:sync)
 

data/lib/neovim/ruby_provider.rb

@@ -84,8 +84,20 @@ module Neovim
 
     # @api private
     def self.__with_globals(client)
-      $curbuf = client.get_current_buffer
-      $curwin = client.get_current_window
+      @__buffer_cache ||= {}
+      @__window_cache ||= {}
+
+      __bufnr = client.evaluate("bufnr('%')")
+      __winnr = client.evaluate("winnr()")
+
+      $curbuf = @__buffer_cache.fetch(__bufnr) do
+        @__buffer_cache[__bufnr] = client.get_current_buffer
+      end
+
+      $curwin = @__window_cache.fetch(__winnr) do
+        @__window_cache[__winnr] = client.get_current_window
+      end
+
       yield
     end
     private_class_method :__with_globals

data/lib/neovim/version.rb

@@ -1,3 +1,3 @@
 module Neovim
-  VERSION = Gem::Version.new("0.2.4")
+  VERSION = Gem::Version.new("0.2.5")
 end

data/spec/acceptance/ruby_provider_spec.rb

@@ -49,6 +49,18 @@ RSpec.describe "ruby_provider" do
       nvim.eval("rpcrequest(host, 'ruby_execute', 'foo')")
       expect(nvim.get_var("called")).to be(1)
     end
+
+    it "persists instance state in globals" do
+      nvim.eval("rpcrequest(host, 'ruby_execute', '$curbuf.instance_variable_set(:@foo, 123)')")
+      nvim.eval("rpcrequest(host, 'ruby_execute', 'VIM.command(\"let g:foo = \#{$curbuf.instance_variable_get(:@foo)}\")')")
+
+      expect(nvim.get_var("foo")).to be(123)
+
+      nvim.eval("rpcrequest(host, 'ruby_execute', '$curwin.instance_variable_set(:@foo, 456)')")
+      nvim.eval("rpcrequest(host, 'ruby_execute', 'VIM.command(\"let g:foo = \#{$curwin.instance_variable_get(:@foo)}\")')")
+
+      expect(nvim.get_var("foo")).to be(456)
+    end
   end
 
   describe "ruby_execute_file" do

data/spec/neovim/api_spec.rb

@@ -6,8 +6,8 @@ module Neovim
       it "returns an empty API object" do
         api = API.null
 
-        expect(api.types).to eq([])
-        expect(api.functions).to eq([])
+        expect(api.types).to be_empty
+        expect(api.functions).to be_empty
       end
     end
 
@@ -29,10 +29,14 @@ module Neovim
     describe "#functions_with_prefix" do
       it "returns relevant functions" do
         api = API.new(
-          [nil, {"functions" => [{"name" => "vim_strwidth"}]}]
+          [nil, {"functions" => [
+            {"name" => "vim_strwidth"},
+            {"name" => "buffer_get_lines"}
+          ]}]
         )
 
         functions = api.functions_with_prefix("vim_")
+        expect(functions.size).to be(1)
         expect(functions.first.name).to eq("vim_strwidth")
       end
     end

data/spec/neovim/event_loop_spec.rb

@@ -87,10 +87,9 @@ module Neovim
         response = nil
         event_loop.write(input).run do |msg|
           response = msg
-          event_loop.stop
+          event_loop.shutdown
         end
 
-        event_loop.shutdown
         expect(response).to eq(MessagePack.pack([1, 0, nil, 2]))
       end
     end

data/spec/neovim_spec.rb

@@ -10,13 +10,13 @@ RSpec.describe Neovim do
       pid = Process.spawn(env, *nvim_argv, [:out, :err] => "/dev/null")
 
       begin
-        TCPSocket.open("0.0.0.0", port).close
+        client = Neovim.attach_tcp("0.0.0.0", port)
       rescue Errno::ECONNREFUSED
         retry
       end
 
       begin
-        expect(Neovim.attach_tcp("0.0.0.0", port).strwidth("hi")).to eq(2)
+        expect(client.strwidth("hi")).to eq(2)
       ensure
         Process.kill(:TERM, pid)
         Process.waitpid(pid)
@@ -31,13 +31,13 @@ RSpec.describe Neovim do
       pid = Process.spawn(env, *nvim_argv, [:out, :err] => "/dev/null")
 
       begin
-        UNIXSocket.new(socket_path).close
+        client = Neovim.attach_unix(socket_path)
       rescue Errno::ENOENT, Errno::ECONNREFUSED
         retry
       end
 
       begin
-        expect(Neovim.attach_unix(socket_path).strwidth("hi")).to eq(2)
+        expect(client.strwidth("hi")).to eq(2)
       ensure
         Process.kill(:TERM, pid)
         Process.waitpid(pid)

data/spec/support.rb

@@ -11,7 +11,12 @@ module Support
 
   def self.port
     server = TCPServer.new("0.0.0.0", 0)
-    server.addr[1].tap { server.close }
+
+    begin
+      server.addr[1]
+    ensure
+      server.close
+    end
   end
 
   def self.file_path(name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neovim
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Alex Genco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-07 00:00:00.000000000 Z
+date: 2016-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack