class Samovar::One

Represents a single positional argument in a command.

A ‘One` parser extracts exactly one argument from the command line that matches the specified pattern.

Attributes

default [R]

The default value if no argument is provided.

@attribute [Object]

description [R]

A description of the argument for help output.

@attribute [String]

key [R]

The name of the attribute to store the value in.

@attribute [Symbol]

pattern [R]

A pattern to match valid values.

@attribute [Regexp]

required [R]

Whether the argument is required.

@attribute [Boolean]

Public Class Methods

new (key, description, pattern: //, default: nil, required: false)

Source

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

Initialize a new positional argument parser.

@parameter key [Symbol] The name of the attribute to store the value in. @parameter description [String] A description of the argument for help output. @parameter pattern [Regexp] A pattern to match valid values. @parameter default [Object] The default value if no argument is provided. @parameter required [Boolean] Whether the 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/one.rb, line 79
def parse(input, parent = nil, default = nil)
        if input.first =~ @pattern
                input.shift
        elsif default ||= @default
                return default
        elsif @required
                raise MissingValueError.new(parent, @key)
        end
end

Parse a single argument 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 [String | Object | Nil] The parsed value, or the default if no match.

to_a ()

Source

# File vendor/bundle/ruby/3.4.0/gems/samovar-2.4.1/lib/samovar/one.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/one.rb, line 54
def to_s
        "<#{@key}>"
end

Generate a string representation for usage output.

@returns [String] The usage string.