Class: Thor::Shell::Basic

Inherits:
Object
  • 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

- (Basic) initialize

Initialize base, mute and padding to nil.



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

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

Instance Attribute Details

- (Object) base

Returns the value of attribute base



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

def base
  @base
end

- (Object) padding

Returns the value of attribute padding



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

def padding
  @padding
end

Instance Method Details

- (Object) ask(statement, *args)

Asks something to the user and receives a response.

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.

Example

ask("What is your name?")

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



48
49
50
51
52
# File 'lib/thor/shell/basic.rb', line 48

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

  options[:limited_to] ? ask_filtered(statement, options[:limited_to], *args) : ask_simply(statement, *args)
end

- (Object) error(statement)

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.



265
266
267
# File 'lib/thor/shell/basic.rb', line 265

def error(statement)
  stderr.puts statement
end

- (Object) file_collision(destination)

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'lib/thor/shell/basic.rb', line 221

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

- (Object) mute

Mute everything that's inside given block



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

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

- (Boolean) mute?

Check if base is muted



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

def mute?
  @mute
end

- (Boolean) no?(statement, color = nil)

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



103
104
105
# File 'lib/thor/shell/basic.rb', line 103

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

Prints values in columns

Parameters

Array[String, String, ...]



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

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.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/thor/shell/basic.rb', line 134

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

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

  formats << "%-#{colwidth + 2}s" 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
    if index == colcount - 1
      # Don't output 2 trailing spaces when printing the last column
      formats << "%-s"
    else
      formats << "%-#{maxima + 2}s"
    end
  end

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

  array.each do |row|
    sentence = ""

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

      if column.is_a?(Numeric)
        if index == row.size - 1
          # Don't output 2 trailing spaces when printing the last column
          f = "%#{maxima}s"
        else
          f = "%#{maxima}s  "
        end
      else
        f = 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.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/thor/shell/basic.rb', line 194

def print_wrapped(message, options={})
  indent = options[:indent] || 0
  width = terminal_width - indent
  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, " " * indent)
    end
    stdout.puts unless para == paras.last
  end
end

- (Object) say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))

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.")



61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/thor/shell/basic.rb', line 61

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

- (Object) say_status(status, message, log_status = true)

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.



81
82
83
84
85
86
87
88
89
90
91
# File 'lib/thor/shell/basic.rb', line 81

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

- (Object) set_color(string, *args)

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



272
273
274
# File 'lib/thor/shell/basic.rb', line 272

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

- (Object) terminal_width

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



249
250
251
252
253
254
255
256
257
258
# File 'lib/thor/shell/basic.rb', line 249

def terminal_width
  if ENV['THOR_COLUMNS']
    result = ENV['THOR_COLUMNS'].to_i
  else
    result = unix? ? dynamic_width : 80
  end
  (result < 10) ? 80 : result
rescue
  80
end

- (Boolean) yes?(statement, color = nil)

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



96
97
98
# File 'lib/thor/shell/basic.rb', line 96

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