Module: Thor::Base::ClassMethods

Defined in:
lib/thor/base.rb

Instance Method Summary collapse

Instance Method Details

#all_commands ⇒ Object Also known as: all_tasks

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.



370
371
372
373
 
# File 'lib/thor/base.rb', line 370

def all_commands
  @all_commands ||= from_superclass(:all_commands, Thor::CoreExt::OrderedHash.new)
  @all_commands.merge!(commands)
end

#argument(name, options = {}) ⇒ Object

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.



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/thor/base.rb', line 232

def argument(name, options = {})
  is_thor_reserved_word?(name, :argument)
  no_commands { attr_accessor name }

  required = if options.key?(:optional)
    !options[:optional]
  elsif options.key?(:required)
    options[:required]
  else
    options[:default].nil?
  end

  remove_argument name

  if required
    arguments.each do |argument|
      next if argument.required?
      raise ArgumentError, "You cannot have #{name.to_s.inspect} as required argument after " \
                          "the non-required argument #{argument.human_name.inspect}."
    end
  end

  options[:required] = required

  arguments << Thor::Argument.new(name, options)
end

#arguments ⇒ Object

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

Returns

Array



264
265
266
 
# File 'lib/thor/base.rb', line 264

def arguments
  @arguments ||= from_superclass(:arguments, [])
end

#attr_accessor ⇒ Object

:nodoc:



136
137
138
 
# File 'lib/thor/base.rb', line 136

def attr_accessor(*) #:nodoc:
  no_commands { super }
end

#attr_reader ⇒ Object

:nodoc:



128
129
130
 
# File 'lib/thor/base.rb', line 128

def attr_reader(*) #:nodoc:
  no_commands { super }
end

#attr_writer ⇒ Object

:nodoc:



132
133
134
 
# File 'lib/thor/base.rb', line 132

def attr_writer(*) #:nodoc:
  no_commands { super }
end

#check_default_type ⇒ Object

:nodoc:



161
162
163
 
# File 'lib/thor/base.rb', line 161

def check_default_type #:nodoc:
  @check_default_type ||= from_superclass(:check_default_type, false)
end

#check_default_type! ⇒ Object

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.



157
158
159
 
# File 'lib/thor/base.rb', line 157

def check_default_type!
  @check_default_type = true
end

#check_default_type? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


165
166
167
 
# File 'lib/thor/base.rb', line 165

def check_default_type? #:nodoc:
  !!check_default_type
end

#check_unknown_options ⇒ Object

:nodoc:



146
147
148
 
# File 'lib/thor/base.rb', line 146

def check_unknown_options #:nodoc:
  @check_unknown_options ||= from_superclass(:check_unknown_options, false)
end

#check_unknown_options! ⇒ Object

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



142
143
144
 
# File 'lib/thor/base.rb', line 142

def check_unknown_options!
  @check_unknown_options = true
end

#check_unknown_options?(config) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/thor/base.rb', line 150

def check_unknown_options?(config) #:nodoc:
  !!check_unknown_options
end

#class_option(name, options = {}) ⇒ Object

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.



299
300
301
 
# File 'lib/thor/base.rb', line 299

def class_option(name, options = {})
  build_option(name, options, class_options)
end

#class_options(options = nil) ⇒ Object

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]



277
278
279
280
281
 
# File 'lib/thor/base.rb', line 277

def class_options(options = nil)
  @class_options ||= from_superclass(:class_options, {})
  build_options(options, @class_options) if options
  @class_options
end

#commands ⇒ Object Also known as: tasks

Returns the commands for this Thor class.

Returns

OrderedHash

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



359
360
361
 
# File 'lib/thor/base.rb', line 359

def commands
  @commands ||= Thor::CoreExt::OrderedHash.new
end

#disable_required_check?(command_name) ⇒ Boolean

If true, option set will not suspend the execution of the command when a required option is not provided.

Returns:

  • (Boolean) 


178
179
180
 
# File 'lib/thor/base.rb', line 178

def disable_required_check?(command_name) #:nodoc:
  false
end

#group(name = nil) ⇒ Object

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>



345
346
347
348
349
350
351
 
# File 'lib/thor/base.rb', line 345

def group(name = nil)
  if name
    @group = name.to_s
  else
    @group ||= from_superclass(:group, "standard")
  end
end

#handle_argument_error(command, error, args, arity) ⇒ Object

:nodoc:

Raises:



500
501
502
503
504
505
506
507
 
# File 'lib/thor/base.rb', line 500

def handle_argument_error(command, error, args, arity) #:nodoc:
  name = [command.ancestor_name, command.name].compact.join(" ")
  msg = "ERROR: \"#{basename} #{name}\" was called with ".dup
  msg << "no arguments"               if     args.empty?
  msg << "arguments " << args.inspect unless args.empty?
  msg << "\nUsage: #{banner(command).inspect}"
  raise InvocationError, msg
end

#handle_no_command_error(command, has_namespace = $thor_runner) ⇒ Object Also known as: handle_no_task_error

:nodoc:

Raises:



495
496
497
 
# File 'lib/thor/base.rb', line 495

def handle_no_command_error(command, has_namespace = $thor_runner) #:nodoc:
  raise UndefinedCommandError.new(command, all_commands.keys, (namespace if has_namespace))
end

#namespace(name = nil) ⇒ Object

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



448
449
450
451
452
453
454
 
# File 'lib/thor/base.rb', line 448

def namespace(name = nil)
  if name
    @namespace = name.to_s
  else
    @namespace ||= Thor::Util.namespace_from_thor_class(self)
  end
end

#no_commands ⇒ Object Also known as: no_tasks

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



418
419
420
421
422
423
 
# File 'lib/thor/base.rb', line 418

def no_commands
  @no_commands = true
  yield
ensure
  @no_commands = false
end

#public_command(*names) ⇒ Object Also known as: public_task

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



488
489
490
491
492
 
# File 'lib/thor/base.rb', line 488

def public_command(*names)
  names.each do |name|
    class_eval "def #{name}(*); super end"
  end
end

#remove_argument(*names) ⇒ Object

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



314
315
316
317
318
319
320
321
 
# File 'lib/thor/base.rb', line 314

def remove_argument(*names)
  options = names.last.is_a?(Hash) ? names.pop : {}

  names.each do |name|
    arguments.delete_if { |a| a.name == name.to_s }
    undef_method name, "#{name}=" if options[:undefine]
  end
end

#remove_class_option(*names) ⇒ Object

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



333
334
335
336
337
 
# File 'lib/thor/base.rb', line 333

def remove_class_option(*names)
  names.each do |name|
    class_options.delete(name)
  end
end

#remove_command(*names) ⇒ Object Also known as: remove_task

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.



388
389
390
391
392
393
394
395
396
 
# File 'lib/thor/base.rb', line 388

def remove_command(*names)
  options = names.last.is_a?(Hash) ? names.pop : {}

  names.each do |name|
    commands.delete(name.to_s)
    all_commands.delete(name.to_s)
    undef_method name if options[:undefine]
  end
end

#start(given_args = ARGV, config = {}) ⇒ Object

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)



464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/thor/base.rb', line 464

def start(given_args = ARGV, config = {})
  config[:shell] ||= Thor::Base.shell.new
  dispatch(nil, given_args.dup, nil, config)
rescue Thor::Error => e
  config[:debug] || ENV["THOR_DEBUG"] == "1" ? (raise e) : config[:shell].error(e.message)
  exit(false) if exit_on_failure?
rescue Errno::EPIPE
  # This happens if a thor command is piped to something like `head`,
  # which closes the pipe when it's done reading. This will also
  # mean that if the pipe is closed, further unnecessary
  # computation will not occur.
  exit(true)
end

#stop_on_unknown_option?(command_name) ⇒ Boolean

If true, option parsing is suspended as soon as an unknown option or a regular argument is encountered. All remaining arguments are passed to the command as regular arguments.

Returns:

  • (Boolean) 


172
173
174
 
# File 'lib/thor/base.rb', line 172

def stop_on_unknown_option?(command_name) #:nodoc:
  false
end

#strict_args_position ⇒ Object

:nodoc:



189
190
191
 
# File 'lib/thor/base.rb', line 189

def strict_args_position #:nodoc:
  @strict_args_position ||= from_superclass(:strict_args_position, false)
end

#strict_args_position! ⇒ Object

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.



185
186
187
 
# File 'lib/thor/base.rb', line 185

def strict_args_position!
  @strict_args_position = true
end

#strict_args_position?(config) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/thor/base.rb', line 193

def strict_args_position?(config) #:nodoc:
  !!strict_args_position
end