optsparser_generator 4.4 → 4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a46c488e646d9dd044a7532ded2d73e30b039a33941641b2a7869cad28e747f7
-  data.tar.gz: 9aeeff83f3124af811a4e7ac07c36ce4d7482462d4bb1815dc5c2deddba52aac
+  metadata.gz: 7002bd5bc1ed12354e14e4db3d4d7e0ded00d2b6984fa94f72095c5ede3676b9
+  data.tar.gz: 5cd3e2448f62f62c5f57db2f37ee1f6cdbc719281bd62262a81766592cd572ef
 SHA512:
-  metadata.gz: f42a1fbf5276adc74bbf913d397e7d2365de057f6be342b651cdd08b7d87d8948dc5d8f401a9d7c3bf8628b267613a9b31368fb2f53b4e33fa1ef84604a420ba
-  data.tar.gz: 06f009faa14e5be34cf0069d03a58fd8e6682839e3c86c6432de5aa3aff0b9c44c7da074d36fac9d18bde9e40c37e2d2c4a625c184e07d7284232e2c4495aabc
+  metadata.gz: 1a57ebea15a0b6c8f6af4d5aa3b64c24e67135c01d81f4a926c0b3084723f833792431b1c293132c7dfbae96e5e35fdad9150409f53e9028f282b09da09b4680
+  data.tar.gz: 72f91bfe36beec53a0cdc85c4514bc5893966d17fe5263361be287aad2038f148ca0b7cc91b35c23ce00fdcfcf8e009bd1bf5bbeed28fcdc15d0358458c18fd8

data/README.md

@@ -17,6 +17,7 @@ os.default = 'value'
 os.val = 123
 os.val__values = [1, 1.5, 2, 123]
 os.val__class = Numeric
+os.val__required = true
 os.bool = true
 os.bool__help = 'description of argument'
 os.bool__short = 'b'
@@ -36,11 +37,12 @@ OptParseGen.parse(os) # takes ARGV or an array
 ```
 
 ## Special values
-* __help  	defines the description for a property
-* __values	defines possible values in an Array
-* __short 	defines the short trigger
-* __class 	defines the Class which OptionParser then tries to coerce to
-* __proc 	a Proc which will be executed to compute the value
+* __help  	  defines the description for a property
+* __values	  defines possible values in an Array
+* __short 	  defines the short trigger
+* __class 	  defines the Class which OptionParser then tries to coerce to
+* __proc 	  a Proc which will be executed to compute the value
+* __required  parameter is required, raises error if missing
 
 # Version numbers
 I choose two digit version numbers.

data/lib/optsparser_generator.rb

@@ -5,11 +5,12 @@ require 'optparse'
 module OptionParserGenerator
   # Special postfixes for Hash keys
   SPECIAL_POSTFIXES = [
+    '--class',
     '--help',
-    '--values',
+    '--proc',
+    '--required',
     '--short',
-    '--class',
-    '--proc'
+    '--values',
   ].freeze
 
   # Raised when not given an OpenStruct
@@ -26,6 +27,8 @@ module OptionParserGenerator
   # @api private
   module OpenStructExtension
     # extracts a special value from the openstruct
+    # @param key [String]
+    # @param string [String]
     def special_value(key, string)
       self["#{key}__#{string}"]
     end
@@ -36,6 +39,7 @@ module OptionParserGenerator
   # @todo preprocess data here instead of doing it adhoc
   # @todo raise more exceptions
   # @api private
+  # @param ostruct [OpenStruct]
   def self.handle_arguments(ostruct)
     unless ostruct.is_a?(OpenStruct)
       raise WrongArgumentType, 'needs an OpenStruct'
@@ -51,14 +55,13 @@ module OptionParserGenerator
   # @todo write documentation :(
   # @todo split this up
   # @param ostruct [OpenStruct] Default values with special values
-  # @param options [Hash]
-  # @option options [Boolean]
-  #   :ignore_collisions ignore bool key collisions see OptionCollision
-  #   :generate_no_help when set to true donesn't generates help command
+  # @param :ignore_collisions [Boolean] ignore bool key collisions see OptionCollision
+  # @param :generate_no_help [Boolean] when set to true donesn't generates help command
   def self.[](ostruct, **options)
     defaults = handle_arguments(ostruct)
 
     optparser = OptionParser.new do |opts|
+      opts.instance_variable_set(:@required, {})
       defaults.each_pair do |key, val|
         trigger = key.to_s.tr('_', '-')
         next if trigger.end_with?(*SPECIAL_POSTFIXES)
@@ -93,8 +96,12 @@ module OptionParserGenerator
           block = proc
         end
         opts.on(*arguments) do |arg|
+          opts.instance_variable_get(:@required)[key] = true
           opts.instance_variable_get(:@out)[key] = block.call(arg)
         end
+        if defaults.special_value(key, 'required')
+          opts.instance_variable_get(:@required)[key] = false
+        end
       end
 
       unless options[:generate_no_help]
@@ -144,6 +151,7 @@ module OptionParserGenerator
     def parse!(*params, **opts)
       @out = @defaults.dup
       super
+      @required.reject{|k,v|v}.each{|k,v|raise OptionParser::MissingArgument, k}
       @out
     end
 
@@ -151,6 +159,7 @@ module OptionParserGenerator
     def parse(*params, **opts)
       @out = @defaults.dup
       super
+      @required.reject{|k,v|v}.each{|k,v|raise OptionParser::MissingArgument, k}
       @out
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: optsparser_generator
 version: !ruby/object:Gem::Version
-  version: '4.4'
+  version: '4.5'
 platform: ruby
 authors:
 - Marvin Zerulla