class Samovar::Many

Represents multiple positional arguments in a command.

A ‘Many` parser extracts all arguments from the command line until it encounters a stop pattern (typically an option flag).

Attributes

default [R]

The default value if no arguments are provided.

@attribute [Object]

description [R]

A description of the arguments for help output.

@attribute [String | Nil]

key [R]

The name of the attribute to store the values in.

@attribute [Symbol]

required [R]

Whether at least one argument is required.

@attribute [Boolean]

stop [R]

A pattern that indicates the end of this argument list.

@attribute [Regexp]

Public Class Methods

new (key, description = nil, stop: /^-/, default: nil, required: false)

Source

# File vendor/bundle/ruby/3.4.0/gems/samovar-2.4.1/lib/samovar/many.rb, line 18
def initialize(key, description = nil, stop: /^-/, default: nil, required: false)
        @key = key
        @description = description
        @stop = stop
        @default = default
        @required = required
end

Initialize a new multi-argument parser.

@parameter key [Symbol] The name of the attribute to store the values in. @parameter description [String | Nil] A description of the arguments for help output. @parameter stop [Regexp] A pattern that indicates the end of this argument list. @parameter default [Object] The default value if no arguments are provided. @parameter required [Boolean] Whether at least one argument is required.

Public Instance Methods

parse (input, parent = nil, default = nil)

Source

# File vendor/bundle/ruby/3.4.0/gems/samovar-2.4.1/lib/samovar/many.rb, line 79
def parse(input, parent = nil, default = nil)
        if @stop and stop_index = input.index{|item| @stop === item}
                input.shift(stop_index)
        elsif input.any?
                input.shift(input.size)
        elsif default ||= @default
                return default
        elsif @required
                raise MissingValueError.new(parent, @key)
        end
end

Parse multiple arguments from the input.

@parameter input [Array(String)] The command-line arguments. @parameter parent [Command | Nil] The parent command. @parameter default [Object | Nil] An override for the default value. @returns [Array(String) | Object | Nil] The parsed values, or the default if none match.

to_a ()

Source

# File vendor/bundle/ruby/3.4.0/gems/samovar-2.4.1/lib/samovar/many.rb, line 61
def to_a
        usage = [to_s, @description]
        
        if @default
                usage << "(default: #{@default.inspect})"
        elsif @required
                usage << "(required)"
        end
        
        return usage
end

Generate an array representation for usage output.

@returns [Array] The usage array.

to_s ()

Source

# File vendor/bundle/ruby/3.4.0/gems/samovar-2.4.1/lib/samovar/many.rb, line 54
def to_s
        "<#{key}...>"
end

Generate a string representation for usage output.

@returns [String] The usage string.