obfusk-util 0.0.1.SNAPSHOT.20130725000153 → 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8adf3c9ae768f80d1e557b744a4dea1245efcce0
+  data.tar.gz: e31cde1403fc3bbd9997a80468b531cf901b404f
+SHA512:
+  metadata.gz: 53faf1797b5f2be9f729ecb4b7f9f6386e0a050e1ce5872aa5cbec3861fea5cec19c60390631b12ed2c0d3573bc15a370cb787e4a7ef93c39417e8d1faa6d908
+  data.tar.gz: cf380054eca3d5717dd75db728b5164e22413f5af8a64327045c70770091a58646b374e9496e7aeda4b9d8ceef9899d9bb371840b0f7c687d1b3070715172f34

data/README.md

@@ -2,28 +2,33 @@
 
     File        : README.md
     Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-    Date        : 2013-07-24
+    Date        : 2014-02-19
 
-    Copyright   : Copyright (C) 2013  Felix C. Stegerman
-    Version     : v0.0.1.SNAPSHOT
+    Copyright   : Copyright (C) 2014  Felix C. Stegerman
+    Version     : v0.4.2
 
 []: }}}1
 
+[![Gem Version](https://badge.fury.io/rb/obfusk-util.png)](http://badge.fury.io/rb/obfusk-util)
+
 ## Description
-[]: {{{1
 
   [rb-]obfusk-util - miscellaneous utility library for ruby
 
-  ...
-
-[]: }}}1
-
 ## Examples
 []: {{{1
 
+```ruby
+require 'obfusk/util/all'
+```
+
+---
+
 []: {{{2
 
 ```ruby
+require 'obfusk/util/cmd'
+
 Obfusk::Util::Cmd.killsig 'SIGINT foo bar'
 # => { command: 'foo bar', signal: 'SIGINT' }
 
@@ -40,9 +45,13 @@ Obfusk::Util::Cmd.set_vars 'echo ${FOO} ... ${BAR} ...',
 
 []: }}}2
 
+---
+
 []: {{{2
 
 ```ruby
+require 'obfusk/util/data'
+
 x = { x: { y: 0 }, z: [1,2,3] }
 Obfusk::Util.assoc(x, [:x,:y] => 1, [:z,1] => 99)
 x[:x][:y] == 1          # => true
@@ -54,19 +63,27 @@ Obfusk::Util.empty_as_nil(ENV['FOO']) || default
 
 []: }}}2
 
+---
+
 []: {{{2
 
 ```ruby
-Obfusk::Util::FS.append 'file', *lines
+require 'obfusk/util/fs'
+
+Obfusk::Util::FS.append('file', *lines)
 Obfusk::Util::FS.exists? 'file-or-possibly-broken-symlink'
 ```
 
 []: }}}2
 
+---
+
 []: {{{2
 
 ```ruby
-Obfusk::Util.ohai *%w{ rackup -p 8888 }
+require 'obfusk/util/message'
+
+Obfusk::Util.ohai(*%w{ rackup -p 8888 })
 # shows '==> rackup -p 8888' in colour
 
 Obfusk::Util.onow 'Starting', 'foo', 'bar'
@@ -76,14 +93,25 @@ Obfusk::Util.onoe 'Something is wrong!' # error in colour
 Obfusk::Util.opoo 'This looks funny!'   # warning in colour
 ```
 
-There are some o\* methods all over obfusk-util that combine some
-operation with e.g. ohai.
+There are some `o*` methods all over `obfusk-util` that combine some
+operation with e.g. `ohai`.
 
 []: }}}2
 
+---
+
 []: {{{2
 
 ```ruby
+require 'obfusk/util/module'
+
+module Foo; def self.foo; 42; end; end
+module Bar
+  # alias Foo.foo as Bar.foo and Bar.bar
+  Obfusk::Util.link_mod_method Foo, :foo, self
+  Obfusk::Util.link_mod_method Foo, :foo, self, :bar
+end
+
 Obfusk::Util.require_all 'foo/bar'
 # requires foo/bar/*
 
@@ -93,20 +121,28 @@ Obfusk::Util.submodules Foo
 
 []: }}}2
 
+---
+
 []: {{{2
 
-Slightly improved OptionParser (w/o officious options):
+Slightly improved `OptionParser` (w/o officious options):
 
 ```ruby
+require 'obfusk/util/opt'
+
 p = Obfusk::Util::Opt::Parser.new # ...
 remaining_args = p.parse_r ARGV
 ```
 
 []: }}}2
 
+---
+
 []: {{{2
 
 ```ruby
+require 'obfusk/util/os'
+
 Obfusk::Util::OS.home         # => current user's home
 Obfusk::Util::OS.home 'user'  # => user's home
 Obfusk::Util::OS.user         # => current user
@@ -115,38 +151,97 @@ Obfusk::Util::OS.now          # => current time as '%F %T'
 
 []: }}}2
 
+---
+
 []: {{{2
 
 ```ruby
+require 'obfusk/util/process'
+
 Obfusk::Util::Process.age pid     # => e.g. '01:06:19'
 Obfusk::Util::Process.alive? pid  # => false/true/:not_mine
 ```
 
 []: }}}2
 
+---
+
 []: {{{2
 
-spawn_w is spawn + wait (which is nicer than system).  No shell is
-ever used; env is an option instead of an optional first argument;
-ENOENT becomes RunError.  See also: exec, spawn, system, popen3.
+`spawn_w` is `spawn` + `wait` (which is nicer than `system`).  No
+shell is ever used; `env` is an option instead of an optional first
+argument; `ENOENT` becomes `RunError`.  See also: `exec`, `spawn`,
+`system`, `capture{2,2e,3}`, `pipeline{,_r,_rw,_start,_w}`,
+`popen{2,2e,3}`.
 
 ```ruby
-Obfusk::Util.spawn_w *%w{ some command }, env: { 'FOO' => 'bar' },
-  chdir: 'some/dir' #, ...
+require 'obfusk/util/run'
+
+Obfusk::Util.spawn_w(*%w{ some command }, env: { 'FOO' => 'bar' },
+  chdir: 'some/dir') #, ...
 # => $?
 
 # raise RunError if command returned non-zero
 Obfusk::Util.chk_exit(%w{ some command }) do |a|
   # spawn + wait + ohai
-  Obfusk::Util.ospawn_w *a
+  Obfusk::Util.ospawn_w(*a)
 end
 ```
 
 []: }}}2
 
+---
+
 []: {{{2
 
 ```ruby
+require 'obfusk/util/sh'
+
+sh('echo "$0" ">>$1<<" ">>$FOO<<"', '"one"', 'FOO' => 'foo').stdout
+# => %Q{bash >>"one"<< >>foo<<}
+
+sh('echo step1; false; echo step3',
+  print: true, exit: true, merge: true).stdout
+# => "+ echo step1\nstep1\n+ false\n"
+
+sh? 'false'
+# => false
+
+sh! 'false'
+# => RunError
+```
+
+[]: }}}2
+
+---
+
+[]: {{{2
+
+```ruby
+require 'obfusk/util/spec'
+
+Obfusk::Util.provide_stdin(input) do
+  # do something with $stdin
+end
+
+output = Obfusk::Util.capture_stdout do
+  # do something with $stdout
+end
+
+output = Obfusk::Util.capture_stderr(:tty) do
+  # do something with $stderr; $stderr.isatty => true
+end
+```
+
+[]: }}}2
+
+---
+
+[]: {{{2
+
+```ruby
+require 'obfusk/util/struct'
+
 Foo = Obfusk::Util.struct(*%w{ field1 field2 field3 }) do
   def some_method; field1 + field2; end
 end
@@ -166,9 +261,13 @@ bar.check!        # => IncompleteError b/c there are empty fields
 
 []: }}}2
 
+---
+
 []: {{{2
 
 ```ruby
+require 'obfusk/util/term'
+
 Obfusk::Util::Term.colour :red
 # => ansi escape code if $stdout is a tty, '' otherwise
 
@@ -183,9 +282,13 @@ Obfusk::Util::Term.prompt 'foo> ', :hide  # prompt for password
 
 []: }}}2
 
+---
+
 []: {{{2
 
 ```ruby
+require 'obfusk/util/valid'
+
 def foo(*args_)
   Obfusk::Util::Valid.args 'description', args_, 1, 3
   # => ArgumentError if #args not in 1..3
@@ -197,36 +300,26 @@ end
 []: }}}1
 
 ## Specs & Docs
-[]: {{{1
-
-    $ rake spec
-    $ rake docs
 
-[]: }}}1
+```bash
+$ rake spec
+$ rake docs
+```
 
 ## TODO
-[]: {{{1
 
-  * write more specs
-  * write more docs
-  * dual-license under EPLv1?
+  * improve sh w/ fp (pipe, lines, json, blocks)?
+  * more specs/docs?
+  * split into several gems?
   * ...
 
-[]: }}}1
-
 ## License
-[]: {{{1
 
-  GPLv2 [1].
-
-[]: }}}1
+  LGPLv3+ [1].
 
 ## References
-[]: {{{1
 
-  [1] GNU General Public License, version 2
-  --- http://www.opensource.org/licenses/GPL-2.0
-
-[]: }}}1
+  [1] GNU Lesser General Public License, version 3
+  --- http://www.gnu.org/licenses/lgpl-3.0.html
 
 []: ! ( vim: set tw=70 sw=2 sts=2 et fdm=marker : )

data/Rakefile

@@ -13,6 +13,22 @@ task 'spec:less' do
   sh 'rspec -cfd --tty | less -R'
 end
 
+desc 'Check for warnings'
+task :warn do
+  sh 'ruby -w -I lib -r obfusk/util/all -e ""'
+end
+
+desc 'Check for warnings in specs'
+task 'warn:spec' do
+  reqs = Dir['spec/**/*.rb'].sort.map { |x| "-r ./#{x}" } * ' '
+  sh "ruby -w -I lib -r rspec #{reqs} -e ''"
+end
+
+desc 'Check for warnings in specs (but not void context)'
+task 'warn:spec:novoid' do
+  sh 'rake warn:spec 2>&1 | grep -v "void context"'
+end
+
 desc 'Generate docs'
 task :docs do
   sh 'yardoc | cat'

data/lib/obfusk/util/all.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/all.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
 
@@ -20,6 +20,7 @@ require 'obfusk/util/opt'
 require 'obfusk/util/os'
 require 'obfusk/util/process'
 require 'obfusk/util/run'
+require 'obfusk/util/sh'
 require 'obfusk/util/spec'
 require 'obfusk/util/struct'
 require 'obfusk/util/term'

data/lib/obfusk/util/cmd.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/cmd.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/data.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/data.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,7 +24,7 @@ module Obfusk; module Util
         case k.length
         when 0; raise ArgumentError, 'empty array key'
         when 1; x[k.first] = v
-        else    h, *t = k; assoc (x[h] ||= {}), t => v
+        else    h, *t = k; assoc(x[h] ||= {}, t => v)
         end
       else
         x[k] = v

data/lib/obfusk/util/die.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/die.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/fs.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/fs.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/message.rb

@@ -2,13 +2,14 @@
 #
 # File        : obfusk/util/message.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
 
+require 'obfusk/util/module'
 require 'obfusk/util/term'
 
 # my namespace
@@ -58,15 +59,8 @@ module Obfusk; module Util
     ': ' + what.map { |x| _tcol(:lgn) + x + _tcol(:non) } *', '
   end
 
-  # Term.colour
-  def self._tcol(*a)
-    Term.colour *a
-  end
-
-  # Term.colour_e
-  def self._tcole(*a)
-    Term.colour_e *a
-  end
+  link_mod_method Term, :colour  , self, :_tcol
+  link_mod_method Term, :colour_e, self, :_tcole
 
 end; end
 

data/lib/obfusk/util/misc.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/misc.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-07-17
+# 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/module.rb

@@ -2,16 +2,24 @@
 #
 # File        : obfusk/util/module.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
 
 # my namespace
 module Obfusk; module Util
 
+  # create module method to.to_meth that calls from.from_meth
+  def self.link_mod_method(from, from_meth, to, to_meth = from_meth)
+    to.module_exec(from, from_meth, to_meth) do |f,fm,tm|
+      (class << self; self; end).send(:define_method, tm) \
+        { |*a,&b| f.send(fm, *a, &b) }
+    end
+  end
+
   # load `dir/*` (by searching for `dir/*.rb` in `$LOAD_PATH`)
   #
   # ```

data/lib/obfusk/util/opt.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/opt.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/os.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/os.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/process.rb

@@ -2,10 +2,10 @@
 #
 # File        : obfusk/util/process.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