cmdopt 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 kuwata-lab.com all rights reserved
+
+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.txt

@@ -0,0 +1,138 @@
+================
+Cmdopt.rb README
+================
+
+Release: 0.2.0
+
+
+About
+-----
+
+Cmdopt.rb is a command-option parser.
+It is easier to use than optparse.rb (a standard library of Ruby).
+
+
+Install
+-------
+
+::
+
+	$ gem install cmdopt
+
+
+Usage
+-----
+
+Example::
+
+	## create parser
+	require 'cmdopt'
+	parser = Cmdopt::Parser.new
+	## define options
+	parser.option("-h, --help",      "show help")
+	parser.option("-f, --file=FILE", "read file")
+	## parse args
+	defaults = {:file=> "config.json"}
+	begin
+	  opts = parser.parse(ARGV, defaults)
+	  p opts.help     #=> true           (if '-h' or '--help' specified)
+	  p opts.file     #=> "config.json"  (if not specified)
+	  p ARGV
+	rescue Cmdopt::ParseError => ex
+	  $stderr.puts ex.message
+	  exit(1)
+	end
+
+More example::
+
+	## no argument
+	parser.option("-h",         "show help")
+	parser.option("    --help", "show help")
+	parser.option("-h, --help", "show help")
+	## required argument
+	parser.option("-f FILE",         "read file")
+	parser.option("    --file=FILE", "read file")
+	parser.option("-f, --file=FILE", "read file")
+	## optional argument
+	parser.option("-i[N]",            "indent width")
+	parser.option("    --indent[=N]", "indent width")
+	parser.option("-i, --indent[=N]", "indent width")
+
+Validation::
+
+	parser.option("-m, --mode=MODE", "set mode")\
+	      .validation {|val| "'verbose' or 'quiet' expected." unless val =~ /^(verbose|quiet)$/ }
+	parser.option("-i, --indent[=N]", "indent width (default 2)")\
+	      .validation {|val| "integer required." unless val == true || val =~ /^\d+$/ }
+
+Action::
+
+	## change default handler
+	parser.option("--verbose", "quiet mode")\
+	      .action {|val, opts| opts.mode = "verbose" }  # default: opts.verbose = true
+	parser.option("--quiet", "quiet mode")\
+	      .action {|val, opts| opts.mode = "quiet" }    # default: opts.quiet = true
+	
+	## The following definitions...
+	parser.option("-h, --help",      "show help")
+	parser.option("-f, --file=FILE", "read file")
+	## are equivarent to:
+	parser.option("-h, --help",      "show help")\
+	      .action {|val, opts| opts.help = val }
+	parser.option("-f, --file=FILE", "read file")\
+	      .action {|val, opts| opts.file = val }
+
+Multiple option::
+
+	## define custom handler to store values into list
+	parser.option("-I path  #paths", "include path (multiple OK)")\
+	      .action {|val, opts| (opts.paths ||= []) << val }
+	##
+	opts = parser.parse(["-Ipath1", "-Ipath2", "-Ipath3"])
+	p opts.paths   #=> ["path1", "path2", "path3"]
+
+Attribute name::
+
+	## usually, long name or sort name is used as attribute name of opts.
+	parser.option("-h, --help", "show help")
+	opts = parser.parse(["-h"])
+	p opts.help         #=> true   (attr name == long name)
+	parser.option("-h", "show help")
+	opts = parser.parse(["-h"])
+	p opts.h            #=> true   (attr name == short name)
+	## it is possible to specify attribute name by '#name'.
+	## this is very helpful when you want not to use long name.
+	parser.option("-h  #help", "show help")
+	opts = parser.parse(["-h"])
+	p opts.help         #=> true   (not 'opts.h')
+
+Help message::
+
+	puts "Usage: command [options] [file...]"
+	puts parser.help            # or parser.help(20, "  ")
+
+Private option::
+
+	parser.option("-D, --debug", nil)    # private option: no description
+	p parser.help =~ /--debug/           #=> false (not included in help message)
+
+
+History
+-------
+
+Release 0.2.0
+~~~~~~~~~~~~~
+
+* Public released
+
+
+License
+-------
+
+$License: MIT License $
+
+
+Copyright
+---------
+
+$Copyright: copyright(c) 2011 kuwata-lab.com all rights reserved $

data/cmdopt.gemspec

@@ -0,0 +1,34 @@
+###
+### $Release: 0.2.0 $
+### $Copyright: copyright(c) 2011 kuwata-lab.com all rights reserved $
+### $License: MIT License $
+###
+
+require 'rubygems'
+
+spec = Gem::Specification.new do |s|
+  ## package information
+  s.name        = "cmdopt"
+  s.author      = "makoto kuwata"
+  s.email       = "kwa(at)kuwata-lab.com"
+  s.rubyforge_project = "cmdopt"
+  s.version     = "0.2.0"
+  s.platform    = Gem::Platform::RUBY
+  s.homepage    = "https://bitbucket.org/kwatch/cmdopt/wiki/Cmdopt.rb"
+  s.summary     = "easy-to-use command option parser"
+  s.description = <<-'END'
+Cmdopt.rb is a command-line option parser.
+It is easier to use than optparse.rb (which is a standard library of Ruby).
+END
+  s.files = %w[README.txt MIT-LICENSE setup.rb cmdopt.gemspec
+               lib/cmdopt.rb test/cmdopt_test.rb]
+  s.test_file   = 'test/cmdopt_test.rb'
+  s.add_development_dependency('section9-unittest')
+end
+
+if $0 == __FILE__
+  Gem::manage_gems
+  Gem::Builder.new(spec).build
+end
+
+spec

data/lib/cmdopt.rb

@@ -0,0 +1,256 @@
+###
+### $Release: 0.2.0 $
+### $Copyright: copyright(c) 2011 kuwata-lab.com all rights reserved $
+### $License: MIT License $
+###
+
+###
+### cmdopt.js -- pretty good command-line option parser for Ruby
+###
+### See https://bitbucket.org/kwatch/cmdopt/wiki/Cmdopt.rb for details.
+###
+
+module Cmdopt
+
+
+  class Schema
+
+    def initialize
+      @items = []
+      @option2item = {}
+    end
+
+    attr_reader :items
+
+    def get(opt)
+      return @option2item[opt]
+    end
+
+    def add(options, desc, validator=nil, handler=nil)
+      attr = nil
+      if options =~ / *\#(\w+)\z/
+        attr, options = $1, $`
+      end
+      short, long, arg, required = _parse_options(options)
+      attr ||= long || short
+      handler ||= proc {|val, opts| opts[attr] = val }
+      item = SchemaItem.new
+      item.short     = short
+      item.long      = long
+      item.arg       = arg
+      item.required  = required
+      item.attr      = attr
+      item.desc      = desc
+      item.options   = options
+      item.validator = validator
+      item.handler   = handler
+      _register(item)
+      return item
+    end
+
+    private
+
+    def _parse_options(options)
+      rexp1 = /^ *-(\w), *--(\w[-\w]*)(?:=(\S+)|\[=(\S+)\])?$/
+      rexp2 = /^ *-(\w)(?: +(\S+)|\[(\S+)\])?$/
+      rexp3 = /^ *--(\w[-\w]*)(?:=(\S+)|\[=(\S+)\])?$/
+      short = long = arg = arg2 = nil
+      case options
+      when rexp1; short, long, arg, arg2 = $1, $2, $3, $4
+      when rexp2; short,       arg, arg2 = $1,     $2, $3
+      when rexp3;        long, arg, arg2 =     $1, $2, $3
+      else
+        raise ArgumentError.new("'#{options}': invalid option definition.")
+      end
+      return short, long, arg || arg2, !!arg
+    end
+
+    def _register(item)
+      @items << item
+      @option2item["-#{item.short}"] = item if item.short
+      @option2item["--#{item.long}"] = item if item.long
+    end
+
+    public
+
+    def help(width=nil, indent="  ")
+      items = @items.select {|it| it.desc }
+      if ! width
+        width = items.collect {|it| it.options.length }.max + 1
+        limit = 20
+        width = limit if width > limit
+      end
+      fmt = "#{indent}%-#{width}s: %s\n"
+      return items.collect {|it| fmt % [it.options, it.desc] }.join
+    end
+
+  end
+
+
+  class SchemaItem
+
+    attr_accessor :short, :long, :arg, :required, :attr,
+    :desc, :options, :validator, :handler
+
+  end
+
+
+  class Builder
+
+    def initialize(item)
+      @item = item
+    end
+
+    def get_item
+      return @item
+    end
+
+    def validation(&block)
+      @item.validator = block
+      self
+    end
+
+    def action(&block)
+      @item.handler = block
+      self
+    end
+
+  end
+
+
+  class Parser
+
+    def initialize
+      @schema = Schema.new
+    end
+
+    attr_accessor :schema
+
+    def option(options, desc)
+      item = @schema.add(options, desc)
+      return Builder.new(item)
+    end
+
+    def help(width=nil, indent="  ")
+      return @schema.help(width, indent)
+    end
+
+    def parse(args, defaults=nil)
+      opts = _new_opts(defaults)
+      while ! args.empty?
+        arg = args.shift
+        case arg
+        when "--" ;  break
+        when /^--/;  _parse_long(arg, opts)
+        when /^-/ ;  _parse_short(arg, args, opts)
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+      return opts
+    end
+
+    private
+
+    def _new_opts(defaults=nil)
+      dict = {}
+      @schema.items.each {|item| dict[item.attr] = nil }
+      dict.update(defaults) if defaults
+      return Options.new(dict)
+    end
+
+    def _parse_long(arg, opts)
+      arg =~ /^--(\w[-\w]*)(?:=(.*))?$/  or
+        raise ParseError.new("#{arg}: invalid long option.")
+      name, val = $1, $2
+      item = @schema.get("--#{name}")  or
+        raise ParseError.new("#{arg}: unknown option.")
+      if val.nil?
+        raise ParseError.new("#{arg}: argument required.") if item.required
+      else
+        raise ParseError.new("#{arg}: unexpected argument.") unless item.arg
+      end
+      val ||= true
+      _call_validator(item.validator, val, arg)
+      _call_handler(item.handler, val, opts)
+    end
+
+    def _parse_short(arg, args, opts)
+      i, n = 1, arg.length
+      while i < n
+        ch = arg[i, 1]
+        item = @schema.get("-#{ch}")  or
+          raise ParseError.new("-#{ch}: unknown option.")
+        if ! item.arg
+          val = true
+        elsif item.required
+          val = arg[(i+1)..-1]
+          if val.empty?
+            ! args.empty?  or
+              raise ParseError.new("-#{ch}: argument required.")
+            val = args.shift
+          end
+        else
+          val = arg[(i+1)..-1]
+          val = true if val.empty?
+        end
+        if    val == true   ;  optarg = "-#{ch}"
+        elsif item.required ;  optarg = "-#{ch} #{val}"
+        else                ;  optarg = "-#{ch}#{val}"
+        end
+        _call_validator(item.validator, val, optarg)
+        _call_handler(item.handler, val, opts)
+        break if item.arg
+        i += 1
+      end
+    end
+
+    def _call_validator(validator, val, arg)
+      if validator
+        errmsg = validator.call(val)
+        raise ParseError.new("#{arg}: #{errmsg}") if errmsg
+      end
+    end
+
+    def _call_handler(handler, val, opts)
+      handler.call(val, opts) if handler
+    end
+
+  end
+
+
+  class ParseError < StandardError
+  end
+
+
+  class Options
+
+    def initialize(dict=nil)
+      if dict
+        dict.each {|k, v| instance_variable_set("@#{k}", v) }
+        (class << self; self; end).class_eval do
+          attr_accessor *dict.keys
+        end
+      end
+    end
+
+    def [](name)
+      instance_variable_get("@#{name}")
+    end
+
+    def []=(name, val)
+      instance_variable_set("@#{name}", val)
+    end
+
+    def inspect
+      s = self.instance_variables.sort.collect {|name|
+        "#{name[1..-1]}=#{instance_variable_get(name).inspect}"
+      }.join(', ')
+      return "<Cmdopt::Options #{s}>"
+    end
+
+  end
+
+
+end