awesome_spawn 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dff33751b72552d7d01e1bfa6e024881148c8d64e309daaa2504107aa6b28f9
-  data.tar.gz: 2d10fb491e209ba595dc1e8eb3751901d45ec427ddc56e3b3108606350881dab
+  metadata.gz: 1a45e9f8c95531c5305ea8f7d275d8ac81b458a5330787f2077c928266ce06c1
+  data.tar.gz: a61d2f6dfba0a30e79a3351f0776ec9c5ff8dd1ae433f42ac3d0f50b400d8a97
 SHA512:
-  metadata.gz: 9b2ab733dc7226ac633d416500a8ddcec2d44a835431645560997acf3621636ad94286eb6431e92fdad88212ec151ad0046371d6c05006eed2d8dcd6e9bf1164
-  data.tar.gz: f4754e31a144048fc5988a664d997da432ac7af5883234ffd7ee4e205d620eab9e715d7980cdb6668f1a28f369cfffeb798867a56186be2a45222bb18387b263
+  metadata.gz: b2bcb990402d54dc83338bf4aa85aa4a963384cdb5df6c26ff6c40d65783232a1d2425641cc892bff6b76634acf2f4fb074a02bbd15117f141b6085ddf14ffea
+  data.tar.gz: 1f1112bebe43856a532c0120394229ce2efebb3744b236a68ce5b8264808da11fd6f5034201937b7d2fb22071150589b1201c74182030102037388d871c75ae7

data/README.md

@@ -1,10 +1,9 @@
 # AwesomeSpawn
 
 [![Gem Version](https://badge.fury.io/rb/awesome_spawn.png)](http://badge.fury.io/rb/awesome_spawn)
-[![Build Status](https://travis-ci.org/ManageIQ/awesome_spawn.png)](https://travis-ci.org/ManageIQ/awesome_spawn)
+[![CI](https://github.com/ManageIQ/awesome_spawn/actions/workflows/ci.yaml/badge.svg)](https://github.com/ManageIQ/awesome_spawn/actions/workflows/ci.yaml)
 [![Code Climate](https://codeclimate.com/github/ManageIQ/awesome_spawn.png)](https://codeclimate.com/github/ManageIQ/awesome_spawn)
 [![Coverage Status](https://coveralls.io/repos/ManageIQ/awesome_spawn/badge.png?branch=master)](https://coveralls.io/r/ManageIQ/awesome_spawn)
-[![Dependency Status](https://gemnasium.com/ManageIQ/awesome_spawn.png)](https://gemnasium.com/ManageIQ/awesome_spawn)
 
 AwesomeSpawn is a module that provides some useful features over Ruby's Kernel.spawn.
 

data/lib/awesome_spawn/command_line_builder.rb

@@ -63,9 +63,7 @@ module AwesomeSpawn
     end
 
     def sanitize_associative_array(assoc_array)
-      assoc_array.each.with_object([]) do |item, array|
-        array.concat(sanitize_item(item))
-      end
+      assoc_array.flat_map { |item| sanitize_item(item) }
     end
 
     def sanitize_item(item)

data/lib/awesome_spawn/command_result.rb

@@ -1,11 +1,12 @@
 module AwesomeSpawn
   class CommandResult
-    attr_reader :command_line, :output, :error, :exit_status
+    attr_reader :command_line, :output, :error, :pid, :exit_status
 
-    def initialize(command_line, output, error, exit_status)
+    def initialize(command_line, output, error, pid, exit_status)
       @command_line = command_line
       @output       = output
       @error        = error
+      @pid          = pid
       @exit_status  = exit_status
     end
 

data/lib/awesome_spawn/spec_helper.rb

@@ -2,6 +2,34 @@ require 'awesome_spawn'
 
 module AwesomeSpawn
   module SpecHelper
+    # Disable spawning for specs
+    #
+    # @example Disable spawning for all specs
+    #   RSpec.configure do |config|
+    #     AwesomeSpawn::SpecHelper.disable_spawning(config)
+    #   end
+    #
+    # @example Disable spawning for specs in a specific path
+    #   RSpec.configure do |config|
+    #     AwesomeSpawn::SpecHelper.disable_spawning(config, file_path: "spec/models")
+    #   end
+    #
+    # @param config [RSpec::Core::Configuration] RSpec configuration
+    # @param file_path [String] Restrict the disabling to a specific set of specs in the given path
+    def self.disable_spawning(config, file_path: nil)
+      if file_path
+        config.define_derived_metadata(:file_path => file_path) do |metadata|
+          metadata[:uses_awesome_spawn] = true
+        end
+        config.include AwesomeSpawn::SpecHelper, :uses_awesome_spawn => true
+        config.before(:each, :uses_awesome_spawn) { disable_spawning }
+      else
+        config.include AwesomeSpawn::SpecHelper
+        config.before { disable_spawning }
+      end
+      config
+    end
+
     def disable_spawning
       allow(Open3).to receive(:capture3)
         .and_raise("Spawning is not permitted in specs.  Please change your spec to use expectations/stubs.")
@@ -33,13 +61,14 @@ module AwesomeSpawn
       options = options.dup
       output = options.delete(:output) || ""
       error  = options.delete(:error)  || (mode == :bad ? "Failure" : "")
+      pid    = options.delete(:pid)    || ""
       exit_status = options.delete(:exit_status) || (mode == :bad ? 1 : 0)
 
       command_line = AwesomeSpawn.build_command_line(command, options[:params])
 
       args = [command, options]
 
-      result = CommandResult.new(command_line, output, error, exit_status)
+      result = CommandResult.new(command_line, output, error, pid, exit_status)
       if method == :run! && mode == :bad
         error_message = CommandResultError.default_message(command, exit_status)
         error = CommandResultError.new(error_message, result)

data/lib/awesome_spawn/version.rb

@@ -1,3 +1,3 @@
 module AwesomeSpawn
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/lib/awesome_spawn.rb

@@ -17,7 +17,7 @@ module AwesomeSpawn
   end
 
   # Execute `command` synchronously via Kernel.spawn and gather the output
-  #   stream, error stream, and exit status in a {CommandResult}.
+  #   stream, error stream, pid, and exit status in a {CommandResult}.
   #
   # @example With normal output
   #   result = AwesomeSpawn.run('echo Hi')
@@ -77,12 +77,15 @@ module AwesomeSpawn
       options[:stdin_data] = in_data
     end
 
-    output, error, status = launch(env, command_line, options)
+    output, error, process_status = launch(env, command_line, options)
+    status = process_status && process_status.exitstatus
+    pid = process_status.pid if process_status
+
   rescue Errno::ENOENT => err
     raise NoSuchFileError.new(err.message) if NoSuchFileError.detected?(err.message)
     raise
   else
-    CommandResult.new(command_line, output, error, status)
+    CommandResult.new(command_line, output, error, pid, status)
   end
 
   # Same as {#run}, additionally raising a {CommandResultError} if the exit
@@ -111,6 +114,35 @@ module AwesomeSpawn
     command_result
   end
 
+  # Execute `command` in a detached manner
+  # The defalt is to spawn a new child process that sends the output to the null device
+  # @param [String] command the command to execute
+  # @param [Hash{Symbol,Object}] options the Kernel.spawn options
+  #   by default the :err, and :out are redirected to the null device.
+  #   For windows, default :pgroup_new is true (make a root process of a new process group)
+  #   For others,  default :pgroup is true (make a new process group)
+  # @returns [Integer] pid of new process
+  #
+  # @example With normal output
+  #   AwesomeSpawn.run_detached('echo "Hi" > /tmp/out')
+  #   # => 79901
+  #
+  # if a user defines :out or :err, it is assumed they will define both
+  def run_detached(command, options = {})
+    env, command_line, options = parse_command_options(command, options)
+    # maybe add support later for this
+    raise ArgumentError, "options cannot contain :in_data" if options.include?(:in_data)
+
+    options[[:out, :err]] = [IO::NULL, "w"] unless (options.keys.flatten & [:out, :err]).any?
+    if Gem.win_platform?
+      options[:new_pgroup]  = true unless options.key?(:new_pgroup)
+    else
+      options[:pgroup]      = true unless options.key?(:pgroup)
+    end
+
+    detach(env, command_line, options)
+  end
+
   # (see CommandLineBuilder#build)
   def build_command_line(command, params = nil)
     CommandLineBuilder.new.build(command, params)
@@ -126,7 +158,7 @@ module AwesomeSpawn
     else
       output, error, status = Open3.capture3(env, command, spawn_options)
     end
-    return output, error, status && status.exitstatus
+    return output, error, status
   end
 
   def parse_command_options(command, options)
@@ -136,4 +168,8 @@ module AwesomeSpawn
 
     [env, build_command_line(command, params), options]
   end
+
+  def detach(env, command, options)
+    Process.detach(Kernel.spawn(env, command, options)).pid
+  end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: awesome_spawn
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Jason Frey
 - Brandon Dunne
 - Joe Rafaniello
 - Mo Morsi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2023-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: manageiq-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -42,7 +42,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -56,7 +56,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -69,6 +69,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
 description: AwesomeSpawn is a module that provides some useful features over Ruby's
   Kernel.spawn.
 email:
@@ -95,7 +109,7 @@ homepage: https://github.com/ManageIQ/awesome_spawn
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,8 +124,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: AwesomeSpawn is a module that provides some useful features over Ruby's Kernel.spawn.
 test_files: []