test-cmd.rb 0.9.0 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cce30514a659d318e574a7a8c13de222c8632a4ab944847821195fe512e133a
-  data.tar.gz: d5a12184b17454efa414a380006c6f240e6747e13220d3b28940c6cf79e7df33
+  metadata.gz: 7e5bf49f40fdbefaea05fb598e7e9fa5a12faeb72e90e8794b0a6b9366dfa8a0
+  data.tar.gz: 1b19f3a1df91a354717cc6c7862762f5ddadf72392b3bd71018ee41673accd0d
 SHA512:
-  metadata.gz: e5d88ccede58e0d3f23d226481291aa7c97d64ca1a18ab3d620dee57fbf6590f2e0da1cb62962e8ac328a6a91d80b87d7a525136893e55f5ab9c583e6eda81dc
-  data.tar.gz: 6190123fe4136ca820e3c1241a32927ee72be094024abb49d0aaa15be9c6955bccdcc396029b2e035629712bd31a8bc5e221dd9db311422e459ea3a2a253da0e
+  metadata.gz: 28a8899a6f9f9bf941a171ced9ae694b57762eb4c24608f9243ec61dc2a17b367566baeaae9de60280af70f75ef9b0a75e08359895f6b69b37f3eda844ad30e1
+  data.tar.gz: 5d87dcebab3b423c19b4d00b90bf447aad83033b71e74e47aff5fd2c904a7289eb5890c42175df0ee35a4c29f6eb2746e9db8d7220b397b13591dc8f67d6e70b

data/README.md

@@ -1,10 +1,24 @@
 ## About
 
-test-cmd.rb provides an object-oriented interface for spawning 
+test-cmd.rb provides an object-oriented interface for spawning
 a process.
 
 ## Examples
 
+### Callbacks
+
+The success and failure callbacks provide hooks for when
+a command exits successfully or unsuccessfully. The callback
+is passed an instance of
+[Test::Cmd](https://0x1eef.github.io/x/test-cmd.rb/Test/Cmd.html):
+
+``` ruby
+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" }
+```
+
 ### Test::Unit
 
 The following example demonstrates how tests might be written with
@@ -35,22 +49,6 @@ class CmdTest < Test::Unit::TestCase
 end
 ```
 
-### Builder
-
-test-cmd.rb provides an API that is similar to Rust's
-[Command API](https://doc.rust-lang.org/std/process/struct.Command.html).
-<br>
-The
-[API reference](https://0x1eef.github.io/x/test-cmd.rb)
-covers it in more-depth:
-
-``` ruby
-require "test/cmd"
-puts cmd("du")
-     .argv("-s", "-h")
-     .stdout
-```
-
 ### IO#sync
 
 Sometimes it can be neccessary to bypass Ruby's internal buffer and flush
@@ -61,12 +59,12 @@ results. Consider the following example, where the output will be
 ``` ruby
 ##
 # test.rb
-pid = fork do
+fork do
   sleep(1)
   puts "bar"
 end
 puts "foo"
-Process.wait(pid)
+Process.wait
 
 ##
 # cmd.rb
@@ -79,12 +77,12 @@ And with output flushed to the operating system immediately:
 ##
 # test.rb
 $stdout.sync = true
-pid = fork do
+fork do
   sleep(1)
   puts "bar"
 end
 puts "foo"
-Process.wait(pid)
+Process.wait
 
 ##
 # cmd.rb
@@ -93,7 +91,7 @@ p cmd("ruby", "test.rb").stdout # => "foo\nbar\n"
 
 ## Documentation
 
-A complete API reference is available at 
+A complete API reference is available at
 [0x1eef.github.io/x/test-cmd.rb](https://0x1eef.github.io/x/test-cmd.rb).
 
 ## Install

data/lib/test/cmd.rb

@@ -31,7 +31,7 @@ class Test::Cmd
   # Spawns a command
   # @return [Test::Cmd]
   def spawn
-    return if @spawned
+    return self if @spawned
 
     tap do
       @spawned = true
@@ -70,6 +70,13 @@ class Test::Cmd
     @status
   end
 
+  ##
+  # @return [Integer]
+  #  Returns the process ID of a spawned command
+  def pid
+    status.pid
+  end
+
   ##
   # @return [Integer]
   #  Returns the exit status of a process
@@ -77,6 +84,45 @@ class Test::Cmd
     status.exitstatus
   end
 
+  ##
+  # @return [Boolean]
+  #  Returns true when a command exited successfully
+  def success?
+    status.success?
+  end
+
+  ##
+  # Yields an instance of {Test::Cmd Test::Cmd}.
+  #
+  # @example
+  #   cmd("ruby", "-e", "exit 0")
+  #     .success { print "Command [#{_1.pid}] exited successfully", "\n" }
+  #     .failure { }
+  #
+  # @return [Test::Cmd]
+  def success
+    tap do
+      spawn
+      status.success? ? yield(self) : nil
+    end
+  end
+
+  ##
+  # Yields an instance of {Test::Cmd Test::Cmd}.
+  #
+  # @example
+  #   cmd("ruby", "-e", "exit 1")
+  #     .success { }
+  #     .failure { print "Command [#{_1.pid}] exited unsuccessfully", "\n" }
+  #
+  # @return [Test::Cmd]
+  def failure
+    tap do
+      spawn
+      status.success? ? nil : yield(self)
+    end
+  end
+
   private
 
   attr_reader :out_io, :err_io

data/test/test_cmd_test.rb

@@ -19,17 +19,36 @@ class CmdTest < Test::Unit::TestCase
 
   def test_ruby_success_status
     assert_equal true, cmd("ruby", "-e", "exit 0").status.success?
+    assert_equal true, cmd("ruby", "-e", "exit 0").success?
+  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
+
+  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_stdout_with_fork
     code = <<-CODE.each_line.map { _1.chomp.strip }.join(";")
       $stdout.sync = true
-      pid = fork do
+      fork do
         sleep(1)
         puts "bar"
       end
       puts "foo"
-      Process.wait(pid)
+      Process.wait
     CODE
     assert_equal "foo\nbar\n", cmd("ruby", "-e", code).stdout
   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.9.0"
+  gem.version = "0.9.3"
   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 process"
   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.9.0
+  version: 0.9.3
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-12 00:00:00.000000000 Z
+date: 2024-05-13 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 process
 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 process
 test_files: []