optsparser_generator 1.1 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcbe1e73825ba5ba097c4bd260424f2eaf0fe286
-  data.tar.gz: b8595c9abc7ad0f13fa0c41c04f0845308a0262d
+  metadata.gz: df87ca8d12e02a00e201b6628060ae316a41220f
+  data.tar.gz: 53f174afb5cf8ce84600faf9a3407821d47a5a6a
 SHA512:
-  metadata.gz: 08e11abeebc8b5ffd471488fee1ea592b52b3f11552f36b398d1f45b0e59127751d1dd3be74bc611baab2c755e39537616dc501dcecfd48aaad1c3646e003669
-  data.tar.gz: 14871d9b25637519b5e629ee8268cf52dc58994e336c1e5104a5a9a0747cceb2064ae16553daafcb34473ac605b073f63816e7c0d7ec9be5498d234d9192f856
+  metadata.gz: 453d7de0e17a27958b62b81ff2c3fef1df0724c34c75659af8373646ef143ca4fa941b46d70058a1d8bfe16fc1ab230dc94fcc0959bef30144f92e361672567c
+  data.tar.gz: 70d896c1c08b9e7d5c2faca0ad57a18fe84fbe1d9f768ee44189da7748ad296ff95d61fcbc000bd0e61862dca257c80cfbed18f6a9a3f51f678e71a81cea1666

data/lib/optsparser_generator.rb

@@ -1,27 +1,60 @@
 require 'ostruct'
 require 'optparse'
 
-class OptParseGenerator
-  def initialize(ostruct)
-    @defaults = ostruct.dup.freeze
+# Small lib for generating an OptionParser from an OpenStruct
+module OptionParserGenerator
+  # raised when not given an OpenStruct
+  class WrongArgumentType < ArgumentError
+  end
+  # raised when there are two boolean entries in the OpenStruct
+  # one named no_xyz and one xyz
+  # only raised when the option :ignore_collisions is not given
+  class OptionCollision < ArgumentError
+  end
+
+  # @todo preprocess data here instead of doing it adhoc
+  # @todo raise more exceptions
+  # @api private
+  def self.handle_arguments(ostruct)
+    unless ostruct.is_a?(OpenStruct)
+      raise WrongArgumentType, 'needs an OpenStruct'
+    end
+    ostruct.dup.freeze
+  end
+
+  # does the magic
+  #
+  # @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
+  def self.[](ostruct, **options)
+    defaults = handle_arguments(ostruct)
 
-    @optparser = OptionParser.new do |opts|
-      @defaults.each_pair do |key, val|
+    optparser = OptionParser.new do |opts|
+      defaults.each_pair do |key, val|
         trigger = key.to_s.tr('_', '-')
-        next if trigger.end_with?('--help', '--values', '--short')
-        trigger[0..2] = '' if trigger.start_with?('no-')
+        next if trigger.end_with?('--help', '--values', '--short', '--class')
 
-        help = @defaults[key.to_s << '__help'] || ''
-        help << " (Default: #{val})"
-        values = @defaults[key.to_s << '__values'] || []
-        short = @defaults[key.to_s << '__short'] || ''
+        help = "#{defaults[key.to_s << '__help']} (Default: #{val})"
+        values = defaults[key.to_s << '__values'] || []
+        short = defaults[key.to_s << '__short'] || ''
         arguments = []
-        arguments << help
-        arguments << short unless short.empty?
-        case val
+        arguments << help unless help.empty?
+        arguments << "-#{short}" unless short.empty?
+        case defaults[key.to_s << '__class'] || val
         when FalseClass, TrueClass
+          if trigger.start_with?('no-')
+            trigger[0..2] = ''
+            if defaults.each_pair.map { |v| v.first.to_s }.include?(trigger)
+              raise OptionCollision, "on #{trigger}" unless options[:ignore_collisions]
+              next
+            end
+          end
           opts.on("--[no-]#{trigger}", *arguments) do |b|
-            @out[key] =
+            out = opts.instance_variable_get(:@out)
+            out[key] =
               if key.to_s.start_with?('no_')
                 !b
               else
@@ -29,57 +62,50 @@ class OptParseGenerator
               end
           end
         else
-          arguments << val.class
+          arguments << defaults[key.to_s << '__class'] || val.class
           arguments << values if values.any?
-          opts.on("--#{trigger}=ARGUMENT", *arguments) do |str|
-            @out[key] = str
+          opts.on("--#{trigger}=ARG", *arguments) do |str|
+            out = opts.instance_variable_get(:@out)
+            out[key] = str
           end
         end
       end
+
       opts.on('-h', '--help') do
         puts opts
         exit
       end
     end
-  end
 
-  def parse!(params)
-    @out = @defaults.dup
-    @optparser.parse!(params)
-    @out
+    # add default values
+    optparser.instance_variable_set(:@defaults, defaults)
+    optparser.extend(OptParsePatch)
+    optparser
   end
 
-  def method_missing(method_sym, *arguments, &block)
-    # TODO: try to copy the methods into this class
-    # instead of method_missing hack them
-    if @optparser.respond_to?(method_sym)
-      @optparser.method(method_sym).call(*arguments, &block)
+  ## patch for OptionParser redefines parse and parse!
+  # @api private
+  module OptParsePatch
+    # @return [OpenStruct]
+    def parse!(*params)
+      @out = @defaults.dup
+      super
+      @out
     end
-  end
 
-  def respond_to?(method_sym, include_private = false)
-    @optparser.respond_to?(method_sym, include_private) || super
+    # @return [OpenStruct]
+    def parse(*params)
+      @out = @defaults.dup
+      super
+      @out
+    end
   end
 end
-
-# tests
-# require 'optsparser_generator'
-# options = OpenStruct.new
-# options.no_filter = false
-# options.no_filter__help = 'bla bla helP!'
-# options.no_filter__short = 'f'
-# options.subsitute_new = true
-# options.log = 'pa/th'
-# options.some_option = 'pa/th'
-# options.some_option__help = 'help text'
-# options.some_option__values = %w(possible values for some option)
-# options.fix_method_names_with_known_ones = true
-
-# optparser = OptParseGenerator.new(options)
-# raise 'broken' unless optparser.respond_to? :to_s
-# raise 'broken' if optparser.respond_to? :notthere
-
-# puts optparser.parse!(['--no-filter']).inspect
-# puts optparser.parse!(['--log=other/path']).inspect
-# optparser.parse!(['--help'])
-# raise 'Error: --help did not quit'
+# global shorthand
+# alias to OptionParserGenerator[arg, opt]
+# @return [OptionParser]
+# @see OptionParserGenerator
+def OptionParserGenerator(arg, **opt)
+  OptionParserGenerator[arg, opt]
+end
+alias OptParseGen OptionParserGenerator

metadata

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