Module: Thor::Base::ClassMethods

Defined in:
lib/thor/base.rb

Instance Method Summary collapse

Instance Method Details

#all_tasks ⇒ Object

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.



292
293
294
295
 
# File 'lib/thor/base.rb', line 292

def all_tasks
  @all_tasks ||= from_superclass(:all_tasks, Thor::CoreExt::OrderedHash.new)
  @all_tasks.merge(tasks)
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 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.



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/thor/base.rb', line 158

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

  arguments << Thor::Argument.new(name, options[:desc], required, options[:type],
                                        options[:default], options[:banner])
end

#arguments ⇒ Object

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

Returns

Array



187
188
189
 
# File 'lib/thor/base.rb', line 187

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

#attr_accessor ⇒ Object

:nodoc:



105
106
107
 
# File 'lib/thor/base.rb', line 105

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

#attr_reader ⇒ Object

:nodoc:



97
98
99
 
# File 'lib/thor/base.rb', line 97

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

#attr_writer ⇒ Object

:nodoc:



101
102
103
 
# File 'lib/thor/base.rb', line 101

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

#check_unknown_options ⇒ Object

:nodoc:



115
116
117
 
# File 'lib/thor/base.rb', line 115

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.



111
112
113
 
# File 'lib/thor/base.rb', line 111

def check_unknown_options!
  @check_unknown_options = true
end

#check_unknown_options?(config) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/thor/base.rb', line 119

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. :type - The type of the argument, can be :string, :hash, :array, :numeric or :boolean. :banner - String to show on usage notes.



221
222
223
 
# File 'lib/thor/base.rb', line 221

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]



200
201
202
203
204
 
# File 'lib/thor/base.rb', line 200

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

#group(name = nil) ⇒ Object

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>



267
268
269
270
271
272
273
274
 
# File 'lib/thor/base.rb', line 267

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

#handle_argument_error(task, error) ⇒ Object

:nodoc:

Raises:



416
417
418
 
# File 'lib/thor/base.rb', line 416

def handle_argument_error(task, error) #:nodoc:
  raise InvocationError, "#{task.name.inspect} was called incorrectly. Call as #{self.banner(task).inspect}."
end

#handle_no_task_error(task) ⇒ Object

:nodoc:



408
409
410
411
412
413
414
 
# File 'lib/thor/base.rb', line 408

def handle_no_task_error(task) #:nodoc:
  if $thor_runner
    raise UndefinedTaskError, "Could not find task #{task.inspect} in #{namespace.inspect} namespace."
  else
    raise UndefinedTaskError, "Could not find task #{task.inspect}."
  end
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 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



367
368
369
370
371
372
373
374
 
# File 'lib/thor/base.rb', line 367

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

#no_tasks ⇒ Object

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



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

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

#public_task(*names) ⇒ Object

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

Paremeters

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

Examples

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



402
403
404
405
406
 
# File 'lib/thor/base.rb', line 402

def public_task(*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.

Paremeters

names<Array>

Arguments to be removed

Examples

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



236
237
238
239
240
241
242
243
 
# File 'lib/thor/base.rb', line 236

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.

Paremeters

names<Array>

Class options to be removed

Examples

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



255
256
257
258
259
 
# File 'lib/thor/base.rb', line 255

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

#remove_task(*names) ⇒ Object

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.



309
310
311
312
313
314
315
316
317
 
# File 'lib/thor/base.rb', line 309

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

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

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)



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

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?
end

#tasks ⇒ Object

Returns the tasks for this Thor class.

Returns

OrderedHash

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



282
283
284
 
# File 'lib/thor/base.rb', line 282

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