cli_helper 0.0.4 → 0.1.0

data/lib/cli_helper.rb

@@ -6,22 +6,15 @@
 ##  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'
-
+# System Libraries
 require 'pathname'
+require 'erb'
+require 'yaml'
+
+# Third-party gems
+require 'configatron'
 require 'nenv'
+require 'parseconfig'
 require 'slop'
 
 # Example Custom Type for Slop
@@ -48,288 +41,269 @@ module Slop
   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] ..."
+module CliHelper
+
+  DEFAULTS = {
+    version:        '0.0.1',# the version of this program
+    arguments:      [],     # whats left after options and parameters are extracted
+    verbose:        false,
+    debug:          false,
+    help:           false,
+    support_config_files: false,
+    disable_help:   false,
+    disable_debug:  false,
+    disable_verbose: false,
+    disable_version: false,
+    suppress_errors: false,
+    user_name:      Nenv.user || Nenv.user_name || Nenv.logname || 'The Unknown Programmer',
+    home_path:      Pathname.new(Nenv.home),
+    cli:            'a place holder for the Slop object',
+    errors:         [],
+    warnings:       []
+  }
+
+  configatron.configure_from_hash DEFAULTS
+
+  configatron.required_by_filename = caller.last.split(':').first
+  configatron.me       = Pathname.new(configatron.required_by_filename).realpath
+  configatron.my_dir   = Pathname.new(configatron.required_by_filename).realpath.parent
+  configatron.my_name  = Pathname.new(configatron.required_by_filename).realpath.basename.to_s
+
+
+  # Return full pathname of program
+  def me
+    configatron.me
   end
 
-  param.separator "\nWhere:"
-  param.separator "  Common Options Are:"
+  # Returns the basename of the program as a string
+  def my_name
+    configatron.my_name
+  end
 
-  param.bool '-h', '--help',    'show this message'
-  param.bool '-v', '--verbose', 'enable verbose mode'
-  param.bool '-d', '--debug',   'enable debug mode'
+  # Returns the version of the program as a string
+  def version
+    configatron.version
+  end
 
-  param.on '--version', "print the version: #{$options[:version]}" do
-    puts $options[:version]
-    exit
+  def cli_helper_process_erb(file_contents)
+    erb_contents = ERB.new(file_contents).result
+    return erb_contents
   end
 
-  param.separator "  Program Options Are:"
+  def cli_helper_process_yaml(file_contents='')
+    a_hash = YAML.load file_contents
+    return a_hash
+  end
 
-  yield(param) if block_given?
+  def cli_helper_process_ini(file_path, file_contents='')
+    # FIXME: mod the parseconfig gem to use a parse method on strings
+    an_ini_object = ParseConfig.new(file_path)
+    return an_ini_object.params
+  end
 
-  parser = Slop::Parser.new(param)
-  $cli = parser.parse(ARGV)
+  # 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
 
-  $options.merge!($cli.to_hash)
-  $options[:arguments] = $cli.arguments
+    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:"
 
-  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
+    if  configatron.disable_help      &&
+        configatron.disable_verbose   &&
+        configatron.disable_debug     &&
+        configatron.disable_version
+      # NOOP
+    else
+      param.separator "\n  Common Options Are:"
+    end
 
-  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
+    unless configatron.disable_help
+      param.bool '-h', '--help',    'show this message'
+    end
 
-  if help?
-    show_usage
-    exit
-  end
+    unless configatron.disable_verbose
+      param.bool '-v', '--verbose', 'enable verbose mode'
+    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)
+    unless configatron.disable_debug
+      param.bool '-d', '--debug',   'enable debug mode'
     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}"
+
+    unless configatron.disable_version
+      param.on '--version', "print the version: #{configatron.version}" do
+        puts configatron.version
+        exit
+      end
     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}"
+
+    param.separator "\n  Program Options Are:"
+
+    yield(param) if block_given?
+
+    if configatron.support_config_files
+      param.paths '--config',    'read config file(s) [*.rb, *.yml, *.ini]'
+    end
+
+    parser = Slop::Parser.new(param, suppress_errors: configatron.suppress_errors)
+    configatron.cli = parser.parse(ARGV)
+
+    # TODO: DRY this conditional block
+    if configatron.support_config_files
+
+      configatron.cli[:config].each do |cf|
+        unless cf.exist? || cf.directory?
+          error "Config file is missing: #{cf}"
+        else
+          file_type = case cf.extname.downcase
+            when '.rb'
+              :ruby
+            when '.yml', '.yaml'
+              :yaml
+            when '.ini', '.txt'
+              :ini
+            when '.erb'
+              extname = cf.basename.to_s.downcase.gsub('.erb','').split('.').last
+              if %w[ yml yaml].include? extname
+                :yaml
+              elsif %w[ ini txt ].include? extname
+                :ini
+              elsif 'rb' == extname
+                raise 'MakesNoSenseToMe: *.rb.erb is not supported'
+              else
+                :unknown
+              end
+          else
+            :unknown
+          end
+
+          case file_type
+            when :ruby
+              load cf
+            when :yaml
+              configatron.configure_from_hash(
+                config_file_hash = configatron.configure_from_hash(
+                  cli_helper_process_yaml(
+                    cli_helper_process_erb(cf.read)
+                  )
+                )
+              )
+            when :ini
+              configatron.configure_from_hash(
+                configatron.configure_from_hash(
+                  cli_helper_process_ini( cf # FIXME: fork parseconfig
+                    # cli_helper_process_erb(cf.read)
+                  )
+                )
+              )
+            else
+              error "Do not know how to parse this file: #{cf}"
+          end # case type_type
+        end # unless cf.exist? || cf.directory?
+      end # configatron.cli.config.each do |cf|
+    end # if configatron.support_config_files
+
+    configatron.configure_from_hash(configatron.cli.to_hash)
+    configatron.arguments = configatron.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
+        configatron[s]
+      end unless self.respond_to?(m+'?')
+      define_method((m+'!').to_sym) do
+        configatron[s] = true
+      end unless self.respond_to?(m+'!')
     end
-    STDERR.puts
-    exit(-1)
+
+
+    if self.respond_to?(:help?) && help?
+      show_usage
+      exit
+    end
+
+    return param
+  end # def cli_helper
+
+  # Returns the usage/help information as a string
+  def usage
+    a_string = configatron.cli.to_s + "\n"
+    a_string += HELP + "\n" if defined?(HELP)
+    return a_string
   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)
+
+  # Prints to STDOUT the usage/help string
+  def show_usage
+    puts usage()
   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'
+
+
+  # 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 configatron.warnings.empty?
+      STDERR.puts
+      STDERR.puts "The following warnings were generated:"
+      STDERR.puts
+      configatron.warnings.each do |w|
+        STDERR.puts "\tWarning: #{w}"
+      end
+      STDERR.print "\nAbort program? (y/N) "
+      answer = (STDIN.gets).chomp.strip.downcase
+      configatron.errors << "Aborted by user" if answer.size>0 && 'y' == answer[0]
+      configatron.warnings = []
+    end
+    unless configatron.errors.empty?
+      STDERR.puts
+      STDERR.puts "Correct the following errors and try again:"
+      STDERR.puts
+      configatron.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)
+    configatron.errors << a_string
   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'
+
+  # Adds a string to the global $warnings array
+  def warning(a_string)
+    configatron.warnings << a_string
   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
+
+end # module CliHelper
 

data/tests/README.txt

@@ -0,0 +1,18 @@
+The minitest framework depends upon pry.
+
+HOWEVER, pry currently requires an older version
+of Slop.  CliHelper is based upon version 4+ of Slop;
+When pry/minitest gets updated, I will un update the
+test suite for full automation.
+
+For now the test file is more manual.  Run tests like
+the following from the command line:
+
+```bash
+./cli_helper_test.rb --config config/sample.ini,config/sample.ini.erb
+./cli_helper_test.rb --config config/sample.rb,config/sample.rb.erb
+./cli_helper_test.rb --config config/sample.txt,config/sample.txt.erb
+./cli_helper_test.rb --config config/sample.yml,config/sample.yml.erb
+```
+
+The test with config/sample.rb.erb with raise a MakesNoSenseToMe exception.