qbash 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 513c4fae2df78a6b4ae254b80dcd5e306c34a68cb8c1e869c3073ee612504d41
-  data.tar.gz: 424695c22db403cfa8ad40def087742cb804a08e4d5c858f378c02ebd3a12303
+  metadata.gz: ddc357961a48953ee7c479583b6d648d9ad34873510e7ef6d8096a7bd8e596b5
+  data.tar.gz: 16dfe814c412365131380e239a93e90532419ece6e66fb3ce0c74bf6566cae5b
 SHA512:
-  metadata.gz: 9fd4f01dd7ba2cbc6da044367d45d14a07e699c632e9ce421674b151095972465e7e3cd86e13bc3efcc80b29a33c9d62cf976c94b56db82578026a0734ba64e3
-  data.tar.gz: e71a4444310641326ce9eb07d312eeaa5157f1c78faf8dcc0c1effc068df8ce50a3bcc3b184849ade9079bfb936a076bf774834ba1590191fe81ea62c835f8b9
+  metadata.gz: 15ae921b000efb256d6907b1b69cda9e60a63612d25eccab76b09f0c765d6aa9d1337ed43580b3bf18cfd84a73e69b4f16aaad62065c8df9644a87779c0d8485
+  data.tar.gz: 6de449a43159e54803266ca16cb960bd09772abbb9a33ad3b5fa77fa25be63cef6e38fa0edb003c342e2c495bfd37b98035365aa76a9a2b9271d99385498ac96

data/Gemfile

@@ -32,9 +32,9 @@ gem 'random-port', '~>0.0', require: false
 gem 'rspec-rails', '7.0.1', require: false
 gem 'rubocop', '1.66.1', require: false
 gem 'rubocop-performance', '1.22.1', require: false
-gem 'rubocop-rspec', '3.0.5', require: false
+gem 'rubocop-rspec', '3.1.0', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'simplecov-cobertura', '2.1.0', require: false
 gem 'w3c_validators', '1.3.7', require: false
-gem 'webmock', '3.23.1', require: false
+gem 'webmock', '3.24.0', require: false
 gem 'yard', '0.9.37', require: false

data/Gemfile.lock

@@ -5,6 +5,7 @@ PATH
       backtrace (> 0)
       elapsed (> 0)
       loog (> 0)
+      tago (> 0)
 
 GEM
   remote: https://rubygems.org/
@@ -94,7 +95,7 @@ GEM
     i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     io-console (0.7.2)
-    irb (1.14.0)
+    irb (1.14.1)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     json (2.7.2)
@@ -166,7 +167,7 @@ GEM
     regexp_parser (2.9.2)
     reline (0.5.10)
       io-console (~> 0.5)
-    rexml (3.3.7)
+    rexml (3.3.8)
     rspec-core (3.13.1)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.3)
@@ -199,7 +200,7 @@ GEM
     rubocop-performance (1.22.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (3.0.5)
+    rubocop-rspec (3.1.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     securerandom (0.3.1)
@@ -225,11 +226,11 @@ GEM
       json (>= 1.8)
       nokogiri (~> 1.6)
       rexml (~> 3.2)
-    webmock (3.23.1)
+    webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    webrick (1.8.1)
+    webrick (1.8.2)
     yard (0.9.37)
     zeitwerk (2.6.18)
 
@@ -253,11 +254,11 @@ DEPENDENCIES
   rspec-rails (= 7.0.1)
   rubocop (= 1.66.1)
   rubocop-performance (= 1.22.1)
-  rubocop-rspec (= 3.0.5)
+  rubocop-rspec (= 3.1.0)
   simplecov (= 0.22.0)
   simplecov-cobertura (= 2.1.0)
   w3c_validators (= 1.3.7)
-  webmock (= 3.23.1)
+  webmock (= 3.24.0)
   yard (= 0.9.37)
 
 BUNDLED WITH

data/README.md

@@ -32,6 +32,9 @@ stdout = qbash('echo "Hello, world!"', log: $stdout)
 
 If the command fails, an exception will be raised.
 
+The function automatically merges `stderr` with `stdout`
+(you can't change this).
+
 It's possible to provide the standard input and environment variables:
 
 ```ruby
@@ -82,6 +85,14 @@ qbash("cat #{Shellwords.escape(file)}")
 Without such an escaping, in this example, a space inside the `file`
 will lead to an unpredicatable result of the execution.
 
+You can also set the maximum time for the command:
+
+```ruby
+qbash("sleep 100", timeout: 4)
+```
+
+This command will raise exception after four seconds.
+
 ## How to contribute
 
 Read

data/lib/qbash.rb

@@ -24,6 +24,7 @@ require 'backtrace'
 require 'loog'
 require 'open3'
 require 'shellwords'
+require 'tago'
 
 # Execute one bash command.
 #
@@ -33,18 +34,27 @@ require 'shellwords'
 module Kernel
   # Execute a single bash command.
   #
+  # For example:
+  #
+  #  year = qbash('date +%Y')
+  #
   # If exit code is not zero, an exception will be raised.
   #
   # To escape arguments, use +Shellwords.escape()+ method.
   #
+  # Stderr automatically merges with stdout.
+  #
+  # Read this <a href="https://github.com/yegor256/qbash">README</a> file for more details.
+  #
   # @param [String] cmd The command to run, for example +echo "Hello, world!"+
   # @param [String] stdin The +stdin+ to provide to the command
   # @param [Hash] env Hash of environment variables
   # @param [Loog|IO] log Logging facility with +.debug()+ method (or +$stdout+)
-  # @param [Array] accept List of accepted exit codes (accepts all if the list is empty)
+  # @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] timeout If it's set to non-NIL, the execution will fail after this number of seconds
   # @return [String] Everything that was printed to the +stdout+ by the command
-  def qbash(cmd, stdin: '', env: {}, log: Loog::NULL, accept: [0], both: false)
+  def qbash(cmd, stdin: '', env: {}, log: Loog::NULL, accept: [0], both: false, timeout: nil)
     cmd = cmd.join(' ') if cmd.is_a?(Array)
     if log.respond_to?(:debug)
       log.debug("+ #{cmd}")
@@ -53,25 +63,32 @@ module Kernel
     end
     buf = ''
     e = 1
-    Open3.popen2e(env, "/bin/bash -c #{Shellwords.escape(cmd)}") do |sin, sout, thr|
-      sin.write(stdin)
-      sin.close
-      until sout.eof?
-        begin
-          ln = sout.gets
-        rescue IOError => e
-          ln = Backtrace.new(e).to_s
-        end
-        if log.respond_to?(:debug)
-          log.debug(ln)
-        else
-          log.print("#{ln}\n")
+    start = Time.now
+    thread =
+      Thread.new do
+        Open3.popen2e(env, "/bin/bash -c #{Shellwords.escape(cmd)}") do |sin, sout, thr|
+          sin.write(stdin)
+          sin.close
+          until sout.eof?
+            begin
+              ln = sout.gets
+            rescue IOError => e
+              ln = Backtrace.new(e).to_s
+            end
+            if log.respond_to?(:debug)
+              log.debug(ln)
+            else
+              log.print("#{ln}\n")
+            end
+            buf += ln
+          end
+          e = thr.value.to_i
+          if !accept.nil? && !accept.include?(e)
+            raise "The command '#{cmd}' failed with exit code ##{e} in #{start.ago}\n#{buf}"
+          end
         end
-        buf += ln
       end
-      e = thr.value.to_i
-      raise "The command '#{cmd}' failed with exit code ##{e}\n#{buf}" if !accept.empty? && !accept.include?(e)
-    end
+    raise "Execution of #{cmd} timed out in #{start.ago}" if thread.join(timeout).nil?
     return [buf, e] if both
     buf
   end

data/qbash.gemspec

@@ -26,7 +26,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.0.4'
+  s.version = '0.0.6'
   s.license = 'MIT'
   s.summary = 'Quick Executor of a BASH Command'
   s.description =
@@ -42,5 +42,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'backtrace', '>0'
   s.add_dependency 'elapsed', '>0'
   s.add_dependency 'loog', '>0'
+  s.add_dependency 'tago', '>0'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/test/test_qbash.rb

@@ -57,6 +57,12 @@ class TestQbash < Minitest::Test
     end
   end
 
+  def test_with_timeout
+    assert_raises do
+      qbash('sleep 100', timeout: 0.1)
+    end
+  end
+
   def test_with_special_symbols
     assert_equal("'hi'\n", qbash("echo \"'hi'\""))
   end
@@ -69,13 +75,13 @@ class TestQbash < Minitest::Test
 
   def test_ignore_errors
     Dir.mktmpdir do |home|
-      qbash("cat #{Shellwords.escape(File.join(home, 'b.txt'))}", accept: [])
+      qbash("cat #{Shellwords.escape(File.join(home, 'b.txt'))}", accept: nil)
     end
   end
 
   def test_with_both
     Dir.mktmpdir do |home|
-      stdout, code = qbash("cat #{Shellwords.escape(File.join(home, 'foo.txt'))}", accept: [], both: true)
+      stdout, code = qbash("cat #{Shellwords.escape(File.join(home, 'foo.txt'))}", accept: nil, both: true)
       assert(code.positive?)
       assert(!stdout.empty?)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbash
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-25 00:00:00.000000000 Z
+date: 2024-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -52,6 +52,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tago
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: With the help of Open3 executes bash command and conveniently returns
   its output and exit code
 email: yegor256@gmail.com