optsparser_generator 4.0 → 4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5121915ca357fd8dfa3d8bfb7c292bc435e46fce
-  data.tar.gz: 218b5d132ab436ae1595b510f51e96d07d261ebf
+SHA256:
+  metadata.gz: 7002bd5bc1ed12354e14e4db3d4d7e0ded00d2b6984fa94f72095c5ede3676b9
+  data.tar.gz: 5cd3e2448f62f62c5f57db2f37ee1f6cdbc719281bd62262a81766592cd572ef
 SHA512:
-  metadata.gz: 2ee9faa906c0d85efc1f83f03ba58067869c17f3750bf268900724f57888fe4438b2c9a6c44c3ec24446cd8833e47ddb994aa47f21ed185cc2873fe6eefb55b1
-  data.tar.gz: e9835ec3a8e9a6fb1fcbad12b25b392b2968a6ef1a91198b76f89accf80343ef3d6a3055e6ee7098d824e605cfa0ca884f5796048095d27cd0bfba36be0af726
+  metadata.gz: 1a57ebea15a0b6c8f6af4d5aa3b64c24e67135c01d81f4a926c0b3084723f833792431b1c293132c7dfbae96e5e35fdad9150409f53e9028f282b09da09b4680
+  data.tar.gz: 72f91bfe36beec53a0cdc85c4514bc5893966d17fe5263361be287aad2038f148ca0b7cc91b35c23ce00fdcfcf8e009bd1bf5bbeed28fcdc15d0358458c18fd8

data/README.md

@@ -17,11 +17,12 @@ 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'
 os.test = "don't know"
-os.test_proc = Proc.new do |value|
+os.test__proc = Proc.new do |value|
 	puts value
 	"some-#{value}-conversion"
 end
@@ -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)
@@ -78,7 +81,7 @@ module OptionParserGenerator
           end
         else
           klass = val.class
-          klass = klass.equal?(Fixnum) ? Integer : klass
+          klass = val.is_a?(Integer) ? Integer : klass
           klass = defaults.special_value(key, 'class') || klass
           arguments.push klass
 
@@ -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]
@@ -141,16 +148,18 @@ module OptionParserGenerator
   # @api private
   module OptParsePatch
     # @return [OpenStruct]
-    def parse!(*params)
+    def parse!(*params, **opts)
       @out = @defaults.dup
       super
+      @required.reject{|k,v|v}.each{|k,v|raise OptionParser::MissingArgument, k}
       @out
     end
 
     # @return [OpenStruct]
-    def parse(*params)
+    def parse(*params, **opts)
       @out = @defaults.dup
       super
+      @required.reject{|k,v|v}.each{|k,v|raise OptionParser::MissingArgument, k}
       @out
     end
   end
@@ -162,14 +171,14 @@ module OptionParserGenerator
   # @see OptionParserGenerator#[]
   # @return [OpenStruct]
   def self.parse(ostruct, argv, **opt)
-    self[ostruct, opt].parse(argv)
+    self[ostruct, **opt].parse(argv)
   end
 
   # Same as parse, removes parsed elements from argv
   # @see OptionParserGenerator#parse
   # @return [OpenStruct]
   def self.parse!(ostruct, argv = ARGV, **opt)
-    self[ostruct, opt].parse!(argv)
+    self[ostruct, **opt].parse!(argv)
   end
 end
 # Object alias
@@ -184,7 +193,7 @@ OptParseGen = OptionParserGenerator
 # @return [OptionParser]
 # @see OptionParserGenerator
 def OptionParserGenerator(arg, **opt)
-  OptionParserGenerator[arg, opt]
+  OptionParserGenerator[arg, **opt]
 end
 alias OptParseGen OptionParserGenerator
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optsparser_generator
 version: !ruby/object:Gem::Version
-  version: '4.0'
+  version: '4.5'
 platform: ruby
 authors:
 - Marvin Zerulla
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-02 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.2.0
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.2.0
@@ -37,7 +37,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
   type: :development
@@ -47,21 +47,21 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   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
@@ -104,8 +104,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.8'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -119,7 +119,7 @@ homepage: https://github.com/madblobfish/optionparser-generator
 licenses:
 - AGPL-1.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,9 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Generates OptionParser using an OpenStruct
 test_files: []