Module: Planter::Prompt

Included in:

Planter

Defined in:

lib/planter/prompt.rb

Overview

Individual question

Defined Under Namespace

Classes: Question

Class Method Summary

• .choice(choices, prompt = 'Make a selection', default_response: nil) ⇒ String

  Choose from an array of multiple choices.

• .file_what?(entry) ⇒ Symbol

  Determine what to do with a file.

• .yn(question, default_response: false) ⇒ Boolean

  Ask a yes or no question in the terminal.

Class Method Details

.choice(choices, prompt = 'Make a selection', default_response: nil) ⇒ String

Choose from an array of multiple choices. Letter surrounded in parenthesis becomes character for response. Only one letter should be specified per choice and must be unique.

Parameters:

• choices (Array) —

  The choices

• prompt (String) (defaults to: 'Make a selection') —

  The prompt

• default_response (String) (defaults to: nil) —

  The character of the default response

Returns:

• (String) —

  string of selected response with parenthesis removed

# File 'lib/planter/prompt.rb', line 274

def self.choice(choices, prompt = 'Make a selection', default_response: nil)
  $stdin.reopen('/dev/tty')

  choices = choices.choices_to_hash if choices.is_a?(Array) && choices.first.is_a?(Hash)

  if choices.is_a?(Hash)
    choices.stringify!
    numeric = choices.keys.first =~ /^\(?\d+\.?\)? /
    keys = choices.keys.to_options(numeric)
    values = choices.values.map(&:clean_value)
    choices = choices.keys
  else
    numeric = choices.first =~ /^\(?\d+\.?\)? /
    keys = choices.to_options(numeric)
    values = choices.to_values.map(&:clean_value)
  end

  die('Choice(s) without selector, please edit config') unless keys.all?(&:selector?)

  default = case default_response.to_s
            when /^\d+$/
              values[default.to_i]
            when /^[a-z]$/i
              keys.include?(default_response) ? values[keys.index(default_response)] : nil
            end

  # If --defaults is set or not an interactive shell, return default
  return default if Planter.accept_defaults || ENV['PLANTER_DEBUG'] || !$stdout.isatty

  default = default_response.to_s if default_response

  # clear the buffer
  if ARGV&.length
    ARGV.length.times do
      ARGV.shift
    end
  end
  system 'stty cbreak'

  vertical = numeric || choices.join(', ').length + 4 > TTY::Screen.cols

  desc = keys.map { |c| c.highlight_character(default: default) }
  abbr = keys.abbr_choices(default: default)

  options = if vertical
              "{x}#{desc.join("\n")}\n{by}#{prompt}{x} #{abbr}{bw}? "
            else
              "{by}#{prompt}{bw}?\n#{desc.join(', ')}{x} #{abbr}:{x} "
            end

  $stdout.syswrite options.x

  res = if numeric && choices.length > 9
          $stdin.sysread choices.length.to_s.length
        else
          $stdin.sysread 1
        end

  puts
  system 'stty cooked'

  res.chomp!
  res.downcase!

  res = res.empty? ? default : res

  return choice(choices, prompt, default_response: default_response) if res.nil? || res.empty?

  if res.to_i.positive?
    values[res.to_i - 1]
  elsif res =~ /^[a-z]/ && keys&.option_index(res)
    values[keys.option_index(res)]
  end
end

.file_what?(entry) ⇒ Symbol

Determine what to do with a file

Parameters:

• entry (FileEntry) —

  The file entry

Returns:

• (Symbol) —

  :merge, :overwrite, :copy, :ignore

# File 'lib/planter/prompt.rb', line 355

def self.file_what?(entry)
  options = %w[(o)vewrite (m)erge]
  options << '(c)opy' unless File.exist?(entry.target)
  options << '(i)gnore'
  opt = Prompt.choice(options, "What do you want to do with #{File.basename(entry.target)}", default_response: 'i')
  case opt
  when /^m/
    :merge
  when /^o/
    :overwrite
  when /^c/
    :copy
  else
    :ignore
  end
end

.yn(question, default_response: false) ⇒ Boolean

Ask a yes or no question in the terminal

Parameters:

• question (String) —

  The question to ask

• default_response (Boolean) (defaults to: false) —

  default response if no input

Returns:

• (Boolean) —

  yes or no

# File 'lib/planter/prompt.rb', line 382

def self.yn(question, default_response: false)
  $stdin.reopen('/dev/tty')

  default = if default_response.is_a?(String)
              default_response =~ /y/i ? true : false
            else
              default_response
            end

  # if PLANTER_DEBUG is set, answer default
  return true if ENV['PLANTER_DEBUG']

  # if this isn't an interactive shell, answer default
  return default unless $stdout.isatty

  # If --defaults is set, return default
  return default if Planter.accept_defaults

  # clear the buffer
  if ARGV&.length
    ARGV.length.times do
      ARGV.shift
    end
  end
  system 'stty cbreak'

  options = if default.nil?
              '{w}[{bw}y{w}/{bw}n{w}]'
            else
              "{w}[#{default ? '{bg}Y{w}/{bw}n' : '{bw}y{w}/{bg}N'}{w}]"
            end

  $stdout.syswrite "{bw}#{question.sub(/\?$/, '')} #{options}{bw}? {x}".x
  res = $stdin.sysread 1
  puts
  system 'stty cooked'

  res.chomp!
  res.downcase!

  return default if res.empty?

  res =~ /y/i ? true : false
end