qbash 0.0.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34c417c95e1753f5500eb19887e7bb64045a8ed7888232af257a82f84ba71fa7
-  data.tar.gz: 4614a0dfd4ce8e692590c80d5ead25a680f49deee23856ee911852f2762baf8a
+  metadata.gz: 39244de3b00f6094ec91699c5a7eb8f0e2e7cf53670233dfb21d5df3a05d00fc
+  data.tar.gz: 8f17ae0148d5a5426ca7754bc12f1746b57b0f9c82fd4a48f0611dee186dc760
 SHA512:
-  metadata.gz: 720d1b9b3ed953125e9a68d308407ede0aa6de2b39c242eb40a31a5e916711c21dd6d57c245536182fff2c72799c7b0f86c6463a6e4d931d21c39d02f68ecf48
-  data.tar.gz: 0f380bf249fea27cd69cfedb460c157b26be03ab3d2c944b21e8a7c09aafc23dbb4500c3bb5f3f6d1262a18bcf2ced2e44f51a0529b5310e2dc337d82109c61f
+  metadata.gz: 4ea302ab3a7094e337b55367c8c10db61465d7ac24187e2691346f25ca1db4ec587c4f6a72b3c9d9c148f9347beabcb6a6f8fb16cd07e09ffd5b12af6521fd3a
+  data.tar.gz: 3c56561a93b211904ac4482df6cf1f3dd31b989792f984e691259d7374f7a51bdf091354149324ddb3460efc7769c3f6db4f489e413d59af7e20d7ae916049d7

data/.github/workflows/copyrights.yml

@@ -31,4 +31,4 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - uses: yegor256/copyrights-action@0.0.5
+      - uses: yegor256/copyrights-action@0.0.8

data/.github/workflows/rake.yml

@@ -31,7 +31,7 @@ jobs:
     name: test
     strategy:
       matrix:
-        os: [ubuntu-24.04, macos-12]
+        os: [ubuntu-24.04, macos-15]
         ruby: [3.3]
     runs-on: ${{ matrix.os }}
     steps:

data/Gemfile

@@ -24,15 +24,15 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'cucumber', '9.2.0', require: false
-gem 'minitest', '5.25.1', require: false
+gem 'minitest', '5.25.4', require: false
 gem 'minitest-reporters', '1.7.1', require: false
 gem 'net-ping', '2.0.8', require: false
 gem 'rake', '13.2.1', require: false
 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.1.0', require: false
+gem 'rspec-rails', '7.1.0', require: false
+gem 'rubocop', '1.69.2', require: false
+gem 'rubocop-performance', '1.23.0', require: false
+gem 'rubocop-rspec', '3.3.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

data/Gemfile.lock

@@ -10,9 +10,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.2.1)
-      actionview (= 7.2.1)
-      activesupport (= 7.2.1)
+    actionpack (7.2.2)
+      actionview (= 7.2.2)
+      activesupport (= 7.2.2)
       nokogiri (>= 1.8.5)
       racc
       rack (>= 2.2.4, < 3.2)
@@ -21,14 +21,15 @@ GEM
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
       useragent (~> 0.16)
-    actionview (7.2.1)
-      activesupport (= 7.2.1)
+    actionview (7.2.2)
+      activesupport (= 7.2.2)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.2.1)
+    activesupport (7.2.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
@@ -44,6 +45,7 @@ GEM
     ast (2.4.2)
     backtrace (0.4.0)
     base64 (0.2.0)
+    benchmark (0.4.0)
     bigdecimal (3.1.8)
     builder (3.3.0)
     concurrent-ruby (1.3.4)
@@ -98,15 +100,15 @@ GEM
     irb (1.14.1)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.7.2)
+    json (2.9.0)
     language_server-protocol (3.17.0.3)
     logger (1.6.1)
-    loofah (2.22.0)
+    loofah (2.23.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     loog (0.6.0)
     mini_mime (1.1.5)
-    minitest (5.25.1)
+    minitest (5.25.4)
     minitest-reporters (1.7.1)
       ansi
       builder
@@ -129,21 +131,20 @@ GEM
     nokogiri (1.16.7-x86_64-linux)
       racc (~> 1.4)
     parallel (1.26.3)
-    parser (3.3.5.0)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
       racc
-    psych (5.1.2)
+    psych (5.2.0)
       stringio
     public_suffix (6.0.1)
     racc (1.8.1)
-    rack (3.1.7)
+    rack (3.1.8)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
       rack (>= 1.3)
-    rackup (2.1.0)
+    rackup (2.2.0)
       rack (>= 3)
-      webrick (~> 1.8)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
@@ -151,9 +152,9 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.2.1)
-      actionpack (= 7.2.1)
-      activesupport (= 7.2.1)
+    railties (7.2.2)
+      actionpack (= 7.2.2)
+      activesupport (= 7.2.2)
       irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
@@ -164,19 +165,19 @@ GEM
     random-port (0.7.1)
     rdoc (6.7.0)
       psych (>= 4.0.0)
-    regexp_parser (2.9.2)
-    reline (0.5.10)
+    regexp_parser (2.9.3)
+    reline (0.5.11)
       io-console (~> 0.5)
     rexml (3.3.8)
-    rspec-core (3.13.1)
+    rspec-core (3.13.2)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-rails (7.0.1)
+    rspec-rails (7.1.0)
       actionpack (>= 7.0)
       activesupport (>= 7.0)
       railties (>= 7.0)
@@ -185,22 +186,22 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.1)
-    rubocop (1.66.1)
+    rubocop (1.69.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.36.2)
       parser (>= 3.3.1.0)
-    rubocop-performance (1.22.1)
+    rubocop-performance (1.23.0)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (3.1.0)
+    rubocop-rspec (3.3.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     securerandom (0.3.1)
@@ -213,7 +214,7 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    stringio (3.1.1)
+    stringio (3.1.2)
     sys-uname (1.3.0)
       ffi (~> 1.1)
     tago (0.0.2)
@@ -230,9 +231,8 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    webrick (1.8.2)
     yard (0.9.37)
-    zeitwerk (2.6.18)
+    zeitwerk (2.7.1)
 
 PLATFORMS
   aarch64-linux
@@ -245,16 +245,16 @@ PLATFORMS
 
 DEPENDENCIES
   cucumber (= 9.2.0)
-  minitest (= 5.25.1)
+  minitest (= 5.25.4)
   minitest-reporters (= 1.7.1)
   net-ping (= 2.0.8)
   qbash!
   rake (= 13.2.1)
   random-port (~> 0.0)
-  rspec-rails (= 7.0.1)
-  rubocop (= 1.66.1)
-  rubocop-performance (= 1.22.1)
-  rubocop-rspec (= 3.1.0)
+  rspec-rails (= 7.1.0)
+  rubocop (= 1.69.2)
+  rubocop-performance (= 1.23.0)
+  rubocop-rspec (= 3.3.0)
   simplecov (= 0.22.0)
   simplecov-cobertura (= 2.1.0)
   w3c_validators (= 1.3.7)

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,10 +53,10 @@ 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)
     mtd =
       case level
@@ -103,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.0.8'
+  s.version = '0.2.0'
   s.license = 'MIT'
   s.summary = 'Quick Executor of a BASH Command'
   s.description =

data/test/test_qbash.rb

@@ -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
@@ -88,6 +82,10 @@ class TestQbash < Minitest::Test
     end
   end
 
+  def test_fails_when_nil_env
+    assert_raises { qbash('echo hi', env: { a: nil }) }
+  end
+
   def test_ignore_errors
     Dir.mktmpdir do |home|
       qbash("cat #{Shellwords.escape(File.join(home, 'b.txt'))}", accept: nil)

metadata

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