cli_helper 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f89331e703cf232785ca8d53326636cfa11c8cd8
-  data.tar.gz: 5481796f66cdf9112a887eccffb2f6db4da5db13
+  metadata.gz: 908f129ebd9c858f0b8a5f63216db870545ba9f6
+  data.tar.gz: a839ae1f117642b1edcf34dbfba1d5c2906e3e0e
 SHA512:
-  metadata.gz: f68d31b2f94d5086e2ac90a0e24e65aa4218195a136eb2984fdb7aa5a1e30ac4dcff9393e71519a51d9e229e70edccac4ecc110d7b03f76f63d0f5b487c32b9f
-  data.tar.gz: 519b04e19531eaa4269264ace89ab7614b91e9970c8d743db34dac760d78b5fb86bfebc0291ba8f83dc9a54f96831ac0f171c37ca60f72ee130e1199ff551808
+  metadata.gz: ca4ac6875722b4caee01dec81a725e872ec4caae88f9d9ac0adb9b291a385e50c9f831a137838749d6fbea6422b801369eb5745b7044684b9e82b020cd53cecf
+  data.tar.gz: 5aee6b729080af581763f64add1685393e8d33814cf4be74eb6628c8f8f0e6a92385a6a26f3c3ef1fb4c6f24a4de8283d7a11e78c8fbcf75d046161a3d1e20d5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cli_helper.gemspec
+gemspec

data/README.md

@@ -0,0 +1,22 @@
+# cli_helper.rb
+
+I had this code just being lazy on my computer.  It might be of use
+to someone else; but, its just really intended to support my own
+quick and dirty command-line based utilities.  Mostly they are one-offs
+but sometimes they hang around.
+
+I typically create thes cli utilities using my own code generater which
+resulted in lots of duplicate source blocks roll around on the deck.  This
+little library will DRYup my code a little.
+
+
+## Usage
+
+TODO: Write usage instructions here in case someone can't figure it out
+      for themselves.
+
+
+## License
+
+You want it?  Its yours.
+# cli_helper

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/cli_helper.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "cli_helper"
+  spec.version       = '0.0.2'
+  spec.authors       = ["Dewayne VanHoozer"]
+  spec.email         = ["dvanhoozer@gmail.com"]
+
+  spec.summary       = %q{An encapsulates of common junk used with Q&D CLI utilities.}
+  spec.description   = %q{An encapsulation of a convention I have been using
+   with the slop, nenv, and other gems for quick and dirty development of
+   command-line based utility programs.  Its not pretty.  It may even break
+   your code.  I wouldn't use it if I were you.  You could, if you wanted,
+   namespace this stuff within CliHelper and establish a new convention.
+   You might even wrap not only slop but some of those other ARGV parsers.
+   I only did this much after being shamed into it by rubycritic.}
+  spec.homepage      = "http://github.com/MadBomber/cli_helper"
+  spec.license       = "You want it?  It's yours."
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  end
+
+  spec.add_dependency 'slop'
+  spec.add_dependency 'nenv'
+  spec.add_dependency 'awesome_print'
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'test_inline'
+
+end

data/example/cli_stub.rb

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+##########################################################
+###
+##  File: cli_stub.rb
+##  Desc: Example on how to use cli_helper for q&d CLI utilities
+##  By:   Dewayne VanHoozer (dvanhoozer@gmail.com)
+#
+
+require 'cli_helper'
+
+$options[:version] = '0.0.1' # the version of this utility program
+
+# HELP is extra stuff shown with usage.  It is optional.
+HELP = <<EOHELP
+Important:
+
+  Put important stuff here.
+
+EOHELP
+
+# The description (aka banner) text is optional.  The block is required.
+cli_helper("An example use of cli_helper") do |o|
+
+  # For a complete list of stuff see Slop on github.com
+  # https://github.com/leejarvis/slop
+
+  o.string  '-s', '--string', 'example string parameter',  default: 'IamDefault'
+  o.int     '-i', '--int',    'example integer parameter', default: 42
+
+  # FIXME: an issue with Slop
+  #o.float   '-f', '--float',  'example float parameter', default: (22.0 / 7.0)
+
+  o.array   '-a', '--array',  'example array parameter',   default: [:bob, :carol, :ted, :alice]
+  o.path    '-p', '--path',   'example Pathname parameter', default: Pathname.new('default/path/to/file.txt')
+  o.paths         '--paths',  'example Pathnames parameter', delimiter: ',', default: ['default/path/to/file.txt', 'file2.txt'].map{|f| Pathname.new f}
+
+  # FIXME: Issue with Slop; default is not passed to the block.  When no parameter is
+  #        given, an exception is raised.  Using the suppress_errors: true option silents
+  #        the exception BUT still the default value is not passed to the block.
+  o.string '-n', '--name', 'print Hello <name>', default: 'World!', suppress_errors: true do |a_string|
+    a_string = 'world' if a_string.empty?
+    puts "Hello #{a_string}"
+  end
+
+end
+
+# ARGV is not touched.  However all command line parameters that are not consummed
+# are available in $options[:arguments]
+
+# Display the usage info
+if  ARGV.empty?
+  show_usage
+  exit
+end
+
+
+# Error check your stuff; use error('some message') and warning('some message')
+
+unless $options[:arguments].empty?
+  warning "These items were not processed #{$options[:arguments]}"
+end
+
+if $options[:arguments].include?('error')
+  error "You wanted an error, so you got one."
+end
+
+abort_if_errors
+
+
+######################################################
+# Local methods
+
+
+######################################################
+# Main
+
+at_exit do
+  puts
+  puts "Done."
+  puts
+end
+
+ap $options  if verbose? || debug?
+
+stub = <<EOS
+
+
+   d888888o. 8888888 8888888888 8 8888      88 8 888888888o
+ .`8888:' `88.     8 8888       8 8888      88 8 8888    `88.
+ 8.`8888.   Y8     8 8888       8 8888      88 8 8888     `88
+ `8.`8888.         8 8888       8 8888      88 8 8888     ,88
+  `8.`8888.        8 8888       8 8888      88 8 8888.   ,88'
+   `8.`8888.       8 8888       8 8888      88 8 8888888888
+    `8.`8888.      8 8888       8 8888      88 8 8888    `88.
+8b   `8.`8888.     8 8888       ` 8888     ,8P 8 8888      88
+`8b.  ;8.`8888     8 8888         8888   ,d8P  8 8888    ,88'
+ `Y8888P ,88P'     8 8888          `Y88888P'   8 888888888P
+
+
+EOS
+
+puts stub
+

data/lib/cli_helper.rb

@@ -0,0 +1,325 @@
+# encoding: utf-8
+##########################################################
+###
+##  File: cli_helper.rb
+##  Desc: Some DRYed up stuff for quick and dirty CLI utilities
+##  By:   Dewayne VanHoozer (dvanhoozer@gmail.com)
+#
+
+#require 'test_inline'
+
+# NOTE: this conditional required by test_inline
+if caller.empty?
+  required_by_filename = __FILE__
+else
+  required_by_filename = caller.last.split(':').first
+end
+
+require 'debug_me'
+include DebugMe
+
+require 'awesome_print'
+
+require 'pathname'
+require 'nenv'
+require 'slop'
+
+# Example Custom Type for Slop
+module Slop
+  class PathOption < Option
+    def call(value)
+      Pathname.new(value)
+    end
+  end
+  class PathsOption < ArrayOption
+    def finish(opts)
+      self.value = value.map { |f| Pathname.new(f) }
+    end
+  end
+end # module Slop
+
+$cli      = 'a place holder'
+$errors   = []
+$warnings = []
+
+$options = {
+  version:        '0.0.1',# the version of this program
+  arguments:      [],     # whats left after options and parameters are extracted
+  verbose:        false,
+  debug:          false,
+  help:           false,
+  user_name:      Nenv.user || Nenv.user_name || Nenv.logname || 'Dewayne VanHoozer',
+  me:             Pathname.new(required_by_filename).realpath,
+  home_path:      Pathname.new(Nenv.home)
+}
+
+$options[:my_dir]   = $options[:me].parent
+$options[:my_name]  = $options[:me].basename.to_s
+
+# Return full pathname of program
+def me
+  $options[:me]
+end
+
+# Returns the basename of the program as a string
+def my_name
+  $options[:my_name]
+end
+
+# Returns the version of the program as a string
+def version
+  $options[:version]
+end
+
+# Invoke Slop with common CLI parameters and custom
+# parameters provided via a block.  Create '?'
+# for all boolean parameters that have a '--name' flag form.
+# Returns a Slop::Options object
+def cli_helper(my_banner='')
+  param = Slop::Options.new
+
+  if my_banner.empty?
+    param.banner = "Usage: #{my_name} [options] ..."
+  else
+    param.banner = my_banner
+    param.separator "\nUsage: #{my_name} [options] ..."
+  end
+
+  param.separator "\nWhere:"
+  param.separator "  Common Options Are:"
+
+  param.bool '-h', '--help',    'show this message'
+  param.bool '-v', '--verbose', 'enable verbose mode'
+  param.bool '-d', '--debug',   'enable debug mode'
+
+  param.on '--version', "print the version: #{$options[:version]}" do
+    puts $options[:version]
+    exit
+  end
+
+  param.separator "  Program Options Are:"
+
+  yield(param) if block_given?
+
+  parser = Slop::Parser.new(param)
+  $cli = parser.parse(ARGV)
+
+  $options.merge!($cli.to_hash)
+  $options[:arguments] = $cli.arguments
+
+
+  bools = param.options.select do |o|
+    o.is_a? Slop::BoolOption
+  end.select{|o| o.flags.select{|f|f.start_with?('--')}}.
+      map{|o| o.flags.last.gsub('--','')} # SMELL: depends on convention
+
+  bools.each do |m|
+    s = m.to_sym
+    define_method(m+'?') do
+      $options[s]
+    end unless self.respond_to?(m+'?')
+    define_method(m+'!') do
+      $options[s] = true
+    end unless self.respond_to?(m+'!')
+  end
+
+  if help?
+    show_usage
+    exit
+  end
+
+  return param
+end # cli_helper
+
+# Returns the usage/help information as a string
+def usage
+  a_string = $cli.to_s + "\n"
+  a_string += HELP + "\n" if defined?(HELP)
+  return a_string
+end
+
+# Prints to STDOUT the usage/help string
+def show_usage
+  puts usage()
+end
+
+
+# Returns an array of valid files of one type
+def get_pathnames_from(an_array, extnames=['.json', '.txt', '.docx'])
+  an_array = [an_array] unless an_array.is_a? Array
+  extnames = [extnames] unless extnames.is_a? Array
+  extnames = extnames.map{|e| e.downcase}
+  file_array = []
+  an_array.each do |a|
+    pfn = Pathname.new(a)
+    if pfn.directory?
+      file_array << get_pathnames_from(pfn.children, extnames)
+    else
+      file_array << pfn if pfn.exist? && extnames.include?(pfn.extname.downcase)
+    end
+  end
+  return file_array.flatten
+end # def get_pathnames_from(an_array, extname='.json')
+
+
+# Display global warnings and errors arrays and exit if necessary
+def abort_if_errors
+  unless $warnings.empty?
+    STDERR.puts
+    STDERR.puts "The following warnings were generated:"
+    STDERR.puts
+    $warnings.each do |w|
+      STDERR.puts "\tWarning: #{w}"
+    end
+    STDERR.print "\nAbort program? (y/N) "
+    answer = (STDIN.gets).chomp.strip.downcase
+    $errors << "Aborted by user" if answer.size>0 && 'y' == answer[0]
+    $warnings = []
+  end
+  unless $errors.empty?
+    STDERR.puts
+    STDERR.puts "Correct the following errors and try again:"
+    STDERR.puts
+    $errors.each do |e|
+      STDERR.puts "\t#{e}"
+    end
+    STDERR.puts
+    exit(-1)
+  end
+end # def abort_if_errors
+
+# Adds a string to the global $errors array
+def error(a_string)
+  $errors << a_string
+end
+
+# Adds a string to the global $warnings array
+def warning(a_string)
+  $warnings << a_string
+end
+
+
+__END__
+################################################
+## Here is how it works
+
+Test '000 supports basic common parameters' do
+  params = cli_helper
+  assert params.is_a? Slop::Options
+  assert usage.include?('--help')
+  assert usage.include?('--debug')
+  assert usage.include?('--verbose')
+  assert usage.include?('--version')
+  refute usage.include?('--xyzzy')
+end
+
+=begin
+# NOTE: The Test construct creates a dynamic class which
+# does not incorporate 'define_method'  This Test results
+# in errors that are a consequence of the testing framework
+# not the object under test.
+Test '002 creates accessor methods to boolean options' do
+  cli_helper
+  all_methods = methods
+  %w[ help? debug? verbose? version?
+      help! debug! verbose! version!].each do |m|
+    assert all_methods.include?(m)
+  end
+  refute all_methods.include?('xyzzy?')
+  refute all_methods.include?('xyzzy!')
+end
+=end
+
+Test '005 block inclusion' do
+  cli_helper do |param|
+    param.string '-x', '--xyxxy', 'example MAGIC parameter',  default: 'IamDefault'
+  end
+  assert usage.include?('MAGIC')
+end
+
+Test '010 supports banner' do
+  refute usage().include?('BANNER')
+  cli_helper('This is my BANNER')
+  assert usage().include?('BANNER')
+end
+
+Test '015 supports additional help in usage' do
+  refute usage.include?('HELP')
+  HELP = "Do you need some HELP?"
+  assert usage.include?('HELP')
+end
+
+Test '020 put it all together' do
+  cli_helper('This is my BANNER') do |o|
+    o.string '-x', '--xyxxy', 'example MAGIC parameter',  default: 'IamDefault'
+  end
+  HELP = "Do you need some HELP?"
+  assert usage.include?('BANNER')
+  assert usage.include?('MAGIC')
+  assert usage.include?('HELP')
+end
+
+Test '025 Add to $errors' do
+  assert $errors.empty?
+  a_message = 'There is a serious problem here'
+  error a_message
+  refute $errors.empty?
+  assert_equal 1, $errors.size
+  assert_equal a_message, $errors.first
+end
+
+Test '030 Add to $warnings' do
+  assert $warnings.empty?
+  a_message = 'There is a minor problem here'
+  warning a_message
+  refute $warnings.empty?
+  assert_equal 1, $warnings.size
+  assert_equal a_message, $warnings.first
+end
+
+Test '035 Add to $errors' do
+  refute $errors.empty?
+  a_message = 'There is another serious problem here'
+  error a_message
+  assert_equal 2, $errors.size
+  assert_equal a_message, $errors.last
+end
+
+Test '040 Add to $warnings' do
+  refute $warnings.empty?
+  a_message = 'There is a another minor problem here'
+  warning a_message
+  assert_equal 2, $warnings.size
+  assert_equal a_message, $warnings.last
+end
+
+
+
+
+
+Test '999 prints usage()'  do
+  puts
+  puts "="*45
+  show_usage
+  puts "="*45
+  puts
+  a_string = <<EOS
+This is my BANNER
+
+Usage: cli_helper.rb [options] ...
+
+Where:
+  Common Options Are:
+    -h, --help     show this message
+    -v, --verbose  enable verbose mode
+    -d, --debug    enable debug mode
+    --version      print the version: 0.0.1
+  Program Options Are:
+    -x, --xyxxy    example MAGIC parameter
+
+Do you need some HELP?
+EOS
+
+  assert_equal a_string, usage
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -94,22 +94,32 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: An encapsulation of a convention I have been using with the slop, nenv,
-  and other gems for quick and dirty development of command-line based utility programs.  Its
-  not pretty.  It may even break your code.  I wouldn't use it if I were you.  You
-  could, if you wanted, namespace this stuff within CliHelper and establish a new
-  convention.  You might even wrap not only slop but some of those other ARGV parsers.  I
-  only did this much after being shamed into it by rubycritic.
+description: |-
+  An encapsulation of a convention I have been using
+     with the slop, nenv, and other gems for quick and dirty development of
+     command-line based utility programs.  Its not pretty.  It may even break
+     your code.  I wouldn't use it if I were you.  You could, if you wanted,
+     namespace this stuff within CliHelper and establish a new convention.
+     You might even wrap not only slop but some of those other ARGV parsers.
+     I only did this much after being shamed into it by rubycritic.
 email:
 - dvanhoozer@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- cli_helper.gemspec
+- example/cli_stub.rb
+- lib/cli_helper.rb
 homepage: http://github.com/MadBomber/cli_helper
 licenses:
-- You want it?  Its yours.
-metadata: {}
+- You want it?  It's yours.
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -126,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: An encapsulates of common junk used with Q&D CLI utilities.