options_by_example 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98c16609314706667d2b776fa71de92ca874b2fcc803ea8f80387fe4f0245d9a
-  data.tar.gz: 8cc7023f98016edaa5521d6184985fb4133135e902f0380f81e233b6f52bfb97
+  metadata.gz: b5533bd626a90e56af73f7fe32cbd2c0a79630da399242c98abce184ac084dd9
+  data.tar.gz: 4583a92414c1e10544ffb42b4e45da0d1c0eac1adc1d38748bd31e24e791337e
 SHA512:
-  metadata.gz: a4e54eeb9f5beef88733ac4c70055570eeff930ccacd287f88b80905bd1760b6b1ec3513c5ea144d1c7cdc259af7d4991f81c5be82249cecb2f939d291d29032
-  data.tar.gz: 9126c11cba93c504fd41939dfa24c62578889b8546b9f472091a9463eed4cc6e3f409ff7e40a8219ce9a70913ae63872486745629431290e8f87dec6edf351be
+  metadata.gz: cd7df1507d066462d1031d71dc054fa886764dddca9fe17b4d6f7310f9e17f75673a6a6709e6ef1636d863dd35a537918d9e6838a04981cd947174d402569480
+  data.tar.gz: 9f11d4fdae24faefc1069435683e65c648635568d54d19e3e8197040b721db3630be4aa779781403d26b5c2e04dd23b3b6bcc0e3bef11d405855ac07e89a0630

data/README.md

@@ -30,15 +30,15 @@ require 'options_by_example'
 
 Options = OptionsByExample.read(DATA).parse(ARGV)
 
-puts Options.include_secure?
-puts Options.include_verbose?
-puts Options.include_retries?
-puts Options.include_timeout?
-puts Options.argument_retries
-puts Options.argument_timeout
-puts Options.argument_mode
-puts Options.argument_host
-puts Options.argument_port
+puts Options.include? :secure
+puts Options.include? :verbose
+puts Options.include? :retries
+puts Options.include? :timeout
+puts Options.get :retries
+puts Options.get :timeout
+puts Options.get :mode
+puts Options.get :host
+puts Options.get :port
 
 
 __END__
@@ -50,8 +50,8 @@ Usage: connect [options] [mode] host port
 Options:
   -s, --secure        Establish a secure connection (SSL/TSL)
   -v, --verbose       Enable verbose output for detailed information
-  -r, --retries NUM   Specify the number of connection retries (default 3)
-  -t, --timeout NUM   Set the connection timeout in seconds (default 10)
+  -r, --retries NUM   Number of connection retries (default 3)
+  -t, --timeout NUM   Set connection timeout in seconds
 
 Arguments:
   [mode]              Optional connection mode (active or passive)

data/lib/options_by_example/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class OptionsByExample
-  VERSION = '3.0.0'
+  VERSION = '3.2.0'
 end
 
 
@@ -11,12 +11,25 @@ __END__
 # Minor version bump when backward-compatible changes or enhancements
 # Patch version bump when backward-compatible bug fixes, security updates etc
 
+3.2.0
+
+  - New method #get returns argument value or nil
+  - New method #fetch returns argument value or raises error
+  - Changed internal method #parse_without_exit to private
+
+3.1.0
+
+  - Support dash in argument and option names
+  - Method #if_present passes argument to block if present
+  - Method #include? return true if option is present
+
 3.0.0
 
   - Support options with default values
   - Improved support for one-line usage messages
   - Expand combined shorthand options into their separate components
   - Shorthand options must be single letter only
+  - Support options with typed arguments
 
 2.0.0
 

data/lib/options_by_example.rb

@@ -8,6 +8,7 @@ class OptionsByExample
 
   attr_reader :arguments
   attr_reader :options
+  attr_reader :usage_message
 
   def self.read(data)
     return new data.read
@@ -25,8 +26,8 @@ class OptionsByExample
 
     text =~ /Usage: (\$0|\w+)(?: \[options\])?((?: \[\w+\])*)((?: \w+)*)/
     raise RuntimeError, "Expected usage string, got none" unless $1
-    @argument_names_optional = $2.to_s.split.map { |match| match.tr('[]', '').downcase }
-    @argument_names_required = $3.to_s.split.map(&:downcase)
+    @argument_names_optional = $2.to_s.split.map { |match| sanitize match.tr('[]', '') }
+    @argument_names_required = $3.to_s.split.map { |match| sanitize match }
 
     # --- 2) Parse option names ---------------------------------------
     #
@@ -41,10 +42,10 @@ class OptionsByExample
 
     @option_names = {}
     @default_values = {}
-    text.scan(/(?:(-\w), ?)?(--(\w+))(?: (\w+))?(?:.*\(default:? (\w+)\))?/) do
+    text.scan(/(?:(-\w), ?)?(--([\w-]+))(?: (\w+))?(?:.*\(default:? (\w+)\))?/) do
       flags = [$1, $2].compact
-      flags.each { |each| @option_names[each] = [$3, $4] }
-      @default_values[$3] = $5 if $5
+      flags.each { |each| @option_names[each] = [(sanitize $3), $4] }
+      @default_values[sanitize $3] = $5 if $5
     end
 
     initialize_argument_accessors
@@ -61,6 +62,27 @@ class OptionsByExample
     exit 1
   end
 
+  def fetch(*args, &block)
+    @arguments.fetch(*args, &block)
+  end
+
+  def get(name)
+    @arguments[name]
+  end
+
+  def if_present(name)
+    raise ArgumentError, 'block missing' unless block_given?
+
+    value = @arguments[name]
+    value.nil? ? value : (yield value)
+  end
+
+  def include?(name)
+    @options.include?(name)
+  end
+
+  private
+
   def parse_without_exit(argv)
     parser = Parser.new(
       @argument_names_required,
@@ -76,8 +98,6 @@ class OptionsByExample
     return self
   end
 
-  private
-
   def initialize_argument_accessors
     [
       *@argument_names_required,
@@ -86,7 +106,7 @@ class OptionsByExample
     ].each do |argument_name|
       instance_eval %{
         def argument_#{argument_name}
-          val = @arguments["#{argument_name}"]
+          val = @arguments[:#{argument_name}]
           val && block_given? ? (yield val) : val
         end
       }
@@ -97,10 +117,14 @@ class OptionsByExample
     @option_names.each_value do |option_name, _|
       instance_eval %{
         def include_#{option_name}?
-          @options.include? "#{option_name}"
+          @options.include? :#{option_name}
         end
       }
     end
   end
+
+  def sanitize(string)
+    string.tr('^a-zA-Z0-9', '_').downcase.to_sym
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: options_by_example
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Adrian Kuhn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2023-06-17 00:00:00.000000000 Z
 dependencies: []
 description:
 email: