cli_helper 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c26800bd031cdd8dc5cb7e27d0772377797a2a19
-  data.tar.gz: bcc1dbb15015453061e049813c8d050b521919bc
+  metadata.gz: 970583c4a48a1bf449f0175963d74582823ee95f
+  data.tar.gz: c01c2f4fe14edc456ff6693434a725419b0f9e0d
 SHA512:
-  metadata.gz: 5e6ed5a90d9aea36b026a68603facfb02117724fb585c711eaf46d2b092e8914302b23bcb5d7891d35560c011813f0d350791487556fc92b739cf5b5ebb76c2f
-  data.tar.gz: ae39b8892ef01b65d529cd852ac1fc5e5a24903a14008ffcc95edd6b110160c95eea4454409b4abf3970c545eda08d12bfdc145d910bf4075cd0e85186d823e2
+  metadata.gz: 9ca124bb2d25a1f8b11c6fc250542926ffa7e772fb1c6462865feee930bc9241016354bf49909a8e5c9aead7aea79fb38512c718e7ba9633d9a0e97df4ac54d2
+  data.tar.gz: acbbd43bbc7653fe5a0850b2fcc55c3be75cd7b888a2b4a9990cb1c8f82ace6dc1b71b9a18422a21d9791ffec204194dd9d00af08c3071943dcea89a2382f39c

data/README.md

@@ -2,6 +2,11 @@
 
 ## Most recent changes
 
+### 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

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.2'
+  spec.version       = '0.1.3'
   spec.authors       = ["Dewayne VanHoozer"]
   spec.email         = ["dvanhoozer@gmail.com"]
 

data/example/cli_stub.rb

@@ -9,10 +9,10 @@
 
 require 'awesome_print'
 
-require 'cli_helper'
+require '../lib/cli_helper'
 include CliHelper
 
-configatron.version = '0.0.1' # the version of this utility program
+configatron.version = '0.0.2' # the version of this utility program
 configatron.enable_config_files = true # default is false
 configatron.disable_help    = false # default is false set true to remove the option
 configatron.disable_verbose = false # ditto
@@ -20,6 +20,23 @@ configatron.disable_debug   = false # ditto
 configatron.disable_version = false # ditto
 configatron.suppress_errors = false # set to true to eat exceptions; unknown options added to arguments
 
+
+# Sometimes you may have a few default config files that you
+# want to apply before the command-line options.  Do it like
+# something like this:
+%w[
+  ../tests/config/sample.yml
+  ../tests/config/sample.yml.erb
+].each do |dcf|
+  cli_helper_process_config_file(dcf)
+end
+
+# OR just pass a directory and all of the config files in the
+# directory will be processed:
+
+cli_helper_process_config_file('../tests/config')
+
+
 # HELP is extra stuff shown with usage.  It is optional.  You
 # can put anything you want into it.  Since it is optional, it
 # can be completely left out of your program.  This HELP text

data/lib/cli_helper.rb

@@ -108,6 +108,66 @@ module CliHelper
     return an_ini_object.to_h
   end
 
+  def cli_helper_process_config_file(a_cf)
+    cf = String == a_cf.class ? Pathname.new(a_cf) : a_cf
+    if cf.directory?
+      cf.children.each do |ccf|
+        cli_helper_process_config_file(ccf)
+      end
+      return
+    end
+    unless cf.exist?
+      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
+            warning 'MakesNoSenseToMe: *.rb.erb is not supported'
+            :unknown
+          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(
+                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 # def cli_helper_process_config_file(cf)
+
+
   # Invoke Slop with common CLI parameters and custom
   # parameters provided via a block.  Create '?'
   # for all boolean parameters that have a '--name' flag form.
@@ -157,64 +217,19 @@ module CliHelper
     yield(param) if block_given?
 
     if configatron.enable_config_files
-      param.paths '--config',    'read config file(s) [*.rb, *.yml, *.ini]'
+      param.paths '--config',    'read config file(s) [*.rb, *.yml, *.ini, *.erb]'
     end
 
     parser = Slop::Parser.new(param, suppress_errors: configatron.suppress_errors)
     configatron.cli = parser.parse(ARGV)
 
-    # TODO: DRY this conditional block
+    # NOTE: The config files are being process before the
+    #       command line options in order for the command
+    #       line options to over-write the values from the
+    #       config files.
     if configatron.enable_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(
-                    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?
+        cli_helper_process_config_file(cf)
       end # configatron.cli.config.each do |cf|
     end # if configatron.enable_config_files
 

data/tests/cli_helper_test.rb

@@ -203,7 +203,7 @@ Where:
 
   Program Options Are:
     -x, --xyxxy    example MAGIC parameter
-    --config       read config file(s) [*.rb, *.yml, *.ini]
+    --config       read config file(s) [*.rb, *.yml, *.ini, *.erb]
 
 Do you need some HELP?
 EOS

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-29 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configatron
@@ -201,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: An encapsulation of an integration of slop, nenv, inifile and configatron.