cli_helper 0.1.8 → 0.1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: daf61d8cbabeb65a4cca02b574eec433477be112
-  data.tar.gz: d7bda7e83f7f3c2f9bbabf66df68f0b398b4466f
+SHA256:
+  metadata.gz: c1359febf0485d5ce8d1b73f6d6b39b264067e0d860bc07ad183c279385450ed
+  data.tar.gz: 58a2e0fc02883f01a9dc89f0cbd4eeb9aa84c75d8b1a9d2fab9104799e7aa20c
 SHA512:
-  metadata.gz: 42014bd7d2a2718ba08ab8dc01d0b87f45116903a85634c04b3a104761cd34e48ccec049b1f51bb18b9c55c83371fe1e78adbb34a1a9b9e33d46d017bb93898d
-  data.tar.gz: d7bbf67ba09b13516d3e02536eb1b20a9a7a40b484aca5c468386c8e03ededb478d98acf9d66f0b27f4e3be2e4d577691315359ee9a2d688466e879639d07aa4
+  metadata.gz: df4e8f09e3a1e0a54078bae22a4877369126b5774fe471e1d4171a44a400bcee55e14aab58590b16da597a59a3a46935bbd2b0e2cba23e46b247108a2749bd42
+  data.tar.gz: 619e7bac2f07d7dc11d4b1a6a2a1933ee7867b2e0237968ddffbdc476dc844da4d726a5005202a7f2ceed1a22ae3a3a8db3c3ffce56bc243e78fc999a858d142

data/README.md

@@ -2,22 +2,28 @@
 
 ## Most recent changes
 
+### v0.1.9.1
+
+* Adopting the amazing_print fork of awesome_print for development.  Its not used in the main gem, just I like to use it while developing.  Doesn't everyone?
+
+### v0.1.9
+
+* Changed gemspec to use slop ~> 4.6
+
+### v0.1.8
+
+* Changed #get_pathnames_from to issue warnings in place of errors for files that do not have the correct file extension
+* Added some more comments to the code
+
 ### v0.1.3
 
 * added ability to process a directory of config files
 * added ability to process a default set of config files that could get over-written by specific config files specified on the command line
 
-### v0.1.2
-
-* replaced the parseconfig gem with the inifile gem -- this now enables the use of ERB in *.ini and *.txt config files
-* changed support_config_files to enable_config_files -- cpmsisten terminology
 
 ## Description
 
-If you write lots of command-line utility programs, or
-even if you don't the cli_helper gem can be a helper
-to you.  It integrates several common gems to give
-a comprehensive configuration management experience.
+If you write lots of command-line utility programs, or even if you don't the cli_helper gem can be a helper to you.  It integrates several common gems to give a comprehensive configuration management experience.
 
 Here are the gems used and what they do:
 
@@ -40,48 +46,35 @@ Here are the gems used and what they do:
 
 ## Convention
 
-The convention w/r/t what value amoung concurrent sources
-is the correct one to use is hierarchic
-where the layer above trumps all the layers below.  This is the order:
+The convention w/r/t what value amoung concurrent sources is the correct one to use is hierarchic where the layer above trumps all the layers below.  This is the order:
 
 * command-line parameter
   * config file value
     * system environment variable
       * default
 
-This ordering says that regardless what you have set in
-a config file or ENV or as a default, the value of the
-command line parameter will be used.
+This ordering says that regardless what you have set in a config file or ENV or as a default, the value of the command line parameter will be used.
 
-I like to use ERB within my config files.  Consider 'default.yml.erb'
-below:
+I like to use ERB within my config files.  Consider 'default.yml.erb' below:
 
 ```ruby
 ---
   host: <%= Nenv.host || 'localhost' %>
 ```
 
-Processing this file will give me either the default value for host
-of 'localhost' or if defined the value of the system environment
-variable HOST.  I like Nenv over ENV.
+Processing this file will give me either the default value for host of 'localhost' or if defined the value of the system environment variable HOST.  I like Nenv over ENV.
 
-Now suppose I use cli_helper within a program and execute the
-program like this:
+Now suppose I use cli_helper within a program and execute the program like this:
 
 ```ruby
 program.rb --host devhost --config default.yml.erb,prod.ini
 ```
 
-Because I have specifically called out the value of host on the
-command line, that value will trump anything that comes from the
-config file.
+Because I have specifically called out the value of host on the command line, that value will trump anything that comes from the config file.
 
 Did you notice that I had two files specified with the --config option?
 
-The config files are processed in the order that they are given on the command
-line.  Whatever values were obtained from the first file will be over-written
-by the second and any subsequent config files.  Regardless of their
-values for host, the command-line value trumps them all.
+The config files are processed in the order that they are given on the command line.  Whatever values were obtained from the first file will be over-written by the second and any subsequent config files.  Regardless of their values for host, the command-line value trumps them all.
 
 
 ## Config files
@@ -98,15 +91,12 @@ cli_helper supports multiple types of configuration files:
   *.yml.erb
 ```
 
-All values obtained from config files and command line parameters are
-held in the configatron structure.
+All values obtained from config files and command line parameters are held in the configatron structure.
 
 
 ## Common Command-line Options
 
-cli_helper predefines common command-line options.  These
-can to disabled by the program if necessary.  The common options
-are:
+cli_helper predefines common command-line options.  These can to disabled by the program if necessary.  The common options are:
 
 ```text
   -h, --help
@@ -116,33 +106,26 @@ are:
   --config (optional)
 ```
 
-To enable the support for config files do this before
-calling the #cli_helger() method:
+To enable the support for config files do this before calling the #cli_helger() method:
 
 ```ruby
 configatron.enable_config_files = true
 ```
 
-To disable any of the other common options do this before
-involking cli_helper:
+To disable any of the other common options do this before involking cli_helper:
 
 ```ruby
-configatron.disable_help = true
-configatron.disable_debug = true
+configatron.disable_help    = true
+configatron.disable_debug   = true
 configatron.disable_verbose = true
 cpnfogatrpm/dosab;e_version = true
 ```
 
 ## Other options
 
-The default behavior is to raise an exception if an unspecified option is
-used on the command line.  For example if your program just uses the common
-options and someone invokes the program with --xyzzy then an exception will be
-raised saying that the option is unknown.
+The default behavior is to raise an exception if an unspecified option is used on the command line.  For example if your program just uses the common options and someone invokes the program with --xyzzy then an exception will be raised saying that the option is unknown.
 
-To prevent this exception you can set the suppress_errors parameter.  With
-this parameter set to true an unknown option will just be added to the unprocessed
-arguments array.
+To prevent this exception you can set the suppress_errors parameter.  With this parameter set to true an unknown option will just be added to the unprocessed arguments array.
 
 ```ruby
 configatron.suppress_errors = true
@@ -154,18 +137,15 @@ The unprocessed options can be access via the arguments array:
 configatron.arguments
 ```
 
-The arguments array is also where you will find anything else from the
-command line that was not processed by the cli_helper.  For example:
+The arguments array is also where you will find anything else from the command line that was not processed by the cli_helper.  For example:
 
 ```ruby
 my_program.rb -v *.txt
 ```
 
-The file names matching the '*.txt' glob will be put into the configatron.arguments
-array.
+The file names matching the '*.txt' glob will be put into the configatron.arguments array.
 
-When process INI or TXT config files the following options can
-be useful:
+When process INI or TXT config files the following options can be useful:
 
 ```ruby
 configatron.ini_comment   # default: '#'
@@ -176,9 +156,7 @@ configatron.ini_seperator # default: '='
 
 ## Boolean options auto-generate methods
 
-Any boolean command-line option specified, even the predefined common ones,
-have two methods defined: query(?) and banger(!).  For the help options
-the methods look like this:
+Any boolean command-line option specified, even the predefined common ones, have two methods defined: query(?) and banger(!).  For the help options the methods look like this:
 
 ```ruby
 def help?
@@ -192,31 +170,20 @@ end
 
 ## Names of command-line options
 
-If you specify a command-line option of xyzzy, then an
-entry in the configatron structure will be created having the
-name 'xyzzy'.  If you do not use a long-form for the option
-the short option name will be used.  For example '-x' will
-be accessed as configatron.x
+If you specify a command-line option of xyzzy, then an entry in the configatron structure will be created having the name 'xyzzy'.  If you do not use a long-form for the option the short option name will be used.  For example '-x' will be accessed as configatron.x
 
 
 ## Support methods
 
-There are several support methods that I have included in cli_helper
-that you may want to use.  The first three deal with
-errors and warnings and what to do with them.
+There are several support methods that I have included in cli_helper that you may want to use.  The first three deal with errors and warnings and what to do with them.
 
 * warning(a_string)
 * error(a_string)
 * abort_if_errors
 
-cli_helper defines two arrays within configatron: errors and warnings.  The
-warning() and error() methods insert their strings into these arrays.  The
-abort_if_errors method first looks at the warnings array and presents all of
-those strings to the user via STDOUT.  It then asks the user if they want
-to abort the program.  The default answer is no.
+cli_helper defines two arrays within configatron: errors and warnings.  The warning() and error() methods insert their strings into these arrays.  The abort_if_errors method first looks at the warnings array and presents all of those strings to the user via STDOUT.  It then asks the user if they want to abort the program.  The default answer is no.
 
-After presenting the warnings to the user, the abort_if_error method presents
-all of the errors to the user.  Then it exits the program.
+After presenting the warnings to the user, the abort_if_error method presents all of the errors to the user.  Then it exits the program.
 
 These next support methods are self explanatory:
 
@@ -229,11 +196,7 @@ But this one needs some explaining:
 
 * get_pathnames_from(an_array, extnames=['.json', '.txt', '.docx'])
 
-The method get_pathnames_from() returns an array of pathnames matching a specific
-set of file types.  The default types are txt, json and docx because that tends to
-be the majority of the files in which I am interested.  Might add wcml to the default list
-later.  Regardless you propabily ought to provide your own array of file extensions.  And
-don't forget the dot!
+The method get_pathnames_from() returns an array of pathnames matching a specific set of file types.  The default types are txt, json and docx because that tends to be the majority of the files in which I am interested.  Might add wcml to the default list later.  Regardless you propabily ought to provide your own array of file extensions.  And don't forget the dot!
 
 If an entry in the array is a directory then its children will be search including any sub-directories recursively.
 

data/cli_helper.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "cli_helper"
-  spec.version       = '0.1.8'
+  spec.version       = '0.1.9.1'
   spec.authors       = ["Dewayne VanHoozer"]
   spec.email         = ["dvanhoozer@gmail.com"]
 
@@ -31,12 +31,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'configatron'
   spec.add_dependency 'nenv'
   spec.add_dependency 'inifile'
-  spec.add_dependency 'slop', "~> 4.2"
+  spec.add_dependency 'slop', "~> 4.6"
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'kick_the_tires'
-  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'amazing_print'
   spec.add_development_dependency 'debug_me'
   spec.add_development_dependency 'timecop'
 

data/example/cli_stub.rb

@@ -10,12 +10,12 @@
 require 'debug_me'
 include DebugMe
 
-require 'awesome_print'
+require 'amazing_print'
 
 require '../lib/cli_helper'
 include CliHelper
 
-configatron.version = '0.0.3' # the version of this utility program
+configatron.version = '0.1.9' # the version of this utility program
 configatron.enable_config_files = false # default is false
 configatron.disable_help    = false # default is false set true to remove the option
 configatron.disable_verbose = false # ditto
@@ -108,7 +108,7 @@ cli_helper("An example use of cli_helper") do |o|
   o.string  '-s', '--string', 'example string parameter',  default: 'IamDefault'
   o.string  '-r', '--required', 'a required parameter'     # I know its required because there is no default
   o.bool          '--xyzzy',  'a required boolean without a default', required: true
-  
+
   # NOTE: you can use many "flags" in defining an option.  Each is valid on the command line.
   # However, only the last flag can be used to retrieve the value via the configatron capability.
   # To get the value entered by the user for this integer parameter you must use:
@@ -120,7 +120,7 @@ cli_helper("An example use of cli_helper") do |o|
   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: ',', 
+  o.paths         '--paths',  'example Pathnames parameter', delimiter: ',',
     default: ['default/path/to/file.txt', 'file2.txt'].map{|f| Pathname.new f}
 
   o.string '-n', '--name', 'print Hello <name>', default: 'World!', suppress_errors: true do |a_string|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9.1
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2020-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configatron
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -200,10 +200,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: An encapsulation of an integration of slop, nenv, inifile and configatron.
 test_files: []
-has_rdoc: