philiprehberger-task_runner 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0edebc1ac881ac5547d09cc825898875461f22b5b13edd6c5c01b3efc9d7a13f
-  data.tar.gz: f7172ad5068e86cb31fa0cb48f1eac41b21f239ff884f9333f52b52d33df29bb
+  metadata.gz: 81a304bf73bc20e70f8bb340125ed6cbc3add80df788e746909341cdbcac85a4
+  data.tar.gz: 46e8d6a93c2f3501142a9a4c330a8686e0d91edfd2c3bcd2674508075d563c34
 SHA512:
-  metadata.gz: 96f98887b963b6e19cd0025b1d2621571422b21ec7c7e72f936892b4f768b0f023590da3591b575deaf8b6395c8d5b27fe3a6ff56bb0a057159f594383323a40
-  data.tar.gz: 84271258a850cc7dbb6a3bda26db60c55b7a43b61b9323659eec0ecbe4bc83f1bfe804ade2b33922de9643418becdc8f595231fa9cf84e9663e57b85ca1a8e15
+  metadata.gz: 83345dc31740a6618be9d21078c0b0640ba04bb54b08d457e67fc0df37786e2c8f86b316355ffd558bf1470967e71aa54575a4f98a2b75acaf8731059b8fbf52
+  data.tar.gz: 304a3c5de5afd3a41e61dd9e127dc8fabecf546743a22900df0486ad95a768f7112f3713f8f4de9747080a31a0e0563a2c3d67b547a3cd6eefbc9f32b0e9ea83

data/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] - 2026-04-28
+
+### Added
+- `TaskRunner.which(cmd)` — absolute path of an executable on `PATH`, or `nil` when not found. Honors `ENV['PATHEXT']` on Windows. Raises `ArgumentError` for nil/empty input.
+
+## [0.5.0] - 2026-04-21
+
+### Added
+- `TaskRunner.run?` — Boolean convenience returning true only when the command exits with status 0; swallows `TimeoutError` as `false`
+
 ## [0.4.0] - 2026-04-20
 
 ### Added

data/README.md

@@ -51,6 +51,31 @@ rescue Philiprehberger::TaskRunner::CommandError => e
 end
 ```
 
+### Boolean Success Check
+
+```ruby
+# Returns true for exit 0, false otherwise (timeouts also return false)
+if Philiprehberger::TaskRunner.run?('which', 'git')
+  puts 'git is installed'
+end
+```
+
+### Which
+
+Locate an executable on `PATH` (like the `which` shell builtin). Returns the
+absolute path or `nil` when not found:
+
+```ruby
+Philiprehberger::TaskRunner.which("git")
+# => "/usr/bin/git"
+
+Philiprehberger::TaskRunner.which("definitely-not-installed")
+# => nil
+```
+
+On Windows, candidate suffixes from `ENV["PATHEXT"]` (`.COM`, `.EXE`,
+`.BAT`, `.CMD`) are tried automatically.
+
 ### Timeout
 
 ```ruby
@@ -115,6 +140,8 @@ end
 |----------------|-------------|
 | `.run(cmd, *args, timeout:, env:, chdir:, signal:, kill_after:, stdin:)` | Run a command and return a Result |
 | `.run!(cmd, *args, **opts)` | Same as `run`, raises `CommandError` on non-zero exit |
+| `.run?(cmd, *args, **opts)` | Boolean shortcut — true only when exit code is 0; timeouts return false |
+| `.which(cmd)` | Absolute path of `cmd` on PATH (or `nil`); honors `PATHEXT` on Windows |
 | `CommandError#result` | The failed `Result` object |
 | `.run(cmd) { \|line\| ... }` | Run with line-by-line stdout streaming |
 | `.run(cmd) { \|line, stream\| ... }` | Run with stdout and stderr streaming |

data/lib/philiprehberger/task_runner/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module TaskRunner
-    VERSION = '0.4.0'
+    VERSION = '0.6.0'
   end
 end

data/lib/philiprehberger/task_runner.rb

@@ -70,6 +70,48 @@ module Philiprehberger
       result
     end
 
+    # Boolean convenience — run the command and return whether it succeeded
+    # (exit code 0). Swallows `TimeoutError` (reported as false). Accepts the
+    # same arguments as {.run}.
+    #
+    # @return [Boolean] true if the command exited with status 0
+    def self.run?(cmd, ...)
+      run(cmd, ...).success?
+    rescue TimeoutError
+      false
+    end
+
+    # Find the absolute path of an executable on PATH.
+    #
+    # Behaves like the `which` shell builtin: walks each entry in
+    # `ENV['PATH']` and returns the first directory that contains an
+    # executable file matching `cmd`. On Windows, also tries each suffix in
+    # `ENV['PATHEXT']`. Returns `nil` when nothing is found.
+    #
+    # @param cmd [String] the executable name to search for
+    # @return [String, nil] the absolute path, or nil when not found
+    # @raise [ArgumentError] if `cmd` is nil or empty
+    def self.which(cmd)
+      raise ArgumentError, 'cmd cannot be nil or empty' if cmd.nil? || cmd.to_s.empty?
+
+      exts = if Gem.win_platform?
+               (ENV['PATHEXT'] || '.COM;.EXE;.BAT;.CMD').split(';')
+             else
+               ['']
+             end
+
+      ENV.fetch('PATH', '').split(File::PATH_SEPARATOR).each do |dir|
+        next if dir.empty?
+
+        exts.each do |ext|
+          candidate = File.join(dir, "#{cmd}#{ext}")
+          return File.expand_path(candidate) if File.file?(candidate) && File.executable?(candidate)
+        end
+      end
+
+      nil
+    end
+
     # @api private
     def self.run_capture(env_hash, full_cmd, spawn_opts, timeout, start_time, signal, kill_after, stdin_data)
       stdout_buf = +''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-task_runner
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-20 00:00:00.000000000 Z
+date: 2026-04-29 00:00:00.000000000 Z
 dependencies: []
 description: Run shell commands with captured stdout/stderr, exit code, duration measurement,
   configurable timeout, environment variables, line-by-line streaming, graceful signal