obfusk-util 0.0.1.SNAPSHOT.20130725000153 → 0.4.2

data/lib/obfusk/util/run.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/run.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 
@@ -23,7 +23,7 @@ module Obfusk; module Util
   # @raise RunError on ENOENT
   def self.exec(*args)
     _enoent_to_run('exec', args) do |a|
-      Kernel.exec *_spawn_args(*a)
+      Kernel.exec(*_spawn_args(*a))
     end
   end
 
@@ -34,7 +34,7 @@ module Obfusk; module Util
   # @raise RunError on ENOENT
   def self.spawn(*args)
     _enoent_to_run('spawn', args) do |a|
-      Kernel.spawn *_spawn_args(*a)
+      Kernel.spawn(*_spawn_args(*a))
     end
   end
 
@@ -46,18 +46,102 @@ module Obfusk; module Util
   # better Kernel.system; returns true/false; see exec, spawn, spawn_w
   # @raise RunError on failure (Kernel.system -> nil)
   def self.system(*args)
-    r = Kernel.system *_spawn_args(*args)
+    r = Kernel.system(*_spawn_args(*args))
     raise RunError, "failed to run command #{args} (#$?)" if r.nil?
     r
   end
 
   # --
 
+  # better Open3.capture2; see capture3
+  # @raise RunError on ENOENT
+  def self.capture2(*args)
+    _enoent_to_run('capture2', args) do |a|
+      Open3.capture2(*_spawn_args(*a))
+    end
+  end
+
+  # better Open3.capture2e; see capture3
+  # @raise RunError on ENOENT
+  def self.capture2e(*args)
+    _enoent_to_run('capture2e', args) do |a|
+      Open3.capture2e(*_spawn_args(*a))
+    end
+  end
+
+  # better Open3.capture3; see popen3
+  # @raise RunError on ENOENT
+  def self.capture3(*args)
+    _enoent_to_run('capture3', args) do |a|
+      Open3.capture3(*_spawn_args(*a))
+    end
+  end
+
+  # --
+
+  # better Open3.pipeline; see exec, popen3
+  # @raise RunError on ENOENT
+  def self.pipeline(*args)
+    _enoent_to_run('pipeline', args) do |a|
+      Open3.pipeline(*_pipeline_args(*a))
+    end
+  end
+
+  # better Open3.pipeline_r; see pipeline_rw
+  # @raise RunError on ENOENT
+  def self.pipeline_r(*args, &b)
+    _enoent_to_run('pipeline_r', args) do |a|
+      Open3.pipeline_r(*_pipeline_args(*a), &b)
+    end
+  end
+
+  # better Open3.pipeline_rw; see popen3
+  # @raise RunError on ENOENT
+  def self.pipeline_rw(*args, &b)
+    _enoent_to_run('pipeline_rw', args) do |a|
+      Open3.pipeline_rw(*_pipeline_args(*a), &b)
+    end
+  end
+
+  # better Open3.pipeline_start; see popen3
+  # @raise RunError on ENOENT
+  def self.pipeline_start(*args, &b)
+    _enoent_to_run('pipeline_start', args) do |a|
+      Open3.pipeline_start(*_pipeline_args(*a), &b)
+    end
+  end
+
+  # better Open3.pipeline_w; see pipeline_rw
+  # @raise RunError on ENOENT
+  def self.pipeline_w(*args, &b)
+    _enoent_to_run('pipeline_w', args) do |a|
+      Open3.pipeline_w(*_pipeline_args(*a), &b)
+    end
+  end
+
+  # --
+
+  # better Open3.popen2; see popen3
+  # @raise RunError on ENOENT
+  def self.popen2(*args, &b)
+    _enoent_to_run('popen2', args) do |a|
+      Open3.popen2(*_spawn_args(*a), &b)
+    end
+  end
+
+  # better Open3.popen2e; see popen3
+  # @raise RunError on ENOENT
+  def self.popen2e(*args, &b)
+    _enoent_to_run('popen2e', args) do |a|
+      Open3.popen2e(*_spawn_args(*a), &b)
+    end
+  end
+
   # better Open3.popen3; see exec, spawn, spawn_w, system
   # @raise RunError on ENOENT
   def self.popen3(*args, &b)
     _enoent_to_run('popen3', args) do |a|
-      Open3.popen3 *_spawn_args(*a), &b
+      Open3.popen3(*_spawn_args(*a), &b)
     end
   end
 
@@ -65,12 +149,12 @@ module Obfusk; module Util
 
   # ohai + spawn; requires `obfusk/util/message`
   def self.ospawn(*args)
-    ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; spawn *args
+    ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; spawn(*args)
   end
 
   # ohai + spawn_w; requires `obfusk/util/message`
   def self.ospawn_w(*args)
-    ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; spawn_w *args
+    ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; spawn_w(*args)
   end
 
   # --
@@ -114,6 +198,15 @@ module Obfusk; module Util
     end
   end                                                           # }}}1
 
+  # helper
+  def self._pipeline_args(*args)                                # {{{1
+    if args.last && (l = args.last.dup).is_a?(Hash)
+      args[0..-2].map { |c| _spawn_args(*c) } + [l]
+    else
+      args.map { |c| _spawn_args(*c) }
+    end
+  end                                                           # }}}1
+
   # helper
   def self._spawn_rm_opts(args)
     args.last.is_a?(Hash) ? args[0..-2] : args

data/lib/obfusk/util/sh.rb

@@ -0,0 +1,102 @@
+# --                                                            ; {{{1
+#
+# File        : obfusk/util/sh.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2014-02-19
+#
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
+#
+# --                                                            ; }}}1
+
+require 'obfusk/util/run'
+
+# my namespace
+module Obfusk; module Util
+
+  # shell command result
+  class Sh < Struct.new(:cmd, :status, :stdout, :stderr)        # {{{1
+
+    # was the exitstatus zero?
+    def ok?
+      status.exitstatus == 0
+    end
+
+    # @raise RunError when exitstatus non-zero
+    def ok!
+      ::Obfusk::Util.chk_exitstatus cmd, status.exitstatus
+    end
+
+    # ... TODO ...
+
+  end                                                           # }}}1
+
+  # --
+
+  # run a command using bash (w/ arguments)
+  #
+  # ```
+  # sh 'echo "$0" ">>$1<<" ">>$FOO<<"', '"one"', 'FOO' => 'foo'
+  # # => bash >>"one"<< >>foo<<
+  # ```
+  #
+  # @param [Hash] args.last
+  #   * `:shell`  the shell to use                    (default: `'bash'`)
+  #   * `:print`  whether to pass `-x` to the shell   (default: `false`)
+  #   * `:exit`   whether to pass `-e` to the shell   (default: `false`)
+  #   * `:merge`  whether to merge stdout and stderr  (default: `false`)
+  #   * `:env`    the environment
+  #   * any other `String` key is added to the `env`
+  #   * 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
+    else
+      stdout, stderr, status = capture3 *c, opts
+    end
+    Sh.new c, status, stdout, stderr
+  end                                                           # }}}1
+
+  # `sh(...).ok?`
+  def self.sh?(cmd, *args)
+    sh(cmd, *args).ok?
+  end
+
+  # `sh(...).ok!`
+  def self.sh!(cmd, *args)
+    sh(cmd, *args).ok!
+  end
+
+  # --
+
+  # ohai + sh; requires `obfusk/util/message`
+  def self.osh(*args)
+    ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; sh(*args)
+  end
+
+  # ohai + sh?; requires `obfusk/util/message`
+  def self.osh?(*args)
+    ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; sh?(*args)
+  end
+
+  # ohai + sh!; requires `obfusk/util/message`
+  def self.osh!(*args)
+    ::Obfusk::Util.ohai _spawn_rm_opts(args)*' '; sh!(*args)
+  end
+
+end; end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/obfusk/util/spec.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/lib/obfusk/util/struct.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/struct.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 
@@ -24,6 +24,7 @@ module Obfusk; module Util
       base.extend ClassMethods
     end
 
+    # class methods
     module ClassMethods                                         # {{{2
 
       # new, block, freeze, return
@@ -73,7 +74,7 @@ module Obfusk; module Util
         h.each { |k,v| self[k] = v }
       end
 
-      self.class_eval &b if b
+      self.class_eval(&b) if b
 
     end
   end                                                           # }}}1

data/lib/obfusk/util/term.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/term.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/lib/obfusk/util/valid.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/valid.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 
@@ -35,7 +35,7 @@ module Obfusk; module Util; module Valid
   # validate value against regex
   # @raise ValidationError on no match
   def self.validate!(x, rx, name)
-    x.to_s.match /^(#{rx})$/ or invalid! "invalid #{name}"
+    x.to_s.match(/^(#{rx})$/) or invalid! "invalid #{name}"
   end
 
 end; end; end

data/lib/obfusk/util/version.rb

@@ -1,5 +1,5 @@
 # my namespace
 module Obfusk; module Util
-  VERSION = '0.0.1.SNAPSHOT.20130725000153'
-  DATE    = '2013-07-24'
+  VERSION = '0.4.2'
+  DATE    = '2014-02-19'
 end; end

data/obfusk-util.gemspec

@@ -7,8 +7,6 @@ Gem::Specification.new do |s|
 
   s.description = <<-END.gsub(/^ {4}/, '')
     miscellaneous utility library for ruby
-
-    ...
   END
 
   s.version     = Obfusk::Util::VERSION
@@ -17,7 +15,7 @@ Gem::Specification.new do |s|
   s.authors     = [ 'Felix C. Stegerman' ]
   s.email       = %w{ flx@obfusk.net }
 
-  s.license     = 'GPLv2'
+  s.licenses    = %w{ LGPLv3+ }
 
   s.files       = %w{ .yardopts README.md Rakefile } \
                 + %w{ obfusk-util.gemspec } \

data/spec/obfusk/util/cmd_spec.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/cmd_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/spec/obfusk/util/data_spec.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/data_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/spec/obfusk/util/die_spec.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/die_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/spec/obfusk/util/fs_spec.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/fs_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/spec/obfusk/util/message_spec.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/message_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/spec/obfusk/util/module_spec.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/module_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 
@@ -23,6 +23,22 @@ ms = ou::Module__Spec
 
 describe 'obfusk/util/module' do
 
+  context 'link_mod_method' do                                  # {{{1
+    it 'link_mod_method' do
+      x = Module.new; y = Module.new
+      x.module_eval do
+        def self.foo; 42; end
+        def self.bar; 37; end
+      end
+      y.module_eval do
+        ou.link_mod_method x, :foo, self
+        ou.link_mod_method x, :bar, self, :baz
+      end
+      y.foo.should == 42
+      y.baz.should == 37
+    end
+  end                                                           # }}}1
+
   context 'require_all' do                                      # {{{1
     it 'require_all' do
       Dir.mktmpdir do |dir|

data/spec/obfusk/util/opt_spec.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/opt_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/spec/obfusk/util/os_spec.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/os_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 
@@ -32,7 +32,7 @@ describe 'obfusk/util/os' do
 
   context 'now' do                                              # {{{1
     it 'now' do
-      os.now.should match /^\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d$/
+      os.now.should match(/^\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d$/)
     end
   end                                                           # }}}1
 

data/spec/obfusk/util/process_spec.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/process_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-24
+# Date        : 2014-02-19
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 
@@ -19,7 +19,7 @@ describe 'obfusk/util/process' do
     it 'age' do
       pid = spawn 'sleep 100'
       begin
-        pr.age(pid).should match /^00:0\d$/                     # ????
+        pr.age(pid).should match(/^00:0\d$/)                    # ????
       ensure
         Process.kill 'TERM', pid; Process.wait pid
       end