test-cmd.rb 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dff5c9ec06745d82889cd41c9e6577984c0ed1c92b58b1d69db24abb63bbed8
-  data.tar.gz: 705f57c755ac6b5c9f586fd71b8af263dc36ed4b75cb36b86dc776c4612556f0
+  metadata.gz: 031f9708015f5e2e10d4b9afe09db3841c2a7c8ffa9ee83717d12ff4e078cd02
+  data.tar.gz: e1afc91430c82bfb3e146ea3b3a8a58c9fdb047b4c25c2be7b62d2b1470fd694
 SHA512:
-  metadata.gz: c9c84f22a646b7890dcd68e3c9b45e5cd7a0e33807dd1bc05991bfda9b9573d555af9e4060a2fab9edaf73d4822b7e2c4cc4d29aa4d8a1fc08221177b54237bc
-  data.tar.gz: f5b2359e1b359fa3e96d8fa558664d082a8226ec8d07758432ce337779f999094ac20cf61408867ea099aab32bff9eafd63766f1dc9c8887b93f062c81ed6512
+  metadata.gz: 599e9bd0599c675f58b742e556b60c0d475b3a8fbe50012eddcc633eb1f09492791e88f0fbc7161a63172b96df1268a80304cd1b6dbb738ddd06d48ce9ad30ed
+  data.tar.gz: acc8485e9f6fde4c25e80dd354933f5750804fe0f066054b2e4cea3c4093a2020df28d86ab7f055766466658d3a69d6a53d89699bb6f0d3652b3cdd8f46eec3d

data/README.md

@@ -1,11 +1,7 @@
 ## About
 
 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.
+(both stdout and stderr) of a spawned process.
 
 ## Examples
 
@@ -53,7 +49,7 @@ require "test/cmd"
 str = cmd("du")
       .arg("-s").arg("-h")
       .spawn.stdout
-puts str      
+puts str
 ```
 
 ### IO#sync
@@ -96,30 +92,24 @@ Process.wait(pid)
 p cmd("ruby test.rb").stdout # => "foo\nbar\n"
 ```
 
-## Sources
+## Documentation
 
-* [Source code (GitHub)](https://github.com/0x1eef/test-cmd.rb#readme)
-* [Source code (GitLab)](https://gitlab.com/0x1eef/test-cmd.rb#about)
+A complete API reference is available at 
+[0x1eef.github.io/x/test-cmd.rb](https://0x1eef.github.io/x/test-cmd.rb).
 
 ## Install
 
-test-cmd.rb is distributed as a RubyGem through its git repositories. <br>
-[GitHub](https://github.com/0x1eef/test-cmd.rb),
-and
-[GitLab](https://gitlab.com/0x1eef/test-cmd.rb)
-are available as sources.
-
-``` ruby
-# Gemfile
-gem "test-cmd.rb", github: "0x1eef/test-cmd.rb", tag: "v0.5.1"
-```
-
 **Rubygems.org**
 
-test-cmd.rb can also be installed via rubygems.org.
+test-cmd.rb can be installed via rubygems.org.
 
     gem install test-cmd.rb
 
+## Sources
+
+* [GitHub](https://github.com/0x1eef/test-cmd.rb#readme)
+* [GitLab](https://gitlab.com/0x1eef/test-cmd.rb#about)
+
 ## License
 
 [BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).

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

@@ -3,11 +3,7 @@ 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.
+# (both stdout and stderr) of a spawned process.
 class Test::Cmd
   require "tempfile"
 
@@ -20,8 +16,8 @@ class 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)
+    @out = unlink!(Tempfile.new("cmd-stdout"))
+    @err = unlink!(Tempfile.new("cmd-stderr"))
     @status = nil
     @spawned = false
   end
@@ -105,9 +101,20 @@ class Test::Cmd
     io = @status.success? ? @stdout : @stderr
     io.each_line.each { yield(_1.chomp) }
   end
+
+  private
+
+  ##
+  # @api private
+  def unlink!(file)
+    file.tap do
+      File.chmod(0, file.path)
+      file.unlink
+    end
+  end
 end
 
-module Test::CmdMixin
+module Test::Cmd::Mixin
   ##
   # @param [String] cmd
   #  A command to execute
@@ -121,5 +128,5 @@ module Test::CmdMixin
 end
 
 module Kernel
-  include Test::CmdMixin
+  include Test::Cmd::Mixin
 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.1"
+  gem.version = "0.6.0"
   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.1
+  version: 0.6.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-03-17 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