process_executer 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 939beda136b7c1bffc2a3e16edda8083125cc5db3acc49f2dcec7837a96d510b
-  data.tar.gz: bea06af73eeff96c1583fdc422b0fe4fdd29f0964f10b6e88c9ee8174d94c5b6
+  metadata.gz: d2bd50be1f3683bc2c8210451c45e270e7072992ec48897a8bbb16cf10790c8b
+  data.tar.gz: e0d1ba5a7c5571b0059db55537726b68baf6017a66941883953ece63f5a58b53
 SHA512:
-  metadata.gz: 3cb8172471ed879e039904a731c40f23c0705643b78cfd0df7ce5d4671ae45db2c65308a9cf54416173fb4ff10d87a23e00e93a52b534aa15f453306c04be848
-  data.tar.gz: 3f25c2cb40a0689a04f26c83d865ddafe35e56cca8d9593f3916c3c5b7b3d41c136f243721978c7b040f9ec4eb53a34902ba01c0877c0dab074102916ddecfc8
+  metadata.gz: bdaab34abbd99de650933f367eedcb40e7a2538d1f48ab8eda6f5df5da3d5f1748543eb28f54f21cc3557c64d34575001da2158caf2f30cc768bec88f657e16c
+  data.tar.gz: 920227450b1da0c56aa3987a2ff1bbeb2c73cd093d04c1318ebb39d02302a408682d0d40c1668eb1f9b37d71f58fe47a6c4b101b75e701fdbaf3db2cdb845b26

data/.commitlintrc.yml

@@ -0,0 +1,16 @@
+---
+extends: '@commitlint/config-conventional'
+
+rules:
+  # See: https://commitlint.js.org/reference/rules.html
+  #
+  # Rules are made up by a name and a configuration array. The configuration array contains:
+  #
+  # * Severity [0..2]: 0 disable rule, 1 warning if violated, or 2 error if violated
+  # * Applicability [always|never]: never inverts the rule
+  # * Value: value to use for this rule
+  #
+  # Run `npx commitlint --print-config` to see the current setting for all rules.
+  #
+  body-leading-blank:    [2, 'always']
+  footer-leading-blank:  [2, 'always']

data/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

data/.rubocop.yml

@@ -1,23 +1,7 @@
-AllCops:
-  NewCops: enable
-  # Output extra information for each offense to make it easier to diagnose:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  ExtraDetails: true
-  SuggestExtensions: false
-  # RuboCop enforces rules depending on the oldest version of Ruby which
-  # your project supports:
-  TargetRubyVersion: 3.0
-
-# The default max line length is 80 characters
-Layout/LineLength:
-  Max: 120
+inherit_gem:
+  main_branch_shared_rubocop_config: config/rubocop.yml
 
-# The DSL for RSpec and the gemspec file make it very hard to limit block length:
-Metrics/BlockLength:
-  Exclude:
-    - "spec/**/*_spec.rb"
-    - "*.gemspec"
-
-Gemspec/DevelopmentDependencies:
-  Enabled: false
+AllCops:
+  # Pin this project to Ruby 3.1 in case the shared config above is upgraded to 3.2
+  # or later.
+  TargetRubyVersion: 3.1

data/.tool-versions

@@ -1 +1 @@
-ruby 3.3.5
+ruby 3.3.5

data/.yardopts

@@ -3,4 +3,4 @@
 --markup-provider=redcarpet
 --markup markdown
 - CHANGELOG.md
-- LICENSE.md
+- LICENSE.txt

data/CHANGELOG.md

@@ -5,25 +5,81 @@ 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.2 (2024-09-26)
-
-[Full Changelog](https://github.com/main-branch/process_executer/compare/v1.1.1..v1.1.2)
-
-Changes since v1.1.1:
-
-* 2006301 Re-add require for 'forwardable'
-
-## v1.1.1 (2024-09-25)
-
-[Full Changelog](https://github.com/main-branch/process_executer/compare/v1.1.0..v1.1.1)
+## v1.3.0 (2025-02-26)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v1.2.0..v1.3.0)
+
+Changes since v1.2.0:
+
+* d1e189b build: add Ruby 3.4 to the CI workflow
+* e805dfc feat: implement ProcessExecuter.run_command
+* bad822f fix: update the yard build in the rake file and update included files
+* 6fbdc5e feat: allow #spawn to accept file descriptors for redirection destination
+* d745685 test: make it so that tests do not give unnecessary output
+
+## v1.2.0 (2024-10-10)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v1.1.2..v1.2.0)
+
+Changes since v1.1.2:
+
+* 35663c9 chore: reset main branch to 1.x
+* 39913bc build: remove semver pr label check
+* 8ae8e34 build: enforce conventional commit message formatting
+* f5b8c51 Release v2.0.0.pre1
+* 8e15c39 Re-add require for 'forwardable'
+* 4bba06e Fix flakey test that checks for thread to die
+* 83bfd78 Remove unused require for 'forwardable' and 'ostruct'
+* ea3ea3c Use shared Rubocop config
+* ecd2cb5 Update copyright notice in this project
+* 7d5bfe1 Update links in gemspec
+* 797de91 Add Slack badge for this project in README
+* 591b716 Update “Build Status” link the README
+* 2fcd001 Update yardopts with new standard options
+* 4e1de47 Standardize YARD and Markdown Lint configurations
+* 929c680 Set JRuby --debug option when running tests in GitHub Actions workflows
+* 71049cb Finish Integration of simplecov-rspec into the project
+* 4fb44bb Update continuous integration and experimental ruby builds
+* 289645c Depend on v1 of semver_pr_label_check
+* 3c4d988 Update code climate test coverage reporter version
+* 04103b4 Simplify how the experimental ruby builds are triggered
+* 35840a4 Use a reusable workflow for the Semver PR label check
+* 0d887f0 Update code climate test coverage reporter version
+* bb7f73b Rename the experimental build workflow
+* 035ce8a Fix the experimental CI Build workflow
+* 3d739f4 Move CI builds using experimental Rubies to a different workflow
+* c5ef6b0 Integrate simplecov-rspec to ensure code covage in CI builds
+* f33707e Update development dependencies and examples (#45)
+
+## v2.0.0.pre1 (2024-09-26)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v1.1.0..v2.0.0.pre1)
 
 Changes since v1.1.0:
 
-* c3f063a Use a later version of ruby for development
-* d4eeb1e Use latest version of the actions/checkout to v4
-* eb4dad7 Fix flakey test on  JRuby
-* ac9417a Update CI build to run on v1.x branch
-* 014e70f Remove unused require for 'forwardable' and 'ostruct' (for v1.x)
+* 8e15c39 Re-add require for 'forwardable'
+* 4bba06e Fix flakey test that checks for thread to die
+* 83bfd78 Remove unused require for 'forwardable' and 'ostruct'
+* ea3ea3c Use shared Rubocop config
+* ecd2cb5 Update copyright notice in this project
+* 7d5bfe1 Update links in gemspec
+* 797de91 Add Slack badge for this project in README
+* 591b716 Update “Build Status” link the README
+* 2fcd001 Update yardopts with new standard options
+* 4e1de47 Standardize YARD and Markdown Lint configurations
+* 929c680 Set JRuby --debug option when running tests in GitHub Actions workflows
+* 71049cb Finish Integration of simplecov-rspec into the project
+* 4fb44bb Update continuous integration and experimental ruby builds
+* 289645c Depend on v1 of semver_pr_label_check
+* 3c4d988 Update code climate test coverage reporter version
+* 04103b4 Simplify how the experimental ruby builds are triggered
+* 35840a4 Use a reusable workflow for the Semver PR label check
+* 0d887f0 Update code climate test coverage reporter version
+* bb7f73b Rename the experimental build workflow
+* 035ce8a Fix the experimental CI Build workflow
+* 3d739f4 Move CI builds using experimental Rubies to a different workflow
+* c5ef6b0 Integrate simplecov-rspec to ensure code covage in CI builds
+* f33707e Update development dependencies and examples (#45)
 
 ## v1.1.0 (2024-02-02)
 

data/{LICENSE.md → LICENSE.txt}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 James Couball
+Copyright (c) 2024 James Couball
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,18 +3,23 @@
 [![Gem Version](https://badge.fury.io/rb/process_executer.svg)](https://badge.fury.io/rb/process_executer)
 [![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/process_executer/)
 [![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/process_executer/file/CHANGELOG.md)
-[![Build Status](https://github.com/main-branch/process_executer/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/main-branch/process_executer/actions?query=workflow%3ACI%20Build)
+[![Build Status](https://github.com/main-branch/process_executer/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/main-branch/process_executer/actions/workflows/continuous-integration.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/0b5c67e5c2a773009cd0/maintainability)](https://codeclimate.com/github/main-branch/process_executer/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/0b5c67e5c2a773009cd0/test_coverage)](https://codeclimate.com/github/main-branch/process_executer/test_coverage)
+[![Conventional
+Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+[![Slack](https://img.shields.io/badge/slack-main--branch/process__executer-yellow.svg?logo=slack)](https://main-branch.slack.com/archives/C07NG2BPG8Y)
 
 * [Usage](#usage)
+  * [ProcessExecuter.run](#processexecuterrun)
   * [ProcessExecuter::MonitoredPipe](#processexecutermonitoredpipe)
   * [ProcessExecuter.spawn](#processexecuterspawn)
 * [Installation](#installation)
 * [Contributing](#contributing)
   * [Reporting Issues](#reporting-issues)
   * [Developing](#developing)
-  * [Submitting Pull Requests](#submitting-pull-requests)
+  * [Commit message guidelines](#commit-message-guidelines)
+  * [Pull request guidelines](#pull-request-guidelines)
   * [Releasing](#releasing)
 * [License](#license)
 
@@ -25,6 +30,36 @@ gem is hosted on RubyGems.org. Read below of an overview and several examples.
 
 This gem contains the following important classes:
 
+### ProcessExecuter.run
+
+`ProcessExecuter.run` execute the given command as a subprocess blocking until it is finished.
+
+A Result object is returned which includes the process's status and output.
+
+Supports the same features as
+[Process.spawn](https://docs.ruby-lang.org/en/3.3/Process.html#method-c-spawn).
+In addition, it (1) blocks until the command has exited, (2) captures stdout and
+stderr to a buffer or file, and (3) can optionally kill the command if it exceeds
+an timeout.
+
+This command takes two forms:
+
+1. When passing a single string the command is passed to a shell:
+
+    `ProcessExecuter.run([env, ] command_line, options = {}) ->` {ProcessExecuter::Command::Result}
+
+2. When passing an array of strings the command is run directly (bypassing the shell):
+
+    `ProcessExecuter.run([env, ] exe_path, *args, options = {}) ->` {ProcessExecuter::Command::Result}
+
+Argument env, if given, is a hash that affects ENV for the new process; see
+[Execution
+Environment](https://docs.ruby-lang.org/en/3.3/Process.html#module-Process-label-Execution+Environment).
+
+Argument options is a hash of options for the new process; see the options listed below.
+
+See comprehensive examples in the YARD documentation for this method.
+
 ### ProcessExecuter::MonitoredPipe
 
 `ProcessExecuter::MonitoredPipe` streams data sent through a pipe to one or more writers.
@@ -116,59 +151,34 @@ allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
-### Submitting Pull Requests
-
-In order for a pull request to be merged, it must be approved by a code owner and
-include a semver label.
-
-The approval must be done using the Github PR Review process by a code owner defined
-in the project's CODEOWNERS file.
-
-The semver label indicates the type of change so that the gem version can be
-increments according to semver rules prior to release. One and only one of the
-following labels must added to the PR:
-
-* **`major-change`**
+### Commit message guidelines
 
-  Use when the PR includes incompatible API or functional changes.
+All commit messages must follow the [Conventional Commits
+standard](https://www.conventionalcommits.org/en/v1.0.0/). This helps us maintain a
+clear and structured commit history, automate versioning, and generate changelogs
+effectively.
 
-  This typically occurs when the changes introduced could break existing code that
-  depends on this gem. For example, removing a public method, changing a method's
-  signature, or altering the expected behavior of a method in a way that would
-  require changes in the dependent code.
+To ensure compliance, this project includes:
 
-* **`minor-change`**
+* A git commit-msg hook that validates your commit messages before they are accepted.
 
-  Use when the PR adds functionality in a backward-compatible manner.
+  To activate the hook, you must have node installed and run `npm install`.
 
-  This includes adding new features, enhancements, or deprecating existing features
-  as long as the deprecation itself doesn't break compatibility.
+* A GitHub Actions workflow that will enforce the Conventional Commit standard as
+  part of the continuous integration pipeline.
 
-  It's also common to include substantial improvements or optimizations in this
-  category, as long as they don't alter the expected behavior of the existing API.
+  Any commit message that does not conform to the Conventional Commits standard will
+  cause the workflow to fail and not allow the PR to be merged.
 
-* **`patch-change`**
+### Pull request guidelines
 
-  Use when the PR includes small user-facing changes that are backward-compatible and
-  do not introduce new functionality.
-
-  This includes bug fixes or other internal changes that do not affect the API such
-  as refactoring code, improving performance, or updating user documentation.
-
-* **`internal-change`**
-
-  Use when the PR includes changes that are NOT user facing and will NOT require a
-  release.
-
-  This includes updates to developer documentation, comments, GitHub Actions, minor
-  refactorings, and fixing Rubocop offenses.
+All pull requests must be merged using rebase merges. This ensures that commit
+messages from the feature branch are preserved in the release branch, keeping the
+history clean and meaningful.
 
 ### Releasing
 
-To release a new version, first determine the proper semver increment based on the
-PRs included in the release.
-
-Then in the root directory of this project with the `main` branch checked out, run
+In the root directory of this project with the `main` branch checked out, run
 the following command:
 
 ```shell

data/Rakefile

@@ -7,7 +7,7 @@ desc 'Run the same tasks that the CI build will run'
 if RUBY_PLATFORM == 'java'
   task default: %w[spec rubocop bundle:audit build]
 else
-  task default: %w[spec rubocop yard yard:audit yard:coverage bundle:audit build]
+  task default: %w[spec rubocop yard bundle:audit build]
 end
 
 # Bundler Audit
@@ -45,38 +45,38 @@ CLEAN << 'rspec-report.xml'
 
 require 'rubocop/rake_task'
 
-RuboCop::RakeTask.new do |t|
-  t.options = %w[
-    --format progress
-    --format json --out rubocop-report.json
-  ]
-end
+RuboCop::RakeTask.new
 
-CLEAN << 'rubocop-report.json'
+# YARD
 
 unless RUBY_PLATFORM == 'java'
-  # YARD
+  # yard:build
 
   require 'yard'
-  YARD::Rake::YardocTask.new do |t|
-    t.files = %w[lib/**/*.rb examples/**/*]
+
+  YARD::Rake::YardocTask.new('yard:build') do |t|
+    t.files = %w[lib/**/*.rb]
+    t.stats_options = ['--list-undoc']
   end
 
   CLEAN << '.yardoc'
   CLEAN << 'doc'
 
-  # Yardstick
+  # yard:audit
 
   desc 'Run yardstick to show missing YARD doc elements'
   task :'yard:audit' do
     sh "yardstick 'lib/**/*.rb'"
   end
 
-  # Yardstick coverage
+  # yard:coverage
 
   require 'yardstick/rake/verify'
 
   Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
     verify.threshold = 100
+    verify.require_exact_threshold = false
   end
+
+  task yard: %i[yard:build yard:audit yard:coverage]
 end

data/lib/process_executer/command/errors.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+# rubocop:disable Layout/LineLength
+
+module ProcessExecuter
+  module Command
+    # Base class for all ProcessExecuter::Command errors
+    #
+    # It is recommended to rescue `ProcessExecuter::Command::Error` to catch any
+    # runtime error raised by this gem unless you need more specific error handling.
+    #
+    # Custom errors are arranged in the following class hierarchy:
+    #
+    # ```text
+    # ::StandardError
+    #   └─> Error
+    #       ├─> CommandError
+    #       │   ├─> FailedError
+    #       │   └─> SignaledError
+    #       │       └─> TimeoutError
+    #       └─> ProcessIOError
+    # ```
+    #
+    # | Error Class | Description |
+    # | --- | --- |
+    # | `Error` | This catch-all error serves as the base class for other custom errors. |
+    # | `CommandError` | A subclass of this error is raised when there is a problem executing a command. |
+    # | `FailedError` | Raised when the command exits with a non-zero status code. |
+    # | `SignaledError` | Raised when the command is terminated as a result of receiving a signal. This could happen if the process is forcibly terminated or if there is a serious system error. |
+    # | `TimeoutError` | This is a specific type of `SignaledError` that is raised when the command times out and is killed via the SIGKILL signal. Raised when the operation takes longer than the specified timeout duration (if provided). |
+    # | `ProcessIOError` | Raised when an error was encountered reading or writing to the command's subprocess. |
+    #
+    # @example Rescuing any error
+    #   begin
+    #     ProcessExecuter.run_command('git', 'status')
+    #   rescue ProcessExecuter::Command::Error => e
+    #     puts "An error occurred: #{e.message}"
+    #   end
+    #
+    # @example Rescuing a timeout error
+    #   begin
+    #     timeout_duration = 0.1 # seconds
+    #     ProcessExecuter.run_command('sleep', '1', timeout: timeout_duration)
+    #   rescue ProcessExecuter::TimeoutError => e # Catch the more specific error first!
+    #     puts "Command took too long and timed out: #{e}"
+    #   rescue ProcessExecuter::Error => e
+    #     puts "Some other error occured: #{e}"
+    #   end
+    #
+    # @api public
+    #
+    class Error < ::StandardError; end
+
+    # Raised when a command fails or exits because of an uncaught signal
+    #
+    # The command executed, status, stdout, and stderr are available from this
+    # object.
+    #
+    # The Gem will raise a more specific error for each type of failure:
+    #
+    # * {FailedError}: when the command exits with a non-zero status
+    # * {SignaledError}: when the command exits because of an uncaught signal
+    # * {TimeoutError}: when the command times out
+    #
+    # @api public
+    #
+    class CommandError < ProcessExecuter::Command::Error
+      # Create a CommandError object
+      #
+      # @example
+      #   `exit 1` # set $? appropriately for this example
+      #   result = ProcessExecuter::Command::Result.new(%w[git status], $?, 'stdout', 'stderr')
+      #   error = ProcessExecuter::Command::CommandError.new(result)
+      #   error.to_s #=> '["git", "status"], status: pid 89784 exit 1, stderr: "stderr"'
+      #
+      # @param result [Result] The result of the command including the command,
+      #   status, stdout, and stderr
+      #
+      def initialize(result)
+        @result = result
+        super(error_message)
+      end
+
+      # The human readable representation of this error
+      #
+      # @example
+      #   error.error_message #=> '["git", "status"], status: pid 89784 exit 1, stderr: "stderr"'
+      #
+      # @return [String]
+      #
+      def error_message
+        "#{result.command}, status: #{result}, stderr: #{result.stderr_to_s.inspect}"
+      end
+
+      # @attribute [r] result
+      #
+      # The result of the command including the command, its status and its output
+      #
+      # @example
+      #   error.result #=> #<ProcessExecuter::Command::Result:0x00007f9b1b8b3d20>
+      #
+      # @return [Result]
+      #
+      attr_reader :result
+    end
+
+    # Raised when the command returns a non-zero exitstatus
+    #
+    # @api public
+    #
+    class FailedError < ProcessExecuter::Command::CommandError; end
+
+    # Raised when the command exits because of an uncaught signal
+    #
+    # @api public
+    #
+    class SignaledError < ProcessExecuter::Command::CommandError; end
+
+    # Raised when the command takes longer than the configured timeout
+    #
+    # @example
+    #   result.status.timeout? #=> true
+    #
+    # @api public
+    #
+    class TimeoutError < ProcessExecuter::Command::SignaledError
+      # Create a TimeoutError object
+      #
+      # @example
+      #   command = %w[sleep 10]
+      #   timeout_duration = 1
+      #   status = ProcessExecuter.spawn(*command, timeout: timeout_duration)
+      #   result = Result.new(command, status, 'stdout', 'err output')
+      #   error = TimeoutError.new(result, timeout_duration)
+      #   error.error_message
+      #     #=> '["sleep", "10"], status: pid 70144 SIGKILL (signal 9), stderr: "err output", timed out after 1s'
+      #
+      # @param result [Result] The result of the command including the git command,
+      #   status, stdout, and stderr
+      #
+      # @param timeout_duration [Numeric] The duration the subprocess was allowed
+      #   to run before being terminated
+      #
+      def initialize(result, timeout_duration)
+        @timeout_duration = timeout_duration
+        super(result)
+      end
+
+      # The amount of time the subprocess was allowed to run before being killed
+      #
+      # @example
+      #   `kill -9 $$` # set $? appropriately for this example
+      #   result = Result.new(%w[git status], $?, '', "killed")
+      #   error = TimeoutError.new(result, 10)
+      #   error.timeout_duration #=> 10
+      #
+      # @return [Numeric]
+      #
+      attr_reader :timeout_duration
+    end
+
+    # Raised when the output of a command can not be read
+    #
+    # @api public
+    #
+    class ProcessIOError < ProcessExecuter::Command::Error; end
+  end
+end
+
+# rubocop:enable Layout/LineLength

data/lib/process_executer/command/result.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'delegate'
+
+module ProcessExecuter
+  module Command
+    # A wrapper around {ProcessExecuter::Status} which adds captured command output
+    #
+    # This class is used to represent the result of a subprocess execution, combining
+    # the process status with the captured output for easier access and manipulation.
+    #
+    # Features:
+    # * Provides access to the process's status, stdout, and stderr.
+    # * Allows conversion of stdout and stderr buffers to strings.
+    #
+    # @example Create a Result object
+    #   status = ProcessExecuter.spawn(*command, timeout:, out:, err:)
+    #   result = ProcessExecuter::Command::Result.new(command, status, out_buffer.string, err_buffer.string)
+    #
+    # @api public
+    #
+    class Result < SimpleDelegator
+      # Create a new Result object
+      # @example
+      #   status = ProcessExecuter.spawn(*command, timeout:, out:, err:)
+      #   Result.new(command, status, out_buffer.string, err_buffer.string)
+      # @param command [Array<String>] The command that was executed
+      # @param status [ProcessExecuter::Status] The status of the process
+      # @param stdout [String] The stdout output from the process
+      # @param stderr [String] The stderr output from the process
+      def initialize(command, status, stdout, stderr)
+        super(status)
+        @command = command
+        @stdout = stdout
+        @stderr = stderr
+      end
+
+      # The command that was run
+      # @example
+      #   result.command #=> %w[git status]
+      # @return [Array<String>]
+      attr_reader :command
+
+      # The captured stdout output from the process
+      # @example
+      #   result.stdout #=> "On branch master\nnothing to commit, working tree clean\n"
+      # @return [String]
+      attr_reader :stdout
+
+      # The captured stderr output from the process
+      # @example
+      #   result.stderr #=> "ERROR: file not found"
+      # @return [String]
+      attr_reader :stderr
+
+      # Return the stdout output as a string
+      # @example When stdout is a StringIO containing "Hello World"
+      #   result.stdout_to_s #=> "Hello World"
+      # @example When stdout is a File object
+      #   result.stdout_to_s #=> #<File:/tmp/output.txt>
+      # @return [String, Object] Returns a String if stdout is a StringIO; otherwise, returns the stdout object
+      def stdout_to_s
+        stdout.respond_to?(:string) ? stdout.string : stdout
+      end
+
+      # Return the stderr output as a string
+      # @example When stderr is a StringIO containing "Hello World"
+      #   result.stderr_to_s #=> "Hello World"
+      # @example When stderr is a File object
+      #   result.stderr_to_s #=> #<File:/tmp/output.txt>
+      # @return [String, Object] Returns a String if stderr is a StringIO; otherwise, returns the stderr object
+      def stderr_to_s
+        stderr.respond_to?(:string) ? stderr.string : stderr
+      end
+    end
+  end
+end