Module: Gem::OptionParser::Arguable

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



2444
2445
2446
2447
 
# File 'lib/rubygems/vendor/optparse/lib/optparse.rb', line 2444

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 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



2437
2438
2439
 
# File 'lib/rubygems/vendor/optparse/lib/optparse.rb', line 2437

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

#initialize(*args) ⇒ Object

:nodoc:



2449
2450
2451
2452
 
# File 'lib/rubygems/vendor/optparse/lib/optparse.rb', line 2449

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



2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
 
# File 'lib/rubygems/vendor/optparse/lib/optparse.rb', line 2396

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.



2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'lib/rubygems/vendor/optparse/lib/optparse.rb', line 2379

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.



2412
 
# File 'lib/rubygems/vendor/optparse/lib/optparse.rb', line 2412

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.



2424
 
# File 'lib/rubygems/vendor/optparse/lib/optparse.rb', line 2424

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.



2418
 
# File 'lib/rubygems/vendor/optparse/lib/optparse.rb', line 2418

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