Class: Xnlogic::UI::Shell

Inherits:
Object
  • Object
show all
Defined in:
lib/xnlogic/ui/shell.rb

Constant Summary collapse

LEVELS = 
%w(silent error warn confirm info debug)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Shell

Returns a new instance of Shell.



8
9
10
11
12
13
14
15
 
# File 'lib/xnlogic/ui/shell.rb', line 8

def initialize(options = {})
  if options["color"] == false || !STDOUT.tty?
    # FIXME: Apparently the basic shell now does color
    Thor::Base.shell = Thor::Shell::Basic
  end
  @shell = Thor::Base.shell.new
  @level = ENV['DEBUG'] ? "debug" : "info"
end

Instance Attribute Details

#shell=(value) ⇒ Object (writeonly)

Sets the attribute shell

Parameters:

  • value —

    the value to set the attribute shell to.



6
7
8
 
# File 'lib/xnlogic/ui/shell.rb', line 6

def shell=(value)
  @shell = value
end

Instance Method Details

#ask(msg) ⇒ Object 



46
47
48
 
# File 'lib/xnlogic/ui/shell.rb', line 46

def ask(msg)
  @shell.ask(msg)
end

#confirm(msg, newline = nil) ⇒ Object 



21
22
23
 
# File 'lib/xnlogic/ui/shell.rb', line 21

def confirm(msg, newline = nil)
  tell_me(msg, :green, newline) if level("confirm")
end

#debug(msg, newline = nil) ⇒ Object 



33
34
35
 
# File 'lib/xnlogic/ui/shell.rb', line 33

def debug(msg, newline = nil)
  tell_me(msg, nil, newline) if level("debug")
end

#debug? ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
40
 
# File 'lib/xnlogic/ui/shell.rb', line 37

def debug?
  # needs to be false instead of nil to be newline param to other methods
  level("debug")
end

#error(msg, newline = nil) ⇒ Object 



29
30
31
 
# File 'lib/xnlogic/ui/shell.rb', line 29

def error(msg, newline = nil)
  tell_me(msg, :red, newline) if level("error")
end

#info(msg, newline = nil) ⇒ Object 



17
18
19
 
# File 'lib/xnlogic/ui/shell.rb', line 17

def info(msg, newline = nil)
  tell_me(msg, nil, newline) if level("info")
end

#level(name = nil) ⇒ Object 



55
56
57
 
# File 'lib/xnlogic/ui/shell.rb', line 55

def level(name = nil)
  name ? LEVELS.index(name) <= LEVELS.index(@level) : @level
end

#level=(level) ⇒ Object

Raises:

  • (ArgumentError) 


50
51
52
53
 
# File 'lib/xnlogic/ui/shell.rb', line 50

def level=(level)
  raise ArgumentError unless LEVELS.include?(level.to_s)
  @level = level
end

#quiet? ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/xnlogic/ui/shell.rb', line 42

def quiet?
  LEVELS.index(@level) <= LEVELS.index("warn")
end

#silence ⇒ Object 



65
66
67
68
69
70
 
# File 'lib/xnlogic/ui/shell.rb', line 65

def silence
  old_level, @level = @level, "silent"
  yield
ensure
  @level = old_level
end

#trace(e, newline = nil) ⇒ Object 



59
60
61
62
63
 
# File 'lib/xnlogic/ui/shell.rb', line 59

def trace(e, newline = nil)
  return unless debug?
  msg = "#{e.class}: #{e.message}\n#{e.backtrace.join("\n  ")}"
  tell_me(msg, nil, newline)
end

#warn(msg, newline = nil) ⇒ Object 



25
26
27
 
# File 'lib/xnlogic/ui/shell.rb', line 25

def warn(msg, newline = nil)
  tell_me(msg, :yellow, newline) if level("warn")
end