coque 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6df60f837355fa035e81e14eff31a1df0f462408
-  data.tar.gz: 5f044bde907269b17ee5279969f13a01840066aa
+SHA256:
+  metadata.gz: 6f9a270751ea085a375d71bc3b7a7ccd34237f4094dce63ffbffb66005b123ff
+  data.tar.gz: 89e0e4065a6eb61c27c1b41e2ecd1dd84470b83ba934e3421ea8ee119840d5cd
 SHA512:
-  metadata.gz: 4b89af30708ef7db84f92238f1a50eefc1bbba04ff1726c746c5a39ba228cd768958e738cc39bb7e4cbca12b0575beb918ce95f4a4892b3f5bedcb5c27e310a9
-  data.tar.gz: 2b4c7d528d05b415704c1dd33090b2b1e0f70b673d9c8a726ec99d6fad5cfc8a71e915c785c972e1301d610ccd9bfe7fed168a4221847506034b932af9a19fc8
+  metadata.gz: 64b833a5a39cc7ed3a65339af2ac13c0a3f0e0461247cd899c69deab5a9a7d30ffccb7bae4da16a7fed175638a59a19aaa43c2335aba109a5105b7b27e0f5682
+  data.tar.gz: 853b5a31c91d099dc88e0881672c4fa8b465bca04ae70d553dcac9daed4c21f29501a4818fb4b04a42d8bc6e1ab021c32ae5e4a411dc3d5e3a1f1a7e44dc5aa8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coque (0.7.1)
+    coque (0.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,7 +10,7 @@ GEM
     builder (3.2.3)
     coderay (1.1.2)
     docile (1.3.1)
-    json (2.1.0)
+    json (2.3.1)
     method_source (0.9.0)
     minitest (5.11.3)
     minitest-reporters (1.2.0)
@@ -21,7 +21,7 @@ GEM
     pry (0.11.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (12.3.1)
+    rake (13.0.1)
     ruby-progressbar (1.9.0)
     simplecov (0.16.1)
       docile (~> 1.1)
@@ -38,8 +38,8 @@ DEPENDENCIES
   minitest (~> 5.11)
   minitest-reporters
   pry
-  rake (~> 12.3)
+  rake (~> 13.0)
   simplecov
 
 BUNDLED WITH
-   2.0.1
+   2.2.24

data/README.md

@@ -102,6 +102,51 @@ Coque also includes a `Coque.source` helper for feeding Ruby enumerables into sh
 # => ["500"]
 ```
 
+#### Asynchrony and Waiting on Processes
+
+Running a Coque command forks a new process, and by default these processes run asynchronously. Calling `.run` on a Coque command or pipeline returns a `Coque::Result` object which can be used to get the output (`.to_a`) or exit code (`.exit_code`) of the process:
+
+```rb
+result = Coque['echo', 'hi'].run
+# => #<Coque::Result:0x000055da63437838 @out=#<IO:fd 15>, @pid=29236>
+puts "its running in the background..."
+its running in the background...
+result.to_a
+# => ["hi"]
+result.exit_code
+# => 0
+```
+
+However you can also just use `.wait` to block on a process while it runs:
+
+```rb
+result = Coque['echo', 'hi'].run.wait
+# => #<Coque::Result:0x000055da633c98b0 @exit_code=0, @out=#<IO:fd 17>, @pid=29536>
+```
+
+Or, use `.run!` to block on the process _and_ raise an exception if it exits with a non-zero response:
+
+```
+Coque["head", "/usr/share/dict/words"].run!
+# => nil
+Coque["head", "/usr/share/dict/pizza"].run!
+# head: cannot open '/usr/share/dict/pizza' for reading: No such file or directory
+# RuntimeError: Coque Command Failed: <Coque::Sh head /usr/share/dict/pizza>
+from /home/horace/.gem/ruby/2.4.4/gems/coque-0.7.1/lib/coque/runnable.rb:13:in `run!'
+```
+
+There's also a `to_a!` variant on commands which combines the error handling of `run!` with the array-slurping of stdout:
+
+```
+Coque['head', '-n 1', '/usr/share/dict/words'].to_a!
+=> ["A"]
+
+Coque['head', '-n 1', '/usr/share/dict/asdf'].to_a!
+head: cannot open '/usr/share/dict/asdf' for reading: No such file or directory
+RuntimeError: Coque Command Failed: <Coque::Sh head -n 1 /usr/share/dict/asdf>
+from /code/coque/lib/coque/runnable.rb:11:in `to_a!'
+```
+
 #### Named (Non-Operator) Method Alternatives
 
 The main piping and redirection methods also include named alternatives:

data/coque.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.11"
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "pry"

data/lib/coque/result.rb

@@ -24,7 +24,7 @@ class Coque::Result
   end
 
   def wait
-    _, status = Process.waitpid2(pid)
+    _pid, status = Process.waitpid2(pid)
     @exit_code = status.exitstatus
     self
   end

data/lib/coque/runnable.rb

@@ -4,6 +4,15 @@ module Coque
       run.to_a
     end
 
+    def to_a!
+      res = run
+      rows = res.to_a
+      unless res.exit_code == 0
+        raise "Coque Command Failed: #{self}"
+      end
+      rows
+    end
+
     def success?
       run.success?
     end
@@ -11,6 +20,8 @@ module Coque
     def run!
       if !success?
         raise "Coque Command Failed: #{self}"
+      else
+        self
       end
     end
 

data/lib/coque/version.rb

@@ -1,3 +1,3 @@
 module Coque
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coque
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Horace Williams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2021-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -144,8 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.2.21
 signing_key: 
 specification_version: 4
 summary: Shell command utilities with easy integration with Ruby code.