Module: OptionParser::Arguable

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Extended In: `::ARGV`
Defined in:	lib/optparse.rb

Overview

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

Class Method Summary

.extend_object(obj)

Initializes instance variable.

Instance Attribute Summary

#options rw

Actual OptionParser object, automatically created if nonexistent.
#options=(opt) rw

Sets OptionParser object, when opt is false or nil, methods #options and options= are undefined.

Instance Method Summary

#getopts(*args, symbolize_names: false, **keywords)

Substitution of getopts is possible as follows.
#order!(**keywords, &blk)

Parses self destructively in order and returns self containing the rest arguments left unparsed.
#parse!(**keywords)

Parses self destructively and returns self containing the rest arguments left unparsed.
#permute!(**keywords)

Parses self destructively in permutation mode and returns self containing the rest arguments left unparsed.
#initialize(*args) Internal use only

Class Method Details

.extend_object(obj)

Initializes instance variable.

[ GitHub ]

# File 'lib/optparse.rb', line 2401


def self.extend_object(obj)
  super
  obj.instance_eval {@optparse = nil}
end

Instance Attribute Details

#options (rw)

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 ParseError exception occurs in the block, it is rescued, a error message printed to STDERR and nil returned.

[ GitHub ]

# File 'lib/optparse.rb', line 2353


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) (rw)

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.

[ GitHub ]

# File 'lib/optparse.rb', line 2336


def options=(opt)
  unless @optparse = opt
    class << self
      undef_method(:options)
      undef_method(:options=)
    end
  end
end

Instance Method Details

#getopts(*args, symbolize_names: false, **keywords)

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

[ GitHub ]

# File 'lib/optparse.rb', line 2394


def getopts(*args, symbolize_names: false, **keywords)
  options.getopts(self, *args, symbolize_names: symbolize_names, **keywords)
end

#initialize(*args)

This method is for internal use only.

[ GitHub ]

# File 'lib/optparse.rb', line 2406


def initialize(*args)       # :nodoc:
  super
  @optparse = nil
end

#order!(**keywords, &blk)

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

[ GitHub ]

# File 'lib/optparse.rb', line 2369


def order!(**keywords, &blk) options.order!(self, **keywords, &blk) end

#parse!(**keywords)

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

[ GitHub ]

# File 'lib/optparse.rb', line 2381


def parse!(**keywords) options.parse!(self, **keywords) end

#permute!(**keywords)

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

[ GitHub ]

# File 'lib/optparse.rb', line 2375


def permute!(**keywords) options.permute!(self, **keywords) end