Class: Thor::Shell::Basic

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

Overview

rubocop:disable ClassLength

Direct Known Subclasses

Color, HTML

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Basic

Initialize base, mute and padding to nil.



12
13
14
 
# File 'lib/thor-plus/shell/basic.rb', line 12

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

Instance Attribute Details

#base ⇒ Object

Returns the value of attribute base.



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

def base
  @base
end

#padding ⇒ Object

Returns the value of attribute padding.



8
9
10
 
# File 'lib/thor-plus/shell/basic.rb', line 8

def padding
  @padding
end

Instance Method Details

#ask(statement, *args) ⇒ Object

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.

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



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

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.



289
290
291
 
# File 'lib/thor-plus/shell/basic.rb', line 289

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/thor-plus/shell/basic.rb', line 242

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

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

    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..."
      fail SystemExit
    when is?(:diff)
      show_diff(destination, yield) if block_given?
      say "Retrying..."
    else
      say file_collision_help
    end
  end
end

#indent(count = 1, &block) ⇒ Object

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



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

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

#mute ⇒ Object

Mute everything that’s inside given block



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

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

#mute? ⇒ Boolean

Check if base is muted

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/thor-plus/shell/basic.rb', line 27

def mute? # rubocop:disable TrivialAccessors
  @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) 


126
127
128
 
# File 'lib/thor-plus/shell/basic.rb', line 126

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

#print_in_columns(array) ⇒ Object

Prints values in columns

Parameters

Array[String, String, …]



135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/thor-plus/shell/basic.rb', line 135

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

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

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.



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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/thor-plus/shell/basic.rb', line 157

def print_table(array, options = {}) # rubocop:disable MethodLength
  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

#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

indent<Integer>

Indent each line of the printed paragraph by indent value.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/thor-plus/shell/basic.rb', line 217

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

#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.”)



88
89
90
91
92
93
94
 
# File 'lib/thor-plus/shell/basic.rb', line 88

def say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
  buffer = prepare_message(message, *color)
  buffer << "\n" if force_new_line && !message.to_s.end_with?("\n")

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/thor-plus/shell/basic.rb', line 101

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

  buffer = "#{status}#{spaces}#{message}"
  buffer << "\n" unless buffer.end_with?("\n")

  stdout.print(buffer)
  stdout.flush
end

#set_color(string, *args) ⇒ Object

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



296
297
298
 
# File 'lib/thor-plus/shell/basic.rb', line 296

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

#terminal_width ⇒ Object

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



273
274
275
276
277
278
279
280
281
282
 
# File 'lib/thor-plus/shell/basic.rb', line 273

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

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

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

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/thor-plus/shell/basic.rb', line 119

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