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.



2208
2209
2210
2211
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2208

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



2201
2202
2203
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2201

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

#initialize(*args) ⇒ Object 



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

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.



2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2160

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.



2143
2144
2145
2146
2147
2148
2149
2150
 
# File 'lib/rubygems/optparse/lib/optparse.rb', line 2143

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.



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

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

#parse! ⇒ Object

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



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

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

#permute! ⇒ Object

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



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

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