test-cmd.rb 0.11.1 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82a43ee0666fd9baea96c1974997092b1a739f730327e0a30ffa5d2e5b48cdaa
-  data.tar.gz: 2ca5079265f236de839baa8c6731433f99a9b0650c60e7c122db03c2b1a5e7bc
+  metadata.gz: 67a69e56d58ed586edecb9b4792bbc54913f2044a6468ce6d098744142cf78a0
+  data.tar.gz: 713bd38cbe6812e61e8847e156e16732cdcfc72026f206bd9df70c03c6d8a946
 SHA512:
-  metadata.gz: 4a6ec40cdce6d791ca2e4880cd6bc31af6151706bb92dd467c0d2b99ce3551e2dd13efd2ecea46d32c2e2feb30995466ade1b16529e93d52e2321b2b29233788
-  data.tar.gz: 3b286a1f7e87e1066837b4a6c5f61421409637becb71792ab06919b5b7620759bd0f6b036e6694cc1f18e14144733bdefb117bd98a61f2c66a4b9f540661f52d
+  metadata.gz: b8f1e8928b018372d5d6247300509f249bb3f7934a04b4a7356beff15d9c223a396657e1bb5e050bb7777b36185f2cf106618330f73df6939204c430a25eb584
+  data.tar.gz: 1f76220a3ab003bf434ab2dd7d604f7abe0577543abd5d86afee3b0a1fb82c3f164f8e6ba62489c1cacb9193c44860cd3fb152e93c3bcf4491400584805dde41

data/.github/workflows/specs.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

data/README.md

@@ -8,8 +8,8 @@ a command.
 ### Callbacks
 
 The success and failure callbacks provide hooks for when
-a command exits successfully or unsuccessfully. The callback
-is passed an instance of
+a command exits successfully or unsuccessfully. The callbacks
+are passed an instance of
 [Test::Cmd](https://0x1eef.github.io/x/test-cmd.rb/Test/Cmd.html):
 
 ``` ruby
@@ -55,46 +55,6 @@ class CmdTest < Test::Unit::TestCase
 end
 ```
 
-### IO#sync
-
-Sometimes it can be neccessary to bypass Ruby's internal buffer and flush
-output to the operating system immediately, otherwise there can be unexpected
-results. Consider the following example, where the output will be
-`bar\nfoo\n` rather than `foo\nbar\n`:
-
-``` ruby
-##
-# test.rb
-fork do
-  sleep(1)
-  puts "bar"
-end
-puts "foo"
-Process.wait
-
-##
-# cmd.rb
-p cmd("ruby", "test.rb").stdout # => "bar\nfoo\n"
-```
-
-And with output flushed to the operating system immediately:
-
-``` ruby
-##
-# test.rb
-$stdout.sync = true
-fork do
-  sleep(1)
-  puts "bar"
-end
-puts "foo"
-Process.wait
-
-##
-# cmd.rb
-p cmd("ruby", "test.rb").stdout # => "foo\nbar\n"
-```
-
 ## Documentation
 
 A complete API reference is available at
@@ -102,8 +62,6 @@ A complete API reference is available at
 
 ## Install
 
-**Rubygems.org**
-
 test-cmd.rb can be installed via rubygems.org:
 
     gem install test-cmd.rb

data/lib/test/cmd.rb

@@ -1,12 +1,23 @@
-module Test
-end unless defined?(Test)
+unless defined?(Test)
+  module Test
+  end
+end
 
 ##
 # test-cmd.rb provides an object oriented interface
 # for spawning a command.
 class Test::Cmd
-  require "tempfile"
-  require "securerandom"
+  ##
+  # @api private
+  class Pipe < Struct.new(:r, :w)
+    def self.pair
+      new(*IO.pipe)
+    end
+
+    def close
+      [r, w].each(&:close)
+    end
+  end
 
   ##
   # @param [String] cmd
@@ -19,6 +30,8 @@ class Test::Cmd
     @argv = argv.dup
     @status = nil
     @spawned = false
+    @stdout = ""
+    @stderr = ""
   end
 
   ##
@@ -36,13 +49,21 @@ class Test::Cmd
     return self if @spawned
 
     tap do
+      out, err = Pipe.pair, Pipe.pair
       @spawned = true
-      @out_io, @err_io = spawn_io
-      Process.spawn(@cmd, *@argv, {out: @out_io, err: @err_io})
-      Process.wait
-      @status = $?
+      t = Thread.new do
+        Process.spawn(@cmd, *@argv, {out: out.w, err: err.w})
+        Process.wait
+        @status = $?
+      end
+      loop do
+        break unless t.alive?
+        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
+      end
     ensure
-      [stdout, stderr]
+      [out, err].each(&:close)
     end
   end
 
@@ -50,24 +71,16 @@ class Test::Cmd
   # @return [String]
   #  Returns the contents of stdout
   def stdout
-    @stdout ||= begin
-      spawn
-      out_io.tap(&:rewind).read.tap { out_io.close }
-    rescue IOError
-      @stdout
-    end
+    spawn
+    @stdout
   end
 
   ##
   # @return [String]
   #  Returns the contents of stderr
   def stderr
-    @stderr ||= begin
-      spawn
-      err_io.tap(&:rewind).read.tap { err_io.close }
-    rescue IOError
-      @stderr
-    end
+    spawn
+    @stderr
   end
 
   ##
@@ -137,27 +150,6 @@ class Test::Cmd
   def spawned?
     @spawned
   end
-
-  private
-
-  attr_reader :out_io, :err_io
-
-  def spawn_io
-    [
-      [".testcmd.stdout.#{ns}.", SecureRandom.alphanumeric(3)],
-      [".testcmd.stderr.#{ns}.", SecureRandom.alphanumeric(3)]
-    ].map do
-      Tempfile.new(_1).tap do |file|
-        File.chmod(0, file.path)
-      ensure
-        file.unlink
-      end
-    end
-  end
-
-  def ns
-    [Process.pid, object_id].join(".")
-  end
 end
 
 module Kernel

data/test/{test_cmd_test.rb → cmd_test.rb}

@@ -3,6 +3,7 @@ require_relative "setup"
 class Test::Cmd
   class Test < Test::Unit::TestCase
     private
+
     def ruby(str)
       cmd "ruby", "-e", str
     end
@@ -57,7 +58,7 @@ class Test::Cmd
       end
       puts "foo"
       Process.wait
-    CODE
+      CODE
       assert_equal "foo\nbar\n", ruby(code).stdout
     end
   end
@@ -84,29 +85,6 @@ class Test::Cmd
     end
   end
 
-  ##
-  # Test::Cmd#spawn
-  class SpawnTest < Test
-    def test_io_closed_after_spawn
-      %i[out_io err_io].each do |io|
-        assert_equal true, spawned_command.send(io).closed?
-      end
-    end
-
-    def test_io_unlink_after_spawn
-      %i[out_io err_io].each do |io|
-        path = spawned_command.send(io).__getobj__.path
-        assert_equal false, File.exist?(path)
-      end
-    end
-
-    private
-
-    def spawned_command
-      ruby("puts 42").spawn
-    end
-  end
-
   ##
   # Test::Cmd#spawned?
   class SpawnedTest < Test

data/test-cmd.rb.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.authors = ["0x1eef"]
   gem.email = ["0x1eef@protonmail.com"]
   gem.homepage = "https://github.com/0x1eef/test-cmd.rb#readme"
-  gem.version = "0.11.1"
+  gem.version = "0.12.1"
   gem.required_ruby_version = ">= 3.0"
   gem.licenses = ["0BSD"]
   gem.files = `git ls-files`.split($/)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-cmd.rb
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.1
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-17 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -99,8 +99,8 @@ files:
 - lib/test-cmd.rb
 - lib/test/cmd.rb
 - test-cmd.rb.gemspec
+- test/cmd_test.rb
 - test/setup.rb
-- test/test_cmd_test.rb
 homepage: https://github.com/0x1eef/test-cmd.rb#readme
 licenses:
 - 0BSD