nvim 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7da86bd1593e902be08b9336b57ec728ff26c9bf27e8988db31abc6aca9e0c6
-  data.tar.gz: def46654276768006e2091feb5f7d40ebf8fd2f2eaad10e4e5104d748d992b56
+  metadata.gz: dbd0024450444336d8516c543f5bf6b9ac1f0a6a08a8e342f03a413e20794bcd
+  data.tar.gz: 5ecd7b84dccc752f82aaf303ad146e5b7462478bc8a58eb25f70fb9393b30e6f
 SHA512:
-  metadata.gz: 806dff346c4a8e988fad37e14ab91391dafffccd4ba426002a9c5a3ea26ce6cebd43ad505b6de512bb0099b91dcabca5fe31f5d7ffdc41aa93c26fefebb0c663
-  data.tar.gz: eec34f3b3c5be8327ee62fbd7ae9838151d7ed0361b34c5fbbf4632dc692aa2433129119f7c1a0cc146491c433d5d1791c5be9b74172829d6108e49703f389c3
+  metadata.gz: 5dfce6dc61d6c2910f8e1a273324682524246f92c9b7f9d62c8a6c9b915852b7d359b02435039105d6bcf811719a3f9e6a8579f8851f87e0c49e7f8b0182d389
+  data.tar.gz: 1b58e82f140457815c0ff571aff1a209f591ff3f301269140685f0a5098d3efc315c318797fb22ea10d77c2ab34536f0c220a4ee6cc62c03a5da46a1150992c7

data/INFO.yaml

@@ -3,7 +3,7 @@
 #
 
 nvim:
-  version: 1.5.0
+  version: 1.6.0
   license: BSD-2-Clause+
   authors:
     - Bertram Scharpf

data/LICENSE

@@ -1,6 +1,6 @@
 # BSD-2-clause license, extended by language use conditions
 
-Copyright (C) 2024, Bertram Scharpf <software@bertram-scharpf.de>.
+Copyright (C) 2024-2025, Bertram Scharpf <software@bertram-scharpf.de>.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -207,6 +207,52 @@ Yet, you should avoid to use `fork` and `exec`, except when
 you're absolutely sure what you're doing.
 
 
+#### Global variables
+
+The global variable `$vim` will be set to the client.
+
+```
+~
+~
+:ruby $vim.command "split"
+```
+
+Further, the variables `$range` and `$lines` will be set.
+
+```
+ 1 foo
+ 2 bar
+ 3 baz
+~
+:%ruby puts $range.inspect, $lines.inspect
+```
+
+The legacy variables `$curbuf` and `$curwin` are supported.
+
+```
+~
+~
+:ruby puts $curbuf.get_name, $curwin.get_height
+```
+
+
+### Requiring Ruby files
+
+In addition to the `:rubyfile` command as documented, that command can also be
+used to just require a Ruby file. Set the name into angle brackets, and the
+file will be searched in `$:`. Sorry, file name completion will not work.
+
+```
+~
+~
+:rubyfile <yaml>
+```
+
+In this case, the global variables `$range` and `$lines` will not be set. Yet,
+`$vim` still will be available. See the
+[Nxxd](https://github.com/BertramScharpf/ruby-nxxd) gem for a nice example.
+
+
 ### List all API functions
 
 To show a list of the API functions call something like this:
@@ -377,7 +423,7 @@ Make a hex dump.
 ruby <<EOT
   require "neovim/foreign/xxd"
   bn = $curbuf.get_name
-  $vim.command :new
+  $vim.command :enew!
   File.open bn do |b| Xxd::Dump.new.run b do |l| $vim.put [l], "l", false, true end end
 EOT
 ```
@@ -385,6 +431,6 @@ EOT
 
 ## Copyright
 
-  * (C) 2024 Bertram Scharpf <software@bertram-scharpf.de>
+  * (C) 2024,2025 Bertram Scharpf <software@bertram-scharpf.de>
   * License: [BSD-2-Clause+](./LICENSE)
 

data/examples/passwords

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+#
+#  examples/passwords  --  Manage a file containing your passwords
+#
+
+# (C) 2025 Bertram Scharpf <software@bertram-scharpf.de>
+
+require "neovim/host"
+
+
+class Passwords
+
+  PW_FILE = File.expand_path "~/.config/mypasswords.asc"
+  RECIPIENT = "jdoe@example.com"
+
+  def initialize debug: false
+    @debug = debug
+  end
+
+  def run
+    contents = get_contents.split $/
+    Neovim::Remote.run_sub do |pw_dsl|
+      pw_dsl.setup do |client|
+        client.set_option shadafile: "NONE"
+        client.set_option filetype: "dosini"
+        client.put contents, "l", true, false
+        client.command "1"
+        client.get_current_line.empty? and client.del_current_line
+        {
+          "Save" => "rb_save",
+          "Totp" => "rb_totp",
+        }.each { |cmd,fn|
+          client.command "command -buffer -nargs=0 %s call rpcrequest(%d,'%s')" % [ cmd, client.channel_id, fn]
+        }
+      end
+      pw_dsl.register_handler "rb_save" do |client|
+        File.rename PW_FILE, "#{PW_FILE}.bak" rescue nil
+        IO.popen %W(gpg -a -r #{RECIPIENT} --encrypt -o #{PW_FILE}), "w" do |gpg|
+          gpg.puts client.get_current_buf[1..]
+        end
+        File.chmod 0600, PW_FILE
+      end
+      pw_dsl.register_handler "rb_totp" do |client|
+        require "potp"
+        require "neovim/tools/copy"
+        p = client.call_function "expand", [ "<cword>"]
+        key = (POTP::TOTP.new p).now if p.notempty? and p.length % 4 == 0
+        client.echo [ [ key]], true, {}
+        xsel key
+      rescue
+        client.err_writeln "No OTP under cursor?"
+      rescue ScriptError
+        client.err_writeln $!.message
+      end
+    end
+  end
+
+  def get_contents
+    r = IO.popen %W(gpg -d #{PW_FILE}), "r" do |gpg| gpg.read end
+    r.notempty? or <<~EOT
+      # Move the cursor to the OTP keyword and give the command `:Totp`.
+      # The TOTP key will be displayed and further copied to the clipboard.
+
+      [account "dummy"]
+      name     = John Doe
+      password = very$ecret
+      optauth  = GYS5L3N3E4AAYNMN562LW76TMWHQBJ4A
+
+      # As soon as you have set the `RECIPIENT` constant in the executable,
+      # you may save this file calling the command `:Save`.
+    EOT
+  end
+
+  new.run
+
+end
+

data/lib/neovim/client.rb

@@ -16,9 +16,6 @@ module Neovim
       attr_accessor :strict
     end
 
-    class UnknownApiFunction       < RuntimeError ; end
-    class UnknownApiObjectFunction < RuntimeError ; end
-
 
     attr_reader :channel_id
 
@@ -112,6 +109,7 @@ module Neovim
 
     def command arg ; call_api :command, arg ; end
 
+    # Be aware that #eval was a private instance method from module Kernel.
     def evaluate expr ; call_api :eval, expr ; end
 
   end

data/lib/neovim/host.rb

@@ -47,6 +47,7 @@ module Neovim
       def run plugins
         $stdin.tty? and raise "This program expects to be called by Neovim. It can't run interactively."
         start plugins do |h|
+          log :info, "Starting event loop."
           h.run
           nil
         rescue Remote::Disconnected
@@ -54,8 +55,13 @@ module Neovim
           nil
         rescue SignalException
           n = $!.signm.notempty? || $!.class.to_s
-          log :fatal, "Signal was caught: #{n}"
-          (n =~ /\A(?:SIG)?TERM\z/) ? 0 : 1
+          if n =~ /\A(?:SIG)?TERM\z/ then
+            log :info, "Exiting after terminate signal."
+            nil
+          else
+            log :fatal, "Signal was caught: #{n}"
+            1
+          end
         rescue Exception
           log_exception :fatal
           2

data/lib/neovim/info.rb

@@ -1,10 +1,10 @@
 require "neovim/meta.rb"
 Neovim::INFO = Neovim::Meta.new "nvim",
-  version: "1.5.0",
+  version: "1.6.0",
   license: "BSD-2-Clause+",
   authors: ["Bertram Scharpf"],
   email: "software@bertram-scharpf.de",
   summary: "Yet another Ruby client for Neovim",
   description: "A simple Ruby client for Neovim.\nClean code, minimal dependecies, no frills, no wokeness.",
   homepage: "https://github.com/BertramScharpf/ruby-nvim",
-  commit: "bc7977a"
+  commit: "b2ddce4"

data/lib/neovim/logging.rb

@@ -234,8 +234,8 @@ module Neovim
         **kwargs
     end
 
-    def log_exception level
-      Logging.put level, "Exception: #$!",
+    def log_exception level = nil
+      Logging.put level||:error, "Exception: #$!",
         sender: self, caller: (caller 1, 1).first,
         exception: $!.class
       $@.each { |b|

data/lib/neovim/remote.rb

@@ -122,13 +122,13 @@ module Neovim
 
       def start plugins, *args, **kwargs
         open_logfile do
-          log :info, "Starting", args: $*
+          log :debug1, "Starting", args: $*
           open_conn *args, **kwargs do |conn|
             i = new plugins, conn
             yield i
           end
         ensure
-          log :info, "Leaving"
+          log :debug1, "Leaving"
         end
       end
 
@@ -154,7 +154,7 @@ module Neovim
         l.map! { |p| p.type }
         l.uniq!
         name = l.join "-"
-        log :info, "Client Name", name: name
+        log :debug1, "Client Name", name: name
         "ruby-#{name}-host"
       else
         "ruby-client"
@@ -210,7 +210,7 @@ module Neovim
             if @conn.client or not h.needs_client? then
               p.call
             else
-              log :info, "Deferred handler for", name: message.method_name
+              log :debug1, "Deferred handler for", name: message.method_name
               @deferred ||= []
               @deferred.push p
             end
@@ -266,7 +266,7 @@ module Neovim
       @plugins.each_value do |plugin|
         h = plugin.get_handler name
         if h then
-          log :info, "Found handler", name: name
+          log :debug1, "Found handler", name: name
           return h
         end
       end

data/lib/neovim/remote_object.rb

@@ -38,6 +38,9 @@ module Neovim
   end
 
 
+  class UnknownApiFunction       < RuntimeError ; end
+  class UnknownApiObjectFunction < RuntimeError ; end
+
 
   class RemoteObject
 

data/lib/neovim/ruby_provider.rb

@@ -203,11 +203,17 @@ module Neovim
 
     # This is called by the +:rubyfile+ command.
     dsl.rpc :ruby_execute_file do |client,path,fst,lst|
-      set_globals client, fst..lst do ||
-        r = File.read path
-        script_binding.eval r, "ruby_file #{path}"
+      if path =~ /<(.*)>\z/ then
+        set_global_client client do
+          require $1
+        end
+      else
+        set_globals client, fst..lst do ||
+          r = File.read path
+          script_binding.eval r, "ruby_file #{path}"
+        end
+        nil
       end
-      nil
     end
 
     # This is called by the +:rubydo+ command.

data/lib/neovim.rb

@@ -19,7 +19,7 @@ module Neovim
   class <<self
 
     def start_remote &block
-      Job.run remote: (DslRemote.open &block), &block
+      Job.run remote: (DslRemote.open &block)
     end
 
   end

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nvim
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Bertram Scharpf
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-31 00:00:00.000000000 Z
+date: 2025-01-26 00:00:00.000000000 Z
 dependencies: []
-description:
 email: software@bertram-scharpf.de
 executables:
 - neovim-ruby-host
@@ -28,6 +26,7 @@ extra_rdoc_files:
 - examples/demo_remote_inside_block.rb
 - examples/demo_sub
 - examples/dump_api
+- examples/passwords
 files:
 - INFO.yaml
 - LICENSE
@@ -41,6 +40,7 @@ files:
 - examples/demo_remote_inside_block.rb
 - examples/demo_sub
 - examples/dump_api
+- examples/passwords
 - lib/neovim.rb
 - lib/neovim/client.rb
 - lib/neovim/connection.rb
@@ -66,7 +66,6 @@ homepage: https://github.com/BertramScharpf/ruby-nvim
 licenses:
 - BSD-2-Clause+
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Yet another Ruby client for Neovim
 test_files: []