arg-parser 0.2.3 → 0.3.0

data/README.md

@@ -84,4 +84,9 @@ list of features:
 * On-parse handler: A proc can be passed that will be called when the argument value is encountered
   during parsing. The return value of the proc will be used as the argument result.
   `on_parse: lambda{ |val, arg, hsh| val.split(',') }`
-
+* On-parse handler reuse: Common parse handlers can be registered and used on multiple arguments.
+  Handlers are registered for reuse via the DSL method #register_parse_handler. To use a registered
+  parse handler for a particular argument, just pass the key under which the handler is registered.
+* Pre-defined arguments: Arguments can be registered under a key, and then re-used across multiple
+  definitions via the #predefined_arg DSL method. Common arguments would typically be defined in a
+  shared file that was included into each job. See Argument.register and DSL.predefined_arg.

data/lib/arg-parser/argument.rb

@@ -5,6 +5,8 @@ module ArgParser
     OnParseHandlers = {
         :split_to_array => lambda{ |val, arg, hsh| val.split(',') }
     }
+    # Hash containing registered arguments available via #predefined_arg
+    PredefinedArguments = { }
 
 
     # Abstract base class of all command-line argument types.
@@ -62,6 +64,47 @@ module ArgParser
         end
 
 
+        # Register a common argument for use in multiple argument definitions. The
+        # registered argument is a completely defined argument that can be added to
+        # any argument definition via Definition#predefined_arg.
+        #
+        # @see Definition#predefined_arg
+        #
+        # @param lookup_key [String, Symbol] The key with which to register the
+        #   argument for subsequent lookup. This can be different from the key
+        #   which will represent the argument when parsed etc; this makes it
+        #   possible to register several alternate versions of the same argument
+        #   for use in different circumstances.
+        # @param arg [Argument] An Argument sub-class that represents the arg
+        #   that is to be registered for later use. #TODO: Document how arg is
+        #   created.
+        def self.register(lookup_key, arg)
+            key = self.to_key(lookup_key)
+            if PredefinedArguments.has_key?(key)
+                raise ArgumentError, "An argument has already been registered under key '#{lookup_key}'"
+            end
+            PredefinedArguments[key] = arg
+        end
+
+
+        # Return a copy of a pre-defined argument for use in an argument
+        # definition.
+        #
+        # @param lookup_key [String, Symbol] The key with which to register the
+        #   argument for subsequent lookup. This can be different from the key
+        #   which will represent the argument when parsed etc; this makes it
+        #   possible to register several alternate versions of the same argument
+        #   for use in different circumstances.
+        # @return [Argument] A copy of the registered argument.
+        def self.lookup(lookup_key)
+            key = self.to_key(lookup_key)
+            unless arg = PredefinedArguments[key]
+                raise ArgumentError, "No pre-defined argument has been registered under key '#{lookup_key}'"
+            end
+            arg.clone
+        end
+
+
         private
 
         def initialize(key, desc, opts = {}, &block)
@@ -308,6 +351,9 @@ module ArgParser
         #   /? flags on the command-line.
         # @param [Hash] opts Contains any options that are desired for this
         #   argument.
+        # @option opts [Fixnum] :min_values The minimum number of rest values
+        #   that must be supplied. Defaults to 1 if the RestArgument is
+        #   required, or 0 if it is not.
         # @param [Block] block If supplied, the block passed will be invoked
         #   after this argument value has been parsed from the command-line.
         #   The block will be called with three arguments: this argument

data/lib/arg-parser/definition.rb

@@ -101,6 +101,36 @@ module ArgParser
         end
 
 
+        # Lookup a pre-defined argument (created earlier via Argument#register),
+        # and add it to this arguments definition.
+        #
+        # @see Argument#register
+        #
+        # @param lookup_key [String, Symbol] The key under which the pre-defined
+        #   argument was registered.
+        # @param desc [String] An optional override for the argument description
+        #   for this use of the pre-defined argument.
+        # @param opts [Hash] An options hash for those select properties that
+        #   can be overridden on a pre-defined argument.
+        # @option opts [String] :description The argument description for this
+        #   use of the pre-defined argument.
+        # @option opts [String] :usage_break The usage break for this use of
+        #   the pre-defined argument.
+        # @option opts [Boolean] :required Whether this argument is a required
+        #   (i.e. mandatory) argument.
+        # @option opts [String] :default The default value for the argument,
+        #   returned in the command-line parse results if no other value is
+        #   specified.
+        def predefined_arg(lookup_key, opts = {})
+            arg = Argument.lookup(lookup_key)
+            arg.description = opts[:description] if opts[:description]
+            arg.useage_break = opts[:usage_break] if opts.has_key?(:usage_break)
+            arg.required = opts[:required] if opts.has_key?(:required)
+            arg.default = opts[:default] if opts.has_key?(:default)
+            self << arg
+        end
+
+
         # Individual arguments are optional, but exactly one of +keys+ arguments
         # is required.
         def require_one_of(*keys)

data/lib/arg-parser/dsl.rb

@@ -96,6 +96,19 @@ module ArgParser
                 args_def.rest_arg(key, desc, opts, &block)
             end
 
+            # Use a pre-defined argument.
+            # @see Definition#predefined_arg
+            def predefined_arg(lookup_key, desc = nil, opts = {})
+                if desc.is_a?(Hash)
+                    opts = desc
+                    desc = nil
+                end
+                opts.merge!(@arg_opts){ |k, e, n| e || n } if @arg_opts
+                opts[:description] = desc if desc
+                @arg_opts = nil
+                args_def.predefined_arg(lookup_key, opts)
+            end
+
             # Set a label for a usage break to be applied on the next argument
             # that is defined.
             def usage_break(label)

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: arg-parser
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
+  prerelease: 
 platform: ruby
 authors:
 - Adam Gardiner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-05-29 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,
@@ -18,35 +19,36 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
 - README.md
-- lib/arg-parser.rb
+- LICENSE
 - lib/arg-parser/argument.rb
 - lib/arg-parser/definition.rb
 - lib/arg-parser/dsl.rb
 - lib/arg-parser/parser.rb
+- lib/arg-parser.rb
 - lib/arg_parser.rb
 homepage: https://github.com/agardiner/arg-parser
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 1.8.21
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: ArgParser is a simple, yet powerful, command-line argument (option) parser
 test_files: []

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YjVkYzMxZDYxNTUzZjdlOTEwMjY3MThiYzNmYTc1OTQ4ZWQ4MjkxZQ==
-  data.tar.gz: !binary |-
-    ZWI1MTc5MDc3ZDE0YjZhZmJiODFlZDBjN2Q0OTFmMjY3ODQ4YzMxZQ==
-SHA512:
-  metadata.gz: !binary |-
-    ZWQ1ZmIzODNlMDI4YjFlZDcwODQ2MDIzODI4MmMyMTg3OTE2MjA4NTZjZmYz
-    OTlkMzQ2NTBmM2YxNzFjOWZmMTM5NjZjM2RmZTZiYzU5MzQ2M2Y0NjVhMGMw
-    ZDM2Zjk4MmVkODBmMjM1YWUxNGMyODllOTgxYmRlYWMwMjMxMGY=
-  data.tar.gz: !binary |-
-    NWMwOTk4NDU1NGQwNDNmMTc4Zjc2MGJhZGM4YmE3OWM1MDZmM2RkODQ1ZjU2
-    OTdkOGQxYmJiNDFjZGU3MGRmMzc3MzFhOTA2MDc0MTU3YzRhMjA3NTY2YmY4
-    NmJlYzdiZGVkYjc0MDY1ZTdjMTJhYjIxZTFkOTUwNWRmMWY4Mjk=