Class: Thor::Shell::Basic
- Defined in:
- lib/vendor/thor/lib/thor/shell/basic.rb
Instance Attribute Summary collapse
-
#base ⇒ Object
Returns the value of attribute base.
-
#padding ⇒ Object
Returns the value of attribute padding.
Instance Method Summary collapse
-
#ask(statement, *args) ⇒ Object
Asks something to the user and receives a response.
-
#error(statement) ⇒ Object
Called if something goes wrong during the execution.
-
#file_collision(destination) ⇒ Object
Deals with file collision and returns true if the file should be overwritten and false otherwise.
-
#initialize ⇒ Basic
constructor
Initialize base, mute and padding to nil.
-
#mute ⇒ Object
Mute everything that’s inside given block.
-
#mute? ⇒ Boolean
Check if base is muted.
-
#no?(statement, color = nil) ⇒ Boolean
Make a question the to user and returns true if the user replies “n” or “no”.
-
#print_table(table, options = {}) ⇒ Object
Prints a table.
-
#print_wrapped(message, options = {}) ⇒ Object
Prints a long string, word-wrapping the text to the current width of the terminal display.
-
#say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)$/)) ⇒ Object
Say (print) something to the user.
-
#say_status(status, message, log_status = true) ⇒ Object
Say a status with the given color and appends the message.
-
#set_color(string, color, bold = false) ⇒ Object
Apply color to the given string with optional bold.
-
#yes?(statement, color = nil) ⇒ Boolean
Make a question the to user and returns true if the user replies “y” or “yes”.
Constructor Details
#initialize ⇒ Basic
Initialize base, mute and padding to nil.
10 11 12 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 10 def initialize #:nodoc: @base, @mute, @padding = nil, false, 0 end |
Instance Attribute Details
#base ⇒ Object
Returns the value of attribute base.
6 7 8 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 6 def base @base end |
#padding ⇒ Object
Returns the value of attribute padding.
6 7 8 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 6 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.
Example
ask(“What is your name?”)
ask(“What is your favorite Neopolitan flavor?”, :limited_to => [“strawberry”, “chocolate”, “vanilla”])
47 48 49 50 51 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 47 def ask(statement, *args) = args.last.is_a?(Hash) ? args.pop : {} [:limited_to] ? ask_filtered(statement, [:limited_to], *args) : ask_simply(statement, *args) 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.
212 213 214 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 212 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
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 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 181 def file_collision(destination) return true if @always_force = block_given? ? "[Ynaqdh]" : "[Ynaqh]" while true answer = ask %[Overwrite #{destination}? (enter "h" for help) #{}] 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/vendor/thor/lib/thor/shell/basic.rb', line 16 def mute @mute = true yield ensure @mute = false end |
#mute? ⇒ Boolean
Check if base is muted
25 26 27 |
# File 'lib/vendor/thor/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”.
101 102 103 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 101 def no?(statement, color=nil) !yes?(statement, color) end |
#print_table(table, 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.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 114 def print_table(table, ={}) return if table.empty? formats, indent, colwidth = [], [:indent].to_i, [:colwidth] [:truncate] = terminal_width if [:truncate] == true formats << "%-#{colwidth + 2}s" if colwidth start = colwidth ? 1 : 0 colcount = table.max{|a,b| a.size <=> b.size }.size start.upto(colcount - 2) do |i| maxima ||= table.map {|row| row[i] ? row[i].size : 0 }.max formats << "%-#{maxima + 2}s" end formats[0] = formats[0].insert(0, " " * indent) formats << "%s" table.each do |row| sentence = "" row.each_with_index do |column, i| sentence << formats[i] % column.to_s end sentence = truncate(sentence, [:truncate]) if [: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.
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 154 def print_wrapped(, ={}) indent = [:indent] || 0 width = terminal_width - indent paras = .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)$/)) ⇒ 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.”)
60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 60 def say(="", color=nil, force_new_line=(.to_s !~ /( |\t)$/)) = .to_s = set_color(, color) if color spaces = " " * padding if force_new_line stdout.puts(spaces + ) else stdout.print(spaces + ) 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.
79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 79 def say_status(status, , 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}#{}" 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.
219 220 221 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 219 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”.
94 95 96 |
# File 'lib/vendor/thor/lib/thor/shell/basic.rb', line 94 def yes?(statement, color=nil) !!(ask(statement, color) =~ is?(:yes)) end |