philiprehberger-task_runner 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 590a04ed4c85ae234b9a0d43827629228ad40905b4519de722ccface3b4c1a94
-  data.tar.gz: dff5e1dc4852a48dcd6baec3355ad54294854bae050663ec72383dd23705e49b
+  metadata.gz: 1e264781c1fb8c863a53e85b4d6b80f4bc1644a27bbeb17446473719d5efc10c
+  data.tar.gz: d7b4719dab1483d43ec494ac3aa00718ecfd6d408b9241c21cbbd7695e4bce2d
 SHA512:
-  metadata.gz: ad0d734a2a0e763e6f8bff1fd0baf02c0351be84f73e3fd7b40fd9846f751c9b73d9c77fda9e3149aea65c3f3b31fbc66e1d3002b3c84b030c726d4b6085eac7
-  data.tar.gz: a1794ab2ad9d37557c340d91c70d7167fb4befe9d9b5dc0195daaedae951c0a154c60f8704aed4563eba651ce5a5bd92f06bf994e1795e51de4dd7c14d8fff01
+  metadata.gz: 8ea18413fb9724653c6621d57f24af1384567aa5361ea3ae4d9ba165f97d5685644d8b45c2ad2cc9e2537db2e9e19f223b4983c94bd2514640c325c8422a46dd
+  data.tar.gz: bd148577cae30e1bb877622f60cdfda40887bee65653a5568c6b6faa420f37cf38bfe95d6d8317508a7a6502c3c67395a242218f6731d16227d338266131c862

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+- `Result#failure?` — logical inverse of `#success?` for clearer branching
+- `Result#timed_out?` — true when the process was killed by the task runner for exceeding its timeout (`:TERM` or `:KILL` signal)
+- `:timed_out` key added to `Result#to_h` alongside the existing `:success` flag
+
 ## [0.3.0] - 2026-04-09
 
 ### Added

data/README.md

@@ -51,6 +51,15 @@ 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
+```
+
 ### Timeout
 
 ```ruby
@@ -115,6 +124,7 @@ 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 |
 | `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 |
@@ -122,9 +132,11 @@ end
 | `Result#stderr` | Captured standard error |
 | `Result#exit_code` | Process exit code |
 | `Result#success?` | Whether exit code is 0 |
+| `Result#failure?` | Logical inverse of `#success?` |
 | `Result#duration` | Execution time in seconds |
 | `Result#signal` | Signal that killed the process (:TERM, :KILL, or nil) |
-| `Result#to_h` | Hash representation of the result |
+| `Result#timed_out?` | Whether the process was killed for exceeding its timeout |
+| `Result#to_h` | Hash representation of the result (includes `:success` and `:timed_out`) |
 
 ## Development
 

data/lib/philiprehberger/task_runner/result.rb

@@ -39,6 +39,22 @@ module Philiprehberger
         @exit_code.zero?
       end
 
+      # Whether the command exited with a non-zero status, was killed by a
+      # signal, or timed out. The logical inverse of {#success?}.
+      #
+      # @return [Boolean]
+      def failure?
+        !success?
+      end
+
+      # Whether the command was terminated by the task runner because it
+      # exceeded its timeout (SIGTERM or SIGKILL).
+      #
+      # @return [Boolean]
+      def timed_out?
+        %i[TERM KILL].include?(@signal)
+      end
+
       # Hash representation of the result.
       #
       # @return [Hash]
@@ -49,7 +65,8 @@ module Philiprehberger
           exit_code: @exit_code,
           duration: @duration,
           signal: @signal,
-          success: success?
+          success: success?,
+          timed_out: timed_out?
         }
       end
     end

data/lib/philiprehberger/task_runner/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module TaskRunner
-    VERSION = '0.3.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/philiprehberger/task_runner.rb

@@ -70,6 +70,17 @@ 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
+
     # @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.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-10 00:00:00.000000000 Z
+date: 2026-04-21 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