class Thor::Shell::Basic

Attributes

base[RW]
padding[RW]

Public Instance Methods

ask(statement, color=nil) click to toggle source

Ask something to the user and receives a response.

Example

ask("What is your name?")

# File lib/bundler/vendor/thor/shell/basic.rb, line 40
def ask(statement, color=nil)
  say("#{statement} ", color)
  stdin.gets.strip
end
error(statement) click to toggle source

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.

# File lib/bundler/vendor/thor/shell/basic.rb, line 202
def error(statement)
  stderr.puts statement
end
file_collision(destination) { || ... } click to toggle source

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

# File lib/bundler/vendor/thor/shell/basic.rb, line 171
def file_collision(destination)
  return true if @always_force
  options = block_given? ? "[Ynaqdh]" : "[Ynaqh]"

  while true
    answer = ask %Q[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
mute() { || ... } click to toggle source

Mute everything that's inside given block

# File lib/bundler/vendor/thor/shell/basic.rb, line 16
def mute
  @mute = true
  yield
ensure
  @mute = false
end
mute?() click to toggle source

Check if base is muted

# File lib/bundler/vendor/thor/shell/basic.rb, line 25
def mute?
  @mute
end
no?(statement, color=nil) click to toggle source

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

# File lib/bundler/vendor/thor/shell/basic.rb, line 93
def no?(statement, color=nil)
  !yes?(statement, color)
end
padding=(value) click to toggle source

Sets the output padding, not allowing less than zero values.

# File lib/bundler/vendor/thor/shell/basic.rb, line 31
def padding=(value)
  @padding = [0, value].max
end
print_table(table, options={}) click to toggle source

Prints a table.

Parameters

Array[Array[String, String, ...]]

Options

ident<Integer>

Indent the first column by ident value.

colwidth<Integer>

Force the first column to colwidth spaces wide.

print_wrapped(message, options={}) click to toggle source

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

Parameters

String

Options

ident<Integer>

Indent each line of the printed paragraph by ident value.

say(message="", color=nil, force_new_line=(message.to_s !~ /( |\t)$/)) click to toggle source

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

# File lib/bundler/vendor/thor/shell/basic.rb, line 52
def say(message="", color=nil, force_new_line=(message.to_s !~ %r( |\t)$/))
  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
say_status(status, message, log_status=true) click to toggle source

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.

# File lib/bundler/vendor/thor/shell/basic.rb, line 71
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
yes?(statement, color=nil) click to toggle source

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

# File lib/bundler/vendor/thor/shell/basic.rb, line 86
def yes?(statement, color=nil)
  !!(ask(statement, color) =~ is?(:yes))
end

Protected Instance Methods

dynamic_width() click to toggle source

Calculate the dynamic width of the terminal

# File lib/bundler/vendor/thor/shell/basic.rb, line 276
def dynamic_width
  @dynamic_width ||= (dynamic_width_stty.nonzero? || dynamic_width_tput)
end
dynamic_width_stty() click to toggle source
# File lib/bundler/vendor/thor/shell/basic.rb, line 280
def dynamic_width_stty
  %x{stty size 2>/dev/null}.split[1].to_i
end
dynamic_width_tput() click to toggle source
# File lib/bundler/vendor/thor/shell/basic.rb, line 284
def dynamic_width_tput
  %x{tput cols 2>/dev/null}.to_i
end
stderr() click to toggle source
# File lib/bundler/vendor/thor/shell/basic.rb, line 223
def stderr
  $stderr
end
stdin() click to toggle source
# File lib/bundler/vendor/thor/shell/basic.rb, line 219
def stdin
  $stdin
end
stdout() click to toggle source
# File lib/bundler/vendor/thor/shell/basic.rb, line 215
def stdout
  $stdout
end
terminal_width() click to toggle source

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

# File lib/bundler/vendor/thor/shell/basic.rb, line 264
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
truncate(string, width) click to toggle source
# File lib/bundler/vendor/thor/shell/basic.rb, line 292
def truncate(string, width)
  if string.length <= width
    string
  else
    ( string[0, width-3] || "" ) + "..."
  end
end
unix?() click to toggle source
# File lib/bundler/vendor/thor/shell/basic.rb, line 288
def unix?
  RUBY_PLATFORM =~ %r(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/
end