test-cmd.rb 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a40537381e81f677332c21cfbc95b997fe0f89a4cbf4c714e2eb857da496554
-  data.tar.gz: 88ceffc1c05ed2b90f79c39c73c6a95adc5ccd9bce97ff435dea3dbea07feb89
+  metadata.gz: 6cce30514a659d318e574a7a8c13de222c8632a4ab944847821195fe512e133a
+  data.tar.gz: d5a12184b17454efa414a380006c6f240e6747e13220d3b28940c6cf79e7df33
 SHA512:
-  metadata.gz: 362b5b2155218c63f01321c279ebb5a7cd204fbdb01af2e76ce3d767d30c4b3a13c2a2eec52de77f7bb80419d37f7fdadb44ce1c3fb97e42d708d916a0eedfa1
-  data.tar.gz: 055f87c0d765be7ec2612ba9ae3e0f49cdaf2458eac747c8399b8b57dda732dca20d4848d9cc6809393fb3dfbd295cf2d55aec50eee9fbec7f8a63d37ef8a466
+  metadata.gz: e5d88ccede58e0d3f23d226481291aa7c97d64ca1a18ab3d620dee57fbf6590f2e0da1cb62962e8ac328a6a91d80b87d7a525136893e55f5ab9c583e6eda81dc
+  data.tar.gz: 6190123fe4136ca820e3c1241a32927ee72be094024abb49d0aaa15be9c6955bccdcc396029b2e035629712bd31a8bc5e221dd9db311422e459ea3a2a253da0e

data/.rubocop.yml

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

data/README.md

@@ -47,8 +47,8 @@ covers it in more-depth:
 ``` ruby
 require "test/cmd"
 puts cmd("du")
-       .args("-s", "-h")
-       .stdout
+     .argv("-s", "-h")
+     .stdout
 ```
 
 ### IO#sync
@@ -100,7 +100,7 @@ A complete API reference is available at
 
 **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,94 @@
 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 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 exit status of a process
+  def exit_status
+    status.exitstatus
+  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,119 +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 [String, #to_s] arg
-  #  A command-line argument.
-  # @return [Test::Cmd]
-  def arg(arg)
-    tap do
-      @argv.push(arg)
-    end
-  end
-
-  ##
-  # @param [Array<String, #to_s>] argv
-  #  One or more command-line arguments.
-  # @return [Test::Cmd]
-  def args(*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)
@@ -121,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,10 @@ 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_stdout_with_fork
     code = <<-CODE.each_line.map { _1.chomp.strip }.join(";")
       $stdout.sync = true
@@ -30,28 +34,9 @@ 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
+  def test_cmd_with_argv
+    assert_equal "42\n", cmd("ruby")
+                           .argv("-e", "warn 42")
+                           .stderr
   end
 end

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.7.0"
+  gem.version = "0.9.0"
   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.7.0
+  version: 0.9.0
 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
@@ -121,7 +121,7 @@ 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.