Module: Thor::Shell

Defined in:
lib/thor/shell.rb,
lib/thor/shell/html.rb,
lib/thor/shell/color.rb,
lib/thor/shell/basic.rb

Defined Under Namespace

Classes: Basic, Color, HTML

Constant Summary

SHELL_DELEGATED_METHODS =
[:ask, :error, :set_color, :yes?, :no?, :say, :say_status, :print_in_columns, :print_table, :print_wrapped, :file_collision, :terminal_width]

Instance Method Summary (collapse)

Instance Method Details

- (Shell) initialize(args = [], options = {}, config = {})

Add shell to initialize config values.

Configuration

shell<Object>

An instance of the shell to be used.

Examples

class MyScript < Thor
  argument :first, :type => :numeric
end

MyScript.new [1.0], { :foo => :bar }, :shell => Thor::Shell::Basic.new


45
46
47
48
49
# File 'lib/thor/shell.rb', line 45

def initialize(args=[], options={}, config={})
  super
  self.shell = config[:shell]
  self.shell.base ||= self if self.shell.respond_to?(:base)
end

- (Object) shell

Holds the shell for the given Thor instance. If no shell is given, it gets a default shell from Thor::Base.shell.



53
54
55
# File 'lib/thor/shell.rb', line 53

def shell
  @shell ||= Thor::Base.shell.new
end

- (Object) shell=(shell)

Sets the shell for this thor class.



58
59
60
# File 'lib/thor/shell.rb', line 58

def shell=(shell)
  @shell = shell
end

- (Object) with_padding

Yields the given block with padding.



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

def with_padding
  shell.padding += 1
  yield
ensure
  shell.padding -= 1
end