Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more

In Files

  • optparse.rb

OptionParser::Arguable

Extends command line arguments array (ARGV) to parse itself.

Public Class Methods

extend_object(obj) click to toggle source

Initializes instance variable.

 
               # File optparse.rb, line 1933
def self.extend_object(obj)
  super
  obj.instance_eval {@optparse = nil}
end
new(*args) click to toggle source 
 
               # File optparse.rb, line 1937
def initialize(*args)
  super
  @optparse = nil
end

Public Instance Methods

getopts(*args) click to toggle source

Substitution of getopts is possible as follows. Also see OptionParser#getopts.

def getopts(*args)
  ($OPT = ARGV.getopts(*args)).each do |opt, val|
    eval "$OPT_#{opt.gsub(/[^A-Za-z0-9_]/, '_')} = val"
  end
rescue OptionParser::ParseError
end

 
               # File optparse.rb, line 1926
def getopts(*args)
  options.getopts(self, *args)
end
options() click to toggle source

Actual OptionParser object, automatically created if nonexistent.

If called with a block, yields the OptionParser object and returns the result of the block. If an OptionParser::ParseError exception occurs in the block, it is rescued, a error message printed to STDERR and nil returned.

 
               # File optparse.rb, line 1885
def options
  @optparse ||= OptionParser.new
  @optparse.default_argv = self
  block_given? or return @optparse
  begin
    yield @optparse
  rescue ParseError
    @optparse.warn $!
    nil
  end
end
options=(opt) click to toggle source

Sets OptionParser object, when opt is false or nil, methods #options and #options= are undefined. Thus, there is no ways to access the OptionParser object via the receiver object.

 
               # File optparse.rb, line 1868
def options=(opt)
  unless @optparse = opt
    class << self
      undef_method(:options)
      undef_method(:options=)
    end
  end
end
order!(&blk) click to toggle source

Parses self destructively in order and returns self containing the rest arguments left unparsed.

 
               # File optparse.rb, line 1901
def order!(&blk) options.order!(self, &blk) end
parse!() click to toggle source

Parses self destructively and returns self containing the rest arguments left unparsed.

 
               # File optparse.rb, line 1913
def parse!() options.parse!(self) end
permute!() click to toggle source

Parses self destructively in permutation mode and returns self containing the rest arguments left unparsed.

 
               # File optparse.rb, line 1907
def permute!() options.permute!(self) end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.