class Samovar::Split
A ‘Split` parser divides the argument list at a marker (typically `–`), allowing you to separate arguments meant for your command from those passed to another tool.
Represents a split point in the command-line arguments.
def initialize(key, description, marker: "--", default: nil, required: false)
@parameter default [Object] The default value if no split is present.
@parameter marker [String] The marker that indicates the split point.
@parameter description [String] A description of the split for help output.
@parameter key [Symbol] The name of the attribute to store the values after the split.
Initialize a new split parser.
def initialize(key, description, marker: "--", default: nil, required: false) @key = key @description = description @marker = marker @default = default @required = required end
def parse(input, parent = nil, default = nil)
@parameter default [Object | Nil] An override for the default value.
@parameter parent [Command | Nil] The parent command.
@parameter input [Array(String)] The command-line arguments.
Parse arguments after the split marker.
def parse(input, parent = nil, default = nil) if offset = input.index(@marker) input.pop(input.size - offset).tap(&:shift) elsif default ||= @default return default elsif @required raise MissingValueError.new(parent, @key) end end
def to_a
Generate an array representation for usage output.
def to_a usage = [to_s, @description] if @default usage << "(default: #{@default.inspect})" elsif @required usage << "(required)" end return usage end
def to_s
Generate a string representation for usage output.
def to_s "#{@marker} <#{@key}...>" end