Module: OptionParser::Arguable
- Defined in:
- lib/optparse.rb
Overview
Extends command line arguments array (ARGV) to parse itself.
Class Method Summary collapse
-
.extend_object(obj) ⇒ Object
Initializes instance variable.
Instance Method Summary collapse
-
#getopts(*args, symbolize_names: false) ⇒ Object
Substitution of getopts is possible as follows.
- #initialize(*args) ⇒ Object
-
#options ⇒ Object
Actual OptionParser object, automatically created if nonexistent.
-
#options=(opt) ⇒ Object
Sets OptionParser object, when
opt
isfalse
ornil
, methods OptionParser::Arguable#options and OptionParser::Arguable#options= are undefined. -
#order!(&blk) ⇒ Object
Parses
self
destructively in order and returnsself
containing the rest arguments left unparsed. -
#parse! ⇒ Object
Parses
self
destructively and returnsself
containing the rest arguments left unparsed. -
#permute! ⇒ Object
Parses
self
destructively in permutation mode and returnsself
containing the rest arguments left unparsed.
Class Method Details
.extend_object(obj) ⇒ Object
Initializes instance variable.
2319 2320 2321 2322 |
# File 'lib/optparse.rb', line 2319 def self.extend_object(obj) super obj.instance_eval {@optparse = nil} end |
Instance Method Details
#getopts(*args, symbolize_names: false) ⇒ Object
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
2312 2313 2314 |
# File 'lib/optparse.rb', line 2312 def getopts(*args, symbolize_names: false) .getopts(self, *args, symbolize_names: symbolize_names) end |
#initialize(*args) ⇒ Object
2323 2324 2325 2326 |
# File 'lib/optparse.rb', line 2323 def initialize(*args) super @optparse = nil end |
#options ⇒ Object
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.
2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 |
# File 'lib/optparse.rb', line 2271 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) ⇒ Object
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.
2254 2255 2256 2257 2258 2259 2260 2261 |
# File 'lib/optparse.rb', line 2254 def (opt) unless @optparse = opt class << self undef_method(:options) undef_method(:options=) end end end |
#order!(&blk) ⇒ Object
Parses self
destructively in order and returns self
containing the rest arguments left unparsed.
2287 |
# File 'lib/optparse.rb', line 2287 def order!(&blk) .order!(self, &blk) end |
#parse! ⇒ Object
Parses self
destructively and returns self
containing the rest arguments left unparsed.
2299 |
# File 'lib/optparse.rb', line 2299 def parse!() .parse!(self) end |
#permute! ⇒ Object
Parses self
destructively in permutation mode and returns self
containing the rest arguments left unparsed.
2293 |
# File 'lib/optparse.rb', line 2293 def permute!() .permute!(self) end |