test-cmd.rb 0.10.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 809adac1c621abbe0f30ba697594c4fe2bf931169b5f5bebdc833c5153e840cd
-  data.tar.gz: 6882e65bd6fa276500285b2f735158506458c19509fa0278fc42410fb1ade2da
+  metadata.gz: 82a43ee0666fd9baea96c1974997092b1a739f730327e0a30ffa5d2e5b48cdaa
+  data.tar.gz: 2ca5079265f236de839baa8c6731433f99a9b0650c60e7c122db03c2b1a5e7bc
 SHA512:
-  metadata.gz: d7f8f2757c6eb96e0b27fae6d59ce8e39b2c7d34e865b25a07e02871a8a4116b08ce78513757fc561a8cd356e6b3e25c04b60ec7a54de347de2dbad251a402e6
-  data.tar.gz: 827b850156e8b11cc38b625c93c3760037dcee47514a0a21761c5d4d9a64f89d2a2b834f2c001f24a7a46e8282cce1a862ed6d336e90736dad722a41ed3c0d56
+  metadata.gz: 4a6ec40cdce6d791ca2e4880cd6bc31af6151706bb92dd467c0d2b99ce3551e2dd13efd2ecea46d32c2e2feb30995466ade1b16529e93d52e2321b2b29233788
+  data.tar.gz: 3b286a1f7e87e1066837b4a6c5f61421409637becb71792ab06919b5b7620759bd0f6b036e6694cc1f18e14144733bdefb117bd98a61f2c66a4b9f540661f52d

data/README.md

@@ -1,7 +1,7 @@
 ## About
 
 test-cmd.rb provides an object-oriented interface for spawning
-a process.
+a command.
 
 ## Examples
 
@@ -13,7 +13,7 @@ is passed an instance of
 [Test::Cmd](https://0x1eef.github.io/x/test-cmd.rb/Test/Cmd.html):
 
 ``` ruby
-require "test/cmd"
+require "test-cmd"
 cmd("ruby", "-e", "exit 0")
   .success { print "The command [#{_1.pid}] was successful", "\n" }
   .failure { print "The command [#{_1.pid}] was unsuccessful", "\n" }
@@ -23,7 +23,7 @@ cmd("ruby", "-e", "exit 0")
 
 The following example demonstrates how tests might be written with
 test-unit from the standard library. The
-[`cmd`](https://0x1eef.github.io/x/test-cmd.rb/Test/CmdMixin.html#cmd-instance_method)
+[`cmd`](https://0x1eef.github.io/x/test-cmd.rb/Kernel.html#cmd-instance_method)
 method takes the name or path of a command, alongside any arguments:
 
 ```ruby
@@ -32,19 +32,25 @@ require "test/cmd"
 
 class CmdTest < Test::Unit::TestCase
   def test_ruby_stdout
-    assert_equal "42\n", cmd("ruby", "-e", "puts 42").stdout
+    assert_equal "42\n", ruby("puts 42").stdout
   end
 
   def test_ruby_stderr
-    assert_equal "42\n", cmd("ruby", "-e", "warn 42").stderr
+    assert_equal "42\n", ruby("warn 42").stderr
   end
 
   def test_ruby_success_exit_status
-    assert_equal 0, cmd("ruby", "-e", "exit 0").exit_status
+    assert_equal 0, ruby("exit 0").exit_status
   end
 
   def test_ruby_failure_exit_status
-    assert_equal 1, cmd("ruby", "-e", "exit 1").exit_status
+    assert_equal 1, ruby("exit 1").exit_status
+  end
+
+  private
+
+  def ruby(code)
+    cmd("ruby", "-e", code)
   end
 end
 ```
@@ -92,7 +98,7 @@ p cmd("ruby", "test.rb").stdout # => "foo\nbar\n"
 ## Documentation
 
 A complete API reference is available at
-[0x1eef.github.io/x/test-cmd.rb](https://0x1eef.github.io/x/test-cmd.rb).
+[0x1eef.github.io/x/test-cmd.rb](https://0x1eef.github.io/x/test-cmd.rb)
 
 ## Install
 
@@ -109,6 +115,6 @@ test-cmd.rb can be installed via rubygems.org:
 
 ## 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/test/cmd.rb

@@ -6,6 +6,7 @@ end unless defined?(Test)
 # for spawning a command.
 class Test::Cmd
   require "tempfile"
+  require "securerandom"
 
   ##
   # @param [String] cmd
@@ -40,6 +41,8 @@ class Test::Cmd
       Process.spawn(@cmd, *@argv, {out: @out_io, err: @err_io})
       Process.wait
       @status = $?
+    ensure
+      [stdout, stderr]
     end
   end
 
@@ -50,6 +53,8 @@ class Test::Cmd
     @stdout ||= begin
       spawn
       out_io.tap(&:rewind).read.tap { out_io.close }
+    rescue IOError
+      @stdout
     end
   end
 
@@ -60,6 +65,8 @@ class Test::Cmd
     @stderr ||= begin
       spawn
       err_io.tap(&:rewind).read.tap { err_io.close }
+    rescue IOError
+      @stderr
     end
   end
 
@@ -124,19 +131,32 @@ class Test::Cmd
     end
   end
 
+  ##
+  # @return [Boolean]
+  #  Returns true when a command has been spawned
+  def spawned?
+    @spawned
+  end
+
   private
 
   attr_reader :out_io, :err_io
 
   def spawn_io
     [
-      %W[#{object_id} testcmd.out],
-      %W[#{object_id} testcmd.err]
-    ].map {
-      file = Tempfile.new(_1)
-      File.chmod(0, file.path)
-      file.tap(&:unlink)
-    }
+      [".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
 

data/test/test_cmd_test.rb

@@ -1,47 +1,55 @@
 require_relative "setup"
 
-class CmdTest < Test::Unit::TestCase
-  def test_ruby_stdout
-    assert_equal "42\n", cmd("ruby", "-e", "puts 42").stdout
+class Test::Cmd
+  class Test < Test::Unit::TestCase
+    private
+    def ruby(str)
+      cmd "ruby", "-e", str
+    end
   end
+end
 
-  def test_ruby_stderr
-    assert_equal "42\n", cmd("ruby", "-e", "warn 42").stderr
+class Test::Cmd
+  ##
+  # Test::Cmd#argv
+  class ARGVTest < Test
+    def test_ruby_argv
+      assert_equal "42\n", cmd("ruby")
+                             .argv("-e", "warn 42")
+                             .stderr
+    end
   end
 
-  def test_ruby_success_exit_status
-    assert_equal 0, cmd("ruby", "-e", "exit 0").exit_status
-  end
+  ##
+  # Test::Cmd#{exit_status, status, success?}
+  class ExitStatusTest < Test
+    def test_ruby_exit_status_success
+      assert_equal 0, ruby("exit 0").exit_status
+    end
 
-  def test_ruby_failure_exit_status
-    assert_equal 1, cmd("ruby", "-e", "exit 1").exit_status
-  end
+    def test_ruby_exit_status_failure
+      assert_equal 1, ruby("exit 1").exit_status
+    end
 
-  def test_ruby_success_status
-    assert_equal true, cmd("ruby", "-e", "exit 0").status.success?
-    assert_equal true, cmd("ruby", "-e", "exit 0").success?
+    def test_ruby_exit_status_predicates
+      assert_equal true, ruby("exit 0").status.success?
+      assert_equal true, ruby("exit 0").success?
+    end
   end
 
-  def test_ruby_success_callback
-    call_ok, call_fail = [false, false]
-    cmd("ruby", "-e", "exit 0")
-      .success { call_ok = true }
-      .failure { call_fail = true }
-    assert_equal true, call_ok
-    assert_equal false, call_fail
-  end
+  ##
+  # Test::Cmd#{stdout,stderr}
+  class OutputTest < Test
+    def test_ruby_stdout
+      assert_equal "42\n", ruby("puts 42").stdout
+    end
 
-  def test_ruby_failure_callback
-    call_ok, call_fail = [false, false]
-    cmd("ruby", "-e", "exit 1")
-      .success { call_ok = true }
-      .failure { call_fail = true }
-    assert_equal true, call_fail
-    assert_equal false, call_ok
-  end
+    def test_ruby_stderr
+      assert_equal "42\n", ruby("warn 42").stderr
+    end
 
-  def test_stdout_with_fork
-    code = <<-CODE.each_line.map { _1.chomp.strip }.join(";")
+    def test_ruby_stdout_fork
+      code = <<-CODE.each_line.map { _1.chomp.strip }.join(";")
       $stdout.sync = true
       fork do
         sleep(1)
@@ -50,12 +58,64 @@ class CmdTest < Test::Unit::TestCase
       puts "foo"
       Process.wait
     CODE
-    assert_equal "foo\nbar\n", cmd("ruby", "-e", code).stdout
+      assert_equal "foo\nbar\n", ruby(code).stdout
+    end
+  end
+
+  ##
+  # Test::Cmd#{success, failure}
+  class CallbackTest < Test
+    def test_ruby_success_callback
+      call_ok, call_fail = [false, false]
+      ruby("exit 0")
+        .success { call_ok = true }
+        .failure { call_fail = true }
+      assert_equal true, call_ok
+      assert_equal false, call_fail
+    end
+
+    def test_ruby_failure_callback
+      call_ok, call_fail = [false, false]
+      ruby("exit 1")
+        .success { call_ok = true }
+        .failure { call_fail = true }
+      assert_equal true, call_fail
+      assert_equal false, call_ok
+    end
   end
 
-  def test_cmd_with_argv
-    assert_equal "42\n", cmd("ruby")
-                           .argv("-e", "warn 42")
-                           .stderr
+  ##
+  # 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
+    def test_spawned_before_spawn
+      assert_equal false, ruby("puts 42").spawned?
+    end
+
+    def test_spawned_after_spawn
+      assert_equal true, ruby("puts 42").tap(&:spawn).spawned?
+    end
   end
 end

data/test-cmd.rb.gemspec

@@ -5,12 +5,12 @@ 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.10.0"
+  gem.version = "0.11.1"
   gem.required_ruby_version = ">= 3.0"
   gem.licenses = ["0BSD"]
   gem.files = `git ls-files`.split($/)
   gem.require_paths = ["lib"]
-  gem.summary = "An object-oriented interface for spawning a process"
+  gem.summary = "An object-oriented interface for spawning a command"
   gem.metadata = { "documentation_uri" => "https://0x1eef.github.io/x/test-cmd.rb/" }
   gem.description = gem.summary
   gem.add_development_dependency "test-unit", "~> 3.5.7"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-cmd.rb
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.1
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-15 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.1'
-description: An object-oriented interface for spawning a process
+description: An object-oriented interface for spawning a command
 email:
 - 0x1eef@protonmail.com
 executables: []
@@ -124,5 +124,5 @@ requirements: []
 rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: An object-oriented interface for spawning a process
+summary: An object-oriented interface for spawning a command
 test_files: []