test-cmd.rb 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9c8ce3140a3961899e285245cbd7d6ceee4caf38508b268ba5500388bfa1aa8
-  data.tar.gz: 907ef5b303a8edfbdcb79930a40274c6976c79a9f78f5754c456adcff745f1e8
+  metadata.gz: c2396593840d674fad470e2e4fcb0f0fc74e55987fe5caec27128457b0608453
+  data.tar.gz: 3b6c43870258be5d3c0a1039e5e8436bff314ea05c03dab2866593dafbf43591
 SHA512:
-  metadata.gz: 03ab91c5888319ad5d6beb8ab45eac1d4749ba39607e09e5d7866af08027dced706b428c6dd80d077ac53ed4536c594068d87394ffdaaf3c0528d11c5fc690fb
-  data.tar.gz: eba0d96c1277ab435d51a2a8ce21c6269d98527224d15982a9ed3c967df56e820285b964fe8a984b9ceb6ec1cb468098777c733a220564be0c25399e6e190211
+  metadata.gz: edb9931271bfc62a1c22be0717659fa83a670652b97ef7ebe74fe98e2605b21fc4c87647c75aa20c4913a8a76e6bd1d3de7a3d28fe74f75d800293844c2b442e
+  data.tar.gz: 3f95d41e84bb4ddf323798dee95e33872e72ff32869f3c1d82f629c00e1b15e840fd93b504f5fd15c7cfa4aa4dd280da172f7edeffd017ec3b486ce7dd2d8ea3

data/README.md

@@ -111,7 +111,7 @@ are available as sources.
 
 ``` ruby
 # Gemfile
-gem "test-cmd.rb", github: "0x1eef/test-cmd.rb", tag: "v0.5.0"
+gem "test-cmd.rb", github: "0x1eef/test-cmd.rb", tag: "v0.5.2"
 ```
 
 **Rubygems.org**

data/Rakefile.rb

@@ -0,0 +1,9 @@
+require "bundler/setup"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+  t.warning = false
+end
+task default: :test

data/lib/test-cmd.rb

@@ -1,121 +1,133 @@
 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. The library was
+# first realized in a test environment, where it provided a path
+# for verifying that when code examples are run they produce the
+# expected output. The library can be generally useful outside a
+# test environment, too.
+class Test::Cmd
+  require "tempfile"
+
   ##
-  # test-cmd.rb is a library for accessing the output streams
-  # (both stdout and stderr) of a spawned process. The library was
-  # first realized in a test environment, where it provided a path
-  # for verifying that when code examples are run they produce the
-  # expected output. The library can be generally useful outside a
-  # test environment, too.
-  class Test::Cmd
-    require "tempfile"
+  # @param [String] cmd
+  #  A command to spawn.
+  # @param [Array<String>] args
+  #  An array of command-line arguments.
+  # @return [Test::Cmd]
+  def initialize(cmd, args = [])
+    @cmd = cmd
+    @args = args.dup
+    @out = unlink!(Tempfile.new("cmd-stdout"))
+    @err = unlink!(Tempfile.new("cmd-stderr"))
+    @status = nil
+    @spawned = false
+  end
 
-    ##
-    # @param [String] cmd
-    #  A command to spawn.
-    # @param [Array<String>] args
-    #  An array of command-line arguments.
-    # @return [Test::Cmd]
-    def initialize(cmd, args = [])
-      @cmd = cmd
-      @args = args.dup
-      @out = Tempfile.new("cmd-stdout").tap(&:unlink)
-      @err = Tempfile.new("cmd-stderr").tap(&:unlink)
-      @status = nil
-      @spawned = false
+  ##
+  # @param [String, #to_s] arg
+  #  A command-line argument.
+  # @return [Test::Cmd]
+  def arg(arg)
+    tap do
+      @args.push(arg)
     end
+  end
 
-    ##
-    # @param [String, #to_s] arg
-    #  A command-line argument.
-    # @return [Test::Cmd]
-    def arg(arg)
-      tap do
-        @args.push(arg)
-      end
+  ##
+  # @param [Array<String, #to_s>] args
+  #  One or more command-line arguments.
+  # @return [Test::Cmd]
+  def args(*args)
+    tap do
+      @args.concat(args)
     end
+  end
 
-    ##
-    # @param [Array<String, #to_s>] args
-    #  One or more command-line arguments.
-    # @return [Test::Cmd]
-    def args(*args)
-      tap do
-        @args.concat(args)
-      end
+  ##
+  # Spawns a command.
+  # @return [Test::Cmd]
+  def spawn
+    tap do
+      @spawned = true
+      Process.wait Process.spawn(@cmd, *@args, {out: @out, err: @err})
+      @status = $?
     end
+  ensure
+    [stdout,stderr]
+  end
 
-    ##
-    # Spawns a command.
-    # @return [Test::Cmd]
-    def spawn
-      tap do
-        @spawned = true
-        Process.wait Process.spawn(@cmd, *@args, {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 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 [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 [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
 
-    ##
-    # @return [Integer]
-    #  Returns the exit status of a process
-    def exit_status
-      status.exitstatus
-    end
+  ##
+  # Yields each line of stdout when the command
+  # was successful, or each line of stderr when
+  # the command was not successful.
+  # @return [Enumerator]
+  #  Returns an Enumerator when a block is not given.
+  def each_line
+    return enum_for(:each_line) unless block_given?
+    spawn unless @spawned
+    io = @status.success? ? @stdout : @stderr
+    io.each_line.each { yield(_1.chomp) }
+  end
 
-    ##
-    # Yields each line of stdout when the command
-    # was successful, or each line of stderr when
-    # the command was not successful.
-    # @return [Enumerator]
-    #  Returns an Enumerator when a block is not given.
-    def each_line
-      return enum_for(:each_line) unless block_given?
-      spawn unless @spawned
-      io = @status.success? ? @stdout : @stderr
-      io.each_line.each { yield(_1.chomp) }
+  private
+
+  ##
+  # @api private
+  def unlink!(file)
+    file.tap do
+      File.chmod(0000, file.path)
+      file.unlink
     end
   end
+end
 
-  module CmdMixin
-    ##
-    # @param [String] cmd
-    #  A command to execute
-    # @param [Array<String>] args
-    #  An array of command-line arguments.
-    # @return [Test::Cmd]
-    #  Returns an instance of {Test::Cmd Test::Cmd}
-    def cmd(cmd, args = [])
-      Test::Cmd.new(cmd, args)
-    end
+module Test::CmdMixin
+  ##
+  # @param [String] cmd
+  #  A command to execute
+  # @param [Array<String>] args
+  #  An array of command-line arguments.
+  # @return [Test::Cmd]
+  #  Returns an instance of {Test::Cmd Test::Cmd}
+  def cmd(cmd, args = [])
+    Test::Cmd.new(cmd, args)
   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.5.0"
+  gem.version = "0.5.2"
   gem.required_ruby_version = ">= 3.0"
   gem.licenses = ["0BSD"]
   gem.files = `git ls-files`.split($/)
@@ -18,4 +18,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "yard", "~> 0.9"
   gem.add_development_dependency "redcarpet", "~> 3.5"
   gem.add_development_dependency "standard", "~> 1.24"
+  gem.add_development_dependency "rake", "~> 13.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-cmd.rb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
 description: test-cmd.rb provides access to the output streams (both stdout and stderr)
   of a spawned process.
 email:
@@ -82,6 +96,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile.rb
 - lib/test-cmd.rb
 - lib/test/cmd.rb
 - test-cmd.rb.gemspec