xchan.rb 0.17.2 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ce716f918994e2481e8fbd333dbdb7e0b258341a09e32d464a54a2331edbd09
-  data.tar.gz: f17d86bf4004ca1ebef87950ff9d20c7aaad29940e8c031ff84d817ade3adeb9
+  metadata.gz: a87a4e61f65ec4df37ecc2b09efd3d9abd4d39e57ac936db27e43ace4e99818d
+  data.tar.gz: 1ac4be7c20abcdee66a441088e1a7bf67b92b96f63b16b3401227bb978afa6de
 SHA512:
-  metadata.gz: c77e364ea0f6365d4fddae810cd14e999cf584dd301e5a651a5565d78fcce157909f0b96a155f67f8f22bb50f1c7d5c2535653e4871f2e5dab862c1e38f207f3
-  data.tar.gz: a4f2d57cf1843407d7056c4528d7e41372ed84378e33f6ca2777b6b2dde93b80fe5e57d33d2b01337a089d808b11e3e6d92c91b4f57f86aeefc4a3e4782c6afa
+  metadata.gz: fc46a04ae48123fbf24371bd3438013cfcb070e353993811d10b4ea9d8b63628b577bed465d441fab1d964a0dab4ec9a2040e293c59272faa6c2081819788383
+  data.tar.gz: 267dd70488de1b49c345c49a87c5f28a7bdf0713c20fdeeba2efbef13e2d114960dc021e3b1ec77df90ad3c1189772e3075dff3ce0f2ebfac27b727acc4a56a8

data/README.md

@@ -2,8 +2,8 @@
 
 xchan.rb is an easy to use library for InterProcess
 Communication (IPC). The library provides a channel
-that can transfer Ruby objects between Ruby processes
-with a parent <-> child relationship.
+that can help facilitate communication between Ruby
+processes who have a parent &lt;=&gt; child relationship.
 
 ## Examples
 
@@ -11,30 +11,26 @@ with a parent <-> child relationship.
 
 #### Options
 
-The first argument given to xchan is the serializer
-that it should use. A channel that will communicate
-in pure strings (ie with no serialization) is
-available as `xchan(:pure)`.
-
-Otherwise, when a channel is written to or read from,
-a Ruby object is serialized (on write) or deserialized
-(on read). The serializers available to choose from
-are `xchan(:marshal)`, `xchan(:json)`, and `xchan(:yaml)`.
-The example uses
-[`Marshal`](https://www.rubydoc.info/stdlib/core/Marshal):
+The first argument provided to xchan is the serializer
+that should be used. A channel that will communicate
+purely in strings (in other words: without serialization)
+is available as `xchan(:pure)` - otherwise a wide range of
+serializers are available by default: `xchan(:marshal)`,
+`xchan(:json)`, and `xchan(:yaml)`.
 
 ```ruby
+#!/usr/bin/env ruby
 require "xchan"
 
 ##
-# This channel uses Marshal to serialize objects
+# Marshal as the serializer
 ch = xchan(:marshal)
 Process.wait fork { ch.send(5) }
-print "There are ", ch.recv + 7, " disciples and the same number of tribes", "\n"
+print "#{ch.recv} + 7 = 12", "\n"
 ch.close
 
 ##
-# There are 12 disciples and the same number of tribes
+# 5 + 7 = 12
 ```
 
 ### Read operations
@@ -49,6 +45,7 @@ blocks. The example performs a read that blocks until
 the parent process writes to the channel:
 
 ```ruby
+#!/usr/bin/env ruby
 require "xchan"
 
 ch = xchan(:marshal)
@@ -76,6 +73,7 @@ the method raises `Chan::WaitReadable` when a read from
 blocks:
 
 ```ruby
+#!/usr/bin/env ruby
 require "xchan"
 
 def read(ch)
@@ -108,9 +106,10 @@ process, or when a write to
 blocks. The example fills the send buffer:
 
 ```ruby
+#!/usr/bin/env ruby
 require "xchan"
 
-ch = xchan(:marshal, sock_type: Socket::SOCK_STREAM)
+ch = xchan(:marshal, sock: Socket::SOCK_STREAM)
 sndbuf = ch.w.getsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF)
 while ch.bytes_sent <= sndbuf.int
   ch.send(1)
@@ -128,6 +127,7 @@ a lock held by another process, and the method raises
 blocks. The example frees space on the send buffer:
 
 ```ruby
+#!/usr/bin/env ruby
 require "xchan"
 
 def send_nonblock(ch, buf)
@@ -141,7 +141,7 @@ rescue Chan::WaitLockable
   retry
 end
 
-ch = xchan(:marshal, sock_type: Socket::SOCK_STREAM)
+ch = xchan(:marshal, sock: Socket::SOCK_STREAM)
 sndbuf = ch.w.getsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF)
 while ch.bytes_sent <= sndbuf.int
   send_nonblock(ch, 1)
@@ -151,6 +151,49 @@ end
 # Blocked - free send buffer
 ```
 
+### Lock
+
+#### File
+
+The default lock for a channel is a file lock. The locking mechanism is
+implemented with the
+[lockf](https://man.freebsd.org/cgi/man.cgi?query=lockf&apropos=0&sektion=3&manpath=FreeBSD+14.2-RELEASE+and+Ports&arch=default&format=html)
+function from the C standard library. Nothing special has to be done to
+use it, and it allows a channel to be safely accessed across multiple
+processes:
+
+```ruby
+#!/usr/bin/env ruby
+require "xchan"
+
+ch = xchan(:marshal, lock: :file)
+5.times.map do
+  fork do
+    ch.send(5)
+  end
+end.each { Process.wait(_1) }
+```
+
+#### Null
+
+The null lock is the same as using no lock at all. The null lock is
+implemented as a collection of no-op operations. The null lock is
+implemented in the
+[Chan::NullLock](https://0x1eef.github,io/x/xchan.rb/Chan/NullLock.html)
+class, and in certain situations, it can be useful and preferable
+to using a file lock:
+
+```ruby
+#!/usr/bin/env ruby
+require "xchan"
+
+ch = xchan(:marshal, lock: :null)
+fork do
+  ch.send(5)
+end
+Process.wait
+```
+
 ### Socket
 
 #### Options
@@ -163,6 +206,7 @@ returns the socket used for read operations, and
 returns the socket used for write operations:
 
 ```ruby
+#!/usr/bin/env ruby
 require "xchan"
 ch = xchan(:marshal)
 
@@ -184,7 +228,7 @@ print "The maximum size of a single message is: ", sndbuf.int, " bytes.\n"
 ## Documentation
 
 A complete API reference is available at
-[0x1eef.github.io/x/xchan.rb](https://0x1eef.github.io/x/xchan.rb/).
+[0x1eef.github.io/x/xchan.rb](https://0x1eef.github.io/x/xchan.rb/)
 
 ## Install
 
@@ -194,11 +238,11 @@ xchan.rb can be installed via rubygems.org:
 
 ## Sources
 
-* [Source code (GitHub)](https://github.com/0x1eef/xchan.rb#readme)
-* [Source code (GitLab)](https://gitlab.com/0x1eef/xchan.rb#about)
+* [github.com/@0x1eef](https://github.com/0x1eef/xchan.rb#readme)
+* [gitlab.com/@0x1eef](https://gitlab.com/0x1eef/xchan.rb#about)
 
-## <a id="license"> License </a>
+## License
 
-[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
+[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
 <br>
-See [LICENSE](./LICENSE).
+See [share/xchan.rb/LICENSE](./share/xchan.rb/LICENSE)

data/lib/xchan/bytes.rb

@@ -13,7 +13,6 @@ class Chan::Bytes
   ##
   # @param [String] tmpdir
   #  Directory where temporary files are stored
-  #
   # @return [Chan::Bytes]
   def initialize(tmpdir)
     @io = Chan.temporary_file(%w[bytes .json], tmpdir:)
@@ -23,10 +22,8 @@ class Chan::Bytes
 
   ##
   # Adds a count to the start of the collection
-  #
   # @param [Integer] len
   #  The bytesize of an object
-  #
   # @return [void]
   def unshift(len)
     return 0 if len.nil? || len.zero?
@@ -38,10 +35,8 @@ class Chan::Bytes
 
   ##
   # Adds a count to the end of the collection
-  #
   # @param [Integer] len
   #  The bytesize of an object
-  #
   # @return [void]
   def push(len)
     return 0 if len.nil? || len.zero?
@@ -53,7 +48,6 @@ class Chan::Bytes
 
   ##
   # Removes a count from the start of the collection
-  #
   # @return [Integer]
   #  Returns the removed byte count
   def shift
@@ -73,7 +67,6 @@ class Chan::Bytes
 
   ##
   # Close the underlying IO
-  #
   # @return [void]
   def close
     @io.close
@@ -95,6 +88,6 @@ class Chan::Bytes
   end
 
   def deserialize(bytes)
-    JSON.load(bytes)
+    JSON.parse(bytes)
   end
 end

data/lib/xchan/counter.rb

@@ -10,7 +10,6 @@ class Chan::Counter
   ##
   # @param [String] tmpdir
   #  Directory where temporary files are stored
-  #
   # @return [Chan::Counter]
   def initialize(tmpdir)
     @io = Chan.temporary_file(%w[counter .json], tmpdir:)
@@ -57,6 +56,6 @@ class Chan::Counter
   end
 
   def deserialize(bytes)
-    JSON.load(bytes)
+    JSON.parse(bytes)
   end
 end

data/lib/xchan/null_lock.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+##
+# {Chan::NullLock Chan::NullLock} is a no-op lock that can be used
+# instead of the standard file lock when a lock is not needed
+#
+# @example
+#   ch = xchan(:marshal, lock: Chan::NullLock)
+#   ch.send([1,2,3])
+#   # ditto
+#   ch = xchan(:marshal, lock: :null)
+#   ch.send([1,2,3])
+class Chan::NullLock
+  ##
+  # @return [void]
+  #  This method is a no-op
+  def self.lock
+  end
+
+  ##
+  # @return [void]
+  #  This method is a no-op
+  def self.lock_nonblock
+  end
+
+  ##
+  # @return [void]
+  #  This method is a no-op
+  def self.release
+  end
+
+  ##
+  # @return [void]
+  #  This method is a no-op
+  def self.close
+  end
+
+  ##
+  # @return [void]
+  #  This method always returns false
+  def self.locked?
+    false
+  end
+end

data/lib/xchan/tempfile.rb

@@ -1,5 +1,7 @@
-require 'delegate'
-require 'tmpdir'
+# frozen_string_literal: true
+
+require "delegate"
+require "tmpdir"
 
 ##
 # @private
@@ -63,12 +65,12 @@ class Chan::Tempfile < DelegateClass(File)
   #
   # Related: Tempfile.create.
   #
-  def initialize(basename="", tmpdir=nil, mode: 0, perm: 0600, **options)
+  def initialize(basename = "", tmpdir = nil, mode: 0, perm: 0o600, **kwargs)
     warn "Tempfile.new doesn't call the given block.", uplevel: 1 if block_given?
 
     @unlinked = false
-    @mode = mode|File::RDWR|File::CREAT|File::EXCL
-    ::Dir::Tmpname.create(basename, tmpdir, **options) do |tmpname, n, opts|
+    @mode = mode | File::RDWR | File::CREAT | File::EXCL
+    ::Dir::Tmpname.create(basename, tmpdir, **kwargs) do |tmpname, n, opts|
       @tmpfile = File.open(tmpname, @mode, perm, **opts)
       @perm = perm
       @opts = opts.freeze
@@ -81,7 +83,7 @@ class Chan::Tempfile < DelegateClass(File)
   # Opens or reopens the file with mode "r+".
   def open
     _close
-    mode = @mode & ~(File::CREAT|File::EXCL)
+    mode = @mode & ~(File::CREAT | File::EXCL)
     @tmpfile = File.open(@tmpfile.path, mode, **@opts)
     __setobj__(@tmpfile)
   end
@@ -97,7 +99,7 @@ class Chan::Tempfile < DelegateClass(File)
   #
   # If you don't explicitly unlink the temporary file, the removal
   # will be delayed until the object is finalized.
-  def close(unlink_now=false)
+  def close(unlink_now = false)
     _close
     unlink if unlink_now
   end
@@ -153,7 +155,7 @@ class Chan::Tempfile < DelegateClass(File)
     ObjectSpace.undefine_finalizer(self)
     @unlinked = true
   end
-  alias delete unlink
+  alias_method :delete, :unlink
 
   # Returns the full path name of the temporary file.
   # This will be nil if #unlink has been called.
@@ -170,7 +172,7 @@ class Chan::Tempfile < DelegateClass(File)
       File.size(@tmpfile.path)
     end
   end
-  alias length size
+  alias_method :length, :size
 
   # :stopdoc:
   def inspect
@@ -190,7 +192,7 @@ class Chan::Tempfile < DelegateClass(File)
     def call(*args)
       return if @pid != Process.pid
 
-      $stderr.puts "removing #{@tmpfile.path}..." if $DEBUG
+      warn "removing #{@tmpfile.path}..." if $DEBUG
 
       @tmpfile.close
       begin
@@ -198,7 +200,7 @@ class Chan::Tempfile < DelegateClass(File)
       rescue Errno::ENOENT
       end
 
-      $stderr.puts "done" if $DEBUG
+      warn "done" if $DEBUG
     end
   end
 
@@ -240,8 +242,8 @@ class Chan::Tempfile < DelegateClass(File)
     #   ensure
     #      f.close
     #   end
-    def self.open(*args, **kw)
-      tempfile = new(*args, **kw)
+    def self.open(*, **)
+      tempfile = new(*, **)
 
       if block_given?
         begin
@@ -313,10 +315,10 @@ module Chan
   #
   # Related: Tempfile.new.
   #
-  def Tempfile.create(basename="", tmpdir=nil, mode: 0, perm: 0600, **options)
+  def Tempfile.create(basename = "", tmpdir = nil, mode: 0, perm: 0o600, **kwargs)
     tmpfile = nil
-    Dir::Tmpname.create(basename, tmpdir, **options) do |tmpname, n, opts|
-      mode |= File::RDWR|File::CREAT|File::EXCL
+    Dir::Tmpname.create(basename, tmpdir, **kwargs) do |tmpname, n, opts|
+      mode |= File::RDWR | File::CREAT | File::EXCL
       tmpfile = File.open(tmpname, mode, perm, **opts)
     end
     if block_given?
@@ -325,7 +327,11 @@ module Chan
       ensure
         unless tmpfile.closed?
           if File.identical?(tmpfile, tmpfile.path)
-            unlinked = File.unlink tmpfile.path rescue nil
+            unlinked = begin
+              File.unlink tmpfile.path
+            rescue
+              nil
+            end
           end
           tmpfile.close
         end

data/lib/xchan/unix_socket.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 ##
-# An easy-to-use InterProcess Communication (IPC) library.
+# An easy-to-use InterProcess Communication (IPC) library
 class Chan::UNIXSocket
   require "socket"
   require "lockf"
@@ -29,24 +29,22 @@ class Chan::UNIXSocket
   #   ch.send([1,2,3])
   #   ch.recv.pop # => 3
   #   ch.close
-  #
-  # @param [Symbol, <#dump, #load>] s
+  # @param [Symbol, <#dump, #load>] serializer
   #  The name of a serializer
-  #
-  # @param [Integer] sock_type
+  # @param [Integer] sock
   #  Type of socket (eg `Socket::SOCK_STREAM`)
-  #
   # @param [String] tmpdir
   #  Directory where temporary files can be stored
-  #
+  # @param [Symbol, <Lock::File, Chan::NullLock>] lock
+  #  The name of a lock, or an instance of `Lock::File`, or {Chan::NullLock Chan::NullLock}
   # @return [Chan::UNIXSocket]
   #  Returns an instance of {Chan::UNIXSocket Chan::UNIXSocket}
-  def initialize(s, sock_type: Socket::SOCK_DGRAM, tmpdir: Dir.tmpdir)
-    @s = Chan.shortcuts[s]&.call || s
-    @r, @w = ::UNIXSocket.pair(sock_type)
+  def initialize(serializer, sock: Socket::SOCK_DGRAM, tmpdir: Dir.tmpdir, lock: :file)
+    @s = Chan.serializers[serializer]&.call || serializer
+    @r, @w = ::UNIXSocket.pair(sock)
     @bytes = Chan::Bytes.new(tmpdir)
     @counter = Chan::Counter.new(tmpdir)
-    @lock = LockFile.new Chan.temporary_file(%w[xchan .lock], tmpdir:)
+    @lock = Chan.locks[lock]&.call(tmpdir) || lock
   end
 
   ##
@@ -58,15 +56,13 @@ class Chan::UNIXSocket
 
   ##
   # Closes the channel
-  #
   # @raise [IOError]
   #  When the channel is closed
-  #
   # @return [void]
   def close
     @lock.lock
     raise IOError, "channel is closed" if closed?
-    [@r, @w, @bytes, @lock.file].each(&:close)
+    [@r, @w, @bytes, @lock].each(&:close)
   rescue IOError => ex
     @lock.release
     raise(ex)
@@ -77,13 +73,10 @@ class Chan::UNIXSocket
 
   ##
   # Performs a blocking write
-  #
   # @param [Object] object
   #  An object
-  #
   # @raise [IOError]
   #  When the channel is closed
-  #
   # @return [Object]
   #  Returns the number of bytes written to the channel
   def send(object)
@@ -95,19 +88,14 @@ class Chan::UNIXSocket
 
   ##
   # Performs a non-blocking write
-  #
   # @param [Object] object
   #  An object
-  #
   # @raise [IOError]
   #  When the channel is closed
-  #
   # @raise [Chan::WaitWritable]
   #  When a write to {#w} blocks
-  #
   # @raise [Chan::WaitLockable]
   #  When a write blocks because of a lock held by another process
-  #
   # @return [Integer, nil]
   #  Returns the number of bytes written to the channel
   def send_nonblock(object)
@@ -133,10 +121,8 @@ class Chan::UNIXSocket
 
   ##
   # Performs a blocking read
-  #
   # @raise [IOError]
   #  When the channel is closed
-  #
   # @return [Object]
   #  Returns an object from the channel
   def recv
@@ -151,16 +137,12 @@ class Chan::UNIXSocket
 
   ##
   # Performs a non-blocking read
-  #
   # @raise [IOError]
   #  When the channel is closed
-  #
   # @raise [Chan::WaitReadable]
   #  When a read from {#r} blocks
-  #
   # @raise [Chan::WaitLockable]
   #  When a read blocks because of a lock held by another process
-  #
   # @return [Object]
   #  Returns an object from the channel
   def recv_nonblock
@@ -187,10 +169,9 @@ class Chan::UNIXSocket
 
   ##
   # @example
-  #   ch = xchan
+  #   ch = xchan(:pure)
   #   1.upto(4) { ch.send(_1) }
-  #   ch.to_a.last # => 4
-  #
+  #   ch.to_a.last # => "4"
   # @return [Array<Object>]
   #  Returns the contents of the channel
   def to_a
@@ -241,10 +222,8 @@ class Chan::UNIXSocket
 
   ##
   # Waits for the channel to become readable
-  #
   # @param [Float, Integer, nil] s
   #  The number of seconds to wait. Waits indefinitely with no arguments.
-  #
   # @return [Chan::UNIXSocket, nil]
   #  Returns self when the channel is readable, otherwise returns nil
   def wait_readable(s = nil)
@@ -253,10 +232,8 @@ class Chan::UNIXSocket
 
   ##
   # Waits for the channel to become writable
-  #
   # @param [Float, Integer, nil] s
   #  The number of seconds to wait. Waits indefinitely with no arguments.
-  #
   # @return [Chan::UNIXSocket, nil]
   #  Returns self when the channel is writable, otherwise returns nil
   def wait_writable(s = nil)

data/lib/xchan/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chan
-  VERSION = "0.17.2"
+  VERSION = "0.19.0"
 end

data/lib/xchan.rb

@@ -3,6 +3,7 @@
 module Chan
   require_relative "xchan/version"
   require_relative "xchan/unix_socket"
+  require_relative "xchan/null_lock"
   require_relative "xchan/tempfile"
 
   WaitReadable = Class.new(IO::EAGAINWaitReadable)
@@ -10,17 +11,14 @@ module Chan
   WaitLockable = Class.new(Errno::EWOULDBLOCK)
 
   ##
-  # The Pure serializer won't perform
-  # serialization that goes beyond calling
-  # `.to_s` on the object it is given. It
-  # can be useful when you want to communicate
-  # purely in strings.
+  # Coerces an object to a string for a
+  # channel communicating in raw strings
+  # (in other words: without serialization)
   #
   # @example
   #   ch = xchan(:pure)
-  #   Process.wait fork {
-  #     ch.send "Hello world"
-  #   }
+  #   fork { ch.send "Hello world" }
+  #   Process.wait
   #   puts ch.recv
   Pure = Class.new do
     def self.dump(str) = str.to_s
@@ -35,10 +33,8 @@ module Chan
   #
   # @param [String] basename
   #  Basename of the temporary file
-  #
   # @param [String] tmpdir
   #  Parent directory of the temporary file
-  #
   # @return [Chan::Tempfile]
   #  Returns an instance of {Chan::Tempfile Chan::Tempfile}
   def self.temporary_file(basename, tmpdir: Dir.tmpdir)
@@ -47,8 +43,8 @@ module Chan
 
   ##
   # @return [Hash<Symbol, Proc>]
-  #  Maps a short name to a serializer
-  def self.shortcuts
+  #  Returns the default serializers
+  def self.serializers
     {
       pure: lambda { Pure },
       marshal: lambda { Marshal },
@@ -62,6 +58,16 @@ module Chan
       }
     }
   end
+
+  ##
+  # @return [Hash<Symbol, Proc>]
+  #  Returns the default locks
+  def self.locks
+    {
+      null: lambda { |_tmpdir| Chan::NullLock },
+      file: lambda { |tmpdir| Lock::File.new Chan.temporary_file(%w[xchan lock], tmpdir:) }
+    }
+  end
 end
 
 module Kernel
@@ -71,12 +77,12 @@ module Kernel
   #   ch.send([1,2,3])
   #   ch.recv.pop # => 3
   #   ch.close
-  #
-  # @param s (see Chan::UNIXSocket#initialize)
-  # @param sock_type (see Chan::UNIXSocket#initialize)
+  # @param serializer (see Chan::UNIXSocket#initialize)
+  # @param sock (see Chan::UNIXSocket#initialize)
   # @param tmpdir (see Chan::UNIXSocket#initialize)
+  # @param lock (see Chan::UNIXSocket#initialize)
   # @return (see Chan::UNIXSocket#initialize)
-  def xchan(s, **kw_args)
-    Chan::UNIXSocket.new(s, **kw_args)
+  def xchan(s, ...)
+    Chan::UNIXSocket.new(s, ...)
   end
 end

data/share/xchan.rb/examples/read_operations/1_blocking_read.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "../setup"

data/share/xchan.rb/examples/read_operations/2_nonblocking_read.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "../setup"

data/share/xchan.rb/examples/serialization/1_serializers.rb

@@ -1,14 +1,15 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "../setup"
 require "xchan"
 
 ##
-# This channel uses Marshal to serialize objects
+# Marshal as the serializer
 ch = xchan(:marshal)
 Process.wait fork { ch.send(5) }
-print "There are ", ch.recv + 7, " disciples and the same number of tribes", "\n"
+print "#{ch.recv} + 7 = 12", "\n"
 ch.close
 
 ##
-# There are 12 disciples and the same number of tribes
+# 5 + 7 = 12

data/share/xchan.rb/examples/socket/{2_options.rb → 1_options.rb}

@@ -1,3 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require "xchan"
 ch = xchan(:marshal)
 

data/share/xchan.rb/examples/write_operations/1_blocking_write.rb

@@ -1,9 +1,10 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "../setup"
 require "xchan"
 
-ch = xchan(:marshal, sock_type: Socket::SOCK_STREAM)
+ch = xchan(:marshal, sock: Socket::SOCK_STREAM)
 sndbuf = ch.w.getsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF)
 while ch.bytes_sent <= sndbuf.int
   ch.send(1)

data/share/xchan.rb/examples/write_operations/2_nonblocking_write.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require_relative "../setup"
@@ -14,7 +15,7 @@ rescue Chan::WaitLockable
   retry
 end
 
-ch = xchan(:marshal, sock_type: Socket::SOCK_STREAM)
+ch = xchan(:marshal, sock: Socket::SOCK_STREAM)
 sndbuf = ch.w.getsockopt(Socket::SOL_SOCKET, Socket::SO_SNDBUF)
 while ch.bytes_sent <= sndbuf.int
   send_nonblock(ch, 1)

data/test/readme_test.rb

@@ -1,42 +1,44 @@
 # frozen_string_literal: true
 
 require_relative "setup"
-require "test/cmd"
+require "test-cmd"
 
 class Chan::ReadmeTest < Test::Unit::TestCase
   def test_serialization_1_serializers
-    assert_equal "There are 12 disciples and the same number of tribes\n",
-                 readme_example("serialization/1_serializers.rb").stdout
+    assert_equal "5 + 7 = 12\n",
+                 cmd("ruby", readme_example("serialization/1_serializers.rb")).stdout
   end
 
   def test_read_operations_1_blocking_read
     r = 'Send a random number \(from parent process\)\s*' \
         'Received random number \(child process\): \d+'
     assert_match Regexp.new(r),
-                 readme_example("read_operations/1_blocking_read.rb").stdout
-                                                                     .tr("\n", " ")
+                 cmd("ruby", readme_example("read_operations/1_blocking_read.rb"))
+                   .stdout
+                   .tr("\n", " ")
   end
 
   def test_write_operations_2_non_blocking_write
     assert_equal ["Blocked - free send buffer\n"],
-                 readme_example("write_operations/2_nonblocking_write.rb").stdout
-                                                                          .each_line
-                                                                          .uniq
+                 cmd("ruby", readme_example("write_operations/2_nonblocking_write.rb"))
+                   .stdout
+                   .each_line
+                   .uniq
   end
 
   def test_socket_2_options
-    r = 'The read buffer can contain a maximum of: \d{1,6} bytes.\s*' \
-        'The maximum size of a single message is: \d{1,6} bytes.\s*'
+    r = 'The read buffer can contain a maximum of: \d{1,7} bytes.\s*' \
+        'The maximum size of a single message is: \d{1,7} bytes.\s*'
     assert_match Regexp.new(r),
-                 readme_example("socket/2_options.rb").stdout
-                                                      .tr("\n", " ")
+                 cmd("ruby", readme_example("socket/1_options.rb"))
+                   .stdout
+                   .tr("\n", " ")
   end
 
   private
 
   def readme_example(path)
-    examples_dir = File.join(Dir.getwd, "share", "xchan.rb", "examples")
-    example = File.join(examples_dir, path)
-    cmd "bundle exec ruby #{example}"
+    dir = File.join(Dir.getwd, "share", "xchan.rb", "examples")
+    File.join(dir, path)
   end
 end

data/test/setup.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "bundler/setup"
 require "json"
 require "yaml"
 require "timeout"

data/test/xchan_test.rb

@@ -205,7 +205,7 @@ class Chan::TemporaryFileTest < Chan::Test
   end
 
   def test_temporary_file_path
-    assert_match %r|#{Regexp.escape(Dir.tmpdir)}/foobar[a-zA-Z0-9-]+\.txt|,
+    assert_match %r{#{Regexp.escape(Dir.tmpdir)}/foobar[a-zA-Z0-9-]+\.txt},
                  file.to_path
   ensure
     file.close

data/xchan.rb.gemspec

@@ -8,15 +8,22 @@ Gem::Specification.new do |gem|
   gem.homepage = "https://github.com/0x1eef/xchan.rb#readme"
   gem.version = Chan::VERSION
   gem.licenses = ["0BSD"]
-  gem.files = `git ls-files`.split($/)
+  gem.files = Dir[
+    "README.md", "LICENSE",
+    "share/xchan.rb/**/*.rb",
+    "lib/*.rb", "lib/**/*.rb",
+    "test/*.rb", "test/**/*.rb",
+    "xchan.rb.gemspec"
+  ]
   gem.require_paths = ["lib"]
   gem.summary = "An easy to use InterProcess Communication (IPC) library"
   gem.description = gem.summary
-  gem.add_runtime_dependency "lockf.rb", "~> 1.0"
+  gem.add_runtime_dependency "lockf.rb", "~> 2.1"
   gem.add_development_dependency "test-unit", "~> 3.5.7"
   gem.add_development_dependency "yard", "~> 0.9"
-  gem.add_development_dependency "redcarpet", "~> 3.5"
+  gem.add_development_dependency "kramdown", "~> 2.5"
   gem.add_development_dependency "standard", "~> 1.13"
-  gem.add_development_dependency "test-cmd.rb", "~> 0.8"
+  gem.add_development_dependency "test-cmd.rb", "~> 0.12.4"
   gem.add_development_dependency "rake", "~> 13.1"
+  gem.add_development_dependency "irb", "~> 1.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xchan.rb
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.19.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lockf.rb
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.12.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.12.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
 description: An easy to use InterProcess Communication (IPC) library
 email:
 - 0x1eef@protonmail.com
@@ -115,19 +129,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/tests.yml"
-- ".gitignore"
-- ".gitlab-ci.yml"
-- ".projectile"
-- ".rubocop.yml"
-- ".yardopts"
-- Gemfile
-- LICENSE
 - README.md
-- Rakefile.rb
 - lib/xchan.rb
 - lib/xchan/bytes.rb
 - lib/xchan/counter.rb
+- lib/xchan/null_lock.rb
 - lib/xchan/tempfile.rb
 - lib/xchan/unix_socket.rb
 - lib/xchan/version.rb
@@ -135,7 +141,7 @@ files:
 - share/xchan.rb/examples/read_operations/2_nonblocking_read.rb
 - share/xchan.rb/examples/serialization/1_serializers.rb
 - share/xchan.rb/examples/setup.rb
-- share/xchan.rb/examples/socket/2_options.rb
+- share/xchan.rb/examples/socket/1_options.rb
 - share/xchan.rb/examples/stress_tests/1_parallel_access_stress_test.rb
 - share/xchan.rb/examples/write_operations/1_blocking_write.rb
 - share/xchan.rb/examples/write_operations/2_nonblocking_write.rb
@@ -162,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: An easy to use InterProcess Communication (IPC) library

data/.github/workflows/tests.yml

@@ -1,26 +0,0 @@
-name: xchan.rb
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  specs:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, macos-latest]
-        ruby: [3.1, 3.2, 3.3]
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - run: bundle install
-    - run: SERIALIZER=marshal bundle exec rake
-    - run: SERIALIZER=json bundle exec rake
-    - run: SERIALIZER=yaml bundle exec rake
-    - run: SERIALIZER=pure bundle exec rake

data/.gitignore

@@ -1,8 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-.yardoc/
-.dev/
-doc/
-pkg/
-.gems/

data/.gitlab-ci.yml

@@ -1,12 +0,0 @@
-stages:
-  - test
-
-test-ruby32:
-  stage: test
-  image: ruby:3.2.0
-  script:
-    - bundle install
-    - SERIALIZER=marshal bundle exec rake
-    - SERIALIZER=json bundle exec rake
-    - SERIALIZER=yaml bundle exec rake
-    - SERIALIZER=pure bundle exec rake

data/.projectile

@@ -1,4 +0,0 @@
-+.
--/doc/
--/.yardoc/
--/.gems/

data/.rubocop.yml

@@ -1,34 +0,0 @@
-##
-# Plugins
-require:
-  - standard
-
-##
-# Defaults: standard-rb
-inherit_gem:
-  standard: config/base.yml
-
-##
-# All cops
-AllCops:
-  TargetRubyVersion: 3.2
-  Include:
-    - lib/*.rb
-    - lib/**/*.rb
-    - test/*_test.rb
-
-##
-# Enabled
-Style/FrozenStringLiteralComment:
-  Enabled: true
-
-##
-# Disabled
-Layout/ArgumentAlignment:
-  Enabled: false
-Layout/MultilineMethodCallIndentation:
-  Enabled: false
-Layout/EmptyLineBetweenDefs:
-  Enabled: false
-Style/TrivialAccessors:
-  Enabled: false

data/.yardopts

@@ -1,4 +0,0 @@
--m markdown -M redcarpet --no-private
--
-README.md
-LICENSE

data/Gemfile

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-gemspec

data/LICENSE

@@ -1,15 +0,0 @@
-Copyright (C) 2023 by 0x1eef <0x1eef@protonmail.com>
-
-Permission to use, copy, modify, and/or distribute this
-software for any purpose with or without fee is hereby
-granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS
-ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
-EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
-RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
-ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
-OF THIS SOFTWARE.

data/Rakefile.rb

@@ -1,9 +0,0 @@
-require "rake/testtask"
-require "bundler/setup"
-
-Rake::TestTask.new do |t|
-  t.test_files = FileList['test/*_test.rb']
-  t.verbose = true
-  t.warning = false
-end
-task default: :test