neovim 0.7.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97582ab6b5d7a61143cc0d0e3e1a5ffec8b6c292
-  data.tar.gz: 1b6c5905f2c870f4fd77490a144a32337f0eef11
+SHA256:
+  metadata.gz: 6261883caf16dbd51bb9b1a869b61cf71597615e32c51af87727ea25b90f8fcd
+  data.tar.gz: 33053c2596c20db1e6314ff38c23f3ca091d994736c9852a45fc3237dcdcdba2
 SHA512:
-  metadata.gz: 01f995a41e2ece2e05228762b8e0d9ca36428bbf6bf896eb388e19b34869ede4d972395d5300381e4f4706e0426bafc6f82f0abd053aab4fa157b232db190f15
-  data.tar.gz: e55008b53e7d042c631032455be96e81715256b1c2763c98f23a7891b44b89e88c1e4a449232bba9716a280844766c03666e346bc2943e6b025b9fc12a6234e8
+  metadata.gz: 8ab4995d175c7dd2821bf547b43c4b2128ee332c5110d59698e419352d325ec94ff761cda257d8bd4612f2f3c3c868c59fcaf947f923c0c1b98ae1d83c88991c
+  data.tar.gz: 996aef5dece8afdf5306a9b716545793dd16d469f869c0d17eb336fc58ce91bf9154e234f42e5e0aab5c2b56e9025a8a5e2c86edbd48e5a7cb459b790252769e

data/.github/workflows/docs.yml

@@ -0,0 +1,39 @@
+name: Docs
+on:
+  push:
+    branches: [main]
+  schedule:
+    - cron: '0 0 * * 0'
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          repository: neovim/neovim-ruby
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: head
+      - 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:
+          NVIM_EXECUTABLE: "_nvim/bin/nvim"
+        run: bundle exec rake docs:generate
+      - name: Open pull request
+        uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "[skip ci] Update generated docs"
+          author: Docs Workflow <noreply@github.com>
+          title: "Update generated docs"

data/.github/workflows/tests.yml

@@ -0,0 +1,64 @@
+name: Tests
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  schedule:
+    - cron: '0 0 * * 0'
+jobs:
+  linux_osx:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7, 3.0, head]
+    runs-on: ${{ matrix.os }}
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    steps:
+      - 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
+      - name: Install Neovim
+        env:
+          BUILD: nightly
+        run: bundle exec rake ci:download_nvim
+      - name: Run tests
+        env:
+          NVIM_EXECUTABLE: "_nvim/bin/nvim"
+        run: bundle exec rake spec
+  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:
+      - 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
+      - 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'
+        run: bundle exec rake spec

data/.gitignore

@@ -21,3 +21,5 @@ spec/workspace
 spec/acceptance/runtime/flavors
 spec/acceptance/runtime/rplugin_manifest.vim
 vendor/bundle
+bin
+.vim-flavor

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# 0.9.0
+
+- Add RPC support for `:rubyeval`.
+- Add `Neovim::Session#next`.
+- Rename `Neovim::Session::Exited` -> `Neovim::Session::Disconnected`.
+
+# 0.8.1
+
+- Set client info on host and client startup
+- Add `Client#channel_id`
+
+# 0.8.0
+
+- Allow `Buffer#append` to take a string with newlines
+- Use non-strict line indexing in `:rubydo` to prevent line deletions from
+  throwing exceptions
+- Performance optimizations:
+  - Cache RPC method lookups and store them in a set
+  - Only flush writes before reading in the event loop
+  - Delete request handlers after invoking them
+  - Refresh provider globals in a single RPC request
+
 # 0.7.1
 
 - Fix `uninitialized constant Neovim::RubyProvider::StringIO`

data/CODE_OF_CONDUCT.md

@@ -40,7 +40,7 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/README.md

@@ -1,30 +1,29 @@
 # Neovim Ruby
 
-[![Travis](https://travis-ci.org/alexgenco/neovim-ruby.svg?branch=master)](https://travis-ci.org/alexgenco/neovim-ruby)
-[![Build status](https://ci.appveyor.com/api/projects/status/wp7agvgcxxcguj6h/branch/master?svg=true)](https://ci.appveyor.com/project/alexgenco/neovim-ruby/branch/master)
-[![Coverage Status](https://coveralls.io/repos/alexgenco/neovim-ruby/badge.svg)](https://coveralls.io/r/alexgenco/neovim-ruby)
-[![Code Climate](https://codeclimate.com/github/alexgenco/neovim-ruby/badges/gpa.svg)](https://codeclimate.com/github/alexgenco/neovim-ruby)
+[![Build Status](https://github.com/neovim/neovim-ruby/workflows/Tests/badge.svg)](https://github.com/neovim/neovim-ruby/actions)
 [![Gem Version](https://badge.fury.io/rb/neovim.svg)](https://badge.fury.io/rb/neovim)
-[![Dependency Status](https://gemnasium.com/badges/github.com/alexgenco/neovim-ruby.svg)](https://gemnasium.com/github.com/alexgenco/neovim-ruby)
-[![Inline docs](http://inch-ci.org/github/alexgenco/neovim-ruby.svg?branch=master)](http://inch-ci.org/github/alexgenco/neovim-ruby)
 
-Ruby bindings for [Neovim](https://github.com/neovim/neovim).
-
-*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)).
+Ruby support for [Neovim](https://github.com/neovim/neovim).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem "neovim"
+```ruby
+gem "neovim"
+```
 
 And then execute:
 
-    $ bundle
+```shell
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install neovim
+```shell
+gem install neovim
+```
 
 ## Usage
 
@@ -41,7 +40,7 @@ require "neovim"
 client = Neovim.attach_unix("/tmp/nvim.sock")
 ```
 
-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.
+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
 
@@ -73,7 +72,7 @@ end
 
 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.
 
-Refer to the [`Neovim::Plugin::DSL` docs](http://www.rubydoc.info/github/alexgenco/neovim-ruby/master/Neovim/Plugin/DSL) for a more complete overview of the `Neovim.plugin` DSL.
+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.
 
 ### Vim Plugin Support
 
@@ -81,16 +80,16 @@ The Neovim gem also acts as a compatibility layer for Ruby plugins written for `
 
 ## Links
 
-* Source: <http://github.com/alexgenco/neovim-ruby>
-* Bugs:   <http://github.com/alexgenco/neovim-ruby/issues>
-* CI: <http://travis-ci.org/alexgenco/neovim-ruby>
+* Source: <https://github.com/neovim/neovim-ruby>
+* Bugs: <https://github.com/neovim/neovim-ruby/issues>
+* CI: <https://github.com/neovim/neovim-ruby/actions>
 * Documentation:
-    * Latest Gem: <http://rubydoc.info/gems/neovim>
-    * Master: <http://rubydoc.info/github/alexgenco/neovim-ruby/master/frames>
+  * Latest Gem: <https://rubydoc.info/gems/neovim>
+  * Main: <https://rubydoc.info/github/neovim/neovim-ruby/main/frames>
 
 ## Contributing
 
-1. Fork it (http://github.com/alexgenco/neovim-ruby/fork)
+1. Fork it (<https://github.com/neovim/neovim-ruby/fork>)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,8 +1,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require "rubocop/rake_task"
 
-RuboCop::RakeTask.new(:style)
+Bundler.setup
 
 namespace :spec do
   desc "Run functional specs"
@@ -10,13 +9,13 @@ namespace :spec do
 
   desc "Run acceptance specs"
   task acceptance: "acceptance:deps" do
-    run_script(:run_acceptance, "--reporter", "dot", "spec/acceptance")
+    run_script("run_acceptance.rb", "--reporter", "dot", "spec/acceptance")
   end
 
   namespace :acceptance do
     desc "Install acceptance spec dependencies"
     task :deps do
-      sh "bundle exec vim-flavor update --vimfiles-path=spec/acceptance/runtime"
+      sh "vim-flavor update --vimfiles-path=spec/acceptance/runtime"
     end
   end
 end
@@ -24,17 +23,28 @@ end
 namespace :docs do
   desc "Generate Neovim remote API docs"
   task :generate do
-    run_script(:generate_docs)
+    run_script("generate_docs.rb")
   end
+end
 
-  desc "Validate generated documentation is up-to-date"
-  task :validate do
-    run_script(:validate_docs)
+namespace :ci do
+  task :download_nvim do
+    run_script("ci/download_nvim.sh")
   end
 end
 
-task default: [:style, "spec:functional", "spec:acceptance", "docs:validate"]
+desc "Run specs"
+task spec: [:"spec:functional", :"spec:acceptance"]
+
+task default: :spec
 
-def run_script(script_name, *args)
-  ruby File.expand_path("../script/#{script_name}.rb", __FILE__), *args
+def run_script(relpath, *args)
+  path = File.expand_path("script/#{relpath}", __dir__)
+  cmd_handler = ->(ok, status) { ok || exit(status.exitstatus) }
+
+  if File.extname(path) == ".rb"
+    ruby(path, *args, &cmd_handler)
+  else
+    sh(path, *args, &cmd_handler)
+  end
 end

data/exe/neovim-ruby-host

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "neovim/host/cli"
+
+Neovim::Host::CLI.run(__FILE__, ARGV, STDIN, STDOUT, STDERR)

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.2.2
+  # The methods documented here were generated using NVIM v0.5.0
   class Buffer < RemoteObject
     attr_reader :lines
 
@@ -91,7 +91,7 @@ module Neovim
       window = @session.request(:nvim_get_current_win)
       cursor = window.cursor
 
-      set_lines(index, index, true, [str])
+      set_lines(index, index, true, [*str.split($/)])
       window.set_cursor(cursor)
       str
     end
@@ -135,112 +135,191 @@ module Neovim
 
 # The following methods are dynamically generated.
 =begin
-@method line_count(buffer)
+@method line_count
   See +:h nvim_buf_line_count()+
-  @param [Buffer] buffer
   @return [Integer]
 
-@method get_lines(buffer, start, end, strict_indexing)
+@method attach(send_buffer, opts)
+  See +:h nvim_buf_attach()+
+  @param [Boolean] send_buffer
+  @param [Hash] opts
+  @return [Boolean]
+
+@method detach
+  See +:h nvim_buf_detach()+
+  @return [Boolean]
+
+@method get_lines(start, end, strict_indexing)
   See +:h nvim_buf_get_lines()+
-  @param [Buffer] buffer
   @param [Integer] start
   @param [Integer] end
   @param [Boolean] strict_indexing
   @return [Array<String>]
 
-@method set_lines(buffer, start, end, strict_indexing, replacement)
+@method set_lines(start, end, strict_indexing, replacement)
   See +:h nvim_buf_set_lines()+
-  @param [Buffer] buffer
   @param [Integer] start
   @param [Integer] end
   @param [Boolean] strict_indexing
   @param [Array<String>] replacement
   @return [void]
 
-@method get_var(buffer, name)
+@method set_text(start_row, start_col, end_row, end_col, replacement)
+  See +:h nvim_buf_set_text()+
+  @param [Integer] start_row
+  @param [Integer] start_col
+  @param [Integer] end_row
+  @param [Integer] end_col
+  @param [Array<String>] replacement
+  @return [void]
+
+@method get_offset(index)
+  See +:h nvim_buf_get_offset()+
+  @param [Integer] index
+  @return [Integer]
+
+@method get_var(name)
   See +:h nvim_buf_get_var()+
-  @param [Buffer] buffer
   @param [String] name
   @return [Object]
 
-@method get_changedtick(buffer)
+@method get_changedtick
   See +:h nvim_buf_get_changedtick()+
-  @param [Buffer] buffer
   @return [Integer]
 
-@method get_keymap(buffer, mode)
+@method get_keymap(mode)
   See +:h nvim_buf_get_keymap()+
-  @param [Buffer] buffer
   @param [String] mode
   @return [Array<Hash>]
 
-@method set_var(buffer, name, value)
+@method set_keymap(mode, lhs, rhs, opts)
+  See +:h nvim_buf_set_keymap()+
+  @param [String] mode
+  @param [String] lhs
+  @param [String] rhs
+  @param [Hash] opts
+  @return [void]
+
+@method del_keymap(mode, lhs)
+  See +:h nvim_buf_del_keymap()+
+  @param [String] mode
+  @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 [Buffer] buffer
   @param [String] name
   @param [Object] value
   @return [void]
 
-@method del_var(buffer, name)
+@method del_var(name)
   See +:h nvim_buf_del_var()+
-  @param [Buffer] buffer
   @param [String] name
   @return [void]
 
-@method get_option(buffer, name)
+@method get_option(name)
   See +:h nvim_buf_get_option()+
-  @param [Buffer] buffer
   @param [String] name
   @return [Object]
 
-@method set_option(buffer, name, value)
+@method set_option(name, value)
   See +:h nvim_buf_set_option()+
-  @param [Buffer] buffer
   @param [String] name
   @param [Object] value
   @return [void]
 
-@method get_number(buffer)
-  See +:h nvim_buf_get_number()+
-  @param [Buffer] buffer
-  @return [Integer]
-
-@method get_name(buffer)
+@method get_name
   See +:h nvim_buf_get_name()+
-  @param [Buffer] buffer
   @return [String]
 
-@method set_name(buffer, name)
+@method set_name(name)
   See +:h nvim_buf_set_name()+
-  @param [Buffer] buffer
   @param [String] name
   @return [void]
 
-@method is_valid(buffer)
+@method is_loaded
+  See +:h nvim_buf_is_loaded()+
+  @return [Boolean]
+
+@method is_valid
   See +:h nvim_buf_is_valid()+
-  @param [Buffer] buffer
   @return [Boolean]
 
-@method get_mark(buffer, name)
+@method get_mark(name)
   See +:h nvim_buf_get_mark()+
-  @param [Buffer] buffer
   @param [String] name
   @return [Array<Integer>]
 
-@method add_highlight(buffer, src_id, hl_group, line, col_start, col_end)
+@method get_extmark_by_id(ns_id, id, opts)
+  See +:h nvim_buf_get_extmark_by_id()+
+  @param [Integer] ns_id
+  @param [Integer] id
+  @param [Hash] opts
+  @return [Array<Integer>]
+
+@method get_extmarks(ns_id, start, end, opts)
+  See +:h nvim_buf_get_extmarks()+
+  @param [Integer] ns_id
+  @param [Object] start
+  @param [Object] end
+  @param [Hash] opts
+  @return [Array]
+
+@method set_extmark(ns_id, line, col, opts)
+  See +:h nvim_buf_set_extmark()+
+  @param [Integer] ns_id
+  @param [Integer] line
+  @param [Integer] col
+  @param [Hash] opts
+  @return [Integer]
+
+@method del_extmark(ns_id, id)
+  See +:h nvim_buf_del_extmark()+
+  @param [Integer] ns_id
+  @param [Integer] id
+  @return [Boolean]
+
+@method add_highlight(ns_id, hl_group, line, col_start, col_end)
   See +:h nvim_buf_add_highlight()+
-  @param [Buffer] buffer
-  @param [Integer] src_id
+  @param [Integer] ns_id
   @param [String] hl_group
   @param [Integer] line
   @param [Integer] col_start
   @param [Integer] col_end
   @return [Integer]
 
-@method clear_highlight(buffer, src_id, line_start, line_end)
-  See +:h nvim_buf_clear_highlight()+
-  @param [Buffer] buffer
+@method clear_namespace(ns_id, line_start, line_end)
+  See +:h nvim_buf_clear_namespace()+
+  @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 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]