neovim 0.9.0 → 0.10.0

data/lib/neovim/client.rb

@@ -9,7 +9,7 @@ module Neovim
   # +RemoteObject+ subclasses (i.e. +Buffer+, +Window+, or +Tabpage+),
   # which similarly have dynamically generated interfaces.
   #
-  # The methods documented here were generated using NVIM v0.5.0
+  # The methods documented here were generated using NVIM v0.10.0
   #
   # @see Buffer
   # @see Window
@@ -117,6 +117,84 @@ module Neovim
 
 # The following methods are dynamically generated.
 =begin
+@method get_autocmds(opts)
+  See +:h nvim_get_autocmds()+
+  @param [Hash] opts
+  @return [Array]
+
+@method create_autocmd(event, opts)
+  See +:h nvim_create_autocmd()+
+  @param [Object] event
+  @param [Hash] opts
+  @return [Integer]
+
+@method del_autocmd(id)
+  See +:h nvim_del_autocmd()+
+  @param [Integer] id
+  @return [void]
+
+@method clear_autocmds(opts)
+  See +:h nvim_clear_autocmds()+
+  @param [Hash] opts
+  @return [void]
+
+@method create_augroup(name, opts)
+  See +:h nvim_create_augroup()+
+  @param [String] name
+  @param [Hash] opts
+  @return [Integer]
+
+@method del_augroup_by_id(id)
+  See +:h nvim_del_augroup_by_id()+
+  @param [Integer] id
+  @return [void]
+
+@method del_augroup_by_name(name)
+  See +:h nvim_del_augroup_by_name()+
+  @param [String] name
+  @return [void]
+
+@method exec_autocmds(event, opts)
+  See +:h nvim_exec_autocmds()+
+  @param [Object] event
+  @param [Hash] opts
+  @return [void]
+
+@method parse_cmd(str, opts)
+  See +:h nvim_parse_cmd()+
+  @param [String] str
+  @param [Hash] opts
+  @return [Hash]
+
+@method cmd(cmd, opts)
+  See +:h nvim_cmd()+
+  @param [Hash] cmd
+  @param [Hash] opts
+  @return [String]
+
+@method create_user_command(name, command, opts)
+  See +:h nvim_create_user_command()+
+  @param [String] name
+  @param [Object] command
+  @param [Hash] opts
+  @return [void]
+
+@method del_user_command(name)
+  See +:h nvim_del_user_command()+
+  @param [String] name
+  @return [void]
+
+@method get_commands(opts)
+  See +:h nvim_get_commands()+
+  @param [Hash] opts
+  @return [Hash]
+
+@method exec(src, output)
+  See +:h nvim_exec()+
+  @param [String] src
+  @param [Boolean] output
+  @return [String]
+
 @method command_output(command)
   See +:h nvim_command_output()+
   @param [String] command
@@ -128,6 +206,71 @@ module Neovim
   @param [Array] args
   @return [Object]
 
+@method get_hl_by_id(hl_id, rgb)
+  See +:h nvim_get_hl_by_id()+
+  @param [Integer] hl_id
+  @param [Boolean] rgb
+  @return [Hash]
+
+@method get_hl_by_name(name, rgb)
+  See +:h nvim_get_hl_by_name()+
+  @param [String] name
+  @param [Boolean] rgb
+  @return [Hash]
+
+@method get_option_info(name)
+  See +:h nvim_get_option_info()+
+  @param [String] name
+  @return [Hash]
+
+@method get_option(name)
+  See +:h nvim_get_option()+
+  @param [String] name
+  @return [Object]
+
+@method call_atomic(calls)
+  See +:h nvim_call_atomic()+
+  @param [Array] calls
+  @return [Array]
+
+@method create_namespace(name)
+  See +:h nvim_create_namespace()+
+  @param [String] name
+  @return [Integer]
+
+@method get_namespaces
+  See +:h nvim_get_namespaces()+
+  @return [Hash]
+
+@method set_decoration_provider(ns_id, opts)
+  See +:h nvim_set_decoration_provider()+
+  @param [Integer] ns_id
+  @param [Hash] opts
+  @return [void]
+
+@method get_option_value(name, opts)
+  See +:h nvim_get_option_value()+
+  @param [String] name
+  @param [Hash] opts
+  @return [Object]
+
+@method set_option_value(name, value, opts)
+  See +:h nvim_set_option_value()+
+  @param [String] name
+  @param [Object] value
+  @param [Hash] opts
+  @return [void]
+
+@method get_all_options_info
+  See +:h nvim_get_all_options_info()+
+  @return [Hash]
+
+@method get_option_info2(name, opts)
+  See +:h nvim_get_option_info2()+
+  @param [String] name
+  @param [Hash] opts
+  @return [Hash]
+
 @method ui_attach(width, height, options)
   See +:h nvim_ui_attach()+
   @param [Integer] width
@@ -135,6 +278,11 @@ module Neovim
   @param [Hash] options
   @return [void]
 
+@method ui_set_focus(gained)
+  See +:h nvim_ui_set_focus()+
+  @param [Boolean] gained
+  @return [void]
+
 @method ui_detach
   See +:h nvim_ui_detach()+
   @return [void]
@@ -171,34 +319,23 @@ module Neovim
   @param [Float] col
   @return [void]
 
-@method exec(src, output)
-  See +:h nvim_exec()+
-  @param [String] src
-  @param [Boolean] output
-  @return [String]
-
-@method command(command)
-  See +:h nvim_command()+
-  @param [String] command
+@method ui_term_event(event, value)
+  See +:h nvim_ui_term_event()+
+  @param [String] event
+  @param [Object] value
   @return [void]
 
-@method get_hl_by_name(name, rgb)
-  See +:h nvim_get_hl_by_name()+
-  @param [String] name
-  @param [Boolean] rgb
-  @return [Hash]
-
-@method get_hl_by_id(hl_id, rgb)
-  See +:h nvim_get_hl_by_id()+
-  @param [Integer] hl_id
-  @param [Boolean] rgb
-  @return [Hash]
-
 @method get_hl_id_by_name(name)
   See +:h nvim_get_hl_id_by_name()+
   @param [String] name
   @return [Integer]
 
+@method get_hl(ns_id, opts)
+  See +:h nvim_get_hl()+
+  @param [Integer] ns_id
+  @param [Hash] opts
+  @return [Hash]
+
 @method set_hl(ns_id, name, val)
   See +:h nvim_set_hl()+
   @param [Integer] ns_id
@@ -206,11 +343,26 @@ module Neovim
   @param [Hash] val
   @return [void]
 
-@method feedkeys(keys, mode, escape_csi)
+@method get_hl_ns(opts)
+  See +:h nvim_get_hl_ns()+
+  @param [Hash] opts
+  @return [Integer]
+
+@method set_hl_ns(ns_id)
+  See +:h nvim_set_hl_ns()+
+  @param [Integer] ns_id
+  @return [void]
+
+@method set_hl_ns_fast(ns_id)
+  See +:h nvim_set_hl_ns_fast()+
+  @param [Integer] ns_id
+  @return [void]
+
+@method feedkeys(keys, mode, escape_ks)
   See +:h nvim_feedkeys()+
   @param [String] keys
   @param [String] mode
-  @param [Boolean] escape_csi
+  @param [Boolean] escape_ks
   @return [void]
 
 @method input(keys)
@@ -236,11 +388,6 @@ module Neovim
   @param [Boolean] special
   @return [String]
 
-@method eval(expr)
-  See +:h nvim_eval()+
-  @param [String] expr
-  @return [Object]
-
 @method exec_lua(code, args)
   See +:h nvim_exec_lua()+
   @param [String] code
@@ -254,19 +401,6 @@ module Neovim
   @param [Hash] opts
   @return [Object]
 
-@method call_function(fn, args)
-  See +:h nvim_call_function()+
-  @param [String] fn
-  @param [Array] args
-  @return [Object]
-
-@method call_dict_function(dict, fn, args)
-  See +:h nvim_call_dict_function()+
-  @param [Object] dict
-  @param [String] fn
-  @param [Array] args
-  @return [Object]
-
 @method strwidth(text)
   See +:h nvim_strwidth()+
   @param [String] text
@@ -327,20 +461,6 @@ module Neovim
   @param [Object] value
   @return [void]
 
-@method get_option(name)
-  See +:h nvim_get_option()+
-  @param [String] name
-  @return [Object]
-
-@method get_all_options_info
-  See +:h nvim_get_all_options_info()+
-  @return [Hash]
-
-@method get_option_info(name)
-  See +:h nvim_get_option_info()+
-  @param [String] name
-  @return [Hash]
-
 @method echo(chunks, history, opts)
   See +:h nvim_echo()+
   @param [Array] chunks
@@ -407,13 +527,6 @@ module Neovim
   @param [String] data
   @return [void]
 
-@method open_win(buffer, enter, config)
-  See +:h nvim_open_win()+
-  @param [Buffer] buffer
-  @param [Boolean] enter
-  @param [Hash] config
-  @return [Window]
-
 @method list_tabpages
   See +:h nvim_list_tabpages()+
   @return [Array<Tabpage>]
@@ -427,15 +540,6 @@ module Neovim
   @param [Tabpage] tabpage
   @return [void]
 
-@method create_namespace(name)
-  See +:h nvim_create_namespace()+
-  @param [String] name
-  @return [Integer]
-
-@method get_namespaces
-  See +:h nvim_get_namespaces()+
-  @return [Hash]
-
 @method paste(data, crlf, phase)
   See +:h nvim_paste()+
   @param [String] data
@@ -503,11 +607,6 @@ module Neovim
   @param [String] lhs
   @return [void]
 
-@method get_commands(opts)
-  See +:h nvim_get_commands()+
-  @param [Hash] opts
-  @return [Hash]
-
 @method get_api_info
   See +:h nvim_get_api_info()+
   @return [Array]
@@ -530,18 +629,6 @@ module Neovim
   See +:h nvim_list_chans()+
   @return [Array]
 
-@method call_atomic(calls)
-  See +:h nvim_call_atomic()+
-  @param [Array] calls
-  @return [Array]
-
-@method parse_expression(expr, flags, highlight)
-  See +:h nvim_parse_expression()+
-  @param [String] expr
-  @param [String] flags
-  @param [Boolean] highlight
-  @return [Hash]
-
 @method list_uis
   See +:h nvim_list_uis()+
   @return [Array]
@@ -564,12 +651,66 @@ module Neovim
   @param [Hash] opts
   @return [void]
 
-@method set_decoration_provider(ns_id, opts)
-  See +:h nvim_set_decoration_provider()+
-  @param [Integer] ns_id
+@method del_mark(name)
+  See +:h nvim_del_mark()+
+  @param [String] name
+  @return [Boolean]
+
+@method get_mark(name, opts)
+  See +:h nvim_get_mark()+
+  @param [String] name
+  @param [Hash] opts
+  @return [Array]
+
+@method eval_statusline(str, opts)
+  See +:h nvim_eval_statusline()+
+  @param [String] str
+  @param [Hash] opts
+  @return [Hash]
+
+@method exec2(src, opts)
+  See +:h nvim_exec2()+
+  @param [String] src
   @param [Hash] opts
+  @return [Hash]
+
+@method command(command)
+  See +:h nvim_command()+
+  @param [String] command
   @return [void]
 
+@method eval(expr)
+  See +:h nvim_eval()+
+  @param [String] expr
+  @return [Object]
+
+@method call_function(fn, args)
+  See +:h nvim_call_function()+
+  @param [String] fn
+  @param [Array] args
+  @return [Object]
+
+@method call_dict_function(dict, fn, args)
+  See +:h nvim_call_dict_function()+
+  @param [Object] dict
+  @param [String] fn
+  @param [Array] args
+  @return [Object]
+
+@method parse_expression(expr, flags, highlight)
+  See +:h nvim_parse_expression()+
+  @param [String] expr
+  @param [String] flags
+  @param [Boolean] highlight
+  @return [Hash]
+
+@method open_win(buffer, enter, config)
+  See +:h nvim_open_win()+
+  @param [Buffer] buffer
+  @param [Boolean] enter
+  @param [Hash] config
+  @return [Window]
+
 =end
   end
 end

data/lib/neovim/remote_module/dsl.rb

@@ -0,0 +1,30 @@
+module Neovim
+  class RemoteModule
+    # The DSL exposed in +Neovim.start_remote+ blocks.
+    #
+    # @api public
+    class DSL < BasicObject
+      attr_reader :handlers
+
+      def initialize(&block)
+        @handlers = ::Hash.new do |h, name|
+          h[name] = ::Proc.new do |_, *|
+            raise NotImplementedError, "undefined handler #{name.inspect}"
+          end
+        end
+
+        block&.call(self)
+      end
+
+      # Define an RPC handler for use in remote modules.
+      #
+      # @param name [String] The handler name.
+      # @param block [Proc] The body of the handler.
+      def register_handler(name, &block)
+        @handlers[name.to_s] = ::Proc.new do |client, *args|
+          block.call(client, *args)
+        end
+      end
+    end
+  end
+end

data/lib/neovim/remote_module.rb

@@ -0,0 +1,42 @@
+require "neovim/client"
+require "neovim/event_loop"
+require "neovim/logging"
+require "neovim/remote_module/dsl"
+require "neovim/session"
+
+module Neovim
+  class RemoteModule
+    include Logging
+
+    def self.from_config_block(&block)
+      new(DSL::new(&block).handlers)
+    end
+
+    def initialize(handlers)
+      @handlers = handlers
+    end
+
+    def start
+      event_loop = EventLoop.stdio
+      session = Session.new(event_loop)
+      client = nil
+
+      session.run do |message|
+        case message
+        when Message::Request
+          begin
+            client ||= Client.from_event_loop(event_loop, session)
+            args = message.arguments.flatten(1)
+
+            @handlers[message.method_name].call(client, *args).tap do |rv|
+              session.respond(message.id, rv, nil) if message.sync?
+            end
+          rescue => e
+            log_exception(:error, e, __method__)
+            session.respond(message.id, nil, e.message) if message.sync?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/neovim/tabpage.rb

@@ -3,7 +3,7 @@ require "neovim/remote_object"
 module Neovim
   # Class representing an +nvim+ tabpage.
   #
-  # The methods documented here were generated using NVIM v0.5.0
+  # The methods documented here were generated using NVIM v0.10.0
   class Tabpage < RemoteObject
 # The following methods are dynamically generated.
 =begin
@@ -31,6 +31,11 @@ module Neovim
   See +:h nvim_tabpage_get_win()+
   @return [Window]
 
+@method set_win(win)
+  See +:h nvim_tabpage_set_win()+
+  @param [Window] win
+  @return [void]
+
 @method get_number
   See +:h nvim_tabpage_get_number()+
   @return [Integer]

data/lib/neovim/version.rb

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

data/lib/neovim/window.rb

@@ -3,7 +3,7 @@ require "neovim/remote_object"
 module Neovim
   # Class representing an +nvim+ window.
   #
-  # The methods documented here were generated using NVIM v0.5.0
+  # The methods documented here were generated using NVIM v0.10.0
   class Window < RemoteObject
     # Get the buffer displayed in the window
     #
@@ -64,6 +64,26 @@ module Neovim
 
 # The following methods are dynamically generated.
 =begin
+@method get_option(name)
+  See +:h nvim_win_get_option()+
+  @param [String] name
+  @return [Object]
+
+@method set_option(name, value)
+  See +:h nvim_win_set_option()+
+  @param [String] name
+  @param [Object] value
+  @return [void]
+
+@method set_config(config)
+  See +:h nvim_win_set_config()+
+  @param [Hash] config
+  @return [void]
+
+@method get_config
+  See +:h nvim_win_get_config()+
+  @return [Hash]
+
 @method get_buf
   See +:h nvim_win_get_buf()+
   @return [Buffer]
@@ -116,17 +136,6 @@ module Neovim
   @param [String] name
   @return [void]
 
-@method get_option(name)
-  See +:h nvim_win_get_option()+
-  @param [String] name
-  @return [Object]
-
-@method set_option(name, value)
-  See +:h nvim_win_set_option()+
-  @param [String] name
-  @param [Object] value
-  @return [void]
-
 @method get_position
   See +:h nvim_win_get_position()+
   @return [Array<Integer>]
@@ -143,15 +152,6 @@ module Neovim
   See +:h nvim_win_is_valid()+
   @return [Boolean]
 
-@method set_config(config)
-  See +:h nvim_win_set_config()+
-  @param [Hash] config
-  @return [void]
-
-@method get_config
-  See +:h nvim_win_get_config()+
-  @return [Hash]
-
 @method hide
   See +:h nvim_win_hide()+
   @return [void]
@@ -166,6 +166,16 @@ module Neovim
   @param [LuaRef] fun
   @return [Object]
 
+@method set_hl_ns(ns_id)
+  See +:h nvim_win_set_hl_ns()+
+  @param [Integer] ns_id
+  @return [void]
+
+@method text_height(opts)
+  See +:h nvim_win_text_height()+
+  @param [Hash] opts
+  @return [Hash]
+
 =end
   end
 end

data/lib/neovim.rb

@@ -4,17 +4,17 @@ require "neovim/session"
 require "neovim/event_loop"
 require "neovim/executable"
 require "neovim/logging"
+require "neovim/remote_module"
 require "neovim/version"
 
 # The main entrypoint to the +Neovim+ gem. It allows you to connect to a
 # running +nvim+ instance programmatically or define a remote plugin to be
 # autoloaded by +nvim+.
 #
-# You can connect to a running +nvim+ instance by setting or inspecting the
-# +NVIM_LISTEN_ADDRESS+ environment variable and connecting via the appropriate
-# +attach_+ method. This is currently supported for both UNIX domain sockets
-# and TCP. You can also spawn and connect to an +nvim+ subprocess via
-# +Neovim.attach_child(argv)+.
+# You can connect to a running +nvim+ process using the appropriate +attach_+
+# method. This is currently supported for both UNIX domain sockets and TCP. You
+# can also spawn and connect to an +nvim+ subprocess using
+# +Neovim.attach_child+.
 #
 # You can define a remote plugin using the +Neovim.plugin+ DSL, which allows
 # you to register commands, functions, and autocmds. Plugins are autoloaded by
@@ -84,6 +84,14 @@ module Neovim
     attach(EventLoop.child(argv))
   end
 
+  # Start a remote module process with handlers defined in the config block.
+  # Blocks indefinitely to handle messages.
+  #
+  # @see RemoteModule::DSL
+  def self.start_remote(&block)
+    RemoteModule.from_config_block(&block).start
+  end
+
   # Placeholder method for exposing the remote plugin DSL. This gets
   # temporarily overwritten in +Host::Loader#load+.
   #

data/neovim.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "msgpack", "~> 1.1"
   spec.add_dependency "multi_json", "~> 1.0"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry", "~> 0.14"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "vim-flavor", "2.2.2"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vim-flavor"
 end

data/script/ci/download_nvim.sh

@@ -2,32 +2,19 @@
 
 set -eu
 
-: ${RUNNER_OS:?} ${BUILD:?}
-
-case "$BUILD" in
-  latest)
-    URL_PART="latest/download"
-    ;;
-  nightly)
-    URL_PART="download/nightly"
-    ;;
-  *)
-    echo "BUILD must be 'latest' or 'nightly'." >&2
-    exit 1
-    ;;
-esac
+: ${RUNNER_OS:?}
 
 case "$(echo "$RUNNER_OS" | tr "[:upper:]" "[:lower:]")" in
   macos)
     wget -nv -P /tmp \
-      "https://github.com/neovim/neovim/releases/$URL_PART/nvim-macos.tar.gz"
-    tar -C /tmp -xzf /tmp/nvim-macos.tar.gz
-    mv /tmp/nvim-osx64 ./_nvim
+      "https://github.com/neovim/neovim/releases/download/stable/nvim-macos-x86_64.tar.gz"
+    tar -C /tmp -xzf /tmp/nvim-macos-x86_64.tar.gz
+    mv /tmp/nvim-macos-x86_64 ./_nvim
     ;;
   linux)
     mkdir -p _nvim/bin
     wget -nv -O _nvim/bin/nvim \
-      "https://github.com/neovim/neovim/releases/$URL_PART/nvim.appimage"
+      "https://github.com/neovim/neovim/releases/download/stable/nvim.appimage"
     ;;
   *)
     echo "Unrecognized \$RUNNER_OS" >&2

data/script/host_wrapper.bat

@@ -0,0 +1,3 @@
+@echo off
+pushd "%~dp0\.." 2>NUL
+ruby -I %CD%\lib %CD%\exe\neovim-ruby-host %*