process_executer 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05077fa5757c373b7587a35c2f32aaa3deeaa5708845ec5db485fccb4f29bc5c
-  data.tar.gz: 9b1fda5d3669f6f09100e2b4b47ec8905d8448632cbd1998af0e606d724967cf
+  metadata.gz: f568a98075e32879207b26949346e4181eed2d2432c9665e84ddb015d5ded96c
+  data.tar.gz: bcc6f74e77155a251d4ad561495f6edb1b6cf95bccc23b7de7322a0897d4a0af
 SHA512:
-  metadata.gz: 6f48795cd44788c27a9931a1960e9d5f83d72ab794fd37d5d24b0a3110a1582211f80cdeef4e8cd171183f3ef9ccfec615f60fda46dd480cdaed10856d69a373
-  data.tar.gz: 54b9a282d8dc8d0ebca8e5e2b1368a0040ec140c5a793d438fe4891363d74574b31541d9d22aea566f09f8b3284cb7d12c49f071f9dca3cd29bbcd8df9babfbe
+  metadata.gz: 0fc886fade1e486d6acb6c32864a469a6d77700c596dd15a47c4e59e440bfda06b3a1ca506fc4a9be8f7d3bea831525329e735d9cb30d5c01d48395571f9164c
+  data.tar.gz: cab6c4b4d5d1761ac46df3aff8c02c44fed93d071bc6c74fdba802c04175321520c92556c8a43fe79bf3f56d9fb80b82e1b7b60ff50c1bdea8fdcf94bb2e22fd

data/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to the process_executer gem will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v1.1.0 (2024-02-02)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v1.0.2..v1.1.0)
+
+Changes since v1.0.2:
+
+* a473281 ProcessExecuter.spawn should indicate if the subprocess timed out or not (#43)
+
 ## v1.0.2 (2024-02-01)
 
 [Full Changelog](https://github.com/main-branch/process_executer/compare/v1.0.1..v1.0.2)

data/README.md

@@ -77,7 +77,15 @@ important behaviorial differences:
 2. A timeout can be specified using the `:timeout` option
 
 If the command does not terminate before the timeout, the process is killed by
-sending it the SIGKILL signal.
+sending it the SIGKILL signal. The returned status object's `timeout?` attribute will
+return `true`. For example:
+
+```ruby
+status = ProcessExecuter.spawn('sleep 10', timeout: 0.01)
+status.signaled? #=> true
+status.termsig #=> 9
+status.timeout? #=> true
+```
 
 ## Installation
 

data/lib/process_executer/status.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'delegate'
+
+module ProcessExecuter
+  # A simple delegator for Process::Status that adds a `timeout?` attribute
+  #
+  # @api public
+  #
+  class Status < SimpleDelegator
+    extend Forwardable
+
+    # Create a new Status object from a Process::Status and timeout flag
+    #
+    # @param status [Process::Status] the status to delegate to
+    # @param timeout [Boolean] true if the process timed out
+    #
+    # @example
+    #   status = Process.wait2(pid).last
+    #   timeout = false
+    #   ProcessExecuter::Status.new(status, timeout)
+    #
+    # @api public
+    #
+    def initialize(status, timeout)
+      super(status)
+      @timeout = timeout
+    end
+
+    # @!attribute [r] timeout?
+    #
+    # True if the process timed out and was sent the SIGKILL signal
+    #
+    # @example
+    #   status = ProcessExecuter.spawn('sleep 10', timeout: 0.01)
+    #   status.timeout? # => true
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    #
+    def timeout? = @timeout
+  end
+end

data/lib/process_executer/version.rb

@@ -2,5 +2,5 @@
 
 module ProcessExecuter
   # The current Gem version
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/lib/process_executer.rb

@@ -2,6 +2,7 @@
 
 require 'process_executer/monitored_pipe'
 require 'process_executer/options'
+require 'process_executer/status'
 
 require 'timeout'
 
@@ -59,16 +60,16 @@ module ProcessExecuter
   # @param pid [Integer] the process id
   # @param options [ProcessExecuter::Options] the options used
   #
-  # @return [Process::Status] the status of the process
+  # @return [ProcessExecuter::Status] the status of the process
   #
   # @api private
   #
   private_class_method def self.wait_for_process(pid, options)
     Timeout.timeout(options.timeout) do
-      Process.wait2(pid).last
+      ProcessExecuter::Status.new(Process.wait2(pid).last, false)
     end
   rescue Timeout::Error
     Process.kill('KILL', pid)
-    Process.wait2(pid).last
+    ProcessExecuter::Status.new(Process.wait2(pid).last, true)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: process_executer
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-02 00:00:00.000000000 Z
+date: 2024-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -190,6 +190,7 @@ files:
 - lib/process_executer.rb
 - lib/process_executer/monitored_pipe.rb
 - lib/process_executer/options.rb
+- lib/process_executer/status.rb
 - lib/process_executer/version.rb
 - process_executer.gemspec
 homepage: https://github.com/main-branch/process_executer
@@ -199,8 +200,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/main-branch/process_executer
   source_code_uri: https://github.com/main-branch/process_executer
-  changelog_uri: https://rubydoc.info/gems/process_executer/1.0.2/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/process_executer/1.0.2
+  changelog_uri: https://rubydoc.info/gems/process_executer/1.1.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/process_executer/1.1.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []