test-cmd.rb 2.5.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0790a7e8e68709204aeb42611543db79e3575615d6ed77ee0b166fff7827825
-  data.tar.gz: 7965cd9baf53560ff8648f0652876b3d31a969528b1419b5b975406ec37c13fc
+  metadata.gz: c42ecb86960f6c733054ea3cd7ed041c23accec019f7addb7a2a595020b507bf
+  data.tar.gz: 05fd256aa2c70bb23e8e9ef3e3f8e91eb9bcff9fa2680f48a059960333e74b06
 SHA512:
-  metadata.gz: f0f7c63d381cbbd8c603c8fc7a1c22e7c73509b0a51965107c2fe2c23adf3c2b8cf5f243712b4f297f90aeb0535c01477ddd4518c10be6afd6a29b248c30af18
-  data.tar.gz: aee5d21c5948e17b29f0df43636bb18d396d6919efdc3a0fe6c03628ba85d5f3ae0e04cd03e61e51c33ad30aa88a2e7a840051cc704d3ac384957ea75d6f1cd1
+  metadata.gz: e2c4e2b3858f7b090359a46756a54408d28c729603f0f47ccda5a68c35e2c11dd807dade25cf79d88af938861a112b582d9ecea0198d4b2023ab6fba504ba63d
+  data.tar.gz: 7efb00552507bbbb2b1d66e599ccdd165e7acb3628f5a5e97daa2ec0bdafca5e63ebce274d937a737224836db806a171d4f8bbd07b2195bc092aa529ddacc2d8

data/.github/workflows/specs.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [3.1, 3.2, 3.3]
+        ruby: [3.1, 3.2, 3.3, 4.0]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/README.md

@@ -34,7 +34,6 @@ test-cmd.rb can be installed via rubygems.org:
 
 ### Commands
 
-
 ```ruby
 require "test-cmd"
 
@@ -42,7 +41,7 @@ require "test-cmd"
 # Call the 'ls' command
 p Test::Command
   .new("ls")
-  .argv("-l")
+  .arguments("-l")
   .stdout
 
 ##
@@ -63,11 +62,11 @@ p Test::Command
 
 ##
 # Limit how much data is read from stdout and
-# stderr. At most 20k chars is read from both:
+# stderr. At most 20k bytes is read from both:
 p Test::Command
   .new("git")
+  .arguments("diff", "--cached")
   .limit(stdout: 20_000, stderr: 20_000)
-  .argv("diff", "--cached")
   .stdout
 ```
 
@@ -75,13 +74,35 @@ p Test::Command
 <summary>Environment</summary>
 <br>
 
+A command that is not given an environment inherits the parent's
+environment. When `env` is called, only the variables that are
+given to `env` are set on the spawned process, alongside `$PATH`
+which is always inherited. `$PATH` is inherited so that the
+command can still be found via path lookup.
+
 ```ruby
-require "test-cmd"
+##
+# Inherit the parent's environment. All variables
+# from the parent process are available.
+p Test::Command
+  .new("env")
+  .stdout
 
+##
+# Only $FOO and $BAR are set, plus the inherited
+# $PATH. Everything else is left behind.
+p Test::Command
+  .new("env")
+  .env("FOO" => "42", "BAR" => "7")
+  .stdout
+
+##
+# An empty hash yields only $PATH and the rest of
+# environment is left empty.
 p Test::Command
-  .new("ruby", "-e", "puts ENV['FOO']")
-  .env("FOO" => "42")
-  .stdout  # => "42\n"
+    .new("env")
+    .env({})
+    .stdout
 ```
 </details>
 

data/lib/test/command/version.rb

@@ -4,5 +4,5 @@ end unless defined?(Test)
 class Test::Command
   ##
   # @string [String]
-  VERSION = "2.5.0"
+  VERSION = "2.7.0"
 end

data/lib/test/command.rb

@@ -28,7 +28,7 @@ class Test::Command
   def initialize(cmd, *argv)
     @cmd = cmd
     @argv = argv.dup
-    @env = {}
+    @env = nil
     @status = nil
     @spawned = false
     @stdout = ""
@@ -38,19 +38,20 @@ class Test::Command
   end
 
   ##
-  # @param [Array<String, #to_s>] argv
+  # @param [Array<String, #to_s>] arguments
   #  Command-line arguments
   # @return [Test::Command]
-  def argv(*argv)
-    tap { @argv.concat(argv) }
+  def arguments(*arguments)
+    tap { @argv.concat(arguments) }
   end
+  alias_method :argv, :arguments
 
   ##
   # @param [Hash{String => String}] env
   #  Environment variables to set for the spawned command
   # @return [Test::Command]
   def env(env)
-    tap { @env.merge!(env) }
+    tap { (@env ||= {}).merge!(env) }
   end
 
   ##
@@ -91,7 +92,7 @@ class Test::Command
       @spawned = true
       @out, @err = Pipe.pair, Pipe.pair
       @pid = Process.spawn(
-        @env,
+        envp,
         @cmd, *@argv.map(&:to_s),
         {in: @in_r, out: @out.w, err: @err.w}
       )
@@ -246,6 +247,29 @@ class Test::Command
 
   private
 
+  ##
+  # Builds the environment passed to Process.spawn.
+  # The spawned process receives only the variables
+  # set with #env: every inherited variable is
+  # cleared, so an empty @env spawns with an empty
+  # environment.
+  # @return [Hash{String => String}]
+  def envp
+    if @env.nil?
+      ##
+      # Inherit the parent's environment
+      ENV.to_h
+    else
+      ##
+      # Clear all environment variables except those
+      # that are set by `@env`. Always inherit ${PATH}.
+      envp = ENV.except("PATH")
+                .each_key
+                .to_h { |key| [key, nil] }
+      envp.merge!(@env)
+    end
+  end
+
   ##
   # Reads up to +max+ bytes from a stream, then drains
   # the remainder so a child writing more than the limit

data/test/cmd_test.rb

@@ -7,24 +7,41 @@ class Test::Command
     def ruby(str)
       ::Test::Command.new "ruby", "-e", str
     end
+
+    ##
+    # macos-specific env vars that are always set
+    # @return [String]
+    def macos
+      if ENV["__CF_USER_TEXT_ENCODING"]
+        "__CF_USER_TEXT_ENCODING\n"
+      else
+        ""
+      end
+    end
   end
 end
 
 class Test::Command
   ##
-  # Test::Command#argv
-  class ARGVTest < Test
-    def test_ruby_argv
+  # Test::Command#arguments
+  class ArgumentsTest < Test
+    def test_ruby_arguments
       assert_equal "42\n", ::Test::Command.new("ruby")
-                             .argv("-e", "warn 42")
+                             .arguments("-e", "warn 42")
                              .stderr
     end
 
-    def test_ruby_argv_to_s
+    def test_ruby_arguments_to_s
       arg = Object.new
       def arg.to_s = "-e"
       assert_equal "42\n", ::Test::Command.new("ruby")
-                             .argv(arg, "warn 42")
+                             .arguments(arg, "warn 42")
+                             .stderr
+    end
+
+    def test_ruby_arguments_argv_alias
+      assert_equal "42\n", ::Test::Command.new("ruby")
+                             .argv("-e", "warn 42")
                              .stderr
     end
   end
@@ -38,6 +55,41 @@ class Test::Command
                      .env("FOO" => "42")
                      .stdout
     end
+
+    def test_ruby_env_only_given_keys
+      assert_equal "BAR\nFOO\nPATH\n#{macos}",
+                  ::Test::Command.new("ruby", "-e", "puts ENV.keys.sort")
+                  .env("FOO" => "42", "BAR" => "7")
+                  .stdout
+    end
+
+    def test_ruby_env_empty_is_empty_env
+      assert_equal "PATH\n#{macos}",
+                  ::Test::Command.new("ruby", "-e", "puts ENV.keys.sort")
+                  .env({})
+                  .stdout
+    end
+
+    def test_ruby_env_does_not_leak_inherited
+      assert_equal "true",
+                    ::Test::Command.new("ruby", "-e", "print ENV.key?('PATH')")
+                    .stdout
+    end
+
+    def test_ruby_env_path_carries_over_inherited
+      parent_path = ENV["PATH"]
+      assert_equal parent_path,
+                   ::Test::Command.new("ruby", "-e", "print ENV['PATH']")
+                     .stdout
+    end
+
+    def test_ruby_env_path_carries_over_empty
+      parent_path = ENV["PATH"]
+      assert_equal parent_path,
+                   ::Test::Command.new("ruby", "-e", "print ENV['PATH']")
+                     .env({})
+                     .stdout
+    end
   end
 
   ##

data/test-cmd.rb.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.name = "test-cmd.rb"
   gem.authors = ["Robert Gleeson"]
   gem.email = ["robert@r.uby.dev"]
-  gem.homepage = "https://github.com/0x1eef/test-cmd.rb#readme"
+  gem.homepage = "https://github.com/r-uby-dev/test-cmd.rb#readme"
   gem.version = Test::Command::VERSION
   gem.required_ruby_version = ">= 3.0"
   gem.licenses = ["MIT"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test-cmd.rb
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Robert Gleeson
@@ -106,7 +106,7 @@ files:
 - test-cmd.rb.gemspec
 - test/cmd_test.rb
 - test/setup.rb
-homepage: https://github.com/0x1eef/test-cmd.rb#readme
+homepage: https://github.com/r-uby-dev/test-cmd.rb#readme
 licenses:
 - MIT
 metadata: {}
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: test-cmd.rb is a Go-inspired, object-oriented interface for running commands
   on UNIX-like systems, in the spirit of Go's `os/exec`. A command can be built by