docopt 0.0.1 → 0.0.2

data/LICENSE-MIT

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Vladimir Keleshev <vladimir@keleshev.com>, Alex Speller <alex@alexspeller.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
+of the Software, and to permit persons to whom the Software is furnished to do 
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
+SOFTWARE.

data/README.md

@@ -41,21 +41,21 @@ require 'docopt'
 
 
 if __FILE__ == $0
-    options = docopt(doc, '1.0.0')  # parse options based on doc above
+    options = Docopt(doc, '1.0.0')  # parse options based on doc above
     puts options.inspect
     puts ARGV.inspect
 end
 ```
 
 Hell yeah! The option parser is generated based on `doc` string above, that you
-pass to the `docopt` function.
+pass to the `Docopt` function.
 
 API `require 'docopt'`
 ===============================================================================
 
-###`options = docopt(doc, version=nil, help=true)`
+###`options = Docopt(doc, version=nil, help=true)`
 
-`docopt` takes 1 required and 2 optional arguments:
+`Docopt` takes 1 required and 2 optional arguments:
 
 - `doc` should be a string that
 describes **options** in a human-readable format, that will be parsed to create
@@ -86,24 +86,38 @@ Note, when `docopt` is set to automatically handle `-h`, `--help` and
 `--version` options, you still need to mention them in the options description
 (`doc`) for your users to know about them.
 
-The **return** value is a hash with option values
-(giving long options precedence), e.g:
-
-    {"--benchmark"=>true,
-     "--count"=>true,
-     "--doctest"=>false,
-     "--exclude"=>".svn,CVS,.bzr,.hg,.git",
-     "--filename"=>"*.rb",
-     "--help"=>false,
-     "--ignore"=>false,
-     "--quiet"=>false,
-     "--repeat"=>false,
-     "--select"=>"*.rb",
-     "--show-source"=>true,
-     "--statistics"=>true,
-     "--testsuite"=>false,
-     "--verbose"=>true,
-     "--version"=>false}
+The **return** value is an instance of the ```Docopt``` class:
+
+```ruby
+doc = "Options:
+  --verbose
+  -o FILE  Output file [default: out.txt]"
+  
+options = Docopt(doc)
+
+puts options.inspect
+# --verbose=nil
+# -o="out.txt"
+```
+
+You can access the values of options like a hash:
+
+```
+doc = "Options:
+  -v, --verbose  Verbose output [default: true]
+  -o FILE  Output file [default: out.txt]"
+  
+options = Docopt(doc)
+
+# The following are equivilant:
+
+puts options['-v']
+puts options['--verbose']
+puts options[:v]
+puts options[:verbose]
+
+
+```
 
 You can access positional arguments in `ARGV`.
 

data/example.rb

@@ -0,0 +1,30 @@
+$DOC = "Usage: example.py [options] <arguments>...
+
+Options:
+  -h --help            show this help message and exit
+  --version            show version and exit
+  -v --verbose         print status messages
+  -q --quiet           report only file names
+  -r --repeat          show all occurrences of the same error
+  --exclude=patterns   exclude files or directories which match these comma
+                       separated patterns [default: .svn,CVS,.bzr,.hg,.git]
+  --filename=patterns  when parsing directories, only check filenames matching
+                       these comma separated patterns [default: *.rb]
+  --select=errors      select errors and warnings (e.g. E,W6)
+  --ignore=errors      skip errors and warnings (e.g. E4,W)
+  --show-source        show source code for each error
+  --statistics         count errors and warnings
+  --count              print total number of errors and warnings to standard
+                       error and set exit code to 1 if total is not null
+  --benchmark          measure processing speed
+  --testsuite=dir      run regression tests from dir
+  --doctest            run doctest on myself"
+
+require 'docopt'
+
+
+if __FILE__ == $0
+    options = Docopt($DOC, '1.0.0')  # parse options based on doc above
+    puts options.inspect
+    puts ARGV.inspect
+end

data/lib/docopt.rb

@@ -0,0 +1,101 @@
+require 'getoptlong'
+
+class Docopt
+  attr_reader :docopts
+  
+  class UnknownOptionError < StandardError; end
+  
+  class Option
+    attr_reader :short, :long, :argcount, :value
+    
+    def initialize parse
+      @argcount                = 0
+      options, _, description = parse.strip.partition('  ')
+      options                 = options.sub(',', ' ').sub('=', ' ')
+
+      for s in options.split
+        if s.start_with? '--'
+          @long = s
+        elsif s.start_with? '-'
+          @short = s
+        else
+          @argcount = 1
+        end
+      end
+      
+      if @argcount == 1
+        matched = description.scan(/\[default: (.*)\]/)[0]
+        @value = matched ? matched[0] : nil
+      end
+    end
+    
+    def synonyms
+      ([short, long] + symbols).compact
+    end
+    
+    def symbols
+      [short, long].compact.map do |name|
+        name.gsub(/^-+/, '').to_sym
+      end
+    end
+
+    def getopt
+      [long, short, argcount].compact
+    end
+
+    def inspect
+      "#<Docopt::Option short: #{short}, long: #{long}, argcount: #{argcount}, value: #{value}>"
+    end
+
+    def == other
+      self.inspect == other.inspect
+    end
+  end
+  
+  
+  def initialize(doc, version=nil, help=true)
+    @docopts = doc.split(/^ *-|\n *-/)[1..-1].map do |line|
+      Option.new('-' + line)
+    end
+    
+    GetoptLong.new(*docopts.map(&:getopt)).each do |opt, arg|
+      if help and (opt == '--help' or opt == '-h')
+        puts doc.strip
+        exit
+      elsif version and opt == '--version'
+        puts version
+        exit
+      end
+    end
+  end
+  
+  def option name
+    option = @docopts.detect do |docopt|
+      docopt.synonyms.include?(name)
+    end
+    raise UnknownOptionError.new("#{name} option not found") unless option
+    option
+  end
+  
+
+  
+  def value name
+    option(name).value
+  end
+  alias_method :[], :value
+    
+  def size
+    @docopts.size
+  end
+  
+  def inspect
+    @docopts.map do |option|
+      "#{option.short} #{option.long}=#{option.value.inspect}".strip
+    end.join("\n")
+  end
+end
+
+# Convenience method for Docopt.parse
+def Docopt *args
+  Docopt.new *args
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docopt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,18 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-03 00:00:00.000000000 Z
+date: 2012-06-05 00:00:00.000000000 Z
 dependencies: []
-description: A command line option parser, that will make you smile.
-email: 
+description: A command line option parser, that will make you smile. Isn't it awesome
+  how `optparse` and other option parsers generate help and usage-messages based on
+  your code?! Hell no!  You know what's awesome? It's when the option parser *is*
+  generated based on the help and usage-message that you write in a docstring!
+email: alex@alexspeller.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- docopt.rb
-homepage: http://github.com/alexspeller/docopt.rb
-licenses: []
+- LICENSE-MIT
+- example.rb
+- lib/docopt.rb
+homepage: http://github.com/alexspeller/docopt
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -31,13 +37,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.11
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/docopt.rb

@@ -1,116 +0,0 @@
-require 'getoptlong'
-
-
-class Option
-
-    attr_reader :short, :long, :argcount, :value
-
-    def initialize(short=nil, long=nil, argcount=0, value=false)
-        @short, @long, @argcount, @value = short, long, argcount, value
-    end
-
-    def getopt
-        [@long, @short, @argcount].compact
-    end
-
-    def inspect
-        "Option.new(#{@short}, #{@long}, #{@argcount}, #{@value})"
-    end
-
-    def == other
-        self.inspect == other.inspect
-    end
-
-end
-
-
-def option parse
-    options, _, description = parse.strip.partition('  ')
-    options = options.sub(',', ' ').sub('=', ' ')
-    short, long, argcount, value = nil, nil, 0, false
-    for s in options.split
-        if s.start_with? '--'
-            long = s
-        elsif s.start_with? '-'
-            short = s
-        else
-            argcount = 1
-        end
-    end
-    if argcount == 1
-        matched = description.scan(/\[default: (.*)\]/)[0]
-        value = matched ? matched[0] : false
-    end
-    Option.new(short, long, argcount, value)
-end
-
-
-class MyHash < Hash
-    def inspect
-        "{#{self.to_a.sort.map {|i| "%p=>%p" % i}.join(",\n ")}}"
-    end
-end
-
-
-def docopt(doc, version=nil, help=true)
-    ret = MyHash.new
-    docopts = []
-    doc.split(/^ *-|\n *-/)[1..-1].each do |s|
-        docopt = option('-' + s)
-        docopts += [docopt]
-        ret[(docopt.long or docopt.short)] = docopt.value
-    end
-    begin
-        GetoptLong.new(*docopts.map {|e| e.getopt}).each do |opt, arg|
-            if help and (opt == '--help' or opt == '-h')
-                puts doc.strip
-                exit
-            elsif version and opt == '--version'
-                puts version
-                exit
-            elsif (docopts.select {|d|(d.long or d.short)==opt})[0].argcount==0
-                ret[opt] = true
-            else
-                ret[opt] = arg
-            end
-        end
-    rescue
-        exit 1
-    end
-    ret
-end
-
-
-if __FILE__ == $0
-
-    def assert cond
-        print cond ? '.' : 'F'
-    end
-
-    assert option('-h') == Option.new('-h', nil)
-    assert option('--help') == Option.new(nil, '--help')
-    assert option('-h --help') == Option.new('-h', '--help')
-    assert option('-h, --help') == Option.new('-h', '--help')
-
-    assert option('-h TOPIC') == Option.new('-h', nil, 1)
-    assert option('--help TOPIC') == Option.new(nil, '--help', 1)
-    assert option('-h TOPIC --help TOPIC') == Option.new('-h', '--help', 1)
-    assert option('-h TOPIC, --help TOPIC') == Option.new('-h', '--help', 1)
-    assert option('-h TOPIC, --help=TOPIC') == Option.new('-h', '--help', 1)
-
-    assert option('-h  Description...') == Option.new('-h', nil)
-    assert option('-h --help  Description...') == Option.new('-h', '--help')
-    assert option('-h TOPIC  Description...') == Option.new('-h', nil, 1)
-
-    assert option('    -h') == Option.new('-h', nil)
-
-    assert option('-h TOPIC  Descripton... [default: 2]') ==
-               Option.new('-h', nil, 1, '2')
-    assert option('-h TOPIC  Descripton... [default: topic-1]') ==
-               Option.new('-h', nil, 1, 'topic-1')
-    assert option('--help=TOPIC  ... [default: 3.14]') ==
-               Option.new(nil, '--help', 1, '3.14')
-    assert option('-h, --help=DIR  ... [default: ./]') ==
-               Option.new('-h', '--help', 1, "./")
-
-end