consoleappsupport 0.5.1 → 0.6.1

data/History.txt

@@ -11,3 +11,17 @@
   * Automatically loads a Logr4 config file, if config option "--log4r-file" is
     defined and enabled.
   * Displays RDoc usage message if config option "--help" is defined and enabled.
+
+=== 0.5.1 / 2009-06-11
+
+* Minor bug fixes and documentation
+
+  * Renamed LICENSE.txt to License.txt
+  * Fixed gem dependencies in Rakefile.
+  * Moved location of 'require' statements in Mixin module 
+
+=== 0.6.0 / 2009-06-29
+
+* Minor feature enhancements
+  
+  * Added ability to specify an app option as 'required'

data/examples/console_app_example.rb

@@ -14,7 +14,7 @@
 #   console_app_example.rb [options] argument1 arg2 etc...
 #
 # == Options (all options can be put into the config file)
-#   -n, --repeat-output [INTEGER]   Number of times to echo back the arguments. default = 1
+#   -n, --repeat-output [INTEGER]   Number of times to echo back the arguments. Required.
 #   -c, --config-file [FILE]        Use config file [FILE]. default = console_app_example.conf 
 #   -l, --log-level [LEVEL]   Sets Log4r level for console output. default = INFO
 #   -r, --log4r-file [FILE]   Optional Log4r config file. default = example_log4r.xml

data/examples/convert_logs_to_csv.rb

@@ -14,7 +14,7 @@
 #   cat [log files] | convert_logs_to_csv.rb [options] > [output file.csv]
 #
 # == Options (all options can be put into the config file)
-#   -p, --log-pattern [REGEX]   Regular expression for matching log lines.
+#   -p, --log-pattern [REGEX]   Regular expression for matching log lines. REQUIRED
 #   -f, --log-fields [LIST]     A list of field names to assign to the parenthesized log-pattern matches.
 #   -c, --config-file [FILE]    Use config file [FILE], default = apache_log_to_csv.conf 
 #   -l, --log-level [LEVEL]     Sets log level to DEBUG, INFO, WARN, ERROR or FATAL. default = INFO

data/lib/ConsoleAppHelper.rb

@@ -20,7 +20,7 @@
 #   * Call helper.read_configuration_files at any time to reload the appliation and
 #     Log4r configuration files.
 
-require "#{File.dirname(__FILE__)}/../lib/ConsoleAppMixin.rb"
+require "#{File.dirname(__FILE__)}/../lib/consoleappmixin.rb"
     
 module ConsoleAppSupport
   class ConsoleAppHelper

data/lib/ConsoleAppMixin.rb

@@ -56,6 +56,8 @@ module ConsoleAppSupport
     OPTION_VALUE_EXPRESSION = %r{^\s*\[(\w+)\]}
     # Regexp used to determine the default value of each application option
     DEFAULT_VALUE_EXPRESSION = %r{default[^=]*=\s*(.*\S)\s*$}i
+    # Regexp used to determine if application option is required
+    REQUIRED_VALUE_EXPRESSION = %r{required}i
 
     # Predefined names for application options
     # that trigger this module's specialized behavior:
@@ -85,6 +87,7 @@ module ConsoleAppSupport
       setup_default_options
       parse_command_line
       read_configuration_files unless skip_config
+      verify_required_options
     end
 
     # Reads the application config file for configuration options, then
@@ -128,6 +131,8 @@ module ConsoleAppSupport
             if (DEFAULT_VALUE_EXPRESSION.match description) then
               @log.debug "This parameter defaults to '#{$1}'"
               new_app_option[:default] = convert_string($1, new_app_option[:type])
+            elsif (REQUIRED_VALUE_EXPRESSION.match description) then
+               new_app_option[:required] = true
             end
           end
           @_app_options[param] = new_app_option
@@ -274,6 +279,18 @@ module ConsoleAppSupport
       end
     end
     
+    def verify_required_options
+      @_app_options.each do |option, option_parameters|
+        if (not @opts.has_key? option.gsub('-','_').intern) then
+          if option_parameters.has_key? :required then
+            flag = option_parameters[:switch]
+            @log.fatal "Application option '#{option}' (-#{flag}) is required."
+            output_help
+          end
+        end
+      end
+    end
+    
     #########################################################
     # Utility methods
 

data/lib/ConsoleAppSupport.rb

@@ -6,7 +6,7 @@
 #   See that module's documentation for usage.
 
 module ConsoleAppSupport
-  VERSION = '0.5.1'
+  VERSION = '0.6.1'
 end
 
-require "#{File.dirname(__FILE__)}/ConsoleAppHelper.rb"
+require "#{File.dirname(__FILE__)}/consoleapphelper.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: consoleappsupport
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.6.1
 platform: ruby
 authors: 
 - benton
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-11 00:00:00 -04:00
+date: 2009-10-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.0
+        version: 2.3.3
     version: 
 description: |-
   The ConsoleAppSupport module provides some commonly-desired behavior
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: consolesupport
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: "The ConsoleAppSupport module provides some commonly-desired behavior for command-line programs: currently command-line parsing; config file   loading; and log4r integration"