Merge pull request #69 from neovim/ruby_eval

Add `rubyeval` support

Author: alexgenco

.rubocop.yml

@@ -65,8 +65,7 @@ Metrics/MethodLength:
   Max: 50
 
 Metrics/ModuleLength:
-  Exclude:
-    - spec/**/*
+  Enabled: false
 
 Metrics/ParameterLists:
   Max: 6
@@ -93,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
 

Rakefile

@@ -12,7 +12,13 @@ namespace :spec do
 
   desc "Run acceptance specs"
   task acceptance: "acceptance:deps" do
-    run_script("run_acceptance.rb", "--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

lib/neovim/ruby_provider.rb

@@ -1,4 +1,5 @@
 require "neovim/ruby_provider/vim"
+require "neovim/ruby_provider/object_ext"
 require "neovim/ruby_provider/buffer_ext"
 require "neovim/ruby_provider/window_ext"
 require "stringio"
@@ -18,6 +19,7 @@ def self.__define_plugin!
 
         __define_setup(plug)
         __define_ruby_execute(plug)
+        __define_ruby_eval(plug)
         __define_ruby_execute_file(plug)
         __define_ruby_do_range(plug)
         __define_ruby_chdir(plug)
@@ -44,19 +46,34 @@ def self.__define_setup(plug)
     def self.__define_ruby_execute(plug)
       plug.__send__(:rpc, :ruby_execute) do |nvim, ruby|
         __wrap_client(nvim) do
-          eval(ruby, TOPLEVEL_BINDING, "eval")
+          eval(ruby, TOPLEVEL_BINDING, "ruby_execute")
         end
+        nil
       end
     end
     private_class_method :__define_ruby_execute
 
+    # Evaluate the provided Ruby code, exposing the +Vim+ constant for
+    # interactions with the editor and returning the value.
+    #
+    # This is used by the +:rubyeval+ command.
+    def self.__define_ruby_eval(plug)
+      plug.__send__(:rpc, :ruby_eval) do |nvim, ruby|
+        __wrap_client(nvim) do
+          eval(ruby, TOPLEVEL_BINDING, "ruby_eval")
+        end
+      end
+    end
+    private_class_method :__define_ruby_eval
+
     # Evaluate the provided Ruby file, exposing the +Vim+ constant for
     # interactions with the editor.
     #
     # This is used by the +:rubyfile+ command.
     def self.__define_ruby_execute_file(plug)
       plug.__send__(:rpc, :ruby_execute_file) do |nvim, path|
         __wrap_client(nvim) { load(path) }
+        nil
       end
     end
     private_class_method :__define_ruby_execute_file
@@ -78,11 +95,12 @@ def self.__define_ruby_do_range(__plug)
           __update_lines_in_chunks(__buffer, __start, __stop, 1_000) do |__lines|
             __lines.map do |__line|
               $_ = __line
-              eval(__ruby, binding, "eval")
+              eval(__ruby, binding, "ruby_do_range")
               $_
             end
           end
         end
+        nil
       end
     end
     private_class_method :__define_ruby_do_range
@@ -103,7 +121,6 @@ def self.__wrap_client(client)
           yield
         end
       end
-      nil
     end
     private_class_method :__wrap_client
 
@@ -122,10 +139,10 @@ def self.__with_std_streams(client)
       $stdout, $stderr = StringIO.new, StringIO.new
 
       begin
-        yield
-
-        client.out_write($stdout.string + $/) if $stdout.size > 0
-        client.err_writeln($stderr.string) if $stderr.size > 0
+        yield.tap do
+          client.out_write($stdout.string + $/) if $stdout.size > 0
+          client.err_writeln($stderr.string) if $stderr.size > 0
+        end
       ensure
         $stdout = old_stdout
         $stderr = old_stderr

lib/neovim/ruby_provider/object_ext.rb

@@ -0,0 +1,5 @@
+class Object
+  def to_msgpack(packer)
+    packer.pack(to_s)
+  end
+end

spec/acceptance/rubyeval_spec.vim

@@ -0,0 +1,22 @@
+let s:suite = themis#suite(":rubyeval")
+let s:expect = themis#helper("expect")
+
+function! s:suite.evaluates_ruby_objects() abort
+  call s:expect(rubyeval("123")).to_equal(123)
+  call s:expect(rubyeval("1.2")).to_equal(1.2)
+  call s:expect(rubyeval("'test'")).to_equal("test")
+  call s:expect(rubyeval("nil")).to_equal(v:null)
+  call s:expect(rubyeval("true")).to_equal(v:true)
+  call s:expect(rubyeval("false")).to_equal(v:false)
+  call s:expect(rubyeval("{x: 1}")).to_equal({"x": 1})
+  call s:expect(rubyeval(":test")).to_equal("test")
+  call s:expect(rubyeval(":test.class")).to_equal("Symbol")
+endfunction
+
+function! s:suite.propagates_exceptions() abort
+  try
+    rubyeval("raise 'BOOM'")
+    throw "Nothing raised"
+  catch /BOOM/
+  endtry
+endfunction

spec/neovim/ruby_provider/object_ext_spec.rb

@@ -0,0 +1,10 @@
+require "helper"
+require "neovim/ruby_provider/object_ext"
+
+RSpec.describe Object do
+  describe "#to_msgpack" do
+    it "converts classes to strings" do
+      expect(MessagePack.pack(String)).to eq(MessagePack.pack("String"))
+    end
+  end
+end