optsparser_generator 2.6 → 4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0dc1cb64554d69901c4cd9a2e70495f188c9f486
-  data.tar.gz: 44b4d8c5c8d5999edf292ce4ddfdc8971b757361
+SHA256:
+  metadata.gz: a46c488e646d9dd044a7532ded2d73e30b039a33941641b2a7869cad28e747f7
+  data.tar.gz: 9aeeff83f3124af811a4e7ac07c36ce4d7482462d4bb1815dc5c2deddba52aac
 SHA512:
-  metadata.gz: 9a0ea186c5015ec27fc9101bad09a1f4cde26935258ece98bedc75cd00f3996da57f23641defe5066e5c2f9b33937a115d3fe66be7cfcc03e4c65b0e9c51a693
-  data.tar.gz: 4d488ecf57e3e7fadf6739f836942b2a8b781dea76a37be36270523ab81ee1bca9401699d327e56feb6071953e58f330968a4c862deb67c80244732a15d6625d
+  metadata.gz: f42a1fbf5276adc74bbf913d397e7d2365de057f6be342b651cdd08b7d87d8948dc5d8f401a9d7c3bf8628b267613a9b31368fb2f53b4e33fa1ef84604a420ba
+  data.tar.gz: 06f009faa14e5be34cf0069d03a58fd8e6682839e3c86c6432de5aa3aff0b9c44c7da074d36fac9d18bde9e40c37e2d2c4a625c184e07d7284232e2c4495aabc

data/README.md

@@ -1,6 +1,7 @@
 # OptionParser Generator
-[![Inline docs](http://inch-ci.org/github/madblobfish/optionparser-generator.svg?branch=master)](http://inch-ci.org/github/madblobfish/optionparser-generator)
 [![Build Status](https://travis-ci.org/madblobfish/optionparser-generator.svg?branch=master)](https://travis-ci.org/madblobfish/optionparser-generator)
+[![Dependency Status](https://gemnasium.com/badges/github.com/madblobfish/optionparser-generator.svg)](https://gemnasium.com/github.com/madblobfish/optionparser-generator)
+[![Inline docs](http://inch-ci.org/github/madblobfish/optionparser-generator.svg?branch=master)](http://inch-ci.org/github/madblobfish/optionparser-generator)
 
 Small gem which generates an OptionParser object from an OpenStruct.
 
@@ -10,7 +11,7 @@ Small gem which generates an OptionParser object from an OpenStruct.
 # Usage
 ```ruby
 require 'optsparser_generator'
-# step one define OpenStruct with default values
+# step one define OpenStruct with default and special values
 os = OpenStruct.new
 os.default = 'value'
 os.val = 123
@@ -19,11 +20,19 @@ os.val__class = Numeric
 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|
+	puts value
+	"some-#{value}-conversion"
+end
 os.freeze
 
 # step two generate OptionParser
 opt_parser = OptParseGen(os)
 opt_parser = OptionParserGenerator(os)
+opt_parser.parse!(ARGV)
+# or parse options directly
+OptParseGen.parse(os) # takes ARGV or an array
 ```
 
 ## Special values
@@ -31,11 +40,11 @@ opt_parser = OptionParserGenerator(os)
 * __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
 
 # Version numbers
 I choose two digit version numbers.
 The first digit indicates breaking changes.
 Second digit increases per release.
 
-
 Enjoy

data/lib/optsparser_generator.rb

@@ -3,6 +3,15 @@ require 'optparse'
 
 # Small lib for generating an OptionParser from an OpenStruct
 module OptionParserGenerator
+  # Special postfixes for Hash keys
+  SPECIAL_POSTFIXES = [
+    '--help',
+    '--values',
+    '--short',
+    '--class',
+    '--proc'
+  ].freeze
+
   # Raised when not given an OpenStruct
   class WrongArgumentType < ArgumentError
   end
@@ -13,6 +22,16 @@ module OptionParserGenerator
   class OptionCollision < ArgumentError
   end
 
+  # utility methods
+  # @api private
+  module OpenStructExtension
+    # extracts a special value from the openstruct
+    def special_value(key, string)
+      self["#{key}__#{string}"]
+    end
+  end
+  private_constant :OpenStructExtension
+
   # Does some sanity checks and prepares the OpenStruct
   # @todo preprocess data here instead of doing it adhoc
   # @todo raise more exceptions
@@ -21,8 +40,11 @@ module OptionParserGenerator
     unless ostruct.is_a?(OpenStruct)
       raise WrongArgumentType, 'needs an OpenStruct'
     end
-    ostruct.dup.freeze # not needed but makes development easier
+    ostruct = ostruct.dup
+    ostruct.extend(OpenStructExtension)
+    ostruct.freeze # freeze is not needed but makes development easier
   end
+  private_class_method :handle_arguments
 
   # Does the magic
   #
@@ -30,92 +52,124 @@ module OptionParserGenerator
   # @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
+  # @option options [Boolean]
+  #   :ignore_collisions ignore bool key collisions see OptionCollision
+  #   :generate_no_help when set to true donesn't generates help command
   def self.[](ostruct, **options)
     defaults = handle_arguments(ostruct)
 
     optparser = OptionParser.new do |opts|
       defaults.each_pair do |key, val|
         trigger = key.to_s.tr('_', '-')
-        next if trigger.end_with?('--help', '--values', '--short', '--class')
-
-        help = "#{defaults["#{key}__help"]} (Default: #{val})"
-        values = defaults["#{key}__values"] || []
-        short = defaults["#{key}__short"] || ''
-        arguments = []
-        arguments << help
-        arguments << "-#{short}" unless short.empty?
+        next if trigger.end_with?(*SPECIAL_POSTFIXES)
+
+        arguments = generate_arguments(defaults, key, val)
         case val
         when FalseClass, TrueClass
+          uneven_no = /\Ano(-no-no)*-(?!no)/ =~ trigger
           if trigger.start_with?('no-')
-            trigger[0..2] = ''
-            if defaults.each_pair.map { |v| v.first.to_s }.include?(trigger) && !options[:ignore_collisions]
-              raise OptionCollision, "on #{key}"
-            end
+            trigger.gsub!(/\A(no-)+/, '') # removes no- prefixes
+            check_collisions(trigger, key, defaults) unless options[:ignore_collisions]
           end
-          opts.on("--[no-]#{trigger}", *arguments) do |b|
-            out = opts.instance_variable_get(:@out)
-            out[key] =
-              if key.to_s.start_with?('no_')
-                !b
-              else
-                b
-              end
+          arguments.unshift "--[no-]#{trigger}"
+          block = lambda do |bool|
+            # inverted when it starts with no_
+            bool ^ uneven_no
           end
         else
-          arguments.push defaults["#{key}__class"] || (val.class.equal?(Fixnum) ? Integer : val.class)
-          arguments << values if values.any?
-          opts.on("--#{trigger}=ARG", *arguments) do |str|
-            out = opts.instance_variable_get(:@out)
-            out[key] = str
+          klass = val.class
+          klass = val.is_a?(Integer) ? Integer : klass
+          klass = defaults.special_value(key, 'class') || klass
+          arguments.push klass
+
+          values = defaults.special_value(key, 'values')
+          arguments.push values if values
+          arguments.unshift "--#{trigger}=ARG"
+          block = lambda do |str|
+            str
           end
         end
+        if (proc = defaults.special_value(key, 'proc'))
+          block = proc
+        end
+        opts.on(*arguments) do |arg|
+          opts.instance_variable_get(:@out)[key] = block.call(arg)
+        end
       end
 
-      opts.on('-h', '--help') do
-        puts opts
-        exit
+      unless options[:generate_no_help]
+        opts.on('-h', '--help') do
+          puts opts
+          exit
+        end
       end
     end
 
     # add default values
     optparser.instance_variable_set(:@defaults, defaults)
     optparser.extend(OptParsePatch)
-    optparser
   end
 
+  # returns an array of helptext and
+  # if set the short version of trigger
+  # @api private
+  def self.generate_arguments(defaults, key, val)
+    short = defaults.special_value(key, 'short') || ''
+    if short.length > 1
+      raise ArgumentError, 'short is too long, it has to be only one character'
+    end
+
+    help = "#{defaults.special_value(key, 'help')} (Default: #{val})"
+
+    if short.empty?
+      [help]
+    else
+      [help, "-#{short}"]
+    end
+  end
+  private_class_method :generate_arguments
+
+  # @api private
+  def self.check_collisions(trigger, key, defaults)
+    if defaults.each_pair.map{ |v| v.first.to_s }.include?(trigger)
+      raise OptionCollision, "on #{key}"
+    end
+  end
+  private_class_method :check_collisions
+
   # patch for OptionParser redefines parse and parse!
   # @api private
   module OptParsePatch
     # @return [OpenStruct]
-    def parse!(*params)
+    def parse!(*params, **opts)
       @out = @defaults.dup
       super
       @out
     end
 
     # @return [OpenStruct]
-    def parse(*params)
+    def parse(*params, **opts)
       @out = @defaults.dup
       super
       @out
     end
   end
+  private_constant :OptParsePatch
 
   # Shorthand when parsing is only needed once.
   #
   # Generates an OptionParser and calls parse on it
   # @see OptionParserGenerator#[]
   # @return [OpenStruct]
-  def self.parse(ostruct, argv = nil, **opt)
-    self[ostruct, opt].parse(argv)
+  def self.parse(ostruct, argv, **opt)
+    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
@@ -130,7 +184,7 @@ OptParseGen = OptionParserGenerator
 # @return [OptionParser]
 # @see OptionParserGenerator
 def OptionParserGenerator(arg, **opt)
-  OptionParserGenerator[arg, opt]
+  OptionParserGenerator[arg, **opt]
 end
 alias OptParseGen OptionParserGenerator
 

metadata

@@ -1,87 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: optsparser_generator
 version: !ruby/object:Gem::Version
-  version: '2.6'
+  version: '4.4'
 platform: ruby
 authors:
 - Marvin Zerulla
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-26 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 11.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 11.2.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.2.0
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.2.0
-description: 
-email: 
+        version: '0.8'
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -95,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
@@ -110,9 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Generates OptionParser using an OpenStruct
 test_files: []