Class: Toys::Flag

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

Overview

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.

Returns:

  • (Proc) 
->(val, _prev) { val }
PUSH_HANDLER =

The push handler pushes the given value using the << operator.

Returns:

  • (Proc) 
->(val, prev) { prev.nil? ? [val] : prev << val }
DEFAULT_HANDLER =

The default handler is the set handler, replacing the previous value.

Returns:

  • (Proc) 
SET_HANDLER

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#acceptor ⇒ Toys::Acceptor::Base (readonly)

Returns the effective acceptor.

Returns:



148
149
150
 
# File 'lib/toys/flag.rb', line 148

def acceptor
  @acceptor
end

#default ⇒ Object (readonly)

Returns the default value, which may be nil.

Returns:

  • (Object) 


154
155
156
 
# File 'lib/toys/flag.rb', line 154

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.

Returns:



171
172
173
 
# File 'lib/toys/flag.rb', line 171

def desc
  @desc
end

#display_name ⇒ String (readonly)

The display name of this flag.

Returns:

  • (String) 


248
249
250
 
# File 'lib/toys/flag.rb', line 248

def display_name
  @display_name
end

#flag_completion ⇒ Proc, Toys::Completion::Base (readonly)

The proc that determines shell completions for the flag.

Returns:



202
203
204
 
# File 'lib/toys/flag.rb', line 202

def flag_completion
  @flag_completion
end

#flag_syntax ⇒ Array<Toys::Flag::Syntax> (readonly)

Returns an array of Flag::Syntax for the flags.

Returns:



142
143
144
 
# File 'lib/toys/flag.rb', line 142

def flag_syntax
  @flag_syntax
end

#flag_type ⇒ :boolean, :value (readonly)

The type of flag.

Returns:

  • (:boolean) —

    if the flag is a simple boolean switch

  • (:value) —

    if the flag sets a value



216
217
218
 
# File 'lib/toys/flag.rb', line 216

def flag_type
  @flag_type
end

#group ⇒ Toys::FlagGroup (readonly)

Returns the flag group containing this flag

Returns:



130
131
132
 
# File 'lib/toys/flag.rb', line 130

def group
  @group
end

#handler ⇒ Proc (readonly)

The handler for setting/updating the value.

Returns:

  • (Proc) 


196
197
198
 
# File 'lib/toys/flag.rb', line 196

def handler
  @handler
end

#key ⇒ Symbol (readonly)

Returns the key.

Returns:

  • (Symbol) 


136
137
138
 
# File 'lib/toys/flag.rb', line 136

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.

Returns:



190
191
192
 
# File 'lib/toys/flag.rb', line 190

def long_desc
  @long_desc
end

#sort_str ⇒ String (readonly)

A string that can be used to sort this flag

Returns:

  • (String) 


254
255
256
 
# File 'lib/toys/flag.rb', line 254

def sort_str
  @sort_str
end

#value_completion ⇒ Proc, Toys::Completion::Base (readonly)

The proc that determines shell completions for the value.

Returns:



208
209
210
 
# File 'lib/toys/flag.rb', line 208

def value_completion
  @value_completion
end

#value_delim ⇒ String? (readonly)

The value delimiter, which may be "", " ", or "=".

Returns:

  • (String) —

    The delimiter

  • (nil) —

    if the flag type is not :value.



242
243
244
 
# File 'lib/toys/flag.rb', line 242

def value_delim
  @value_delim
end

#value_label ⇒ String? (readonly)

The string label for the value as it should display in help.

Returns:

  • (String) —

    The label

  • (nil) —

    if the flag type is not :value.



234
235
236
 
# File 'lib/toys/flag.rb', line 234

def value_label
  @value_label
end

#value_type ⇒ :required, ... (readonly)

The type of value.

Returns:

  • (:required) —

    if the flag type is :value and the value is required.

  • (:optional) —

    if the flag type is :value and the value is optional.

  • (nil) —

    if the flag type is not :value.



227
228
229
 
# File 'lib/toys/flag.rb', line 227

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.

Parameters:

  • key (String, Symbol) —

    The key to use to retrieve the value from the execution context.

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

    The flags in OptionParser format. If empty, a flag will be inferred from the key.

  • accept (Object) (defaults to: nil) —

    An acceptor that validates and/or converts the value. See Acceptor.create for recognized formats. Optional. If not specified, defaults to Acceptor::DEFAULT.

  • default (Object) (defaults to: nil) —

    The default value. This is the value that will be set in the context if this flag is not provided on the command line. Defaults to nil.

  • handler (Proc, nil, :set, :push) (defaults to: nil) —

    An optional handler for setting/updating the value. A handler is a proc taking two arguments, the given value and the previous value, returning the new value that should be set. You may also specify a predefined named handler. The :set handler (the default) replaces the previous value (effectively -> (val, _prev) { val }). The :push handler expects the previous value to be an array and pushes the given value onto it; it should be combined with setting default: [] and is intended for "multi-valued" flags.

  • complete_flags (Object) (defaults to: nil) —

    A specifier for shell tab completion for flag names associated with this flag. By default, a DefaultCompletion is used, which provides the flag's names as completion candidates. To customize completion, set this to a hash of options to pass to the constructor for DefaultCompletion, or pass any other spec recognized by Completion.create.

  • complete_values (Object) (defaults to: nil) —

    A specifier for shell tab completion for flag values associated with this flag. Pass any spec recognized by Completion.create.

  • report_collisions (Boolean) (defaults to: true) —

    Raise an exception if a flag is requested that is already in use or marked as disabled. Default is true.

  • group (Toys::FlagGroup) (defaults to: nil) —

    Group containing this flag.

  • desc (String, Array<String>, Toys::WrappableString) (defaults to: nil) —

    Short description for the flag. See Tool#desc= for a description of allowed formats. Defaults to the empty string.

  • long_desc (Array<String,Array<String>,Toys::WrappableString>) (defaults to: nil) —

    Long description for the flag. See Tool#long_desc= for a description of allowed formats. Defaults to the empty array.

  • display_name (String) (defaults to: nil) —

    A display name for this flag, used in help text and error messages.

  • used_flags (Array<String>) (defaults to: nil) —

    An array of flags already in use.



118
119
120
121
122
123
124
 
# File 'lib/toys/flag.rb', line 118

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)
  new(key, flags, used_flags, report_collisions, accept, handler, default, complete_flags,
      complete_values, desc, long_desc, display_name, group)
end

Instance Method Details

#active? ⇒ Boolean

Whether this flag is active--that is, it has a nonempty flags list.

Returns:

  • (Boolean) 


318
319
320
 
# File 'lib/toys/flag.rb', line 318

def active?
  !effective_flags.empty?
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.

Parameters:

Returns:

  • (self) 


353
354
355
356
 
# File 'lib/toys/flag.rb', line 353

def append_long_desc(long_desc)
  @long_desc.concat(WrappableString.make_array(long_desc))
  self
end

#canonical_syntax_strings ⇒ Array<String>

A list of canonical flag syntax strings.

Returns:

  • (Array<String>) 


309
310
311
 
# File 'lib/toys/flag.rb', line 309

def canonical_syntax_strings
  @canonical_syntax_strings ||= flag_syntax.map(&:canonical_str)
end

#effective_flags ⇒ Array<String>

The list of all effective flags used.

Returns:

  • (Array<String>) 


276
277
278
 
# File 'lib/toys/flag.rb', line 276

def effective_flags
  @effective_flags ||= flag_syntax.flat_map(&:flags)
end

#long_flag_syntax ⇒ Array<Flag::Syntax>

An array of Flag::Syntax including only long (double-dash) flags.

Returns:



268
269
270
 
# File 'lib/toys/flag.rb', line 268

def long_flag_syntax
  @long_flag_syntax ||= flag_syntax.find_all { |ss| ss.flag_style == :long }
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.

Parameters:

  • str (String) —

    Flag string to look up

Returns:



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/toys/flag.rb', line 288

def resolve(str)
  resolution = Resolution.new(str)
  flag_syntax.each do |fs|
    if fs.positive_flag == str
      resolution.add!(self, fs, false, true)
    elsif fs.negative_flag == str
      resolution.add!(self, fs, true, true)
    elsif fs.positive_flag.start_with?(str)
      resolution.add!(self, fs, false, false)
    elsif fs.negative_flag.to_s.start_with?(str)
      resolution.add!(self, fs, true, false)
    end
  end
  resolution
end

#short_flag_syntax ⇒ Array<Flag::Syntax>

An array of Flag::Syntax including only short (single dash) flags.

Returns:



260
261
262
 
# File 'lib/toys/flag.rb', line 260

def short_flag_syntax
  @short_flag_syntax ||= flag_syntax.find_all { |ss| ss.flag_style == :short }
end