sproc 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b21c852197676569f95bf84f37a1e2d070a06ee5fb1bbe1b627e2eb9f83500da
-  data.tar.gz: 3f8fe794b2afcb54d50af93e774091ef1fd72e27c221eb2f38a82686ec214f89
+  metadata.gz: 8938c9977d79ffd99b2526dc698d66f33c0afc225121307a7cbf79fe9284acdb
+  data.tar.gz: 0fcd34ab808b76a121a581443b0bf9c075e8bf92633a112c406b11b11691b9ab
 SHA512:
-  metadata.gz: e76140b5a74de9977e60a657ce8c40ad5cf070f3b8c856f954d87ecda0b2cc61a601016b8c8beafd6dd5840dc6dd4cac81eb44b85a3c811fbb38612ea97b0236
-  data.tar.gz: e8999dfdf2a0aa3f577d9c3ed49184989595ac545088b506befcea989782f502c8776fbb851746d696679a2dd84453ef8ebce732e69c53346283c01e024e9fd6
+  metadata.gz: e4da5cce84127eb2b3fda62ba9cb893b588ad1e68b173ad8ef558d8c7f4945c089c74dea20e7be62e7e685bd7efbcf91a6d0616bcc413a7fb4663731151c25da
+  data.tar.gz: 7abf027ed86e29fbc531698feec84c318fda64d3138fa3e22bce81c1f2ef7a79b73aa255274de5f0265453c8df59964a616b912cb41cb55b8e692cd36b0d1fae

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sproc (0.1.0)
+    sproc (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/sproc/core.rb

@@ -7,10 +7,8 @@ module SProc
   # Defines the shell under which to invoke the sub-process
   module ShellType
     SHELL_TYPES = [
-      # Use the default shell for the platform we're on.
-      # - For Windows, it seems to be the 'cmd prompt'
-      # - For current ubuntu, it seems to be 'dash'
-      NATIVE = 0, 
+      # Start the process without any shell
+      NONE = 0,
       # Will create a 'bash' instance and run the subprocess
       # within that instance.
       BASH = 1
@@ -58,10 +56,13 @@ module SProc
     #                        from the process as it is running (default nil)
     # @param stderr_callback a callback that will receive all stderr output
     #                        from the process as it is running (default nil)
+    # @param env             a hash containing key/value pairs of strings that
+    #                        set the environment variable 'key' to 'value'. If value
+    #                        is nil, that env variable is unset
     #
     # example callback signature: def my_stdout_cb(line)
-    def initialize(type = ShellType::NATIVE, stdout_callback = nil,
-                   stderr_callback = nil)
+    def initialize(type: ShellType::NONE, stdout_callback: nil,
+                   stderr_callback: nil, env: {})
       @run_opts = {
         type: type,
         stdout_callback: stdout_callback,
@@ -69,10 +70,12 @@ module SProc
       }
       @runner = TaskRunner.new(@run_opts)
       @execution_thread = nil
+      @env = env
     end
 
     # Return the execution state of this SubProcess. Note that it is not
     # identical with the life-cycle of the underlying ProcessStatus object
+    #
     # @return current ExecutionState
     def execution_state
       return ExecutionState::NOT_STARTED if @execution_thread.nil?
@@ -106,18 +109,25 @@ module SProc
       raise RuntimeError("Unhandled process status: #{status.inspect}")
     end
 
-    # Start the process non-blocking. Use one of the wait... methods
-    # to later block on the process.
+    # Start the sub-process and block until it has completed.
+    #
+    #
+    # @cmd    the command to execute
+    # @args   an array with all arguments to the cmd
+    # @opts   a hash with options that influence the spawned process
+    #         the supported options are: chdir umask unsetenv_others
+    #         See Process.spawn for definitions
+    #
     # @return this SubProcess instance
     def exec_sync(cmd, *args, **opts)
-      exec(true, cmd, *args, **opts)
+      exec(true, @env, cmd, *args, **opts)
     end
 
     # Start the process non-blocking. Use one of the wait... methods
     # to later block on the process.
     # @return this SubProcess instance
     def exec_async(cmd, *args, **opts)
-      exec(false, cmd, *args, **opts)
+      exec(false, @env, cmd, *args, **opts)
     end
 
     # check if this process has completed with exit code 0
@@ -170,7 +180,7 @@ module SProc
     # # start 3 processes asyncronously
     # nof_processes = 3
     # p_array = (1..nof_processes).collect do
-    #   SubProcess.new(SubProcess::NATIVE).exec_async('ping', ['127.0.0.1'])
+    #   SubProcess.new(SubProcess::NONE).exec_async('ping', ['127.0.0.1'])
     # end
     #
     # # block until a process completes and then immediately start a new process
@@ -218,13 +228,13 @@ module SProc
 
     private
 
-    def exec(synch, cmd, *args, **opts)
-      raise RuntimeError,"Subprocess already running!" unless @execution_thread.nil? || !@execution_thread.alive?
+    def exec(synch, env, cmd, *args, **opts)
+      raise 'Subprocess already running!' unless @execution_thread.nil? || !@execution_thread.alive?
 
       # kick-off a fresh task runner and execution thread
       @runner = TaskRunner.new(@run_opts)
       @execution_thread = Thread.new do
-        @runner.execute(cmd, *args, **opts)
+        @runner.execute(env, cmd, *args, **opts)
       end
       @execution_thread.join if synch
       self
@@ -238,8 +248,11 @@ module SProc
 
       include ShellType
 
+      # Restrict the options to Process.spawn that we support to these
+      SUPPORTED_SPAWN_OPTS = %i[chdir umask unsetenv_others]
+
       DEFAULT_OPTS = {
-        type: NATIVE,
+        type: NONE,
         stdout_callback: nil,
         stderr_callback: nil
       }.freeze
@@ -250,12 +263,12 @@ module SProc
       end
 
       # Runs the process and blocks until it is completed or aborted.
-      # The stdout and stdin streams are continuously read in parallal with
+      # The stdout and stdin streams are continuously read in parallel with
       # the process execution.
-      def execute(cmd, *args, **opts)
+      def execute(env, cmd, *args, **opts)
         start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
         begin
-          shell_out_via_popen(cmd, *args, **opts)
+          shell_out_via_popen(env, cmd, *args, **opts)
         rescue StandardError => e
           @task_info[:exception] = e
         end
@@ -266,14 +279,26 @@ module SProc
 
       private
 
-      def shell_out_via_popen(cmd, *args, **opts)
+      def valid_opts(**opts)
+        return opts if opts.nil? || opts.empty?
+
+        supported = {}
+        SUPPORTED_SPAWN_OPTS.each { |o| supported[o] = opts[o] if opts.has_key?(o) }
+        supported
+      end
+
+      def shell_out_via_popen(env, cmd, *args, **opts)
+        opts = valid_opts(**opts)
         args = case @opts[:type]
-               when NATIVE then get_args_native(cmd, *args, **opts)
-               when BASH   then get_args_bash(cmd, *args, **opts)
+               when NONE then get_args_native(cmd, *args, **opts)
+               when BASH then get_args_bash(cmd, *args, **opts)
                else raise ArgumentError, "Unknown task type: #{@type}!!"
                end
+
         SProc.logger&.debug { "Start: #{task_info[:cmd_str]}" }
-        Open3.popen3(*args) do |stdin, stdout, stderr, thread|
+        SProc.logger&.debug { "Supplying env: #{env}" } unless env.nil?
+        SProc.logger&.debug { "Spawn options: #{opts}" } unless opts.nil?
+        Open3.popen3(env, *args) do |stdin, stdout, stderr, thread|
           @task_info[:popen_thread] = thread
           threads = do_while_process_running(stdin, stdout, stderr)
           @task_info[:process_status] = thread.value
@@ -306,16 +331,14 @@ module SProc
       def process_output_stream(stream, stream_cache = nil,
                                 process_callback = nil)
         Thread.new do
-          begin
-            until (raw_line = stream.gets).nil?
-              process_callback&.call(raw_line)
-              stream_cache << raw_line unless stream_cache.nil?
-            end
-          rescue IOError => e
-            l = SProc.logger
-            l&.warn { 'Stream closed before all output were read!' }
-            l&.warn { e.message }
+          until (raw_line = stream.gets).nil?
+            process_callback&.call(raw_line)
+            stream_cache << raw_line unless stream_cache.nil?
           end
+        rescue IOError => e
+          l = SProc.logger
+          l&.warn { 'Stream closed before all output were read!' }
+          l&.warn { e.message }
         end
       end
     end

data/lib/sproc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SProc
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/sproc.gemspec

@@ -1,39 +1,40 @@
 # frozen_string_literal: true
 
-require_relative "lib/sproc/version"
+require_relative 'lib/sproc/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sproc"
+  spec.name          = 'sproc'
   spec.version       = SProc::VERSION
-  spec.authors       = ["Anders Rillbert"]
-  spec.email         = ["anders.rillbert@kutso.se"]
+  spec.authors       = ['Anders Rillbert']
+  spec.email         = ['anders.rillbert@kutso.se']
 
-  spec.summary       = "Run subprocess asynch/synch."
-  spec.description   = "Run subprocess asynch/synch."
-  spec.homepage      = "https://github.com/rillbert/sproc"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.summary       = 'Spawn commands as asynch/synch subprocesses.'
+  spec.description   = 'Easier invokation of asynch/synch commands with '\
+                       'a reasonable easy and flexible interface for processing stdout and stderr'
+  spec.homepage      = 'https://github.com/rillbert/sproc'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
 
   # 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.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   # Developer dependencies
-  spec.add_development_dependency "minitest", "~> 5.1"
+  spec.add_development_dependency 'minitest', '~> 5.1'
 
   # Uncomment to register a new dependency of your gem
-#  spec.add_dependency "example-gem", "~> 1.0"
+  #  spec.add_dependency "example-gem", "~> 1.0"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sproc
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Anders Rillbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-19 00:00:00.000000000 Z
+date: 2021-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -24,7 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
-description: Run subprocess asynch/synch.
+description: Easier invokation of asynch/synch commands with a reasonable easy and
+  flexible interface for processing stdout and stderr
 email:
 - anders.rillbert@kutso.se
 executables: []
@@ -71,5 +72,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Run subprocess asynch/synch.
+summary: Spawn commands as asynch/synch subprocesses.
 test_files: []