Class: Thor::Shell::Basic

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

Direct Known Subclasses

Color, HTML

Constant Summary collapse

DEFAULT_TERMINAL_WIDTH =
80

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeBasic

Initialize base, mute and padding to nil.


11
12
13
14
15
16
# File 'lib/thor/shell/basic.rb', line 11

def initialize #:nodoc:
  @base = nil
  @mute = false
  @padding = 0
  @always_force = false
end

Instance Attribute Details

#baseObject

Returns the value of attribute base


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

def base
  @base
end

#paddingObject

Returns the value of attribute padding


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

def padding
  @padding
end

Instance Method Details

#ask(statement, *args) ⇒ Object

Asks something to the user and receives a response.

If a default value is specified it will be presented to the user and allows them to select that value with an empty response. This option is ignored when limited answers are supplied.

If asked to limit the correct responses, you can pass in an array of acceptable answers. If one of those is not supplied, they will be shown a message stating that one of those answers must be given and re-asked the question.

If asking for sensitive information, the :echo option can be set to false to mask user input from $stdin.

If the required input is a path, then set the path option to true. This will enable tab completion for file paths relative to the current working directory on systems that support Readline.

Example

ask(“What is your name?”)

ask(“What is the planet furthest from the sun?”, :default => “Pluto”)

ask(“What is your favorite Neopolitan flavor?”, :limited_to => [“strawberry”, “chocolate”, “vanilla”])

ask(“What is your password?”, :echo => false)

ask(“Where should the file be saved?”, :path => true)


78
79
80
81
82
83
84
85
86
87
# File 'lib/thor/shell/basic.rb', line 78

def ask(statement, *args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  color = args.first

  if options[:limited_to]
    ask_filtered(statement, color, options)
  else
    ask_simply(statement, color, options)
  end
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 something went wrong, you can always raise an exception. If you raise a Thor::Error, it will be rescued and wrapped in the method below.


342
343
344
# File 'lib/thor/shell/basic.rb', line 342

def error(statement)
  stderr.puts statement
end

#file_collision(destination) ⇒ Object

Deals with file collision and returns true if the file should be overwritten 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 and merge


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
# File 'lib/thor/shell/basic.rb', line 285

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

  loop do
    answer = ask(
      %[Overwrite #{destination}? (enter "h" for help) #{options}],
      :add_to_history => false
    )

    case answer
    when nil
      say ""
      return true
    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..."
    when is?(:merge)
      if block_given? && !merge_tool.empty?
        merge(destination, yield)
        return nil
      end

      say "Please specify merge tool to `THOR_MERGE` env."
    else
      say file_collision_help
    end
  end
end

#indent(count = 1) ⇒ Object

Sets the output padding while executing a block and resets it.


41
42
43
44
45
46
# File 'lib/thor/shell/basic.rb', line 41

def indent(count = 1)
  orig_padding = padding
  self.padding = padding + count
  yield
  self.padding = orig_padding
end

#muteObject

Mute everything that's inside given block


20
21
22
23
24
25
# File 'lib/thor/shell/basic.rb', line 20

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

#mute?Boolean

Check if base is muted

Returns:

  • (Boolean)

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

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)

154
155
156
# File 'lib/thor/shell/basic.rb', line 154

def no?(statement, color = nil)
  !!(ask(statement, color, :add_to_history => false) =~ is?(:no))
end

Prints values in columns

Parameters

Array[String, String, …]


163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/thor/shell/basic.rb', line 163

def print_in_columns(array)
  return if array.empty?
  colwidth = (array.map { |el| el.to_s.size }.max || 0) + 2
  array.each_with_index do |value, index|
    # Don't output trailing spaces when printing the last column
    if ((((index + 1) % (terminal_width / colwidth))).zero? && !index.zero?) || index + 1 == array.length
      stdout.puts value
    else
      stdout.printf("%-#{colwidth}s", value)
    end
  end
end

Prints a table.

Parameters

Array[Array[String, String, …]]

Options

indent<Integer>

Indent the first column by indent value.

colwidth<Integer>

Force the first column to colwidth spaces wide.


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/thor/shell/basic.rb', line 185

def print_table(array, options = {}) # rubocop:disable MethodLength
  return if array.empty?

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

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

  colcount = array.max { |a, b| a.size <=> b.size }.size

  maximas = []

  start.upto(colcount - 1) do |index|
    maxima = array.map { |row| row[index] ? row[index].to_s.size : 0 }.max
    maximas << maxima
    formats << if index == colcount - 1
                 # Don't output 2 trailing spaces when printing the last column
                 "%-s".dup
               else
                 "%-#{maxima + 2}s".dup
               end
  end

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

  array.each do |row|
    sentence = "".dup

    row.each_with_index do |column, index|
      maxima = maximas[index]

      f = if column.is_a?(Numeric)
        if index == row.size - 1
          # Don't output 2 trailing spaces when printing the last column
          "%#{maxima}s"
        else
          "%#{maxima}s  "
        end
      else
        formats[index]
      end
      sentence << f % column.to_s
    end

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

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

Parameters

String

Options

indent<Integer>

Indent each line of the printed paragraph by indent value.


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/thor/shell/basic.rb', line 247

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

  paras.map! do |unwrapped|
    words = unwrapped.split(" ")
    counter = words.first.length
    words.inject do |memo, word|
      word = word.gsub(/\n\005/, "\n").gsub(/\005/, "\n")
      counter = 0 if word.include? "\n"
      if (counter + word.length + 1) < width
        memo = "#{memo} #{word}"
        counter += (word.length + 1)
      else
        memo = "#{memo}\n#{word}"
        counter = word.length
      end
      memo
    end
  end.compact!

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

#say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/)) ⇒ 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.”)


96
97
98
99
100
101
102
103
104
# File 'lib/thor/shell/basic.rb', line 96

def say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
  return if quiet?

  buffer = prepare_message(message, *color)
  buffer << "\n" if force_new_line && !message.to_s.end_with?("\n")

  stdout.print(buffer)
  stdout.flush
end

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

Say (print) an error 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_error(“error: something went wrong”)


113
114
115
116
117
118
119
120
121
# File 'lib/thor/shell/basic.rb', line 113

def say_error(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
  return if quiet?

  buffer = prepare_message(message, *color)
  buffer << "\n" if force_new_line && !message.to_s.end_with?("\n")

  stderr.print(buffer)
  stderr.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.


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/thor/shell/basic.rb', line 128

def say_status(status, message, log_status = true)
  return if quiet? || log_status == false
  spaces = "  " * (padding + 1)
  status = status.to_s.rjust(12)
  margin = " " * status.length + spaces

  color  = log_status.is_a?(Symbol) ? log_status : :green
  status = set_color status, color, true if color

  message = message.to_s.chomp.gsub(/(?<!\A)^/, margin)
  buffer = "#{status}#{spaces}#{message}\n"

  stdout.print(buffer)
  stdout.flush
end

#set_color(string) ⇒ Object

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


349
350
351
# File 'lib/thor/shell/basic.rb', line 349

def set_color(string, *) #:nodoc:
  string
end

#terminal_widthObject

This code was copied from Rake, available under MIT-LICENSE Copyright © 2003, 2004 Jim Weirich


326
327
328
329
330
331
332
333
334
335
# File 'lib/thor/shell/basic.rb', line 326

def terminal_width
  result = if ENV["THOR_COLUMNS"]
    ENV["THOR_COLUMNS"].to_i
  else
    unix? ? dynamic_width : DEFAULT_TERMINAL_WIDTH
  end
  result < 10 ? DEFAULT_TERMINAL_WIDTH : result
rescue
  DEFAULT_TERMINAL_WIDTH
end

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

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

Returns:

  • (Boolean)

147
148
149
# File 'lib/thor/shell/basic.rb', line 147

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