obfusk-util 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30f9d007dcb9e565a07d90b2294e5277238e3962
-  data.tar.gz: 6a32009fc08b0c4ac6afa7941860405d3855453e
+  metadata.gz: ace37fd05ca1a55b9ed7197c9ef69ad8b25b5ebd
+  data.tar.gz: d1f1fd09ce7432c58810fa072358a2b114d138d6
 SHA512:
-  metadata.gz: 2d0ec221df62096ced64e7ee2c35f0e0832c38e1448d09cd589c5a368aba15c8e112760068462c5132fecae47f3ed053b4fa4a2a41eb3f2dffbcf85249863274
-  data.tar.gz: 159554003b57938c2ceb3f939e37a48b8a598be5a274527f698ff6cf4d228dc173ac77af7fc84c60e8a4a4d081abac019fed68c9735b9509d30702660728a093
+  metadata.gz: 48e4a35b37818666e5037dc416b912e2952cdc854eae275b7821a9f14274d921b99db71e47fe7212d47367be6f8e07e8565c57ea100ed4d88eb0217534016a9c
+  data.tar.gz: e0dfe81bb323b6222b408333184edfe287d56aada548352b23bfe6cd2032fd971625aadbb45970d809f56c7b7fe5237c0ef6f04f36b1505f2090d20646fb4b19

data/README.md

@@ -5,7 +5,7 @@
     Date        : 2014-02-20
 
     Copyright   : Copyright (C) 2014  Felix C. Stegerman
-    Version     : v0.4.3
+    Version     : v0.4.4
 
 []: }}}1
 
@@ -210,6 +210,14 @@ Obfusk::Util::sh? 'false'
 
 Obfusk::Util::sh! 'false'
 # => RunError
+
+Obfusk::Util::sys 'echo "$0" ">>$1<<" ">>$FOO<<"', '"one"', 'FOO' => 'foo'
+# stdout: bash >>"one"<< >>foo<<
+
+Obfusk::Util::sys! 'echo FOO; false'
+# stdout: FOO
+# => RunError
+
 ```
 
 []: }}}2

data/lib/obfusk/util/sh.rb

@@ -25,8 +25,7 @@ module Obfusk; module Util
     # @raise RunError when exitstatus non-zero
     # @return [Sh] self
     def ok!
-      ::Obfusk::Util.chk_exitstatus cmd, status.exitstatus
-      self
+      ::Obfusk::Util.chk_exitstatus cmd, status.exitstatus; self
     end
 
     # ... TODO ...
@@ -35,11 +34,12 @@ module Obfusk; module Util
 
   # --
 
-  # run a command using bash (w/ arguments)
+  # run a command using bash (w/ arguments) and capture its output;
+  # see also `sys`; uses `capture{2e,3}`
   #
   # ```
-  # sh 'echo "$0" ">>$1<<" ">>$FOO<<"', '"one"', 'FOO' => 'foo'
-  # # => bash >>"one"<< >>foo<<
+  # sh('echo "$0" ">>$1<<" ">>$FOO<<"', '"one"', 'FOO' => 'foo').stdout
+  # # => %Q{bash >>"one"<< >>foo<<}
   # ```
   #
   # @param [Hash] args.last
@@ -52,24 +52,13 @@ module Obfusk; module Util
   #   * any other `Symbol` key is passed as an option to `capture3`
   # @return [Sh]
   def self.sh(cmd, *args)                                       # {{{1
-    a, o  = args.last && (l = args.last.dup).is_a?(Hash) ?
-              [args[0..-2],l] : [args,{}]
-    shell = o.delete(:shell) || 'bash'
-    print = o.delete :print
-    exit  = o.delete :exit
-    merge = o.delete :merge
-    env   = o.delete(:env) || {}
-    syms  = o.select { |k,v| Symbol === k }
-    strs  = o.select { |k,v| String === k }
-    opts  = syms.merge env: env.merge(strs)
-    c     = [shell] + (print ? %w{-x} : []) + (exit ? %w{-e} : []) +
-              ['-c', cmd, shell] + a
-    if merge
-      stderr = nil; stdout, status = capture2e *c, opts
+    c = _sh cmd, args
+    if c[:merge]
+      stderr = nil; stdout, status = capture2e(*c[:cmd], c[:opts])
     else
-      stdout, stderr, status = capture3 *c, opts
+      stdout, stderr, status = capture3(*c[:cmd], c[:opts])
     end
-    Sh.new c, status, stdout, stderr
+    Sh.new c[:cmd], status, stdout, stderr
   end                                                           # }}}1
 
   # `sh(...).ok?`
@@ -84,6 +73,34 @@ module Obfusk; module Util
 
   # --
 
+  # run a command using bash (w/ arguments); takes the same arguments
+  # as `sh`; uses `spawn_w`
+  #
+  # ```
+  # sys 'echo "$0" ">>$1<<" ">>$FOO<<"', '"one"', 'FOO' => 'foo'
+  # # stdout: bash >>"one"<< >>foo<<
+  # ```
+  #
+  # @return [Process::Status]
+  def self.sys(cmd, *args)
+    c   = _sh cmd, args; o = c[:opts]
+    o_  = c[:merge] ? o.merge(:err => o[:out] ? [:child, :out] : :out) : o
+    spawn_w(*c[:cmd], o_)
+  end
+
+  # `sys(...).exitstatus == 0`
+  def self.sys?(cmd, *args)
+    sys(cmd, *args).exitstatus == 0
+  end
+
+  # `sys(...)`
+  # @raise RunError when exitstatus non-zero
+  def self.sys!(cmd, *args)
+    sys(cmd, *args).tap { |s| chk_exitstatus cmd, s.exitstatus }
+  end
+
+  # --
+
   # ohai + sh; requires `obfusk/util/message`
   def self.osh(*args)
     ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; sh(*args)
@@ -99,6 +116,42 @@ module Obfusk; module Util
     ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; sh!(*args)
   end
 
+  # --
+
+  # ohai + sys; requires `obfusk/util/message`
+  def self.osys(*args)
+    ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; sys(*args)
+  end
+
+  # ohai + sys?; requires `obfusk/util/message`
+  def self.osys?(*args)
+    ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; sys?(*args)
+  end
+
+  # ohai + sys!; requires `obfusk/util/message`
+  def self.osys!(*args)
+    ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; sys!(*args)
+  end
+
+  # --
+
+  # helper
+  def self._sh(cmd, args)                                       # {{{1
+    a, o  = args.last && (l = args.last.dup).is_a?(Hash) ?
+              [args[0..-2],l] : [args,{}]
+    shell = o.delete(:shell) || 'bash'
+    print = o.delete :print
+    exit  = o.delete :exit
+    merge = o.delete :merge
+    env   = o.delete(:env) || {}
+    syms  = o.select { |k,v| Symbol === k }
+    strs  = o.select { |k,v| String === k }
+    opts  = syms.merge env: env.merge(strs)
+    c     = [shell] + (print ? %w{-x} : []) + (exit ? %w{-e} : []) +
+              ['-c', cmd, shell] + a
+    { cmd: c, opts: opts, merge: merge }
+  end                                                           # }}}1
+
 end; end
 
 # vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/obfusk/util/version.rb

@@ -1,5 +1,5 @@
 # my namespace
 module Obfusk; module Util
-  VERSION = '0.4.3'
+  VERSION = '0.4.4'
   DATE    = '2014-02-20'
 end; end

data/spec/obfusk/util/sh_spec.rb

@@ -120,6 +120,113 @@ describe 'obfusk/util/sh' do
     end
   end                                                           # }}}1
 
+  context 'sys (1)' do                                          # {{{1
+    it 'echoes w/ args and env' do
+      r, w = IO.pipe
+      res = ou.sys 'echo "$0" ">>$1<<" ">>$FOO<<"', '"one"',
+        'FOO' => 'foo', out: w
+      w.close; x = r.read; r.close
+      expect(res.exitstatus).to eq(0)
+      expect(x).to eq(%Q{bash >>"one"<< >>foo<<\n})
+    end
+    it 'works w/ print, exit, and merge' do
+      r, w = IO.pipe
+      res = ou.sys 'echo step1; false; echo step3', print: true, exit: true,
+        merge: true, out: w
+      w.close; x = r.read; r.close
+      expect(res.exitstatus).to_not eq(0)
+      expect(x).to eq("+ echo step1\nstep1\n+ false\n")
+    end
+    it 'outputs pwd w/ arg' do
+      r, w = IO.pipe
+      res = ou.sys 'cd "$1"; pwd', '/', out: w
+      w.close; x = r.read; r.close
+      expect(res.exitstatus).to eq(0)
+      expect(x).to eq("/\n")
+    end
+    it 'outputs pwd w/ :chdir' do
+      r, w = IO.pipe
+      res = ou.sys 'pwd', chdir: '/', out: w
+      w.close; x = r.read; r.close
+      expect(res.exitstatus).to eq(0)
+      expect(x).to eq("/\n")
+    end
+  end                                                           # }}}1
+
+  context 'sys (2)' do                                          # {{{1
+    it 'prints to stderr w/ print/-x' do
+      ro, wo = IO.pipe; re, we = IO.pipe
+      res = ou.sys 'echo FOO; echo BAR', print: true, out: wo, err: we
+      wo.close; o = ro.read; ro.close
+      we.close; e = re.read; re.close
+      expect(res.exitstatus).to eq(0)
+      expect(o).to eq("FOO\nBAR\n")
+      expect(e).to eq("+ echo FOO\n+ echo BAR\n")
+    end
+    it 'ignores false w/o exit/-e' do
+      r, w = IO.pipe
+      res = ou.sys 'echo FOO; false; echo BAR', out: w
+      w.close; x = r.read; r.close
+      expect(res.exitstatus).to eq(0)
+      expect(x).to eq("FOO\nBAR\n")
+    end
+    it 'stops at false w/ exit/-e' do
+      r, w = IO.pipe
+      res = ou.sys 'echo FOO; false; echo BAR', exit: true, out: w
+      w.close; x = r.read; r.close
+      expect(res.exitstatus).to_not eq(0)
+      expect(x).to eq("FOO\n")
+    end
+    it 'merges stdout and stderr w/ merge' do
+      r, w = IO.pipe
+      res = ou.sys 'echo FOO; echo BAR >&2; echo BAZ', merge: true, out: w
+      w.close; x = r.read; r.close
+      expect(res.exitstatus).to eq(0)
+      expect(x).to eq("FOO\nBAR\nBAZ\n")
+    end
+    it 'merges env w/ string keys' do
+      r, w = IO.pipe
+      res = ou.sys 'echo $FOO; echo $BAR',
+        env: { 'FOO' => 'no', 'BAR' => 'bar' }, 'FOO' => 'yes', out: w
+      w.close; x = r.read; r.close
+      expect(res.exitstatus).to eq(0)
+      expect(x).to eq("yes\nbar\n")
+    end
+  end                                                           # }}}1
+
+  context 'sys (3)' do                                          # {{{1
+    it 'fails w/ message on stderr w/ NONEXISTENT' do
+      r, w = IO.pipe
+      res = ou.sys 'NONEXISTENT', err: w
+      w.close; x = r.read; r.close
+      expect(res.exitstatus).to eq(127)
+      expect(x).to eq("bash: NONEXISTENT: command not found\n")
+    end
+    it 'fails w/ RunError w/ shell NONEXISTENT' do
+      expect { ou.sys 'irrelevant', shell: 'NONEXISTENT' } .to \
+        raise_error(ou::RunError, /failed to spawn command/)
+    end
+  end                                                           # }}}1
+
+  context 'sys?' do                                             # {{{1
+    it 'true => true' do
+      expect(ou.sys? 'true').to eq(true)
+    end
+    it 'false => false' do
+      expect(ou.sys? 'false').to eq(false)
+    end
+  end                                                           # }}}1
+
+  context 'sys!' do                                             # {{{1
+    it 'true => Process::Status' do
+      expect( ou.sys! 'true' ).to be_an_instance_of(Process::Status)
+    end
+    it 'false => RunError' do
+      expect { ou.sys! 'false' } .to \
+        raise_error(ou::RunError, /command returned non-zero/)
+    end
+  end                                                           # }}}1
+
 end
 
 # vim: set tw=70 sw=2 sts=2 et fdm=marker :

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obfusk-util
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Felix C. Stegerman
@@ -14,28 +14,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: |
@@ -46,44 +46,44 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .yardopts
+- ".yardopts"
 - README.md
 - Rakefile
 - obfusk-util.gemspec
-- lib/obfusk/util/die.rb
-- lib/obfusk/util/sh.rb
-- lib/obfusk/util/misc.rb
-- lib/obfusk/util/term.rb
-- lib/obfusk/util/spec.rb
-- lib/obfusk/util/fs.rb
-- lib/obfusk/util/message.rb
-- lib/obfusk/util/process.rb
-- lib/obfusk/util/all.rb
-- lib/obfusk/util/os.rb
 - lib/obfusk/util/run.rb
+- lib/obfusk/util/misc.rb
 - lib/obfusk/util/opt.rb
-- lib/obfusk/util/cmd.rb
-- lib/obfusk/util/module.rb
-- lib/obfusk/util/struct.rb
+- lib/obfusk/util/os.rb
 - lib/obfusk/util/valid.rb
+- lib/obfusk/util/module.rb
+- lib/obfusk/util/all.rb
+- lib/obfusk/util/process.rb
+- lib/obfusk/util/fs.rb
+- lib/obfusk/util/sh.rb
 - lib/obfusk/util/data.rb
+- lib/obfusk/util/spec.rb
+- lib/obfusk/util/message.rb
 - lib/obfusk/util/version.rb
+- lib/obfusk/util/die.rb
+- lib/obfusk/util/term.rb
+- lib/obfusk/util/struct.rb
+- lib/obfusk/util/cmd.rb
 - spec/obfusk/util/die_spec.rb
-- spec/obfusk/util/struct_spec.rb
-- spec/obfusk/util/process_spec.rb
-- spec/obfusk/util/fs_spec.rb
-- spec/obfusk/util/cmd_spec.rb
+- spec/obfusk/util/valid_spec.rb
+- spec/obfusk/util/sh_spec.rb
+- spec/obfusk/util/message_spec.rb
+- spec/obfusk/util/term_spec.rb
+- spec/obfusk/util/os_spec.rb
 - spec/obfusk/util/spec_spec.rb
-- spec/obfusk/util/run_spec.rb
 - spec/obfusk/util/opt_spec.rb
-- spec/obfusk/util/misc_spec.rb
-- spec/obfusk/util/term_spec.rb
-- spec/obfusk/util/sh_spec.rb
+- spec/obfusk/util/struct_spec.rb
 - spec/obfusk/util/module_spec.rb
-- spec/obfusk/util/os_spec.rb
-- spec/obfusk/util/valid_spec.rb
-- spec/obfusk/util/message_spec.rb
+- spec/obfusk/util/fs_spec.rb
+- spec/obfusk/util/misc_spec.rb
+- spec/obfusk/util/cmd_spec.rb
 - spec/obfusk/util/data_spec.rb
+- spec/obfusk/util/process_spec.rb
+- spec/obfusk/util/run_spec.rb
 homepage: https://github.com/obfusk/rb-obfusk-util
 licenses:
 - LGPLv3+
@@ -94,12 +94,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -109,3 +109,4 @@ signing_key:
 specification_version: 4
 summary: miscellaneous utility library for ruby
 test_files: []
+has_rdoc: