test-cmd.rb 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceedd530e04b4429280815527f9c18213db595390d6c554854a843c9c9a7717e
-  data.tar.gz: 98ad59766cd5aa84d4fbed39ca8d2465fd6be4fa3d7895707f6341fbad37e6c4
+  metadata.gz: 6c1063e0ddb4b42759986c6772953a164f09c73c440d172d135cbc285a28bad3
+  data.tar.gz: 5a77c90c1f3d11686dcd3d3ce50b228520122a0aa329b82ad4bb563ed69d2174
 SHA512:
-  metadata.gz: f25e60111e111074f5dd1cdba6ba10f7074a5a2fbe9ddbf57ef08a3d1ecc1096e4119331c98ab74736b689aedf8c5f4b784cd18db7255bb7df01de314a1b1dd5
-  data.tar.gz: 368188e8228ea2974e2db19d284efabb70ce3a0a2c773d73e372078a82034fa93e69ff9e586c62fc570b49039f4bc759d1b0da1cf8e240ac7f3b631893d5dff3
+  metadata.gz: f30023b4013ac900ef6cf1f9c5aa91cace6f796dd08d810c6d9c4bca340bda97490025b379972ed5e37ee23f5edb41f0fc70008c1837fa0af6b2557f4e0cb29e
+  data.tar.gz: 874f6f8b2fb5b61d8d222f6e7737459a47c1bd94ec05f4cee35da718c9d463a4530ada6f1711d6d9cc96e54ca26156583d8f82eeb60642f15e05db0a76da088f

data/Rakefile.rb

@@ -1,4 +1,5 @@
 require "bundler/setup"
+require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new do |t|

data/lib/test/cmd.rb

@@ -49,8 +49,36 @@ class Test::Cmd
     tap do
       @spawned = true
       @out, @err = Pipe.pair, Pipe.pair
-      produce(@out, @err)
+      ##
+      # Spawn in the calling thread so the command's fds are
+      # wired up before the reader thread starts. We then close
+      # our own copies of the write ends so the reader thread
+      # observes EOF the moment the child exits, and reads both
+      # streams with whole-buffer reads rather than a byte at
+      # a time.
+      @pid = Process.spawn(
+        @cmd, *@argv,
+        {out: @out.w, err: @err.w, in: IO::NULL}
+      )
+      @out.w.close
+      @err.w.close
+      @producer = Thread.new do
+        @stdout = @out.r.read
+        @stderr = @err.r.read
+        Process.wait
+        @status = $?
+      ensure
+        @out.r.close
+        @err.r.close
+      end
     end
+  rescue Errno::ENOENT => ex
+    @stderr = ex.message
+    @enoent = true
+    ##
+    # Capture a real non-zero status so predicates like
+    # #success? work even though the command never spawned.
+    @status = Process.waitpid2(Process.spawn("false")).last
   end
 
   ##
@@ -58,7 +86,7 @@ class Test::Cmd
   #  Returns the status of a process
   def status
     spawn
-    consume(@producer, @out, @err)
+    consume
     @status
   end
 
@@ -85,7 +113,7 @@ class Test::Cmd
   #  Returns the contents of stdout
   def stdout
     spawn
-    consume(@producer, @out, @err)
+    consume
     @stdout
   end
 
@@ -94,7 +122,7 @@ class Test::Cmd
   #  Returns the contents of stderr
   def stderr
     spawn
-    consume(@producer, @out, @err)
+    consume
     @stderr
   end
   # @endgroup
@@ -137,7 +165,7 @@ class Test::Cmd
   #  Returns true when a command can't be found
   def command_not_found?
     spawn
-    consume(@producer, @out, @err)
+    consume
     @enoent
   end
   alias_method :not_found?, :command_not_found?
@@ -150,14 +178,14 @@ class Test::Cmd
   # @yieldparam [Test::Cmd] cmd
   #  Yields an instance of {Test::Cmd Test::Cmd}
   # @example
-  #   cmd("ruby", "-e", "exit 0")
-  #     .success { print "Command [#{_1.pid}] exited successfully", "\n" }
-  #     .failure { }
+  #   cmd("ruby", "-e", "exit 0").success do
+  #     print "ok pid #{_1.pid}", "\n"
+  #   end
   # @return [Test::Cmd]
   def success
     tap do
       spawn
-      consume(@producer, @out, @err)
+      consume
       status.success? ? yield(self) : nil
     end
   end
@@ -166,14 +194,14 @@ class Test::Cmd
   # @yieldparam [Test::Cmd] cmd
   #  Yields an instance of {Test::Cmd Test::Cmd}
   # @example
-  #   cmd("ruby", "-e", "exit 1")
-  #     .success { }
-  #     .failure { print "Command [#{_1.pid}] exited unsuccessfully", "\n" }
+  #   cmd("ruby", "-e", "exit 1").failure do
+  #     print "fail pid #{_1.pid}", "\n"
+  #   end
   # @return [Test::Cmd]
   def failure
     tap do
       spawn
-      consume(@producer, @out, @err)
+      consume
       status.success? ? nil : yield(self)
     end
   end
@@ -182,44 +210,13 @@ class Test::Cmd
   private
 
   ##
-  # @param [Test::Cmd::Pipe] out
-  #  A pipe for stdout
-  # @param [Test::Cmd::Pipe] err
-  #  A pipe for stderr
-  # @return [Thread]
-  #  Returns a thread for a spawned command
-  def produce(out, err)
-    @producer = Thread.new do
-      @pid = Process.spawn(@cmd, *@argv, {out: out.w, err: err.w})
-      Process.wait
-      @status = $?
-    rescue Errno::ENOENT => ex
-      @cmd, @argv, @stderr = "false", [], ex.message
-      @enoent = true
-      retry
-    end
-  end
-
-  ##
-  # @param [Thread] thread
-  #  A thread for a spawned command
-  # @param [Test::Cmd::Pipe] out
-  #  A pipe for stdout
-  # @param [Test::Cmd::Pipe] err
-  #  A pipe for stderr
+  # Blocks until the spawned command has finished, its
+  # output has been read, and its exit status captured.
+  # Safe to call more than once.
   # @return [void]
-  def consume(thread, out, err)
-    return if @consumed
-    sleep 0.01 while thread.alive?
-    loop do
-      io, _ = IO.select([out.r, err.r], nil, nil, 0.01)
-      io&.include?(out.r) ? @stdout << out.r.read(1) : nil
-      io&.include?(err.r) ? @stderr << err.r.read(1) : nil
-      break unless thread.alive? || IO.select([out.r, err.r], nil, nil, 0.01)
-    end
-  ensure
-    [out, err].each(&:close)
-    @consumed = true
+  def consume
+    return unless @producer&.alive?
+    @producer.join
   end
 end
 

data/test-cmd.rb.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |gem|
   gem.name = "test-cmd.rb"
-  gem.authors = ["0x1eef"]
-  gem.email = ["0x1eef@protonmail.com"]
-  gem.homepage = "https://github.com/1robertrb/test-cmd.rb#readme"
-  gem.version = "1.0.0"
+  gem.authors = ["robert"]
+  gem.email = ["robert@r.uby.dev"]
+  gem.homepage = "https://github.com/0x1eef/test-cmd.rb#readme"
+  gem.version = "1.2.0"
   gem.required_ruby_version = ">= 3.0"
   gem.licenses = ["0BSD"]
   gem.files = `git ls-files`.split($/)

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: test-cmd.rb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
-- '0x1eef'
+- robert
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -81,7 +81,7 @@ dependencies:
         version: '13.1'
 description: test-cmd.rb provides an object-oriented interface for spawning a command
 email:
-- 0x1eef@protonmail.com
+- robert@r.uby.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -99,7 +99,7 @@ files:
 - test-cmd.rb.gemspec
 - test/cmd_test.rb
 - test/setup.rb
-homepage: https://github.com/1robertrb/test-cmd.rb#readme
+homepage: https://github.com/0x1eef/test-cmd.rb#readme
 licenses:
 - 0BSD
 metadata: {}
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.16
 specification_version: 4
 summary: test-cmd.rb provides an object-oriented interface for spawning a command
 test_files: []