Class: Toys::Context

Inherits:
Object
  • Object
show all
Defined in:
core-docs/toys/context.rb

Overview

Defined in the toys-core gem

This is the base class for tool execution. It represents self when your tool's methods (such as run) are called, and it defines the methods that can be called by your tool (such as #logger and #exit.)

This class also manages the "data" available to your tool when it runs. This data is a hash of key-value pairs. It consists of values set by flags and arguments defined by the tool, plus some "well-known" values such as the logger and verbosity level.

You can obtain a value from the data using the #get method. Additionally, convenience methods are provided for many of the well-known keys. For instance, you can call #verbosity to obtain the value for the key Key::VERBOSITY. Finally, flags and positional arguments that store their data here will also typically generate convenience methods. For example, an argument with key :abc will add a method called abc that you can call to get the value.

By convention, flags and arguments defined by your tool should use strings or symbols as keys. Keys that are not strings or symbols should either be well-known keys such as Key::VERBOSITY, or should be used for internal private information needed by middleware and mixins. The module Key defines a number of well-known keys as constants.

Direct Known Subclasses

Tool

Defined Under Namespace

Modules: Key

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.exit(code = 0) ⇒ void

This method returns an undefined value.

Exit immediately with the given status code. This class method can be called if the instance method is or could be replaced by the tool.

Parameters:

  • code (Integer) (defaults to: 0) —

    The status code, which should be 0 for no error, or nonzero for an error condition. Default is 0. (Note: if a non-integer is passed in, it is changed to -1.)



373
374
375
 
# File 'core-docs/toys/context.rb', line 373

def self.exit(code = 0)
  # Source available in the toys-core gem
end

Instance Method Details

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

Fetch an option or other piece of data by key.

If the get method is overridden by the tool, you can still access it using the name __get or the [] operator.

Parameters:

  • key (Symbol)

Returns:

  • (Object) 


275
276
277
 
# File 'core-docs/toys/context.rb', line 275

def [](key)
  # Source available in the toys-core gem
end

#[]=(key, value) ⇒ Object

Set an option or other piece of context data by key.

Parameters:

  • key (Symbol)
  • value (Object) 


287
288
289
 
# File 'core-docs/toys/context.rb', line 287

def []=(key, value)
  # Source available in the toys-core gem
end

#__exit ⇒ void

This method returns an undefined value.

Exit immediately with the given status code.

If the exit method is overridden by the tool, you can still access it using the name __exit or by calling exit. Source available in the toys-core gem

Parameters:

  • code (Integer) —

    The status code, which should be 0 for no error, or nonzero for an error condition. Default is 0.



362
363
364
 
# File 'core-docs/toys/context.rb', line 362

def exit(code = 0)
  # Source available in the toys-core gem
end

#args ⇒ Array<String> Also known as: __args

The raw arguments passed to the tool, as an array of strings. This does not include the tool name itself.

This is a convenience getter for Toys::Context::Key::ARGS.

If the args method is overridden by the tool, you can still access it using the name __args.

Returns:

  • (Array<String>) 


152
153
154
 
# File 'core-docs/toys/context.rb', line 152

def args
  # Source available in the toys-core gem
end

#cli ⇒ Toys::CLI Also known as: __cli

The currently running CLI.

This is a convenience getter for Toys::Context::Key::CLI.

If the cli method is overridden by the tool, you can still access it using the name __cli.

Returns:



167
168
169
 
# File 'core-docs/toys/context.rb', line 167

def cli
  # Source available in the toys-core gem
end

#context_directory ⇒ String? Also known as: __context_directory

Return the context directory for this tool. Generally, this defaults to the directory containing the toys config directory structure being read, but it may be changed by setting a different context directory for the tool.

This is a convenience getter for Toys::Context::Key::CONTEXT_DIRECTORY.

If the context_directory method is overridden by the tool, you can still access it using the name __context_directory.

Returns:

  • (String) —

    Context directory path

  • (nil) —

    if there is no context.



186
187
188
 
# File 'core-docs/toys/context.rb', line 186

def context_directory
  # Source available in the toys-core gem
end

#exit(code = 0) ⇒ void

This method returns an undefined value.

Exit immediately with the given status code.

If the exit method is overridden by the tool, you can still access it using the name __exit or by calling exit.

Parameters:

  • code (Integer) (defaults to: 0) —

    The status code, which should be 0 for no error, or nonzero for an error condition. Default is 0.



359
360
361
 
# File 'core-docs/toys/context.rb', line 359

def exit(code = 0)
  # Source available in the toys-core gem
end

#find_data(path, type: nil) ⇒ String? Also known as: __find_data

Find the given data file or directory in this tool's search path.

If the find_data method is overridden by the tool, you can still access it using the name __find_data.

Parameters:

  • path (String) —

    The path to find

  • type (nil, :file, :directory) (defaults to: nil) —

    Type of file system object to find, or nil to return any type.

Returns:

  • (String) —

    Absolute path of the result

  • (nil) —

    if the data was not found.



344
345
346
 
# File 'core-docs/toys/context.rb', line 344

def find_data(path, type: nil)
  # Source available in the toys-core gem
end

#logger ⇒ Logger Also known as: __logger

The logger for this execution.

This is a convenience getter for Toys::Context::Key::LOGGER.

If the logger method is overridden by the tool, you can still access it using the name __logger.

Returns:

  • (Logger) 


201
202
203
 
# File 'core-docs/toys/context.rb', line 201

def logger
  # Source available in the toys-core gem
end

#options ⇒ Hash Also known as: __options

The subset of the context that uses string or symbol keys. By convention, this includes keys that are set by tool flags and arguments, but does not include well-known context values such as verbosity or private context values used by middleware or mixins.

If the options method is overridden by the tool, you can still access it using the name __options.

Returns:

  • (Hash) 


326
327
328
 
# File 'core-docs/toys/context.rb', line 326

def options
  # Source available in the toys-core gem
end

#set(key, value) ⇒ self #set(hash) ⇒ self Also known as: __set

Set one or more options or other context data by key.

If the set method is overridden by the tool, you can still access it using the name __set.

Overloads:

  • #set(key, value) ⇒ self

    Set an option or other piece of context data by key.

    Parameters:

    • key (Symbol)
    • value (Object)

    Returns:

    • (self)
  • #set(hash) ⇒ self

    Set multiple content data keys and values

    Parameters:

    • hash (Hash) —

      The keys and values to set

    Returns:

    • (self)

Returns:

  • (self) 


310
311
312
 
# File 'core-docs/toys/context.rb', line 310

def set(key, value = nil)
  # Source available in the toys-core gem
end

#tool_name ⇒ Array<String> Also known as: __tool_name

The full name of the tool being executed, as an array of strings.

This is a convenience getter for Toys::Context::Key::TOOL_NAME.

If the tool_name method is overridden by the tool, you can still access it using the name __tool_name.

Returns:

  • (Array<String>) 


216
217
218
 
# File 'core-docs/toys/context.rb', line 216

def tool_name
  # Source available in the toys-core gem
end

#tool_source ⇒ Toys::SourceInfo Also known as: __tool_source

The source of the tool being executed.

This is a convenience getter for Toys::Context::Key::TOOL_SOURCE.

If the tool_source method is overridden by the tool, you can still access it using the name __tool_source.

Returns:



231
232
233
 
# File 'core-docs/toys/context.rb', line 231

def tool_source
  # Source available in the toys-core gem
end

#usage_errors ⇒ Array<Toys::ArgParser::UsageError> Also known as: __usage_errors

The (possibly empty) array of errors detected during argument parsing.

This is a convenience getter for Toys::Context::Key::USAGE_ERRORS.

If the usage_errors method is overridden by the tool, you can still access it using the name __usage_errors.

Returns:



246
247
248
 
# File 'core-docs/toys/context.rb', line 246

def usage_errors
  # Source available in the toys-core gem
end

#verbosity ⇒ Integer Also known as: __verbosity

The current verbosity setting as an integer.

This is a convenience getter for Toys::Context::Key::VERBOSITY.

If the verbosity method is overridden by the tool, you can still access it using the name __verbosity.

Returns:

  • (Integer) 


261
262
263
 
# File 'core-docs/toys/context.rb', line 261

def verbosity
  # Source available in the toys-core gem
end