Class: Thor

Inherits:
Object
  • Object
show all
Includes:
Base
Defined in:
lib/thor.rb,
lib/thor/base.rb,
lib/thor/util.rb,
lib/thor/error.rb,
lib/thor/shell.rb,
lib/thor/actions.rb,
lib/thor/command.rb,
lib/thor/version.rb,
lib/thor/invocation.rb,
lib/thor/shell/html.rb,
lib/thor/line_editor.rb,
lib/thor/rake_compat.rb,
lib/thor/shell/basic.rb,
lib/thor/shell/color.rb,
lib/thor/parser/option.rb,
lib/thor/nested_context.rb,
lib/thor/parser/options.rb,
lib/thor/shell/terminal.rb,
lib/thor/parser/argument.rb,
lib/thor/parser/arguments.rb,
lib/thor/actions/directory.rb,
lib/thor/line_editor/basic.rb,
lib/thor/actions/create_file.rb,
lib/thor/actions/create_link.rb,
lib/thor/shell/table_printer.rb,
lib/thor/line_editor/readline.rb,
lib/thor/shell/column_printer.rb,
lib/thor/shell/wrapped_printer.rb,
lib/thor/actions/empty_directory.rb,
lib/thor/actions/inject_into_file.rb,
lib/thor/actions/file_manipulation.rb,
lib/thor/core_ext/hash_with_indifferent_access.rb

Direct Known Subclasses

Runner

Defined Under Namespace

Modules: Actions, Base, CoreExt, Invocation, LineEditor, RakeCompat, Sandbox, Shell, Util Classes: AmbiguousCommandError, Argument, Arguments, AtLeastOneRequiredArgumentError, Command, DynamicCommand, Error, ExclusiveArgumentError, Group, HiddenCommand, InvocationError, MalformattedArgumentError, NestedContext, Option, Options, RequiredArgumentMissingError, Runner, UndefinedCommandError, UnknownArgumentError

Constant Summary collapse

HELP_MAPPINGS =

Shortcuts for help.

%w(-h -? --help -D)
THOR_RESERVED_WORDS =

Thor methods that should not be overwritten by the user.

%w(invoke shell options behavior root destination_root relative_root
action add_file create_file in_root inside run run_ruby_script)
TEMPLATE_EXTNAME = 
".tt"
Correctable =

rubocop:disable Naming/ConstantName

if defined?(DidYouMean::SpellChecker) && defined?(DidYouMean::Correctable) # rubocop:disable Naming/ConstantName
  Module.new do
    def to_s
      super + DidYouMean.formatter.message_for(corrections)
    end

    def corrections
      @corrections ||= self.class.const_get(:SpellChecker).new(self).corrections
    end
  end
end
UndefinedTaskError = 
UndefinedCommandError
AmbiguousTaskError = 
AmbiguousCommandError
Task = 
Command
HiddenTask = 
HiddenCommand
DynamicTask = 
DynamicCommand
VERSION = 
"1.3.2"

Instance Attribute Summary

Attributes included from Base

#args, #options, #parent_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Base

included, #initialize, register_klass_file, subclass_files, subclasses

Class Method Details

.check_unknown_options!(options = {}) ⇒ Object

Extend check unknown options to accept a hash of conditions.

Parameters

options<Hash>: A hash containing :only and/or :except keys



350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/thor.rb', line 350

def check_unknown_options!(options = {})
  @check_unknown_options ||= {}
  options.each do |key, value|
    if value
      @check_unknown_options[key] = Array(value)
    else
      @check_unknown_options.delete(key)
    end
  end
  @check_unknown_options
end

.check_unknown_options?(config) ⇒ Boolean

Overwrite check_unknown_options? to take subcommands and options into account.

Returns:

  • (Boolean) 


363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/thor.rb', line 363

def check_unknown_options?(config) #:nodoc:
  options = check_unknown_options
  return false unless options

  command = config[:current_command]
  return true unless command

  name = command.name

  if subcommands.include?(name)
    false
  elsif options[:except]
    !options[:except].include?(name.to_sym)
  elsif options[:only]
    options[:only].include?(name.to_sym)
  else
    true
  end
end

.command_exists?(command_name) ⇒ Boolean

Checks if a specified command exists.

Parameters

command_name<String>

The name of the command to check for existence.

Returns

Boolean

true if the command exists, false otherwise.

Returns:

  • (Boolean) 


449
450
451
 
# File 'lib/thor.rb', line 449

def command_exists?(command_name) #:nodoc:
  commands.keys.include?(normalize_command_name(command_name))
end

.command_help(shell, command_name) ⇒ Object Also known as: task_help

Prints help information for the given command.

Parameters

shell<Thor::Shell> command_name<String>



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/thor.rb', line 258

def command_help(shell, command_name)
  meth = normalize_command_name(command_name)
  command = all_commands[meth]
  handle_no_command_error(meth) unless command

  shell.say "Usage:"
  shell.say "  #{banner(command).split("\n").join("\n  ")}"
  shell.say
  class_options_help(shell, nil => command.options.values)
  print_exclusive_options(shell, command)
  print_at_least_one_required_options(shell, command)

  if command.long_description
    shell.say "Description:"
    if command.wrap_long_description
      shell.print_wrapped(command.long_description, indent: 2)
    else
      shell.say command.long_description
    end
  else
    shell.say command.description
  end
end

.default_command(meth = nil) ⇒ Object Also known as: default_task

Sets the default command when thor is executed without an explicit command to be called.

Parameters

meth<Symbol>

name of the default command



21
22
23
24
25
26
27
 
# File 'lib/thor.rb', line 21

def default_command(meth = nil)
  if meth
    @default_command = meth == :none ? "help" : meth.to_s
  else
    @default_command ||= from_superclass(:default_command, "help")
  end
end

.deprecation_warning(message) ⇒ Object

:nodoc:



26
27
28
29
30
31
 
# File 'lib/thor/base.rb', line 26

def deprecation_warning(message) #:nodoc:
  unless ENV["THOR_SILENCE_DEPRECATION"]
    warn "Deprecation warning: #{message}\n" +
      "You can silence deprecations warning by setting the environment variable THOR_SILENCE_DEPRECATION."
  end
end

.desc(usage, description, options = {}) ⇒ Object

Defines the usage and the description of the next command.

Parameters

usage<String> description<String> options<String>



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/thor.rb', line 54

def desc(usage, description, options = {})
  if options[:for]
    command = find_and_refresh_command(options[:for])
    command.usage = usage             if usage
    command.description = description if description
  else
    @usage = usage
    @desc = description
    @hide = options[:hide] || false
  end
end

.disable_required_check!(*command_names) ⇒ Object

Disable the check for required options for the given commands. This is useful if you have a command that does not need the required options to work, like help.

Parameters

Symbol …

A list of commands that should be affected.



434
435
436
 
# File 'lib/thor.rb', line 434

def disable_required_check!(*command_names)
  @disable_required_check = disable_required_check | command_names
end

.disable_required_check?(command) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


438
439
440
 
# File 'lib/thor.rb', line 438

def disable_required_check?(command) #:nodoc:
  command && disable_required_check.include?(command.name.to_sym)
end

.help(shell, subcommand = false) ⇒ Object

Prints help information for this class.

Parameters

shell<Thor::Shell>



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/thor.rb', line 288

def help(shell, subcommand = false)
  list = printable_commands(true, subcommand)
  Thor::Util.thor_classes_in(self).each do |klass|
    list += klass.printable_commands(false)
  end
  sort_commands!(list)

  if defined?(@package_name) && @package_name
    shell.say "#{@package_name} commands:"
  else
    shell.say "Commands:"
  end

  shell.print_table(list, indent: 2, truncate: true)
  shell.say
  class_options_help(shell)
  print_exclusive_options(shell)
  print_at_least_one_required_options(shell)
end

.long_desc(long_description, options = {}) ⇒ Object

Defines the long description of the next command.

Long description is by default indented, line-wrapped and repeated whitespace merged. In order to print long description verbatim, with indentation and spacing exactly as found in the code, use the wrap option

long_desc 'your very long description', wrap: false

Parameters

long description<String> options<Hash>



78
79
80
81
82
83
84
85
86
 
# File 'lib/thor.rb', line 78

def long_desc(long_description, options = {})
  if options[:for]
    command = find_and_refresh_command(options[:for])
    command.long_description = long_description if long_description
  else
    @long_desc = long_description
    @long_desc_wrap = options[:wrap] != false
  end
end

.map(mappings = nil, **kw) ⇒ Object

Maps an input to a command. If you define:

map "-T" => "list"

Running:

thor -T

Will invoke the list command.

Parameters

Hash[String|Array => Symbol]

Maps the string or the strings in the array to the given command.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/thor.rb', line 101

def map(mappings = nil, **kw)
  @map ||= from_superclass(:map, {})

  if mappings && !kw.empty?
    mappings = kw.merge!(mappings)
  else
    mappings ||= kw
  end
  if mappings
    mappings.each do |key, value|
      if key.respond_to?(:each)
        key.each { |subkey| @map[subkey] = value }
      else
        @map[key] = value
      end
    end
  end

  @map
end

.method_at_least_one(*args, &block) ⇒ Object Also known as: at_least_one

Adds and declares option group for required at least one of options in the block of arguments. You can declare options as the outside of the block.

If :for is given as option, it allows you to change the options from a previous defined command.

Parameters

Array

options<Hash>

:for is applied for previous defined command.

Examples

at_least_one do
  option :one
  option :two
end

Or

option :one
option :two
at_least_one :one, :two

If you do not give “–one” and “–two” AtLeastOneRequiredArgumentError will be raised.

You can use at_least_one and exclusive at the same time.

exclusive do
  at_least_one do
    option :one
    option :two
  end
end

Then it is required either only one of “–one” or “–two”.



246
247
248
249
 
# File 'lib/thor.rb', line 246

def method_at_least_one(*args, &block)
  register_options_relation_for(:method_options,
                                :method_at_least_one_option_names, *args, &block)
end

.method_exclusive(*args, &block) ⇒ Object Also known as: exclusive

Adds and declares option group for exclusive options in the block and arguments. You can declare options as the outside of the block.

If :for is given as option, it allows you to change the options from a previous defined command.

Parameters

Array

options<Hash>

:for is applied for previous defined command.

Examples

exclusive do
  option :one
  option :two
end

Or

option :one
option :two
exclusive :one, :two

If you give “–one” and “–two” at the same time ExclusiveArgumentsError will be raised.



203
204
205
206
 
# File 'lib/thor.rb', line 203

def method_exclusive(*args, &block)
  register_options_relation_for(:method_options,
                                :method_exclusive_option_names, *args, &block)
end

.method_option(name, options = {}) ⇒ Object Also known as: option

Adds an option to the set of method options. If :for is given as option, it allows you to change the options from a previous defined command.

def previous_command
  # magic
end

method_option :foo, :for => :previous_command

def next_command
  # magic
end

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. It cannot be required and have default values. :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. :hide - If you want to hide this option from the help.



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/thor.rb', line 163

def method_option(name, options = {})
  unless [ Symbol, String ].any? { |klass| name.is_a?(klass) }
    raise ArgumentError, "Expected a Symbol or String, got #{name.inspect}"
  end
  scope = if options[:for]
    find_and_refresh_command(options[:for]).options
  else
    method_options
  end

  build_option(name, options, scope)
end

.method_options(options = nil) ⇒ Object Also known as: options

Declares the options for the next command to be declared.

Parameters

Hash[Symbol => Object]

The hash key is the name of the option and the value

is the type of the option. Can be :string, :array, :hash, :boolean, :numeric or :required (string). If you give a value, the type of the value is used.



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

def method_options(options = nil)
  @method_options ||= {}
  build_options(options, @method_options) if options
  @method_options
end

.package_name(name, _ = {}) ⇒ Object

Allows for custom “Command” package naming.

Parameters

name<String> options<Hash>



12
13
14
 
# File 'lib/thor.rb', line 12

def package_name(name, _ = {})
  @package_name = name.nil? || name == "" ? nil : name
end

.printable_commands(all = true, subcommand = false) ⇒ Object Also known as: printable_tasks

Returns commands ready to be printed.



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

def printable_commands(all = true, subcommand = false)
  (all ? all_commands : commands).map do |_, command|
    next if command.hidden?
    item = []
    item << banner(command, false, subcommand)
    item << (command.description ? "# #{command.description.gsub(/\s+/m, ' ')}" : "")
    item
  end.compact
end

.register(klass, subcommand_name, usage, description, options = {}) ⇒ Object

Registers another Thor subclass as a command.

Parameters

klass<Class>

Thor subclass to register

command<String>

Subcommand name to use

usage<String>

Short usage for the subcommand

description<String>

Description for the subcommand



37
38
39
40
41
42
43
44
45
 
# File 'lib/thor.rb', line 37

def register(klass, subcommand_name, usage, description, options = {})
  if klass <= Thor::Group
    desc usage, description, options
    define_method(subcommand_name) { |*args| invoke(klass, args) }
  else
    desc usage, description, options
    subcommand subcommand_name, klass
  end
end

.stop_on_unknown_option!(*command_names) ⇒ Object

Stop parsing of options as soon as an unknown option or a regular argument is encountered. All remaining arguments are passed to the command. This is useful if you have a command that can receive arbitrary additional options, and where those additional options should not be handled by Thor.

Example

To better understand how this is useful, let’s consider a command that calls an external command. A user may want to pass arbitrary options and arguments to that command. The command itself also accepts some options, which should be handled by Thor.

class_option "verbose",  :type => :boolean
stop_on_unknown_option! :exec
check_unknown_options!  :except => :exec

desc "exec", "Run a shell command"
def exec(*args)
  puts "diagnostic output" if options[:verbose]
  Kernel.exec(*args)
end

Here exec can be called with --verbose to get diagnostic output, e.g.:

$ thor exec --verbose echo foo
diagnostic output
foo

But if --verbose is given after echo, it is passed to echo instead:

$ thor exec echo --verbose foo
--verbose foo

Parameters

Symbol …

A list of commands that should be affected.



420
421
422
 
# File 'lib/thor.rb', line 420

def stop_on_unknown_option!(*command_names)
  @stop_on_unknown_option = stop_on_unknown_option | command_names
end

.stop_on_unknown_option?(command) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


424
425
426
 
# File 'lib/thor.rb', line 424

def stop_on_unknown_option?(command) #:nodoc:
  command && stop_on_unknown_option.include?(command.name.to_sym)
end

.subcommand(subcommand, subcommand_class) ⇒ Object Also known as: subtask 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/thor.rb', line 329

def subcommand(subcommand, subcommand_class)
  subcommands << subcommand.to_s
  subcommand_class.subcommand_help subcommand
  subcommand_classes[subcommand.to_s] = subcommand_class

  define_method(subcommand) do |*args|
    args, opts = Thor::Arguments.split(args)
    invoke_args = [args, opts, {invoked_via_subcommand: true, class_options: options}]
    invoke_args.unshift "help" if opts.delete("--help") || opts.delete("-h")
    invoke subcommand_class, *invoke_args
  end
  subcommand_class.commands.each do |_meth, command|
    command.ancestor_name = subcommand
  end
end

.subcommand_classes ⇒ Object 



325
326
327
 
# File 'lib/thor.rb', line 325

def subcommand_classes
  @subcommand_classes ||= {}
end

.subcommands ⇒ Object Also known as: subtasks 



320
321
322
 
# File 'lib/thor.rb', line 320

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

Instance Method Details

#help(command = nil, subcommand = false) ⇒ Object 



663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/thor.rb', line 663

def help(command = nil, subcommand = false)
  if command
    if self.class.subcommands.include? command
      self.class.subcommand_classes[command].help(shell, true)
    else
      self.class.command_help(shell, command)
    end
  else
    self.class.help(shell, subcommand)
  end
end