class Canis::Bottomline::Question

Attributes

_case[RW]

Used to control character case processing for the answer to this question. See HighLine::Question.change_case() for acceptable settings.

above[RW]

Used to control range checks for answer.

answer_type[RW]

The type that will be used to convert this answer.

below[RW]

Used to control range checks for answer.

change_proc[RW]

Called when any character is pressed with the string.

q.change_proc = Proc.new {|str| Dir.glob(str +"*") }
character[RW]

Can be set to true to use HighLine's cross-platform character reader instead of fetching an entire line of input. (Note: HighLine's character reader ONLY supports STDIN on Windows and Unix.) Can also be set to :getc to use that method on the input stream.

WARNING: The echo and overwrite attributes for a question are ignored when using the :getc method.

color_pair[RW]
completion_proc[RW]

If the user presses tab in ask(), then this proc is used to fill in values. Typically, for files. e.g.

q.completion_proc = Proc.new {|str| Dir.glob(str +"*") }
confirm[RW]

Asks a yes or no confirmation question, to ensure a user knows what they have just agreed to. If set to true the question will be, “Are you sure? ” Any other true value for this attribute is assumed to be the question to ask. When false or nil (the default), answers are not confirmed.

default[RW]

Used to provide a default answer to this question.

directory[RW]

The directory from which a user will be allowed to select files, when File or Pathname is specified as an answer_type. Initially set to Pathname.new(File.expand_path(File.dirname($0))).

echo[RW]

Can be set to true or false to control whether or not input will be echoed back to the user. A setting of true will cause echo to match input, but any other true value will be treated as to String to echo for each character typed.

This requires HighLine's character reader. See the character attribute for details.

Note: When using HighLine to manage echo on Unix based systems, we recommend installing the termios gem. Without it, it's possible to type fast enough to have letters still show up (when reading character by character only).

first_answer[W]

When set to a non nil value, this will be tried as an answer to the question. If this answer passes validations, it will become the result without the user ever being prompted. Otherwise this value is discarded, and this Question is resolved as a normal call to HighLine.ask().

gather[RW]

When set, the user will be prompted for multiple answers which will be collected into an Array or Hash and returned as the final answer.

You can set gather to an Integer to have an Array of exactly that many answers collected, or a String/Regexp to match an end input which will not be returned in the Array.

Optionally gather can be set to a Hash. In this case, the question will be asked once for each key and the answers will be returned in a Hash, mapped by key. The @key variable is set before each question is evaluated, so you can use it in your question.

glob[RW]

The glob pattern used to limit file selection when File or Pathname is specified as an answer_type. Initially set to "*".

help_text[RW]

text to be shown if user presses M-h

history[RW]
in[RW]

If set, answer must pass an include?() check on this object.

key_handler_proc[RW]

Called when any control-key is pressed, one that we are not handling

q.key_handler_proc = Proc.new {|ch| xxxx) }
limit[RW]

Allows you to set a character limit for input.

If not set, a default of 100 is used

overwrite[RW]

When set to true the question is asked, but output does not progress to the next line. The Cursor is moved back to the beginning of the question line and it is cleared so that all the contents of the line disappear from the screen.

question[RW]

The ERb template of the question to be asked.

readline[RW]

Use the Readline library to fetch input. This allows input editing as well as keeping a history. In addition, tab will auto-complete within an Array of choices or a file listing.

WARNING: This option is incompatible with all of HighLine's character reading modes and it causes HighLine to ignore the specified input stream.

this messes up in ncurses RK 2010-10-24 12:23

responses[R]

A Hash that stores the various responses used by HighLine to notify the user. The currently used responses and their purpose are as follows:

:ambiguous_completion

Used to notify the user of an ambiguous answer the auto-completion system cannot resolve.

:ask_on_error

This is the question that will be redisplayed to the user in the event of an error. Can be set to :question to repeat the original question.

:invalid_type

The error message shown when a type conversion fails.

:no_completion

Used to notify the user that their selection does not have a valid auto-completion match.

:not_in_range

Used to notify the user that a provided answer did not satisfy the range requirement tests.

:not_valid

The error message shown when validation checks fail.

validate[RW]

If set to a Regexp, the answer must match (before type conversion). Can also be set to a Proc which will be called with the provided answer to validate with a true or false return.

whitespace[RW]

Used to control whitespace processing for the answer to this question. See HighLine::Question.remove_whitespace() for acceptable settings.

Public Class Methods

new( question, answer_type ) { |self| ... } click to toggle source

Create an instance of HighLine::Question. Expects a question to ask (can be "") and an answer_type to convert the answer to. The answer_type parameter must be a type recognized by Question.convert(). If given, a block is yeilded the new Question object to allow custom initializaion.

# File lib/canis/core/util/extras/bottomline.rb, line 125
def initialize( question, answer_type )
  # initialize instance data
  @question    = question
  @answer_type = answer_type

  @character    = nil
  @limit        = nil
  @echo         = true
  @readline     = false
  @whitespace   = :strip
  @_case         = nil
  @default      = nil
  @validate     = nil
  @above        = nil
  @below        = nil
  @in           = nil
  @confirm      = nil
  @gather       = false
  @first_answer = nil
  @directory    = Pathname.new(File.expand_path(File.dirname($0)))
  @glob         = "*"
  @responses    = Hash.new
  @overwrite    = false
  @history      = nil

  # allow block to override settings
  yield self if block_given?

  #$log.debug " XXX default #{@default}" if $log.debug?
  #$log.debug " XXX history #{@history}" if $log.debug?

  # finalize responses based on settings
  build_responses
end

Public Instance Methods

answer_or_default( answer_string ) click to toggle source

Returns the provided answer_string or the default answer for this Question if a default was set and the answer is empty. NOTE: in our case, the user actually edits this value (in highline it is used if user enters blank)

# File lib/canis/core/util/extras/bottomline.rb, line 335
def answer_or_default( answer_string )
  if answer_string.length == 0 and not @default.nil?
    @default
  else
    answer_string
  end
end
build_responses( ) click to toggle source

Called late in the initialization process to build intelligent responses based on the details of this Question object.

# File lib/canis/core/util/extras/bottomline.rb, line 347
def build_responses(  )
  ### WARNING:  This code is quasi-duplicated in     ###
  ### Menu.update_responses().  Check there too when ###
  ### making changes!                                ###
  append_default unless default.nil?
  @responses = { :ambiguous_completion =>
    "Ambiguous choice.  " +
      "Please choose one of #{@answer_type.inspect}.",
      :ask_on_error         =>
    "?  ",
      :invalid_type         =>
    "You must enter a valid #{@answer_type}.",
      :no_completion        =>
    "You must choose one of " +
      "#{@answer_type.inspect}.",
      :not_in_range         =>
    "Your answer isn't within the expected range " +
      "(#{expected_range}).",
      :not_valid            =>
      "Your answer isn't valid (must match " +
        "#{@validate.inspect})." }.merge(@responses)
      ### WARNING:  This code is quasi-duplicated in     ###
      ### Menu.update_responses().  Check there too when ###
      ### making changes!                                ###
end
change_case( answer_string ) click to toggle source

Returns the provided answer_string after changing character case by the rules of this Question. Valid settings for whitespace are:

nil

Do not alter character case. (Default.)

:up

Calls upcase().

:upcase

Calls upcase().

:down

Calls downcase().

:downcase

Calls downcase().

:capitalize

Calls capitalize().

An unrecognized choice (like :none) is treated as nil.

# File lib/canis/core/util/extras/bottomline.rb, line 387
def change_case( answer_string )
  if [:up, :upcase].include?(@_case)
    answer_string.upcase
  elsif [:down, :downcase].include?(@_case)
    answer_string.downcase
  elsif @_case == :capitalize
    answer_string.capitalize
  else
    answer_string
  end
end
convert( answer_string ) click to toggle source

Transforms the given answer_string into the expected type for this Question. Currently supported conversions are:

[...]

Answer must be a member of the passed Array. Auto-completion is used to expand partial answers.

lambda {...}

Answer is passed to lambda for conversion.

Date

Date.parse() is called with answer.

DateTime

DateTime.parse() is called with answer.

File

The entered file name is auto-completed in terms of directory + glob, opened, and returned.

Float

Answer is converted with Kernel.Float().

Integer

Answer is converted with Kernel.Integer().

nil

Answer is left in String format. (Default.)

Pathname

Same as File, save that a Pathname object is returned.

String

Answer is converted with Kernel.String().

Regexp

Answer is fed to Regexp.new().

Symbol

The method to_sym() is called on answer and the result returned.

any other Class

The answer is passed on to Class.parse().

This method throws ArgumentError, if the conversion cannot be completed for any reason.

# File lib/canis/core/util/extras/bottomline.rb, line 427
def convert( answer_string )
  if @answer_type.nil?
    answer_string
  elsif [Float, Integer, String].include?(@answer_type)
    Kernel.send(@answer_type.to_s.to_sym, answer_string)
  elsif @answer_type == Symbol
    answer_string.to_sym
  elsif @answer_type == Regexp
    Regexp.new(answer_string)
  elsif @answer_type.is_a?(Array) or [File, Pathname].include?(@answer_type)
    # cheating, using OptionParser's Completion module
    choices = selection
    #choices.extend(OptionParser::Completion)
    #answer = choices.complete(answer_string)
    answer = choices # bug in completion of optparse
    if answer.nil?
      raise NoAutoCompleteMatch
    end
    if @answer_type.is_a?(Array)
      #answer.last  # we don't need this anylonger
      answer_string # we have already selected
    elsif @answer_type == File
      File.open(File.join(@directory.to_s, answer_string))
    else
      #Pathname.new(File.join(@directory.to_s, answer.last))
      Pathname.new(File.join(@directory.to_s, answer_string))
    end
  elsif [Date, DateTime].include?(@answer_type) or @answer_type.is_a?(Class)
    @answer_type.parse(answer_string)
  elsif @answer_type.is_a?(Proc)
    @answer_type[answer_string]
  end
end
expected_range( ) click to toggle source

Returns a english explination of the current range settings.

# File lib/canis/core/util/extras/bottomline.rb, line 462
def expected_range(  )
  expected = [ ]

  expected << "above #{@above}" unless @above.nil?
  expected << "below #{@below}" unless @below.nil?
  expected << "included in #{@in.inspect}" unless @in.nil?

  case expected.size
  when 0 then ""
  when 1 then expected.first
  when 2 then expected.join(" and ")
  else        expected[0..-2].join(", ") + ", and #{expected.last}"
  end
end
first_answer( ) click to toggle source

Returns first_answer, which will be unset following this call.

# File lib/canis/core/util/extras/bottomline.rb, line 478
def first_answer( )
  @first_answer
ensure
  @first_answer = nil
end
first_answer?( ) click to toggle source

Returns true if first_answer is set.

# File lib/canis/core/util/extras/bottomline.rb, line 485
def first_answer?( )
  not @first_answer.nil?
end
in_range?( answer_object ) click to toggle source

Returns true if the answer_object is greater than the above attribute, less than the below attribute and included?()ed in the in attribute. Otherwise, false is returned. Any nil attributes are not checked.

# File lib/canis/core/util/extras/bottomline.rb, line 495
def in_range?( answer_object )
  (@above.nil? or answer_object > @above) and
  (@below.nil? or answer_object < @below) and
  (@in.nil? or @in.include?(answer_object))
end
remove_whitespace( answer_string ) click to toggle source

Returns the provided answer_string after processing whitespace by the rules of this Question. Valid settings for whitespace are:

nil

Do not alter whitespace.

:strip

Calls strip(). (Default.)

:chomp

Calls chomp().

:collapse

Collapses all whitspace runs to a single space.

:strip_and_collapse

Calls strip(), then collapses all whitspace runs to a single space.

:chomp_and_collapse

Calls chomp(), then collapses all whitspace runs to a single space.

:remove

Removes all whitespace.

An unrecognized choice (like :none) is treated as nil.

This process is skipped, for single character input.

# File lib/canis/core/util/extras/bottomline.rb, line 520
def remove_whitespace( answer_string )
  if @whitespace.nil?
    answer_string
  elsif [:strip, :chomp].include?(@whitespace)
    answer_string.send(@whitespace)
  elsif @whitespace == :collapse
    answer_string.gsub(/\s+/, " ")
  elsif [:strip_and_collapse, :chomp_and_collapse].include?(@whitespace)
    result = answer_string.send(@whitespace.to_s[/^[a-z]+/])
    result.gsub(/\s+/, " ")
  elsif @whitespace == :remove
    answer_string.gsub(/\s+/, "")
  else
    answer_string
  end
end
selection( ) click to toggle source

Returns an Array of valid answers to this question. These answers are only known when answer_type is set to an Array of choices, File, or Pathname. Any other time, this method will return an empty Array.

# File lib/canis/core/util/extras/bottomline.rb, line 542
def selection(  )
  if @answer_type.is_a?(Array)
    @answer_type
  elsif [File, Pathname].include?(@answer_type)
    Dir[File.join(@directory.to_s, @glob)].map do |file|
      File.basename(file)
    end
  else
    [ ]
  end      
end
to_str( ) click to toggle source

Stringifies the question to be asked.

# File lib/canis/core/util/extras/bottomline.rb, line 555
def to_str(  )
  @question
end
valid_answer?( answer_string ) click to toggle source

Returns true if the provided answer_string is accepted by the validate attribute or false if it's not.

It's important to realize that an answer is validated after whitespace and case handling.

# File lib/canis/core/util/extras/bottomline.rb, line 566
def valid_answer?( answer_string )
  @validate.nil? or 
  (@validate.is_a?(Regexp) and answer_string =~ @validate) or
  (@validate.is_a?(Proc)   and @validate[answer_string])
end

Private Instance Methods

append_default( ) click to toggle source

Adds the default choice to the end of question between |...|. Trailing whitespace is preserved so the function of HighLine.say() is not affected.

# File lib/canis/core/util/extras/bottomline.rb, line 579
def append_default(  )
  if @question =~ /([\t ]+)\Z/
    @question << "|#{@default}|#{$1}"
  elsif @question == ""
    @question << "|#{@default}|  "
  elsif @question[-1, 1] == "\n"
    @question[-2, 0] =  "  |#{@default}|"
  else
    @question << "  |#{@default}|"
  end
end