xchan.rb 0.17.0 → 0.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf2db46e92eb29ed0182377c209a8ff7511460d22a73225616c719cd05372884
-  data.tar.gz: 05b70d50483d354f79e29f9219628c44cb6f4b25e63cbd5aee7e0c0a14da8865
+  metadata.gz: 9ce716f918994e2481e8fbd333dbdb7e0b258341a09e32d464a54a2331edbd09
+  data.tar.gz: f17d86bf4004ca1ebef87950ff9d20c7aaad29940e8c031ff84d817ade3adeb9
 SHA512:
-  metadata.gz: f8fb7b0f73b09c4593dfa7892fd3e0061dce37242c0e9bebab0edd204cda399dd16c8fdbadce2ee6a5fac1fc6c1d583ad60eadd85c7ece4a145fdb18358aff0a
-  data.tar.gz: ef454d2422ae0a719a19b7fad3bf670a3cc4b46154ea6e87786a4c6404bbe9f7af5437e81b3ed8651fa9e1f438ee7f43c38d10497ca9b50facd3aea3ededc7f0
+  metadata.gz: c77e364ea0f6365d4fddae810cd14e999cf584dd301e5a651a5565d78fcce157909f0b96a155f67f8f22bb50f1c7d5c2535653e4871f2e5dab862c1e38f207f3
+  data.tar.gz: a4f2d57cf1843407d7056c4528d7e41372ed84378e33f6ca2777b6b2dde93b80fe5e57d33d2b01337a089d808b11e3e6d92c91b4f57f86aeefc4a3e4782c6afa

data/.github/workflows/tests.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [3.1, 3.2]
+        ruby: [3.1, 3.2, 3.3]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
@@ -23,4 +23,4 @@ jobs:
     - run: SERIALIZER=marshal bundle exec rake
     - run: SERIALIZER=json bundle exec rake
     - run: SERIALIZER=yaml bundle exec rake
-    - run: SERIALIZER=plain bundle exec rake
+    - run: SERIALIZER=pure bundle exec rake

data/.gitlab-ci.yml

@@ -9,4 +9,4 @@ test-ruby32:
     - SERIALIZER=marshal bundle exec rake
     - SERIALIZER=json bundle exec rake
     - SERIALIZER=yaml bundle exec rake
-    - SERIALIZER=plain bundle exec rake
+    - SERIALIZER=pure bundle exec rake

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

@@ -1,39 +1,31 @@
 # frozen_string_literal: true
 
 ##
-# The {Chan::Bytes Chan::Bytes} class is similar
-# to an array, where each element represents the
-# number of bytes used to store an object on a
-# channel. When an object is written to a channel,
-# the array increases in size, and when an object
-# is read from a channel, the array decreases in
-# size.
+# {Chan::Bytes Chan::Bytes} represents a collection
+# of byte counts for each object stored on a channel.
+# When an object is written to a channel, the collection
+# increases in size, and when an object is read from
+# a channel, the collection decreases in size.
 class Chan::Bytes
   require "json"
-  require_relative "stat"
-
-  ##
-  # @return [Chan::Stat]
-  attr_reader :stat
+  require_relative "counter"
 
   ##
   # @param [String] tmpdir
-  #  Path to a directory where temporary files will be stored.
+  #  Directory where temporary files are stored
   #
   # @return [Chan::Bytes]
   def initialize(tmpdir)
-    @serializer = JSON
-    @io = Chan.temporary_file("xchan.bytes", tmpdir:)
+    @io = Chan.temporary_file(%w[bytes .json], tmpdir:)
     @io.sync = true
-    @stat = Chan::Stat.new(tmpdir)
     write(@io, [])
   end
 
   ##
-  # Insert a byte count at the head of the array
+  # Adds a count to the start of the collection
   #
   # @param [Integer] len
-  #  Number of bytes
+  #  The bytesize of an object
   #
   # @return [void]
   def unshift(len)
@@ -41,15 +33,14 @@ class Chan::Bytes
     bytes = read(@io)
     bytes.unshift(len)
     write(@io, bytes)
-    @stat.store(bytes_written: len)
     len
   end
 
   ##
-  # Insert a byte count at the tail of the array
+  # Adds a count to the end of the collection
   #
   # @param [Integer] len
-  #  Number of bytes
+  #  The bytesize of an object
   #
   # @return [void]
   def push(len)
@@ -57,25 +48,25 @@ class Chan::Bytes
     bytes = read(@io)
     bytes.push(len)
     write(@io, bytes)
-    @stat.store(bytes_written: len)
     len
   end
 
   ##
+  # Removes a count from the start of the collection
+  #
   # @return [Integer]
-  #  Returns (and removes) a byte count from the head of the array
+  #  Returns the removed byte count
   def shift
     bytes = read(@io)
     return 0 if bytes.size.zero?
     len = bytes.shift
     write(@io, bytes)
-    @stat.store(bytes_read: len)
     len
   end
 
   ##
   # @return [Integer]
-  #  Returns the size of the array
+  #  Returns the number of objects in the collection
   def size
     read(@io).size
   end
@@ -100,10 +91,10 @@ class Chan::Bytes
   end
 
   def serialize(bytes)
-    @serializer.dump(bytes)
+    JSON.dump(bytes)
   end
 
   def deserialize(bytes)
-    @serializer.load(bytes)
+    JSON.load(bytes)
   end
 end

data/lib/xchan/{stat.rb → counter.rb}

@@ -1,33 +1,32 @@
 # frozen_string_literal: true
 
 ##
-# The {Chan::Stat Chan::Stat} class provides statistics
-# (eg number of bytes read, number of bytes written) for
-# a given channel.
-class Chan::Stat
+# {Chan::Counter Chan::Counter} provides a counter
+# for the number of written and received bytes on a
+# given channel.
+class Chan::Counter
   require "json"
 
   ##
   # @param [String] tmpdir
-  #  Path to a directory where temporary files will be stored.
+  #  Directory where temporary files are stored
   #
-  # @return [Chan::Stat]
+  # @return [Chan::Counter]
   def initialize(tmpdir)
-    @serializer = JSON
-    @io = Chan.temporary_file("xchan.stat", tmpdir:)
+    @io = Chan.temporary_file(%w[counter .json], tmpdir:)
     write(@io, {"bytes_read" => 0, "bytes_written" => 0})
   end
 
   ##
   # @return [Integer]
-  #  Returns the number of bytes written to a channel.
+  #  Returns the number of bytes written to a channel
   def bytes_written
     read(@io).fetch("bytes_written")
   end
 
   ##
   # @return [Integer]
-  #  Returns the number of bytes read from a channel.
+  #  Returns the number of bytes read from a channel
   def bytes_read
     read(@io).fetch("bytes_read")
   end
@@ -36,7 +35,7 @@ class Chan::Stat
   # @param [Hash] new_stat
   # @return [void]
   # @private
-  def store(new_stat)
+  def increment!(new_stat)
     stat = read(@io)
     new_stat.each { stat[_1.to_s] += _2 }
     write(@io, stat)
@@ -54,10 +53,10 @@ class Chan::Stat
   end
 
   def serialize(bytes)
-    @serializer.dump(bytes)
+    JSON.dump(bytes)
   end
 
   def deserialize(bytes)
-    @serializer.load(bytes)
+    JSON.load(bytes)
   end
 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,32 +41,26 @@ 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)
-    @lock = LockFile.new Chan.temporary_file("xchan.lock", tmpdir:)
-  end
-
-  ##
-  # @return [<#dump, #load>]
-  #  Returns the serializer used by the channel.
-  def serializer
-    @serializer
+    @counter = Chan::Counter.new(tmpdir)
+    @lock = LockFile.new Chan.temporary_file(%w[xchan .lock], tmpdir:)
   end
 
   ##
   # @return [Boolean]
-  #  Returns true when the channel is closed.
+  #  Returns true when the channel is closed
   def closed?
     @r.closed? and @w.closed?
   end
 
   ##
-  # Closes the channel.
+  # Closes the channel
   #
   # @raise [IOError]
-  #  When the channel is closed.
+  #  When the channel is closed
   #
   # @return [void]
   def close
@@ -79,13 +79,13 @@ class Chan::UNIXSocket
   # Performs a blocking write
   #
   # @param [Object] object
-  #  An object to write to the channel.
+  #  An object
   #
   # @raise [IOError]
-  #  When the channel is closed.
+  #  When the channel is closed
   #
   # @return [Object]
-  #  Returns the number of bytes written to the channel.
+  #  Returns the number of bytes written to the channel
   def send(object)
     send_nonblock(object)
   rescue Chan::WaitWritable, Chan::WaitLockable
@@ -97,24 +97,25 @@ class Chan::UNIXSocket
   # Performs a non-blocking write
   #
   # @param [Object] object
-  #  An object to write to the channel.
+  #  An object
   #
   # @raise [IOError]
-  #  When the channel is closed.
+  #  When the channel is closed
   #
   # @raise [Chan::WaitWritable]
-  #  When a write to the underlying IO blocks.
+  #  When a write to {#w} blocks
   #
   # @raise [Chan::WaitLockable]
-  #  When a write blocks because of a lock held by another process.
+  #  When a write blocks because of a lock held by another process
   #
   # @return [Integer, nil]
-  #  Returns the number of bytes written to the channel.
+  #  Returns the number of bytes written to the channel
   def send_nonblock(object)
     @lock.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 }
   rescue IOError, IO::WaitWritable, Errno::ENOBUFS => ex
     @lock.release
@@ -134,10 +135,10 @@ class Chan::UNIXSocket
   # Performs a blocking read
   #
   # @raise [IOError]
-  #  When the channel is closed.
+  #  When the channel is closed
   #
   # @return [Object]
-  #  Returns an object from the channel.
+  #  Returns an object from the channel
   def recv
     recv_nonblock
   rescue Chan::WaitReadable
@@ -152,21 +153,22 @@ class Chan::UNIXSocket
   # Performs a non-blocking read
   #
   # @raise [IOError]
-  #  When the channel is closed.
+  #  When the channel is closed
   #
   # @raise [Chan::WaitReadable]
-  #  When a read from the underlying IO blocks.
+  #  When a read from {#r} blocks
   #
   # @raise [Chan::WaitLockable]
-  #  When a read blocks because of a lock held by another process.
+  #  When a read blocks because of a lock held by another process
   #
   # @return [Object]
-  #  Returns an object from the channel.
+  #  Returns an object from the channel
   def recv_nonblock
     @lock.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 }
   rescue IOError => ex
     @lock.release
@@ -190,7 +192,7 @@ class Chan::UNIXSocket
   #   ch.to_a.last # => 4
   #
   # @return [Array<Object>]
-  #  Returns the consumed contents of the channel.
+  #  Returns the contents of the channel
   def to_a
     lock do
       [].tap { _1.push(recv) until empty? }
@@ -199,7 +201,7 @@ class Chan::UNIXSocket
 
   ##
   # @return [Boolean]
-  #  Returns true when the channel is empty.
+  #  Returns true when the channel is empty
   def empty?
     return true if closed?
     lock { size.zero? }
@@ -210,23 +212,23 @@ class Chan::UNIXSocket
 
   ##
   # @return [Integer]
-  #  Returns the total number of bytes written to the channel.
+  #  Returns the total number of bytes written to the channel
   def bytes_sent
-    lock { @bytes.stat.bytes_written }
+    lock { @counter.bytes_written }
   end
   alias_method :bytes_written, :bytes_sent
 
   ##
   # @return [Integer]
-  #  Returns the total number of bytes read from the channel.
+  #  Returns the total number of bytes read from the channel
   def bytes_received
-    lock { @bytes.stat.bytes_read }
+    lock { @counter.bytes_read }
   end
   alias_method :bytes_read, :bytes_received
 
   ##
   # @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
@@ -238,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
@@ -274,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.0"
+  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

@@ -4,7 +4,7 @@ require_relative "setup"
 
 class Chan::Test < Test::Unit::TestCase
   def setup
-    @ch = xchan ENV.fetch("SERIALIZER", "marshal").to_sym
+    @ch = xchan(serializer)
   end
 
   def teardown
@@ -17,9 +17,13 @@ class Chan::Test < Test::Unit::TestCase
     @ch
   end
 
+  def serializer
+    ENV.fetch("SERIALIZER", "pure").to_sym
+  end
+
   def object
-    case ENV["SERIALIZER"]
-    when "plain" then "xchan"
+    case serializer
+    when :pure then "xchan"
     else %w[xchan]
     end
   end
@@ -190,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.0
+  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
@@ -127,7 +127,7 @@ files:
 - Rakefile.rb
 - lib/xchan.rb
 - lib/xchan/bytes.rb
-- lib/xchan/stat.rb
+- lib/xchan/counter.rb
 - lib/xchan/tempfile.rb
 - lib/xchan/unix_socket.rb
 - lib/xchan/version.rb