test-cmd.rb 0.8.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3271a0fc385b5c2ec050a4295cfd9c67b662dca479a1e5c197610fb0f773fb8b
-  data.tar.gz: da1a24b436cfde2e63a6fccdaf6ac5d597f180f10b578319549713e64992a095
+  metadata.gz: 3d07ddf04e4a028f4c745b1583b0fb54a8d0a66c6545be5ae06a36fe2bed5d44
+  data.tar.gz: fc37608b53d4648fcc580c8845af31a8d423087816fdc862662e6e9dda99d29f
 SHA512:
-  metadata.gz: bf4e1638056aa03ce82db25547efe1ad9c2bbb2ac737a3ec13b9f8c23576c090101b59c19ce7adf554a2b47e9ae16d9fac6439e730c74423a8fe37e317be745d
-  data.tar.gz: 82c83edc676b854ffa3e96930a6d6b6d51e3ab484df093f1919529e5abc9914e6ff0bc65180733ed0434d48fdee15be93bbe5ff7526e422f2ff57e56c061a4c7
+  metadata.gz: b170b84a449b49991d94f902b4d60aa9030f257e3123335e2eb42718b8116ff27200d396738c83cfe38c03eeb762bf07f47887e0508f0a5f88cb4185b4ea7e82
+  data.tar.gz: 07e946aa6b365bfc17e6337eb3c0c7fd773783a8e3b7cdb80dbdf88e91cdfb1550a086d727ea5b14ab350d259c2ad46038ea7683ada3146066dd34cd6d792dc9

data/.rubocop.yml

@@ -17,3 +17,7 @@ AllCops:
 Style/MultilineIfModifier:
   Exclude:
     - 'lib/test-cmd.rb'
+
+Layout/MultilineMethodCallIndentation:
+  Exclude:
+    - 'test/*.rb'

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
@@ -93,14 +91,14 @@ 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
 
 **Rubygems.org**
 
-test-cmd.rb can be installed via rubygems.org.
+test-cmd.rb can be installed via rubygems.org:
 
     gem install test-cmd.rb
 

data/lib/test/cmd.rb

@@ -1 +1,133 @@
 require_relative "../test-cmd"
+
+##
+# test-cmd.rb provides an object oriented interface
+# for spawning a command.
+class Test::Cmd
+  require "tempfile"
+
+  ##
+  # @param [String] cmd
+  #  A command to spawn
+  # @param [Array<String>] argv
+  #  Zero or more command-line arguments
+  # @return [Test::Cmd]
+  def initialize(cmd, *argv)
+    @cmd = cmd
+    @argv = argv.dup
+    @status = nil
+    @spawned = false
+  end
+
+  ##
+  # @param [Array<String, #to_s>] argv
+  #  Command-line arguments
+  # @return [Test::Cmd]
+  def argv(*argv)
+    tap { @argv.concat(argv) }
+  end
+
+  ##
+  # Spawns a command
+  # @return [Test::Cmd]
+  def spawn
+    return self if @spawned
+
+    tap do
+      @spawned = true
+      @out_io, @err_io = spawn_io
+      Process.spawn(@cmd, *@argv, {out: @out_io, err: @err_io})
+      Process.wait
+      @status = $?
+    end
+  end
+
+  ##
+  # @return [String]
+  #  Returns the contents of stdout
+  def stdout
+    @stdout ||= begin
+      spawn
+      out_io.tap(&:rewind).read.tap { out_io.close }
+    end
+  end
+
+  ##
+  # @return [String]
+  #  Returns the contents of stderr
+  def stderr
+    @stderr ||= begin
+      spawn
+      err_io.tap(&:rewind).read.tap { err_io.close }
+    end
+  end
+
+  ##
+  # @return [Process::Status]
+  #  Returns the status of a process
+  def status
+    spawn
+    @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
+  def exit_status
+    status.exitstatus
+  end
+
+  ##
+  # Yields an instance of {Test::Cmd Test::Cmd}.
+  #
+  # @example
+  #   cmd("ruby", "-e", "exit 0")
+  #     .success { print "Command exited successfully: #{_1.exit_status}", "\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 exited unsuccessfully: #{_1.exit_status}", "\n" }
+  #
+  # @return [Test::Cmd]
+  def failure
+    tap do
+      spawn
+      status.success? ? nil : yield(self)
+    end
+  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)
+    }
+  end
+end

data/lib/test-cmd.rb

@@ -1,109 +1,11 @@
 module Test
 end unless defined?(Test)
 
-##
-# test-cmd.rb is a library for accessing the output streams
-# (both stdout and stderr) of a spawned process.
-class Test::Cmd
-  require "tempfile"
-
-  ##
-  # @param [String] cmd
-  #  A command to spawn.
-  # @param [Array<String>] argv
-  #  A variable number of command-line arguments.
-  # @return [Test::Cmd]
-  def initialize(cmd, *argv)
-    @cmd = cmd
-    @argv = argv.dup
-    @out = unlink!(Tempfile.new("cmd-stdout"))
-    @err = unlink!(Tempfile.new("cmd-stderr"))
-    @status = nil
-    @spawned = false
-  end
-
-  ##
-  # @param [Array<String, #to_s>] argv
-  #  One or more command-line arguments.
-  # @return [Test::Cmd]
-  def argv(*argv)
-    tap do
-      @argv.concat(argv)
-    end
-  end
-
-  ##
-  # Spawns a command.
-  # @return [Test::Cmd]
-  def spawn
-    tap do
-      @spawned = true
-      Process.wait Process.spawn(@cmd, *@argv, {out: @out, err: @err})
-      @status = $?
-    end
-  ensure
-    [stdout,stderr]
-  end
-
-  ##
-  # @return [String]
-  #  Returns the contents of stdout.
-  def stdout
-    spawn unless @spawned
-    @stdout ||= @out.tap(&:rewind).read
-  ensure
-    @out.close unless @out.closed?
-  end
-
-  ##
-  # @return [String]
-  #  Returns the contents of stderr.
-  def stderr
-    spawn unless @spawned
-    @stderr ||= @err.tap(&:rewind).read
-  ensure
-    @err.close unless @err.closed?
-  end
-
-  ##
-  # @return [Process::Status]
-  #  Returns the status of a process
-  def status
-    spawn unless @spawned
-    @status
-  end
-
-  ##
-  # @return [Integer]
-  #  Returns the exit status of a process
-  def exit_status
-    status.exitstatus
-  end
-
-  ##
-  # @param [Symbol] io
-  #  The output stream as a Symbol (:stdout, :stderr).
-  # @return [Enumerator]
-  #  Returns an Enumerator when a block is not given.
-  def each_line(io = :stdout)
-    return enum_for(:each_line, io) unless block_given?
-    spawn unless @spawned
-    public_send(io).each_line { yield(_1) }
-  end
-
-  private
-
-  ##
-  # @api private
-  def unlink!(file)
-    file.tap do
-      File.chmod(0, file.path)
-      file.unlink
-    end
-  end
+module Test
+  require_relative "test/cmd"
 end
 
-module Test::Cmd::Mixin
+module Kernel
   ##
   # @param (see Test::Cmd#initialize)
   # @return (see Test::Cmd#initialize)
@@ -111,7 +13,3 @@ module Test::Cmd::Mixin
     Test::Cmd.new(cmd, *argv)
   end
 end
-
-module Kernel
-  include Test::Cmd::Mixin
-end

data/test/test_cmd_test.rb

@@ -17,6 +17,28 @@ class CmdTest < Test::Unit::TestCase
     assert_equal 1, cmd("ruby", "-e", "exit 1").exit_status
   end
 
+  def test_ruby_success_status
+    assert_equal true, cmd("ruby", "-e", "exit 0").status.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
@@ -30,31 +52,6 @@ class CmdTest < Test::Unit::TestCase
     assert_equal "foo\nbar\n", cmd("ruby", "-e", code).stdout
   end
 
-  def test_each_line_stdout
-    run = false
-    cmd("ruby", "-e", "puts 'FooBar'")
-    .each_line do
-      run = true
-      assert_equal "FooBar\n", _1
-    end
-    assert run
-  end
-
-  def test_each_line_stderr
-    run = false
-    cmd("ruby", "-e", "warn 'BarFoo'")
-    .each_line(:stderr) do
-      run = true
-      assert_equal "BarFoo\n", _1
-    end
-    assert run
-  end
-
-  def test_each_line_returns_enum
-    assert_instance_of Enumerator,
-                       cmd("ruby", "-e", "puts 'FooBar'").each_line
-  end
-
   def test_cmd_with_argv
     assert_equal "42\n", cmd("ruby")
                            .argv("-e", "warn 42")

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.8.0"
+  gem.version = "0.9.2"
   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.8.0
+  version: 0.9.2
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-01 00:00:00.000000000 Z
+date: 2024-05-12 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: []
@@ -121,8 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+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: []