qbash 0.4.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f45318f0039db9484ee85f0275a154b59a71d4b89e72f2c70d22099f7812f11
-  data.tar.gz: 7dc9f2442f61a7cc307d5edd9518d62b3d18eb4b6bf0d4423e8f2c353077384e
+  metadata.gz: 9e872574e62d1c8a6c104b3073529e89aef6bb4cbf0e72d96c464b91e82d96ee
+  data.tar.gz: 020a400a253c7467a8d4bf5fcd7bcab4991174ba500b792e5afb2cb80214c2f7
 SHA512:
-  metadata.gz: 5f40c92d162c7341d0dcb9386deeabeca095fbf8fec80bea2066a1b8fcece6b78a974b4ce8d8f60e2274caa97a7afbd80ef5a9235840a899def9f4efe0344012
-  data.tar.gz: d2f897f6cbb43ba9a90a67475fe0eb5b0c55573a7d3524bd92dceacf7f186b492583af1bae270df66b1bacb40a0c7321cd1d7cfe4d18e94777ff23efe96672ec
+  metadata.gz: c104aba85b47d33cac8a92acf3d6c917dc40a9c813e04c65dec7c2d694860d9ae34118e3042f9d37f0fd596162b7e647074bd2c7275409b8abb0aefbd3cfa68e
+  data.tar.gz: 76a9724d3477772a856ede1693668b665afc53b07d442e01b9380d1a6a7e90a163f1d88991a9232f9aa4b062c62e5006df5bdb805939c6d73a3b735abcca4744

data/Gemfile

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-FileCopyrightText: Copyright (c) 2024-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
 source 'https://rubygems.org'
 gemspec
 
 gem 'cucumber', '~>10.0', require: false
-gem 'minitest', '~>5.25', require: false
+gem 'minitest', '~>6.0', require: false
 gem 'minitest-reporters', '~>1.7', require: false
 gem 'net-ping', '~>2.0', require: false
 gem 'rake', '~>13.2', require: false
 gem 'random-port', '~>0.0', require: false
-gem 'rdoc', '~>6.13', require: false
+gem 'rdoc', '~>7.0', require: false
 gem 'rubocop', '~>1.73', require: false
 gem 'rubocop-minitest', '~>0.38', require: false
 gem 'rubocop-performance', '~>1.25', require: false

data/Gemfile.lock

@@ -21,22 +21,22 @@ GEM
     crack (1.0.1)
       bigdecimal
       rexml
-    cucumber (10.1.1)
+    cucumber (10.2.0)
       base64 (~> 0.2)
       builder (~> 3.2)
-      cucumber-ci-environment (> 9, < 11)
+      cucumber-ci-environment (> 9, < 12)
       cucumber-core (> 15, < 17)
-      cucumber-cucumber-expressions (> 17, < 19)
-      cucumber-html-formatter (> 20.3, < 22)
+      cucumber-cucumber-expressions (> 17, < 20)
+      cucumber-html-formatter (> 21, < 23)
       diff-lcs (~> 1.5)
       logger (~> 1.6)
       mini_mime (~> 1.1)
       multi_test (~> 1.1)
       sys-uname (~> 1.3)
     cucumber-ci-environment (10.0.1)
-    cucumber-core (15.3.0)
-      cucumber-gherkin (> 27, < 35)
-      cucumber-messages (> 26, < 30)
+    cucumber-core (15.4.0)
+      cucumber-gherkin (> 27, < 40)
+      cucumber-messages (> 26, < 33)
       cucumber-tag-expressions (> 5, < 9)
     cucumber-cucumber-expressions (18.0.1)
       bigdecimal
@@ -45,14 +45,14 @@ GEM
     cucumber-html-formatter (21.15.1)
       cucumber-messages (> 19, < 28)
     cucumber-messages (27.2.0)
-    cucumber-tag-expressions (8.0.0)
-    date (3.4.1)
+    cucumber-tag-expressions (8.1.0)
+    date (3.5.1)
     diff-lcs (1.6.2)
     docile (1.4.1)
     elapsed (0.2.0)
       loog (~> 0.6)
       tago (~> 0.1)
-    erb (5.1.1)
+    erb (6.0.1)
     ffi (1.17.2-aarch64-linux-gnu)
     ffi (1.17.2-arm-linux-gnu)
     ffi (1.17.2-arm64-darwin)
@@ -61,7 +61,7 @@ GEM
     ffi (1.17.2-x86_64-darwin)
     ffi (1.17.2-x86_64-linux-gnu)
     hashdiff (1.2.1)
-    json (2.15.1)
+    json (2.18.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -70,7 +70,8 @@ GEM
     memoist3 (1.0.0)
     mini_mime (1.1.5)
     mini_portile2 (2.8.9)
-    minitest (5.26.0)
+    minitest (6.0.1)
+      prism (~> 1.5)
     minitest-reporters (1.7.1)
       ansi
       builder
@@ -94,26 +95,26 @@ GEM
     nokogiri (1.18.10-x86_64-linux-gnu)
       racc (~> 1.4)
     parallel (1.27.0)
-    parser (3.3.9.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
     prism (1.6.0)
-    psych (5.2.6)
+    psych (5.3.1)
       date
       stringio
     public_suffix (6.0.2)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.0)
+    rake (13.3.1)
     random-port (0.7.6)
       tago (~> 0.0)
-    rdoc (6.15.0)
+    rdoc (7.0.3)
       erb
       psych (>= 4.0.0)
       tsort
     regexp_parser (2.11.3)
     rexml (3.4.4)
-    rubocop (1.81.6)
+    rubocop (1.82.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -121,10 +122,10 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.47.1, < 2.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.47.1)
+    rubocop-ast (1.48.0)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-minitest (0.38.2)
@@ -148,7 +149,7 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    stringio (3.1.7)
+    stringio (3.2.0)
     sys-uname (1.4.1)
       ffi (~> 1.1)
       memoist3 (~> 1.0.0)
@@ -161,11 +162,11 @@ GEM
       json (>= 1.8)
       nokogiri (~> 1.6)
       rexml (~> 3.2)
-    webmock (3.25.2)
+    webmock (3.26.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    yard (0.9.37)
+    yard (0.9.38)
 
 PLATFORMS
   aarch64-linux
@@ -179,13 +180,13 @@ PLATFORMS
 
 DEPENDENCIES
   cucumber (~> 10.0)
-  minitest (~> 5.25)
+  minitest (~> 6.0)
   minitest-reporters (~> 1.7)
   net-ping (~> 2.0)
   qbash!
   rake (~> 13.2)
   random-port (~> 0.0)
-  rdoc (~> 6.13)
+  rdoc (~> 7.0)
   rubocop (~> 1.73)
   rubocop-minitest (~> 0.38)
   rubocop-performance (~> 1.25)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2024-2025 Yegor Bugayenko
+Copyright (c) 2024-2026 Yegor Bugayenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/LICENSES/MIT.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2024-2025 Yegor Bugayenko
+Copyright (c) 2024-2026 Yegor Bugayenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/README.md

@@ -13,9 +13,10 @@
 
 How do you execute a new shell command from Ruby?
 There are [many ways][so-question].
-None of them offers a one-liner that would execute a command, print
-its output to the console or a logger, and then raise an exception if
-the exit code is not zero. This small gem offers exactly this one-liner.
+None of them offers a one-liner that would execute a command,
+  print its output to the console or a logger, and then raise an exception if
+  the exit code is not zero.
+This small gem offers exactly this one-liner.
 
 First, install it:
 
@@ -23,17 +24,17 @@ First, install it:
 gem install qbash
 ```
 
-Then, you can use [qbash][qbash] global function:
+Then, you can use [qbash] global function:
 
 ```ruby
 require 'qbash'
 stdout = qbash('echo "Hello, world!"', log: $stdout)
 ```
 
-If the command fails, an exception will be raised.
+If the command fails, an exception is raised.
 
 The function automatically merges `stderr` with `stdout`
-(you can't change this).
+  (you can't change this).
 
 It's possible to provide the standard input and environment variables:
 
@@ -41,28 +42,28 @@ It's possible to provide the standard input and environment variables:
 stdout = qbash('cat > $FILE', env: { 'FILE' => 'a.txt' }, stdin: 'Hello!')
 ```
 
-It's possible to configure the logging facility too, for example, with the help
-of the [loog](https://github.com/yegor256/loog) gem (the output
-will be returned _and_ printed to the logger):
+It's possible to configure the logging facility too, for example,
+  with the help of the [loog] gem
+  (the output is returned _and_ printed to the logger):
 
 ```ruby
 require 'loog'
 qbash('echo "Hello, world!"', log: Loog::VERBOSE)
 ```
 
-You can also make it return both stdout and exit code, with the help
-of the `both` option set to `true`:
+You can also make it return both stdout and exit code,
+  with the help of the `both` option set to `true`:
 
 ```ruby
 stdout, code = qbash('cat a.txt', both: true, accept: [])
 ```
 
 Here, the `accept` param contains the list of exit codes that are "acceptable"
-and won't lead to runtime failures. When the list is empty, all exists are
-acceptable (there will be no failures ever).
+  and won't lead to runtime failures.
+When the list is empty, all exits are acceptable (no failures occur).
 
-The command may be provided as an array, which automatically will be
-converted to a string by joining all items with spaces between them.
+The command may be provided as an array, which is automatically
+  converted to a string by joining all items with spaces between them.
 
 ```ruby
 qbash(
@@ -74,9 +75,19 @@ qbash(
 )
 ```
 
-If a block is given to `qbash`, it will run the command in background mode,
-waiting for the block to finish. Once it's finished, the command will be
-terminated via the `TERM` [signal]:
+Even simpler:
+
+```ruby
+qbash(
+  'echo "Hello, world!"',
+  '&& echo "How are you?"',
+  '&& cat /etc/passwd'
+)
+```
+
+If a block is given to `qbash`, it runs the command in background mode,
+  waiting for the block to finish.
+Once finished, the command is terminated via the `TERM` [signal]:
 
 ```ruby
 qbash('sleep 9999') do |pid|
@@ -85,18 +96,17 @@ end
 ```
 
 It is very much recommended to escape all command-line values with the help
-of the [Shellwords.escape()][shellwords] utility method, for example:
+  of the [Shellwords.escape()][shellwords] utility method, for example:
 
 ```ruby
 file = '/tmp/test.txt'
 qbash("cat #{Shellwords.escape(file)}")
 ```
 
-Without such an escaping, in this example, a space inside the `file`
-will lead to an unpredictable result of the execution.
+Without such escaping, a space inside the `file` variable
+  leads to an unpredictable result.
 
-If you want to stop sooner than the command finishes, use
-[timeout] gem:
+If you want to stop sooner than the command finishes, use [timeout] gem:
 
 ```ruby
 require 'timeout'
@@ -105,17 +115,15 @@ Timeout.timeout(5) do
 end
 ```
 
-This command will raise `Timeout::Error` exception after five seconds
-of waiting for the `sleep` to finish.
+This raises a `Timeout::Error` exception after five seconds
+  of waiting for `sleep` to finish.
 
 ## How to contribute
 
-Read
-[these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
-Make sure your build is green before you contribute
-your pull request. You will need to have
-[Ruby](https://www.ruby-lang.org/en/) 3.0+ and
-[Bundler](https://bundler.io/) installed. Then:
+Read [these guidelines][guidelines].
+Make sure your build is green before you contribute your pull request.
+You need [Ruby] 3.0+ and [Bundler] installed.
+Then:
 
 ```bash
 bundle update
@@ -124,8 +132,12 @@ bundle exec rake
 
 If it's clean and you don't see any error messages, submit your pull request.
 
-[shellwords]: https://ruby-doc.org/stdlib-3.0.1/libdoc/shellwords/rdoc/Shellwords.html
+[Bundler]: https://bundler.io/
+[guidelines]: https://www.yegor256.com/2014/04/15/github-guidelines.html
+[loog]: https://github.com/yegor256/loog
 [qbash]: https://rubydoc.info/github/yegor256/qbash/master/Kernel#qbash-instance_method
+[Ruby]: https://www.ruby-lang.org/en/
+[shellwords]: https://ruby-doc.org/stdlib-3.0.1/libdoc/shellwords/rdoc/Shellwords.html
 [signal]: https://en.wikipedia.org/wiki/Signal_(IPC)
-[timeout]: https://github.com/ruby/timeout
 [so-question]: https://stackoverflow.com/questions/2232/
+[timeout]: https://github.com/ruby/timeout

data/Rakefile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-FileCopyrightText: Copyright (c) 2024-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
 require 'rubygems'
@@ -33,6 +33,7 @@ require 'yard'
 desc 'Build Yard documentation'
 YARD::Rake::YardocTask.new do |t|
   t.files = ['lib/**/*.rb']
+  t.options = ['--fail-on-warning']
 end
 
 require 'rubocop/rake_task'

data/lib/qbash.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-FileCopyrightText: Copyright (c) 2024-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
 require 'backtrace'
@@ -12,7 +12,7 @@ require 'tago'
 # Execute one bash command.
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
+# Copyright:: Copyright (c) 2024-2026 Yegor Bugayenko
 # License:: MIT
 module Kernel
   # Execute a single bash command safely with proper error handling.
@@ -81,9 +81,9 @@ module Kernel
   # @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+)
   # @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: {}, 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.is_a?(String) && a.empty?) }.join(' ') if cmd.is_a?(Array)
+    cmd = cmd.reject { |a| a.nil? || (a.is_a?(String) && a.empty?) }.join(' ')
     logit =
       lambda do |msg|
         msg = msg.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?').gsub(/\n$/, '')
@@ -158,7 +158,7 @@ module Kernel
       else
         consume.call
       end
-      e = ctrl.value.to_i
+      e = ctrl.value.exitstatus
       if !accept.nil? && !accept.include?(e)
         raise "The command '#{cmd}' failed with exit code ##{e} in #{start.ago}\n#{buf}"
       end

data/qbash.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-FileCopyrightText: Copyright (c) 2024-2026 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
 require 'English'
@@ -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.4.7'
+  s.version = '0.5.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.4.7
+  version: 0.5.0
 platform: ruby
 authors:
 - Yegor Bugayenko