test-cmd.rb 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6c0bc0c0b5e20d51b2455762362ee54301e95c6171a6427dbdf6ea85acdc834
-  data.tar.gz: 9bcbbe35149e54547b7e01a678de58a068e4a35a0728d454fa613f26d2d9c3ee
+  metadata.gz: 92d0cf20a1d63472f4ac178bcb7b74b05d2e5875fe05bccb56f9decbcccd691a
+  data.tar.gz: '0318fb0281b874accf7f44c6f4a3c2320d3aa4a3405829a36430347f8d65a9c4'
 SHA512:
-  metadata.gz: ec35ba65fefe5c978fe9d467d90f1c9719a984078f2bafb22f1a9e1757ca322533ee99c7f77d4268bbb051986230685058da3da88ca2674567b264d915b5f97b
-  data.tar.gz: 517746b21cb1edd44a3d96216ae3b842b88acec38c6b3fad389d3748ef8cacc241f4baf205aa1fe285a2aea92c5775e359a04d6fd89f5f9f2e205a7e13784bf8
+  metadata.gz: 4daa335326b92120051a40666c07d8b731f447b45e01a73bc5e1cbb2eac65d53e4e4bb87d3ded462b6375b86e85bbe15419d1b8e64642c5f1a60659427456401
+  data.tar.gz: '0859457b884abaafc8ea53ecc2fd238c4c111b2f6175f177d85ab48b1378de7bc81556160a06433ba900e59d0513b7e910e060944f99fb7d8db6b57182e5e15f'

data/README.md

@@ -36,14 +36,35 @@ A command is created with
 which takes the name or path of a command, and given additional
 arguments with
 [`Test::Command#argv`](https://r.uby.dev/api-docs/test-cmd.rb/Test/Command.html#argv-instance_method).
+Environment variables can be set for the spawned process with
+[`Test::Command#env`](https://r.uby.dev/api-docs/test-cmd.rb/Test/Command.html#env-instance_method).
 The instance has access to the command's process ID, exit status,
 standard output stream, and standard error stream.
 
 ```ruby
 require "test-cmd"
-Test::Command.new("ls").argv("-l").stdout
+puts Test::Command.new("ls").argv("-l").stdout
+puts Test::Command.new("env").env("FOO" => "bar").stdout
 ```
 
+<details>
+<summary>Environment</summary>
+<br>
+
+Environment variables for the spawned process are set with
+[`Test::Command#env`](https://r.uby.dev/api-docs/test-cmd.rb/Test/Command.html#env-instance_method),
+which merges the given variables into the child's environment and
+returns the command for chaining.
+
+```ruby
+require "test-cmd"
+puts Test::Command
+  .new("ruby", "-e", "puts ENV['FOO']")
+  .env("FOO" => "42")
+  .stdout  # => "42\n"
+```
+</details>
+
 <details>
 <summary>Callbacks</summary>
 <br>

data/lib/test/cmd.rb

@@ -26,6 +26,7 @@ class Test::Command
   def initialize(cmd, *argv)
     @cmd = cmd
     @argv = argv.dup
+    @env = {}
     @status = nil
     @spawned = false
     @stdout = ""
@@ -41,6 +42,14 @@ class Test::Command
     tap { @argv.concat(argv) }
   end
 
+  ##
+  # @param [Hash{String => String}] env
+  #  Environment variables to set for the spawned command
+  # @return [Test::Command]
+  def env(env)
+    tap { @env.merge!(env) }
+  end
+
   ##
   # Spawns a command
   # @return [Test::Command]
@@ -57,6 +66,7 @@ class Test::Command
       # streams with whole-buffer reads rather than a byte at
       # a time.
       @pid = Process.spawn(
+        @env,
         @cmd, *@argv,
         {out: @out.w, err: @err.w, in: IO::NULL}
       )

data/test/cmd_test.rb

@@ -21,6 +21,17 @@ class Test::Command
     end
   end
 
+  ##
+  # Test::Command#env
+  class EnvTest < Test
+    def test_ruby_env
+      assert_equal "42\n",
+                   ::Test::Command.new("ruby", "-e", "puts ENV['FOO']")
+                     .env("FOO" => "42")
+                     .stdout
+    end
+  end
+
   ##
   # Test::Command#{exit_status, status, success?}
   class ExitStatusTest < Test

data/test-cmd.rb.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.authors = ["robert"]
   gem.email = ["robert@r.uby.dev"]
   gem.homepage = "https://github.com/0x1eef/test-cmd.rb#readme"
-  gem.version = "2.0.0"
+  gem.version = "2.1.0"
   gem.required_ruby_version = ">= 3.0"
   gem.licenses = ["0BSD"]
   gem.files = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test-cmd.rb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - robert