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/task.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/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::Serverside::CLI::App, Runner

Defined Under Namespace

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

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



221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/vendor/thor/lib/thor.rb', line 221

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) 


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/vendor/thor/lib/thor.rb', line 234

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

  task = config[:current_task]
  return true unless task

  name = task.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

.default_task(meth = nil) ⇒ Object

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

Parameters

meth

name of the default task



10
11
12
13
14
15
16
17
18
19
 
# File 'lib/vendor/thor/lib/thor.rb', line 10

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

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

Defines the usage and the description of the next task.

Parameters

usage description options



45
46
47
48
49
50
51
52
53
 
# File 'lib/vendor/thor/lib/thor.rb', line 45

def desc(usage, description, options={})
  if options[:for]
    task = find_and_refresh_task(options[:for])
    task.usage = usage             if usage
    task.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



179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/vendor/thor/lib/thor.rb', line 179

def help(shell, subcommand = false)
  list = printable_tasks(true, subcommand)
  Thor::Util.thor_classes_in(self).each do |klass|
    list += klass.printable_tasks(false)
  end
  list.sort!{ |a,b| a[0] <=> b[0] }

  shell.say "Tasks:"
  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 task.

Parameters

long description



60
61
62
63
64
65
66
67
 
# File 'lib/vendor/thor/lib/thor.rb', line 60

def long_desc(long_description, options={})
  if options[:for]
    task = find_and_refresh_task(options[:for])
    task.long_description = long_description if long_description
  else
    @long_desc = long_description
  end
end

.map(mappings = nil) ⇒ Object

Maps an input to a task. If you define:

map "-T" => "list"

Running:

thor -T

Will invoke the list task.

Parameters

Hash[String|Array => Symbol]

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/vendor/thor/lib/thor.rb', line 82

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

def previous_task
# magic
end

method_option :foo => :bar, :for => :previous_task

def next_task
# 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.



139
140
141
142
143
144
145
146
147
 
# File 'lib/vendor/thor/lib/thor.rb', line 139

def method_option(name, options={})
  scope = if options[:for]
    find_and_refresh_task(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 task 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.



105
106
107
108
109
 
# File 'lib/vendor/thor/lib/thor.rb', line 105

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

.printable_tasks(all = true, subcommand = false) ⇒ Object

Returns tasks ready to be printed.



193
194
195
196
197
198
199
200
201
 
# File 'lib/vendor/thor/lib/thor.rb', line 193

def printable_tasks(all = true, subcommand = false)
  (all ? all_tasks : tasks).map do |_, task|
    next if task.hidden?
    item = []
    item << banner(task, false, subcommand)
    item << (task.description ? "# #{task.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



28
29
30
31
32
33
34
35
36
 
# File 'lib/vendor/thor/lib/thor.rb', line 28

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

.subcommand(subcommand, subcommand_class) ⇒ Object 



207
208
209
210
211
212
213
214
215
 
# File 'lib/vendor/thor/lib/thor.rb', line 207

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

.subcommands ⇒ Object 



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

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

.task_help(shell, task_name) ⇒ Object

Prints help information for the given task.

Parameters

shellThor::Shell task_name



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/vendor/thor/lib/thor.rb', line 157

def task_help(shell, task_name)
  meth = normalize_task_name(task_name)
  task = all_tasks[meth]
  handle_no_task_error(meth) unless task

  shell.say "Usage:"
  shell.say "  #{banner(task)}"
  shell.say
  class_options_help(shell, nil => task.options.map { |_, o| o })
  if task.long_description
    shell.say "Description:"
    shell.print_wrapped(task.long_description, :indent => 2)
  else
    shell.say task.description
  end
end

Instance Method Details

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



376
377
378
 
# File 'lib/vendor/thor/lib/thor.rb', line 376

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