xchan.rb 0.17.1 → 0.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5509107cf1cda5e847f3c15e19c81ba9323c2dbb524a7ef808eeb820d5bcdeb9
-  data.tar.gz: 43deff543ee38ace3ca8a083a043eb1c6bbedec9143bd2c8e17de50f13127031
+  metadata.gz: 9ce716f918994e2481e8fbd333dbdb7e0b258341a09e32d464a54a2331edbd09
+  data.tar.gz: f17d86bf4004ca1ebef87950ff9d20c7aaad29940e8c031ff84d817ade3adeb9
 SHA512:
-  metadata.gz: d5455dd6c714bc4060ec1f563b46d8a9eaee32e5aa58c2a2508de99f53fc29e346d07ac04e719822bc394b66ac6ba6ddf5585bf7958c606a0f1f375c113b4310
-  data.tar.gz: '09bd28506d18a63e8e917ad1189c708cc6643b852707508ee0edf563064bd3618d3ae251d85e06f618672c414537b4da3db0538b61e4c11c2a6c64fff3394f38'
+  metadata.gz: c77e364ea0f6365d4fddae810cd14e999cf584dd301e5a651a5565d78fcce157909f0b96a155f67f8f22bb50f1c7d5c2535653e4871f2e5dab862c1e38f207f3
+  data.tar.gz: a4f2d57cf1843407d7056c4528d7e41372ed84378e33f6ca2777b6b2dde93b80fe5e57d33d2b01337a089d808b11e3e6d92c91b4f57f86aeefc4a3e4782c6afa

data/README.md

@@ -52,13 +52,14 @@ the parent process writes to the channel:
 require "xchan"
 
 ch = xchan(:marshal)
-Process.detach fork {
+fork do
   print "Received a random number (child process): ", ch.recv, "\n"
-}
+end
 sleep(1)
 print "Send a random number (from parent process)", "\n"
 ch.send(rand(21))
 ch.close
+Process.wait
 
 ##
 # Send a random number (from parent process)

data/lib/xchan/bytes.rb

@@ -16,7 +16,7 @@ class Chan::Bytes
   #
   # @return [Chan::Bytes]
   def initialize(tmpdir)
-    @io = Chan.temporary_file("xchan.bytes", tmpdir:)
+    @io = Chan.temporary_file(%w[bytes .json], tmpdir:)
     @io.sync = true
     write(@io, [])
   end

data/lib/xchan/counter.rb

@@ -13,7 +13,7 @@ class Chan::Counter
   #
   # @return [Chan::Counter]
   def initialize(tmpdir)
-    @io = Chan.temporary_file("xchan.counter", tmpdir:)
+    @io = Chan.temporary_file(%w[counter .json], tmpdir:)
     write(@io, {"bytes_read" => 0, "bytes_written" => 0})
   end
 

data/lib/xchan/unix_socket.rb

@@ -17,6 +17,12 @@ class Chan::UNIXSocket
   #  Returns a socket used for write operations
   attr_reader :w
 
+  ##
+  # @return [<#dump, #load>]
+  #  Returns the serializer used by the channel
+  attr_reader :s
+  alias_method :serializer, :s
+
   ##
   # @example
   #   ch = Chan::UNIXSocket.new(:marshal)
@@ -24,7 +30,7 @@ class Chan::UNIXSocket
   #   ch.recv.pop # => 3
   #   ch.close
   #
-  # @param [Symbol, <#dump, #load>] serializer
+  # @param [Symbol, <#dump, #load>] s
   #  The name of a serializer
   #
   # @param [Integer] sock_type
@@ -35,19 +41,12 @@ class Chan::UNIXSocket
   #
   # @return [Chan::UNIXSocket]
   #  Returns an instance of {Chan::UNIXSocket Chan::UNIXSocket}
-  def initialize(serializer, sock_type: Socket::SOCK_DGRAM, tmpdir: Dir.tmpdir)
-    @serializer = Chan.serializers[serializer]&.call || serializer
+  def initialize(s, sock_type: Socket::SOCK_DGRAM, tmpdir: Dir.tmpdir)
+    @s = Chan.shortcuts[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("xchan.lock", tmpdir:)
-  end
-
-  ##
-  # @return [<#dump, #load>]
-  #  Returns the serializer used by the channel
-  def serializer
-    @serializer
+    @lock = LockFile.new Chan.temporary_file(%w[xchan .lock], tmpdir:)
   end
 
   ##
@@ -61,7 +60,7 @@ class Chan::UNIXSocket
   # Closes the channel
   #
   # @raise [IOError]
-  #  When the channel is closed.
+  #  When the channel is closed
   #
   # @return [void]
   def close
@@ -229,7 +228,7 @@ class Chan::UNIXSocket
 
   ##
   # @return [Integer]
-  #  Returns the number of objects waiting to be read.
+  #  Returns the number of objects waiting to be read
   def size
     lock { @bytes.size }
   end
@@ -241,25 +240,25 @@ class Chan::UNIXSocket
   # @group Wait methods
 
   ##
-  # Waits for the channel to become readable.
+  # Waits for the channel to become readable
   #
   # @param [Float, Integer, nil] s
-  #  The number of seconds to wait. Waits indefinitely when "nil".
+  #  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.
+  #  Returns self when the channel is readable, otherwise returns nil
   def wait_readable(s = nil)
     @r.wait_readable(s) and self
   end
 
   ##
-  # Waits for the channel to become writable.
+  # Waits for the channel to become writable
   #
   # @param [Float, Integer, nil] s
-  #  The number of seconds to wait. Waits indefinitely when "nil".
+  #  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.
+  #  Returns self when the channel is writable, otherwise returns nil
   def wait_writable(s = nil)
     @w.wait_writable(s) and self
   end
@@ -277,10 +276,10 @@ class Chan::UNIXSocket
   end
 
   def serialize(obj)
-    @serializer.dump(obj)
+    @s.dump(obj)
   end
 
   def deserialize(str)
-    @serializer.load(str)
+    @s.load(str)
   end
 end

data/lib/xchan/version.rb

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

data/lib/xchan.rb

@@ -47,8 +47,8 @@ module Chan
 
   ##
   # @return [Hash<Symbol, Proc>]
-  #  A mapping of serializers
-  def self.serializers
+  #  Maps a short name to a serializer
+  def self.shortcuts
     {
       pure: lambda { Pure },
       marshal: lambda { Marshal },
@@ -72,11 +72,11 @@ module Kernel
   #   ch.recv.pop # => 3
   #   ch.close
   #
-  # @param serializer (see Chan::UNIXSocket#initialize)
+  # @param s (see Chan::UNIXSocket#initialize)
   # @param sock_type (see Chan::UNIXSocket#initialize)
   # @param tmpdir (see Chan::UNIXSocket#initialize)
   # @return (see Chan::UNIXSocket#initialize)
-  def xchan(serializer, **kw_args)
-    Chan::UNIXSocket.new(serializer, **kw_args)
+  def xchan(s, **kw_args)
+    Chan::UNIXSocket.new(s, **kw_args)
   end
 end

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

@@ -5,13 +5,14 @@ require "xchan"
 
 $stdout.sync = true
 ch = xchan(:marshal)
-Process.detach fork {
+fork do
   print "Received random number (child process): ", ch.recv, "\n"
-}
+end
 sleep(1)
 print "Send a random number (from parent process)", "\n"
 ch.send(rand(21))
 ch.close
+Process.wait
 
 ##
 # Send a random number (from parent process)

data/test/xchan_test.rb

@@ -194,3 +194,32 @@ class Chan::BytesReadTest < Chan::Test
     assert_equal object_size * 2, ch.bytes_read
   end
 end
+
+##
+# Chan.temporary_file
+class Chan::TemporaryFileTest < Chan::Test
+  def test_temporary_file_mode
+    assert_equal 0, file.stat.mode & 0o777
+  ensure
+    file.close
+  end
+
+  def test_temporary_file_path
+    assert_match %r|#{Regexp.escape(Dir.tmpdir)}/foobar[a-zA-Z0-9-]+\.txt|,
+                 file.to_path
+  ensure
+    file.close
+  end
+
+  def test_temporary_file_unlinked
+    refute File.exist?(file.to_path)
+  ensure
+    file.close
+  end
+
+  private
+
+  def file
+    @file ||= Chan.temporary_file %w[foobar .txt]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xchan.rb
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.17.2
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 2024-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lockf.rb