neovim 0.8.1 → 0.9.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fedda91f1ab06609df060e17b598655776a94fb60a7037fbdbeec1eebc24585d
-  data.tar.gz: 2e5a7ae9846c9b1375912cf129153f89ecadf2617b618267f6a44aed2c768843
+  metadata.gz: 9b1d22feedf4011597b4ef37233dbc13f1f874fa7bb03986d21a4e1cbe0d3f21
+  data.tar.gz: 63f008322d89124368e2d3c556dd14e8734874d9ffd7c96ef77556efeda69b5b
 SHA512:
-  metadata.gz: 9c1238b3fb5ccb9595e81f872f1080114c63a01505f8f12a3d230cc3c3f039e8d89f3a69fb38df237e8420f732bb1627554c8b87b26a4e0eb98f59e1c3b17c5c
-  data.tar.gz: 7cf59362e19aa0ffbf44a1dd91fe62b7e822bf5c3dee5039adce141499139024fe7dbf0d6adaddb60cbe45144584662f1f23626d32bf16e9326d889ea402c39d
+  metadata.gz: 556a087351aee954365afc96f6f57bc4f47bab4dd0333db4d8a55025c578068275b91186d6509a7b160faa20a8863be72aaa09866dcc604490a1aaf92e26c6c5
+  data.tar.gz: 23dbec9563bae88cdd3ed4315c1f1ff36cfdc2446b438c162da1633cd0e5e40b1f0f1f92d8a2d457c80b8b9e73ef6ad84bcb9d18870aab91a73a2bf053743dfd

data/.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: Docs
+on:
+  push:
+    branches: [master]
+  schedule:
+    - cron: '0 0 * * 0'
+jobs:
+  docs:
+    runs-on: ubuntu-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: 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@v2
+        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/linter.yml

@@ -0,0 +1,32 @@
+name: Linter
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+jobs:
+  linter:
+    runs-on: ubuntu-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: head
+      - name: Cache checksum
+        run: |
+          openssl md5 Gemfile neovim.gemspec > /tmp/checksum.txt
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('/tmp/checksum.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - name: Bundle install
+        run: |
+          bundle config set path vendor/bundle
+          bundle install --jobs 3 --retry 3
+      - name: Run linter
+        run: bundle exec rake linter

data/.github/workflows/tests.yml

@@ -0,0 +1,62 @@
+name: Tests
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  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, 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] # msgpack not supported on windows on 2.8 yet
+    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:
+          args: install neovim --pre -fy --ignore-dependencies --ignore-checksums
+      - name: Run tests
+        env:
+          NVIM_EXECUTABLE: 'C:\tools\neovim\Neovim\bin\nvim'
+        run: bundle exec rake spec

data/.rubocop.yml

@@ -29,6 +29,7 @@ Lint/HandleExceptions:
     - lib/neovim/logging.rb
     - lib/neovim/connection.rb
     - lib/neovim/line_range.rb
+    - spec/**/*
 
 Lint/RescueException:
   Exclude:
@@ -64,8 +65,7 @@ Metrics/MethodLength:
   Max: 50
 
 Metrics/ModuleLength:
-  Exclude:
-    - spec/**/*
+  Enabled: false
 
 Metrics/ParameterLists:
   Max: 6
@@ -92,6 +92,11 @@ Style/ConditionalAssignment:
   EnforcedStyle: assign_inside_condition
   IncludeTernaryExpressions: false
 
+Style/Documentation:
+  Exclude:
+    - spec/**/*
+    - lib/neovim/ruby_provider/object_ext.rb
+
 Style/DoubleNegation:
   Enabled: false
 
@@ -103,15 +108,27 @@ Style/GlobalVars:
     - lib/neovim/ruby_provider/vim.rb
     - spec/neovim/ruby_provider/vim_spec.rb
 
+Style/IfUnlessModifier:
+  Enabled: false
+
 Style/MultilineTernaryOperator:
   Enabled: false
 
+Style/NegatedIf:
+  EnforcedStyle: postfix
+
 Style/ParallelAssignment:
   Enabled: false
 
+Style/PerlBackrefs:
+   Enabled: false
+
 Style/RescueStandardError:
   EnforcedStyle: implicit
 
+Style/Semicolon:
+  Enabled: false
+
 Style/SpecialGlobalVars:
   EnforcedStyle: use_perl_names
 

data/CHANGELOG.md

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

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,27 +1,29 @@
 # Neovim Ruby
 
-[![Travis](https://travis-ci.org/neovim/neovim-ruby.svg?branch=master)](https://travis-ci.org/neovim/neovim-ruby)
-[![Build status](https://ci.appveyor.com/api/projects/status/y44k25tcdvvuq0ee?svg=true)](https://ci.appveyor.com/project/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)
-[![Inline docs](http://inch-ci.org/github/neovim/neovim-ruby.svg?branch=master)](http://inch-ci.org/github/neovim/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
 
@@ -38,7 +40,7 @@ require "neovim"
 client = Neovim.attach_unix("/tmp/nvim.sock")
 ```
 
-Refer to the [`Neovim` docs](http://www.rubydoc.info/github/neovim/neovim-ruby/master/Neovim) for other ways to connect to `nvim`, and the [`Neovim::Client` docs](http://www.rubydoc.info/github/neovim/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/master/Neovim) for other ways to connect to `nvim`, and the [`Neovim::Client` docs](https://www.rubydoc.info/github/neovim/neovim-ruby/master/Neovim/Client) for a summary of the client interface.
 
 ### Plugins
 
@@ -70,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/neovim/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/master/Neovim/Plugin/DSL) for a more complete overview of the `Neovim.plugin` DSL.
 
 ### Vim Plugin Support
 
@@ -78,16 +80,16 @@ The Neovim gem also acts as a compatibility layer for Ruby plugins written for `
 
 ## Links
 
-* Source: <http://github.com/neovim/neovim-ruby>
-* Bugs:   <http://github.com/neovim/neovim-ruby/issues>
-* CI: <http://travis-ci.org/neovim/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/neovim/neovim-ruby/master/frames>
+  * Latest Gem: <https://rubydoc.info/gems/neovim>
+  * Master: <https://rubydoc.info/github/neovim/neovim-ruby/master/frames>
 
 ## Contributing
 
-1. Fork it (http://github.com/neovim/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

@@ -2,7 +2,9 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"
 
-RuboCop::RakeTask.new(:style)
+Bundler.setup
+
+RuboCop::RakeTask.new(:linter)
 
 namespace :spec do
   desc "Run functional specs"
@@ -10,15 +12,19 @@ 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",
+      # TODO: remove once rubyeval is merged in nvim
+      "--exclude", "rubyeval",
+      "spec/acceptance"
+    )
   end
 
   namespace :acceptance do
     desc "Install acceptance spec dependencies"
     task :deps do
-      Bundler.with_clean_env do
-        sh "bundle exec vim-flavor update --vimfiles-path=spec/acceptance/runtime"
-      end
+      sh "vim-flavor update --vimfiles-path=spec/acceptance/runtime"
     end
   end
 end
@@ -26,30 +32,28 @@ end
 namespace :docs do
   desc "Generate Neovim remote API docs"
   task :generate do
-    run_script(:generate_docs)
-  end
-
-  desc "Validate generated documentation is up-to-date"
-  task :validate do
-    run_script(:validate_docs)
+    run_script("generate_docs.rb")
   end
 end
 
-namespace :scripts do
-  desc "Validate script syntax"
-  task :validate do
-    sh "ruby -c #{File.expand_path("script/*.rb", __dir__)}"
+namespace :ci do
+  task :download_nvim do
+    run_script("ci/download_nvim.sh")
   end
 end
 
-task default: [
-  :style,
-  :"docs:validate",
-  :"scripts:validate",
-  :"spec:functional",
-  :"spec:acceptance"
-]
+desc "Run specs"
+task spec: [:"spec:functional", :"spec:acceptance"]
 
-def run_script(script_name, *args)
-  ruby File.expand_path("script/#{script_name}.rb", __dir__), *args
+task default: [:linter, :spec]
+
+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

@@ -1,18 +1,5 @@
 #!/usr/bin/env ruby
 
-require "neovim/host"
+require "neovim/host/cli"
 
-ARGV.each do |arg|
-  break if arg == "--"
-
-  if ["--version", "-V"].include?(arg)
-    puts Neovim::VERSION
-    exit(0)
-  end
-end
-
-if STDIN.tty?
-  abort("Can't run neovim-ruby-host interactively.")
-else
-  Neovim::Host.run(ARGV)
-end
+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.3.7
+  # The methods documented here were generated using NVIM v0.4.4
   class Buffer < RemoteObject
     attr_reader :lines
 
@@ -183,6 +183,20 @@ module Neovim
   @param [String] mode
   @return [Array<Hash>]
 
+@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

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.3.7
+  # The methods documented here were generated using NVIM v0.4.4
   #
   # @see Buffer
   # @see Window
@@ -140,6 +140,18 @@ module Neovim
   @param [Object] value
   @return [void]
 
+@method ui_try_resize_grid(grid, width, height)
+  See +:h nvim_ui_try_resize_grid()+
+  @param [Integer] grid
+  @param [Integer] width
+  @param [Integer] height
+  @return [void]
+
+@method ui_pum_set_height(height)
+  See +:h nvim_ui_pum_set_height()+
+  @param [Integer] height
+  @return [void]
+
 @method command(command)
   See +:h nvim_command()+
   @param [String] command
@@ -169,6 +181,16 @@ module Neovim
   @param [String] keys
   @return [Integer]
 
+@method input_mouse(button, action, modifier, grid, row, col)
+  See +:h nvim_input_mouse()+
+  @param [String] button
+  @param [String] action
+  @param [String] modifier
+  @param [Integer] grid
+  @param [Integer] row
+  @param [Integer] col
+  @return [void]
+
 @method replace_termcodes(str, from_part, do_lt, special)
   See +:h nvim_replace_termcodes()+
   @param [String] str
@@ -254,6 +276,12 @@ module Neovim
   @param [String] name
   @return [Object]
 
+@method set_vvar(name, value)
+  See +:h nvim_set_vvar()+
+  @param [String] name
+  @param [Object] value
+  @return [void]
+
 @method get_option(name)
   See +:h nvim_get_option()+
   @param [String] name
@@ -300,6 +328,19 @@ module Neovim
   @param [Window] window
   @return [void]
 
+@method create_buf(listed, scratch)
+  See +:h nvim_create_buf()+
+  @param [Boolean] listed
+  @param [Boolean] scratch
+  @return [Buffer]
+
+@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>]
@@ -322,6 +363,21 @@ module Neovim
   See +:h nvim_get_namespaces()+
   @return [Hash]
 
+@method paste(data, crlf, phase)
+  See +:h nvim_paste()+
+  @param [String] data
+  @param [Boolean] crlf
+  @param [Integer] phase
+  @return [Boolean]
+
+@method put(lines, type, after, follow)
+  See +:h nvim_put()+
+  @param [Array<String>] lines
+  @param [String] type
+  @param [Boolean] after
+  @param [Boolean] follow
+  @return [void]
+
 @method subscribe(event)
   See +:h nvim_subscribe()+
   @param [String] event
@@ -341,6 +397,16 @@ module Neovim
   See +:h nvim_get_color_map()+
   @return [Hash]
 
+@method get_context(opts)
+  See +:h nvim_get_context()+
+  @param [Hash] opts
+  @return [Hash]
+
+@method load_context(dict)
+  See +:h nvim_load_context()+
+  @param [Hash] dict
+  @return [Object]
+
 @method get_mode
   See +:h nvim_get_mode()+
   @return [Hash]
@@ -350,6 +416,20 @@ module Neovim
   @param [String] mode
   @return [Array<Hash>]
 
+@method set_keymap(mode, lhs, rhs, opts)
+  See +:h nvim_set_keymap()+
+  @param [String] mode
+  @param [String] lhs
+  @param [String] rhs
+  @param [Hash] opts
+  @return [void]
+
+@method del_keymap(mode, lhs)
+  See +:h nvim_del_keymap()+
+  @param [String] mode
+  @param [String] lhs
+  @return [void]
+
 @method get_commands(opts)
   See +:h nvim_get_commands()+
   @param [Hash] opts
@@ -403,6 +483,14 @@ module Neovim
   @param [Integer] pid
   @return [Object]
 
+@method select_popupmenu_item(item, insert, finish, opts)
+  See +:h nvim_select_popupmenu_item()+
+  @param [Integer] item
+  @param [Boolean] insert
+  @param [Boolean] finish
+  @param [Hash] opts
+  @return [void]
+
 =end
   end
 end