Module: OptionParser::Arguable
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Extended In:
| |
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
isfalse
ornil
, methods #options andoptions=
are undefined.
Instance Method Summary
-
#getopts(*args)
Substitution of getopts is possible as follows.
- #initialize(*args)
-
#order!(&blk)
Parses
self
destructively in order and returnsself
containing the rest arguments left unparsed. -
#parse!
Parses
self
destructively and returnsself
containing the rest arguments left unparsed. -
#permute!
Parses
self
destructively in permutation mode and returnsself
containing the rest arguments left unparsed.
Class Method Details
.extend_object(obj)
Initializes instance variable.
# File 'lib/optparse.rb', line 2130
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.
# File 'lib/optparse.rb', line 2082
def @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.
# File 'lib/optparse.rb', line 2065
def (opt) unless @optparse = opt class << self undef_method(: ) undef_method(: ) end end end
Instance Method Details
#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
# File 'lib/optparse.rb', line 2123
def getopts(*args) .getopts(self, *args) end
#initialize(*args)
[ GitHub ]# File 'lib/optparse.rb', line 2134
def initialize(*args) super @optparse = nil end
#order!(&blk)
Parses self
destructively in order and returns self
containing the rest arguments left unparsed.
# File 'lib/optparse.rb', line 2098
def order!(&blk) .order!(self, &blk) end
#parse!
Parses self
destructively and returns self
containing the rest arguments left unparsed.
# File 'lib/optparse.rb', line 2110
def parse!() .parse!(self) end
#permute!
Parses self
destructively in permutation mode and returns self
containing the rest arguments left unparsed.
# File 'lib/optparse.rb', line 2104
def permute!() .permute!(self) end