process_executer 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae4d5881afe09475a15692bf7110746ff4dfd76a70958775351c6fb510a7fb2f
-  data.tar.gz: 683508220b6137f2129bf094b823862ae155a7a5b418aced87dd0056bb0eda7f
+  metadata.gz: c6d2904b0fd36166eb05a23f8d208b27de0c19bc10284e71e63a1e7055034a7b
+  data.tar.gz: 5ed998bd38182774d63265bd6729c219918acf41755215a172c87b85e4873ebe
 SHA512:
-  metadata.gz: 506898e021e1bf3b923d3900fb83005836e729daf064885c0d8172a35690fc9f7865d716197ce60cfb6d6a5153817bde385f6b5b38165296b7f1c213a7a6cfe3
-  data.tar.gz: 3111bfbaf30068de540fb1463a8f862a1d55d6c26f3c47cc90776b2d111a3330601927d4c7e70dcc719ea7c6e60da447c6a2b9b6bddeb89749f44e106a71847e
+  metadata.gz: 7aec2cdf98b06acccccfa449e57efbc3d6ea4b7bb9ee833a5f81ee77faa02490c55d5c3cea7c1235295d765eaf3b957b2577e3cf8fae0818d4e60e097218bcc3
+  data.tar.gz: a0a95d10b07111be5ca3bc094cfa4255629f43b723fb7ae44ead94615c11cd97af370da9a219e481c1d55eb55fd20f7f3a24e213a96834d91b3f18527a6af8ab

data/CHANGELOG.md

@@ -5,6 +5,30 @@ 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).
 
+## v0.5.0 (2022-12-12)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v0.4.0...v0.5.0)
+
+* c6d8de9 Workaround a problem with SimpleCov / JRuby
+* c480b5f Increase time to wait for results from a writer throwing an exception
+* 1934563 Handle exceptions from writers within MonitoredPipe
+* e948ada Increase default chunk_size to 100_000 bytes
+* 5eb2c24 Update documentation for ProcessExecuter#spawn
+* a3a4217 Release v0.4.0
+
+## v0.4.0 (2022-12-06)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v0.3.0...v0.4.0)
+
+* 9ac17a4 Remove build using jruby-head on windows
+* d36d131 Work around a SimpleCov problem when using JRuby
+* b6b3a19 Remove unused Status and Process classes
+* a5cdf04 Allow 100% coverage check to be skipped
+* a3fa1f5 Output coverage details when coverage is below 100%
+* 6a9a417 Refactor monitor so that closing the pipe is on the monitoring thread
+* 65ee9a2 Add JRuby and Windows builds
+* 2e713e3 Release v0.3.0
+
 ## v0.3.0 (2022-12-01)
 
 [Full Changelog](https://github.com/main-branch/process_executer/compare/v0.2.0...v0.3.0)

data/Rakefile

@@ -3,7 +3,12 @@
 # The default task
 
 desc 'Run the same tasks that the CI build will run'
-task default: %w[spec rubocop yard yard:audit yard:coverage bundle:audit build]
+
+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]
+end
 
 # Bundler Audit
 
@@ -53,27 +58,29 @@ end
 
 CLEAN << 'rubocop-report.json'
 
-# YARD
+unless RUBY_PLATFORM == 'java'
+  # YARD
 
-require 'yard'
-YARD::Rake::YardocTask.new do |t|
-  t.files = %w[lib/**/*.rb examples/**/*]
-end
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = %w[lib/**/*.rb examples/**/*]
+  end
 
-CLEAN << '.yardoc'
-CLEAN << 'doc'
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
 
-# Yardstick
+  # Yardstick
 
-desc 'Run yardstick to show missing YARD doc elements'
-task :'yard:audit' do
-  sh "yardstick 'lib/**/*.rb'"
-end
+  desc 'Run yardstick to show missing YARD doc elements'
+  task :'yard:audit' do
+    sh "yardstick 'lib/**/*.rb'"
+  end
 
-# Yardstick coverage
+  # Yardstick coverage
 
-require 'yardstick/rake/verify'
+  require 'yardstick/rake/verify'
 
-Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
-  verify.threshold = 100
+  Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
+    verify.threshold = 100
+  end
 end

data/lib/process_executer/monitored_pipe.rb

@@ -9,9 +9,12 @@ module ProcessExecuter
   # When a new MonitoredPipe is created, a pipe is created (via IO.pipe) and
   # a thread is created to read data written to the pipe.
   #
-  # Data that is read from the pipe is written one or more writers passed to
+  # Data that is read from that pipe is written one or more writers passed to
   # `#initialize`.
   #
+  # If any of the writers raise an exception, the monitoring thread will exit, the
+  # pipe will be closed, and the exception will be saved in `#exception`.
+  #
   # `#close` must be called to ensure that (1) the pipe is closed, (2) all data is
   # read from the pipe and written to the writers, and (3) the monitoring thread is
   # killed.
@@ -52,31 +55,38 @@ module ProcessExecuter
     # @param writers [Array<#write>] as data is read from the pipe, it is written to these writers
     # @param chunk_size [Integer] the size of the chunks to read from the pipe
     #
-    def initialize(*writers, chunk_size: 1000)
-      @pipe_reader, @pipe_writer = IO.pipe
-      @chunk_size = chunk_size
+    def initialize(*writers, chunk_size: 100_000)
       @writers = writers
-      @thread = Thread.new { monitor_pipe }
+      @chunk_size = chunk_size
+      @pipe_reader, @pipe_writer = IO.pipe
+      @state = :open
+      @thread = Thread.new do
+        Thread.current.report_on_exception = false
+        Thread.current.abort_on_exception = false
+        monitor
+      end
     end
 
-    # Kill the monitoring thread, read remaining data, and close the pipe
+    # Set the state to `:closing` and wait for the state to be set to `:closed`
+    #
+    # The monitoring thread will see that the state has changed and will close the pipe.
     #
     # @example
-    #   require 'stringio'
     #   data_collector = StringIO.new
     #   pipe = ProcessExecuter::MonitoredPipe.new(data_collector)
+    #   pipe.state #=> :open
     #   pipe.write('Hello World')
     #   pipe.close
+    #   pipe.state #=> :closed
     #   data_collector.string #=> "Hello World"
     #
     # @return [void]
     #
     def close
-      thread.kill
-      thread.join
-      pipe_writer.close
-      read_pipe_output if pipe_reader.wait_readable(0)
-      pipe_reader.close
+      return unless state == :open
+
+      @state = :closing
+      sleep 0.01 until state == :closed
     end
 
     # Return the write end of the pipe so that data can be written to it
@@ -212,26 +222,91 @@ module ProcessExecuter
     # @return [IO] the write end of the pipe
     attr_reader :pipe_writer
 
+    # @!attribute [r]
+    #
+    # The state of the pipe
+    #
+    # Must be either `:open`, `:closing`, or `:closed`
+    #
+    # * `:open` - the pipe is open and data can be written to it
+    # * `:closing` - the pipe is being closed and data can no longer be written to it
+    # * `:closed` - the pipe is closed and data can no longer be written to it
+    #
+    # @example
+    #   pipe = ProcessExecuter::MonitoredPipe.new($stdout)
+    #   pipe.state #=> :open
+    #   pipe.close
+    #   pipe.state #=> :closed
+    #
+    # @return [Symbol] the state of the pipe
+    #
+    attr_reader :state
+
+    # @!attribute [r]
+    #
+    # The exception raised by a writer
+    #
+    # If an exception is raised by a writer, it is stored here. Otherwise, it is `nil`.
+    #
+    # @example
+    #   pipe.exception #=> nil
+    #
+    # @return [Exception, nil] the exception raised by a writer or `nil` if no exception was raised
+    #
+    attr_reader :exception
+
     private
 
-    # Reads data from the pipe forever until the monitoring thread is killed
+    # Read data from the pipe until `#state` is changed to `:closing`
+    #
+    # The state is changed to `:closed` by calling `#close`.
+    #
+    # Before this method returns, state is set to `:closed`
+    #
+    # @return [void]
+    # @api private
+    def monitor
+      monitor_pipe until state == :closing
+      close_pipe
+      @state = :closed
+    end
+
+    # Read data from the pipe until `#state` is changed to `:closing`
+    #
+    # Data read from the pipe is written to the writers given to the constructor.
+    #
     # @return [void]
     # @api private
     def monitor_pipe
-      loop do
-        read_pipe_output if pipe_reader.wait_readable
+      new_data = pipe_reader.read_nonblock(chunk_size)
+      # SimpleCov under JRuby reports the begin statement as not covered, but it is
+      # :nocov:
+      begin
+        # :nocov:
+        writers.each { |w| w.write(new_data) }
+      rescue StandardError => e
+        @exception = e
+        @state = :closing
       end
+    rescue IO::WaitReadable
+      pipe_reader.wait_readable(0.01)
     end
 
-    # Read a chunk of data from the pipe and write it to the writers
+    # Read any remaining data from the pipe and close it
+    #
     # @return [void]
     # @api private
-    def read_pipe_output
-      new_data = pipe_reader.read_nonblock(chunk_size)
-      # puts "Received new data: #{new_data.inspect} from #{pipe_reader.inspect}"
-      writers.each { |w| w.write(new_data) }
-    rescue EOFError, IO::EAGAINWaitReadable
-      # No output to read at this time
+    def close_pipe
+      # Close the write end of the pipe so no more data can be written to it
+      pipe_writer.close
+      # Read remaining data from pipe_reader (if any)
+      # If an exception was already raised by the last call to #write, then don't try to read remaining data
+      if exception.nil? && pipe_reader.wait_readable(0.01)
+        new_data = pipe_reader.read(chunk_size)
+        writers.each { |w| w.write(new_data) }
+      end
+      # Close the read end of the pipe
+      pipe_reader.close
     end
   end
 end

data/lib/process_executer/options.rb

@@ -13,6 +13,10 @@ module ProcessExecuter
   # @api public
   #
   class Options
+    # :nocov:
+    # SimpleCov on JRuby seems to hav a bug that causes hashes declared on multiple lines
+    # to not be counted as covered.
+
     # These options should be passed to `Process.spawn`
     #
     # Additionally, any options whose key is an Integer or an IO object will
@@ -49,6 +53,8 @@ module ProcessExecuter
       timeout: nil
     }.freeze
 
+    # :nocov:
+
     # All options allowed by this class
     #
     ALL_OPTIONS = (SPAWN_OPTIONS + NON_SPAWN_OPTIONS).freeze

data/lib/process_executer/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module ProcessExecuter
-  VERSION = '0.3.0'
+  # The current Gem version
+  VERSION = '0.5.0'
 end

data/lib/process_executer.rb

@@ -2,8 +2,6 @@
 
 require 'process_executer/monitored_pipe'
 require 'process_executer/options'
-require 'process_executer/process'
-require 'process_executer/status'
 
 require 'timeout'
 
@@ -12,15 +10,17 @@ require 'timeout'
 # @api public
 #
 module ProcessExecuter
-  # Execute the specified command and return the exit status
+  # Execute the specified command as a subprocess and return the exit status
   #
-  # This method blocks until the command has terminated or the timeout has been reached.
+  # This method blocks until the command has terminated.
+  #
+  # The command will be send the SIGKILL signal if it does not terminate within
+  # the specified timeout.
   #
   # @example
   #   status = ProcessExecuter.spawn('echo hello')
   #   status.exited? # => true
   #   status.success? # => true
-  #   stdout.string # => "hello\n"
   #
   # @example with a timeout
   #   status = ProcessExecuter.spawn('sleep 10', timeout: 0.01)
@@ -29,6 +29,11 @@ module ProcessExecuter
   #   status.signaled? # => true
   #   status.termsig # => 9
   #
+  # @example capturing stdout to a string
+  #   stdout = StringIO.new
+  #   status = ProcessExecuter.spawn('echo hello', out: stdout)
+  #   stdout.string # => "hello"
+  #
   # @see https://ruby-doc.org/core-3.1.2/Kernel.html#method-i-spawn Kernel.spawn
   #   documentation for valid command and options
   #
@@ -36,13 +41,13 @@ module ProcessExecuter
   #   for additional options that may be specified
   #
   # @param command [Array<String>] the command to execute
-  # @param options_hash [Hash] the options to use for this execution context
+  # @param options_hash [Hash] the options to use when exectuting the command
   #
-  # @return [ProcessExecuter::ExecutionContext] the execution context that can run commands
+  # @return [Process::Status] the exit status of the proceess
   #
   def self.spawn(*command, **options_hash)
     options = ProcessExecuter::Options.new(**options_hash)
-    pid = ::Process.spawn(*command, **options.spawn_options)
+    pid = Process.spawn(*command, **options.spawn_options)
     wait_for_process(pid, options)
   end
 
@@ -53,16 +58,16 @@ module ProcessExecuter
   # @param pid [Integer] the process id
   # @param options [ProcessExecuter::Options] the options used
   #
-  # @return [ProcessExecuter::Status] the status of the process
+  # @return [Process::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
+      Process.wait2(pid).last
     end
   rescue Timeout::Error
-    ::Process.kill('KILL', pid)
-    ::Process.wait2(pid).last
+    Process.kill('KILL', pid)
+    Process.wait2(pid).last
   end
 end

data/process_executer.gemspec

@@ -10,15 +10,15 @@ Gem::Specification.new do |spec|
 
   spec.summary = 'An API for executing commands in a subprocess'
   spec.description = 'An API for executing commands in a subprocess'
-  spec.homepage = 'https://github.com/main_branch/process_executer'
+  spec.homepage = 'https://github.com/main-branch/process_executer'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 2.7.0'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/main_branch/process_executer'
-  spec.metadata['changelog_uri'] = 'https://github.com/main_branch/process_executer'
+  spec.metadata['source_code_uri'] = 'https://github.com/main-branch/process_executer'
+  spec.metadata['changelog_uri'] = 'https://github.com/main-branch/process_executer'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -37,14 +37,17 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
   spec.add_development_dependency 'create_github_release', '~> 0.2'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'redcarpet', '~> 3.5'
   spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'rubocop', '~> 1.36'
   spec.add_development_dependency 'simplecov', '~> 0.21'
   spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
   spec.add_development_dependency 'solargraph', '~> 0.47'
-  spec.add_development_dependency 'yard', '~> 0.9'
-  spec.add_development_dependency 'yardstick', '~> 0.9'
+
+  unless RUBY_PLATFORM == 'java'
+    spec.add_development_dependency 'redcarpet', '~> 3.5'
+    spec.add_development_dependency 'yard', '~> 0.9', '>= 0.9.28'
+    spec.add_development_dependency 'yardstick', '~> 0.9'
+  end
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: process_executer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.47'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +157,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -164,6 +167,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
 - !ruby/object:Gem::Dependency
   name: yardstick
   requirement: !ruby/object:Gem::Requirement
@@ -197,18 +203,16 @@ files:
 - lib/process_executer.rb
 - lib/process_executer/monitored_pipe.rb
 - lib/process_executer/options.rb
-- lib/process_executer/process.rb
-- lib/process_executer/status.rb
 - lib/process_executer/version.rb
 - process_executer.gemspec
-homepage: https://github.com/main_branch/process_executer
+homepage: https://github.com/main-branch/process_executer
 licenses:
 - MIT
 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://github.com/main_branch/process_executer
+  homepage_uri: https://github.com/main-branch/process_executer
+  source_code_uri: https://github.com/main-branch/process_executer
+  changelog_uri: https://github.com/main-branch/process_executer
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []

data/lib/process_executer/process.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module ProcessExecuter
-  # Spawns a process and knows how to check if the process is terminated
-  #
-  # This class is not currently used in this Gem.
-  #
-  # @api public
-  #
-  class Process
-    # Spawns a new process using Process.spawn
-    #
-    # @example
-    #   command = ['echo', 'hello world']
-    #   options = { chdir: '/tmp' }
-    #   process = ProcessExecuter::Process.new(*command, **options)
-    #   process.pid # => 12345
-    #   process.terminated? # => true
-    #   process.status # => #<Process::Status: pid 12345 exit 0>
-    #
-    # @see https://ruby-doc.org/core/Process.html#method-c-spawn Process.spawn documentation
-    #
-    # @param command [Array] the command to execute
-    # @param spawn_options [Hash] the options to pass to Process.spawn
-    #
-    def initialize(*command, **spawn_options)
-      @pid = ::Process.spawn(*command, **spawn_options)
-    end
-
-    # @!attribute [r]
-    #
-    # The id of the process
-    #
-    # @example
-    #   ProcessExecuter::Process.new('echo', 'hello world').pid # => 12345
-    #
-    # @return [Integer] The id of the process
-    #
-    attr_reader :pid
-
-    # @!attribute [r]
-    #
-    # The exit status of the process or `nil` if the process has not terminated
-    #
-    # @example
-    #   ProcessExecuter::Process.new('echo', 'hello world').status # => #<Process::Status: pid 12345 exit 0>
-    #
-    # @return [::Process::Status, nil]
-    #
-    #   The status is set only when `terminated?` is called and returns `true`.
-    #
-    attr_reader :status
-
-    # Return true if the process has terminated
-    #
-    # If the proces has terminated, `#status` is set to the exit status of the process.
-    #
-    # @example
-    #   process = ProcessExecuter::Process.new('echo', 'hello world')
-    #   sleep 1
-    #   process.terminated? # => true
-    #
-    # @return [Boolean] true if the process has terminated
-    #
-    def terminated?
-      return true if @status
-
-      _pid, @status = ::Process.wait2(pid, ::Process::WNOHANG)
-      !@status.nil?
-    end
-  end
-end

data/lib/process_executer/status.rb

@@ -1,345 +0,0 @@
-# frozen_string_literal: true
-
-module ProcessExecuter
-  # A replacement for Process::Status that can be used to mock the exit status of a process
-  #
-  # This class is not currently used in this Gem.
-  #
-  # Process::Status encapsulates the information on the status of a running or
-  # terminated system process. The built-in variable $? is either nil or a
-  # Process::Status object.
-  #
-  # ```ruby
-  # fork { exit 99 }   #=> 26557
-  # Process.wait       #=> 26557
-  # $?.class           #=> Process::Status
-  # $?.to_i            #=> 25344
-  # $? >> 8            #=> 99
-  # $?.stopped?        #=> false
-  # $?.exited?         #=> true
-  # $?.exitstatus      #=> 99
-  # ```
-  #
-  # Posix systems record information on processes using a 16-bit integer. The
-  # lower bits record the process status (stopped, exited, signaled) and the
-  # upper bits possibly contain additional information (for example the program's
-  # return code in the case of exited processes). Pre Ruby 1.8, these bits were
-  # exposed directly to the Ruby program. Ruby now encapsulates these in a
-  # Process::Status object. To maximize compatibility, however, these objects
-  # retain a bit-oriented interface. In the descriptions that follow, when we
-  # talk about the integer value of stat, we're referring to this 16 bit value.
-  #
-  # @api public
-  #
-  class Status
-    # Create a new Status object
-    #
-    # @example
-    #   status = ProcessExecuter::Status.new(999, 0)
-    #   status.exited? # => true
-    #   status.success? # => true
-    #   status.exitstatus # => 0
-    #
-    def initialize(pid, stat)
-      @pid = pid
-      @stat = stat
-    end
-
-    # @!attribute
-    #
-    # The pid of the process
-    #
-    # @example
-    #   status = ProcessExecuter::Status.new(999, 0)
-    #   status.pid # => 999
-    #
-    # @return [Integer]
-    #
-    # @api public
-    #
-    attr_reader :pid
-
-    # @!attribute
-    #
-    # The status code of the process
-    #
-    # @example
-    #   status = ProcessExecuter::Status.new(999, 123)
-    #   status.stat # => 123
-    #
-    # @return [Integer]
-    #
-    # @api public
-    #
-    attr_reader :stat
-
-    # Logical AND of the bits in stat with `other`
-    #
-    # @example Process ended due to an uncaught signal 11 with a core dump
-    #   status = ProcessExecuter::Status.new(999, 139)
-    #   status & 127 # => 11 => the uncaught signal
-    #   !(status & 128).zero? # => true => indicating a core dump
-    #
-    # @param other [Integer] the value to AND with stat
-    #
-    # @return [Integer] the result of the AND operation
-    #
-    def &(other)
-      stat & other
-    end
-
-    # Compare stat to `other`
-    #
-    # @example Process exited normally with exitstatus 99
-    #   status = ProcessExecuter::Status.new(999, 25_344)
-    #   status == 25_344 # => true
-    #
-    # @param other [Integer] the value to compare stat to
-    #
-    # @return [Boolean] true if stat == other, false otherwise
-    #
-    def ==(other)
-      stat == other
-    end
-
-    # rubocop:disable Naming/BinaryOperatorParameterName
-
-    # Shift the bits in stat right `num` places
-    #
-    # @example Process exited normally with exitstatus 99
-    #   status = ProcessExecuter::Status.new(999, 25_344)
-    #   status >> 8 # => 99
-    #
-    # @param num [Integer] the number of places to shift stat
-    #
-    # @return [Integer] the result of the shift operation
-    #
-    def >>(num)
-      stat >> num
-    end
-
-    # rubocop:enable Naming/BinaryOperatorParameterName
-
-    # Returns true if the process generated a coredump upon termination
-    #
-    # Not available on all platforms.
-    #
-    # @example process exited normally with exitstatus 99
-    #   status = ProcessExecuter::Status.new(999, 25_344)
-    #   status.coredump? # => false
-    #
-    # @example process ended due to an uncaught signal 11 with a core dump
-    #   status = ProcessExecuter::Status.new(999, 139)
-    #   status.coredump? # => true
-    #
-    # @return [Boolean] true if stat generated a coredump when it terminated
-    #
-    def coredump?
-      !(stat & 128).zero?
-    end
-
-    # Returns true if the process exited normally
-    #
-    # This happens when the process uses an exit() call or runs to the end of the program.
-    #
-    # @example process exited normally with exitstatus 0
-    #   status = ProcessExecuter::Status.new(999, 0)
-    #   status.exited? # => true
-    #
-    # @example process exited normally with exitstatus 99
-    #   status = ProcessExecuter::Status.new(999, 25_344)
-    #   status.exited? # => true
-    #
-    # @example process ended due to an uncaught signal 11 with a core dump
-    #   status = ProcessExecuter::Status.new(999, 139)
-    #   status.exited? # => false
-    #
-    # @return [Boolean] true if the process exited normally
-    #
-    def exited?
-      (stat & 127).zero?
-    end
-
-    # Returns the exit status of the process
-    #
-    # Returns nil if the process did not exit normally (when `#exited?` is false).
-    #
-    # @example process exited normally with exitstatus 99
-    #   status = ProcessExecuter::Status.new(999, 25_344)
-    #   status.exitstatus # => 99
-    #
-    # @return [Integer, nil] the exit status of the process
-    #
-    def exitstatus
-      stat >> 8 if exited?
-    end
-
-    # Returns true if the process was successful
-    #
-    # This means that `exited?` is true and `#exitstatus` is 0.
-    #
-    # Returns nil if the process did not exit normally (when `#exited?` is false).
-    #
-    # @example process exited normally with exitstatus 0
-    #   status = ProcessExecuter::Status.new(999, 0)
-    #   status.success? # => true
-    #
-    # @example process exited normally with exitstatus 99
-    #   status = ProcessExecuter::Status.new(999, 25_344)
-    #   status.success? # => false
-    #
-    # @example process ended due to an uncaught signal 11 with a core dump
-    #   status = ProcessExecuter::Status.new(999, 139)
-    #   status.success? # => nil
-    #
-    # @return [Boolean, nil] true if successful, false if unsuccessful, nil if the process did not exit normally
-    #
-    def success?
-      exitstatus.zero? if exited?
-    end
-
-    # Returns true if the process was stopped
-    #
-    # @example with a stopped process with signal 17
-    #   status = ProcessExecuter::Status.new(999, 4_479)
-    #   status.stopped? # => true
-    #
-    # @example process exited normally with exitstatus 99
-    #   status = ProcessExecuter::Status.new(999, 25_344)
-    #   status.stopped? # => false
-    #
-    # @example process ended due to an uncaught signal 11 with a core dump
-    #   status = ProcessExecuter::Status.new(999, 139)
-    #   status.stopped? # => false
-    #
-    # @return [Boolean] true if the process was stopped, false otherwise
-    #
-    def stopped?
-      (stat & 127) == 127
-    end
-
-    # The signal number that casused the process to stop
-    #
-    # Returns nil if the process is not stopped.
-    #
-    # @example with a stopped process with signal 17
-    #   status = ProcessExecuter::Status.new(999, 4_479)
-    #   status.stopsig # => 17
-    #
-    # @example process exited normally with exitstatus 99
-    #   status = ProcessExecuter::Status.new(999, 25_344)
-    #   status.stopsig # => nil
-    #
-    # @return [Integer, nil] the signal number that caused the process to stop or nil
-    #
-    def stopsig
-      stat >> 8 if stopped?
-    end
-
-    # Returns true if stat terminated because of an uncaught signal
-    #
-    # @example process ended due to an uncaught signal 9
-    #   status = ProcessExecuter::Status.new(999, 9)
-    #   status.signaled? # => true
-    #
-    # @example process exited normally with exitstatus 0
-    #   status = ProcessExecuter::Status.new(999, 0)
-    #   status.signaled? # => false
-    #
-    # @return [Boolean] true if stat terminated because of an uncaught signal, false otherwise
-    #
-    def signaled?
-      ![0, 127].include?(stat & 127)
-    end
-
-    # Returns the number of the signal that caused the process to terminate
-    #
-    # Returns nil if the process exited normally or is stopped.
-    #
-    # @example process ended due to an uncaught signal 9
-    #   status = ProcessExecuter::Status.new(999, 9)
-    #   status.termsig # => 9
-    #
-    # @example process exited normally with exitstatus 0
-    #   status = ProcessExecuter::Status.new(999, 0)
-    #   status.termsig # => nil
-    #
-    # @return [Integer, nil] the signal number that caused the process to terminate or nil
-    #
-    def termsig
-      stat & 127 if signaled?
-    end
-
-    # Returns the bits in stat as an Integer
-    #
-    # @example with a stopped process with signal 17
-    #   status = ProcessExecuter::Status.new(999, 4_479)
-    #   status.to_i # => 4_479
-    #
-    # @return [Integer] the bits in stat
-    #
-    def to_i
-      stat
-    end
-
-    # Show the status type, pid, and exit status as a string
-    #
-    # @example with a stopped process with signal 17
-    #   status = ProcessExecuter::Status.new(999, 4_479)
-    #   status.to_s # => "pid 999 stopped SIGSTOP (signal 17)"
-    #
-    # @return [String] the status type, pid, and exit status as a string
-    #
-    def to_s
-      type_to_s + (coredump? ? ' (core dumped)' : '')
-    end
-
-    # Show the status type, pid, and exit status as a string
-    #
-    # @example with a stopped process with signal 17
-    #   status = ProcessExecuter::Status.new(999, 4_479)
-    #   status.inspect # => "#<ProcessExecuter::Status pid 999 stopped SIGSTOP (signal 17)>"
-    #
-    # @return [String] the status type, pid, and exit status as a string
-    #
-    def inspect
-      "#<#{self.class} #{self}>"
-    end
-
-    private
-
-    # The string representation of a status based on how it was terminated
-    # @return [String] the string representation
-    # @api private
-    def type_to_s
-      if signaled?
-        signaled_to_s
-      elsif exited?
-        exited_to_s
-      elsif stopped?
-        stopped_to_s
-      end
-    end
-
-    # The string representation of a signaled process
-    # @return [String] the string representation of a signaled process
-    # @api private
-    def signaled_to_s
-      "pid #{pid} SIG#{Signal.signame(termsig)} (signal #{termsig})"
-    end
-
-    # The string representation of an exited process
-    # @return [String] the string representation of an exited process
-    # @api private
-    def exited_to_s
-      "pid #{pid} exit #{exitstatus}"
-    end
-
-    # The string representation of a stopped process
-    # @return [String] the string representation of a stopped process
-    # @api private
-    def stopped_to_s
-      "pid #{pid} stopped SIG#{Signal.signame(stopsig)} (signal #{stopsig})"
-    end
-  end
-end