Module: Thor::Invocation

Defined in:
lib/thor/invocation.rb

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



3
4
5
# File 'lib/thor/invocation.rb', line 3

def self.included(base) #:nodoc:
  base.extend ClassMethods
end

Instance Method Details

#current_command_chainObject

Make the current command chain accessible with in a Thor-(sub)command



29
30
31
# File 'lib/thor/invocation.rb', line 29

def current_command_chain
  @_invocations.values.flatten.map(&:to_sym)
end

#initialize(args = [], options = {}, config = {}, &block) ⇒ Object

Make initializer aware of invocations and the initialization args.



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

def initialize(args = [], options = {}, config = {}, &block) #:nodoc:
  @_invocations = config[:invocations] || Hash.new { |h, k| h[k] = [] }
  @_initializer = [args, options, config]
  super
end

#invoke(name = nil, *args) ⇒ Object

Receives a name and invokes it. The name can be a string (either “command” or “namespace:command”), a Thor::Command, a Class or a Thor instance. If the command cannot be guessed by name, it can also be supplied as second argument.

You can also supply the arguments, options and configuration values for the command to be invoked, if none is given, the same values used to initialize the invoker are used to initialize the invoked.

When no name is given, it will invoke the default command of the current class.

Examples

class A < Thor
  def foo
    invoke :bar
    invoke "b:hello", ["Erik"]
  end

  def bar
    invoke "b:hello", ["Erik"]
  end
end

class B < Thor
  def hello(name)
    puts "hello #{name}"
  end
end

You can notice that the method “foo” above invokes two commands: “bar”, which belongs to the same class and “hello” which belongs to the class B.

By using an invocation system you ensure that a command is invoked only once. In the example above, invoking “foo” will invoke “b:hello” just once, even if it's invoked later by “bar” method.

When class A invokes class B, all arguments used on A initialization are supplied to B. This allows lazy parse of options. Let's suppose you have some rspec commands:

class Rspec < Thor::Group
  class_option :mock_framework, :type => :string, :default => :rr

  def invoke_mock_framework
    invoke "rspec:#{options[:mock_framework]}"
  end
end

As you noticed, it invokes the given mock framework, which might have its own options:

class Rspec::RR < Thor::Group
  class_option :style, :type => :string, :default => :mock
end

Since it's not rspec concern to parse mock framework options, when RR is invoked all options are parsed again, so RR can extract only the options that it's going to use.

If you want Rspec::RR to be initialized with its own set of options, you have to do that explicitly:

invoke "rspec:rr", [], :style => :foo

Besides giving an instance, you can also give a class to invoke:

invoke Rspec::RR, [], :style => :foo


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

def invoke(name = nil, *args)
  if name.nil?
    warn "[Thor] Calling invoke() without argument is deprecated. Please use invoke_all instead.\n#{caller.join("\n")}"
    return invoke_all
  end

  args.unshift(nil) if args.first.is_a?(Array) || args.first.nil?
  command, args, opts, config = args

  klass, command = _retrieve_class_and_command(name, command)
  fail "Missing Thor class for invoke #{name}" unless klass
  fail "Expected Thor class, got #{klass}" unless klass <= Thor::Base

  args, opts, config = _parse_initialization_options(args, opts, config)
  klass.send(:dispatch, command, args, opts, config) do |instance|
    instance.parent_options = options
  end
end

#invoke_allObject

Invoke all commands for the current instance.



132
133
134
# File 'lib/thor/invocation.rb', line 132

def invoke_all #:nodoc:
  self.class.all_commands.map { |_, command| invoke_command(command) }
end

#invoke_command(command, *args) ⇒ Object Also known as: invoke_task

Invoke the given command if the given args.



121
122
123
124
125
126
127
128
# File 'lib/thor/invocation.rb', line 121

def invoke_command(command, *args) #:nodoc:
  current = @_invocations[self.class]

  unless current.include?(command.name)
    current << command.name
    command.run(self, *args)
  end
end

#invoke_with_padding(*args) ⇒ Object

Invokes using shell padding.



137
138
139
# File 'lib/thor/invocation.rb', line 137

def invoke_with_padding(*args)
  with_padding { invoke(*args) }
end