Module: Arguable

Initializes instance variable.

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

new(*args)

[Source]

# File optparse.rb, line 1763
    def initialize(*args)
      super
      @optparse = nil
    end

getopts(*args)

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]

# File optparse.rb, line 1752
    def getopts(*args)
      options.getopts(self, *args)
    end

options() {|@optparse| ...}

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]

# File optparse.rb, line 1711
    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]

# File optparse.rb, line 1694
    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]

# File optparse.rb, line 1727
    def order!(&blk) options.order!(self, &blk) end

parse!()

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

[Source]

# File optparse.rb, line 1739
    def parse!() options.parse!(self) end

permute!()

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

[Source]

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

Methods

Public Class methods

Public Instance methods