Module Thor::Base::ClassMethods
In: lib/thor/base.rb

Methods

External Aliases

handle_no_command_error -> handle_no_task_error
find_and_refresh_command -> find_and_refresh_task
create_command -> create_task

Public Instance methods

Returns the commands for this Thor class and all subclasses.

Returns

OrderedHash:An ordered hash with commands names as keys and Thor::Command objects as values.
all_tasks()

Alias for all_commands

Adds an argument to the class and creates an attr_accessor for it.

Arguments are different from options in several aspects. The first one is how they are parsed from the command line, arguments are retrieved from position:

  thor command NAME

Instead of:

  thor command --name=NAME

Besides, arguments are used inside your code as an accessor (self.argument), while options are all kept in a hash (self.options).

Finally, arguments cannot have type :default or :boolean but can be optional (supplying :optional => :true or :required => false), although you cannot have a required argument after a non-required argument. If you try it, an error is raised.

Parameters

name<Symbol>:The name of the argument.
options<Hash>:Described below.

Options

:desc - Description for the argument. :required - If the argument is required or not. :optional - If the argument is optional or not. :type - The type of the argument, can be :string, :hash, :array, :numeric. :default - Default value for this argument. It cannot be required and have default values. :banner - String to show on usage notes.

Errors

ArgumentError:Raised if you supply a required argument after a non required one.

Returns this class arguments, looking up in the ancestors chain.

Returns

Array[Thor::Argument]

If you want to raise an error when the default value of an option does not match the type call check_default_type! This is disabled by default for compatibility.

If you want to raise an error for unknown options, call check_unknown_options! This is disabled by default to allow dynamic invocations.

Adds an option to the set of class options

Parameters

name<Symbol>:The name of the argument.
options<Hash>:Described below.

Options

:desc:— Description for the argument.
:required:— If the argument is required or not.
:default:— Default value for this argument.
:group:— The group for this options. Use by class options to output options in different levels.
:aliases:— Aliases for this option. Note: Thor follows a convention of one-dash-one-letter options. Thus aliases like "-something" wouldn‘t be parsed; use either "\—something" or "-s" instead.
:type:— The type of the argument, can be :string, :hash, :array, :numeric or :boolean.
:banner:— String to show on usage notes.
:hide:— If you want to hide this option from the help.

Adds a bunch of options to the set of class options.

  class_options :foo => false, :bar => :required, :baz => :string

If you prefer more detailed declaration, check class_option.

Parameters

Hash[Symbol => Object]

Returns the commands for this Thor class.

Returns

OrderedHash:An ordered hash with commands names as keys and Thor::Command objects as values.

Defines the group. This is used when thor list is invoked so you can specify that only commands from a pre-defined group will be shown. Defaults to standard.

Parameters

name<String|Symbol>

Sets the namespace for the Thor or Thor::Group class. By default the namespace is retrieved from the class name. If your Thor class is named Scripts::MyScript, the help method, for example, will be called as:

  thor scripts:my_script -h

If you change the namespace:

  namespace :my_scripts

You change how your commands are invoked:

  thor my_scripts -h

Finally, if you change your namespace to default:

  namespace :default

Your commands can be invoked with a shortcut. Instead of:

  thor :my_command

All methods defined inside the given block are not added as commands.

So you can do:

  class MyScript < Thor
    no_commands do
      def this_is_not_a_command
      end
    end
  end

You can also add the method and remove it from the command list:

  class MyScript < Thor
    def this_is_not_a_command
    end
    remove_command :this_is_not_a_command
  end
no_tasks()

Alias for no_commands

Allows to use private methods from parent in child classes as commands.

Parameters

  names<Array>:: Method names to be used as commands

Examples

  public_command :foo
  public_command :foo, :bar, :baz
public_task(*names)

Alias for public_command

Removes a previous defined argument. If :undefine is given, undefine accessors as well.

Parameters

names<Array>:Arguments to be removed

Examples

  remove_argument :foo
  remove_argument :foo, :bar, :baz, :undefine => true

Removes a previous defined class option.

Parameters

names<Array>:Class options to be removed

Examples

  remove_class_option :foo
  remove_class_option :foo, :bar, :baz

Removes a given command from this Thor class. This is usually done if you are inheriting from another class and don‘t want it to be available anymore.

By default it only remove the mapping to the command. But you can supply :undefine => true to undefine the method from the class as well.

Parameters

name<Symbol|String>:The name of the command to be removed
options<Hash>:You can give :undefine => true if you want commands the method to be undefined from the class as well.
remove_task(*names)

Alias for remove_command

Parses the command and options from the given args, instantiate the class and invoke the command. This method is used when the arguments must be parsed from an array. If you are inside Ruby and want to use a Thor class, you can simply initialize it:

  script = MyScript.new(args, options, config)
  script.invoke(:command, first_arg, second_arg, third_arg)

If you want only strict string args (useful when cascading thor classes), call strict_args_position! This is disabled by default to allow dynamic invocations.

tasks()

Alias for commands

Protected Instance methods

The basename of the program invoking the thor class.

A flag that makes the process exit with status 1 if any error happens.

Retrieves a value from superclass. If it reaches the baseclass, returns default.

Everytime someone inherits from a Thor class, register the klass and file into baseclass.

Fire this callback whenever a method is added. Added methods are tracked as commands by invoking the create_command method.

Receives a set of options and print them.

[Validate]