exeggutor 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b9eb0de91468b1ba1d04da72cac44b57eaadd3553719d86910d71f88af67746
-  data.tar.gz: 77713dec1ae04c17322d25563abf517dc406c34f61661e1fd483abf9a307f123
+  metadata.gz: 1ef72410040189a5e3d92f9112a65ddf167d08196047136da03e5471fbce10c6
+  data.tar.gz: 2767a58074b611c9b47448313f1eb483648b8b81336fd7e49998cece6ca11ed6
 SHA512:
-  metadata.gz: edfbd0cbe10c2b38812b8a92adfa91566cdd5f4823a4d4e9030a516c7b0c352c465796c7c30b78744db33501d3cf832acf1570076aa47a1db0826621a5d0ab16
-  data.tar.gz: a7bdcd0f7f915dfce050b7cb84ec3ffe92ac46304524e2f51440eeef02417209458f35562256b7e74807795501d893a24eed97cf947481686d5f7bd3a1c7e064
+  metadata.gz: a681829d986c9466675547079d53d90420e9a26b1cf71ce7987a48c766e3400510009595e6e8dec6c73e15b20c2a618e3233367c47827ecfa53ebe8b040a6149
+  data.tar.gz: '0329cd3a8c536474c5a2090c7a1f049c01c571b9d6038fe013fe9946277884587fef568839f70303c813869c05a510da0f323eeb24ce1b1dbdceefa101dc1e67'

data/lib/exeggutor.rb

@@ -40,6 +40,7 @@ module Exeggutor
 
   # @private
   def self.run_popen3(args, env)
+    # Use this weird [args[0], args[0]] thing for the case where a command with just one arg is being run
     if env
       Open3.popen3(env, [args[0], args[0]], *args.drop(1))
     else
@@ -47,20 +48,6 @@ module Exeggutor
     end
   end
 
-  # Executes a command with the provided arguments and options
-  #
-  # @param args [Array<String>] The command and its arguments as an array.
-  # @param can_fail [Boolean] If false, raises a ProcessError on failure.
-  # @param show_stdout [Boolean] If true, prints stdout to the console in real-time.
-  # @param show_stderr [Boolean] If true, prints stderr to the console in real-time.
-  # @param cwd [String, nil] The working directory to run the command in. If nil, uses the current working directory.
-  # @param stdin_data [String, nil] Input data to pass to the command's stdin. If nil, doesn't pass any data to stdin.
-  # @param env_vars [Hash{String => String}, nil] A hashmap containing environment variable overrides,
-  #        or `nil` if no overrides are desired
-  #
-  # @return [ProcessResult] An object containing process info such as stdout, stderr, and exit code. Waits for the command to complete to return.
-  #
-  # @raise [ProcessError] If the command fails and `can_fail` is false.
   def self.run!(args, can_fail: false, show_stdout: false, show_stderr: false, env: nil, cwd: nil, stdin_data: nil)
     # TODO: expand "~"? popen3 doesn't expand it by default
     if cwd
@@ -72,7 +59,10 @@ module Exeggutor
     stdin_stream.write(stdin_data) if stdin_data
     stdin_stream.close
 
-    stderr_stream.sync = true # Match terminals more closely
+    # Make the streams as synchronous as possible, to minimize the possibility of a surprising lack
+    # of output
+    stdout_stream.sync = true
+    stderr_stream.sync = true
 
     stdout_str = +''  # Using unfrozen string
     stderr_str = +''
@@ -103,7 +93,7 @@ module Exeggutor
     # Close open pipes
     stdout_stream.close
     stderr_stream.close
-    
+
     result = ProcessResult.new(
       stdout: stdout_str.force_encoding('UTF-8'),
       stderr: stderr_str.force_encoding('UTF-8'),
@@ -124,6 +114,20 @@ module Exeggutor
   end
 end
 
+# Executes a command with the provided arguments and options
+#
+# @param args [Array<String>] The command and its arguments as an array.
+# @param can_fail [Boolean] If false, raises a ProcessError on failure.
+# @param show_stdout [Boolean] If true, prints stdout to the console in real-time.
+# @param show_stderr [Boolean] If true, prints stderr to the console in real-time.
+# @param cwd [String, nil] The working directory to run the command in. If nil, uses the current working directory.
+# @param stdin_data [String, nil] Input data to pass to the command's stdin. If nil, doesn't pass any data to stdin.
+# @param env_vars [Hash{String => String}, nil] A hashmap containing environment variable overrides,
+#        or `nil` if no overrides are desired
+#
+# @return [ProcessResult] An object containing process info such as stdout, stderr, and exit code. Waits for the command to complete to return.
+#
+# @raise [ProcessError] If the command fails and `can_fail` is false.
 def run!(...)
   Exeggutor::run!(...)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exeggutor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Eisel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-23 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest