qbash 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 010ab8ee65105e6dd7d463e0f86a93ab0816c85d390de47c0e146fdf3d101cb4
-  data.tar.gz: 1fa31fc03e965c1a41c435b0722443ef4836455febe350e7a129402965a1df69
+  metadata.gz: 39338c15ddd4926d63fda7043f8f1037e0b6c6d6796e2e40a40e5d184963fdd1
+  data.tar.gz: 1198126dc03e798b35ba5a22499e48efdbd29fe477c9386b694687c0be1d60ed
 SHA512:
-  metadata.gz: 19933d40b4ac18a7d9db6d9328fd09d303971aa113bbff8a4c655db4cdbed14b682e95487134e33cb5e443dcf826996ffc8d39065cecfc6c1dd1bb57147abf47
-  data.tar.gz: 33a7904018b3b781a1efdebf39cb6fdfc96e6ec578803948a1b446b116ccc4e53630939ad63e3de2ba0c38f8cae4695f1e1f9b665196720dc5ed0b6473179a48
+  metadata.gz: 2c91c96828249e4f4116e322fc08b07fb75acef2d2c6a1e102cf9440c0e5f12a91d609ddb69969f7cf079293cb7d1b56242853f049935dc895f5e4536693e80d
+  data.tar.gz: 32ae547117a5ee567dc4cd488b9c54264975c6705d56798654e06bf8d150a7da52b5a30e94d508d986252784890abdcc81de36a80238bf3d85835aee5f786bd9

data/README.md

@@ -85,13 +85,18 @@ 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:
+If you want to stop sooner than the command finishes, use
+[`timeout`](https://github.com/ruby/timeout) gem:
 
 ```ruby
-qbash("sleep 100", timeout: 4)
+require 'timeout'
+Timeout.timeout(5) do
+  qbash('sleep 100')
+end
 ```
 
-This command will raise exception after four seconds.
+This command will raise `Timeout::Error` exception after five seconds
+of waiting for the `sleep` to finish.
 
 ## How to contribute
 

data/lib/qbash.rb

@@ -53,12 +53,11 @@ module Kernel
   # @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 +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
   # @param [Integer] level Logging level (use +Logger::DEBUG+, +Logger::INFO+, +Logger::WARN+, or +Logger::ERROR+)
   # @return [String] Everything that was printed to the +stdout+ by the command
-  def qbash(cmd, stdin: '', env: {}, log: Loog::NULL, accept: [0], both: false, timeout: nil, level: Logger::DEBUG)
+  def qbash(cmd, stdin: '', env: {}, log: Loog::NULL, accept: [0], both: false, level: Logger::DEBUG)
     env.each { |k, v| raise "env[#{k}] is nil" if v.nil? }
-    cmd = cmd.reject { |a| a.nil? || a.empty? }.join(' ') if cmd.is_a?(Array)
+    cmd = cmd.reject { |a| a.nil? || (a.is_a?(String) && a.empty?) }.join(' ') if cmd.is_a?(Array)
     mtd =
       case level
       when Logger::DEBUG
@@ -104,7 +103,7 @@ module Kernel
           end
         end
       end
-    raise "Execution of #{cmd} timed out in #{start.ago}" if thread.join(timeout).nil?
+    thread.join
     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.1.0'
+  s.version = '0.2.1'
   s.license = 'MIT'
   s.summary = 'Quick Executor of a BASH Command'
   s.description =

data/test/test_qbash.rb

@@ -42,7 +42,7 @@ class TestQbash < Minitest::Test
   end
 
   def test_command_as_array
-    assert_equal('123', qbash(['printf 1;', 'printf 2;', 'printf 3']))
+    assert_equal('123', qbash(['printf 1;', 'printf 2;', 'printf', 3]))
   end
 
   def test_log_to_console
@@ -72,12 +72,6 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbash
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-20 00:00:00.000000000 Z
+date: 2024-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace