opt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c5e2c614056045ba24f44b7fe368b76bc3c8ae7
+  data.tar.gz: 42212a7f059c754fd846bbcbd9f5ad6823ca8a57
+SHA512:
+  metadata.gz: 29820dfd8267e9fe3e95586b74738e6094949ca4b4d95810522e9a7bf3f1ddc8ff7ae1c55b91f0f3422440a18d4e49c33f43fa6a085028a2e337752871c137c2
+  data.tar.gz: 9d70b7861cc491645a317f7d608f503682afa42f80951a4163662efd7a78b704d67a8e835b0ecd83c1ca4b20c12bc18deae2479e80e2f15005f76d15ae17863e

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,85 @@
+# Opt
+
+An option parsing library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'opt'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opt
+
+## Usage
+
+Simply specify your options:
+
+```ruby
+opt = Opt.new
+opt.option '--help, -h'
+opt.option '--version, -v'
+
+result = opt.parse %w(-h)
+result.help? #=> true
+result.version? #=> nil
+```
+
+You can also specify subcommands, the number of arguments for a switch or a text option. You can further specify a custom name with the opts hash, otherwise the name of the first switch will be used.
+
+```ruby
+opt = Opt.new
+opt.command 'merge' do |cmd|
+  cmd.option '--out, -O', nargs: 1
+  cmd.option 'file', name: :files, nargs: '+'
+end
+
+result = opt.parse %w(merge --out out.txt file1.txt file2.txt)
+result.out #=> "out.txt"
+result.files #=> ["file1.txt", "file2.txt"]
+```
+
+Different styles are supported:
+
+```ruby
+opt = Opt.new
+opt.option '--level, -l', nargs: 1
+
+opt.parse(%w(--level 5)).level #=> "5"
+opt.parse(%w(--level=5)).level #=> "5"
+opt.parse(%w(-l 5)).level #=> "5"
+opt.parse(%w(-l5)).level #=> "5"
+```
+
+See API documentation and specs for more examples and configuration option.
+
+## ToDos
+
+* Argument type parsing
+* Option block argument processing
+* GNU Flags (--no-xy, --with/without-xy)
+* rc-file loading (?)
+
+## Contributing
+
+1. Fork it (http://github.com/jgraichen/opt/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add specs so that I do not break your feature later.
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+## License
+
+Copyright (C) 2014 Jan Graichen
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/doc/file.README.html

@@ -0,0 +1,107 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>
+  File: README
+  
+    &mdash; Documentation by YARD 0.8.7.4
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!file.README.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index</a> &raquo; 
+    <span class="title">File: README</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><div id='filecontents'><h1>Opt</h1>
+
+<p>TODO: Write a gem description</p>
+
+<h2>Installation</h2>
+
+<p>Add this line to your application&#39;s Gemfile:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>opt</span><span class='tstring_end'>&#39;</span></span>
+</code></pre>
+
+<p>And then execute:</p>
+
+<pre class="code ruby"><code class="ruby">$ bundle
+</code></pre>
+
+<p>Or install it yourself as:</p>
+
+<pre class="code ruby"><code class="ruby">$ gem install opt
+</code></pre>
+
+<h2>Usage</h2>
+
+<p>TODO: Write usage instructions here</p>
+
+<h2>Contributing</h2>
+
+<ol>
+<li>Fork it ( <a href="http://github.com/">http://github.com/</a><my-github-username>/opt/fork )</li>
+<li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
+<li>Commit your changes (<code>git commit -am &#39;Add some feature&#39;</code>)</li>
+<li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
+<li>Create new Pull Request</li>
+</ol>
+</div></div>
+
+    <div id="footer">
+  Generated on Sun Jun 15 13:02:43 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.2).
+</div>
+
+  </body>
+</html>

data/lib/opt.rb

@@ -0,0 +1,65 @@
+require 'opt/version'
+
+module Opt
+  require 'opt/command'
+  require 'opt/program'
+  require 'opt/option'
+  require 'opt/switch'
+
+  def self.new
+    Program.new.tap{|p| yield p if block_given? }
+  end
+end
+
+#   #
+#   class Flag < Option
+#     attr_reader :negated_long
+
+#     REGEX = /^(?<word>[^-]+)-(?<rest>.+)/
+
+#     def initialize(*)
+#       super
+#       @value        = options.fetch(:default, true)
+#       @negated_long = Set.new
+
+#       long.each do |code|
+#         if (n = REGEX.match(code)) && (tl = self.class.translations[n[:word]])
+#           @negated_long << "#{tl}#{tl.empty? ? '' : '-'}#{n[:rest]}"
+#         elsif self.class.translations['']
+#           tl = self.class.translations['']
+#           @negated_long << "#{tl}#{tl.empty? ? '' : '-'}#{code}"
+#         end
+#       end
+#     end
+
+#     def accept?(argv)
+#       if argv.first.type == :long && negated_long.include?(argv.first.value)
+#         return true
+#       else
+#         super
+#       end
+#     end
+
+#     def parse_argv(argv)
+#       arg = argv.shift
+
+#       case arg.type
+#         when :long
+#           if negated_long.include?(arg.value)
+#             !value
+#           else
+#             value
+#           end
+#         when :short
+#           arg.value.slice!(0, 1)
+#           argv.unshift(arg) unless arg.value.empty?
+#           value
+#       end
+#     end
+
+#     class << self
+#       def translations
+#         {'with' => 'without', 'without' => 'with', '' => 'no', 'no' => '', 'not' => ''}
+#       end
+#     end
+#   end

data/lib/opt/command.rb

@@ -0,0 +1,282 @@
+require 'ostruct'
+
+module Opt
+  #
+  class Command
+    #
+    # List of registered options for this command.
+    #
+    # Can be used to add manually created {Option}s but use
+    # with care as no collision or sanity checks are done.
+    #
+    # @return [Array<Option>] Option list.
+    #
+    attr_reader :options
+
+    # List of registered subcommands.
+    #
+    # Can be used to add manually created {Command}s but use
+    # with care as no collision or sanity checks are done.
+    #
+    # @return [Array<Command>] Subcommand list.
+    #
+    attr_reader :commands
+
+    # The command name.
+    #
+    attr_reader :name
+
+    # @api private
+    #
+    def initialize(name, opts = {})
+      @name     = name.to_s.freeze
+      @opts     = opts
+      @options  = []
+      @commands = []
+    end
+
+    # Register a new option.
+    #
+    # @example An option named "help" triggered on "--help" or "-h"
+    #   command.option '--help, -h'
+    #
+    # @example An option with exactly one argument
+    #   command.option '--level, -l', nargs: 1
+    #
+    # @example An option with 2 or more arguments
+    #   command.option '--files', nargs: [2, :inf]
+    #   command.option '--files', nargs: [2, :infinity]
+    #   command.option '--files', nargs: [2, '*']
+    #
+    # @example An option with 2 to 4 arguments and a specific name
+    #   command.option '--sum, -s, -a', nargs: (2..4), name: :accumulate
+    #
+    # @example An option with 0 or more arguments
+    #   command.option '-x', nargs: '*'
+    #
+    # @example An option with 1 or more arguments
+    #   command.option '-x', nargs: '+'
+    #
+    # @example A free-text option
+    #   command.option 'file', name: :files, nargs: '*'
+    #
+    # @param definition [String] The option definition. Usually a command
+    #   separated list of dashed command line switches. If definition is
+    #   not dashed a free-text argument will be given. See {Option#initialize}
+    #   for more information.
+    # @param opts [Hash] Option hash passed to {Option#initialize}.
+    #   Used to specify a name, number of arguments, etc.
+    #
+    # @raise [ArgumentError] An {ArgumentError} is raised when a colliding
+    #   option is already registered or you try do define a free-text
+    #   option while already heaving a subcommand registered.
+    #
+    # @api public
+    # @see Option.new
+    #
+    def option(definition = nil, opts = {})
+      option = Option.new(definition, opts)
+
+      if commands.any?
+        raise ArgumentError.new \
+          'Can only have subcommands OR free-text arguments.'
+      end
+
+      if (opt = options.find{|o| o.collide?(option) })
+        raise "Option `#{definition}' collides with already " \
+              "registered option: #{opt}"
+      else
+        options << option
+      end
+    end
+
+    # Add a subcommand.
+    #
+    # A command can either have subcommands or free-text options.
+    #
+    # @example
+    #   opt.command 'add' do |cmd|
+    #     cmd.option '--num, -n'
+    #   end
+    #
+    # @param name [String, Symbol, #to_s] The command name. This token
+    #   will be used to match when parsing arguments.
+    # @param opts [Hash] Options.
+    #
+    # @yield [command] Yield new command.
+    # @yieldparam command [Command] The new command.
+    #
+    # @raise [ArgumentError] An {ArgumentError} will be raised when
+    #   the command already has a free-text option or if a command
+    #   with the same name is already registered.
+    #
+    # @return [Command] The new command.
+    #
+    # @api public
+    # @see Opt::Command#initialize
+    #
+    def command(name, opts = {})
+      if options.any?{|o| o.text? }
+        raise ArgumentError.new \
+          'Can only have subcommands OR free-text arguments.'
+      end
+
+      command = Command.new(name, opts)
+
+      if commands.any?{|c| c.name == command.name }
+        raise ArgumentError.new "Command `#{command.name}' already registered."
+      end
+
+      yield command if block_given?
+
+      commands << command
+      command
+    end
+
+    # Return hash with default values for all options.
+    #
+    # @return [Hash<String, Object>] Hash with option defaults.
+    #
+    # @api private
+    #
+    def defaults
+      Hash[options.map{|o| [o.name, o.default] }]
+    end
+
+    # Parses given list of command line tokens.
+    #
+    # @example
+    #   opt.parse %w(-fd command -x 56 --fuubar)
+    #
+    # @param argv [Array<String>] List of command line strings.
+    #   Defaults to {ARGV}.
+    #
+    # @return [Result] Return a hash-like result object.
+    #
+    # @api public
+    # @see Result
+    #
+    def parse(argv = ARGV)
+      result = Result.new
+      result.merge! defaults
+
+      parse_argv! parse_tokens(argv), result
+
+      result
+    end
+
+    # @api private
+    #
+    def parse_argv!(argv, result, options = [])
+      options += self.options
+
+      while argv.any?
+        next if options.any?{|o| o.parse!(argv, result) }
+
+        if argv.first.text?
+          if (cmd = commands.find{|c| c.name == argv.first.value })
+            result.command << argv.shift.value
+            cmd.parse_argv!(argv, result, options)
+            next
+          end
+        end
+
+        raise "Unknown option (#{argv.first.type}): #{argv.first}"
+      end
+    end
+
+    private
+
+    def parse_tokens(argv)
+      tokens = []
+      argv.each_with_index do |arg, index|
+        if arg == '--'
+          return tokens + argv[index + 1..-1].map{|a| Token.new(:text, a) }
+        elsif arg[0..1] == '--'
+          tokens << Token.new(:long, arg[2..-1])
+        elsif arg[0] == '-'
+          tokens << Token.new(:short, arg[1..-1])
+        else
+          tokens << Token.new(:text, arg)
+        end
+      end
+
+      tokens
+    end
+
+    # A hash-like result object.
+    #
+    # Allow for method-access to all key-value pairs similar
+    # to `OpenStruct`.
+    #
+    # @example
+    #   result = opt.parse %w(--help --level=5 add --exec bash sh)
+    #   result.help? #=> true
+    #   result.level #=> "5"
+    #   result.command #=> ["add"]
+    #   result.exec #=> ["bash", "sh"]
+    #
+    class Result < Hash
+      #
+      # A list of command names.
+      #
+      # @return [Array<String>] List of commands.
+      #
+      attr_reader :command
+
+      # @api private
+      #
+      def initialize
+        @command = []
+        super
+      end
+
+      # @api private
+      #
+      def respond_to_missing?(mth)
+        if mth =~ /^(\w)\??$/ && key?($1)
+          true
+        else
+          super
+        end
+      end
+
+      # @api private
+      #
+      def method_missing(mth, *args, &block)
+        if mth =~ /^(\w+)\??$/ && key?($1) && args.empty? && block.nil?
+          fetch $1
+        else
+          super
+        end
+      end
+    end
+
+    # @api private
+    #
+    Token = Struct.new(:type, :value) do
+      def text?
+        type == :text
+      end
+
+      def short?
+        type == :short
+      end
+
+      def to_s
+        case type
+          when :long
+            "--#{value}"
+          when :short
+            "-#{value}"
+          else
+            value
+        end
+      end
+
+      def inspect
+        "<#{self.class}(#{type}):\"#{self}\">"
+      end
+    end
+  end
+end