Class: Toys::Completion::Context

Inherits:
Object
  • Object
show all
Defined in:
lib/toys/completion.rb

Overview

The context in which to determine completion candidates.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cli:, previous_words: [], fragment_prefix: "", fragment: "", **params) ⇒ Context

Create a completion context.

Extra params are optional and can be used to affect the behavior in specific cases. Currently these are:

  • shell: :bash causes the FileSystem completion to include glob expansions, since bash doesn't handle those directly
  • disable_flags: true causes tool completion to omit flag completions which is used by the toys do built-in tool

Parameters:

  • cli (Toys::CLI) —

    The CLI being run. Required.

  • previous_words (Array<String>) (defaults to: []) —

    Array of complete strings that appeared prior to the fragment to complete.

  • fragment_prefix (String) (defaults to: "") —

    A prefix in the fragment that does not participate in completion. (e.g. "key=")

  • fragment (String) (defaults to: "") —

    The string fragment to complete.

  • params (Hash) —

    Miscellaneous context data



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/toys/completion.rb', line 38

def initialize(cli:, previous_words: [], fragment_prefix: "", fragment: "", **params)
  @cli = cli
  @previous_words = previous_words
  @fragment_prefix = fragment_prefix
  @fragment = fragment
  extra_params = {
    cli: cli, previous_words: previous_words, fragment_prefix: fragment_prefix,
    fragment: fragment
  }
  @params = params.merge(extra_params)
  @tool = nil
  @args = nil
  @arg_parser = nil
end

Instance Attribute Details

#cli ⇒ Toys::CLI (readonly)

The CLI being run.

Returns:



67
68
69
 
# File 'lib/toys/completion.rb', line 67

def cli
  @cli
end

#fragment ⇒ String (readonly)

The current string fragment to complete

Returns:

  • (String) 


85
86
87
 
# File 'lib/toys/completion.rb', line 85

def fragment
  @fragment
end

#fragment_prefix ⇒ String (readonly)

A non-completed prefix for the current fragment.

Returns:

  • (String) 


79
80
81
 
# File 'lib/toys/completion.rb', line 79

def fragment_prefix
  @fragment_prefix
end

#previous_words ⇒ Array<String> (readonly)

All previous words.

Returns:

  • (Array<String>) 


73
74
75
 
# File 'lib/toys/completion.rb', line 73

def previous_words
  @previous_words
end

Instance Method Details

#[](key) ⇒ Object Also known as: get

Get data for arbitrary key.

Parameters:

  • key (Symbol)

Returns:

  • (Object) 


92
93
94
 
# File 'lib/toys/completion.rb', line 92

def [](key)
  @params[key]
end

#arg_parser ⇒ Toys::ArgParser

Current ArgParser indicating the status of argument parsing up to this point.

Returns:



122
123
124
125
 
# File 'lib/toys/completion.rb', line 122

def arg_parser
  lookup_tool
  @arg_parser ||= ArgParser.new(@cli, @tool).parse(@args)
end

#args ⇒ Array<String>

An array of complete arguments passed to the tool, prior to the fragment to complete.

Returns:

  • (Array<String>) 


111
112
113
114
 
# File 'lib/toys/completion.rb', line 111

def args
  lookup_tool
  @args
end

#tool ⇒ Toys::ToolDefinition

The tool being invoked, which should control the completion.

Returns:



101
102
103
104
 
# File 'lib/toys/completion.rb', line 101

def tool
  lookup_tool
  @tool
end

#with(**delta_params) ⇒ Toys::Completion::Context

Create a new completion context with the given modifications.

Parameters:

  • delta_params (Hash) —

    Replace context data.

Returns:



59
60
61
 
# File 'lib/toys/completion.rb', line 59

def with(**delta_params)
  Context.new(**@params, **delta_params)
end