argparser 1.0.rc1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cff1283a52db9d44ad99667cf617ce8ca7c9a3f
-  data.tar.gz: 7d5976fa654b6d36a2a02a3daf2deefe97f86703
+  metadata.gz: dfd904524c50a0940710fd85f7739820409c9e10
+  data.tar.gz: a17ea81dc8409f8bd8eaab57a7c2a31ef87dade9
 SHA512:
-  metadata.gz: 3f7c962841f1173cd972ed7dff430f99f67c78822aed82df1af28242299c2961b034548dbd8913c0aafb48a3cdadfb348ec15a9fffdebf238e0639e0f849d498
-  data.tar.gz: 6384e7a3e0be42426ca87b022f6ef8899163c22166c1a47f12e9295bfcafbd436cadd8688b6e467513c7ce2ff159302b65ca6b4735944e2b50a06776dd4cca0c
+  metadata.gz: 90663f798ea4eced3de8423b969f61203f921e9a32a794d1f4b9b040e70ffe40db88275744da3f7e225288600e5a0e4ce64a2ccb93d840ddb9e2079ff4d15bfb
+  data.tar.gz: 2cdcea748f35be75a1cf26a78cb7b550a94656b4b60ccc1251000211d05afa0f31f63b4b0cd0e6b7c02054ffc8c326169ce6465e594d6e009708add47768752f

data/.gitignore

@@ -17,3 +17,4 @@ thumbs.db
 .ruby-version
 Gemfile.lock
 core
+*.gem

data/README.md

@@ -0,0 +1,102 @@
+# argparser
+Command line argument parser library, trying to follow POSIX and GNU guidelines.
+
+## Installation
+`gem install argparser`, as usual.
+
+## Usage by example
+Suppose there's a file named `example.rb` like this:
+````ruby
+require 'argparser'
+args= ArgParser.new( # Here goes the manifest.
+  :program => 'example.rb', # Use additional properties like these:
+  :version => '1.0',        #   :info, :copyright, :license,
+  :options => [{            #   :package, :bugs, :homepage
+    :names      => %w[m mode],
+    :argument   => 'first|second|third',
+    :default    => 'first',
+    :multiple   => true,
+    :help       => 'Example mode.',
+    :validate   => (lambda {|this, parser|  # Validating value in-line
+      possible = this.argument.split('|')
+      this.value.select{|v| possible.include?(v)}.size == this.value.size })
+  }, {
+    :names      => 'file',
+    :input      => true,
+    :required   => true,
+    :help       => 'Filename or - for stdin.',
+    :validate   => (lambda {|this, parser|
+      if this.value == '-'
+        this.value = $stdin.read
+      else
+        parser.terminate(2, 'No such file') unless File.exists?(this.value)
+        this.value = File.read(this.value)
+      end
+      true })
+  }]
+).parse!  # Uses ARGV by default, you may supply your own arguments.
+          # It exits if bad arguments given or they aren't validated.
+
+puts args['mode'].value.inspect # So we could use our options...
+puts args['file'].value         # Prints contents of a file
+````
+
+Now, let's look at the output of example given in various cases.
+
+`$ ruby example.rb` is unsufficient:
+````
+example.rb [-m, --mode first|second|third]... file
+Expected argument: file
+````
+
+`$ ruby example.rb --help` helps:
+````
+example.rb [-m, --mode first|second|third]... file
+[-m, --mode first|second|third]...
+  Example mode.
+  Defaults to: first
+[--help]
+  Print this help and exit.
+[--version]
+  Print version and exit.
+file
+  Filename or - for stdin.
+````
+
+`$ echo "content" | ruby example.rb -` does the trick:
+````
+["first"]
+content
+````
+
+`$ echo "content" | ruby example.rb --mode fourth -` oopses:
+````
+example.rb [-m, --mode first|second|third]... file
+Invalid option: m
+````
+
+`$ echo "content" | ruby example.rb -abcm first -`:
+````
+example.rb [-m, --mode first|second|third]... file
+Unknown option: a
+````
+
+## Consider more rules
+* `--help` and `--version` options provided for free unless specified.
+* printed synopsys provided for free unless specified
+* `:default` used if option has :argument and no value given, lowest priority
+* `:env  => 'ENV_VAR'` to pick default value from ENV, high priority
+* `:eval => 'ruby expr'` to pick default from eval(...), useful for read defaults from config files, so it has low priority
+* `--`-argument honored
+
+## Documentation
+This README is all i could say in a rush. No other documentation provided at this moment, see the sources.
+
+## If you've found a bug or drawback
+Don't hesistate to leave a report.
+
+## License
+MIT for now.
+
+## TODO
+* Go steal milk for the hazards applied.

data/argparser.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = 'argparser'
-  spec.version       = '1.0.rc1'
+  spec.version       = '1.0.0'
   spec.authors       = ['sinm']
   spec.email         = 'sinm.sinm@gmail.com'
   spec.summary       = 'Command line argument parser'

data/lib/argparser/examples/example.rb

@@ -0,0 +1,32 @@
+require 'argparser'
+args= ArgParser.new( # Here goes the manifest.
+  :program => 'example.rb', # Use additional properties like these:
+  :version => '1.0',        #   :info, :copyright, :license,
+  :options => [{            #   :package, :bugs, :homepage
+    :names      => %w[m mode],
+    :argument   => 'first|second|third',
+    :default    => 'first',
+    :multiple   => true,
+    :help       => 'Example mode.',
+    :validate   => (lambda {|this, parser|  # Validating value in-line
+      possible = this.argument.split('|')
+      this.value.select{|v| possible.include?(v)}.size == this.value.size })
+  }, {
+    :names      => 'file',
+    :input      => true,
+    :required   => true,
+    :help       => 'Filename or - for stdin.',
+    :validate   => (lambda {|this, parser|
+      if this.value == '-'
+        this.value = $stdin.read
+      else
+        parser.terminate(2, 'No such file') unless File.exists?(this.value)
+        this.value = File.read(this.value)
+      end
+      true })
+  }]
+).parse!  # Uses ARGV by default, you may supply your own arguments.
+          # It exits if bad arguments given or they aren't validated.
+
+puts args['mode'].value.inspect # So we could use our options...
+puts args['file'].value         # Prints contents of a file

data/lib/argparser.rb

@@ -1,4 +1,3 @@
-
 #__END__
 module Tulz
   def hash2vars!(hash)
@@ -42,9 +41,13 @@ class ArgParser
   OUT_ARGUMENT_EXPECTED = 'Expected argument: %s'
   OUT_UNIQUE_NAME = 'Option name should be unique: %s'
   INVALID_OPTION = 'Invalid option: %s'
+  OPT_ENOUGH  = '--'
+
+  # These options don't display their synopsis and given for free unless
+  # explicitly specified in the manifest.
   OPT_HELP    = 'help'
   OPT_VERSION = 'version'
-  OPT_ENOUGH  = '--'
+  OPTS_RESERVED = [OPT_HELP, OPT_VERSION]
 
   class Option
     include Tulz
@@ -200,7 +203,7 @@ class ArgParser
       end
     end
 
-    [OPT_VERSION, OPT_HELP].each { |o|
+    OPTS_RESERVED.each { |o|
       next unless arguments.include?("--#{o}")
       o = self[o]
       o.set_value(nil)
@@ -229,7 +232,7 @@ class ArgParser
             option.set_value(nil)
           end
         else
-          terminate(2, OUT_UNKNOWN_OPTION % a)
+          terminate(2, OUT_UNKNOWN_OPTION % $1)
         end
       elsif a =~ /^-([^-].*)/ # short option, may combine and has an arg at end
         (opts = $1).chars.to_a.each_with_index do |char, index|
@@ -249,7 +252,7 @@ class ArgParser
               option.set_value(nil)
             end
           else
-            terminate(2, OUT_UNKNOWN_OPTION % a)
+            terminate(2, OUT_UNKNOWN_OPTION % char)
           end
         end
       else
@@ -334,33 +337,18 @@ class ArgParser
 
   def printed_synopsis
     s = synopsis ||
-      (options.select{|o| !o.input} + inputs).map{|o| o.synopsis}.join(' ')
+      (options.select{|o| !o.input} + inputs).map{|o|
+        OPTS_RESERVED.include?(o.name) ? nil : o.synopsis}.compact.join(' ')
     "#{program} #{s}"
   end
 
-  if __FILE__ == $0 # Some selftests
+  if __FILE__ == $0 # Some selftests... while hakin in an editor
     $stdout.sync = true
     $stderr.sync = true
-    args = ArgParser.new(
-      :version    => '00',
-      :program    => 'exec',
-      :info       => 'executes command over a group of servers',
-      :options    => [{
-        :names    => 'group',
-        :input    => true,
-        :required => true,
-        :help     => 'Name of a group'
-      },{
-        :names    => 'command',
-        :input    => true,
-        :required => true,
-        :multiple => true,
-        :help     => 'command to execute'
-      }]
-    ).parse!(%w[--help])
-
-    puts args.options.map(&:to_s).join("\n")
-    puts 'OK!'
+    ARGV = %w[--abcm first]
+    example = File.read('argparser/examples/example.rb')
+    example = example.split("\n")[1..-1].join("\n") # Cut 'require' string
+    eval(example) # Last line
   end
 
-end # class
+end # the very end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: argparser
 version: !ruby/object:Gem::Version
-  version: 1.0.rc1
+  version: 1.0.0
 platform: ruby
 authors:
 - sinm
@@ -21,6 +21,7 @@ files:
 - README.md
 - argparser.gemspec
 - lib/argparser.rb
+- lib/argparser/examples/example.rb
 homepage: https://github.com/sinm/argparser
 licenses:
 - MIT
@@ -36,9 +37,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2