qbash 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e872574e62d1c8a6c104b3073529e89aef6bb4cbf0e72d96c464b91e82d96ee
-  data.tar.gz: 020a400a253c7467a8d4bf5fcd7bcab4991174ba500b792e5afb2cb80214c2f7
+  metadata.gz: d9269eaeacc7fe858cd6e08abbcb5b66ed09b3f4bf06bbca5ea976e19cc2f125
+  data.tar.gz: bb0ce33d753a822af98417da51d716a5726f29df839da3c7b17bb51bdf37c9e4
 SHA512:
-  metadata.gz: c104aba85b47d33cac8a92acf3d6c917dc40a9c813e04c65dec7c2d694860d9ae34118e3042f9d37f0fd596162b7e647074bd2c7275409b8abb0aefbd3cfa68e
-  data.tar.gz: 76a9724d3477772a856ede1693668b665afc53b07d442e01b9380d1a6a7e90a163f1d88991a9232f9aa4b062c62e5006df5bdb805939c6d73a3b735abcca4744
+  metadata.gz: 3cee929894765836118f8bdbd5a505a0259586d15c5337d804806dbae2f994aa8f2f184d49e9e0d67edc42dea6d2c4b255e14a28276339f619f1635292e4b27f
+  data.tar.gz: e1241fe9604fd13a4c8352a56b408be3fe442c5518d13280496ca2f002e1b66579ba31911db8452a46b673dfb8b3a55a0e7911b24486c4e1b29ab9e4b6fdc07f

data/Gemfile.lock

@@ -10,13 +10,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
     ansi (1.5.0)
     ast (2.4.3)
     backtrace (0.4.1)
     base64 (0.3.0)
-    bigdecimal (3.3.1)
+    bigdecimal (4.0.1)
     builder (3.3.0)
     crack (1.0.1)
       bigdecimal
@@ -33,39 +33,41 @@ GEM
       mini_mime (~> 1.1)
       multi_test (~> 1.1)
       sys-uname (~> 1.3)
-    cucumber-ci-environment (10.0.1)
-    cucumber-core (15.4.0)
-      cucumber-gherkin (> 27, < 40)
-      cucumber-messages (> 26, < 33)
-      cucumber-tag-expressions (> 5, < 9)
-    cucumber-cucumber-expressions (18.0.1)
+    cucumber-ci-environment (11.0.0)
+    cucumber-core (16.1.1)
+      cucumber-gherkin (> 36, < 40)
+      cucumber-messages (> 31, < 33)
+      cucumber-tag-expressions (> 6, < 9)
+    cucumber-cucumber-expressions (19.0.0)
       bigdecimal
-    cucumber-gherkin (34.0.0)
-      cucumber-messages (> 25, < 29)
-    cucumber-html-formatter (21.15.1)
-      cucumber-messages (> 19, < 28)
-    cucumber-messages (27.2.0)
+    cucumber-gherkin (38.0.0)
+      cucumber-messages (>= 31, < 33)
+    cucumber-html-formatter (22.3.0)
+      cucumber-messages (> 23, < 33)
+    cucumber-messages (32.0.1)
     cucumber-tag-expressions (8.1.0)
     date (3.5.1)
     diff-lcs (1.6.2)
     docile (1.4.1)
-    elapsed (0.2.0)
+    elapsed (0.2.2)
       loog (~> 0.6)
       tago (~> 0.1)
+    ellipsized (0.3.0)
     erb (6.0.1)
-    ffi (1.17.2-aarch64-linux-gnu)
-    ffi (1.17.2-arm-linux-gnu)
-    ffi (1.17.2-arm64-darwin)
-    ffi (1.17.2-x64-mingw-ucrt)
-    ffi (1.17.2-x86-linux-gnu)
-    ffi (1.17.2-x86_64-darwin)
-    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.3-aarch64-linux-gnu)
+    ffi (1.17.3-arm-linux-gnu)
+    ffi (1.17.3-arm64-darwin)
+    ffi (1.17.3-x64-mingw-ucrt)
+    ffi (1.17.3-x86-linux-gnu)
+    ffi (1.17.3-x86_64-darwin)
+    ffi (1.17.3-x86_64-linux-gnu)
     hashdiff (1.2.1)
     json (2.18.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
-    loog (0.6.1)
+    loog (0.7.2)
+      ellipsized
       logger (~> 1.0)
     memoist3 (1.0.0)
     mini_mime (1.1.5)
@@ -79,36 +81,36 @@ GEM
       ruby-progressbar
     multi_test (1.1.0)
     net-ping (2.0.8)
-    nokogiri (1.18.10)
+    nokogiri (1.19.0)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.18.10-aarch64-linux-gnu)
+    nokogiri (1.19.0-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.10-arm-linux-gnu)
+    nokogiri (1.19.0-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.10-arm64-darwin)
+    nokogiri (1.19.0-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.10-x64-mingw-ucrt)
+    nokogiri (1.19.0-x64-mingw-ucrt)
       racc (~> 1.4)
-    nokogiri (1.18.10-x86_64-darwin)
+    nokogiri (1.19.0-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.10-x86_64-linux-gnu)
+    nokogiri (1.19.0-x86_64-linux-gnu)
       racc (~> 1.4)
     parallel (1.27.0)
-    parser (3.3.10.0)
+    parser (3.3.10.1)
       ast (~> 2.4.1)
       racc
-    prism (1.6.0)
+    prism (1.8.0)
     psych (5.3.1)
       date
       stringio
-    public_suffix (6.0.2)
+    public_suffix (7.0.2)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.1)
     random-port (0.7.6)
       tago (~> 0.0)
-    rdoc (7.0.3)
+    rdoc (7.1.0)
       erb
       psych (>= 4.0.0)
       tsort
@@ -125,9 +127,9 @@ GEM
       rubocop-ast (>= 1.48.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.48.0)
+    rubocop-ast (1.49.0)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
+      prism (~> 1.7)
     rubocop-minitest (0.38.2)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
@@ -153,11 +155,11 @@ GEM
     sys-uname (1.4.1)
       ffi (~> 1.1)
       memoist3 (~> 1.0.0)
-    tago (0.3.0)
+    tago (0.7.0)
     tsort (0.2.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
-    unicode-emoji (4.1.0)
+    unicode-emoji (4.2.0)
     w3c_validators (1.3.7)
       json (>= 1.8)
       nokogiri (~> 1.6)

data/README.md

@@ -28,13 +28,23 @@ Then, you can use [qbash] global function:
 
 ```ruby
 require 'qbash'
-stdout = qbash('echo "Hello, world!"', log: $stdout)
+stdout = qbash('echo "Hello, world!"')
 ```
 
 If the command fails, an exception is raised.
 
-The function automatically merges `stderr` with `stdout`
-  (you can't change this).
+By default, `stderr` merges with the `stdout` logger.
+You can redirect it elsewhere:
+
+```ruby
+# Redirect stderr to a separate logger
+out = Loog::Buffer.new
+err = Loog::Buffer.new
+qbash('cmd', stdout: out, stderr: err)
+
+# Discard stderr completely
+qbash('cmd', stderr: nil)
+```
 
 It's possible to provide the standard input and environment variables:
 
@@ -48,7 +58,7 @@ It's possible to configure the logging facility too, for example,
 
 ```ruby
 require 'loog'
-qbash('echo "Hello, world!"', log: Loog::VERBOSE)
+qbash('echo "Hello, world!"', stdout: Loog::VERBOSE)
 ```
 
 You can also make it return both stdout and exit code,

data/lib/qbash.rb

@@ -51,12 +51,12 @@ module Kernel
   #
   # == Logging
   #
-  #   # Enable detailed logging to stdout
-  #   qbash('ls -la', log: $stdout)
+  #   # Enable detailed logging to console
+  #   qbash('ls -la', stdout: $stdout)
   #
   #   # Use custom logger with specific level
   #   logger = Logger.new($stdout)
-  #   qbash('make all', log: logger, level: Logger::INFO)
+  #   qbash('make all', stdout: logger, level: Logger::INFO)
   #
   # == Process Control
   #
@@ -67,8 +67,30 @@ module Kernel
   #     # Process will be terminated when block exits
   #   end
   #
+  # == Changing Working Directory
+  #
+  #   # Execute command in a specific directory
+  #   files = qbash('ls -la', chdir: '/tmp')
+  #
+  #   # Useful for commands that operate on the current directory
+  #   qbash('git status', chdir: '/path/to/repo')
+  #
   # For command with multiple arguments, you can use +Shellwords.escape()+ to
-  # properly escape each argument. Stderr automatically merges with stdout.
+  # properly escape each argument.
+  #
+  # == Stderr Handling
+  #
+  # By default, stderr merges with stdout. You can redirect it elsewhere:
+  #
+  #   # Merge stderr with stdout (default)
+  #   output = qbash('cmd', stderr: :stdout)
+  #
+  #   # Redirect stderr to a separate logger
+  #   err_log = Loog::Buffer.new
+  #   output = qbash('cmd', stderr: err_log)
+  #
+  #   # Discard stderr completely
+  #   output = qbash('cmd', stderr: nil)
   #
   # Read this <a href="https://github.com/yegor256/qbash">README</a> file for more details.
   #
@@ -76,87 +98,95 @@ module Kernel
   # @param [String] stdin The +stdin+ to provide to the command
   # @param [Array] opts List of bash options, like "--login" and "--noprofile"
   # @param [Hash] env Hash of environment variables
-  # @param [Loog|IO] log Logging facility with +.debug()+ method (or +$stdout+, or nil if should go to +/dev/null+)
+  # @param [Loog|IO] stdout Logging facility with +.debug()+ method (or +$stdout+, or nil if should go to +/dev/null+)
+  # @param [Loog|IO] stderr Where to send stderr
   # @param [Array] accept List of accepted exit codes (accepts all if the list is +nil+)
   # @param [Boolean] both If set to TRUE, the function returns an array +(stdout, code)+
   # @param [Integer] level Logging level (use +Logger::DEBUG+, +Logger::INFO+, +Logger::WARN+, or +Logger::ERROR+)
+  # @param [String] chdir Directory to change to before running the command (or +nil+ to use current directory)
   # @return [String] Everything that was printed to the +stdout+ by the command
-  def qbash(*cmd, opts: [], stdin: '', env: {}, log: Loog::NULL, accept: [0], both: false, level: Logger::DEBUG)
+  def qbash(*cmd, opts: [], stdin: '', env: {}, stdout: Loog::NULL, stderr: nil, accept: [0], both: false,
+            level: Logger::DEBUG, chdir: nil)
+    stderr ||= stdout
     env.each { |k, v| raise "env[#{k}] is nil" if v.nil? }
     cmd = cmd.reject { |a| a.nil? || (a.is_a?(String) && a.empty?) }.join(' ')
-    logit =
-      lambda do |msg|
+    mtd =
+      case level
+      when Logger::DEBUG
+        :debug
+      when Logger::INFO
+        :info
+      when Logger::WARN
+        :warn
+      when Logger::ERROR
+        :error
+      else
+        raise "Unknown log level #{level}"
+      end
+    printer =
+      lambda do |target, msg|
         msg = msg.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?').gsub(/\n$/, '')
-        mtd =
-          case level
-          when Logger::DEBUG
-            :debug
-          when Logger::INFO
-            :info
-          when Logger::WARN
-            :warn
-          when Logger::ERROR
-            :error
-          else
-            raise "Unknown log level #{level}"
-          end
-        if log.nil?
+        if target.nil?
           # nothing to print
-        elsif log.respond_to?(mtd)
-          log.__send__(mtd, msg)
+        elsif target.respond_to?(mtd)
+          target.__send__(mtd, msg)
         else
-          log.print("#{msg}\n")
+          target.print("#{msg}\n")
         end
       end
-    buf = ''
+    buf = +''
     e = 1
     start = Time.now
     bash = ['/bin/bash'] + opts + ['-c', cmd]
-    Open3.popen2e(env, *bash) do |sin, sout, ctrl|
+    popen = chdir.nil? ? [env, *bash] : [env, *bash, { chdir: }]
+    Open3.send(:popen3, *popen) do |sin, sout, serr, ctrl|
       pid = ctrl.pid
-      logit["+ #{cmd} /##{pid}"]
+      printer[stderr, "+ #{cmd} /##{pid}"]
       consume =
-        lambda do
+        lambda do |stream, target, buffer|
           loop do
             sleep 0.001
-            break if sout.closed? || sout.eof?
-            ln = sout.gets # together with the \n at the end
+            break if stream.closed? || stream.eof?
+            ln = stream.gets
             next if ln.nil?
             next if ln.empty?
-            buf += ln
-            ln = "##{ctrl.pid}: #{ln}"
-            logit[ln]
+            buffer << ln if buffer
+            printer[target, "##{pid}: #{ln}"]
           rescue IOError => e
-            logit[e.message]
+            printer[stderr, e.message]
             break
           end
         end
       sin.write(stdin)
       sin.close
       if block_given?
-        watch = Thread.new { consume.call }
+        watch = Thread.new { consume.call(sout, stdout, buf) }
         watch.abort_on_exception = true
         begin
           yield pid
         ensure
           sout.close
+          serr&.close
           watch.join(0.01)
           watch.kill if watch.alive?
           attempt = 1
           since = Time.now
           loop do
-            Process.kill(0, pid) # should be dead already (raising Errno::ESRCH)
-            Process.kill('TERM', pid) # let's try to kill it
-            logit["Tried to stop ##{pid} with SIGTERM (attempt no.#{attempt}, #{since.ago}): #{cmd}"]
+            Process.kill(0, pid)
+            Process.kill('TERM', pid)
+            printer[stderr, "Tried to stop ##{pid} with SIGTERM (attempt no.#{attempt}, #{since.ago}): #{cmd}"]
             sleep(0.1)
             attempt += 1
           rescue Errno::ESRCH
-            logit["Process ##{pid} reacted to SIGTERM, after #{attempt} attempts and #{since.ago}"] if attempt > 1
+            if attempt > 1
+              printer[stderr,
+                      "Process ##{pid} reacted to SIGTERM, after #{attempt} attempts and #{since.ago}"]
+            end
             break
           end
         end
       else
-        consume.call
+        consume.call(sout, stdout, buf)
       end
       e = ctrl.value.exitstatus
       if !accept.nil? && !accept.include?(e)

data/qbash.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=3.2'
   s.name = 'qbash'
-  s.version = '0.5.0'
+  s.version = '0.7.0'
   s.license = 'MIT'
   s.summary = 'Quick Executor of a BASH Command'
   s.description =

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qbash
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Yegor Bugayenko