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.



1765
1766
1767
1768
 
# File 'lib/optparse.rb', line 1765

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

Instance Method Details

#getopts(*args) ⇒ 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



1758
1759
1760
 
# File 'lib/optparse.rb', line 1758

def getopts(*args)
  options.getopts(self, *args)
end

#initialize(*args) ⇒ Arguable

Returns a new instance of Arguable.

Returns:

  • (Arguable) —

    a new instance of Arguable



1769
1770
1771
1772
 
# File 'lib/optparse.rb', line 1769

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.



1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
 
# File 'lib/optparse.rb', line 1717

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.



1700
1701
1702
1703
1704
1705
1706
1707
 
# File 'lib/optparse.rb', line 1700

def options=(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.



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

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

#parse! ⇒ Object

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



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

def parse!() options.parse!(self) end

#permute! ⇒ Object

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



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

def permute!() options.permute!(self) end