Skip to Content Skip to Search

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

Methods
E
G
N
O
P

Class Public methods

extend_object(obj)

Initializes instance variable.

Source: show | on GitHub 

# File ruby/lib/optparse.rb, line 2308
def self.extend_object(obj)
  super
  obj.instance_eval {@optparse = nil}
end

new(*args)

Source: show | on GitHub 

# File ruby/lib/optparse.rb, line 2312
def initialize(*args)
  super
  @optparse = nil
end

Instance Public methods

getopts(*args, symbolize_names: false)

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

Source: show | on GitHub 

# File ruby/lib/optparse.rb, line 2301
def getopts(*args, symbolize_names: false)
  options.getopts(self, *args, symbolize_names: symbolize_names)
end

options()

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.

Source: show | on GitHub 

# File ruby/lib/optparse.rb, line 2260
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)

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

Source: show | on GitHub 

# File ruby/lib/optparse.rb, line 2243
def options=(opt)
  unless @optparse = opt
    class << self
      undef_method(:options)
      undef_method(:options=)
    end
  end
end

order!(&blk)

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

Source: show | on GitHub 

# File ruby/lib/optparse.rb, line 2276
def order!(&blk) options.order!(self, &blk) end

parse!()

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

Source: show | on GitHub 

# File ruby/lib/optparse.rb, line 2288
def parse!() options.parse!(self) end

permute!()

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

Source: show | on GitHub 

# File ruby/lib/optparse.rb, line 2282
def permute!() options.permute!(self) end