port examples from docopt

Author: johari

docopt.gemspec

@@ -63,7 +63,14 @@ Gem::Specification.new do |s|
     README.md
     Rakefile
     docopt.gemspec
-    example.rb
+    examples/any_options_example.rb
+    examples/calculator.rb
+    examples/counted_example.rb
+    examples/example_options.rb
+    examples/git_example.rb
+    examples/naval_fate.rb
+    examples/odd_even_example.rb
+    examples/quick_example.rb
     lib/docopt.rb
     test/test_docopt.rb
     test/testee.rb

examples/calculator.rb

@@ -0,0 +1,16 @@
+require File.expand_path("../../lib/docopt.rb", __FILE__)
+
+doc = <<DOCOPT
+Usage:
+  #{__FILE__} tcp <host> <port> [--timeout=<seconds>]
+  #{__FILE__} serial <port> [--baud=9600] [--timeout=<seconds>]
+  #{__FILE__} -h | --help | --version
+
+DOCOPT
+
+begin
+  require "pp"
+  pp Docopt::docopt(doc)
+rescue Docopt::Exit => e
+  puts e.message
+end

examples/counted_example.rb

@@ -0,0 +1,22 @@
+require File.expand_path("../../lib/docopt.rb", __FILE__)
+
+doc = <<DOCOPT
+Usage: #{__FILE__} --help
+       #{__FILE__} -v...
+       #{__FILE__} go [go]
+       #{__FILE__} (--path=<path>)...
+       #{__FILE__} <file> <file>
+
+Try: #{__FILE__} -vvvvvvvvvv
+     #{__FILE__} go go
+     #{__FILE__} --path ./here --path ./there
+     #{__FILE__} this.txt that.txt
+
+DOCOPT
+
+begin
+  require "pp"
+  pp Docopt::docopt(doc)
+rescue Docopt::Exit => e
+  puts e.message
+end

examples/example.rb

@@ -0,0 +1,44 @@
+require File.expand_path("../../lib/docopt.rb", __FILE__)
+
+doc = <<DOCOPT
+Example of program with many options using docopt.
+
+Usage:
+  #{__FILE__} [-hvqrf NAME] [--exclude=PATTERNS]
+                     [--select=ERRORS | --ignore=ERRORS] [--show-source]
+                     [--statistics] [--count] [--benchmark] PATH...
+  #{__FILE__} (--doctest | --testsuite=DIR)
+  #{__FILE__} --version
+
+Arguments:
+  PATH  destination path
+
+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]
+  -f NAME --file=NAME  when parsing directories, only check filenames matching
+                       these comma separated patterns [default: *#{__FILE__}]
+  --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
+
+
+DOCOPT
+
+begin
+  require "pp"
+  pp Docopt::docopt(doc)
+rescue Docopt::Exit => e
+  puts e.message
+end

examples/example_options.rb

@@ -0,0 +1,44 @@
+require File.expand_path("../../lib/docopt.rb", __FILE__)
+
+doc = <<DOCOPT
+Usage:
+    #{__FILE__} remote [-v | --verbose]
+    #{__FILE__} remote add [-t <branch>] [-m <master>] [-f]
+                   [--tags|--no-tags] [--mirror] <name> <url>
+    #{__FILE__} remote rename <old> <new>
+    #{__FILE__} remote rm <name>
+    #{__FILE__} remote set-head <name> (-a | -d | <branch>)
+    #{__FILE__} remote set-branches <name> [--add] <branch>...
+    #{__FILE__} remote set-url [--push] <name> <newurl> [<oldurl>]
+    #{__FILE__} remote set-url --add [--push] <name> <newurl>
+    #{__FILE__} remote set-url --delete [--push] <name> <url>
+    #{__FILE__} remote [-v | --verbose] show [-n] <name>
+    #{__FILE__} remote prune [-n | --dry-run] <name>
+    #{__FILE__} remote [-v | --verbose] update [-p | --prune]
+                   [(<group> | <remote>)...]
+
+Options:
+    -v, --verbose
+    -t <branch>
+    -m <master>
+    -f
+    --tags
+    --no-tags
+    --mittor
+    -a
+    -d
+    -n, --dry-run
+    -p, --prune
+    --add
+    --delete
+    --push
+    --mirror
+
+DOCOPT
+
+begin
+  require "pp"
+  pp Docopt::docopt(doc)
+rescue Docopt::Exit => e
+  puts e.message
+end

examples/git_example.rb

@@ -0,0 +1,30 @@
+require File.expand_path("../../lib/docopt.rb", __FILE__)
+
+#The *popular* naval fate example
+
+doc = <<DOCOPT
+Naval Fate.
+
+Usage:
+  #{__FILE__} ship new <name>...
+  #{__FILE__} ship <name> move <x> <y> [--speed=<kn>]
+  #{__FILE__} ship shoot <x> <y>
+  #{__FILE__} mine (set|remove) <x> <y> [--moored|--drifting]
+  #{__FILE__} -h | --help
+  #{__FILE__} --version
+
+Options:
+  -h --help     Show this screen.
+  --version     Show version.
+  --speed=<kn>  Speed in knots [default: 10].
+  --moored      Moored (anchored) mine.
+  --drifting    Drifting mine.
+
+DOCOPT
+
+begin
+  require "pp"
+  pp Docopt::docopt(doc)
+rescue Docopt::Exit => e
+  puts e.message
+end

examples/naval_fate.rb

@@ -0,0 +1,19 @@
+require File.expand_path("../../lib/docopt.rb", __FILE__)
+
+doc = <<DOCOPT
+Usage: #{__FILE__} [-h | --help] (ODD EVEN)...
+
+Example, try:
+  #{__FILE__} 1 2 3 4
+
+Options:
+  -h, --help
+
+DOCOPT
+
+begin
+  require "pp"
+  pp Docopt::docopt(doc)
+rescue Docopt::Exit => e
+  puts e.message
+end

examples/odd_even_example.rb

@@ -0,0 +1,16 @@
+require File.expand_path("../../lib/docopt.rb", __FILE__)
+
+doc = <<DOCOPT
+Usage:
+  #{__FILE__} tcp <host> <port> [--timeout=<seconds>]
+  #{__FILE__} serial <port> [--baud=9600] [--timeout=<seconds>]
+  #{__FILE__} -h | --help | --version
+
+DOCOPT
+
+begin
+  require "pp"
+  pp Docopt::docopt(doc)
+rescue Docopt::Exit => e
+  puts e.message
+end