exeggutor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b9eb0de91468b1ba1d04da72cac44b57eaadd3553719d86910d71f88af67746
+  data.tar.gz: 77713dec1ae04c17322d25563abf517dc406c34f61661e1fd483abf9a307f123
+SHA512:
+  metadata.gz: edfbd0cbe10c2b38812b8a92adfa91566cdd5f4823a4d4e9030a516c7b0c352c465796c7c30b78744db33501d3cf832acf1570076aa47a1db0826621a5d0ab16
+  data.tar.gz: a7bdcd0f7f915dfce050b7cb84ec3ffe92ac46304524e2f51440eeef02417209458f35562256b7e74807795501d893a24eed97cf947481686d5f7bd3a1c7e064

data/lib/exeggutor.rb

@@ -0,0 +1,129 @@
+require 'open3'
+require 'shellwords'
+
+module Exeggutor
+  # Represents the result of a process execution.
+  #
+  # @attr_reader stdout [String] The standard output of the process.
+  # @attr_reader stderr [String] The standard error of the process.
+  # @attr_reader exit_code [Integer] The exit code of the process.
+  class ProcessResult
+    attr_reader :stdout, :stderr, :exit_code
+
+    # @private
+    def initialize(stdout:, stderr:, exit_code:)
+      @stdout = stdout
+      @stderr = stderr
+      @exit_code = exit_code
+    end
+
+    # Checks if the process was successful.
+    #
+    # @return [Boolean] True if the exit code is 0, otherwise false.
+    def success?
+      exit_code == 0
+    end
+  end
+
+  # Represents an error that occurs during a process execution.
+  # The error contains a {ProcessResult} object with details about the process.
+  #
+  # @attr_reader result [ProcessResult] The result of the process execution.
+  class ProcessError < StandardError
+    attr_reader :result
+
+    # @private
+    def initialize(result)
+      @result = result
+    end
+  end
+
+  # @private
+  def self.run_popen3(args, env)
+    if env
+      Open3.popen3(env, [args[0], args[0]], *args.drop(1))
+    else
+      Open3.popen3([args[0], args[0]], *args.drop(1))
+    end
+  end
+
+  # Executes a command with the provided arguments and options
+  #
+  # @param args [Array<String>] The command and its arguments as an array.
+  # @param can_fail [Boolean] If false, raises a ProcessError on failure.
+  # @param show_stdout [Boolean] If true, prints stdout to the console in real-time.
+  # @param show_stderr [Boolean] If true, prints stderr to the console in real-time.
+  # @param cwd [String, nil] The working directory to run the command in. If nil, uses the current working directory.
+  # @param stdin_data [String, nil] Input data to pass to the command's stdin. If nil, doesn't pass any data to stdin.
+  # @param env_vars [Hash{String => String}, nil] A hashmap containing environment variable overrides,
+  #        or `nil` if no overrides are desired
+  #
+  # @return [ProcessResult] An object containing process info such as stdout, stderr, and exit code. Waits for the command to complete to return.
+  #
+  # @raise [ProcessError] If the command fails and `can_fail` is false.
+  def self.run!(args, can_fail: false, show_stdout: false, show_stderr: false, env: nil, cwd: nil, stdin_data: nil)
+    # TODO: expand "~"? popen3 doesn't expand it by default
+    if cwd
+      stdin_stream, stdout_stream, stderr_stream, wait_thread = Dir.chdir(cwd) { Exeggutor::run_popen3(args, env) }
+    else
+      stdin_stream, stdout_stream, stderr_stream, wait_thread = Exeggutor::run_popen3(args, env)
+    end
+
+    stdin_stream.write(stdin_data) if stdin_data
+    stdin_stream.close
+
+    stderr_stream.sync = true # Match terminals more closely
+
+    stdout_str = +''  # Using unfrozen string
+    stderr_str = +''
+
+    # Start readers for both stdout and stderr
+    stdout_thread = Thread.new do
+      while (line = stdout_stream.gets)
+
+        stdout_str << line
+        print line if show_stdout
+      end
+    end
+
+    stderr_thread = Thread.new do
+      while (line = stderr_stream.gets)
+        stderr_str << line
+        warn line if show_stderr
+      end
+    end
+
+    # Wait for process completion
+    exit_status = wait_thread.value
+
+    # Ensure all IO is complete
+    stdout_thread.join
+    stderr_thread.join
+
+    # Close open pipes
+    stdout_stream.close
+    stderr_stream.close
+    
+    result = ProcessResult.new(
+      stdout: stdout_str.force_encoding('UTF-8'),
+      stderr: stderr_str.force_encoding('UTF-8'),
+      exit_code: exit_status.exitstatus
+    )
+
+    if !can_fail && !result.success?
+      error_str = <<~ERROR_STR
+        Command failed: #{args.shelljoin}
+        Exit code: #{result.exit_code}
+        stdout: #{result.stdout}
+        stderr: #{result.stderr}
+      ERROR_STR
+      raise ProcessError.new(result), error_str
+    end
+
+    result
+  end
+end
+
+def run!(...)
+  Exeggutor::run!(...)
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: exeggutor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Eisel
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: michael.eisel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/exeggutor.rb
+homepage: https://github.com/michaeleisel/Exeggutor
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: A Simple, Capable, and Unified Interface for Running Subprocesses in Ruby
+test_files: []