Module: Gem::OptionParser::Arguable

Defined in:
lib/rubygems/optparse/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.



2281
2282
2283
2284
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2281

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 Gem::OptionParser#getopts.

def getopts(*args)
  ($OPT = ARGV.getopts(*args)).each do |opt, val|
    eval "$OPT_#{opt.gsub(/[^A-Za-z0-9_]/, '_')} = val"
  end
rescue Gem::OptionParser::ParseError
end



2274
2275
2276
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2274

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

#initialize(*args) ⇒ Object 



2285
2286
2287
2288
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2285

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

#options ⇒ Object

Actual Gem::OptionParser object, automatically created if nonexistent.

If called with a block, yields the Gem::OptionParser object and returns the result of the block. If an Gem::OptionParser::ParseError exception occurs in the block, it is rescued, a error message printed to STDERR and nil returned.



2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2233

def options
  @optparse ||= Gem::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 Gem::OptionParser object, when opt is false or nil, methods Gem::OptionParser::Arguable#options and Gem::OptionParser::Arguable#options= are undefined. Thus, there is no ways to access the Gem::OptionParser object via the receiver object.



2216
2217
2218
2219
2220
2221
2222
2223
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2216

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.



2249
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2249

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

#parse! ⇒ Object

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



2261
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2261

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

#permute! ⇒ Object

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



2255
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2255

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