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.


1914
1915
1916
1917
# File 'lib/optparse.rb', line 1914

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

1907
1908
1909
# File 'lib/optparse.rb', line 1907

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

#initialize(*args) ⇒ Object


1918
1919
1920
1921
# File 'lib/optparse.rb', line 1918

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

#optionsObject

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.


1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
# File 'lib/optparse.rb', line 1866

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.


1849
1850
1851
1852
1853
1854
1855
1856
# File 'lib/optparse.rb', line 1849

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.


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

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

#parse!Object

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


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

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

#permute!Object

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


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

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