cmd-utils 1.0.12 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21f1afe5b217d494c957c641883697faae639685
-  data.tar.gz: f333b84392e66181fad89bbd6672bef55fd05bc4
+  metadata.gz: 1f047ffb87574fcc165f9651ff733e2f42f0c2e3
+  data.tar.gz: b64622069ed70aca2474362658474f88c9f26542
 SHA512:
-  metadata.gz: b482a92e33b183d96ef1748cbd84cf3a95885cc8d1273a56e9aa2b2a17f7e30b68f4bae5173343bc5a770530e50bc67637059ec2d4ae688f749b29e0a92569d1
-  data.tar.gz: 026d9fdcb50239a8bc05a698ad9756f9905bf6bc6fb15cc7ad1beee7f17ec9b7680632576ee5f2f7d3afe2c0cffc6978c7b103136bd573a0a1657bf64a170cc3
+  metadata.gz: d74547e65fb7d59e99aae4cc87d6bb358c3b3a0a784e2894b90e37db53e58f0be35fbb10cf107c3c0c8f6b4cc74a17fada172071c5f658d4498232a7ac7580fd
+  data.tar.gz: e56c5364aed15bb4cc340924bf0e64c434007081e600eaa3ddd65e7377a22858fae8671b8244707f905d4e93754442857ce693371470e13424a7d83ba141b137

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "minitest", ">= 5.3.0"
+  #gem "shoulda"
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler"
+  gem "simplecov"
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    descendants_tracker (0.0.3)
+    docile (1.1.3)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    mini_portile (0.5.2)
+    minitest (5.3.0)
+    multi_json (1.8.4)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler
+  minitest (>= 5.3.0)
+  rdoc
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Alan K. Stebbens
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,255 @@
+cmd-utils
+=========
+
+Utilities for writing command line tools in ruby.
+
+Installation:
+
+    gem install cmd-utils
+
+Usage:
+
+    require 'cmd-utils'
+    require 'ssh-utils'
+    require 'lookup'
+
+This gem provides:
+
+* routines for output on `$stderr`, controlled by several global variables
+* error-reporting-and-exit
+* system call handling, with verbose or debug output, error and "ok" message handling
+* remote system command invocation (based on ssh)
+* ambiguous, case-insensitive string lookups in arrays or hashs, with error handling
+
+talk, dtalk, qtalk, vtalk, nrtalk, nvtalk
+=========================================
+
+These utilities provide simple utilities that rely on the following global variables:
+
+    `$verbose` -- enables vtalk(f) function output
+    `$norun`   -- enables nrtalk(f) output, and disables the "run" command execution
+    `$quiet`   -- disables talk(f) output, and enables qtalk(f) function output
+    `$debug`   -- enables dtalk(f) function output
+
+These routines provide option-controlled output.  The arguments can be given as
+part of the the function calls, or, can be provided as the return value of a
+block.
+
+The advantage of using a block is that the block is not evaluated unless the
+conditions requiring output are met.  So, if the expression to compute a value
+that _might_ be printed is expensive, do the computation inside a block.
+
+The brief synopses given below show the function calls with arguments, and then
+the function calls with the arguments passed as the block's return value.
+
+Talk:
+
+      talk    msg         - print msg on STDERR unless $quiet
+      talk  { msg }
+      talkf fmt,   args ..
+      talkf(fmt) { args .. }
+
+Debug talk:
+
+     dtalk    msg         - print msg on STDERR if $debug
+     dtalk  { msg }
+     dtalkf fmt,   args ..
+     dtalkf(fmt) { args .. }
+
+Quiet talk:
+
+     qtalk   msg         - print msg on STDERR if     $quiet
+     qtalk { msg }
+     qtalkf fmt,   args ..
+     qtalkf(fmt) { args .. }
+
+Verbose talk:
+
+     vtalk   msg         - print msg on STDERR if     $verbose
+     vtalk { msg }
+     vtalkf fmt,   args ..
+     vtalkf(fmt) { args .. }
+
+No-run talk:
+
+    nrtalk   msg         - print msg on STDERR if     $norun || $verbose
+    nrtalk { msg }
+    nrtalkf fmt,   args ..
+    nrtalkf(fmt) { args .. }
+
+Non-verbose talk:
+
+    nvtalk   msg         - print msg on STDERR unless $verbose
+    nvtalk { msg }
+    nvtalkf fmt,   args ..
+    nvtalkf(fmt) { args .. }
+
+Error output:
+
+    error      [code,] msg   - print msg on STDERR, exit with CODE [default:1]
+    error  { [ [code,] msg ] }
+    errorf     [code,] fmt, args ..
+    errorf { [ [code,] fmt, args .. ] }
+
+The `error` routine take an optional numeric first argument which is used to
+set the exit code.  If not given, the exit code is 1.
+
+`cmd_run` 
+--------
+
+    cmd_run     cmd 
+    cmd_run   { cmd }
+
+Variants:
+
+    cmd_run     cmd,     errmsg 
+    cmd_run     cmd,     errmsg, okmsg 
+    cmd_run    (cmd) { [ errmsg, okmsg ] } 
+    cmd_run { [ cmd,     errmsg, okmsg ] }
+
+The `cmd_run` method depends on the `$norun` and `$verbose` global variables.
+If `$norun` is set, the `cmd` is simply displayed with a prefix of `(norun) `,
+and the method returns without invoking `cmd`.
+
+When `$norun` is false, and if `$verbose` is set, the `cmd` is displayed with
+a prefix of `">> "` before executing it.
+
+If the result of invoking `system(cmd)` is an error (non-zero exit code), then
+an error is printed on `$stderr`, possibly preceded by the command itself if it
+was not already printed.
+
+Note that when using the block forms of run (e.g., `run { cmd }`), the result
+of the block should be an array of one or more strings, in the same order as
+the arguments. The block will always be evaluated in order to obtain the string
+values that will be printed in `$norun` mode, or used as the error or ok
+messages.
+
+The `safe_run` method invokes `cmd`, regardless of `$norun`, basically wrapping the 
+command evaluation with the `$verbose` treatment.
+
+    safe_run   cmd
+    safe_run   cmd,   errmsg
+    safe_run   cmd,   errmsg,  okmsg
+    safe_run  (cmd) {[errmsg,  okmsg]}
+    safe_run { cmd } 
+    safe_run {[cmd, errmsg, okmsg]} 
+
+ssh-utils
+=========
+
+A module to define some routines for running commands across many systems using
+ssh.  Environment variables can be specified (PATH is used by default).
+
+Usage:
+
+    require 'ssh-utils'
+
+    on serverlist, :debug = true do |server|
+      as user do
+        with PATH
+          remote_run :whoami
+        end
+      end
+    end
+
+Method Descriptions
+-------------------
+
+    on SERVERLIST, OPTIONSHASH |server|
+      BLOCK-TO-EXECUTE-FOR-EACH-SERVER
+    end
+
+The `on` method specifies a list of servers, with an optional hash of
+options.  The supported options are: `:debug`, `:verbose`, `:with`, 
+`:without`, and `:as`
+
+    :with => ENVARS
+
+`ENVARS` is an array of environment symbol names (or strings) that will
+be included on the `ssh` command that is used to run remote commands.
+
+    :without => ENVARS
+
+`ENVARS` is an array of environment symbol names (or strings) that will *not*
+be included on the `ssh` command that is used to run remote commands.  This
+option is useful when overriding the default inclusion of `PATH`.  For example:
+
+    on backupserver, :without => :PATH
+      remote_run "/bin/tar", "-cf", source_path, dest_path
+    end
+
+    :as => USER
+
+Specifies the user to be used for the subsequent invocations.  By default, 
+the current user is used implicitly.
+
+    :debug => [true | false]
+
+Sets the `:debug` flag for use within the associated block.  The `$debug` flag
+is globally available, but the `:debug` option is a block-local specification.
+
+    :verbose => [true | false]
+
+Sets the `:verbose` flag for use within the associated block.  The `$verbose` flag
+is globally available, but the `:verbose` option is a block-local specification.
+
+
+    as USERLIST, OPTIONSHASH
+      BLOCK-TO-EXECUTE-FOR-EACH-USER
+    end
+
+The `as` method is optional, and if absent causes the current user to
+be used by default (unless overridden by the `~/.ssh/config` file).
+
+The `as` method allows the embedded block to be repeated for each given user.
+If there only one user, it can be specified on the `on` method with an `:as`
+option.  For example, the following two sections are equivalent:
+
+    on someserver
+      as root
+        remote_run :whoami
+      end
+    end
+
+    on someserver, :as => 'root'
+      remote_run :whoami
+    end
+
+
+
+lookup
+======
+
+usage:
+
+     require 'lookup'
+  
+lookup: lookup a keyword in a list, in a case-insensitive, disambiguous way
+ 
+      result = lookup list, key, err_notfound="%s not found", err_ambig="% is ambiguous"
+      result = list.lookup( key, err_notfound, err_ambig )
+      result = list.lookup( key, err_notfound )
+      result = list.lookup( key )
+ 
+Lookup key in list, which can be an array or a hash.  Return the one that
+matches exactly, or matches using case-insensitive, unambiguous matches, or
+raise a LookupError with a message.
+ 
+`LookupError` is a subclass of StandardError.
+ 
+`LookupNotFoundError`, a subclass of `LookupError`, is raised when a keyword is
+not found, and only if `err_notfound` is not nil.
+ 
+`LookupAmbigError`, a subsclass of `LookupError`, is raised when a keyword search
+matches multiple entries from the list, and only if `err_ambig` is not nil.
+ 
+If `err_notfound` is nil, do not raise a `LookupNotFoundError` error, and return
+nil.
+ 
+If `err_ambigmsg` is nil, do not raise a `LookupAmbigError`, and return the list
+of possible results.
+
+Author
+------
+
+Alan K. Stebbens <aks@stebbens.org>

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "cmd-utils"
+  gem.homepage = "http://bitbucket.org/aks_/cmd-utils"
+  gem.license = "MIT"
+  gem.summary = %Q{Utilities for building CLIs}
+  gem.description = %Q{Several ruby libraries for building command-line utilities.}
+  gem.email = "aks@stebbens.org"
+  gem.authors = ["Alan K. Stebbens"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test-*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cmd-utils #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.2

data/cmd-utils.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: cmd-utils 1.1.2 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "cmd-utils"
+  s.version = "1.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Alan K. Stebbens"]
+  s.date = "2014-03-03"
+  s.description = "Several ruby libraries for building command-line utilities."
+  s.email = "aks@stebbens.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "cmd-utils.gemspec",
+    "lib/cmd-utils.rb",
+    "lib/lookup.rb",
+    "lib/ssh-utils.rb",
+    "test/helper.rb",
+    "test/test-cmd-utils.rb",
+    "test/test-lookup.rb",
+    "test/test_cmd-utils.rb.off"
+  ]
+  s.homepage = "http://bitbucket.org/aks_/cmd-utils"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Utilities for building CLIs"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<minitest>, [">= 5.3.0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<minitest>, [">= 5.3.0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<minitest>, [">= 5.3.0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/cmd-utils.rb

@@ -4,7 +4,7 @@
 #
 #
 #    require 'cmd-utils'
-# 
+#
 # Utilities for option-controlled output, and running commands.
 #
 # The output and run methods rely on some external variables:
@@ -14,11 +14,12 @@
 #    $quiet   -- enables qtalk(f) output, and disables talk(f) output
 #    $debug   -- enables dtalk(f) output
 #
-# These routines provide conditional output.  The arguments can be given as part of the
-# the function calls, or, can be provided as the return value of a block.  The advantage
-# of using a block is that the block is not evaluated unless the conditions requiring
-# output are met.  So, if the expression to compute a value that _might_ be printed is
-# expensive, do the computation inside a block.
+# These routines provide conditional output.  The arguments can be given as
+# part of the the function calls, or, can be provided as the return value of a
+# block.  The advantage of using a block is that the block is not evaluated
+# unless the conditions requiring output are met.  So, if the expression to
+# compute a value that _might_ be printed is expensive, do the computation
+# inside a block.
 #
 ##
 # talk - Print msg on STDERR unless `$quiet` is set
@@ -62,7 +63,7 @@ def _fmtargs args, flag
 end
 
 ##
-# dtalk - "debug talk" 
+# dtalk - "debug talk"
 # Print msg on STDERR only if `$debug` is set
 #
 # :call-seq:
@@ -77,9 +78,9 @@ def dtalk *args
   end
 end
 
-def dtalkf *args 
+def dtalkf *args
   if $debug && (args.size> 0 || block_given?)
-    $stderr.printf(*_fmtargs(args, block_given?) { yield }) 
+    $stderr.printf(*_fmtargs(args, block_given?) { yield })
   end
 end
 
@@ -99,7 +100,7 @@ def qtalk *args
   end
 end
 
-def qtalkf *args 
+def qtalkf *args
   if $quiet && (args.size > 0 || block_given?)
     $stderr.printf(*_fmtargs(args, block_given?) { yield } )
   end
@@ -222,6 +223,7 @@ end
 #     run      { [cmd, errmsg] }
 #     run      { [cmd, errmsg, okmg] }
 #     run         cmd, errmsg, okmsg
+#
 #     safe_run    cmd
 #     safe_run    cmd, errmsg
 #     safe_run    cmd, errmsg, okmsg
@@ -238,10 +240,10 @@ end
 #
 # If there is an error, show the command (preceded by `>> `) if `$verbose` is
 # not set, then show the error code, followed by the given `errmsg` or the
-# default error message.  
+# default error message.
 #
 # The `cmd` can be given either as an argument, or as the returned value from a
-# block.  Important: the block should return a string value to be passed to 
+# block.  Important: the block should return a string value to be passed to
 # the system call.
 
 def cmd_run *args
@@ -249,7 +251,7 @@ def cmd_run *args
   if $norun
     nrtalk(args.first)
   elsif args.size > 0
-    safe_run(*args)
+    safe_run *args
   end
 end
 
@@ -259,8 +261,8 @@ def safe_run *args
   args = _msgargs(args, block_given?) { yield }
   cmd, errmsg, okmsg = args
   vtalkf ">> %s\n", cmd
-  if cmd 
-    if system(cmd)              # invoke the command
+  if cmd
+    if system cmd              # invoke the command
       $stderr.puts okmsg if okmsg
       return true
     else                        # an error occured

data/lib/ssh-utils.rb

@@ -0,0 +1,134 @@
+# ssh-utils.rb
+#
+# A module to define some routines for running commands across many systems
+# using ssh
+#
+# Copyright 2013, Alan K. Stebbens <aks@stebbens.org>
+#
+# Usage:
+#
+#    require 'ssh-utils'
+#
+#    on serverlist, :debug = true do |server|
+#      as user do
+#        with PATH
+#          remote_run :whoami
+#        end
+#      end
+#    end
+
+require 'rubygems'
+require 'cmd-utils'
+
+module SSH_Utils
+
+  attr_reader   :server
+  attr_accessor :servers
+
+  @opts = {}
+  @opts.default = nil
+  @@default_envars = %w(PATH)			# default envarlist
+
+  def merge_opts opts = {}
+    @opts ||= {}
+    @opts.merge!(opts) unless opts.empty?
+  end
+
+  # merge_env opts
+  #
+  # merge envars.  :with => ENVARS_TO_ADD, :without => ENVARS_TO_EXCLUDE
+  #   :with => %w(PATH RUBYLIB)
+  #   :without => %w(PATH)
+  # Removes the :with and :without keys from the opts hash
+
+  def merge_env opts
+    @envars = @@default_envars
+    if opts.key?(:with)
+      @envars.concat(opts[:with]).uniq!
+      opts.delete(:with)
+    end
+    if opts.key?(:without)
+      @envars -= opts[:without]
+      opts.delete(:without)
+    end
+  end
+
+  # on SERVERLIST, :with => %w(PATH RUBYLIB), :debug => [true|false], :norun => [true|false]
+
+  def on servers, opts = {}
+    merge_env (opts = opts.dup)
+    merge_opts opts
+    (@servers = servers).each do |server|
+      @server = server
+      talk("--> Running block for server #{server}..") if @opts[:debug] || $debug
+      yield server
+    end
+  end
+
+  # as USER, :with => ENVARLIST, :debug => [true|false], :norun => [true|false]
+
+  def as user, opts = {}
+    @user = user
+    merge_env (opts = opts.dup)
+    merge_opts opts
+    yield if block_given?
+  end
+
+  # with ENVARLIST, :VAR1 => value, :debug => ...
+
+  def with env, opts = {}
+    merge_env (opts = opts.dup)
+    merge_opts opts
+  end
+
+  def ssh_command cmd
+    ssh = "ssh -A"
+    ssh += " -u #{@user}" unless @user.nil?
+    ssh += " #{@server}"
+    @envars.each do |env|
+      # explicit values in the options list override the environment values
+      val = @opts.key?(env) ? @opts[env] : ENV[env]
+      if !(val.nil? || val.empty?)
+        ssh += sprintf(" %s='%s'", env, val.gsub("'", "\'"))
+      end
+    end
+    ssh += " " + cmd.to_s
+    ssh
+  end
+
+  def _show_cmd cmd
+    if @opts[:norun] || $norun
+      talkf "(norun) %s\n", cmd
+    elsif @opts[:debug] || $debug || @opts[:verbose] || $verbose
+      talkf "--> %s\n", cmd
+    end
+  end
+
+  # remote_run COMMAND
+  # run the remote command
+
+  def remote_run cmd
+    ssh = ssh_command(cmd)
+    _show_cmd ssh
+    system(ssh) unless @opts[:norun] || $norun
+  end
+  alias :run_remotely :remote_run
+
+
+  def remote_run_with_output cmd, opts = {}
+    merge_env (opts = opts.dup)
+    merge_opts opts
+    ssh = ssh_command cmd
+    _show_cmd ssh
+    out = nil
+    IO.popen(ssh) {|f| out = f.read }
+    out
+  end
+  alias :capture :remote_run_with_output
+  alias :rrout   :remote_run_with_output
+
+end
+
+include SSH_Utils
+
+# vim: sw=2:ai

data/test/helper.rb

@@ -0,0 +1,35 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cmd-utils'
+
+class Test::Unit::TestCase
+end

data/{tests → test}/test-cmd-utils.rb

@@ -8,7 +8,7 @@ require 'cmd-utils'
 
 # these routines produce output on STDERR depending on $norun, $verbose, and $quiet.
 
-class TestCmdUtils < MiniTest::Test
+class TestCmdUtils < Minitest::Test
 
   #def gen_test name, norun, verbose, quiet, debug, output
   def gen_test name, flags, output
@@ -29,9 +29,9 @@ class TestCmdUtils < MiniTest::Test
     begin
       out, err = capture_subprocess_io do
         begin
-          yield 
-        rescue 
-        end 
+          yield
+        rescue
+        end
       end
     rescue
     end

data/{tests → test}/test-lookup.rb

@@ -8,18 +8,18 @@ require 'lookup'
 
 class NilClass ; def to_s ; '' ; end ; end
 
-class TestLookup < MiniTest::Test
+class TestLookup < Minitest::Test
 
   # do_lookup input-text, output-text, true-if-notfound, true-if-ambiguous
 
   def do_lookup input, output, notfound=nil, ambig=nil
     found = nil
     if notfound
-      assert_raises(LookupNotFoundError) { 
+      assert_raises(LookupNotFoundError) {
         found = lookup(@keywords, input)
       }
     elsif ambig
-      assert_raises(LookupAmbigError)    { 
+      assert_raises(LookupAmbigError)    {
         found = lookup(@keywords, input)
       }
     else
@@ -46,10 +46,18 @@ class TestLookup < MiniTest::Test
     @keywords = %w( email emails reason reasons )
     do_lookup 'email',  'email'
     do_lookup 'emails', 'emails'
-    do_lookup 'emai',   'email',  nil, true
-    do_lookup 'rea',    'reason', nil, true
+    do_lookup 'emai',   '',  nil, true   # ambiguous
+    do_lookup 'rea',    '',  nil, true   # ambiguous
     do_lookup 'reason', 'reason'
     do_lookup 'reasons', 'reasons'
   end
 
+  def test_lookup_failures
+    @keywords = %w( set get show edit reset delete count )
+    do_lookup "s", nil, nil, true   # ambigous
+    do_lookup "foo", nil, true      # not found
+    do_lookup "showit", nil, true   # not found
+    do_lookup "rest",   nil, true   # not found
+  end
+
 end

data/test/test_cmd-utils.rb.off

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCmdUtils < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -1,28 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: cmd-utils
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.1.2
 platform: ruby
 authors:
 - Alan K. Stebbens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
-dependencies: []
-description: Some handy utilities for writing command line scripts in ruby.
+date: 2014-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: bundler
+  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: jeweler
+  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: simplecov
+  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: Several ruby libraries for building command-line utilities.
 email: aks@stebbens.org
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
 files:
+- ".document"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- cmd-utils.gemspec
 - lib/cmd-utils.rb
 - lib/lookup.rb
-- tests/test-cmd-utils.rb
-- tests/test-lookup.rb
-homepage: http://gitlab.com/as/cmd-utils
+- lib/ssh-utils.rb
+- test/helper.rb
+- test/test-cmd-utils.rb
+- test/test-lookup.rb
+- test/test_cmd-utils.rb.off
+homepage: http://bitbucket.org/aks_/cmd-utils
 licenses:
-- GPL-2
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -30,20 +113,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Utilities for ruby command line scripts
-test_files:
-- tests/test-cmd-utils.rb
-- tests/test-lookup.rb
+summary: Utilities for building CLIs
+test_files: []