Module: OptionParser::Arguable

Defined in:
lib/optparse.rb

Overview

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

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extend_object(obj) ⇒ Object

Initializes instance variable.



2435
2436
2437
2438
 
# File 'lib/optparse.rb', line 2435

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

Instance Method Details

#getopts(*args, symbolize_names: false, **keywords) ⇒ 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



2428
2429
2430
 
# File 'lib/optparse.rb', line 2428

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

#initialize(*args) ⇒ Object

:nodoc:



2440
2441
2442
2443
 
# File 'lib/optparse.rb', line 2440

def initialize(*args)       # :nodoc:
  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.



2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
 
# File 'lib/optparse.rb', line 2387

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) ⇒ 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.



2370
2371
2372
2373
2374
2375
2376
2377
 
# File 'lib/optparse.rb', line 2370

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

#order!(**keywords, &blk) ⇒ Object

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



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

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

#parse!(**keywords) ⇒ Object

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



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

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

#permute!(**keywords) ⇒ Object

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



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

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