process_executer 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3af694308b0e9c5119b2ff63d11b6b351a25cc9f7d66ac2dd482c8525736595a
-  data.tar.gz: a669d2c3cceadeb7544be9765793eff22addc8c7bde10e13e4d36de447b26cb5
+  metadata.gz: 0a9debe1b364e7755e593434f5b018b6ef39d64f509132b2f803ebe1be1bfe36
+  data.tar.gz: 780091f37f642962c1bbaf885cd22559defe52d568294884df23aac0eb575318
 SHA512:
-  metadata.gz: 670dcd425f0879def69e0875a90edae0f79280b44d4ea73d117b3875ad3eeb1cd6329f4b2d8a6a8c0d601f7b79eb72989288255d57067714f2e830f4dde3ddb2
-  data.tar.gz: 6a18db9777ecb26ebaa7b30c3fbadb81ae8adba1dcd60c92bf6d30510f30275336ef34c4b1c05c5df6356bcd62cd5b783736adb25462dd55d9d87deec6015945
+  metadata.gz: fc21311fca209fc28ce413c7562a8d80a3268c90bf34941525422db8cdd0656549c5e8ca285c4cfee4711f0d9ad8babe4de55676d4ed0fbf77f2001b4ebd17fe
+  data.tar.gz: 689feaf01cc890fcb978c78e24c16ad912e4e64cfa3494ecd6d825ceaf86662d46e8239528e4f985ed9a5365cc32498c7d618d1203aebf1da0a34bfedf868228

data/CHANGELOG.md

@@ -5,6 +5,19 @@ 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).
 
+## v3.2.1 (2025-04-08)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v3.2.0..v3.2.1)
+
+Changes since v3.2.0:
+
+* d1e19a5 test: assert that MonitoredPipe has no open instances after each test
+* aa71f8e test: ensure MonitoredPipe cleans up open instances in specs
+* 987b0c9 fix: ensure that all pipes are closed even when there is an IOError
+* 65e8db0 fix: ensure that MonitoredPipe cleans up after itself even when there is IOError
+* ed2454e chore: integrate track_open_instances gem to report on leaked MonitoredPipe instances
+* f25c87d chore: release v3.2.0
+
 ## v3.2.0 (2025-04-04)
 
 [Full Changelog](https://github.com/main-branch/process_executer/compare/v3.1.0..v3.2.0)

data/lib/process_executer/monitored_pipe.rb

@@ -2,6 +2,7 @@
 
 require 'stringio'
 require 'io/wait'
+require 'track_open_instances'
 
 module ProcessExecuter
   # Write data sent through a pipe to a destination
@@ -41,6 +42,8 @@ module ProcessExecuter
   # @api public
   #
   class MonitoredPipe
+    include TrackOpenInstances
+
     # Create a new monitored pipe
     #
     # Creates a IO.pipe and starts a monitoring thread to read data written to the pipe.
@@ -64,6 +67,8 @@ module ProcessExecuter
       @pipe_reader, @pipe_writer = IO.pipe
       @state = :open
       @thread = start_monitoring_thread
+
+      self.class.add_open_instance(self)
     end
 
     # Set the state to `:closing` and wait for the state to be set to `:closed`
@@ -83,18 +88,15 @@ module ProcessExecuter
     #
     def close
       mutex.synchronize do
-        return unless state == :open
-
-        @state = :closing
-      end
-
-      mutex.synchronize do
-        condition_variable.wait(mutex) while @state != :closed
+        if state == :open
+          @state = :closing
+          condition_variable.wait(mutex) while @state != :closed
+        end
       end
 
       thread.join
-
       destination.close
+      self.class.remove_open_instance(self)
     end
 
     # Return the write end of the pipe so that data can be written to it

data/lib/process_executer/runner.rb

@@ -52,7 +52,8 @@ module ProcessExecuter
       opened_pipes = wrap_stdout_stderr(options)
       ProcessExecuter.spawn_and_wait_with_options(command, options)
     ensure
-      opened_pipes.each { |key, value| close_pipe(command, key, value) }
+      opened_pipes.each_value(&:close)
+      opened_pipes.each { |option_key, pipe| raise_pipe_error(command, option_key, pipe) }
     end
 
     # Wrap the stdout and stderr redirection options with a MonitoredPipe
@@ -81,16 +82,6 @@ module ProcessExecuter
         ProcessExecuter::Destinations.compatible_with_monitored_pipe?(value)
     end
 
-    # Close the pipe and raise an error if the pipe raised an exception
-    # @return [void]
-    # @raise [ProcessExecuter::ProcessIOError] If an exception was raised while
-    #   collecting subprocess output
-    # @api private
-    def close_pipe(command, option_key, pipe)
-      pipe.close
-      raise_pipe_error(command, option_key, pipe) if pipe.exception
-    end
-
     # Process the result of the command and return a ProcessExecuter::Result
     #
     # Log the command and result, and raise an error if the command failed.
@@ -144,6 +135,8 @@ module ProcessExecuter
     # @api private
     #
     def raise_pipe_error(command, option_key, pipe)
+      return unless pipe.exception
+
       error = ProcessExecuter::ProcessIOError.new("Pipe Exception for #{command}: #{option_key.inspect}")
       raise(error, cause: pipe.exception)
     end

data/lib/process_executer/version.rb

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

data/process_executer.gemspec

@@ -37,6 +37,8 @@ Gem::Specification.new do |spec|
     'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
   ]
 
+  spec.add_dependency 'track_open_instances', '~> 0.1'
+
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
   spec.add_development_dependency 'create_github_release', '~> 2.1'
   spec.add_development_dependency 'main_branch_shared_rubocop_config', '~> 0.1'

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: process_executer
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
 platform: ruby
 authors:
 - James Couball
 bindir: exe
 cert_chain: []
-date: 2025-04-05 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: track_open_instances
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -250,8 +264,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
-  documentation_uri: https://rubydoc.info/gems/process_executer/3.2.0
-  changelog_uri: https://rubydoc.info/gems/process_executer/3.2.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/process_executer/3.2.1
+  changelog_uri: https://rubydoc.info/gems/process_executer/3.2.1/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: