neovim 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6261883caf16dbd51bb9b1a869b61cf71597615e32c51af87727ea25b90f8fcd
-  data.tar.gz: 33053c2596c20db1e6314ff38c23f3ca091d994736c9852a45fc3237dcdcdba2
+  metadata.gz: 5320dac4af30229401acf28acf82589d27523b419a65caaf6a9b32982be13559
+  data.tar.gz: 1de09c53e257cce5c3b82902cd998a8b74601e452e25641e7e5f59fceed9bcaf
 SHA512:
-  metadata.gz: 8ab4995d175c7dd2821bf547b43c4b2128ee332c5110d59698e419352d325ec94ff761cda257d8bd4612f2f3c3c868c59fcaf947f923c0c1b98ae1d83c88991c
-  data.tar.gz: 996aef5dece8afdf5306a9b716545793dd16d469f869c0d17eb336fc58ce91bf9154e234f42e5e0aab5c2b56e9025a8a5e2c86edbd48e5a7cb459b790252769e
+  metadata.gz: 5d4950d5edfd43619d9e2e3c4efccaee9ab9219cad3db41fd9d003262870ad2a98f77f3f76dba60c9fb17272fb0b0ad2982acdb1d9b8a31248e2c9ed494e27ec
+  data.tar.gz: 8cc1963557bd46b91e4050363296b4d5b87bd7f1fcf736ac5bb1b6a324d4ec1c84baf2cc6069290c73108ec948af37a2fb57e78b3ec8c5c7622e13f1b6e31e65

data/.github/workflows/docs.yml

@@ -18,13 +18,13 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: head
+      - name: Install libfuse
+        run: sudo apt install libfuse2
       - name: Bundle install
         run: |
           bundle config set path vendor/bundle
           bundle install --jobs 3 --retry 3
       - name: Install Neovim
-        env:
-          BUILD: latest
         run: bundle exec rake ci:download_nvim
       - name: Generate docs
         env:

data/.github/workflows/tests.yml

@@ -12,23 +12,23 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [2.5, 2.6, 2.7, 3.0, head]
+        ruby: [ruby, head]
     runs-on: ${{ matrix.os }}
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
+      - name: Fix up git URLs
+        run: echo -e '[url "https://github.com/"]\n  insteadOf = "git://github.com/"' >> ~/.gitconfig
       - uses: actions/checkout@v2
         with:
           repository: neovim/neovim-ruby
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: Bundle install
-        run: |
-          bundle config set path vendor/bundle
-          bundle install --jobs 3 --retry 3
+          bundler-cache: true
+      - name: Install libfuse
+        run: sudo apt install libfuse2
+        if: matrix.os == 'ubuntu-latest'
       - name: Install Neovim
-        env:
-          BUILD: nightly
         run: bundle exec rake ci:download_nvim
       - name: Run tests
         env:
@@ -37,28 +37,26 @@ jobs:
   windows:
     strategy:
       fail-fast: false
-      matrix:
-        ruby: [2.5, 2.6, 2.7, 3.0]
     runs-on: windows-latest
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
     steps:
+      - name: Fix up git URLs
+        run: |
+          echo '[url "https://github.com/"]' >> ~/.gitconfig
+          echo '  insteadOf = "git://github.com/"' >> ~/.gitconfig
       - uses: actions/checkout@v2
         with:
           repository: neovim/neovim-ruby
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Bundle install
-        run: |
-          bundle config set path vendor/bundle
-          bundle install --jobs 3 --retry 3
+          ruby-version: ruby
+          bundler-cache: true
       - name: Install Neovim
         uses: crazy-max/ghaction-chocolatey@v1
         with:
-          # TODO: Install `--pre` once nightly release is fixed:
-          # https://github.com/neovim/neovim/issues/13312
           args: install neovim -fy --ignore-dependencies --ignore-checksums
       - name: Run tests
         env:
-          NVIM_EXECUTABLE: 'C:\tools\neovim\Neovim\bin\nvim'
+          VIM_FLAVOR_HOME: 'D:\'
+          NVIM_EXECUTABLE: 'C:\tools\neovim\nvim-win64\bin\nvim'
         run: bundle exec rake spec

data/.gitignore

@@ -18,7 +18,7 @@ test/tmp
 test/version_tmp
 tmp
 spec/workspace
-spec/acceptance/runtime/flavors
+spec/acceptance/runtime/pack
 spec/acceptance/runtime/rplugin_manifest.vim
 vendor/bundle
 bin

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 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
+  (https://github.com/neovim/neovim-ruby/issues/97)
+
 # 0.9.0
 
 - Add RPC support for `:rubyeval`.

data/Flavorfile.lock

@@ -0,0 +1 @@
+thinca/vim-themis (c1f4d465ce7dd23735513551b5c4c918d9c1bab1 at master)

data/README.md

@@ -27,10 +27,10 @@ gem install neovim
 
 ## Usage
 
-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:
+Neovim supports the `--listen` option for specifying an address to serve its RPC API. To connect to Neovim over a Unix socket, start it up like this:
 
 ```shell
-$ NVIM_LISTEN_ADDRESS=/tmp/nvim.sock nvim
+$ nvim --listen /tmp/nvim.sock
 ```
 
 You can then connect to that socket path to get a `Neovim::Client`:
@@ -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
 
@@ -85,7 +69,7 @@ The Neovim gem also acts as a compatibility layer for Ruby plugins written for `
 * CI: <https://github.com/neovim/neovim-ruby/actions>
 * Documentation:
   * Latest Gem: <https://rubydoc.info/gems/neovim>
-  * Main: <https://rubydoc.info/github/neovim/neovim-ruby/main/frames>
+  * Main: <https://rubydoc.info/github/neovim/neovim-ruby/main>
 
 ## Contributing
 

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.5.0
+  # The methods documented here were generated using NVIM v0.10.0
   class Buffer < RemoteObject
     attr_reader :lines
 
@@ -54,7 +54,7 @@ module Neovim
     # @param index [Integer]
     # @return [String]
     def [](index)
-      check_index(index)
+      check_index(index, 1)
       @lines[index - 1]
     end
 
@@ -64,7 +64,7 @@ module Neovim
     # @param str [String]
     # @return [String]
     def []=(index, str)
-      check_index(index)
+      check_index(index, 1)
       @lines[index - 1] = str
     end
 
@@ -73,13 +73,16 @@ module Neovim
     # @param index [Integer]
     # @return [void]
     def delete(index)
-      check_index(index)
+      check_index(index, 1)
       @lines.delete(index - 1)
       nil
     end
 
     # Append a line after the given line (1-indexed).
     #
+    # Unlike the other methods, `0` is a valid index argument here, and inserts
+    # into the first line of the buffer.
+    #
     # To maintain backwards compatibility with +vim+, the cursor is forced back
     # to its previous position after inserting the line.
     #
@@ -87,7 +90,7 @@ module Neovim
     # @param str [String]
     # @return [String]
     def append(index, str)
-      check_index(index)
+      check_index(index, 0)
       window = @session.request(:nvim_get_current_win)
       cursor = window.cursor
 
@@ -127,8 +130,8 @@ module Neovim
 
     private
 
-    def check_index(index)
-      raise ArgumentError, "Index out of bounds" if index < 0
+    def check_index(index, min)
+      raise ArgumentError, "Index out of bounds" if index < min
     end
 
     public
@@ -173,6 +176,15 @@ module Neovim
   @param [Array<String>] replacement
   @return [void]
 
+@method get_text(start_row, start_col, end_row, end_col, opts)
+  See +:h nvim_buf_get_text()+
+  @param [Integer] start_row
+  @param [Integer] start_col
+  @param [Integer] end_row
+  @param [Integer] end_col
+  @param [Hash] opts
+  @return [Array<String>]
+
 @method get_offset(index)
   See +:h nvim_buf_get_offset()+
   @param [Integer] index
@@ -206,11 +218,6 @@ module Neovim
   @param [String] lhs
   @return [void]
 
-@method get_commands(opts)
-  See +:h nvim_buf_get_commands()+
-  @param [Hash] opts
-  @return [Hash]
-
 @method set_var(name, value)
   See +:h nvim_buf_set_var()+
   @param [String] name
@@ -222,17 +229,6 @@ module Neovim
   @param [String] name
   @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]
-
 @method get_name
   See +:h nvim_buf_get_name()+
   @return [String]
@@ -250,11 +246,76 @@ module Neovim
   See +:h nvim_buf_is_valid()+
   @return [Boolean]
 
+@method del_mark(name)
+  See +:h nvim_buf_del_mark()+
+  @param [String] name
+  @return [Boolean]
+
+@method set_mark(name, line, col, opts)
+  See +:h nvim_buf_set_mark()+
+  @param [String] name
+  @param [Integer] line
+  @param [Integer] col
+  @param [Hash] opts
+  @return [Boolean]
+
 @method get_mark(name)
   See +:h nvim_buf_get_mark()+
   @param [String] name
   @return [Array<Integer>]
 
+@method call(fun)
+  See +:h nvim_buf_call()+
+  @param [LuaRef] fun
+  @return [Object]
+
+@method create_user_command(name, command, opts)
+  See +:h nvim_buf_create_user_command()+
+  @param [String] name
+  @param [Object] command
+  @param [Hash] opts
+  @return [void]
+
+@method del_user_command(name)
+  See +:h nvim_buf_del_user_command()+
+  @param [String] name
+  @return [void]
+
+@method get_commands(opts)
+  See +:h nvim_buf_get_commands()+
+  @param [Hash] opts
+  @return [Hash]
+
+@method get_number
+  See +:h nvim_buf_get_number()+
+  @return [Integer]
+
+@method clear_highlight(ns_id, line_start, line_end)
+  See +:h nvim_buf_clear_highlight()+
+  @param [Integer] ns_id
+  @param [Integer] line_start
+  @param [Integer] line_end
+  @return [void]
+
+@method set_virtual_text(src_id, line, chunks, opts)
+  See +:h nvim_buf_set_virtual_text()+
+  @param [Integer] src_id
+  @param [Integer] line
+  @param [Array] chunks
+  @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
@@ -300,30 +361,6 @@ module Neovim
   @param [Integer] line_end
   @return [void]
 
-@method set_virtual_text(src_id, line, chunks, opts)
-  See +:h nvim_buf_set_virtual_text()+
-  @param [Integer] src_id
-  @param [Integer] line
-  @param [Array] chunks
-  @param [Hash] opts
-  @return [Integer]
-
-@method call(fun)
-  See +:h nvim_buf_call()+
-  @param [LuaRef] fun
-  @return [Object]
-
-@method get_number
-  See +:h nvim_buf_get_number()+
-  @return [Integer]
-
-@method clear_highlight(ns_id, line_start, line_end)
-  See +:h nvim_buf_clear_highlight()+
-  @param [Integer] ns_id
-  @param [Integer] line_start
-  @param [Integer] line_end
-  @return [void]
-
 =end
   end
 end