Class: Toys::Flag
- Inherits:
-
Object
- Object
- Toys::Flag
- Defined in:
- core-docs/toys/flag.rb
Overview
Defined in the toys-core gem
Representation of a formal set of flags that set a particular context key. The flags within a single Flag definition are synonyms.
Defined Under Namespace
Classes: DefaultCompletion, Resolution, Syntax
Constant Summary collapse
- SET_HANDLER =
The set handler replaces the previous value.
->(val, _prev) { val }
- PUSH_HANDLER =
The push handler pushes the given value using the
<<
operator. ->(val, prev) { prev.nil? ? [val] : prev << val }
- DEFAULT_HANDLER =
The default handler is the set handler, replacing the previous value.
SET_HANDLER
Instance Attribute Summary collapse
-
#acceptor ⇒ Toys::Acceptor::Base
readonly
Returns the effective acceptor.
-
#default ⇒ Object
readonly
Returns the default value, which may be
nil
. -
#desc ⇒ Toys::WrappableString
The short description string.
-
#display_name ⇒ String
readonly
The display name of this flag.
-
#flag_completion ⇒ Proc, Toys::Completion::Base
readonly
The proc that determines shell completions for the flag.
-
#flag_syntax ⇒ Array<Toys::Flag::Syntax>
readonly
Returns an array of Flag::Syntax for the flags.
-
#flag_type ⇒ :boolean, :value
readonly
The type of flag.
-
#group ⇒ Toys::FlagGroup
readonly
Returns the flag group containing this flag.
-
#handler ⇒ Proc
readonly
The handler for setting/updating the value.
-
#key ⇒ Symbol
readonly
Returns the key.
-
#long_desc ⇒ Array<Toys::WrappableString>
The long description strings.
-
#sort_str ⇒ String
readonly
A string that can be used to sort this flag.
-
#value_completion ⇒ Proc, Toys::Completion::Base
readonly
The proc that determines shell completions for the value.
-
#value_delim ⇒ String?
readonly
The value delimiter, which may be
""
," "
, or"="
. -
#value_label ⇒ String?
readonly
The string label for the value as it should display in help.
-
#value_type ⇒ :required, ...
readonly
The type of value.
Class Method Summary collapse
-
.create(key, flags = [], used_flags: nil, report_collisions: true, accept: nil, handler: nil, default: nil, complete_flags: nil, complete_values: nil, display_name: nil, desc: nil, long_desc: nil, group: nil) ⇒ Object
Create a flag definition.
Instance Method Summary collapse
-
#active? ⇒ Boolean
Whether this flag is active--that is, it has a nonempty flags list.
-
#append_long_desc(long_desc) ⇒ self
Append long description strings.
-
#canonical_syntax_strings ⇒ Array<String>
A list of canonical flag syntax strings.
-
#effective_flags ⇒ Array<String>
The list of all effective flags used.
-
#long_flag_syntax ⇒ Array<Flag::Syntax>
An array of Flag::Syntax including only long (double-dash) flags.
-
#resolve(str) ⇒ Toys::Flag::Resolution
Look up the flag by string.
-
#short_flag_syntax ⇒ Array<Flag::Syntax>
An array of Flag::Syntax including only short (single dash) flags.
Instance Attribute Details
#acceptor ⇒ Toys::Acceptor::Base (readonly)
Returns the effective acceptor.
352 353 354 |
# File 'core-docs/toys/flag.rb', line 352 def acceptor @acceptor end |
#default ⇒ Object (readonly)
Returns the default value, which may be nil
.
358 359 360 |
# File 'core-docs/toys/flag.rb', line 358 def default @default end |
#desc ⇒ Toys::WrappableString
The short description string.
When reading, this is always returned as a WrappableString.
When setting, the description may be provided as any of the following:
- A WrappableString.
- A normal String, which will be transformed into a WrappableString using spaces as word delimiters.
- An Array of String, which will be transformed into a WrappableString where each array element represents an individual word for wrapping.
375 376 377 |
# File 'core-docs/toys/flag.rb', line 375 def desc @desc end |
#display_name ⇒ String (readonly)
The display name of this flag.
452 453 454 |
# File 'core-docs/toys/flag.rb', line 452 def display_name @display_name end |
#flag_completion ⇒ Proc, Toys::Completion::Base (readonly)
The proc that determines shell completions for the flag.
406 407 408 |
# File 'core-docs/toys/flag.rb', line 406 def flag_completion @flag_completion end |
#flag_syntax ⇒ Array<Toys::Flag::Syntax> (readonly)
Returns an array of Flag::Syntax for the flags.
346 347 348 |
# File 'core-docs/toys/flag.rb', line 346 def flag_syntax @flag_syntax end |
#flag_type ⇒ :boolean, :value (readonly)
The type of flag.
420 421 422 |
# File 'core-docs/toys/flag.rb', line 420 def flag_type @flag_type end |
#group ⇒ Toys::FlagGroup (readonly)
Returns the flag group containing this flag
334 335 336 |
# File 'core-docs/toys/flag.rb', line 334 def group @group end |
#handler ⇒ Proc (readonly)
The handler for setting/updating the value.
400 401 402 |
# File 'core-docs/toys/flag.rb', line 400 def handler @handler end |
#key ⇒ Symbol (readonly)
Returns the key.
340 341 342 |
# File 'core-docs/toys/flag.rb', line 340 def key @key end |
#long_desc ⇒ Array<Toys::WrappableString>
The long description strings.
When reading, this is returned as an Array of WrappableString representing the lines in the description.
When setting, the description must be provided as an Array where each element may be any of the following:
- A WrappableString representing one line.
- A normal String representing a line. This will be transformed into a WrappableString using spaces as word delimiters.
- An Array of String representing a line. This will be transformed into a WrappableString where each array element represents an individual word for wrapping.
394 395 396 |
# File 'core-docs/toys/flag.rb', line 394 def long_desc @long_desc end |
#sort_str ⇒ String (readonly)
A string that can be used to sort this flag
458 459 460 |
# File 'core-docs/toys/flag.rb', line 458 def sort_str @sort_str end |
#value_completion ⇒ Proc, Toys::Completion::Base (readonly)
The proc that determines shell completions for the value.
412 413 414 |
# File 'core-docs/toys/flag.rb', line 412 def value_completion @value_completion end |
#value_delim ⇒ String? (readonly)
The value delimiter, which may be ""
, " "
, or "="
.
446 447 448 |
# File 'core-docs/toys/flag.rb', line 446 def value_delim @value_delim end |
#value_label ⇒ String? (readonly)
The string label for the value as it should display in help.
438 439 440 |
# File 'core-docs/toys/flag.rb', line 438 def value_label @value_label end |
#value_type ⇒ :required, ... (readonly)
The type of value.
431 432 433 |
# File 'core-docs/toys/flag.rb', line 431 def value_type @value_type end |
Class Method Details
.create(key, flags = [], used_flags: nil, report_collisions: true, accept: nil, handler: nil, default: nil, complete_flags: nil, complete_values: nil, display_name: nil, desc: nil, long_desc: nil, group: nil) ⇒ Object
Create a flag definition.
323 324 325 326 327 328 |
# File 'core-docs/toys/flag.rb', line 323 def self.create(key, flags = [], used_flags: nil, report_collisions: true, accept: nil, handler: nil, default: nil, complete_flags: nil, complete_values: nil, display_name: nil, desc: nil, long_desc: nil, group: nil) # Source available in the toys-core gem end |
Instance Method Details
#active? ⇒ Boolean
Whether this flag is active--that is, it has a nonempty flags list.
510 511 512 |
# File 'core-docs/toys/flag.rb', line 510 def active? # Source available in the toys-core gem end |
#append_long_desc(long_desc) ⇒ self
Append long description strings.
You must pass an array of lines in the long description. See #long_desc for details on how each line may be represented.
545 546 547 |
# File 'core-docs/toys/flag.rb', line 545 def append_long_desc(long_desc) # Source available in the toys-core gem end |
#canonical_syntax_strings ⇒ Array<String>
A list of canonical flag syntax strings.
501 502 503 |
# File 'core-docs/toys/flag.rb', line 501 def canonical_syntax_strings # Source available in the toys-core gem end |
#effective_flags ⇒ Array<String>
The list of all effective flags used.
480 481 482 |
# File 'core-docs/toys/flag.rb', line 480 def effective_flags # Source available in the toys-core gem end |
#long_flag_syntax ⇒ Array<Flag::Syntax>
An array of Flag::Syntax including only long (double-dash) flags.
472 473 474 |
# File 'core-docs/toys/flag.rb', line 472 def long_flag_syntax # Source available in the toys-core gem end |
#resolve(str) ⇒ Toys::Flag::Resolution
Look up the flag by string. Returns an object that indicates whether the given string matched this flag, whether the match was unique, and other pertinent information.
492 493 494 |
# File 'core-docs/toys/flag.rb', line 492 def resolve(str) # Source available in the toys-core gem end |
#short_flag_syntax ⇒ Array<Flag::Syntax>
An array of Flag::Syntax including only short (single dash) flags.
464 465 466 |
# File 'core-docs/toys/flag.rb', line 464 def short_flag_syntax # Source available in the toys-core gem end |