Class: Thor::Shell::Basic

Inherits:
Object show all
Defined in:
lib/thor/shell/basic.rb

Direct Known Subclasses

Color, HTML

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Basic

Initialize base and padding to nil.



10
11
12
 
# File 'lib/thor/shell/basic.rb', line 10

def initialize #:nodoc:
  @base, @padding = nil, 0
end

Instance Attribute Details

#base ⇒ Object

Returns the value of attribute base.



6
7
8
 
# File 'lib/thor/shell/basic.rb', line 6

def base
  @base
end

#padding ⇒ Object

Returns the value of attribute padding.



6
7
8
 
# File 'lib/thor/shell/basic.rb', line 6

def padding
  @padding
end

Instance Method Details

#ask(statement, color = nil) ⇒ Object

Ask something to the user and receives a response.

Example

ask(“What is your name?”)



40
41
42
43
 
# File 'lib/thor/shell/basic.rb', line 40

def ask(statement, color=nil)
  say("#{statement} ", color)
  $stdin.gets.strip
end

#error(statement) ⇒ Object

Called if something goes wrong during the execution. This is used by Thor internally and should not be used inside your scripts. If someone went wrong, you can always raise an exception. If you raise a Thor::Error, it will be rescued and wrapped in the method below.



202
203
204
 
# File 'lib/thor/shell/basic.rb', line 202

def error(statement)
  $stderr.puts statement
end

#file_collision(destination) ⇒ Object

Deals with file collision and returns true if the file should be overwriten and false otherwise. If a block is given, it uses the block response as the content for the diff.

Parameters

destination<String>

the destination file to solve conflicts

block<Proc>

an optional block that returns the value to be used in diff



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/thor/shell/basic.rb', line 171

def file_collision(destination)
  return true if @always_force
  options = block_given? ? "[Ynaqdh]" : "[Ynaqh]"

  while true
    answer = ask %[Overwrite #{destination}? (enter "h" for help) #{options}]

    case answer
      when is?(:yes), is?(:force), ""
        return true
      when is?(:no), is?(:skip)
        return false
      when is?(:always)
        return @always_force = true
      when is?(:quit)
        say 'Aborting...'
        raise SystemExit
      when is?(:diff)
        show_diff(destination, yield) if block_given?
        say 'Retrying...'
      else
        say file_collision_help
    end
  end
end

#mute ⇒ Object

Mute everything that’s inside given block



16
17
18
19
20
21
 
# File 'lib/thor/shell/basic.rb', line 16

def mute
  @mute = true
  yield
ensure
  @mute = false
end

#mute? ⇒ Boolean

Check if base is muted

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/thor/shell/basic.rb', line 25

def mute?
  @mute
end

#no?(statement, color = nil) ⇒ Boolean

Make a question the to user and returns true if the user replies “n” or “no”.

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/thor/shell/basic.rb', line 93

def no?(statement, color=nil)
  !yes?(statement, color)
end

#print_table(table, options = {}) ⇒ Object

Prints a table.

Parameters

Array[Array[String, String, …]]

Options

ident<Integer>

Indent the first column by ident value.

colwidth<Integer>

Force the first column to colwidth spaces wide.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/thor/shell/basic.rb', line 106

def print_table(table, options={})
  return if table.empty?

  formats, ident, colwidth = [], options[:ident].to_i, options[:colwidth]
  options[:truncate] = terminal_width if options[:truncate] == true

  formats << "%-#{colwidth + 2}s" if colwidth
  start = colwidth ? 1 : 0

  start.upto(table.first.length - 2) do |i|
    maxima ||= table.max{|a,b| a[i].size <=> b[i].size }[i].size
    formats << "%-#{maxima + 2}s"
  end

  formats[0] = formats[0].insert(0, " " * ident)
  formats << "%s"

  table.each do |row|
    sentence = ""

    row.each_with_index do |column, i|
      sentence << formats[i] % column.to_s
    end

    sentence = truncate(sentence, options[:truncate]) if options[:truncate]
    $stdout.puts sentence
  end
end

#print_wrapped(message, options = {}) ⇒ Object

Prints a long string, word-wrapping the text to the current width of the terminal display. Ideal for printing heredocs.

Parameters

String

Options

ident<Integer>

Indent each line of the printed paragraph by ident value.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/thor/shell/basic.rb', line 144

def print_wrapped(message, options={})
  ident = options[:ident] || 0
  width = terminal_width - ident
  paras = message.split("\n\n")

  paras.map! do |unwrapped|
    unwrapped.strip.gsub(/\n/, " ").squeeze(" ").
    gsub(/.{1,#{width}}(?:\s|\Z)/){($& + 5.chr).
    gsub(/\n\005/,"\n").gsub(/\005/,"\n")}
  end

  paras.each do |para|
    para.split("\n").each do |line|
      $stdout.puts line.insert(0, " " * ident)
    end
    $stdout.puts unless para == paras.last
  end
end

#say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)$/)) ⇒ Object

Say (print) something to the user. If the sentence ends with a whitespace or tab character, a new line is not appended (print + flush). Otherwise are passed straight to puts (behavior got from Highline).

Example

say(“I know you knew that.”)



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/thor/shell/basic.rb', line 52

def say(message="", color=nil, force_new_line=(message.to_s !~ /( |\t)$/))
  message = message.to_s
  message = set_color(message, color) if color

  spaces = "  " * padding

  if force_new_line
    $stdout.puts(spaces + message)
  else
    $stdout.print(spaces + message)
  end
  $stdout.flush
end

#say_status(status, message, log_status = true) ⇒ Object

Say a status with the given color and appends the message. Since this method is used frequently by actions, it allows nil or false to be given in log_status, avoiding the message from being shown. If a Symbol is given in log_status, it’s used as the color.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/thor/shell/basic.rb', line 71

def say_status(status, message, log_status=true)
  return if quiet? || log_status == false
  spaces = "  " * (padding + 1)
  color  = log_status.is_a?(Symbol) ? log_status : :green

  status = status.to_s.rjust(12)
  status = set_color status, color, true if color

  $stdout.puts "#{status}#{spaces}#{message}"
  $stdout.flush
end

#set_color(string, color, bold = false) ⇒ Object

Apply color to the given string with optional bold. Disabled in the Thor::Shell::Basic class.



209
210
211
 
# File 'lib/thor/shell/basic.rb', line 209

def set_color(string, color, bold=false) #:nodoc:
  string
end

#yes?(statement, color = nil) ⇒ Boolean

Make a question the to user and returns true if the user replies “y” or “yes”.

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/thor/shell/basic.rb', line 86

def yes?(statement, color=nil)
  !!(ask(statement, color) =~ is?(:yes))
end