Class: Toys::Completion::Context
- Inherits:
-
Object
- Object
- Toys::Completion::Context
- Defined in:
- toys-core/lib/toys/completion.rb
Overview
Defined in the toys-core gem
The context in which to determine completion candidates.
Instance Attribute Summary collapse
-
#cli ⇒ Toys::CLI
readonly
The CLI being run.
-
#fragment ⇒ String
readonly
The current string fragment to complete.
-
#fragment_prefix ⇒ String
readonly
A non-completed prefix for the current fragment.
-
#previous_words ⇒ Array<String>
readonly
All previous words.
Instance Method Summary collapse
-
#[](key) ⇒ Object
(also: #get)
Get data for arbitrary key.
-
#arg_parser ⇒ Toys::ArgParser
Current ArgParser indicating the status of argument parsing up to this point.
-
#args ⇒ Array<String>
An array of complete arguments passed to the tool, prior to the fragment to complete.
-
#initialize(cli:, previous_words: [], fragment_prefix: "", fragment: "", **params) ⇒ Context
constructor
Create a completion context.
-
#tool ⇒ Toys::ToolDefinition
The tool being invoked, which should control the completion.
-
#with(**delta_params) ⇒ Toys::Completion::Context
Create a new completion context with the given modifications.
Constructor Details
#initialize(cli:, previous_words: [], fragment_prefix: "", fragment: "", **params) ⇒ Context
Create a completion context
34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
# File 'toys-core/lib/toys/completion.rb', line 34 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.
63 64 65 |
# File 'toys-core/lib/toys/completion.rb', line 63 def cli @cli end |
#fragment ⇒ String (readonly)
The current string fragment to complete
81 82 83 |
# File 'toys-core/lib/toys/completion.rb', line 81 def fragment @fragment end |
#fragment_prefix ⇒ String (readonly)
A non-completed prefix for the current fragment.
75 76 77 |
# File 'toys-core/lib/toys/completion.rb', line 75 def fragment_prefix @fragment_prefix end |
#previous_words ⇒ Array<String> (readonly)
All previous words.
69 70 71 |
# File 'toys-core/lib/toys/completion.rb', line 69 def previous_words @previous_words end |
Instance Method Details
#[](key) ⇒ Object Also known as: get
Get data for arbitrary key.
88 89 90 |
# File 'toys-core/lib/toys/completion.rb', line 88 def [](key) @params[key] end |
#arg_parser ⇒ Toys::ArgParser
Current ArgParser indicating the status of argument parsing up to this point.
118 119 120 121 |
# File 'toys-core/lib/toys/completion.rb', line 118 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.
107 108 109 110 |
# File 'toys-core/lib/toys/completion.rb', line 107 def args lookup_tool @args end |
#tool ⇒ Toys::ToolDefinition
The tool being invoked, which should control the completion.
97 98 99 100 |
# File 'toys-core/lib/toys/completion.rb', line 97 def tool lookup_tool @tool end |
#with(**delta_params) ⇒ Toys::Completion::Context
Create a new completion context with the given modifications.
55 56 57 |
# File 'toys-core/lib/toys/completion.rb', line 55 def with(**delta_params) Context.new(**@params.merge(delta_params)) end |