options_by_example 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f146461611879c6934270f692e97391830d93f634b9300f7fa2883195bc0a22
-  data.tar.gz: 19ad57569defbb334404085af3248675cfa84000511bbf49b2803b5c6cb38dee
+  metadata.gz: 59f737886cd6b035ebefb01b6d513d6a4cd66957858d9c3f9d4b489058fe5725
+  data.tar.gz: d3f6f2d559a4f5c077f878dec4e8fb8c8f9cf9e4daaeebaba8b5611f343ac86b
 SHA512:
-  metadata.gz: 01146df8d0c06df84d2c093d0493219d6bd9d78ab5174f089b6b13b79b5fbb355ebd16f8bd5e3b65358670b44f6479e032e8967e57df52935328e5f151bfb4a1
-  data.tar.gz: fbfe47bf367329b63e3661c28b964118c9dd47e013dabcfabdf6ceae9bdad3a2af9cd0998a852d5e3ede7a22b07146d64ae85fb61727aac54e1ced139075f918
+  metadata.gz: ad0b05e43b8ec21c9bbc434085896082fe0a956190d255c5ef24382f3f0ec8faf5f05b32f3acda272ca8d0fbbb63e736d9a5db4860e6bd750be26f7601a263c6
+  data.tar.gz: e2008e435bbfc129170599f7e28626ede57501b078e65684c436fea0644d69b8a564c388da1bd197a60332c4c34404d60424541dd9912307c0b2316ad069a811

data/README.md

@@ -16,8 +16,8 @@ require %(options_by_example)
 
 flags = OptionsByExample.read(DATA).parse(ARGV)
 
-puts 'Feeling verbose today' if flags.include?(:verbose)
-puts flags.get(:words).sample(flags.get(:num))
+puts 'Feeling verbose today' if flags.include_verbose?
+puts flags.get_words.sample(flags.get_num)
 
 __END__
 Choose at random from a list of provided words.

data/lib/options_by_example/commandline_parser.rb

@@ -46,7 +46,7 @@ class OptionsByExample
 
     def treat_everything_after_double_dash_as_positionals
       index = @slices.index { |head,| head == '--' }
-      @slices[index..] = [@slices.drop(index).flatten] if index
+      @slices[index..-1] = [@slices.drop(index).flatten] if index
     end
 
     def exit_if_help_option
@@ -120,15 +120,32 @@ class OptionsByExample
         end
 
         option = current.shift # consume the option/flag
-        option_name, has_argument, _ = @option_names[option]
+        option_name, argument_arity, _, _ = @option_names[option]
         @option_values[option_name] = true
 
-        if has_argument
+        if argument_arity == :required
           raise "Expected argument for option '#{option}', got none" unless current.first
-          @argument_values[option_name] = current.shift # consume the argument
-          @option_took_argument = option
-        else
-          @option_took_argument = nil
+
+          if pending.length == 1
+            minimum_count = count_arguments(:required) + count_arguments(:vararg)
+            if current.length <= minimum_count
+              raise "Ambiguous argument for option '#{option}', not enough remaining positional arguments"
+            end
+          end
+
+          @argument_values[option_name] = current.shift
+        elsif argument_arity == :optional && current.first
+          if pending.length == 1
+            required_count = count_arguments(:required)
+            if current.length <= required_count and required_count == @argument_names.length
+              return current
+            end
+            if current.length <= required_count or required_count != @argument_names.length
+              raise "Ambiguous argument for option '#{option}', please use -- before positional arguments"
+            end
+          end
+
+          @argument_values[option_name] = current.shift
         end
 
         pending.shift if current.empty?
@@ -138,12 +155,12 @@ class OptionsByExample
     end
 
     def coerce_num_date_time_etc
-      @option_names.each do |option, (each, argument_name, default_value)|
+      @option_names.each do |option, (each, _, argument_type, default_value)|
         value = @argument_values.fetch(each, default_value)
         next unless value
 
         begin
-          case argument_name
+          case argument_type
           when 'NUM'
             expected_type = 'an integer value'
             value = Integer value
@@ -197,10 +214,6 @@ class OptionsByExample
         # :nocov:
         end
 
-        if @option_took_argument
-          msg += " (considering #{@option_took_argument} takes an argument)"
-        end
-
         raise msg
       end
     end

data/lib/options_by_example/usage_specification.rb

@@ -23,7 +23,7 @@ class OptionsByExample
 
       usage_line = text.lines.grep(/Usage:/).first
       raise "Expected usage string, got none" unless usage_line
-      tokens = usage_line.scan(/\[.*?\]|\w+ \.\.\.|\S+/)
+      tokens = usage_line.split(/(\[.*?\]?\]|\w+ \.\.\.)|\s+/).reject(&:empty?)
       raise "Expected usage line to start with 'Usage:'" unless tokens.shift == 'Usage:'
       raise "Expected command name on same line as 'Usage:'" unless tokens.shift
       tokens.shift if tokens.first == '[options]'
@@ -74,30 +74,42 @@ class OptionsByExample
 
       options = inline_options + text.lines.grep(/^\s*--?\w/)
       options.each do |string|
-        tokens = string.scan(/--?\w[\w-]*(?: \w+)?|,|\(default \S+\)|\S+/)
+        tokens = string.strip.split(/(\s+)|(,)\s*/)
 
         short_form = nil
         long_form = nil
         option_name = nil
-        argument_name = nil
+        argument_arity = nil
+        argument_type = nil
         default_value = nil
 
-        if /^-(\w)( \w+)?$/ === tokens.first
-          short_form, argument_name = tokens.shift.split
+        if /^-(\w)$/ === tokens.first
+          short_form = tokens.shift
           option_name = sanitize $1
-          tokens.shift if ',' === tokens.first
+          tokens.shift if tokens.first == ','
         end
 
-        if /^--([\w-]+)( \w+)?$/ === tokens.first
-          long_form, argument_name = tokens.shift.split
+        if /^--([\w-]+)$/ === tokens.first
+          long_form = tokens.shift
           option_name = sanitize $1
         end
 
-        if /^\(default (\S+)\)$/ === tokens.last
+        if tokens.shift == ' '
+          if /^(\[(.+)\]|(.+)\?)$/ === tokens.first
+            argument_type = $2 || $3
+            argument_arity = :optional
+            tokens.shift
+          else
+            argument_type = tokens.shift
+            argument_arity = :required
+          end
+        end
+
+        if /\(default\s+(\S+)\)$/ === tokens.join
           default_value = $1
         end
 
-        ary = [option_name, argument_name, default_value]
+        ary = [option_name, argument_arity, argument_type, default_value]
         [short_form, long_form].each do |each|
           @option_names[each] = ary if each
         end

data/lib/options_by_example/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class OptionsByExample
-  VERSION = '4.1.0'
+  VERSION = '4.2.0'
 end
 
 
@@ -11,6 +11,14 @@ __END__
 # Minor version bump when backward-compatible changes or enhancements
 # Patch version bump when backward-compatible bug fixes, security updates etc
 
+4.2.0
+  - Generate #get_NAME methods for arguments
+  - Keep #argument_NAME as backwards-compatible aliases
+  - New method #get_at_most_one returns the provided option or nil
+  - New method #get_mutually_exclusive aliases #get_at_most_one
+  - Deprecate #expect_at_most_one_of in favor of #expect_at_most_one
+  - Support optional option arguments, eg '--compress [NUM]'
+
 4.1.0
   - Treat everything after double-dash as positional arguments
   - Improve error message when usage is split across lines

data/lib/options_by_example.rb

@@ -32,16 +32,24 @@ class OptionsByExample
   end
 
   def expect_at_most_one_except(*extra_options)
-    expect_at_most_one_of *(@options.keys - extra_options)
+    expect_at_most_one *(@options.keys - extra_options)
   end
 
   def expect_at_most_one_of(*mutually_exclusive_options)
+    expect_at_most_one *mutually_exclusive_options
+  end
+
+  def get_at_most_one(*mutually_exclusive_options)
     provided_options = @options.keys & mutually_exclusive_options
     if provided_options.length > 1
       abort "ERR: Found more than one mutually-exclusive option {#{provided_options.join ', '}}"
     end
+    provided_options.first
   end
 
+  alias expect_at_most_one get_at_most_one
+  alias get_mutually_exclusive get_at_most_one
+
   def fetch(*args, &block)
     @arguments.fetch(*args, &block)
   end
@@ -77,14 +85,16 @@ class OptionsByExample
     [
       *@usage_spec.argument_names.keys,
       *@usage_spec.option_names.values
-        .map { |option_name, has_argument| option_name if has_argument }
+        .map { |option_name, argument_arity| option_name if argument_arity }
         .compact,
     ].each do |argument_name|
       instance_eval %{
-        def argument_#{argument_name}
+        def get_#{argument_name}
           val = @arguments[:#{argument_name}]
           val && block_given? ? (yield val) : val
         end
+
+        alias argument_#{argument_name} get_#{argument_name}
       }
     end
   end
@@ -99,4 +109,3 @@ class OptionsByExample
     end
   end
 end
-

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: options_by_example
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Adrian Kuhn
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-04-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: 
 email:
 - akuhn@iam.unibe.ch
 executables: []
@@ -29,7 +27,6 @@ metadata:
   homepage_uri: https://github.com/akuhn/options_by_example
   source_code_uri: https://github.com/akuhn/options_by_example
   changelog_uri: https://github.com/akuhn/options_by_example/blob/master/lib/options_by_example/version.rb
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -44,8 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: No-code options parser that extracts arguments directly from usage text.
 test_files: []