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.



2212
2213
2214
2215
 
# File 'lib/optparse.rb', line 2212

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



2205
2206
2207
 
# File 'lib/optparse.rb', line 2205

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

#initialize(*args) ⇒ Object 



2216
2217
2218
2219
 
# File 'lib/optparse.rb', line 2216

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.



2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
 
# File 'lib/optparse.rb', line 2164

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.



2147
2148
2149
2150
2151
2152
2153
2154
 
# File 'lib/optparse.rb', line 2147

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.



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

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

#parse! ⇒ Object

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



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

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

#permute! ⇒ Object

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



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

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