cli_helper 0.0.4 → 0.1.0

data/tests/cli_helper_test.rb

@@ -0,0 +1,217 @@
+#!/usr/bin/env ruby
+################################################
+## Here is how it works
+
+require_relative '../lib/cli_helper'
+include CliHelper
+
+
+# can not use minitest because it requires pry which
+# requires an older version of slop
+#require 'minitest/autorun'
+require 'kick_the_tires'
+include KickTheTires
+
+require 'debug_me'
+include DebugMe
+
+
+configatron.support_config_files = true
+
+#describe 'how it works' do
+
+#it '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')
+
+  if configatron.support_config_files
+    assert usage.include?('--config')
+  else
+    refute usage.include?('--config')
+  end
+
+#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.
+it '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
+
+#it '005 block inclusion' do
+  cli_helper do |param|
+    param.string '-x', '--xyxxy', 'example MAGIC parameter',  default: 'IamDefault'
+  end
+  assert usage.include?('MAGIC')
+#end
+
+#it '010 supports banner' do
+  refute usage().include?('BANNER')
+  cli_helper('This is my BANNER')
+  assert usage().include?('BANNER')
+#end
+
+#it '015 supports additional help in usage' do
+  refute usage.include?('HELP')
+  HELP = "Do you need some HELP?"
+  assert usage.include?('HELP')
+#end
+
+#it '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
+
+#it '025 Add to options.errors' do
+  assert configatron.errors.empty?
+  a_message = 'There is a serious problem here'
+  error a_message
+  refute configatron.errors.empty?
+  assert_equal 1, configatron.errors.size
+  assert_equal a_message, configatron.errors.first
+#end
+
+#it '030 Add to options.warnings' do
+  assert configatron.warnings.empty?
+  a_message = 'There is a minor problem here'
+  warning a_message
+  refute configatron.warnings.empty?
+  assert_equal 1, configatron.warnings.size
+  assert_equal a_message, configatron.warnings.first
+#end
+
+#it '035 Add to options.errors' do
+  refute configatron.errors.empty?
+  a_message = 'There is another serious problem here'
+  error a_message
+  assert_equal 2, configatron.errors.size
+  assert_equal a_message, configatron.errors.last
+#end
+
+#it '040 Add to options.warnings' do
+  refute configatron.warnings.empty?
+  a_message = 'There is a another minor problem here'
+  warning a_message
+  assert_equal 2, configatron.warnings.size
+  assert_equal a_message, configatron.warnings.last
+#end
+
+#it '050 support erb config files' do
+  unless configatron.config.nil?
+    configatron.config.each do |c|
+      case c.basename.extname.to_s.downcase
+        when '.erb'
+          file_type = c.basename.to_s.downcase.gsub('.erb','').split('.').last
+          case file_type
+            when 'ini'
+              # FIXME: ParseConfig gem has problem
+              refute Time == configatron.wall_clock.the_mouse_says.class
+            when 'txt'
+              # FIXME: ParseConfig gem has problem
+              refute Time == configatron.wrist.watch_time.class
+            when 'yml'
+              assert_equal Time, configatron.production.watch_time.class
+          else
+          end
+        when '.rb'
+          assert_equal 'devhost', configatron.development.host
+        when '.txt'
+          assert_equal 6, configatron.fingers.right_hand
+        when '.ini'
+          assert_equal 'wedding ring', configatron.hands.left_hand
+        when '.yml'
+          assert_equal 'go fish', configatron.production.threes
+          assert configatron.production.watch_time.nil?
+        when '.xyzzy'
+      else
+      end
+    end
+  else
+    # means test did not include config files
+  end
+#end
+
+
+
+
+
+#it '888 prints usage()'  do
+  puts
+  puts "="*45
+  show_usage
+  puts "="*45
+  puts
+  a_string = <<EOS
+This is my BANNER
+
+Usage: cli_helper_test.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
+
+
+a_string_with_config = <<EOS
+This is my BANNER
+
+Usage: cli_helper_test.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
+    --config       read config file(s) [*.rb, *.yml, *.ini]
+
+Do you need some HELP?
+EOS
+
+  if configatron.support_config_files
+    assert_equal a_string_with_config, usage
+  else
+    assert_equal a_string, usage
+  end
+#end
+
+#it '999 Show the options structure' do
+  puts '*'*45
+  ap configatron.to_h
+#end
+
+#end # decribe 'how it works'

data/tests/config/sample.ini

@@ -0,0 +1,6 @@
+[base2]
+\  three = 11
+
+[hands]
+  left_hand = 'wedding ring'
+

data/tests/config/sample.ini.erb

@@ -0,0 +1,9 @@
+[base2]
+\  three = 11
+
+[hands]
+  left_hand = 'wedding ring'
+
+[wall_clock]
+  the_mouse_says = <%= Time.now %>
+

data/tests/config/sample.rb

@@ -0,0 +1,15 @@
+
+configatron.test do |test|
+  test.host = 'localhost'
+  test.ip   = '127.0.0.1'
+end
+
+configatron.development do |dev|
+  dev.host = 'devhost'
+  dev.ip   = '127.0.0.1'
+end
+
+configatron.production do |prod|
+  prod.host = 'prodhost'
+  prod.ip   = '0.0.0.0'
+end

data/tests/config/sample.rb.erb

@@ -0,0 +1,20 @@
+
+configatron.test do |test|
+  test.host = 'localhost'
+  test.ip   = '127.0.0.1'
+end
+
+configatron.development do |dev|
+  dev.host = 'devhost'
+  dev.ip   = '127.0.0.1'
+end
+
+configatron.production do |prod|
+  prod.host = 'prodhost'
+  prod.ip   = '0.0.0.0'
+end
+
+if <%= true =>
+  puts "Why would you ever want ERB stuff in a ruby-based config file?"
+end
+

data/tests/config/sample.txt

@@ -0,0 +1,12 @@
+[base2]
+  zero = 0
+  one = 1
+  two = 10
+
+[fingers]
+  left_hand = 5
+  right_hand = 6
+
+[toes]
+  left_foot = 6
+  right_foot = 5

data/tests/config/sample.txt.erb

@@ -0,0 +1,16 @@
+[base2]
+  zero = 0
+  one = 1
+  two = 10
+
+[fingers]
+  left_hand = 5
+  right_hand = 6
+
+[toes]
+  left_foot = 6
+  right_foot = 5
+
+[wrist]
+  watch_time = <%= Time.now %>
+

data/tests/config/sample.xyzzy

@@ -0,0 +1 @@
+This is an unknown config file format

data/tests/config/sample.yml

@@ -0,0 +1,16 @@
+---
+test:
+  one: 1
+  two: 1
+  three: 11
+
+development:
+  one: 'one'
+  two: 'two'
+  three: 'three'
+
+production:
+  ones: 1111
+  tows: 2222
+  threes: 'go fish'
+

data/tests/config/sample.yml.erb

@@ -0,0 +1,17 @@
+---
+test:
+  one: 1
+  two: 1
+  three: 11
+
+development:
+  one: 'one'
+  two: 'two'
+  three: 'three'
+
+production:
+  ones: 1111
+  tows: 2222
+  threes: 'go fish'
+  watch_time: <%= Time.now %>
+

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cli_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-22 00:00:00.000000000 Z
+date: 2015-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: configatron
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nenv
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: parseconfig
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debug_me
+  name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +95,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: test_inline
+  name: kick_the_tires
+  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: awesome_print
+  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: debug_me
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,14 +136,12 @@ 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: "\n     An encapsulation of a convention I have been using\n     with
+  the slop, nenv, parseconfig and configatron gems for quick and dirty\n     development
+  of\n     command-line based utility programs.  Slop parses ARGV; Nenv parses ENV;\n
+  \    ParseConfig parses INI; Configatron keeps it all together.  YAML and ERB\n
+  \    preprocessing is also available.  Ruby configuration files are also supported.\n
+  \    and you can specify multiple config files of mixed types at once.\n  "
 email:
 - dvanhoozer@gmail.com
 executables: []
@@ -129,6 +155,17 @@ files:
 - cli_helper.gemspec
 - example/cli_stub.rb
 - lib/cli_helper.rb
+- tests/README.txt
+- tests/cli_helper_test.rb
+- tests/config/sample.ini
+- tests/config/sample.ini.erb
+- tests/config/sample.rb
+- tests/config/sample.rb.erb
+- tests/config/sample.txt
+- tests/config/sample.txt.erb
+- tests/config/sample.xyzzy
+- tests/config/sample.yml
+- tests/config/sample.yml.erb
 homepage: http://github.com/MadBomber/cli_helper
 licenses:
 - You want it?  It's yours.
@@ -153,5 +190,6 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: An encapsulates of common junk used with Q&D CLI utilities.
+summary: An encapsulation of an integration of slop, nenv, parseconfig and configatron.
 test_files: []
+has_rdoc: