wooga_docopt 0.6.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41ca52f4bf6c08ce53978e44ee76909825998607
+  data.tar.gz: 52f73dc209fe8bb18a351287d5505b6c634d3a6c
+SHA512:
+  metadata.gz: 5551c334b5f1d296d43f4162b015cd9bd4bb02493aa10205d298cc18075665884e3d8b787f88dbc1d9cdaa09dbfaaf3b0fde9788c1de32ab825e16f48a68d31e
+  data.tar.gz: cae5addd81ac9a9ab98730dda4720581c9896b24eb46a7a88e2022b8daafa469da7441e2c4c83d522de16d5a4a61eb1759add5e4458a18655b907ddba71ed976

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Vladimir Keleshev <vladimir@keleshev.com>
+                   Blake Williams <code@shabbyrobe.org>
+                   Alex Speller <alex@alexspeller.com>
+                   Nima Johari
+
+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

@@ -0,0 +1,188 @@
+`docopt.rb` – command line option parser, that will make you smile
+===============================================================================
+
+[![Build Status](https://travis-ci.org/wooga/wooga.docopt.rb.svg?branch=master)](https://travis-ci.org/wooga/wooga.docopt.rb)
+
+This is the wooga ruby port of [`docopt`](https://github.com/docopt/docopt),
+the awesome option parser written originally in python.
+
+> New in version 0.6.0.1:
+>
+> New argument options_first, disallows interspersing options and arguments. If you supply options_first=True to docopt, it will interpret all arguments as positional arguments after first positional argument.
+> If option with argument could be repeated, its default value will be interpreted as space-separated list. E.g. with [default: ./here ./there] will be interpreted as ['./here', './there'].
+
+Isn't it awesome how `optparse` and `argparse` generate help messages
+based on your code?!
+
+*Hell no!*  You know what's awesome?  It's when the option parser *is* generated
+based on the beautiful help message that you write yourself!  This way
+you don't need to write this stupid repeatable parser-code, and instead can
+write only the help message--*the way you want it*.
+
+`docopt` helps you create most beautiful command-line interfaces *easily*:
+
+```ruby
+require "docopt"
+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
+```
+
+Beat that! The option parser is generated based on the docstring above that is
+passed to `docopt` function.  `docopt` parses the usage pattern
+(`Usage: ...`) and option descriptions (lines starting with dash "`-`") and
+ensures that the program invocation matches the usage pattern; it parses
+options, arguments and commands based on that. The basic idea is that
+*a good help message has all necessary information in it to make a parser*.
+
+Installation
+===============================================================================
+
+Docopt is available via rubygems:
+
+    gem install docopt
+
+Alternatively, you can just drop `lib/docopt.rb` file into your project--it is
+self-contained. [Get source on github](http://github.com/docopt/docopt.rb).
+
+`docopt` has been confirmed to work with 1.8.7p370 and 1.9.3p194. If you have
+noticed it working (or not working) with an earlier version, please raise an
+issue and we will investigate support.
+
+API
+===============================================================================
+
+`Docopt` takes 1 required and 1 optional argument:
+
+- `doc` should be a string that
+describes **options** in a human-readable format, that will be parsed to create
+the option parser.  The simple rules of how to write such a docstring
+(in order to generate option parser from it successfully) are given in the next
+section. Here is a quick example of such a string:
+
+        Usage: your_program.rb [options]
+
+        -h --help     Show this.
+        -v --verbose  Print more text.
+        --quiet       Print less text.
+        -o FILE       Specify output file [default: ./test.txt].
+
+
+The optional second argument contains a hash of additional data to influence
+docopt. The following keys are supported: 
+
+- `help`, by default `true`, specifies whether the parser should automatically
+print the usage-message (supplied as `doc`) in case `-h` or `--help` options
+are encountered. After showing the usage-message, the program will terminate.
+If you want to handle `-h` or `--help` options manually (as all other options),
+set `help=false`.
+
+- `version`, by default `nil`, is an optional argument that specifies the
+version of your program. If supplied, then, if the parser encounters
+`--version` option, it will print the supplied version and terminate.
+`version` could be any printable object, but most likely a string,
+e.g. `'2.1.0rc1'`.
+
+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 just a dictionary with options, arguments and commands,
+with keys spelled exactly like in a help message
+(long versions of options are given priority). For example, if you invoke
+the top example as::
+
+    naval_fate.rb ship Guardian move 100 150 --speed=15
+
+the return dictionary will be::
+
+```ruby
+{"ship"=>true,
+ "new"=>false,
+ "<name>"=>["Guardian"],
+ "move"=>true,
+ "<x>"=>"100",
+ "<y>"=>"150",
+ "--speed"=>"15",
+ "shoot"=>false,
+ "mine"=>false,
+ "set"=>false,
+ "remove"=>false,
+ "--moored"=>false,
+ "--drifting"=>false,
+ "--help"=>false,
+ "--version"=>false}
+```
+
+Help message format
+===============================================================================
+
+docopt.rb follows the docopt help message format.
+You can find more details at
+[official docopt git repo](https://github.com/docopt/docopt#help-message-format)
+
+
+Examples
+-------------------------------------------------------------------------------
+
+We have an extensive list of
+[examples](https://github.com/docopt/docopt.rb/tree/master/examples)
+which cover every aspect of functionality of `docopt`.  Try them out,
+read the source if in doubt.
+
+Data validation
+-------------------------------------------------------------------------------
+
+`docopt` does one thing and does it well: it implements your command-line
+interface.  However it does not validate the input data.  We are looking
+for ruby validation libraries to make your option parsing experiene
+even more awesome!
+If you've got any suggestions or think your awesome schema validation gem
+fits well with `docopt.rb`, open an issue on github and enjoy the eternal glory!
+
+Contribution
+===============================================================================
+
+We would *love* to hear what you think about `docopt.rb`.
+Contribute, make pull requrests, report bugs, suggest ideas and discuss
+`docopt.rb` on
+[issues page](http://github.com/docopt/docopt.rb/issues).
+
+If you want to discuss the original `docopt` reference,
+point to [it's home](http://github.com/docopt/docopt) or
+drop a line directly to vladimir@keleshev.com!
+
+Porting `docopt` to other languages
+===============================================================================
+
+Docopt is an interlinguistic (?) effort,
+and this is the ruby port of `docopt`.
+We coordinate our efforts with docopt community and try our best to
+keep in sync with the python reference.
+
+Docopt community *loves* to hear what you think about `docopt`, `docopt.rb`
+and other sister projects on docopt's
+[issues page](http://github.com/docopt/docopt/issues).

data/Rakefile

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/docopt.gemspec

@@ -0,0 +1,85 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+  s.required_ruby_version = '>= 1.9.3'
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'wooga_docopt'
+  s.version           = '0.6.0.1'
+  s.date              = '2016-10-03'
+  
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary = "A command line option parser, that will make you smile."
+  s.description = "Isn't it awesome how `optparse` and other option parsers generate help and usage-messages based on your code?! Hell no!\nYou 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! That's what docopt does!"
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors = ["Blake Williams", "Vladimir Keleshev", "Alex Speller", "Nima Johari"]
+  s.email = "code@shabbyrobe.org"
+  s.homepage = "http://github.com/docopt/docopt.rb"
+  s.license = 'MIT'
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## This sections is only necessary if you have C extensions.
+  # s.require_paths << 'ext'
+  # s.extensions = %w[ext/extconf.rb]
+
+  ## If your gem includes any executables, list them here.
+  # s.executables = ["name"]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  # s.add_dependency('DEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency('rake')
+  s.add_development_dependency('json', "~> 1.8")
+  s.add_development_dependency('test-unit', "~> 3.2")
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    docopt.gemspec
+    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/language_agnostic_tester.py
+    test/test_docopt.rb
+    test/testcases.docopt
+    test/testee.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end