arg-parser 0.2.2 → 0.2.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODcwNmFlYTFmYzRkMDE2NzRkYzVjMmIyZjEzOGZiMDZmNWYxODRjNQ==
+    YjVkYzMxZDYxNTUzZjdlOTEwMjY3MThiYzNmYTc1OTQ4ZWQ4MjkxZQ==
   data.tar.gz: !binary |-
-    NzNlZjg3MmI1YTVkNjY1NmNmOThhYWIyM2I3YjJmMzgzZDgzMTViZg==
+    ZWI1MTc5MDc3ZDE0YjZhZmJiODFlZDBjN2Q0OTFmMjY3ODQ4YzMxZQ==
 SHA512:
   metadata.gz: !binary |-
-    ZmY0MThmOTJiM2UwNmVlODEwZWFkNjczNWZlNmYwNzA4NThkNGMwOGNkYTdj
-    OWNlY2ZlZGVlYzMwNTNhMDM2OTJhM2RmNDIzOTFhZmVmNzdhOTBiZmY4M2Qw
-    N2I5YjdiNjhhNDdlYWI4ZjJiNTNmYzM3YjM1ZDJiZTYzMGM3NWU=
+    ZWQ1ZmIzODNlMDI4YjFlZDcwODQ2MDIzODI4MmMyMTg3OTE2MjA4NTZjZmYz
+    OTlkMzQ2NTBmM2YxNzFjOWZmMTM5NjZjM2RmZTZiYzU5MzQ2M2Y0NjVhMGMw
+    ZDM2Zjk4MmVkODBmMjM1YWUxNGMyODllOTgxYmRlYWMwMjMxMGY=
   data.tar.gz: !binary |-
-    ZWNlNThjZGRiZGM3YjY4ZGQ2N2FkODFiN2E4YzMyMGRkNDY2MDhmMzRkNGJl
-    NTNkMzZkMzU0Y2ZkN2VkMmM3YjBhMWU5MDI0ZDE1YTBiN2JiNzIzYzQ1MmYz
-    MDhmYTk0NjYwMzI4ODU4MWY4NDU0ODJlMDgxMzZmZTU3YjE5NWY=
+    NWMwOTk4NDU1NGQwNDNmMTc4Zjc2MGJhZGM4YmE3OWM1MDZmM2RkODQ1ZjU2
+    OTdkOGQxYmJiNDFjZGU3MGRmMzc3MzFhOTA2MDc0MTU3YzRhMjA3NTY2YmY4
+    NmJlYzdiZGVkYjc0MDY1ZTdjMTJhYjIxZTFkOTUwNWRmMWY4Mjk=

data/README.md

@@ -31,7 +31,12 @@ class MyClass
     EOT
 
     positional_arg :my_positional_arg, 'This is a positional arg'
-    keyword_arg :my_keyword_arg, 'This is a keyword arg'
+    keyword_arg :my_keyword_arg, 'This is a keyword arg; if not specified, returns value1',
+        default: 'value1'
+    # An optional value keyword argument. If not specified, returns false. If specified
+    # without a value, returns 'maybe'. If specified with a value, returns the value.
+    keyword_arg :val_opt, 'This is a keyword arg with optional value',
+        value_optional: 'maybe'
     flag_arg :flag, 'This is a flag argument'
     rest_arg :files, 'This is where we specify that remaining args will be collected in an array'
 
@@ -61,6 +66,8 @@ list of features:
 * Mandatory vs Optional: All arguments your program accepts can be defined as optional or mandatory.
   By default, positional arguments are considered mandatory, and all others default to optional. To change
   the default, simply specify `required: true` or `required: false` when defining the argument.
+* Keyword arguments can also accept an optional value, using the `value_optional` option. If a keyword
+  argument is supplied without a value, it returns the value of the `value_optional` option.
 * Short-keys and long-keys: Arguments are defined with a long_key name which will be used to access the
   parsed value in the results. However, arguments can also define a single letter or digit short-key form
   which can be used as an alternate means for indicating a value. To define a short key, simply pass

data/lib/arg-parser/argument.rb

@@ -195,8 +195,18 @@ module ArgParser
     class KeywordArgument < ValueArgument
 
         # Whether the keyword argument must be specified with a non-missing
-        # value.
-        # @return [Boolean] true if the keyword can be specified without a value.
+        # value. The default is false, meaning the keyword argument must be
+        # specified together with a value. When this property is set to a
+        # non-falsy value (i.e. not nil or false), the keyword argument can
+        # be specified either with or without a value (or not at all):
+        # - If specified with a value, the value will be returned.
+        # - If specified without a value, the value of this property will be
+        #   returned.
+        # - If not specified at all, the default value will be returned.
+        #
+        # @return [Object] If truthy, the argument does not require a value.
+        #   If the argument is specified but no value is provided, the value
+        #   of this property will be the argument value.
         attr_accessor :value_optional
         alias_method :value_optional?, :value_optional
 
@@ -205,6 +215,7 @@ module ArgParser
         # on a command-line using either a long form key (i.e. --key), or
         # optionally, a short-form key (i.e. -k) should one be defined for this
         # argument.
+        #
         # @param key [Symbol] the key that will be used to identify this argument
         #   value in the parse results.
         # @param desc [String] the description of this argument, displayed in the

data/lib/arg-parser/parser.rb

@@ -185,9 +185,13 @@ module ArgParser
                 self.errors << "No value was specified for required argument '#{arg}'"
                 return
             end
-            if !is_default && val.nil? && KeywordArgument === arg && !arg.value_optional?
-                self.errors << "No value was specified for keyword argument '#{arg}'"
-                return
+            if !is_default && val.nil? && KeywordArgument === arg
+                if arg.value_optional?
+                    val = arg.value_optional
+                else
+                    self.errors << "No value was specified for keyword argument '#{arg}'"
+                    return
+                end
             end
 
             # Argument value validation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arg-parser
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Adam Gardiner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-11 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies: []
 description: ! "        ArgParser is a simple, yet powerful command-line argument
   parser, with\n        support for positional, keyword, flag and rest arguments,