Module: Toys::DSL::Tool

Defined in:
core-docs/toys/dsl/tool.rb

Overview

This module defines the DSL for a Toys source.

A Toys source defines one or more named tools. It provides syntax for setting the description, defining flags and arguments, specifying how to execute the tool, and requesting mixin modules and other services. It also lets you define subtools, nested arbitrarily deep, using blocks.

Simple example

Create a file called .toys.rb in the current directory, with the following contents:

tool "greet" do
  desc "Prints a simple greeting"

  optional_arg :recipient, default: "world"

  def run
    puts "Hello, #{recipient}!"
  end
end

The DSL directives tool, desc, optional_arg, and others are defined in this module.

Now you can execute it using:

toys greet

or try:

toys greet rubyists

Defined in the toys-core gem

Instance Method Summary collapse

Instance Method Details

#acceptor(name, spec = nil, type_desc: nil, &block) ⇒ self

Create a named acceptor that can be referenced by name from any flag or positional argument in this tool or its subtools.

An acceptor validates the string parameter passed to a flag or positional argument. It also optionally converts the string to a different object before storing it in your tool's data.

Acceptors can be defined in one of four ways.

  • You can provide a regular expression. This acceptor validates only if the regex matches the entire string parameter.

    You can also provide an optional conversion function as a block. If provided, function must take a variable number of arguments, the first being the matched string and the remainder being the captures from the regular expression. It should return the converted object that will be stored in the context data. If you do not provide a block, the original string will be used.

  • You can provide an array of possible values. The acceptor validates if the string parameter matches the string form of one of the array elements (i.e. the results of calling to_s on the array elements.)

    An array acceptor automatically converts the string parameter to the actual array element that it matched. For example, if the symbol :foo is in the array, it will match the string "foo", and then store the symbol :foo in the tool data.

  • You can provide a range of possible values, along with a conversion function that converts a string parameter to a type comparable by the range. (See the "function" spec below for a detailed description of conversion functions.) If the range has numeric endpoints, the conversion function is optional because a default will be provided.

  • You can provide a function by passing it as a proc or a block. This function performs both validation and conversion. It should take the string parameter as its argument, and it must either return the object that should be stored in the tool data, or raise an exception (descended from StandardError) to indicate that the string parameter is invalid.

Example

The following example creates an acceptor named "hex" that is defined via a regular expression. It uses the acceptor to validate values passed to a flag.

tool "example" do
  acceptor "hex", /[0-9a-fA-F]+/, type_desc: "hex numbers"
  flag :number, accept: "hex"
  def run
    puts "number was #{number}"
  end
end

Parameters:

  • name (String) —

    The acceptor name.

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

    See the description for recognized values.

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

    Type description string, shown in help. Defaults to the acceptor name.

  • block (Proc) —

    See the description for recognized forms.

Returns:

  • (self) 


105
106
107
 
# File 'core-docs/toys/dsl/tool.rb', line 105

def acceptor(name, spec = nil, type_desc: nil, &block)
  # Source available in the toys-core gem
end

#all_required(desc: nil, long_desc: nil, name: nil, report_collisions: true, prepend: false, &block) ⇒ self

Create a flag group of type :required. If a block is given, flags defined in the block belong to the group. All flags in this group are required.

Example

The following example creates a group of required flags.

tool "login" do
  all_required do
    flag :username, "--username=VAL", desc: "Set username (required)"
    flag :password, "--password=VAL", desc: "Set password (required)"
  end
  # ...
end

Parameters:

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

    Short description for the group. See #desc for a description of allowed formats. Defaults to "Flags".

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

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

  • name (String, Symbol, nil) (defaults to: nil) —

    The name of the group, or nil for no name.

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

    If true, raise an exception if a the given name is already taken. If false, ignore. Default is true.

  • prepend (boolean) (defaults to: false) —

    If true, prepend rather than append the group to the list. Default is false.

  • block (Proc) —

    Adds flags to the group. See FlagGroup for the directives that can be called in this block. That object is set as self within the block, and is also passed to the block as an optional argument.

Returns:

  • (self) 


647
648
649
650
 
# File 'core-docs/toys/dsl/tool.rb', line 647

def all_required(desc: nil, long_desc: nil, name: nil, report_collisions: true,
                 prepend: false, &block)
  # Source available in the toys-core gem
end

#at_least_one(desc: nil, long_desc: nil, name: nil, report_collisions: true, prepend: false, &block) ⇒ self Also known as: at_least_one_required

Create a flag group of type :at_least_one. If a block is given, flags defined in the block belong to the group. At least one flag in this group must be provided on the command line.

Example

The following example creates a group of flags in which one or more may be set.

tool "run-tests" do
  at_least_one do
    flag :unit, desc: "Run unit tests"
    flag :integration, desc: "Run integration tests"
    flag :performance, desc: "Run performance tests"
  end
  # ...
end

Parameters:

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

    Short description for the group. See #desc for a description of allowed formats. Defaults to "Flags".

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

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

  • name (String, Symbol, nil) (defaults to: nil) —

    The name of the group, or nil for no name.

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

    If true, raise an exception if a the given name is already taken. If false, ignore. Default is true.

  • prepend (boolean) (defaults to: false) —

    If true, prepend rather than append the group to the list. Default is false.

  • block (Proc) —

    Adds flags to the group. See FlagGroup for the directives that can be called in this block. That object is set as self within the block, and is also passed to the block as an optional argument.

Returns:

  • (self) 


736
737
738
739
 
# File 'core-docs/toys/dsl/tool.rb', line 736

def at_least_one(desc: nil, long_desc: nil, name: nil, report_collisions: true,
                 prepend: false, &block)
  # Source available in the toys-core gem
end

#at_most_one(desc: nil, long_desc: nil, name: nil, report_collisions: true, prepend: false, &block) ⇒ self Also known as: at_most_one_required

Create a flag group of type :at_most_one. If a block is given, flags defined in the block belong to the group. At most one flag in this group may be provided on the command line.

Example

The following example creates a group of flags in which either one or none may be set, but not more than one.

tool "provision-server" do
  at_most_one do
    flag :restore_from_backup, "--restore-from-backup=VAL"
    flag :restore_from_image, "--restore-from-image=VAL"
    flag :clone_existing, "--clone-existing=VAL"
  end
  # ...
end

Parameters:

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

    Short description for the group. See #desc for a description of allowed formats. Defaults to "Flags".

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

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

  • name (String, Symbol, nil) (defaults to: nil) —

    The name of the group, or nil for no name.

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

    If true, raise an exception if a the given name is already taken. If false, ignore. Default is true.

  • prepend (boolean) (defaults to: false) —

    If true, prepend rather than append the group to the list. Default is false.

  • block (Proc) —

    Adds flags to the group. See FlagGroup for the directives that can be called in this block. That object is set as self within the block, and is also passed to the block as an optional argument.

Returns:

  • (self) 


691
692
693
694
 
# File 'core-docs/toys/dsl/tool.rb', line 691

def at_most_one(desc: nil, long_desc: nil, name: nil, report_collisions: true,
                prepend: false, &block)
  # Source available in the toys-core gem
end

#complete_tool_args(spec = nil, **options, &block) ⇒ self

Set the shell completion strategy for this tool's arguments. You can pass one of the following:

Example

The namespace "foo" supports completion only of subtool names. It does not complete the standard flags (like --help).

tool "foo" do
  complete_tool_args complete_args: false, complete_flags: false,
                     complete_flag_values: false
  tool "bar" do
    def run
      puts "in foo bar"
    end
  end
end

Parameters:

  • spec (Object) (defaults to: nil)
  • options (Hash)
  • block (Proc)

Returns:

  • (self) 


1417
1418
1419
 
# File 'core-docs/toys/dsl/tool.rb', line 1417

def complete_tool_args(spec = nil, **options, &block)
  # Source available in the toys-core gem
end

#completion(name, spec = nil, **options, &block) ⇒ self

Create a named completion procedure that may be used by name by any flag or positional arg in this tool or any subtool.

A completion controls tab completion for the value of a flag or positional argument. In general, it is a Ruby Proc that takes a context object (of type Completion::Context) and returns an array of completion candidate strings.

Completions can be specified in one of three ways.

  • A Proc object itself, either passed directly to this directive or provided as a block.
  • A static array of strings, indicating the completion candidates independent of context.
  • The symbol :file_system which indicates that paths in the file system should serve as completion candidates.

Example

The following example defines a completion that uses only the immediate files in the current directory as candidates. (This is different from the :file_system completion which will descend into subdirectories similar to how bash completes most of its file system commands.)

completion "local-files" do |_context|
  `/bin/ls`.split("\n")
end
tool "example" do
  flag :file, complete_values: "local-files"
  def run
    puts "selected file #{file}"
  end
end

Parameters:

  • name (String) —

    Name of the completion

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

    See the description for recognized values.

  • options (Hash) —

    Additional options to pass to the completion.

  • block (Proc) —

    See the description for recognized forms.

Returns:

  • (self) 


252
253
254
 
# File 'core-docs/toys/dsl/tool.rb', line 252

def completion(name, spec = nil, **options, &block)
  # Source available in the toys-core gem
end

#context_directory ⇒ String?

Return the context directory for this tool. Generally, this is set to the directory containing the toys tool directory structure being read, but it may be unset (nil) if the tool was not loaded from a normal tool file. It may also be changed by the tool definition itself.

Returns:

  • (String) —

    Context directory path

  • (nil) —

    if there is no context directory



1661
1662
1663
 
# File 'core-docs/toys/dsl/tool.rb', line 1661

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

#current_tool ⇒ Toys::ToolDefinition

Return the current tool definition. This object can be queried to determine such information as the name, but it should not be altered.

Returns:



1671
1672
1673
 
# File 'core-docs/toys/dsl/tool.rb', line 1671

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

#delegate_to(target) ⇒ self

Causes the current tool to delegate to another tool, specified by the full tool name. When run, it simply invokes the target tool with the same arguments.

Example

This example defines a tool that runs one of its subtools. Running the test tool will have the same effect (and recognize the same args) as the subtool test unit.

tool "test" do
  tool "unit" do
    flag :faster
    def run
      puts "running tests..."
    end
  end
  delegate_to "test:unit"
end

Parameters:

  • target (String, Array<String>) —

    The full path to the delegate tool. This path may be given as an array of strings, or a single string possibly delimited by path separators.

Returns:

  • (self) 


337
338
339
 
# File 'core-docs/toys/dsl/tool.rb', line 337

def delegate_to(target)
  # Source available in the toys-core gem
end

#desc(str) ⇒ self Also known as: short_desc

Set the short description for the current tool. The short description is displayed with the tool in a subtool list. You may also use the equivalent method short_desc.

The description is a WrappableString, which may be word-wrapped when displayed in a help screen. You may pass a WrappableString directly to this method, or you may pass any input that can be used to construct a wrappable string:

  • If you pass a String, its whitespace will be compacted (i.e. tabs, newlines, and multiple consecutive whitespace will be turned into a single space), and it will be word-wrapped on whitespace.
  • If you pass an Array of Strings, each string will be considered a literal word that cannot be broken, and wrapping will be done across the strings in the array. In this case, whitespace is not compacted.

Examples

If you pass in a sentence as a simple string, it may be word wrapped when displayed:

desc "This sentence may be wrapped."

To specify a sentence that should never be word-wrapped, pass it as the sole element of a string array:

desc ["This sentence will not be wrapped."]

Parameters:

Returns:

  • (self) 


527
528
529
 
# File 'core-docs/toys/dsl/tool.rb', line 527

def desc(str)
  # Source available in the toys-core gem
end

#disable_argument_parsing ⇒ self

Disable argument parsing for this tool. Arguments will not be parsed and the options will not be populated. Instead, tools can retrieve the full unparsed argument list by calling Context#args.

This directive is mutually exclusive with any of the directives that declare arguments or flags.

Example

tool "mytool" do
  disable_argument_parsing
  def run
    puts "Arguments passed: #{args}"
  end
end

Returns:

  • (self) 


1355
1356
1357
 
# File 'core-docs/toys/dsl/tool.rb', line 1355

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

#disable_flag(*flags) ⇒ self

Mark one or more flags as disabled, preventing their use by any subsequent flag definition. This can be used to prevent middleware from defining a particular flag.

Example

This tool does not support the -v and -q short forms for the two verbosity flags (although it still supports the long forms --verbose and --quiet.)

tool "mytool" do
  disable_flag "-v", "-q"
  def run
    # ...
  end
end

Parameters:

  • flags (String...) —

    The flags to disable

Returns:

  • (self) 


1380
1381
1382
 
# File 'core-docs/toys/dsl/tool.rb', line 1380

def disable_flag(*flags)
  # Source available in the toys-core gem
end

#enforce_flags_before_args(state = true) ⇒ self

Enforce that all flags must be provided before any positional args. That is, as soon as the first positional arg appears in the command line arguments, flag parsing is disabled as if -- had appeared.

Issuing this directive by itself turns on enforcement. You may turn it off by passing false as the parameter.

Parameters:

  • state (boolean) (defaults to: true)

Returns:

  • (self) 


1280
1281
1282
 
# File 'core-docs/toys/dsl/tool.rb', line 1280

def enforce_flags_before_args(state = true)
  # Source available in the toys-core gem
end

#exactly_one(desc: nil, long_desc: nil, name: nil, report_collisions: true, prepend: false, &block) ⇒ self Also known as: exactly_one_required

Create a flag group of type :exactly_one. If a block is given, flags defined in the block belong to the group. Exactly one flag in this group must be provided on the command line.

Example

The following example creates a group of flags in which exactly one must be set.

tool "deploy" do
  exactly_one do
    flag :server, "--server=IP_ADDR", desc: "Deploy to server"
    flag :vm, "--vm=ID", desc: "Deploy to a VM"
    flag :container, "--container=ID", desc: "Deploy to a container"
  end
  # ...
end

Parameters:

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

    Short description for the group. See #desc for a description of allowed formats. Defaults to "Flags".

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

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

  • name (String, Symbol, nil) (defaults to: nil) —

    The name of the group, or nil for no name.

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

    If true, raise an exception if a the given name is already taken. If false, ignore. Default is true.

  • prepend (boolean) (defaults to: false) —

    If true, prepend rather than append the group to the list. Default is false.

  • block (Proc) —

    Adds flags to the group. See FlagGroup for the directives that can be called in this block. That object is set as self within the block, and is also passed to the block as an optional argument.

Returns:

  • (self) 


781
782
783
784
 
# File 'core-docs/toys/dsl/tool.rb', line 781

def exactly_one(desc: nil, long_desc: nil, name: nil, report_collisions: true,
                prepend: false, &block)
  # Source available in the toys-core gem
end

#expand(template_class, *args, **kwargs) ⇒ self

Expand the given template in the current location.

The template may be specified as a class or a well-known template name. You may also provide arguments to pass to the template.

Example

The following example creates and uses a simple template.

template "hello-generator" do
  def initialize(name, message)
    @name = name
    @message = message
  end
  attr_reader :name, :message
  expansion do |template|
    tool template.name do
      to_run do
        puts template.message
      end
    end
  end
end

expand "hello-generator", "mytool", "mytool is running!"

Parameters:

  • template_class (Class, String, Symbol) —

    The template, either as a class or a well-known name.

  • args (Object...) —

    Template arguments

Returns:

  • (self) 


490
491
492
 
# File 'core-docs/toys/dsl/tool.rb', line 490

def expand(template_class, *args, **kwargs)
  # Source available in the toys-core gem
end

#find_data(path, type: nil) ⇒ String?

Find the given data path (file or directory).

Data directories are a convenient place to put images, archives, keys, or other such static data needed by your tools. Data files are located in a directory called .data inside a Toys directory. This directive locates a data file during tool definition.

Example

This tool reads its description from a text file in the .data directory.

tool "mytool" do
  path = find_data("mytool-desc.txt", type: :file)
  desc IO.read(path) if path
  def run
    # ...
  end
end

Parameters:

  • path (String) —

    The path to find

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

    Type of file system object to find. Default is nil, indicating any type.

Returns:

  • (String) —

    Absolute path of the data.

  • (nil) —

    if the given data path is not found.



1648
1649
1650
 
# File 'core-docs/toys/dsl/tool.rb', line 1648

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

#flag(key, *flags, accept: nil, default: nil, handler: nil, complete_flags: nil, complete_values: nil, report_collisions: true, group: nil, desc: nil, long_desc: nil, display_name: nil, add_method: nil, &block) ⇒ self

Add a flag to the current tool. Each flag must specify a key which the script may use to obtain the flag value from the context. You may then provide the flags themselves in OptionParser form.

If the given key is a symbol representing a valid method name, then a helper method is automatically added to retrieve the value. Otherwise, if the key is a string or does not represent a valid method name, the tool can retrieve the value by calling Context#get.

Attributes of the flag may be passed in as arguments to this method, or set in a block passed to this method. If you provide a block, you can use directives in Flag within the block.

Flag syntax

The flags themselves should be provided in OptionParser form. Following are examples of valid syntax.

  • -a : A short boolean switch. When this appears as an argument, the value is set to true.
  • --abc : A long boolean switch. When this appears as an argument, the value is set to true.
  • -aVAL or -a VAL : A short flag that takes a required value. These two forms are treated identically. If this argument appears with a value attached (e.g. -afoo), the attached string (e.g. "foo") is taken as the value. Otherwise, the following argument is taken as the value (e.g. for -a foo, the value is set to "foo".) The following argument is treated as the value even if it looks like a flag (e.g. -a -a causes the string "-a" to be taken as the value.)
  • -a[VAL] : A short flag that takes an optional value. If this argument appears with a value attached (e.g. -afoo), the attached string (e.g. "foo") is taken as the value. Otherwise, the value is set to true. The following argument is never interpreted as the value. (Compare with -a [VAL].)
  • -a [VAL] : A short flag that takes an optional value. If this argument appears with a value attached (e.g. -afoo), the attached string (e.g. "foo") is taken as the value. Otherwise, if the following argument does not look like a flag (i.e. it does not begin with a hyphen), it is taken as the value. (e.g. -a foo causes the string "foo" to be taken as the value.). If there is no following argument, or the following argument looks like a flag, the value is set to true. (Compare with -a[VAL].)
  • --abc=VAL or --abc VAL : A long flag that takes a required value. These two forms are treated identically. If this argument appears with a value attached (e.g. --abc=foo), the attached string (e.g. "foo") is taken as the value. Otherwise, the following argument is taken as the value (e.g. for --abc foo, the value is set to "foo".) The following argument is treated as the value even if it looks like a flag (e.g. --abc --def causes the string "--def" to be taken as the value.)
  • --abc[=VAL] : A long flag that takes an optional value. If this argument appears with a value attached (e.g. --abc=foo), the attached string (e.g. "foo") is taken as the value. Otherwise, the value is set to true. The following argument is never interpreted as the value. (Compare with --abc [VAL].)
  • --abc [VAL] : A long flag that takes an optional value. If this argument appears with a value attached (e.g. --abc=foo), the attached string (e.g. "foo") is taken as the value. Otherwise, if the following argument does not look like a flag (i.e. it does not begin with a hyphen), it is taken as the value. (e.g. --abc foo causes the string "foo" to be taken as the value.). If there is no following argument, or the following argument looks like a flag, the value is set to true. (Compare with --abc=[VAL].)
  • --[no-]abc : A long boolean switch that can be turned either on or off. This effectively creates two flags, --abc which sets the value to true, and --no-abc which sets the falue to false.

Default flag syntax

If no flag syntax strings are provided, a default syntax will be inferred based on the key and other options.

Specifically, if the key has one character, then that character will be chosen as a short flag. If the key has multiple characters, a long flag will be generated.

Furthermore, if a custom completion, a non-boolean acceptor, or a non-boolean default value is provided in the options, then the flag will be considered to take a value. Otherwise, it will be considered to be a boolean switch.

For example, the following pairs of flags are identical:

flag :a
flag :a, "-a"

flag :abc_def
flag :abc_def, "--abc-def"

flag :number, accept: Integer
flag :number, "--number=VAL", accept: Integer

More examples

A flag that sets its value to the number of times it appears on the command line:

flag :verbose, "-v", "--verbose",
     default: 0, handler: ->(_val, count) { count + 1 }

An example using block form:

flag :shout do
  flags "-s", "--shout"
  default false
  desc "Say it louder"
  long_desc "This flag says it lowder.",
            "You might use this when people can't hear you.",
            "",
            "Example:",
            ["    toys say --shout hello"]
end

Parameters:

  • key (String, Symbol) —

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

  • flags (String...) —

    The flags in OptionParser format.

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

    An acceptor that validates and/or converts the value. You may provide either the name of an acceptor you have defined, one of the default acceptors provided by OptionParser, or any other specification recognized by Acceptor.create. Optional. If not specified, accepts any value as a string.

  • 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 that customizes how a value is set or updated when the flag is parsed. A handler is a proc that takes up to three arguments: the given value, the previous value, and a hash containing all the data collected so far during argument parsing. The proc must return the new value for the flag. You may also specify a predefined named handler. The :set handler (the default) replaces the previous value (effectively -> (val) { 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 the default value to [] 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 Flag::DefaultCompletion is used, which provides the flag's names as completion candidates. To customize completion, set this to the name of a previously defined completion, a hash of options to pass to the constructor for Flag::DefaultCompletion, or 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. This is the empty completion by default. To customize completion, set this to the name of a previously defined completion, or 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 unusable. Default is true.

  • group (Toys::FlagGroup, String, Symbol, nil) (defaults to: nil) —

    Group for this flag. You may provide a group name, a FlagGroup object, or nil which denotes the default group.

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

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

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

    Long description for the flag. See #long_desc for a description of the allowed formats. (But note that this param takes an Array of description lines, rather than a series of arguments.) Defaults to the empty array.

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

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

  • add_method (true, false, nil) (defaults to: nil) —

    Whether to add a method for this flag. If omitted or set to nil, uses the default behavior, which adds the method if the key is a symbol representing a legal method name that starts with a letter and does not override any public method in the Ruby Object class or collide with any method directly defined in the tool class.

  • block (Proc) —

    Configures the flag. See Flag for the directives that can be called in this block. That object is set as self within the block, and is also passed to the block as an optional argument.

Returns:

  • (self) 


965
966
967
968
969
970
971
972
 
# File 'core-docs/toys/dsl/tool.rb', line 965

def flag(key, *flags,
         accept: nil, default: nil, handler: nil,
         complete_flags: nil, complete_values: nil,
         report_collisions: true, group: nil,
         desc: nil, long_desc: nil, display_name: nil, add_method: nil,
         &block)
  # Source available in the toys-core gem
end

#flag_group(type: :optional, desc: nil, long_desc: nil, name: nil, report_collisions: true, prepend: false, &block) ⇒ self

Create a flag group. If a block is given, flags defined in the block belong to the group. The flags in the group are listed together in help screens.

Example

The following example creates a flag group in which all flags are optional.

tool "execute" do
  flag_group desc: "Debug Flags" do
    flag :debug, "-D", desc: "Enable debugger"
    flag :warnings, "-W[VAL]", desc: "Enable warnings"
  end
  # ...
end

Parameters:

  • type (Symbol) (defaults to: :optional) —

    The type of group. Allowed values: :required, :optional, :exactly_one, :at_most_one, :at_least_one. Default is :optional.

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

    Short description for the group. See #desc for a description of allowed formats. Defaults to "Flags".

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

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

  • name (String, Symbol, nil) (defaults to: nil) —

    The name of the group, or nil for no name.

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

    If true, raise an exception if a the given name is already taken. If false, ignore. Default is true.

  • prepend (boolean) (defaults to: false) —

    If true, prepend rather than append the group to the list. Default is false.

  • block (Proc) —

    Adds flags to the group. See FlagGroup for the directives that can be called in this block. That object is set as self within the block, and is also passed to the block as an optional argument.

Returns:

  • (self) 


605
606
607
608
 
# File 'core-docs/toys/dsl/tool.rb', line 605

def flag_group(type: :optional, desc: nil, long_desc: nil, name: nil,
               report_collisions: true, prepend: false, &block)
  # Source available in the toys-core gem
end

#include(mixin, *args, **kwargs) ⇒ self

Specify that the given module should be mixed into this tool, and its methods made available when running the tool.

You can provide either a module, the string name of a mixin that you have defined in this tool or one of its ancestors, or the symbol name of a well-known mixin.

The standard Ruby Module#include method can be invoked by calling include_module instead of include.

Example

Include the well-known mixin :terminal and perform some terminal magic.

tool "spin" do
  include :terminal
  def run
    # The spinner method is defined by the :terminal mixin.
    (leading_text: "Waiting...", final_text: "\n") do
      sleep 5
    end
  end
end

Parameters:

  • mixin (Module, Symbol, String) —

    Module or module name.

  • args (Object...) —

    Arguments to pass to the initializer

  • kwargs (keywords) —

    Keyword arguments to pass to the initializer

Returns:

  • (self) 


1592
1593
1594
 
# File 'core-docs/toys/dsl/tool.rb', line 1592

def include(mixin, *args, **kwargs)
  # Source available in the toys-core gem
end

#include?(mod) ⇒ boolean

Determine if the given module/mixin has already been included.

You can provide either a module, the string name of a mixin that you have defined in this tool or one of its ancestors, or the symbol name of a well-known mixin.

Parameters:

  • mod (Module, Symbol, String) —

    Module or module name.

Returns:

  • (boolean) —

    Whether the mixin is included



1607
1608
1609
 
# File 'core-docs/toys/dsl/tool.rb', line 1607

def include?(mod)
  # Source available in the toys-core gem
end

#inheritable_helper_methods(val) ⇒ self

Set whether this tool's helper methods are inherited by subtools.

Parameters:

  • val (true, false, nil) —

    The boolean value. Setting to nil unsets the value, causing it to revert to the setting of the parent tool if any, or false for the root tool.

Returns:

  • (self) 


1758
1759
1760
 
# File 'core-docs/toys/dsl/tool.rb', line 1758

def inheritable_helper_methods(val)
  # Source available in the toys-core gem
end

#load(path, context_directory: nil, as: nil) ⇒ self

Load another tool file or directory, as if its contents were inserted at the current location.

Note that this directive has restrictions within a #subtool_apply block. See the #subtool_apply documentation for details.

Parameters:

  • path (String) —

    The file or directory to load.

  • context_directory (String, Pathname, nil) (defaults to: nil) —

    The context directory path for tools loaded from this source. Optional. If not provided, defaults to the context directory for the surrounding source. Context directory paths should generally be absolute. Relative paths will be converted to absolute, using the current working directory at the time of loading.

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

    Load into the given tool/namespace, relative to the current namespace. If omitted, tools will be loaded into the current namespace.

Returns:

  • (self) 


361
362
363
364
365
 
# File 'core-docs/toys/dsl/tool.rb', line 361

def load(path,
         context_directory: nil,
         as: nil)
  # Source available in the toys-core gem
end

#load_gem(name, *versions, version: nil, path: nil, toys_dir: nil, context_directory: nil, on_missing: nil, default_confirm: nil, as: nil) ⇒ self

Load tools from a gem, as if its contents were inserted at the current location.

Note that this directive has restrictions within a #subtool_apply block. See the #subtool_apply documentation for details.

Parameters:

  • name (String) —

    Name of the gem

  • versions (Array<String>) —

    Version requirements for the gem.

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

    An alternate way to specify version requirements for the gem.

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

    Optional path within the gem to the file or directory to load. Defaults to the root of the gem's toys directory.

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

    Optional override for the gem's toys directory name. If not specified, the default specified by the gem will be used (normally "toys").

  • context_directory (String, Pathname, nil) (defaults to: nil) —

    The context directory path for tools loaded from this source. Optional. If not provided, defaults to the context directory for the surrounding source. Context directory paths should generally be absolute. Relative paths will be converted to absolute, using the current working directory at the time of loading.

  • on_missing (:confirm, :error, :install) (defaults to: nil) —

    What to do if the requested gem is not installed. Possible values:

    • :confirm - prompt the user on whether to install
    • :error - raise an exception
    • :install - just install the gem

    Defaults to the setting in the Utils::Gems utility used to activate the gem (usually :confirm).

  • default_confirm (boolean) (defaults to: nil) —

    The default confirmation result, if on_missing is set to :confirm. Defaults to the setting in the Utils::Gems utility used to activate the gem (usually true).

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

    Load into the given tool/namespace, relative to the current namespace. If omitted, tools will be loaded into the current namespace.

Returns:

  • (self) 


447
448
449
450
451
452
453
454
455
456
 
# File 'core-docs/toys/dsl/tool.rb', line 447

def load_gem(name, *versions,
             version: nil,
             path: nil,
             toys_dir: nil,
             context_directory: nil,
             on_missing: nil,
             default_confirm: nil,
             as: nil)
  # Source available in the toys-core gem
end

#load_git(remote: nil, path: nil, commit: nil, update: false, context_directory: nil, as: nil) ⇒ self

Load tools from a public git repository, as if its contents were inserted at the current location.

Note that this directive has restrictions within a #subtool_apply block. See the #subtool_apply documentation for details.

Parameters:

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

    The URL of the git repository. Defaults to the current repository if already loading from git.

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

    The path within the repo to the file or directory to load. Defaults to the root of the repo.

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

    The commit branch, tag, or sha. Defaults to the current commit if already loading from git, or to HEAD.

  • update (boolean, Integer) (defaults to: false) —

    Whether and when to force-fetch from the remote (unless the commit is a SHA). Force-fetching will ensure that symbolic commits, such as branch names or HEAD, are up to date. You can pass true or false to specify whether to update, or an integer to update if the last update was done at least that many seconds ago. Default is false.

  • context_directory (String, Pathname, nil) (defaults to: nil) —

    The context directory path for tools loaded from this source. Optional. If not provided, defaults to the context directory for the surrounding source. Context directory paths should generally be absolute. Relative paths will be converted to absolute, using the current working directory at the time of loading.

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

    Load into the given tool/namespace, relative to the current namespace. If omitted, tools will be loaded into the current namespace.

Returns:

  • (self) 


398
399
400
401
402
403
404
405
 
# File 'core-docs/toys/dsl/tool.rb', line 398

def load_git(remote: nil,
             path: nil,
             commit: nil,
             update: false,
             context_directory: nil,
             as: nil)
  # Source available in the toys-core gem
end

#long_desc(*strs, file: nil, data: nil) ⇒ self

Add to the long description for the current tool. The long description is displayed in the usage documentation for the tool itself. This directive may be given multiple times, and the results are cumulative.

A long description is a series of descriptions, which are generally displayed in a series of lines/paragraphs. Each individual description uses the form described in the #desc documentation, and may be word-wrapped when displayed. To insert a blank line, include an empty string as one of the descriptions.

Example

long_desc "This initial paragraph might get word wrapped.",
          "This next paragraph is followed by a blank line.",
          "",
          ["This line will not be wrapped."],
          ["    This indent is preserved."]
long_desc "This line is appended to the description."

Parameters:

  • strs (Toys::WrappableString, String, Array<String>...)
  • file (String) (defaults to: nil) —

    Optional. Read the description from the given file provided relative to the directory containing the current toys file. The file must be a plain text file whose suffix is .txt.

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

    Optional. Read the description from the given data file. The file must be a plain text file whose suffix is .txt.

Returns:

  • (self) 


560
561
562
 
# File 'core-docs/toys/dsl/tool.rb', line 560

def long_desc(*strs, file: nil, data: nil)
  # Source available in the toys-core gem
end

#mixin(name, mixin_module = nil, &block) ⇒ self

Create a named mixin module that can be included by name from this tool or its subtools.

A mixin is a module that defines methods that can be called from a tool. It is commonly used to provide "utility" methods, implementing common functionality and allowing tools to share code.

Normally you provide a block and define the mixin's methods in that block. Alternatively, you can create a module separately and pass it directly to this directive.

Example

The following example creates a named mixin and uses it in a tool.

mixin "error-reporter" do
  def error message
    logger.error "An error occurred: #{message}"
    exit 1
  end
end

tool "build" do
  include "error-reporter"
  def run
    puts "Building..."
    error "Build failed!"
  end
end

Parameters:

  • name (String) —

    Name of the mixin

  • mixin_module (Module) (defaults to: nil) —

    Module to use as the mixin. Optional. Either pass a module here, or provide a block and define the mixin within the block.

  • block (Proc) —

    Defines the mixin module.

Returns:

  • (self) 


147
148
149
 
# File 'core-docs/toys/dsl/tool.rb', line 147

def mixin(name, mixin_module = nil, &block)
  # Source available in the toys-core gem
end

#on_interrupt(handler = nil, &block) ⇒ self

Specify how to handle interrupts.

You can provide either a block to be called, a Proc to be called, or the name of a method to be called. In each case, the block, Proc, or method can optionally take one argument, the Interrupt exception that was raised.

Note: this is equivalent to on_signal("SIGINT").

Example

tool "foo" do
  def run
    sleep 10
  end
  on_interrupt do
    puts "I was interrupted."
  end
end

Parameters:

  • handler (Proc, Symbol, nil) (defaults to: nil) —

    The callback proc or method name. Pass nil to disable interrupt handling.

  • block (Proc) —

    The callback as a block.

Returns:

  • (self) 


1499
1500
1501
 
# File 'core-docs/toys/dsl/tool.rb', line 1499

def on_interrupt(handler = nil, &block)
  # Source available in the toys-core gem
end

#on_signal(signal, handler = nil, &block) ⇒ self

Specify how to handle the given signal.

You can provide either a block to be called, a Proc to be called, or the name of a method to be called. In each case, the block, Proc, or method can optionally take one argument, the SignalException that was raised.

Example

tool "foo" do
  def run
    sleep 10
  end
  on_signal("QUIT") do |e|
    puts "Signal caught: #{e.signm}."
  end
end

Parameters:

  • signal (Integer, String, Symbol) —

    The signal name or number

  • handler (Proc, Symbol, nil) (defaults to: nil) —

    The callback proc or method name. Pass nil to disable signal handling.

  • block (Proc) —

    The callback as a block.

Returns:

  • (self) 


1528
1529
1530
 
# File 'core-docs/toys/dsl/tool.rb', line 1528

def on_signal(signal, handler = nil, &block)
  # Source available in the toys-core gem
end

#on_usage_error(handler = nil, &block) ⇒ self

Specify how to handle usage errors.

You can provide either a block to be called, a Proc to be called, or the name of a method to be called. In each case, the block, Proc, or method can optionally take one argument, the array of usage errors reported.

Example

This tool runs even if a usage error is encountered, by setting the run method as the usage error handler.

tool "foo" do
  def run
    puts "Errors: #{usage_errors.join("\n")}"
  end
  on_usage_error :run
end

Parameters:

  • handler (Proc, Symbol, nil) (defaults to: nil) —

    The callback proc or method name. Pass nil to disable usage error handling.

  • block (Proc) —

    The callback as a block.

Returns:

  • (self) 


1557
1558
1559
 
# File 'core-docs/toys/dsl/tool.rb', line 1557

def on_usage_error(handler = nil, &block)
  # Source available in the toys-core gem
end

#optional_arg(key, default: nil, accept: nil, complete: nil, display_name: nil, desc: nil, long_desc: nil, add_method: nil, &block) ⇒ self Also known as: optional

Add an optional positional argument to the current tool. You must specify a key which the script may use to obtain the argument value from the context. If an optional argument is not given on the command line, the value is set to the given default.

If the given key is a symbol representing a valid method name, then a helper method is automatically added to retrieve the value. Otherwise, if the key is a string or does not represent a valid method name, the tool can retrieve the value by calling Context#get.

Attributes of the arg may be passed in as arguments to this method, or set in a block passed to this method. If you provide a block, you can use directives in PositionalArg within the block.

It is legal to declare a required argument after an optional argument, but at parse time, all required arguments are parsed first, followed by optional arguments. Thus, it is generally recommended to declare them in that order to avoid confusion. Within each type, arguments are parsed in the order they are declared.

Example

This tool creates a "link" to a given target. The link location is optional; if it is not given, it is inferred from the target.

tool "ln" do
  required_arg :target
  optional_arg :location
  def run
    loc = location || File.basename(target)
    puts "linking to #{target} from #{loc}..."
  end
end

Parameters:

  • key (String, Symbol) —

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

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

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

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

    An acceptor that validates and/or converts the value. You may provide either the name of an acceptor you have defined, one of the default acceptors provided by OptionParser, or any other specification recognized by Acceptor.create. Optional. If not specified, accepts any value as a string.

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

    A specifier for shell tab completion for values of this arg. This is the empty completion by default. To customize completion, set this to the name of a previously defined completion, or any spec recognized by Completion.create.

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

    A name to use for display (in help text and error reports). Defaults to the key in upper case.

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

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

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

    Long description for the argument. See #long_desc for a description of the allowed formats. (But note that this param takes an Array of description lines, rather than a series of arguments.) Defaults to the empty array.

  • add_method (true, false, nil) (defaults to: nil) —

    Whether to add a method for this argument. If omitted or set to nil, uses the default behavior, which adds the method if the key is a symbol representing a legal method name that starts with a letter and does not override any public method in the Ruby Object class or collide with any method directly defined in the tool class.

  • block (Proc) —

    Configures the positional argument. See PositionalArg for the directives that can be called in this block. That object is set as self within the block, and is also passed to the block as an optional argument.

Returns:

  • (self) 


1119
1120
1121
1122
1123
1124
 
# File 'core-docs/toys/dsl/tool.rb', line 1119

def optional_arg(key,
                 default: nil, accept: nil, complete: nil, display_name: nil,
                 desc: nil, long_desc: nil, add_method: nil,
                 &block)
  # Source available in the toys-core gem
end

#remaining_args(key, default: [], accept: nil, complete: nil, display_name: nil, desc: nil, long_desc: nil, add_method: nil, &block) ⇒ self Also known as: remaining

Specify what should be done with unmatched positional arguments. You must specify a key which the script may use to obtain the remaining args from the context.

If the given key is a symbol representing a valid method name, then a helper method is automatically added to retrieve the value. Otherwise, if the key is a string or does not represent a valid method name, the tool can retrieve the value by calling Context#get.

Attributes of the arg may be passed in as arguments to this method, or set in a block passed to this method. If you provide a block, you can use directives in PositionalArg within the block.

Remaining arguments are parsed only after explicit required and optional arguments have been parsed and matched. While it is legal for the remaining_args directive to appear before required_arg or optional_arg directives, it is generally recommended that it appear last in order to avoid confusion.

Example

This tool displays a "list" of the given directories. If no directories ar given, lists the current directory.

tool "ln" do
  remaining_args :directories
  def run
    dirs = directories.empty? ? [Dir.pwd] : directories
    dirs.each do |dir|
      puts "Listing directory #{dir}..."
    end
  end
end

Parameters:

  • key (String, Symbol) —

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

  • default (Object) (defaults to: []) —

    The default value. This is the value that will be set in the context if no unmatched arguments are provided on the command line. Defaults to the empty array [].

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

    An acceptor that validates and/or converts the value. You may provide either the name of an acceptor you have defined, one of the default acceptors provided by OptionParser, or any other specification recognized by Acceptor.create. Optional. If not specified, accepts any value as a string.

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

    A specifier for shell tab completion for values of this arg. This is the empty completion by default. To customize completion, set this to the name of a previously defined completion, or any spec recognized by Completion.create.

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

    A name to use for display (in help text and error reports). Defaults to the key in upper case.

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

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

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

    Long description for the argument. See #long_desc for a description of the allowed formats. (But note that this param takes an Array of description lines, rather than a series of arguments.) Defaults to the empty array.

  • add_method (true, false, nil) (defaults to: nil) —

    Whether to add a method for these arguments. If omitted or set to nil, uses the default behavior, which adds the method if the key is a symbol representing a legal method name that starts with a letter and does not override any public method in the Ruby Object class or collide with any method directly defined in the tool class.

  • block (Proc) —

    Configures the positional argument. See PositionalArg for the directives that can be called in this block. That object is set as self within the block, and is also passed to the block as an optional argument.

Returns:

  • (self) 


1198
1199
1200
1201
1202
1203
 
# File 'core-docs/toys/dsl/tool.rb', line 1198

def remaining_args(key,
                   default: [], accept: nil, complete: nil, display_name: nil,
                   desc: nil, long_desc: nil, add_method: nil,
                   &block)
  # Source available in the toys-core gem
end

#require_exact_flag_match(state = true) ⇒ self

Require that flags must match exactly. That is, flags must appear in their entirety on the command line. (If false, substrings of flags are accepted as long as they are unambiguous.)

Issuing this directive by itself turns on exact match. You may turn it off by passing false as the parameter.

Parameters:

  • state (boolean) (defaults to: true)

Returns:

  • (self) 


1295
1296
1297
 
# File 'core-docs/toys/dsl/tool.rb', line 1295

def require_exact_flag_match(state = true)
  # Source available in the toys-core gem
end

#required_arg(key, accept: nil, complete: nil, display_name: nil, desc: nil, long_desc: nil, add_method: nil, &block) ⇒ self Also known as: required

Add a required positional argument to the current tool. You must specify a key which the script may use to obtain the argument value from the context.

If the given key is a symbol representing a valid method name, then a helper method is automatically added to retrieve the value. Otherwise, if the key is a string or does not represent a valid method name, the tool can retrieve the value by calling Context#get.

Attributes of the arg may be passed in as arguments to this method, or set in a block passed to this method. If you provide a block, you can use directives in PositionalArg within the block.

It is legal to declare a required argument after an optional argument, but at parse time, all required arguments are parsed first, followed by optional arguments. Thus, it is generally recommended to declare them in that order to avoid confusion. Within each type, arguments are parsed in the order they are declared.

Example

This tool "moves" something from a source to destination, and takes two required arguments:

tool "mv" do
  required_arg :source
  required_arg :dest
  def run
    puts "moving from #{source} to #{dest}..."
  end
end

Parameters:

  • key (String, Symbol) —

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

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

    An acceptor that validates and/or converts the value. You may provide either the name of an acceptor you have defined, one of the default acceptors provided by OptionParser, or any other specification recognized by Acceptor.create. Optional. If not specified, accepts any value as a string.

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

    A specifier for shell tab completion for values of this arg. This is the empty completion by default. To customize completion, set this to the name of a previously defined completion, or any spec recognized by Completion.create.

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

    A name to use for display (in help text and error reports). Defaults to the key in upper case.

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

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

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

    Long description for the argument. See #long_desc for a description of the allowed formats. (But note that this param takes an Array of description lines, rather than a series of arguments.) Defaults to the empty array.

  • add_method (true, false, nil) (defaults to: nil) —

    Whether to add a method for this argument. If omitted or set to nil, uses the default behavior, which adds the method if the key is a symbol representing a legal method name that starts with a letter and does not override any public method in the Ruby Object class or collide with any method directly defined in the tool class.

  • block (Proc) —

    Configures the positional argument. See PositionalArg for the directives that can be called in this block. That object is set as self within the block, and is also passed to the block as an optional argument.

Returns:

  • (self) 


1040
1041
1042
1043
1044
1045
 
# File 'core-docs/toys/dsl/tool.rb', line 1040

def required_arg(key,
                 accept: nil, complete: nil, display_name: nil,
                 desc: nil, long_desc: nil, add_method: nil,
                 &block)
  # Source available in the toys-core gem
end

#set(key, value) ⇒ self #set(hash) ⇒ self

Set option values statically without creating helper methods.

Example

tool "hello" do
  set :greeting, "Hi there"
  def run
    puts "#{get(:greeting)}, world!"
  end
end

Overloads:

  • #set(key, value) ⇒ self

    Set a single value by key.

    Parameters:

    • key (String, Symbol) —

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

    • value (Object) —

      The value to set.

    Returns:

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

    Set multiple keys and values

    Parameters:

    • hash (Hash) —

      The keys and values to set

    Returns:

    • (self) 


1265
1266
1267
 
# File 'core-docs/toys/dsl/tool.rb', line 1265

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

#set_context_directory(dir) ⇒ self

Set a custom context directory for this tool.

Parameters:

  • dir (String) —

    Context directory

Returns:

  • (self) 


1681
1682
1683
 
# File 'core-docs/toys/dsl/tool.rb', line 1681

def set_context_directory(dir)
  # Source available in the toys-core gem
end

#source_info ⇒ Toys::SourceInfo

Return the current source info object.

Returns:



1616
1617
1618
 
# File 'core-docs/toys/dsl/tool.rb', line 1616

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

#static(key, value) ⇒ self #static(hash) ⇒ self

Set option values statically and create helper methods.

A helper method will be defined to retrieve the value based on the same logic governing flag and positional argument directives. That is, if the key is a symbol representing a legal method name that starts with a letter and does not override any public method in the Ruby Object class or collide with any method directly defined in the tool class. Otherwise, the value can be retrieved by calling Context#get.

Example

tool "hello" do
  static :greeting, "Hi there"
  def run
    puts "#{greeting}, world!"
  end
end

Overloads:

  • #static(key, value) ⇒ self

    Set a single value by key.

    Parameters:

    • key (String, Symbol) —

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

    • value (Object) —

      The value to set.

    Returns:

    • (self)
  • #static(hash) ⇒ self

    Set multiple keys and values

    Parameters:

    • hash (Hash) —

      The keys and values to set

    Returns:

    • (self) 


1237
1238
1239
 
# File 'core-docs/toys/dsl/tool.rb', line 1237

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

#subtool_apply(&block) ⇒ Object

Applies the given block to all subtools, recursively. Effectively, the given block is run at the end of every tool block. This can be used, for example, to provide some shared configuration for all tools.

The block is applied only to subtools defined after the block appears. Subtools defined before the block appears are not affected.

A subtool_apply block cannot create or modify subtools of the subtool being applied to. (This is because the same block could be expected to apply to that subtool as well, and the semantics of the resulting recursion would be messy and ambiguous.) Thus, within the block:

  • You cannot use the tool directive.
  • You cannot create a Toys::Tool subclass.
  • You cannot use a nested subtool_apply directive.
  • You cannot pass the as: parameter to any load or related directive.
  • You cannot use any load or related directive that references a directory. (You can, however, load a file directly, as long as it does not use the as: parameter, and the file's contents do not violate any of these rules.)

Example

It is common for tools to use the :exec mixin to invoke external programs. This example automatically includes the exec mixin in all subtools, recursively, so you do not have to repeat the include directive in every tool.

# .toys.rb

subtool_apply do
  # Include the mixin only if the tool hasn't already done so
  unless include?(:exec)
    include :exec, exit_on_nonzero_status: true
  end
end

tool "foo" do
  def run
    # This tool has access to methods defined by the :exec mixin
    # because the above block is applied to the tool.
    sh "echo hello"
  end
end



1732
1733
1734
 
# File 'core-docs/toys/dsl/tool.rb', line 1732

def subtool_apply(&block)
  # Source available in the toys-core gem
end

#template(name, template_class = nil, &block) ⇒ self

Create a named template that can be expanded by name from this tool or its subtools.

A template is an object that generates DSL directives. You can use it to build "prefabricated" tools, and then instantiate them in your Toys files.

A template is an object that defines an expansion procedure. This procedure generates the DSL directives implemented by the template. The template object typically also includes attributes that are used to configure the expansion.

The simplest way to define a template is to pass a block to the #template directive. In the block, define an initialize method that accepts any arguments that may be passed to the template when it is instantiated and are used to configure the template. Define attr_readers or other methods to make this configuration accessible from the object. Then define an on_expand block that implements the template's expansion. The template object is passed as an object to the on_expand block.

Alternately, you can create a template class separately and pass it directly. See Template for details on creating a template class.

Example

The following example creates and uses a simple template. The template defines a tool, with a configurable name, that simply prints out a configurable message.

template "hello-generator" do
  def initialize(name, message)
    @name = name
    @message = message
  end
  attr_reader :name, :message
  on_expand do |template|
    tool template.name do
      to_run do
        puts template.message
      end
    end
  end
end

expand "hello-generator", "mytool", "mytool is running!"

Parameters:

  • name (String) —

    Name of the template

  • template_class (Class) (defaults to: nil) —

    Class to use as the template. Optional. Either pass a class here, or provide a block and define the template within the block.

  • block (Proc) —

    Defines the template class.

Returns:

  • (self) 


207
208
209
 
# File 'core-docs/toys/dsl/tool.rb', line 207

def template(name, template_class = nil, &block)
  # Source available in the toys-core gem
end

#to_run(handler = nil, &block) ⇒ self Also known as: on_run

Specify how to run this tool.

Typically the entrypoint for a tool is a method named run. However, you can change this by passing a different method name, as a symbol, to #to_run.

You can also alternatively pass a block to #to_run. You might do this if your method needs access to local variables in the lexical scope. However, it is often more convenient to use #static to set those values in the context.

Examples

# Set a different method name as the entrypoint:

tool "foo" do
  to_run :foo
  def foo
    puts "The foo tool ran!"
  end
end

# Use a block to retain access to the enclosing lexical scope from
# the run method:

tool "foo" do
  cur_time = Time.now
  to_run do
    puts "The time at tool definition was #{cur_time}"
  end
end

# But the following is approximately equivalent:

tool "foo" do
  static :cur_time, Time.now
  def run
    puts "The time at tool definition was #{cur_time}"
  end
end

Parameters:

  • handler (Proc, Symbol, nil) (defaults to: nil) —

    The run handler as a method name symbol or a proc, or nil to explicitly set as non-runnable.

  • block (Proc) —

    The run handler as a block.

Returns:

  • (self) 


1468
1469
1470
 
# File 'core-docs/toys/dsl/tool.rb', line 1468

def to_run(handler = nil, &block)
  # Source available in the toys-core gem
end

#tool(words, if_defined: :combine, delegate_to: nil, delegate_relative: nil, &block) ⇒ self

Create a subtool. You must provide a block defining the subtool.

Note that this cannot be called from within #subtool_apply or from a middleware config method.

Example

The following example defines a tool and two subtools within it.

tool "build" do
  tool "staging" do
    def run
      puts "Building staging"
    end
  end
  tool "production" do
    def run
      puts "Building production"
    end
  end
end

The following example uses delegate_to to define a tool that runs one of its subtools.

tool "test", delegate_to: ["test", "unit"] do
  tool "unit" do
    def run
      puts "Running unit tests"
    end
  end
end

Parameters:

  • words (String, Array<String>) —

    The name of the subtool

  • if_defined (:combine, :reset, :ignore) (defaults to: :combine) —

    What to do if a definition already exists for this tool. Possible values are :combine (the default) indicating the definition should be combined with the existing definition, :reset indicating the earlier definition should be reset and the new definition applied instead, or :ignore indicating the new definition should be ignored.

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

    Optional. This tool should delegate to another tool, specified by the full path. This path may be given as an array of strings, or a single string possibly delimited by path separators.

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

    Optional. Similar to delegate_to, but takes a delegate name relative to the context in which this tool is being defined.

  • block (Proc) —

    Defines the subtool.

Returns:

  • (self) 


307
308
309
 
# File 'core-docs/toys/dsl/tool.rb', line 307

def tool(words, if_defined: :combine, delegate_to: nil, delegate_relative: nil, &block)
  # Source available in the toys-core gem
end

#toys_version!(*requirements) ⇒ self

Asserts that the current Toys version against the given requirements, raising an exception if not.

Returns:

  • (self)

Raises:



1781
1782
1783
 
# File 'core-docs/toys/dsl/tool.rb', line 1781

def toys_version!(*requirements)
  # Source available in the toys-core gem
end

#toys_version?(*requirements) ⇒ boolean

Determines whether the current Toys version satisfies the given requirements.

Returns:

  • (boolean) —

    whether or not the requirements are satisfied



1768
1769
1770
 
# File 'core-docs/toys/dsl/tool.rb', line 1768

def toys_version?(*requirements)
  # Source available in the toys-core gem
end

#treat_unknown_flags_as_args(state = true) ⇒ self

Treat unknown flags as positional arguments. That is, if an argument looks like a flag but does not match any flag defined for this tool, it is passed to the tool's positional arguments instead of reporting a usage error.

An argument is redirected in its entirety. Thus, an argument of the form --foo=bar is treated as a single positional argument, and a cluster of single-character flags such as -abc is treated as a single positional argument if any of its characters is unknown. (In particular, none of the flags in such a cluster are set.)

This directive does not affect ambiguous flags. If an argument matches a prefix of multiple flags, it is still reported as a usage error.

Issuing this directive by itself turns on the behavior. You may turn it off by passing false as the parameter.

Example

tool "mytool" do
  treat_unknown_flags_as_args
  flag :verbose, "--verbose"
  remaining_args :command
  def run
    # Invoking `mytool --verbose ls -l` sets verbose to true and
    # command to ["ls", "-l"].
  end
end

Parameters:

  • state (boolean) (defaults to: true)

Returns:

  • (self) 


1332
1333
1334
 
# File 'core-docs/toys/dsl/tool.rb', line 1332

def treat_unknown_flags_as_args(state = true)
  # Source available in the toys-core gem
end

#truncate_load_path! ⇒ Object

Remove lower-priority sources from the load path. This prevents lower- priority sources (such as Toys files from parent or global directories) from executing or defining tools.

This works only if no such sources have already loaded yet.

Raises:



1746
1747
1748
 
# File 'core-docs/toys/dsl/tool.rb', line 1746

def truncate_load_path!
  # Source available in the toys-core gem
end