class Samovar::Split

Represents a split point in the command-line arguments.

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.

Attributes

completions [R]

Completions for split arguments.

@attribute [Array | Proc | Nil]

default [R]

The default value if no split is present.

@attribute [Object]

description [R]

A description of the split for help output.

@attribute [String]

key [R]

The name of the attribute to store the values after the split.

@attribute [Symbol]

marker [R]

The marker that indicates the split point.

@attribute [String]

required [R]

Whether the split is required.

@attribute [Boolean]

@parameter key [Symbol] The name of the attribute to store the values after the split. @parameter description [String] A description of the split for help output. @parameter marker [String] The marker that indicates the split point. @parameter default [Object] The default value if no split is present. @parameter required [Boolean] Whether the split is required. @parameter completions [Array | Proc | Nil] Completions for split arguments.

Public Instance Methods

complete (input, context, collected)

Source

# File vendor/bundle/ruby/4.0.0/gems/samovar-2.5.1/lib/samovar/split.rb, line 104
def complete(input, context, collected)
        if offset = input.index(@marker)
                input.shift(offset + 1)
                
                if @completions == :executable && input.any?
                        return Completion::Result.new(collected + [
                                Completion::Suggestion.new(
                                        input.first,
                                        description: "Delegate completion",
                                        type: :delegate,
                                        index: context.arguments.index(@marker) + 1,
                                ),
                        ])
                end
                
                return Completion::Result.new(collected) + Completion::Provider.new(context.with_row(self), @completions).suggestions
        end
        
        return Completion::Result.new(collected) unless input.empty?
        
        suggestions = []
        
        if @marker.start_with?(context.current)
                suggestions << Completion::Suggestion.new(@marker, description: @description, type: :split)
        end
        
        return Completion::Result.new(collected + suggestions)
end

Complete the split marker or arguments after it.

@parameter input [Array(String)] Previously completed command-line arguments. @parameter context [Completion::Context] The completion context. @parameter collected [Array(Completion::Suggestion)] Suggestions collected so far. @returns [Completion::Result | Nil] A final completion result, or nil to continue.

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

Source

# File vendor/bundle/ruby/4.0.0/gems/samovar-2.5.1/lib/samovar/split.rb, line 88
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

Parse arguments after the split marker.

@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 arguments after the split, or the default if no split.

to_a ()

Source

# File vendor/bundle/ruby/4.0.0/gems/samovar-2.5.1/lib/samovar/split.rb, line 70
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/4.0.0/gems/samovar-2.5.1/lib/samovar/split.rb, line 63
def to_s
        "#{@marker} <#{@key}...>"
end

Generate a string representation for usage output.

@returns [String] The usage string.