neovim 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d86525bb60d51c356a2c75f368d248991a207c7875348a88181a3f7156b6051a
-  data.tar.gz: cb88fe16e651b54a671ae95f1ea71b692fa5f9c9348f16ce0f38218c98b7b90a
+  metadata.gz: 5320dac4af30229401acf28acf82589d27523b419a65caaf6a9b32982be13559
+  data.tar.gz: 1de09c53e257cce5c3b82902cd998a8b74601e452e25641e7e5f59fceed9bcaf
 SHA512:
-  metadata.gz: f24def6fc7afdab94cb605e5f9fb721d3b621841ebda9016ba26ab4acabf10dba0ad3b79c278c009fdf153654181a1c18b69385445e19627b91494db048d546c
-  data.tar.gz: f64be9703c9c312fb5571108838b199f4d5349ced2dcac12a32936db8a9f847222643ee05cd37b67a7671c8e92124489703df54ff5ef134d8875e8f546f46b9c
+  metadata.gz: 5d4950d5edfd43619d9e2e3c4efccaee9ab9219cad3db41fd9d003262870ad2a98f77f3f76dba60c9fb17272fb0b0ad2982acdb1d9b8a31248e2c9ed494e27ec
+  data.tar.gz: 8cc1963557bd46b91e4050363296b4d5b87bd7f1fcf736ac5bb1b6a324d4ec1c84baf2cc6069290c73108ec948af37a2fb57e78b3ec8c5c7622e13f1b6e31e65

data/.github/workflows/tests.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [2.7, 3.0, 3.1, 3.2, head]
+        ruby: [ruby, head]
     runs-on: ${{ matrix.os }}
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
@@ -37,8 +37,6 @@ jobs:
   windows:
     strategy:
       fail-fast: false
-      matrix:
-        ruby: [2.7, 3.0, 3.1, 3.2]
     runs-on: windows-latest
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
@@ -51,7 +49,7 @@ jobs:
           repository: neovim/neovim-ruby
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby }}
+          ruby-version: ruby
           bundler-cache: true
       - name: Install Neovim
         uses: crazy-max/ghaction-chocolatey@v1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.10.0
+
+- Add `Neovim.start_remote` helper for remote module support
+  (https://github.com/neovim/neovim-ruby/pull/107)
+
 # 0.9.1
 
 - Fix bug where `Buffer#[]` with `0` returned the last line of the buffer

data/Flavorfile.lock

@@ -1 +1 @@
-thinca/vim-themis (737e5444713ba53a9dcfbe3b962239bd0bd9162e at master)
+thinca/vim-themis (c1f4d465ce7dd23735513551b5c4c918d9c1bab1 at master)

data/README.md

@@ -42,37 +42,21 @@ client = Neovim.attach_unix("/tmp/nvim.sock")
 
 Refer to the [`Neovim` docs](https://www.rubydoc.info/github/neovim/neovim-ruby/main/Neovim) for other ways to connect to `nvim`, and the [`Neovim::Client` docs](https://www.rubydoc.info/github/neovim/neovim-ruby/main/Neovim/Client) for a summary of the client interface.
 
-### Plugins
+### Remote Modules
 
-Plugins are Ruby files loaded from the `$VIMRUNTIME/rplugin/ruby/` directory. Here's an example plugin:
+Remote modules allow users to define custom handlers in Ruby. To implement a remote module:
 
-```ruby
-# ~/.config/nvim/rplugin/ruby/example_plugin.rb
-
-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|
-    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|
-    x + y
-  end
-
-  # Define an autocmd for the BufEnter event on Ruby files.
-  plug.autocmd(:BufEnter, pattern: "*.rb") do |nvim|
-    nvim.command("echom 'Ruby file, eh?'")
-  end
-end
-```
+- Define your handlers in a plain Ruby script that imports `neovim`
+- Spawn the script from lua using `jobstart`
+- Define commands in lua using `nvim_create_user_command` that route to the job's channel ID
+
+For usage examples, see:
 
-When you add or update a plugin, you will need to call `:UpdateRemotePlugins` to update the remote plugin manifest. See `:help remote-plugin-manifest` for more information.
+- [`example_remote_module.rb`](spec/acceptance/runtime/example_remote_module.rb)
+- [`example_remote_module.lua`](spec/acceptance/runtime/plugin/example_remote_module.lua)
+- [`remote_module_spec.vim`](spec/acceptance/remote_module_spec.vim)
 
-Refer to the [`Neovim::Plugin::DSL` docs](https://www.rubydoc.info/github/neovim/neovim-ruby/main/Neovim/Plugin/DSL) for a more complete overview of the `Neovim.plugin` DSL.
+*Note*: Remote modules are a replacement for the deprecated "remote plugin" architecture. See https://github.com/neovim/neovim/issues/27949 for details.
 
 ### Vim Plugin Support
 

data/lib/neovim/buffer.rb

@@ -4,7 +4,7 @@ require "neovim/line_range"
 module Neovim
   # Class representing an +nvim+ buffer.
   #
-  # The methods documented here were generated using NVIM v0.9.1
+  # The methods documented here were generated using NVIM v0.10.0
   class Buffer < RemoteObject
     attr_reader :lines
 
@@ -305,6 +305,17 @@ module Neovim
   @param [Hash] opts
   @return [Integer]
 
+@method get_option(name)
+  See +:h nvim_buf_get_option()+
+  @param [String] name
+  @return [Object]
+
+@method set_option(name, value)
+  See +:h nvim_buf_set_option()+
+  @param [String] name
+  @param [Object] value
+  @return [void]
+
 @method get_extmark_by_id(ns_id, id, opts)
   See +:h nvim_buf_get_extmark_by_id()+
   @param [Integer] ns_id
@@ -350,17 +361,6 @@ module Neovim
   @param [Integer] line_end
   @return [void]
 
-@method get_option(name)
-  See +:h nvim_buf_get_option()+
-  @param [String] name
-  @return [Object]
-
-@method set_option(name, value)
-  See +:h nvim_buf_set_option()+
-  @param [String] name
-  @param [Object] value
-  @return [void]
-
 =end
   end
 end

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.9.1
+  # The methods documented here were generated using NVIM v0.10.0
   #
   # @see Buffer
   # @see Window
@@ -223,6 +223,16 @@ module Neovim
   @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
@@ -261,11 +271,6 @@ module Neovim
   @param [Hash] opts
   @return [Hash]
 
-@method get_option(name)
-  See +:h nvim_get_option()+
-  @param [String] name
-  @return [Object]
-
 @method ui_attach(width, height, options)
   See +:h nvim_ui_attach()+
   @param [Integer] width
@@ -314,6 +319,12 @@ module Neovim
   @param [Float] col
   @return [void]
 
+@method ui_term_event(event, value)
+  See +:h nvim_ui_term_event()+
+  @param [String] event
+  @param [Object] value
+  @return [void]
+
 @method get_hl_id_by_name(name)
   See +:h nvim_get_hl_id_by_name()+
   @param [String] name
@@ -332,6 +343,11 @@ module Neovim
   @param [Hash] val
   @return [void]
 
+@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
@@ -613,11 +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 list_uis
   See +:h nvim_list_uis()+
   @return [Array]

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.9.1
+  # 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.1")
+  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.9.1
+  # The methods documented here were generated using NVIM v0.10.0
   class Window < RemoteObject
     # Get the buffer displayed in the window
     #
@@ -171,6 +171,11 @@ module Neovim
   @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,6 +4,7 @@ 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
@@ -83,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/script/ci/download_nvim.sh

@@ -7,9 +7,9 @@ set -eu
 case "$(echo "$RUNNER_OS" | tr "[:upper:]" "[:lower:]")" in
   macos)
     wget -nv -P /tmp \
-      "https://github.com/neovim/neovim/releases/download/stable/nvim-macos.tar.gz"
-    tar -C /tmp -xzf /tmp/nvim-macos.tar.gz
-    mv /tmp/nvim-macos ./_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

data/script/host_wrapper.bat

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

data/script/host_wrapper.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+cd "$(dirname "$0")/.."
+
+exec ruby -I ./lib ./exe/neovim-ruby-host "$@"

data/script/run_acceptance.rb

@@ -21,7 +21,7 @@ env = {
   "NVIM_RPLUGIN_MANIFEST" => manifest,
   "THEMIS_VIM" => nvim,
   "THEMIS_HOME" => themis_home,
-  "THEMIS_ARGS" => "-e -s --headless -u #{vimrc}"
+  "THEMIS_ARGS" => "-e --headless -u #{vimrc}"
 }
 
 FileUtils.rm_f(manifest)
@@ -30,7 +30,7 @@ Dir.chdir(root) do
   system(
     env,
     nvim,
-    "-e", "-s", "--headless",
+    "-e", "--headless",
     "-u", vimrc,
     "+UpdateRemotePlugins", "+qa!"
   )

data/spec/acceptance/client_info_spec.vim

@@ -9,34 +9,18 @@ function! s:suite.before_each() abort
         \ "v:val.client")
 endfunction
 
-function! s:suite.get_script_host_client_info() abort
-  let client_info = s:client_chans[1]
-
-  call s:expect(sort(keys(client_info))).to_equal(
-        \ ["attributes", "methods", "name", "type", "version"])
-
-  call s:expect(client_info.attributes).to_be_dict()
-  call s:expect(client_info.methods).to_equal({"specs": {"nargs": 1}, "poll": {}})
-  call s:expect(client_info.name).to_equal("ruby-script-host")
-  call s:expect(client_info.type).to_equal("host")
-
-  call s:expect(client_info.version.major).to_be_number()
-  call s:expect(client_info.version.minor).to_be_number()
-  call s:expect(client_info.version.patch).to_be_number()
-endfunction
-
-function! s:suite.get_rplugin_client_info() abort
-  let client_info = s:client_chans[0]
-
-  call s:expect(sort(keys(client_info))).to_equal(
-        \ ["attributes", "methods", "name", "type", "version"])
-
-  call s:expect(client_info.attributes).to_be_dict()
-  call s:expect(client_info.methods).to_equal({"specs": {"nargs": 1}, "poll": {}})
-  call s:expect(client_info.name).to_equal("ruby-rplugin-host")
-  call s:expect(client_info.type).to_equal("host")
-
-  call s:expect(client_info.version.major).to_be_number()
-  call s:expect(client_info.version.minor).to_be_number()
-  call s:expect(client_info.version.patch).to_be_number()
+function! s:suite.get_client_info() abort
+  for client_info in s:client_chans
+    call s:expect(sort(keys(client_info))).to_equal(
+          \ ["attributes", "methods", "name", "type", "version"])
+
+    call s:expect(client_info.attributes).to_be_dict()
+    call s:expect(client_info.methods).to_equal({"specs": {"nargs": 1}, "poll": {}})
+    call s:expect(client_info.name).to_match("ruby-\\(script\\|rplugin\\)-host")
+    call s:expect(client_info.type).to_equal("host")
+
+    call s:expect(client_info.version.major).to_be_number()
+    call s:expect(client_info.version.minor).to_be_number()
+    call s:expect(client_info.version.patch).to_be_number()
+  endfor
 endfunction

data/spec/acceptance/remote_module_spec.vim

@@ -0,0 +1,13 @@
+let s:suite = themis#suite("Remote module")
+let s:expect = themis#helper("expect")
+
+call themis#helper('command').with(s:)
+
+function! s:suite.defines_commands() abort
+  RbSetVar set_from_rb_mod foobar
+  call s:expect(g:set_from_rb_mod).to_equal('foobar')
+endfunction
+
+function! s:suite.propagates_errors() abort
+  Throws /oops/ :RbWillRaise
+endfunction

data/spec/acceptance/runtime/example_remote_module.rb

@@ -0,0 +1,11 @@
+require "neovim"
+
+Neovim.start_remote do |mod|
+  mod.register_handler("rb_set_var") do |nvim, name, val|
+    nvim.set_var(name, val.to_s)
+  end
+
+  mod.register_handler("rb_will_raise") do |nvim|
+    raise "oops"
+  end
+end

data/spec/acceptance/runtime/init.vim

@@ -1,7 +1,12 @@
 let s:lib_path = getcwd() . "/lib"
 let s:exe_path = getcwd() . "/exe/neovim-ruby-host"
 let g:acceptance_rtp = getcwd() . "/spec/acceptance/runtime"
-let g:ruby_host_prog = printf("ruby -I %s %s", s:lib_path, s:exe_path)
+
+if has("win32") || has("win64")
+  let g:ruby_host_prog = getcwd() . "/script/host_wrapper.bat"
+else
+  let g:ruby_host_prog = getcwd() . "/script/host_wrapper.sh"
+endif
 
 ruby require "rspec/expectations"
 ruby include ::RSpec::Matchers.dup

data/spec/acceptance/runtime/plugin/example_remote_module.lua

@@ -0,0 +1,23 @@
+local chan
+
+local function ensure_job()
+  if chan then
+    return chan
+  end
+
+  chan = vim.fn.jobstart({
+    'ruby',
+    '-I', 'lib',
+    'spec/acceptance/runtime/example_remote_module.rb',
+  }, { rpc = true })
+
+  return chan
+end
+
+vim.api.nvim_create_user_command('RbSetVar', function(args)
+  vim.fn.rpcrequest(ensure_job(), 'rb_set_var', args.fargs)
+end, { nargs = '*' })
+
+vim.api.nvim_create_user_command('RbWillRaise', function(args)
+  vim.fn.rpcrequest(ensure_job(), 'rb_will_raise', args.fargs)
+end, { nargs = 0 })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neovim
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Alex Genco
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-13 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -160,6 +160,8 @@ files:
 - lib/neovim/plugin.rb
 - lib/neovim/plugin/dsl.rb
 - lib/neovim/plugin/handler.rb
+- lib/neovim/remote_module.rb
+- lib/neovim/remote_module/dsl.rb
 - lib/neovim/remote_object.rb
 - lib/neovim/ruby_provider.rb
 - lib/neovim/ruby_provider/buffer_ext.rb
@@ -174,10 +176,13 @@ files:
 - script/ci/download_nvim.sh
 - script/dump_api.rb
 - script/generate_docs.rb
+- script/host_wrapper.bat
+- script/host_wrapper.sh
 - script/j2mp.rb
 - script/mp2j.rb
 - script/run_acceptance.rb
 - spec/acceptance/client_info_spec.vim
+- spec/acceptance/remote_module_spec.vim
 - spec/acceptance/rplugin_autocmd_spec.vim
 - spec/acceptance/rplugin_command_spec.vim
 - spec/acceptance/rplugin_function_spec.vim
@@ -196,7 +201,9 @@ files:
 - spec/acceptance/rubyfile/set_pwd_after.rb
 - spec/acceptance/rubyfile/set_pwd_before.rb
 - spec/acceptance/rubyfile_spec.vim
+- spec/acceptance/runtime/example_remote_module.rb
 - spec/acceptance/runtime/init.vim
+- spec/acceptance/runtime/plugin/example_remote_module.lua
 - spec/acceptance/runtime/rplugin/ruby/autocmds.rb
 - spec/acceptance/runtime/rplugin/ruby/commands.rb
 - spec/acceptance/runtime/rplugin/ruby/functions.rb
@@ -250,6 +257,7 @@ specification_version: 4
 summary: A Ruby client for Neovim
 test_files:
 - spec/acceptance/client_info_spec.vim
+- spec/acceptance/remote_module_spec.vim
 - spec/acceptance/rplugin_autocmd_spec.vim
 - spec/acceptance/rplugin_command_spec.vim
 - spec/acceptance/rplugin_function_spec.vim
@@ -268,7 +276,9 @@ test_files:
 - spec/acceptance/rubyfile/set_pwd_after.rb
 - spec/acceptance/rubyfile/set_pwd_before.rb
 - spec/acceptance/rubyfile_spec.vim
+- spec/acceptance/runtime/example_remote_module.rb
 - spec/acceptance/runtime/init.vim
+- spec/acceptance/runtime/plugin/example_remote_module.lua
 - spec/acceptance/runtime/rplugin/ruby/autocmds.rb
 - spec/acceptance/runtime/rplugin/ruby/commands.rb
 - spec/acceptance/runtime/rplugin/ruby/functions.rb