Class: Bundler::Thor::Shell::Basic

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

Direct Known Subclasses

Color, HTML

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Basic

Initialize base, mute and padding to nil.



13
14
15
16
17
18
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 13

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

Instance Attribute Details

#base ⇒ Object

Returns the value of attribute base.



8
9
10
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 8

def base
  @base
end

#padding ⇒ Object

Returns the value of attribute padding.



9
10
11
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 9

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)



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

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 Bundler::Thor internally and should not be used inside your scripts. If something went wrong, you can always raise an exception. If you raise a Bundler::Thor::Error, it will be rescued and wrapped in the method below.



251
252
253
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 251

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



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
237
238
239
240
241
242
243
244
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 207

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(block_given?)
    end
  end
end

#indent(count = 1) ⇒ Object

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



43
44
45
46
47
48
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 43

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

#mute ⇒ Object

Mute everything that’s inside given block



22
23
24
25
26
27
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 22

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

#mute? ⇒ Boolean

Check if base is muted

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 31

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) 


156
157
158
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 156

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, …]



165
166
167
168
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 165

def print_in_columns(array)
  printer = ColumnPrinter.new(stdout)
  printer.print(array)
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.

borders<Boolean>

Adds ascii borders.



180
181
182
183
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 180

def print_table(array, options = {}) # rubocop:disable Metrics/MethodLength
  printer = TablePrinter.new(stdout, options)
  printer.print(array)
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.



194
195
196
197
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 194

def print_wrapped(message, options = {})
  printer = WrappedPrinter.new(stdout, options)
  printer.print(message)
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.”)



98
99
100
101
102
103
104
105
106
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 98

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



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

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.



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

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 Bundler::Thor::Shell::Basic class.



258
259
260
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 258

def set_color(string, *) #: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) 


149
150
151
 
# File 'lib/bundler/vendor/thor/lib/thor/shell/basic.rb', line 149

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