pargser 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3dffd531e9a47357559aa2315aaf5f3151b52e9
-  data.tar.gz: 5c9236c175de9fcb1af91409cd53c77720f0fcfe
+  metadata.gz: 2766da1ace1d84c0bdd1f2095e32c7aa4ef0cdee
+  data.tar.gz: ab46a7f67e9ad2d730d13d51bdaa3acf5d91ff64
 SHA512:
-  metadata.gz: fa192889e980aef25e0691b026879ac977d69d25ad1b843d37a04876338ce372fcfda7abaa1e0ef9c6c6e9a3981beb88c51865910b49f486b0f60294f040bfd4
-  data.tar.gz: a75e25d2a6d8d370cbaae90e107b4cb512bda23dd2cbe03af0097484975553c473d5540b41ce18bb4ccf802830f0cfaabab985bfc069a89f49a4f08a5dd55667
+  metadata.gz: 6772dad90c716c614436b60a047ba2db174d309a4842592da2a46d4cb17e6dc023e8ccce9818a501cc7d7a8300e96cff0c37f0ada244f1631df73091508d9a2e
+  data.tar.gz: ee2a5d230a2f81d6053a55c1cc6e6498d01d3c9f0c823cb1b0f8cbb27ae62b7a65ddf15b356cd779ab9e829939095bafa31d16ede7f101019e00a70888b052a1

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 
 ## Usage
 
-Very straightforward
+Rather straightforward
 
     p = Pargser.new.key('-f', '--fantastic') {
       @fantastic = true
@@ -68,7 +68,7 @@ Very straightforward
 
     p.keys_doc.should == expected_docs
 
-For details please consult documentation:
+For details please consult documentation: http://www.rubydoc.info/gems/pargser
 
 ## Contributing
 

data/lib/pargser.rb

@@ -2,12 +2,14 @@ require "pargser"
 
 # The Ruby-Style (e,g, nice and laconic) command line parser that easily supports:
 #
-# --keys
-#    optional keys with any number of aliases aliases
-# -name value
-#    key that wants value (next agrument), optionally with default value
-# --
-#    no more keys past double dash
+# * --keys
+#   optional keys with any number of aliases aliases
+#
+# * -name value
+#   key that wants value (next agrument), optionally with default value
+#
+# * --
+#   no more keys past double dash
 #
 # and regular (all other) arguments.
 #
@@ -15,7 +17,7 @@ require "pargser"
 #
 class Pargser
 
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 
   # The pargser errors, e.g. wrong usage or command line does not fit specified
   # keys ocnstraints.
@@ -25,7 +27,8 @@ class Pargser
   # Create parser instance with a list of arguments. Otherwise, arguments can
   # be passed to #parse call.
   #
-  # @param [Array] args arguments
+  # @param args [Array] optional command line arguments. Usually it is more convenient
+  #     to pass them to #parse
   def initialize args=[]
     @args     = args
     @keys     = {}
@@ -33,23 +36,23 @@ class Pargser
     @docs     = []
   end
 
-  # Register key handler.
-  # When #parse handler blocks will be called in order of appearance in
-  # arguments array
+  # Register a new key handler. When #parse fonds a key (or an alias) the blocks will be called.
+  # Invocation order is same as in the command line.
   #
+  # @param name [String] key name
   #
-  # @param [String] name key name
+  # @param aliases [Array(String)] any number of aliases for the key
   #
-  # @param [Array(String)] aliases for the key
-  #
-  # @param [Boolean] :needs_value if set then the parser wants a value argument after the
+  # @param needs_value [Boolean]  if set then the parser wants a value argument after the
   #   key which will be passed to block as an argument. if default param is not set and
   #   the key will not be detected, Pargser::Error will be raised
   #
-  # @param [String] :default value. if set, needs_value parameter can be omitted - the handler
-  #   block will be passed either with this value or with one specified in args.
+  # @param default [String] default value. if set, needs_value parameter can be omitted -
+  #   the handler block will be invoked with either this value or with one from args.
+  #
+  # @param doc [String] optional documentation string that will be used in #keys_doc
   #
-  # @param [String] :doc optional documentation string that will be used in #keys_doc
+  # @return [Pargser] self
   #
   # @yield block if the key is found with optional value argument
   #
@@ -88,10 +91,10 @@ class Pargser
   #
   # You can optionally set other arguments than specified in constructor
   #
-  # @param [Array] args to parse. If specified, arguments passed to constructor
+  # @param args [Array(String)]  to parse. If specified, arguments passed to constructor
   #                will be ignored and lost
-  # @return [Array] non-keys arguments (keys afer '--' or other arguments)
-  # @yield [String] non keys argumenrs (same as returned)
+  # @return [Array] non-keys arguments (keys after '--' or other arguments)
+  # @yield [String] non keys arguments in order of appearance (same as returned)
   def parse args=nil
     @args = args.clone if args
     no_more_keys = false

data/pargser.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "pargser"
   spec.version       = Pargser::VERSION
   spec.authors       = ["sergeych"]
-  spec.email         = ["sergeych"]
+  spec.email         = ["real.sergeych@gmail.com"]
   spec.summary       = %q{Very Ruby-style command line parser}
   spec.description   = %q{Allows to write CLI in ruby without headache of arguments parsing and
 usage writing}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pargser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - sergeych
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-08 00:00:00.000000000 Z
+date: 2015-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,7 +56,7 @@ description: |-
   Allows to write CLI in ruby without headache of arguments parsing and
   usage writing
 email:
-- sergeych
+- real.sergeych@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []