sproc 0.5.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5e5c5c9b6543425812a0b454c1f926a12a5ff8fbf6d7ce5c3bf8885103560c4
-  data.tar.gz: 1a788a9c6571fc1c7aa9a066f3a3c35aeec5248af68022c074849d5450f0eda3
+  metadata.gz: e9b6bbd295c0519d4a06d4b20768cc59c9e08cd940e4fa351eaeb85e32106010
+  data.tar.gz: 285071c6d925fb623c4815bf780f4c1954f6270c2fef2a277ef35e70e8e8775d
 SHA512:
-  metadata.gz: fa1e828e275560ecdc598412ef13e7fc16dfa7f9d3d943cc5bf0952ce4e4a0a6a2ffeaebc43712da5ee023ebd32fc3aae5bf57df06689c0daa01be0b2ef9b301
-  data.tar.gz: 54fe83f84dcd9525e8f3d6b1ff66900a63ab4f83132baaed4abbce10cc9c43731a1f33685671551b6205157b47951471d696739fb7b27d95c4057b9e1feb2a79
+  metadata.gz: 3e9b1730da68e271acf7b6d4e79597af566524666ba59c56d70caa7e45901d850c4de5ba23040664347a7406b8695d149d61f6c17e1b2a96b9842c7307fcd9a7
+  data.tar.gz: eefd86ac13d27c867e6e2329c61fba7b7e4e850ba08daa0a82fb3c8a82e0f3b11663bcaf9b2a00704f57008c650d829fbaa82fadba56b726003ec504437911e3

data/lib/sproc.rb

@@ -2,7 +2,7 @@
 
 require_relative "sproc/version"
 require_relative "sproc/core"
-require_relative "sproc/reporting"
+require_relative "sproc/osinfo"
 
 module SProc
   class Error < StandardError; end

data/lib/sproc/core.rb

@@ -336,6 +336,8 @@ module SProc
         Thread.new do
           until (raw_line = stream.gets).nil?
             process_callback&.call(raw_line)
+            # log stream output directly in debug mode
+            SProc.logger&.debug { raw_line }
             stream_cache << raw_line unless stream_cache.nil?
           end
         rescue IOError => e

data/lib/sproc/osinfo.rb

@@ -0,0 +1,55 @@
+require 'rbconfig'
+
+# helper methods to find out os and execution environment
+module SProc
+  module OSInfo
+    # the supported exec environments
+    module OS
+      WINDOWS = 0
+      LINUX = 1
+      MINGW = 2
+      CYGWIN = 3
+      OSX = 4
+      BSD = 5
+      UNKNOWN = 100
+    end
+
+    # returns the current execution environment
+    def self.os_context
+      case RbConfig::CONFIG['host_os']
+      when /mswin/ then OS::WINDOWS
+      when /mingw/ then OS::MINGW
+      when /cygwin/ then OS::CYGWIN
+      when /darwin/ then OS::OSX
+      when /linux/ then OS::LINUX
+      when /bsd/ then OS::BSD
+      else OS::UNKNOWN
+      end
+    end
+
+    # return the current underlying operating system
+    def self.host_os
+      if [OS::WINDOWS, OS::MINGW, OS::CYGWIN].include?(os_context)
+        OS::WINDOWS
+      else
+        os_context
+      end
+    end
+
+    def on_windows?
+      OSInfo.host_os == OS::WINDOWS
+    end
+
+    def on_linux?
+      OSInfo.os_context == OS::LINUX
+    end
+
+    def on_bsd?
+      OSInfo.os_context == OS::BSD
+    end
+
+    def on_osx?
+      OSInfo.os_context == OS::OSX
+    end
+  end
+end

data/lib/sproc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sproc
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Anders Rillbert
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-28 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -43,8 +43,7 @@ files:
 - bin/setup
 - lib/sproc.rb
 - lib/sproc/core.rb
-- lib/sproc/reporting.rb
-- lib/sproc/utils.rb
+- lib/sproc/osinfo.rb
 - lib/sproc/version.rb
 - sproc.gemspec
 homepage: https://github.com/rillbert/sproc
@@ -55,7 +54,7 @@ metadata:
   homepage_uri: https://github.com/rillbert/sproc
   source_code_uri: https://github.com/rillbert/sproc
   changelog_uri: https://github.com/rillbert/sproc
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Spawn commands as asynch/synch subprocesses.
 test_files: []

data/lib/sproc/reporting.rb

@@ -1,196 +0,0 @@
-require_relative 'core'
-
-# This module is written to provide sub-process
-# execution with some human readable logging of process start/stop/errors
-#
-# It wraps SProc instances and execution with calls to logging methods
-# that tries to make the resulting log user friendly
-module SProc
-  module Reporting
-    class << self
-      attr_accessor :logger
-    end
-
-    def logger
-      Reporting.logger
-    end
-
-    # Run a process synchronuously via the native shell and log
-    # output suitable for a build log
-    #
-    # @param cmd_name   a String containing a descriptive
-    #                        name for what the process will do.
-    # @param cmd, args, opts see SProc.exec_sync
-    #
-    # @return                the SProc instance containing the completed process
-    def report_sync(cmd_name, cmd, *args, **opts)
-      p = create_proc_and_log(cmd_name,
-                              ShellType::NONE, :exec_sync,
-                              cmd, args, opts)
-      report_completed(p)
-      p
-    end
-
-    # Run a process asynchronuously via the native shell and log
-    # output suitable for a build log
-    #
-    # @param cmd_name   a String containing a descriptive
-    #                        name for what the process will do.
-    # @param cmd, args, opts see SProc.exec_sync
-    #
-    # @return                the created SProc instance
-    def report_async(cmd_name, cmd, *args, **opts)
-      create_proc_and_log(cmd_name,
-                          ShellType::NONE, :exec_async,
-                          cmd, args, opts)
-    end
-
-    # Run a process asynchronuously via the Bash shell and log
-    # output suitable for a build log
-    #
-    # @param cmd_name   a String containing a descriptive
-    #                        name for what the process will do.
-    # @param cmd, args, opts see SProc.exec_sync
-    #
-    # @return                the created SProc instance
-    def report_async_within_bash(cmd_name, cmd, *args, **opts)
-      create_proc_and_log(cmd_name,
-                          ShellType::BASH, :exec_async,
-                          cmd, args, opts)
-    end
-
-    # Log output from a completed/aborted process
-    #
-    # @param process   the SProc instance that has run
-    # @return          true/false corresponding to process success
-    def report_completed(process)
-      friendly_name = if @log_friendly_name_map&.key?(process)
-                  "#{@log_friendly_name_map[process]}"
-                else
-                  'Process'
-                end
-      started_ok = true
-      case process.execution_state
-      when ExecutionState::COMPLETED
-        process.exit_zero? && log_completed_ok(friendly_name, process.task_info)
-        !process.exit_zero? && log_completed_err(friendly_name, process.task_info)
-      when ExecutionState::ABORTED
-        log_aborted(friendly_name, process.task_info)
-        started_ok = false
-      when ExecutionState::FAILED_TO_START
-        log_failed_start(friendly_name, process.task_info)
-        started_ok = false
-      else
-        log_unexpected(friendly_name, process.task_info)
-      end
-      started_ok && process.exit_zero?
-    end
-
-    private
-
-    def create_proc_and_log(cmd_name, type, method, cmd, args, opts)
-      log_start(cmd_name, type, method, cmd, args, **opts)
-      p = SProc.new(type: type).send(method, cmd, args, **opts)
-      @log_friendly_name_map ||= {}
-      @log_friendly_name_map[p] = cmd_name
-      p
-    end
-
-    def log_method_result_ok(friendly_name, delta)
-      logger.info do
-        "#{friendly_name} completed successfully after #{delta.round(3)}s"
-      end
-    end
-
-    def log_method_result_error(friendly_name_method, delta, exc)
-      logger.error do
-        "#{friendly_name_method} aborted by #{exc.class} after #{delta.round(3)}s\n"\
-        "Exception info: #{exc.message}"
-      end
-
-      logger.debug do
-        exc.backtrace.to_s
-      end
-    end
-
-    def log_start(cmd_name, type, method, cmd, *args, **opts)
-      logger.info do
-        async_str = method == :exec_async ? 'asynchronuously' : 'synchronuously'
-        type_str = type == ShellType::NONE ? 'without shell' : 'within the bash shell'
-        "'#{cmd_name}' executing #{async_str} #{type_str}..."
-      end
-      logger.debug do
-        msg = String.new("Starting #{cmd}")
-        msg << " with args: #{args.flatten.inspect}" unless args.nil? || args.empty?
-        msg << " and opts: #{opts.inspect}" unless opts.nil? || opts.empty?
-        msg
-      end
-    end
-
-    def log_one_dll(regex, cmd_str, time)
-      m = regex.match(cmd_str)
-      s = m.nil? ? cmd_str : m[1]
-      max = 45
-      s = s.length > max ? s.slice(0..max - 1) : s.ljust(max)
-      logger.info { "#{s} took #{time.round(3)}s." }
-    end
-
-    def log_aborted(friendly_name, p_info)
-      logger.error do
-        "'#{friendly_name}' aborted!\n"\
-        "When running: #{p_info[:cmd_str]}\n"\
-        "#{merge_proc_output(p_info)}"\
-        "#{p_info[:process_status] unless p_info[:process_status].nil?}"
-      end
-    end
-
-    def log_failed_start(friendly_name, p_info)
-      logger.error do
-        "'#{friendly_name}' not run!\n"\
-        "Could not start process using: #{p_info[:cmd_str]}\n"\
-        "#{merge_proc_output(p_info)}"
-      end
-    end
-
-    def log_completed_ok(friendly_name, p_info)
-      logger.info do
-        "'#{friendly_name}' completed successfully after #{p_info[:wall_time].round(3)}s"
-      end
-      logger.debug do
-        "Cmd: #{p_info[:cmd_str]}"
-      end
-    end
-
-    def log_completed_err(friendly_name, p_info)
-      logger.error do
-        "'#{friendly_name}' completed with exit code "\
-        "#{p_info[:process_status].exitstatus}\n"\
-        "When running: #{p_info[:cmd_str]}\n"\
-        "after #{p_info[:wall_time].round(3)}s\n"\
-        "#{merge_proc_output(p_info)}"
-      end
-    end
-
-    def log_unexpected(friendly_name, p_info)
-      logger.error do
-        "'#{friendly_name}' caused unexpected error!"\
-        ' Trying to display info on a running process'\
-        "(#{p_info[:cmd_str]})"
-      end
-    end
-
-    # @return String with sections for each non-empty output stream
-    #                and exception messages
-    def merge_proc_output(p_info)
-      inf_str = %i[stdout stderr].collect do |sym|
-        next('') if p_info[sym].empty?
-
-        "--- #{sym} ---\n#{p_info[sym]}"
-      end.join("\n")
-
-      exc = p_info[:exception]
-      inf_str << "--- exception ---\n#{exc}\n" unless exc.nil?
-      inf_str
-    end
-  end
-end

data/lib/sproc/utils.rb

@@ -1,53 +0,0 @@
-require 'rbconfig'
-
-# utility to find out info about our execution environment
-module OSInfo
-  # the supported exec environments
-  module OS
-    WINDOWS = 0
-    LINUX = 1
-    MINGW = 2
-    CYGWIN = 3
-    OSX = 4
-    BSD = 5
-    UNKNOWN = 100
-  end
-
-  # returns the current execution environment
-  def self.os_context
-    case RbConfig::CONFIG['host_os']
-    when /mswin/ then OS::WINDOWS
-    when /mingw/ then OS::MINGW
-    when /cygwin/ then OS::CYGWIN
-    when /darwin/ then OS::OSX
-    when /linux/ then OS::LINUX
-    when /bsd/ then OS::BSD
-    else OS::UNKNOWN
-    end
-  end
-
-  # return the current underlying operating system
-  def self.host_os
-    if [OS::WINDOWS, OS::MINGW, OS::CYGWIN].include?(os_context)
-      OS::WINDOWS
-    else
-      os_context
-    end
-  end
-
-  def on_windows?
-    host_os == OS::WINDOWS
-  end
-
-  def on_linux?
-    os_context == OS::LINUX
-  end
-
-  def on_bsd?
-    os_context == OS::BSD
-  end
-
-  def on_osx?
-    os_context == OS::OSX
-  end
-end