xchan.rb 0.17.2 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ce716f918994e2481e8fbd333dbdb7e0b258341a09e32d464a54a2331edbd09
-  data.tar.gz: f17d86bf4004ca1ebef87950ff9d20c7aaad29940e8c031ff84d817ade3adeb9
+  metadata.gz: 49c3ec314ad19f47d91dd30c854e94ad184fd70a0cb5ed7fd0139b506b295c6e
+  data.tar.gz: 1ba90eb765464330c3c6c35385c6ce6732f0bd95cd21e85be236576b7a0ba7c5
 SHA512:
-  metadata.gz: c77e364ea0f6365d4fddae810cd14e999cf584dd301e5a651a5565d78fcce157909f0b96a155f67f8f22bb50f1c7d5c2535653e4871f2e5dab862c1e38f207f3
-  data.tar.gz: a4f2d57cf1843407d7056c4528d7e41372ed84378e33f6ca2777b6b2dde93b80fe5e57d33d2b01337a089d808b11e3e6d92c91b4f57f86aeefc4a3e4782c6afa
+  metadata.gz: d29f66b50713d1277b25ad2900bbcd5a99ac1589a921e0b0a8ccd2028e534204ffc8a382b68f3ba48947aa2be8fda90843adda2fbdf133db3cf9fb230f2a5873
+  data.tar.gz: 218b603663b0cac0af9c6780e942c74decb096045e9a7eef14daf5c6644286bd2ee8e1969445260952425bfad08b4bd2fb588a6a1d1f3be0b45d0913337575b5

data/.github/workflows/tests.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [3.1, 3.2, 3.3]
+        ruby: [3.2, 3.3]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
@@ -20,7 +20,7 @@ jobs:
       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
+    - run: SERIALIZER=marshal; for t in *_test.rb; do ruby test/${t}; done
+    - run: SERIALIZER=json; for t in *_test.rb; do ruby test/${t}; done
+    - run: SERIALIZER=yaml; for t in *_test.rb; do ruby test/${t}; done
+    - run: SERIALIZER=pure; for t in *_test.rb; do ruby test/${t}; done

data/.projectile

@@ -1,4 +1,5 @@
-+.
++/
++/.github/
 -/doc/
 -/.yardoc/
 -/.gems/

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,25 @@ 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
 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
@@ -184,7 +179,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 +189,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](https://github.com/0x1eef/xchan.rb#readme)
+* [GitLab](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 [LICENSE](./LICENSE)

data/lib/xchan/bytes.rb

@@ -95,6 +95,6 @@ class Chan::Bytes
   end
 
   def deserialize(bytes)
-    JSON.load(bytes)
+    JSON.parse(bytes)
   end
 end

data/lib/xchan/counter.rb

@@ -57,6 +57,6 @@ class Chan::Counter
   end
 
   def deserialize(bytes)
-    JSON.load(bytes)
+    JSON.parse(bytes)
   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(*args, **kwargs)
+      tempfile = new(*args, **kwargs)
 
       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"
@@ -42,11 +42,11 @@ class Chan::UNIXSocket
   # @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
+    @s = Chan.serializers[s]&.call || s
     @r, @w = ::UNIXSocket.pair(sock_type)
     @bytes = Chan::Bytes.new(tmpdir)
     @counter = Chan::Counter.new(tmpdir)
-    @lock = LockFile.new Chan.temporary_file(%w[xchan .lock], tmpdir:)
+    @lockf = Lock::File.new Chan.temporary_file(%w[xchan .lock], tmpdir:)
   end
 
   ##
@@ -64,11 +64,11 @@ class Chan::UNIXSocket
   #
   # @return [void]
   def close
-    @lock.lock
+    @lockf.lock
     raise IOError, "channel is closed" if closed?
-    [@r, @w, @bytes, @lock.file].each(&:close)
+    [@r, @w, @bytes, @lockf].each(&:close)
   rescue IOError => ex
-    @lock.release
+    @lockf.release
     raise(ex)
   end
 
@@ -111,14 +111,14 @@ class Chan::UNIXSocket
   # @return [Integer, nil]
   #  Returns the number of bytes written to the channel
   def send_nonblock(object)
-    @lock.lock_nonblock
+    @lockf.lock_nonblock
     raise IOError, "channel closed" if closed?
     len = @w.write_nonblock(serialize(object))
     @bytes.push(len)
     @counter.increment!(bytes_written: len)
-    len.tap { @lock.release }
+    len.tap { @lockf.release }
   rescue IOError, IO::WaitWritable, Errno::ENOBUFS => ex
-    @lock.release
+    @lockf.release
     raise Chan::WaitWritable, ex.message
   rescue Errno::EWOULDBLOCK => ex
     raise Chan::WaitLockable, ex.message
@@ -164,18 +164,18 @@ class Chan::UNIXSocket
   # @return [Object]
   #  Returns an object from the channel
   def recv_nonblock
-    @lock.lock_nonblock
+    @lockf.lock_nonblock
     raise IOError, "closed channel" if closed?
     len = @bytes.shift
     obj = deserialize(@r.read_nonblock(len.zero? ? 1 : len))
     @counter.increment!(bytes_read: len)
-    obj.tap { @lock.release }
+    obj.tap { @lockf.release }
   rescue IOError => ex
-    @lock.release
+    @lockf.release
     raise(ex)
   rescue IO::WaitReadable => ex
     @bytes.unshift(len)
-    @lock.release
+    @lockf.release
     raise Chan::WaitReadable, ex.message
   rescue Errno::EAGAIN => ex
     raise Chan::WaitLockable, ex.message
@@ -187,9 +187,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
@@ -269,10 +269,10 @@ class Chan::UNIXSocket
   private
 
   def lock
-    @lock.lock
+    @lockf.lock
     yield
   ensure
-    @lock.release
+    @lockf.release
   end
 
   def serialize(obj)

data/lib/xchan/version.rb

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

data/lib/xchan.rb

@@ -10,17 +10,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
@@ -47,8 +44,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 },
@@ -76,7 +73,7 @@ module Kernel
   # @param sock_type (see Chan::UNIXSocket#initialize)
   # @param tmpdir (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/serialization/1_serializers.rb

@@ -2,13 +2,14 @@
 
 require_relative "../setup"
 require "xchan"
+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/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*'
     assert_match Regexp.new(r),
-                 readme_example("socket/2_options.rb").stdout
-                                                      .tr("\n", " ")
+                 cmd("ruby", readme_example("socket/2_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

@@ -84,7 +84,7 @@ class Chan::RecvNonBlockTest < Chan::Test
   end
 
   def test_recv_nonblock_with_a_lock
-    ch.instance_variable_get(:@lock).lock
+    ch.instance_variable_get(:@lockf).lock
     pid = fork do
       ch.recv_nonblock
       exit(1)
@@ -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

@@ -12,11 +12,11 @@ Gem::Specification.new do |gem|
   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 "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"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xchan.rb
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.18.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2024-06-30 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
@@ -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
@@ -117,7 +117,6 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/tests.yml"
 - ".gitignore"
-- ".gitlab-ci.yml"
 - ".projectile"
 - ".rubocop.yml"
 - ".yardopts"
@@ -162,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: An easy to use InterProcess Communication (IPC) library

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