Module: Thor::Base::ClassMethods

Defined in:
lib/thor/base.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) all_tasks

Returns the tasks for this Thor class and all subclasses.

Returns

OrderedHash

An ordered hash with tasks names as keys and Thor::Task objects as values.



340
341
342
343
 
# File 'lib/thor/base.rb', line 340

def all_tasks
  @all_tasks ||= from_superclass(:all_tasks, Thor::CoreExt::OrderedHash.new)
  @all_tasks.merge(tasks)
end

- (Object) argument(name, options = {})

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 task NAME

Instead of:

thor task --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.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/thor/base.rb', line 204

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

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

  remove_argument name

  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 if required

  options[:required] = required

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

- (Object) arguments

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

Returns

Array



234
235
236
 
# File 'lib/thor/base.rb', line 234

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

- (Object) attr_accessor

:nodoc:



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

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

- (Object) attr_reader

:nodoc:



121
122
123
 
# File 'lib/thor/base.rb', line 121

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

- (Object) attr_writer

:nodoc:



125
126
127
 
# File 'lib/thor/base.rb', line 125

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

- (Object) check_unknown_options

:nodoc:



139
140
141
 
# File 'lib/thor/base.rb', line 139

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

- (Object) check_unknown_options!

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



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

def check_unknown_options!
  @check_unknown_options = true
end

- (Boolean) check_unknown_options?(config)

:nodoc:

Returns:

  • (Boolean) 


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

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

- (Object) class_option(name, options = {})

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.



269
270
271
 
# File 'lib/thor/base.rb', line 269

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

- (Object) class_options(options = nil)

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]



247
248
249
250
251
 
# File 'lib/thor/base.rb', line 247

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

- (Object) group(name = nil)

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

Parameters

name<String|Symbol>



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

def group(name=nil)
  case name
    when nil
      @group ||= from_superclass(:group, 'standard')
    else
      @group = name.to_s
  end
end

- (Object) handle_argument_error(task, error, arity = nil)

:nodoc:

Raises:



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/thor/base.rb', line 470

def handle_argument_error(task, error, arity=nil) #:nodoc:
  msg = "#{basename} #{task.name}"
  if arity
    required = arity < 0 ? (-1 - arity) : arity
    if required == 0
      msg << " should have no arguments"
    else
      msg << " requires at least #{required} argument"
      msg << "s" if required > 1
    end
  else
    msg = "call #{msg} as"
  end

  msg << ": #{self.banner(task).inspect}."
  raise InvocationError, msg
end

- (Object) handle_no_task_error(task, has_namespace = $thor_runner)

:nodoc:



462
463
464
465
466
467
468
 
# File 'lib/thor/base.rb', line 462

def handle_no_task_error(task, has_namespace = $thor_runner) #:nodoc:
  if has_namespace
    raise UndefinedTaskError, "Could not find task #{task.inspect} in #{namespace.inspect} namespace."
  else
    raise UndefinedTaskError, "Could not find task #{task.inspect}."
  end
end

- (Object) namespace(name = nil)

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 tasks are invoked:

thor my_scripts -h

Finally, if you change your namespace to default:

namespace :default

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

thor :my_task


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

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

- (Object) no_tasks

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

So you can do:

class MyScript < Thor
  no_tasks do
    def this_is_not_a_task
    end
  end
end

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

class MyScript < Thor
  def this_is_not_a_task
  end
  remove_task :this_is_not_a_task
end


386
387
388
389
390
391
 
# File 'lib/thor/base.rb', line 386

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

- (Object) public_task(*names)

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

Parameters

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

Examples

public_task :foo
public_task :foo, :bar, :baz


456
457
458
459
460
 
# File 'lib/thor/base.rb', line 456

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

- (Object) remove_argument(*names)

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


284
285
286
287
288
289
290
291
 
# File 'lib/thor/base.rb', line 284

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

- (Object) remove_class_option(*names)

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


303
304
305
306
307
 
# File 'lib/thor/base.rb', line 303

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

- (Object) remove_task(*names)

Removes a given task 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 task. But you can supply :undefine => true to undefine the method from the class as well.

Parameters

name<Symbol|String>

The name of the task to be removed

options<Hash>

You can give :undefine => true if you want tasks the method to be undefined from the class as well.



357
358
359
360
361
362
363
364
365
 
# File 'lib/thor/base.rb', line 357

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

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

- (Object) start(given_args = ARGV, config = {})

Parses the task and options from the given args, instantiate the class and invoke the task. 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(:task, first_arg, second_arg, third_arg)


432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/thor/base.rb', line 432

def start(given_args=ARGV, config={})
  config[:shell] ||= Thor::Base.shell.new
  dispatch(nil, given_args.dup, nil, config)
rescue Thor::Error => e
  ENV["THOR_DEBUG"] == "1" ? (raise e) : config[:shell].error(e.message)
  exit(1) if exit_on_failure?
rescue Errno::EPIPE
  # This happens if a thor task 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(0)
end

- (Boolean) stop_on_unknown_option?(task_name)

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 task as regular arguments.

Returns:

  • (Boolean) 


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

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

- (Object) strict_args_position

:nodoc:



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

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

- (Object) strict_args_position!

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.



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

def strict_args_position!
  @strict_args_position = true
end

- (Boolean) strict_args_position?(config)

:nodoc:

Returns:

  • (Boolean) 


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

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

- (Object) tasks

Returns the tasks for this Thor class.

Returns

OrderedHash

An ordered hash with tasks names as keys and Thor::Task objects as values.



330
331
332
 
# File 'lib/thor/base.rb', line 330

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