Class: Thor

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

Direct Known Subclasses

EY::Thor, Runner

Defined Under Namespace

Modules: Actions, Base, CoreExt, Invocation, RakeCompat, Sandbox, Shell, Util Classes: Argument, Arguments, Command, DynamicCommand, Error, Group, HiddenCommand, InvocationError, MalformattedArgumentError, Option, Options, RequiredArgumentMissingError, Runner, Task, 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)
UndefinedTaskError = 
UndefinedCommandError
HiddenTask = 
HiddenCommand
DynamicTask = 
DynamicCommand
VERSION = 
"0.18.1"

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, shell, shell=, subclass_files, subclasses

Class Method Details

.check_unknown_options!(options = {}) ⇒ Object

Extend check unknown options to accept a hash of conditions.

Parameters

options: A hash containing :only and/or :except keys



241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/vendor/thor/lib/thor.rb', line 241

def check_unknown_options!(options={})
  @check_unknown_options ||= Hash.new
  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) 


254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/vendor/thor/lib/thor.rb', line 254

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_help(shell, command_name) ⇒ Object Also known as: task_help

Prints help information for the given command.

Parameters

shellThor::Shell command_name



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/vendor/thor/lib/thor.rb', line 168

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)}"
  shell.say
  class_options_help(shell, nil => command.options.map { |_, o| o })
  if command.long_description
    shell.say "Description:"
    shell.print_wrapped(command.long_description, :indent => 2)
  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

name of the default command



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

def default_command(meth=nil)
  @default_command = case meth
  when :none
    'help'
  when nil
    @default_command || from_superclass(:default_command, 'help')
  else
    meth.to_s
  end
end

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

Defines the usage and the description of the next command.

Parameters

usage description options



57
58
59
60
61
62
63
64
65
 
# File 'lib/vendor/thor/lib/thor.rb', line 57

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, @desc, @hide = usage, description, options[:hide] || false
  end
end

.help(shell, subcommand = false) ⇒ Object

Prints help information for this class.

Parameters

shellThor::Shell



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/vendor/thor/lib/thor.rb', line 191

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
  list.sort!{ |a,b| a[0] <=> b[0] }

  if @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)
end

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

Defines the long description of the next command.

Parameters

long description



72
73
74
75
76
77
78
79
 
# File 'lib/vendor/thor/lib/thor.rb', line 72

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

.map(mappings = nil) ⇒ 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.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/vendor/thor/lib/thor.rb', line 94

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

  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_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 => :bar, :for => :previous_command

def next_command
# magic
end

Parameters

name

The name of the argument.

options

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.



151
152
153
154
155
156
157
158
159
 
# File 'lib/vendor/thor/lib/thor.rb', line 151

def method_option(name, options={})
  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.



117
118
119
120
121
 
# File 'lib/vendor/thor/lib/thor.rb', line 117

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

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

Allows for custom "Command" package naming.

Parameters

name options



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

def package_name(name, options={})
  @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.



210
211
212
213
214
215
216
217
218
 
# File 'lib/vendor/thor/lib/thor.rb', line 210

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

Thor subclass to register

command

Subcommand name to use

usage

Short usage for the subcommand

description

Description for the subcommand



40
41
42
43
44
45
46
47
48
 
# File 'lib/vendor/thor/lib/thor.rb', line 40

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.



311
312
313
314
 
# File 'lib/vendor/thor/lib/thor.rb', line 311

def stop_on_unknown_option!(*command_names)
  @stop_on_unknown_option ||= Set.new
  @stop_on_unknown_option.merge(command_names)
end

.stop_on_unknown_option?(command) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


316
317
318
 
# File 'lib/vendor/thor/lib/thor.rb', line 316

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

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



226
227
228
229
230
231
232
233
234
 
# File 'lib/vendor/thor/lib/thor.rb', line 226

def subcommand(subcommand, subcommand_class)
  self.subcommands << subcommand.to_s
  subcommand_class.subcommand_help subcommand

  define_method(subcommand) do |*args|
    args, opts = Thor::Arguments.split(args)
    invoke subcommand_class, args, opts, :invoked_via_subcommand => true, :class_options => options
  end
end

.subcommands ⇒ Object Also known as: subtasks 



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

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

Instance Method Details

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



470
471
472
 
# File 'lib/vendor/thor/lib/thor.rb', line 470

def help(command = nil, subcommand = false)
  command ? self.class.command_help(shell, command) : self.class.help(shell, subcommand)
end