module OptionParser::Arguable - Documentation for Ruby 3.4
Description: module OptionParser::Arguable: Extends command line arguments array (ARGV) to parse itself.
Keywords: ruby,module,OptionParser::Arguable

# module OptionParser::Arguable

Extends command line arguments array (ARGV) to parse itself.

### Public Class Methods

extend_object (obj)
Source

    # File lib/optparse.rb, line 2403
    def self.extend_object(obj)
      super
      obj.instance_eval {@optparse = nil}
    end

Initializes instance variable.

Calls superclass method

### Public Instance Methods

getopts (*args, symbolize_names: false, **keywords)
Source

    # File lib/optparse.rb, line 2396
    def getopts(*args, symbolize_names: false, **keywords)
      options.getopts(self, *args, symbolize_names: symbolize_names, **keywords)
    end

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

options () { |optparse| ... }
Source

    # File lib/optparse.rb, line 2355
    def options
      @optparse ||= OptionParser.new
      @optparse.default_argv = self
      block_given? or return @optparse
      begin
        yield @optparse
      rescue ParseError
        @optparse.warn $!
        nil
      end
    end

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.

options= (opt)
Source

    # File lib/optparse.rb, line 2338
    def options=(opt)
      unless @optparse = opt
        class << self
          undef_method(:options)
          undef_method(:options=)
        end
      end
    end

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.

order! (**keywords, &blk)
Source

    # File lib/optparse.rb, line 2371
    def order!(**keywords, &blk) options.order!(self, **keywords, &blk) end

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

parse! (**keywords)
Source

    # File lib/optparse.rb, line 2383
    def parse!(**keywords) options.parse!(self, **keywords) end

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

permute! (**keywords)
Source

    # File lib/optparse.rb, line 2377
    def permute!(**keywords) options.permute!(self, **keywords) end

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