pokedex-terminal 0.2.3 → 0.2.4

data/vendor/bundle/ruby/2.7.0/gems/tty-cursor-0.7.1/lib/tty/cursor/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TTY
+  module Cursor
+    VERSION = "0.7.1"
+  end # Cursor
+end # TTY

data/vendor/bundle/ruby/2.7.0/gems/tty-prompt-0.21.0/CHANGELOG.md

@@ -0,0 +1,379 @@
+# Change log
+
+## [v0.21.0] - 2019-03-08
+
+### Added
+* Add :min option to #multi_select prompt by Katelyn Schiesser(@slowbro)
+
+### Changed
+* Change gemspec to remove test artifacts
+
+### Fixed
+* Fix :help_color option for multi_selct prompt by @robbystk
+
+## [v0.20.0] - 2019-11-24
+
+### Changed
+* Change to update tty-reader dependency
+* Change gemspec to include metadata
+
+### Fixed
+* Fix Choice#from to differentiate between nil and false by Katelyn Schiesser(@slowbro)
+* Fix yes? and no? prompts to stop raising on invalid/blank input by Katelyn Schiesser(@slowbro)
+* Fix Ruby 2.7 keyword arguments warnings
+* Fix question validation to work with nil input
+
+## [v0.19.0] - 2019-05-27
+
+### Added
+* Add Prompt#debug to allow displaying values in terminal's top right corner
+* Add :max to limit number of choices in #multi_select prompt
+* Add :value to pre populate #ask prompt line content
+* Add :auto_hint to expand default hint in #expand prompt by Ewoudt Kellerman(@hellola)
+* Add Timer to track and timeout code execution
+
+### Changed
+* Change Paginator to expose #start_index & #end_index
+* Change Paginator to figure out #start_index based on per page size and adjust boundaries to match active selection
+* Change #ask prompt to allow no question
+* Change #enum_select to automatically assigned non-disabled default option
+* Change #enum_select to set default choice when navigating by page
+* Change #select & #multi_select to allow navigation by page with left/right keys
+* Change #keypress to use Timer
+* Change Choice#from to allow any object coercible to string
+* Change to remove test artifacts from the gem bundle
+* Change to remove timers dependency
+* Change to update tty-reader dependency
+
+## [v0.18.1] - 2018-12-29
+
+### Changed
+* Change #multi_select & #select to auto select first non-disabled active choice
+
+### Fixed
+* Fix #select, #multi_select & #enum_select to allow for symbols as choice names
+
+## [v0.18.0] - 2018-11-24
+
+### Changed
+* Change to update tty-reader dependency
+* Remove encoding magic comments
+
+### Fixed
+* Fix #keypress to stop using the :nonblock option
+* Fix input reading to correctly capture the Esc key(#84)
+* Fix line editing when cursor is on second to last character(#94)
+
+## [v0.17.2] - 2018-11-01
+
+### Fixed
+* Fix #yes? & #no? prompt suffix option to all non-standard characters by Rui(@rpbaltazar)
+
+## [v0.17.1] - 2018-10-03
+
+### Change
+* Change #select, #multi_select to allow alphanumeric, punctuation and space characters in filters
+
+### Fixed
+* Fix #select by making filter an array to avoid frozen string issues by Chris Hoffman(@yarmiganosca)
+
+## [v0.17.0] - 2018-08-05
+
+### Changed
+* Change to update tty-reader & tty-cursor dependencies
+* Change to directly require files in gemspec
+
+## [v0.16.1] - 2018-04-29
+
+### Fixed
+* Fix key events subscription to only listen for the current prompt events
+
+## [v0.16.0] - 2018-03-11
+
+### Added
+* Add :disabled key to Choice
+* Add ability to disable choices in #select, #multi_selct & #enum_select prompts
+* Add #frozen_string_literal to all files
+
+### Changed
+* Change Choice#from to allow parsing different data structures
+* Change all classes to prevent strings mutations
+* Change Timeout to cleanly terminate keypress input without raising errors
+
+### Fixed
+* Fix #select, #enum_select & #multi_select navigation to work correctly with items longer than terminal screen width
+* Fix timeout on Ruby 2.5 and stop raising Timeout::Error
+
+## [v0.15.0] - 2018-02-08
+
+### Added
+* Add ability to filter list items in #select, #multi_select & #enum_selct prompts by Saverio Miroddi(@saveriomiroddi)
+* Add support for array of values for an answer collector key by Danny Hadley(@dadleyy)
+
+### Changed
+* Relax dependency on timers by Andy Brody(@brodygov)
+
+## [v0.14.0] - 2018-01-01
+
+### Added
+* Add :cycle option to #select, #multi_select & #enum_select prompts to allow toggling between infinite and bounded list by Jonas Müller(@muellerj)
+
+### Changed
+* Change #multi_selct, #select & #enum_select to stop cycling options by default by Jona Müller(@muellerj)
+* Change gemspec to require ruby >= 2.0.0
+* Change #slider prompt to display slider next to query and help underneath
+* Change to use tty-reader v0.2.0 with new line editing features for processing long inputs
+
+### Fixed
+* Fix Paginator & EnumPaginator to allow only positive integer values by Andy Brody(@ab)
+* Fix EnumSelect to report on default option out of range and raise correctly
+* Fix #ask :file & :path converters to correctly locate the files
+* Fix #ask, #multiline to correctly handle long strings that wrap around screen
+* Fix #slider prompt to correctly scale sliding
+
+## [v0.13.2] - 2017-08-30
+
+### Changed
+* Change to extract TTY::Prompt::Reader to its own dependency
+
+## [v0.13.1] - 2017-08-16
+
+### Added
+* Add ability to manually cancel the time scheduler
+
+### Changed
+* Change #keypress to use new scheduler cancelling
+* Change Reader to inline interrupt to allow for early exit
+
+### Fix
+* Fix keypress reading on Windows to distinguish between blocking & non-blocking IO
+
+## [v0.13.0] - 2017-08-11
+
+### Changed
+* Change Timeout to use clock time instead of sleep to measure interval
+* Upgrade tty-cursor to fix save & restore
+
+### Fixed
+* Fix keypress with timeout option to cleanly stop timeout thread
+* Fix Reader on Windows to stop blocking when waiting for key press
+
+## [v0.12.0] - 2017-03-19
+
+### Added
+* Add Multiline question type
+* Add Keypress question type
+* Add Reader::History for storing buffered lines
+* Add Reader::Line for line abstraction
+
+### Changed
+* Remove :read option from Question
+* Chnage Reader#read_line to handle raw mode for processing special
+  characters such as Ctrl+x, navigate through history buffer
+  using up/down arrows, allow editing current line by moving left/right
+  with arrow keys and inserting content
+* Change Reader#read_multiline to gather multi line input correctly,
+  skip empty lines and terminate when Ctrl+d and Ctrl+z are pressed
+* Change Reader::Mode to check if tty is available by Matt Martyn (@MMartyn)
+* Change #keypress prompt to correctly refresh line and accept :keys & :timeout options
+
+### Fixed
+* Fix issue with #select, #multi_selct, #enum_select when choices are
+  provided as hash object together with prompt options.
+* Fix issue with default parameter for yes?/no? prompt by Carlos Fonseca (@carlosefonseca)
+* Fix List#help to allow setting help text through DSL
+
+## [v0.11.0] - 2017-02-26
+
+### Added
+* Add Console for reading input characters on Unix systems
+* Add WinConsole for reading input characters on Windows systems
+* Add WindowsApi to allow for calls to external Windows api
+* Add echo support to multilist by Keith Keith T. Garner(@ktgeek)
+
+### Changed
+* Change Reader to use Console for input reading
+* Change Codes to use codepoints instead of strings
+* Change Reader#read_line to match #gets behaviour
+* Change Symbols to provide Unicode support on windows
+* Change Slider to display Unicode when possible
+* Change ConverterRegistry to be immutable
+* Change Reader to expose #trigger in place of #publish for events firing
+
+### Fixed
+* Fix `modify` throwing exception, when user enters empty input by Igor Rzegocki(@ajgon)
+* Fix #clear_line behaviour by using tty-cursor 0.4.0 to work in all terminals
+* Fix paging issue for lists shorter than :per_page value repeating title
+* Fix #mask prompt to correctly match input on Windows
+* Fix @mask to use default error messages
+* Fix #select & #multi_select prompts to allow changing options with arrow keys on Windows
+* Fix #echo to work correctly in zsh shell by štef(@d4be4st)
+* Fix Slider#keyright event accepting max value outside of range
+* Fix 2.4.0 conversion errors by using necromancer 0.4.0
+* Fix #enum_select preventing selection of first item
+
+## [v0.10.1] - 2017-02-06
+
+### Fixed
+* Fix File namespacing
+
+## [v0.10.0] - 2017-01-01
+
+### Added
+* Add :enable_color option for toggling colors support
+
+### Changed
+* Update pastel dependency version
+
+## [v0.9.0] - 2016-12-20
+
+### Added
+* Add ability to paginate choices list for #select, #multi_select & #enum_select
+  with :per_page, :page_info and :default options
+* Add ability to switch through options in #select & #multi_select using the tab key
+
+### Fixed
+* Fix readers to accept multibyte characters reported by Jaehyun Shin(@keepcosmos)
+
+## [v0.8.0] - 2016-11-29
+
+### Added
+* Add ability to publish custom key events for VIM keybindings customisations etc...
+
+### Fixed
+* Fix Reader#read_char to use Ruby internal buffers instead of direct system call by @kke(Kimmo Lehto)
+* Fix issue with #ask required & validate checks to take into account required when validating values
+* Fix bug with #read_keypress to handle function keys and meta navigation keys
+* Fix issue with default messages not displaying for `range`, `required` and `validate`
+
+## [v0.7.1] - 2016-08-07
+
+### Fixed
+* Fix Reader::Mode to include standard io library
+
+## [v0.7.0] - 2016-07-17
+
+### Added
+* Add :interrupt_handler option to customise keyboard interrupt behaviour
+
+### Changed
+* Remove tty-platform dependency
+
+### Fixed
+* Fix Reader#read_keypress issue when handling interrupt signal by Ondrej Moravcik(@ondra-m)
+* Fix raw & echo modes to use standard library support by Kim Burgestrand(@Burgestrand)
+
+## [v0.6.0] - 2016-05-21
+
+### Changed
+* Upgrade tty-cursor dependency
+
+### Fixed
+* Fix issue with reader trapping signals by @kylekyle
+* Fix expand to use new prev_line implementation
+
+## [v0.5.0] - 2016-03-28
+
+### Added
+* Add ConfirmQuestion for #yes? & #no? calls
+* Add ability to collect more than one answer through #collect call
+* Add Choices#find_by for selecting choice based on attribute
+* Add Prompt#expand for expanding key options
+* Add :active_color, :help_color, :prefix options for customizing prompts display
+
+### Changed
+* Change Choice#from to allow for coersion of complex objects with keys
+* Change Choices#pluck to search through object attributes
+* Change #select :enum option help text to display actual numbers range
+
+### Fixed
+* Fix #no? to correctly ask negative question by @ondra-m
+* Fix #ask :default option to handle nil or empty string
+* Fix #multi_select :default option and color changing
+
+## [v0.4.0] - 2016-02-08
+
+### Added
+* Add :enum option for #select & #multi_select to allow for numerical selection by @rtoshiro
+* Add new key event types to KeyEvent
+* Add #slider for picking values from range of numbers
+* Add #enum_select for selecting option from enumerated list
+* Add ability to configure error messages for #ask call
+* Add new ConversionError type
+
+### Changed
+* Move #blank? to Utils
+* Update pastel dependency
+
+## [v0.3.0] - 2015-12-28
+
+### Added
+* Add prefix option to prompt to customize #ask, #select, #multi_select
+* Add default printing to #ask
+* Add #yes?/#no? boolean queries
+* Add Evaluator and Result for validation checking to Question
+* Add ability for #ask to display error messages on failed validation
+* Add ability to specify in-built names for validation e.i. :email
+* Add KeyEvent for keyboard events publishing to Reader
+* Add #read_multiline to Reader
+* Add :convert option for ask configuration
+* Add ability to specify custom proc converters
+* Add #ask_keypress to gather character input
+* Add #ask_multiline to gather multiline input
+* Add MaskedQuestion & #mask method for masking input stream characters
+
+### Changed
+* Change Reader#read_keypress to be robust and read correctly byte sequences
+* Change Reader#getc to #read_line and extend arguments with echo option
+* Extract cursor movement to dependency tty-cursor
+* Change List & MultiList to subscribe to keyboard events
+* Change to move mode inside reader namespace
+* Remove Response & Error objects
+* Remove :char option from #ask
+* Change :read option to specify mode of reading out of :line, :multiline, :keypress
+* Rename #confirm to #ok
+
+## [v0.2.0] - 2015-11-23
+
+### Added
+* Add ability to select choice form list #select
+* Add ability to select multiple options #multi_select
+* Add :read option to #ask for reading specific type input
+
+### Changed
+* Change #ask api to be similar to #select and #multi_select behaviour
+* Change #ask :argument option to be :required
+* Remove :valid option from #ask as #select is a better solution
+
+## [v0.1.0] - 2015-11-01
+
+* Initial implementation and release
+
+[v0.20.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.19.0...v0.20.0
+[v0.19.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.18.1...v0.19.0
+[v0.18.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.18.0...v0.18.1
+[v0.18.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.17.2...v0.18.0
+[v0.17.2]: https://github.com/piotrmurach/tty-prompt/compare/v0.17.1...v0.17.2
+[v0.17.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.17.0...v0.17.1
+[v0.17.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.16.1...v0.17.0
+[v0.16.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.16.0...v0.16.1
+[v0.16.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.15.0...v0.16.0
+[v0.15.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.14.0...v0.15.0
+[v0.14.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.13.2...v0.14.0
+[v0.13.2]: https://github.com/piotrmurach/tty-prompt/compare/v0.13.1...v0.13.2
+[v0.13.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.13.0...v0.13.1
+[v0.13.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.12.0...v0.13.0
+[v0.12.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.11.0...v0.12.0
+[v0.11.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.10.1...v0.11.0
+[v0.10.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.10.0...v0.10.1
+[v0.10.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.9.0...v0.10.0
+[v0.9.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.8.0...v0.9.0
+[v0.8.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.7.1...v0.8.0
+[v0.7.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.7.0...v0.7.1
+[v0.7.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.6.0...v0.7.0
+[v0.6.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.5.0...v0.6.0
+[v0.5.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.4.0...v0.5.0
+[v0.4.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.1.0

data/vendor/bundle/ruby/2.7.0/gems/tty-prompt-0.21.0/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Piotr Murach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/vendor/bundle/ruby/2.7.0/gems/tty-prompt-0.21.0/README.md

@@ -0,0 +1,1552 @@
+<div align="center">
+  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+</div>
+
+# TTY::Prompt [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+
+[![Gem Version](https://badge.fury.io/rb/tty-prompt.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-prompt.svg?branch=master)][travis]
+[![Build status](https://ci.appveyor.com/api/projects/status/4cguoiah5dprbq7n?svg=true)][appveyor]
+[![Code Climate](https://codeclimate.com/github/piotrmurach/tty-prompt/badges/gpa.svg)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-prompt/badge.svg)][coverage]
+[![Inline docs](http://inch-ci.org/github/piotrmurach/tty-prompt.svg?branch=master)][inchpages]
+
+[gitter]: https://gitter.im/piotrmurach/tty
+[gem]: http://badge.fury.io/rb/tty-prompt
+[travis]: http://travis-ci.org/piotrmurach/tty-prompt
+[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-prompt
+[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-prompt
+[coverage]: https://coveralls.io/github/piotrmurach/tty-prompt
+[inchpages]: http://inch-ci.org/github/piotrmurach/tty-prompt
+
+> A beautiful and powerful interactive command line prompt.
+
+**TTY::Prompt** provides independent prompt component for [TTY](https://github.com/piotrmurach/tty) toolkit.
+
+## Features
+
+* Number of prompt types for gathering user input
+* A robust API for validating complex inputs
+* User friendly error feedback
+* Intuitive DSL for creating complex menus
+* Ability to page long menus
+* Support for Linux, OS X, FreeBSD and Windows systems
+
+## Windows support
+
+`tty-prompt` works across all Unix and Windows systems in the "best possible" way. On Windows, it uses Win32 API in place of terminal device to provide matching functionality.
+
+Since Unix terminals provide richer set of features than Windows PowerShell consoles, expect to have a better experience on Unix-like platform.
+
+Some features like `select` or `multi_select` menus may not work on Windows when run from Git Bash. See GitHub suggested [fixes](https://github.com/git-for-windows/git/wiki/FAQ#some-native-console-programs-dont-work-when-run-from-git-bash-how-to-fix-it).
+
+For Windows, consider installing [ConEmu](https://conemu.github.io/), [cmder](http://cmder.net/) or [PowerCmd](http://www.powercmd.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty-prompt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-prompt
+
+## Contents
+
+* [1. Usage](#1-usage)
+* [2. Interface](#2-interface)
+  * [2.1 ask](#21-ask)
+    * [2.1.1 convert](#211-convert)
+    * [2.1.2 default](#212-default)
+    * [2.1.3 value](#213-value)
+    * [2.1.4 echo](#214-echo)
+    * [2.1.5 error messages](#215-error-messages)
+    * [2.1.6 in](#216-in)
+    * [2.1.7 modify](#217-modify)
+    * [2.1.8 required](#218-required)
+    * [2.1.9 validate](#219-validate)
+  * [2.2 keypress](#22-keypress)
+    * [2.2.1 :timeout](#221-timeout)
+  * [2.3 multiline](#23-multiline)
+  * [2.4 mask](#24-mask)
+  * [2.5 yes?/no?](#25-yesno)
+  * [2.6 menu](#26-menu)
+    * [2.6.1 choices](#261-choices)
+    * [2.6.1.1 :disabled](#2611-disabled)
+    * [2.6.2 select](#262-select)
+      * [2.6.2.1 :per_page](#2621-per_page)
+      * [2.6.2.2 :disabled](#2622-disabled)
+      * [2.6.2.3 :filter](#2623-filter)
+    * [2.6.3 multi_select](#263-multi_select)
+      * [2.6.3.1 :disabled](#2631-disabled)
+      * [2.6.3.2 :echo](#2632-echo)
+      * [2.6.3.3 :filter](#2633-filter)
+      * [2.6.3.4 :min](#2634-min)
+      * [2.6.3.5 :max](#2635-max)
+    * [2.6.4 enum_select](#264-enum_select)
+      * [2.6.4.1 :per_page](#2641-per_page)
+      * [2.6.4.1 :disabled](#2641-disabled)
+  * [2.7 expand](#27-expand)
+    * [2.7.1 auto_hint](#271-auto_hint)
+  * [2.8 collect](#28-collect)
+  * [2.9 suggest](#29-suggest)
+  * [2.10 slider](#210-slider)
+  * [2.11 say](#211-say)
+    * [2.11.1 ok](#2111-ok)
+    * [2.11.2 warn](#2112-warn)
+    * [2.11.3 error](#2113-error)
+  * [2.12 keyboard events](#212-keyboard-events)
+* [3. settings](#3-settings)
+  * [3.1 :symbols](#31-symbols)
+  * [3.2 :active_color](#32-active_color)
+  * [3.3 :enable_color](#33-enable-color)
+  * [3.4 :help_color](#34-help_color)
+  * [3.5 :interrupt](#35-interrupt)
+  * [3.6 :prefix](#36-prefix)
+  * [3.7 :track_history](#37-track_history)
+
+## 1. Usage
+
+In order to start asking questions on the command line, create prompt:
+
+```ruby
+require "tty-prompt"
+
+prompt = TTY::Prompt.new
+```
+
+And then call `ask` with the question for simple input:
+
+```ruby
+prompt.ask('What is your name?', default: ENV['USER'])
+# => What is your name? (piotr)
+```
+
+To confirm input use `yes?`:
+
+```ruby
+prompt.yes?('Do you like Ruby?')
+# => Do you like Ruby? (Y/n)
+```
+
+If you want to input password or secret information use `mask`:
+
+```ruby
+prompt.mask("What is your secret?")
+# => What is your secret? ••••
+```
+
+Asking question with list of options couldn't be easier using `select` like so:
+
+```ruby
+prompt.select("Choose your destiny?", %w(Scorpion Kano Jax))
+# =>
+# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# ‣ Scorpion
+#   Kano
+#   Jax
+```
+
+Also, asking multiple choice questions is a breeze with `multi_select`:
+
+```ruby
+choices = %w(vodka beer wine whisky bourbon)
+prompt.multi_select("Select drinks?", choices)
+# =>
+#
+# Select drinks? (Use ↑/↓ arrow keys, press Space to select and Enter to finish)"
+# ‣ ⬡ vodka
+#   ⬡ beer
+#   ⬡ wine
+#   ⬡ whisky
+#   ⬡ bourbon
+```
+
+To ask for a selection from enumerated list you can use `enum_select`:
+
+```ruby
+choices = %w(emacs nano vim)
+prompt.enum_select("Select an editor?", choices)
+# =>
+#
+# Select an editor?
+#   1) emacs
+#   2) nano
+#   3) vim
+#   Choose 1-3 [1]:
+```
+
+However, if you have a lot of options to choose from you may want to use `expand`:
+
+```ruby
+choices = [
+  { key: 'y', name: 'overwrite this file', value: :yes },
+  { key: 'n', name: 'do not overwrite this file', value: :no },
+  { key: 'a', name: 'overwrite this file and all later files', value: :all },
+  { key: 'd', name: 'show diff', value: :diff },
+  { key: 'q', name: 'quit; do not overwrite this file ', value: :quit }
+]
+prompt.expand('Overwrite Gemfile?', choices)
+# =>
+# Overwrite Gemfile? (enter "h" for help) [y,n,a,d,q,h]
+```
+
+If you wish to collect more than one answer use `collect`:
+
+```ruby
+result = prompt.collect do
+  key(:name).ask('Name?')
+
+  key(:age).ask('Age?', convert: :int)
+
+  key(:address) do
+    key(:street).ask('Street?', required: true)
+    key(:city).ask('City?')
+    key(:zip).ask('Zip?', validate: /\A\d{3}\Z/)
+  end
+end
+# =>
+# {:name => "Piotr", :age => 30, :address => {:street => "Street", :city => "City", :zip => "123"}}
+```
+
+## 2. Interface
+
+### 2.1 ask
+
+In order to ask a basic question do:
+
+```ruby
+prompt.ask("What is your name?")
+```
+
+However, to prompt for more complex input you can use robust API by passing hash of properties or using a block like so:
+
+```ruby
+prompt.ask("What is your name?") do |q|
+  q.required true
+  q.validate /\A\w+\Z/
+  q.modify   :capitalize
+end
+```
+
+#### 2.1.1 convert
+
+The `convert` property is used to convert input to a required type.
+
+By default no conversion is performed. The following conversions are provided:
+
+```ruby
+:bool       # true or false for strings such as "Yes", "No"
+:date       # date type
+:datetime   # datetime type
+:file       # File object
+:float      # decimal or error if cannot convert
+:int        # integer or error if cannot convert
+:path       # Pathname object
+:range      # range type
+:regexp     # regex expression
+:string     # string
+:symbol     # symbol
+```
+
+For example, if you are interested in range type as answer do the following:
+
+```ruby
+prompt.ask("Provide range of numbers?", convert: :range)
+# Provide range of numbers? 1-10
+# => 1..10
+```
+
+You can also provide a custom conversion like so:
+
+```ruby
+prompt.ask('Ingredients? (comma sep list)') do |q|
+  q.convert -> (input) { input.split(/,\s*/) }
+end
+# Ingredients? (comma sep list) milk, eggs, flour
+# => ['milk', 'eggs', 'flour']
+```
+
+#### 2.1.2 default
+
+The `:default` option is used if the user presses return key:
+
+```ruby
+prompt.ask('What is your name?', default: 'Anonymous')
+# =>
+# What is your name? (Anonymous)
+```
+
+#### 2.1.3 value
+
+To pre-populate the input line for editing use `:value` option:
+
+```ruby
+prompt.ask("What is your name?", value: "Piotr")
+# =>
+# What is your name? Piotr
+```
+
+#### 2.1.4 echo
+
+To control whether the input is shown back in terminal or not use `:echo` option like so:
+
+```ruby
+prompt.ask('password:', echo: false)
+```
+
+#### 2.1.5 error messages
+
+By default `tty-prompt` comes with predefined error messages for `required`, `in`, `validate` options.
+
+You can change these and configure to your liking either by passing message as second argument with the option:
+
+```ruby
+prompt.ask('What is your email?') do |q|
+  q.validate(/\A\w+@\w+\.\w+\Z/, 'Invalid email address')
+end
+```
+
+Or change the `messages` key entry out of `:required?`, `:valid?`, `:range?`:
+
+```ruby
+prompt.ask('What is your email?') do |q|
+  q.validate(/\A\w+@\w+\.\w+\Z/)
+  q.messages[:valid?] = 'Invalid email address'
+end
+```
+
+To change default range validation error message do:
+
+```ruby
+prompt.ask('How spicy on scale (1-5)? ') do |q|
+  q.in '1-5'
+  q.messages[:range?] = '%{value} out of expected range #{in}'
+end
+```
+
+#### 2.1.6 in
+
+In order to check that provided input falls inside a range of inputs use the `in` option. For example, if we wanted to ask a user for a single digit in given range we may do following:
+
+```ruby
+ask("Provide number in range: 0-9?") { |q| q.in('0-9') }
+```
+
+#### 2.1.7 modify
+
+Set the `:modify` option if you want to handle whitespace or letter capitalization.
+
+```ruby
+prompt.ask('Enter text:') do |q|
+  q.modify :strip, :collapse
+end
+```
+
+Available letter casing settings are:
+```ruby
+:up         # change to upper case
+:down       # change to small case
+:capitalize # capitalize each word
+```
+
+Available whitespace settings are:
+
+```ruby
+:trim     # remove whitespace from both ends of the input
+:strip    # same as :trim
+:chomp    # remove whitespace at the end of input
+:collapse # reduce all whitespace to single character
+:remove   # remove all whitespace
+```
+
+#### 2.1.8 required
+
+To ensure that input is provided use `:required` option:
+
+```ruby
+prompt.ask("What's your phone number?", required: true)
+# What's your phone number?
+# >> Value must be provided
+```
+
+#### 2.1.9 validate
+
+In order to validate that input matches a given pattern you can pass the `validate` option. Validate setting accepts `Regex`, `Proc` or `Symbol`.
+
+```ruby
+prompt.ask('What is your username?') do |q|
+  q.validate /^[^\.]+\.[^\.]+/
+end
+```
+
+```ruby
+prompt.ask('What is your username?') do |q|
+  q.validate { |input| input =~ /^[^\.]+\.[^\.]+/ }
+end
+```
+
+The **TTY::Prompt** comes with built-in validations for `:email` and you can use them directly like so:
+
+```ruby
+prompt.ask('What is your email?') { |q| q.validate :email }
+```
+
+### 2.2. keypress
+
+In order to ask question that awaits a single character answer use `keypress` prompt like so:
+
+```ruby
+prompt.keypress("Press key ?")
+# Press key?
+# => a
+```
+
+By default any key is accepted but you can limit keys by using `:keys` option. Any key event names such as `:space` or `:ctrl_k` are valid:
+
+```ruby
+prompt.keypress("Press space or enter to continue", keys: [:space, :return])
+```
+
+#### 2.2.1 timeout
+
+Timeout can be set using `:timeout` option to expire prompt and allow the script to continue automatically:
+
+```ruby
+prompt.keypress("Press any key to continue, resumes automatically in 3 seconds ...", timeout: 3)
+```
+
+In addition the `keypress` recognises `:countdown` token when inserted inside the question. It will automatically countdown the time in seconds:
+
+```ruby
+prompt.keypress("Press any key to continue, resumes automatically in :countdown ...", timeout: 3)
+```
+
+### 2.3 multiline
+
+Asking for multiline input can be done with `multiline` method. The reading of input will terminate when `Ctrl+d` or `Ctrl+z` is pressed. Empty lines will not be included in the returned array.
+
+```ruby
+prompt.multiline("Description?")
+# Description? (Press CTRL-D or CTRL-Z to finish)
+# I know not all that may be coming,
+# but be it what it will,
+# I'll go to it laughing.
+# => ["I know not all that may be coming,\n", "but be it what it will,\n", "I'll go to it laughing.\n"]
+```
+
+The `multiline` uses similar options to those supported by `ask` prompt. For example, to provide default description:
+
+```ruby
+prompt.multiline("Description?", default: 'A super sweet prompt.')
+```
+
+Or using DSL:
+
+```ruby
+prompt.multiline("Description?") do |q|
+  q.default 'A super sweet prompt.'
+  q.help 'Press thy ctrl+d to end'
+end
+```
+
+### 2.4 mask
+
+If you require input of confidential information use `mask` method. By default each character that is printed is replaced by `•` symbol. All configuration options applicable to `ask` method can be used with `mask` as well.
+
+```ruby
+prompt.mask('What is your secret?')
+# => What is your secret? ••••
+```
+
+The masking character can be changed by passing `:symbols` option with `:mask` key:
+
+```ruby
+heart = prompt.decorate(prompt.symbols[:heart] + ' ', :magenta)
+prompt.mask('What is your secret?', symbols: {mask: heart})
+# => What is your secret? ❤  ❤  ❤  ❤  ❤
+```
+
+If you don't wish to show any output use `:echo` option like so:
+
+```ruby
+prompt.mask('What is your secret?', echo: false)
+```
+
+You can also provide validation for your mask to enforce for instance strong passwords:
+
+```ruby
+prompt.mask('What is your secret?', mask: heart) do |q|
+  q.validate(/[a-z\ ]{5,15}/)
+end
+```
+
+### 2.5 yes?/no?
+
+In order to display a query asking for boolean input from user use `yes?` like so:
+
+```ruby
+prompt.yes?('Do you like Ruby?')
+# =>
+# Do you like Ruby? (Y/n)
+```
+
+You can further customize question by passing `suffix`, `positive`, `negative` and `convert` options. The `suffix` changes text of available options, the `positive` specifies display string for successful answer and `negative` changes display string for negative answer. The final value is a boolean provided the `convert` option evaluates to boolean.
+
+It's enough to provide the `suffix` option for the prompt to accept matching answers with correct labels:
+
+```ruby
+prompt.yes?("Are you a human?") do |q|
+  q.suffix 'Yup/nope'
+end
+# =>
+# Are you a human? (Yup/nope)
+```
+
+Alternatively, instead of `suffix` option provide the `positive` and `negative` labels:
+
+```ruby
+prompt.yes?("Are you a human?") do |q|
+  q.default false
+  q.positive 'Yup'
+  q.negative 'Nope'
+end
+# =>
+# Are you a human? (yup/Nope)
+```
+
+Finally, providing all available options you can ask fully customized question:
+
+```ruby
+prompt.yes?('Are you a human?') do |q|
+  q.suffix 'Agree/Disagree'
+  q.positive 'Agree'
+  q.negative 'Disagree'
+  q.convert -> (input) { !input.match(/^agree$/i).nil? }
+end
+# =>
+# Are you a human? (Agree/Disagree)
+```
+
+There is also the opposite for asking confirmation of negative question:
+
+```ruby
+prompt.no?('Do you hate Ruby?')
+# =>
+# Do you hate Ruby? (y/N)
+```
+
+Similarly to `yes?` method, you can supply the same options to customize the question.
+
+### 2.6 menu
+
+### 2.6.1 choices
+
+There are many ways in which you can add menu choices. The simplest way is to create an array of values:
+
+```ruby
+choices = %w(small medium large)
+```
+
+By default the choice name is also the value the prompt will return when selected. To provide custom values, you can provide a hash with keys as choice names and their respective values:
+
+```ruby
+choices = {small: 1, medium: 2, large: 3}
+```
+
+Finally, you can define an array of choices where each choice is a hash value with `:name` & `:value` keys which can include other options for customising individual choices:
+
+```ruby
+choices = [
+  {name: 'small', value: 1},
+  {name: 'medium', value: 2, disabled: '(out of stock)'},
+  {name: 'large', value: 3}
+]
+```
+
+You can specify `:key` as an additional option which will be used as short name for selecting the choice via keyboard key press.
+
+Another way to create menu with choices is using the DSL and the `choice` method. For example, the previous array of choices with hash values can be translated as:
+
+```ruby
+prompt.select('What size?') do |menu|
+  menu.choice name: 'small',  value: 1
+  menu.choice name: 'medium', value: 2, disabled: '(out of stock)'
+  menu.choice name: 'large',  value: 3
+end
+```
+
+or in a more compact way:
+
+```ruby
+prompt.select('What size?') do |menu|
+  menu.choice 'small', 1
+  menu.choice 'medium', 2, disabled: '(out of stock)'
+  menu.choice 'large', 3
+end
+```
+
+#### 2.6.1.1 `:disabled`
+
+The `:disabled` key indicates to display a choice as currently unavailable to select. Disabled choices are displayed with a cross `✘` character next to them. If the choice is disabled, it cannot be selected. The value for the `:disabled` is used next to the choice to provide reason for excluding it from the selection menu. For example:
+
+```ruby
+choices = [
+  {name: 'small', value: 1},
+  {name: 'medium', value: 2, disabled: '(out of stock)'}
+  {name: 'large', value: 3}
+]
+```
+
+### 2.6.2 select
+
+For asking questions involving list of options use `select` method by passing the question and possible choices:
+
+```ruby
+prompt.select("Choose your destiny?", %w(Scorpion Kano Jax))
+# =>
+# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# ‣ Scorpion
+#   Kano
+#   Jax
+```
+
+You can also provide options through DSL using the `choice` method for single entry and/or `choices` for more than one choice:
+
+```ruby
+prompt.select("Choose your destiny?") do |menu|
+  menu.choice 'Scorpion'
+  menu.choice 'Kano'
+  menu.choice 'Jax'
+end
+# =>
+# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# ‣ Scorpion
+#   Kano
+#   Jax
+```
+
+By default the choice name is used as return value, but you can provide your custom values including a `Proc` object:
+
+```ruby
+prompt.select("Choose your destiny?") do |menu|
+  menu.choice 'Scorpion', 1
+  menu.choice 'Kano', 2
+  menu.choice 'Jax', -> { 'Nice choice captain!' }
+end
+# =>
+# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# ‣ Scorpion
+#   Kano
+#   Jax
+```
+
+If you wish you can also provide a simple hash to denote choice name and its value like so:
+
+```ruby
+choices = {'Scorpion' => 1, 'Kano' => 2, 'Jax' => 3}
+prompt.select("Choose your destiny?", choices)
+```
+
+To mark particular answer as selected use `default` with index of the option starting from `1`:
+
+```ruby
+prompt.select("Choose your destiny?") do |menu|
+  menu.default 3
+
+  menu.choice 'Scorpion', 1
+  menu.choice 'Kano', 2
+  menu.choice 'Jax', 3
+end
+# =>
+# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+#   Scorpion
+#   Kano
+# ‣ Jax
+```
+
+You can navigate the choices using the arrow keys or define your own key mappings (see [keyboard events](#212-keyboard-events). When reaching the top/bottom of the list, the selection does not cycle around by default. If you wish to enable cycling, you can pass `cycle: true` to `select` and `multi_select`:
+
+```ruby
+prompt.select("Choose your destiny?", %w(Scorpion Kano Jax), cycle: true)
+# =>
+# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# ‣ Scorpion
+#   Kano
+#   Jax
+```
+
+For ordered choices set `enum` to any delimiter String. In that way, you can use arrows keys and numbers (0-9) to select the item.
+
+```ruby
+prompt.select("Choose your destiny?") do |menu|
+  menu.enum '.'
+
+  menu.choice 'Scorpion', 1
+  menu.choice 'Kano', 2
+  menu.choice 'Jax', 3
+end
+# =>
+# Choose your destiny? (Use ↑/↓ arrow or number (0-9) keys, press Enter to select)
+#   1. Scorpion
+#   2. Kano
+# ‣ 3. Jax
+```
+
+You can configure help message and/or marker like so
+
+```ruby
+choices = %w(Scorpion Kano Jax)
+prompt.select("Choose your destiny?", choices, help: "(Bash keyboard)", symbols: {marker: '>'})
+# =>
+# Choose your destiny? (Bash keyboard)
+# > Scorpion
+#   Kano
+#   Jax
+```
+
+#### 2.6.1.1 `:per_page`
+
+By default the menu is paginated if selection grows beyond `6` items. To change this setting use `:per_page` configuration.
+
+```ruby
+letters = ('A'..'Z').to_a
+prompt.select("Choose your letter?", letters, per_page: 4)
+# =>
+# Which letter? (Use ↑/↓ and ←/→ arrow keys, press Enter to select)
+# ‣ A
+#   B
+#   C
+#   D
+```
+
+You can also customise page navigation text using `:help` option:
+```ruby
+letters = ('A'..'Z').to_a
+prompt.select("Choose your letter?") do |menu|
+  menu.per_page 4
+  menu.help '(Wiggle thy finger up/down and left/right to see more)'
+  menu.choices letters
+end
+# =>
+# Which letter? (Wiggle thy finger up/down and left/right to see more)
+# ‣ A
+#   B
+#   C
+#   D
+```
+
+#### 2.6.2.2 `:disabled`
+
+To disable menu choice, use the `:disabled` key with a value that explains the reason for the choice being unavailable. For example, out of all warriors, the Goro is currently injured:
+
+```ruby
+warriors = [
+  'Scorpion',
+  'Kano',
+  { name: 'Goro', disabled: '(injury)' },
+  'Jax',
+  'Kitana',
+  'Raiden'
+]
+```
+
+The disabled choice will be displayed with a cross `✘` character next to it and followed by an explanation:
+
+```ruby
+prompt.select('Choose your destiny?', warriors)
+# =>
+# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# ‣ Scorpion
+#   Kano
+# ✘ Goro (injury)
+#   Jax
+#   Kitana
+#   Raiden
+```
+
+#### 2.6.2.3 `:filter`
+
+To activate dynamic list searching on letter/number key presses use `:filter` option:
+
+```ruby
+warriors = %w(Scorpion Kano Jax Kitana Raiden)
+prompt.select('Choose your destiny?', warriors, filter: true)
+# =>
+# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select, and letter keys to filter)
+# ‣ Scorpion
+#   Kano
+#   Jax
+#   Kitana
+#   Raiden
+```
+
+After the user presses "k":
+
+```ruby
+# =>
+# Choose your destiny? (Filter: "k")
+# ‣ Kano
+#   Kitana
+```
+
+After the user presses "ka":
+
+```ruby
+# =>
+# Choose your destiny? (Filter: "ka")
+# ‣ Kano
+```
+
+Filter characters can be deleted partially or entirely via, respectively, Backspace and Canc.
+
+If the user changes or deletes a filter, the choices previously selected remain selected.
+
+### 2.6.3 multi_select
+
+For asking questions involving multiple selection list use `multi_select` method by passing the question and possible choices:
+
+```ruby
+choices = %w(vodka beer wine whisky bourbon)
+prompt.multi_select("Select drinks?", choices)
+# =>
+#
+# Select drinks? (Use ↑/↓ arrow keys, press Space to select and Enter to finish)"
+# ‣ ⬡ vodka
+#   ⬡ beer
+#   ⬡ wine
+#   ⬡ whisky
+#   ⬡ bourbon
+```
+
+As a return value, the `multi_select` will always return an array by default populated with the names of the choices. If you wish to return custom values for the available choices do:
+
+```ruby
+choices = {vodka: 1, beer: 2, wine: 3, whisky: 4, bourbon: 5}
+prompt.multi_select("Select drinks?", choices)
+
+# Provided that vodka and beer have been selected, the function will return
+# => [1, 2]
+```
+
+Similar to `select` method, you can also provide options through DSL using the `choice` method for single entry and/or `choices` call for more than one choice:
+
+```ruby
+prompt.multi_select("Select drinks?") do |menu|
+  menu.choice :vodka, {score: 1}
+  menu.choice :beer, 2
+  menu.choice :wine, 3
+  menu.choices whisky: 4, bourbon: 5
+end
+```
+
+To mark choice(s) as selected use the `default` option with index(s) of the option(s) starting from `1`:
+
+```ruby
+prompt.multi_select("Select drinks?") do |menu|
+  menu.default 2, 5
+
+  menu.choice :vodka,   {score: 10}
+  menu.choice :beer,    {score: 20}
+  menu.choice :wine,    {score: 30}
+  menu.choice :whisky,  {score: 40}
+  menu.choice :bourbon, {score: 50}
+end
+# =>
+# Select drinks? beer, bourbon
+#   ⬡ vodka
+#   ⬢ beer
+#   ⬡ wine
+#   ⬡ whisky
+# ‣ ⬢ bourbon
+```
+
+Like `select`, for ordered choices set `enum` to any delimiter String. In that way, you can use arrows keys and numbers (0-9) to select the item.
+
+```ruby
+prompt.multi_select("Select drinks?") do |menu|
+  menu.enum ')'
+
+  menu.choice :vodka,   {score: 10}
+  menu.choice :beer,    {score: 20}
+  menu.choice :wine,    {score: 30}
+  menu.choice :whisky,  {score: 40}
+  menu.choice :bourbon, {score: 50}
+end
+# =>
+# Select drinks? beer, bourbon
+#   ⬡ 1) vodka
+#   ⬢ 2) beer
+#   ⬡ 3) wine
+#   ⬡ 4) whisky
+# ‣ ⬢ 5) bourbon
+```
+
+And when you press enter you will see the following selected:
+
+```ruby
+# Select drinks? beer, bourbon
+# => [{score: 20}, {score: 50}]
+```
+
+Also like, `select`, the method takes an option `cycle` (which defaults to `false`), which lets you configure whether the selection should cycle around when reaching the top/bottom of the list when navigating:
+
+```ruby
+prompt.multi_select("Select drinks?", %w(vodka beer wine), cycle: true)
+```
+
+You can configure help message and/or marker like so
+
+```ruby
+choices = {vodka: 1, beer: 2, wine: 3, whisky: 4, bourbon: 5}
+prompt.multi_select("Select drinks?", choices, help: 'Press beer can against keyboard')
+# =>
+# Select drinks? (Press beer can against keyboard)"
+# ‣ ⬡ vodka
+#   ⬡ beer
+#   ⬡ wine
+#   ⬡ whisky
+#   ⬡ bourbon
+```
+
+By default the menu is paginated if selection grows beyond `6` items. To change this setting use `:per_page` configuration.
+
+```ruby
+letters = ('A'..'Z').to_a
+prompt.multi_select("Choose your letter?", letters, per_page: 4)
+# =>
+# Which letter? (Use ↑/↓ and ←/→ arrow keys, press Space to select and Enter to finish)
+# ‣ ⬡ A
+#   ⬡ B
+#   ⬡ C
+#   ⬡ D
+```
+
+#### 2.6.3.1 `:disabled`
+
+To disable menu choice, use the `:disabled` key with a value that explains the reason for the choice being unavailable. For example, out of all drinks, the sake and beer are currently out of stock:
+
+```ruby
+drinks = [
+  'bourbon',
+  {name: 'sake', disabled: '(out of stock)'},
+  'vodka',
+  {name: 'beer', disabled: '(out of stock)'},
+  'wine',
+  'whisky'
+]
+```
+
+The disabled choice will be displayed with a cross `✘` character next to it and followed by an explanation:
+
+```ruby
+prompt.multi_select('Choose your favourite drink?', drinks)
+# =>
+# Choose your favourite drink? (Use ↑/↓ arrow keys, press Space to select and Enter to finish)
+# ‣ ⬡ bourbon
+#   ✘ sake (out of stock)
+#   ⬡ vodka
+#   ✘ beer (out of stock)
+#   ⬡ wine
+#   ⬡ whisky
+```
+
+#### 2.6.3.2 `:echo`
+
+To control whether the selected items are shown on the question
+header use the :echo option:
+
+```ruby
+choices = %w(vodka beer wine whisky bourbon)
+prompt.multi_select("Select drinks?", choices, echo: false)
+# =>
+# Select drinks?
+#   ⬡ vodka
+#   ⬢ 2) beer
+#   ⬡ 3) wine
+#   ⬡ 4) whisky
+# ‣ ⬢ 5) bourbon
+```
+
+#### 2.6.3.3 `:filter`
+
+To activate dynamic list filtering on letter/number typing, use the :filter option:
+
+```ruby
+choices = %w(vodka beer wine whisky bourbon)
+prompt.multi_select("Select drinks?", choices, filter: true)
+# =>
+# Select drinks? (Use ↑/↓ arrow keys, press Space to select and Enter to finish, and letter keys to filter)
+# ‣ ⬡ vodka
+#   ⬡ beer
+#   ⬡ wine
+#   ⬡ whisky
+#   ⬡ bourbon
+```
+
+After the user presses "w":
+
+```ruby
+# Select drinks? (Filter: "w")
+# ‣ ⬡ wine
+#   ⬡ whisky
+```
+
+Filter characters can be deleted partially or entirely via, respectively, Backspace and Canc.
+
+If the user changes or deletes a filter, the choices previously selected remain selected.
+
+The `filter` option is not compatible with `enum`.
+
+#### 2.6.3.4 `:min`
+
+To force the minimum number of choices an user must select, use the `:min` option:
+
+```ruby
+choices = %w(vodka beer wine whisky bourbon)
+prompt.multi_select("Select drinks?", choices, min: 3)
+# =>
+# Select drinks? (min. 3) vodka, beer
+#   ⬢ vodka
+#   ⬢ beer
+#   ⬡ wine
+#   ⬡ wiskey
+# ‣ ⬡ bourbon
+```
+
+#### 2.6.3.5 `:max`
+
+To limit the number of choices an user can select, use the `:max` option:
+
+```ruby
+choices = %w(vodka beer wine whisky bourbon)
+prompt.multi_select("Select drinks?", choices, max: 3)
+# =>
+# Select drinks? (max. 3) vodka, beer, whisky
+#   ⬢ vodka
+#   ⬢ beer
+#   ⬡ wine
+#   ⬢ whisky
+# ‣ ⬡ bourbon
+```
+
+### 2.6.4 enum_select
+
+In order to ask for standard selection from indexed list you can use `enum_select` and pass question together with possible choices:
+
+```ruby
+choices = %w(emacs nano vim)
+prompt.enum_select("Select an editor?")
+# =>
+#
+# Select an editor?
+#   1) nano
+#   2) vim
+#   3) emacs
+#   Choose 1-3 [1]:
+```
+
+Similar to `select` and `multi_select`, you can provide question options through DSL using `choice` method and/or `choices` like so:
+
+```ruby
+choices = %w(nano vim emacs)
+prompt.enum_select("Select an editor?") do |menu|
+  menu.choice :nano,  '/bin/nano'
+  menu.choice :vim,   '/usr/bin/vim'
+  menu.choice :emacs, '/usr/bin/emacs'
+end
+# =>
+#
+# Select an editor?
+#   1) nano
+#   2) vim
+#   3) emacs
+#   Choose 1-3 [1]:
+#
+# Select an editor? /bin/nano
+```
+
+You can change the indexed numbers by passing `enum` option and the default option by using `default` like so
+
+```ruby
+choices = %w(nano vim emacs)
+prompt.enum_select("Select an editor?") do |menu|
+  menu.default 2
+  menu.enum '.'
+
+  menu.choice :nano,  '/bin/nano'
+  menu.choice :vim,   '/usr/bin/vim'
+  menu.choice :emacs, '/usr/bin/emacs'
+end
+# =>
+#
+# Select an editor?
+#   1. nano
+#   2. vim
+#   3. emacs
+#   Choose 1-3 [2]:
+#
+# Select an editor? /usr/bin/vim
+```
+
+#### 2.6.4.1 `:per_page`
+
+By default the menu is paginated if selection grows beyond `6` items. To change this setting use `:per_page` configuration.
+
+```ruby
+letters = ('A'..'Z').to_a
+prompt.enum_select("Choose your letter?", letters, per_page: 4)
+# =>
+# Which letter?
+#   1) A
+#   2) B
+#   3) C
+#   4) D
+#   Choose 1-26 [1]:
+# (Press tab/right or left to reveal more choices)
+```
+
+#### 2.6.4.2 `:disabled`
+
+To make a choice unavailable use the `:disabled` option and, if you wish, as value provide a reason:
+
+```ruby
+choices = [
+  {name: "Emacs", disabled: '(not installed)'},
+  "Atom",
+  "GNU nano",
+  {name: "Notepad++", disabled: '(not installed)'},
+  "Sublime",
+  "Vim"
+]
+```
+
+The disabled choice will be displayed with a cross ✘ character next to it and followed by an explanation:
+
+
+```ruby
+prompt.enum_select('Select an editor', choices)
+# =>
+# Select an editor
+# ✘ 1) Emacs (not installed)
+#   2) Atom
+#   3) GNU nano
+# ✘ 4) Notepad++ (not installed)
+#   5) Sublime
+#   6) Vim
+#   Choose 1-6 [2]:
+```
+
+### 2.7 expand
+
+The `expand` provides a compact way to ask a question with many options.
+
+As first argument `expand` takes the message to display and as a second an array of choices. Compared to the `select`, `multi_select` and `enum_select`, the choices need to be objects that include `:key`, `:name` and `:value` keys. The `:key` must be a single character. The help choice is added automatically as the last option under the key `h`.
+
+```ruby
+choices = [
+  {
+    key: 'y',
+    name: 'overwrite this file',
+    value: :yes
+  }, {
+    key: 'n',
+    name: 'do not overwrite this file',
+    value: :no
+  }, {
+    key: 'q',
+    name: 'quit; do not overwrite this file ',
+    value: :quit
+  }
+]
+```
+
+The choices can also be provided through DSL using the `choice` method. The `:value` can be a primitive value or `Proc` instance that gets executed and whose value is used as returned type. For example:
+
+```ruby
+prompt.expand('Overwrite Gemfile?') do |q|
+  q.choice key: 'y', name: 'Overwrite'      do :ok end
+  q.choice key: 'n', name: 'Skip',          value: :no
+  q.choice key: 'a', name: 'Overwrite all', value: :all
+  q.choice key: 'd', name: 'Show diff',     value: :diff
+  q.choice key: 'q', name: 'Quit',          value: :quit
+end
+```
+
+The first element in the array of choices or provided via `choice` DSL will be the default choice, you can change that by passing `default` option.
+
+```ruby
+prompt.expand('Overwrite Gemfile?', choices)
+# =>
+# Overwrite Gemfile? (enter "h" for help) [y,n,q,h]
+```
+
+Each time user types an option a hint will be displayed:
+
+```ruby
+# Overwrite Gemfile? (enter "h" for help) [y,n,a,d,q,h] y
+# >> overwrite this file
+```
+
+If user types `h` and presses enter, an expanded view will be shown which further allows to refine the choice:
+
+```ruby
+# Overwrite Gemfile?
+#   y - overwrite this file
+#   n - do not overwrite this file
+#   q - quit; do not overwrite this file
+#   h - print help
+#   Choice [y]:
+```
+
+Run `examples/expand.rb` to see the prompt in action.
+
+#### 2.7.1 `:auto_hint`
+
+To show hint by default use `:auto_hint` option:
+
+```ruby
+prompt.expand('Overwrite Gemfile?', choices, auto_hint: true)
+# =>
+# Overwrite Gemfile? (enter "h" for help) [y,n,q,h]
+# >> overwrite this file
+```
+
+### 2.8 collect
+
+In order to collect more than one answer use `collect` method. Using the `key` you can describe the answers key name. All the methods for asking user input such as `ask`, `mask`, `select` can be directly invoked on the key. The key composition is very flexible by allowing nested keys. If you want the value to be automatically converted to required type use [convert](#221-convert).
+
+For example to gather some contact information do:
+
+```ruby
+prompt.collect do
+  key(:name).ask('Name?')
+
+  key(:age).ask('Age?', convert: :int)
+
+  key(:address) do
+    key(:street).ask('Street?', required: true)
+    key(:city).ask('City?')
+    key(:zip).ask('Zip?', validate: /\A\d{3}\Z/)
+  end
+end
+# =>
+# {:name => "Piotr", :age => 30, :address => {:street => "Street", :city => "City", :zip => "123"}}
+```
+
+In order to collect _mutliple values_ for a given key in a loop, chain `values` onto the `key` desired:
+
+```ruby
+result = prompt.collect do
+  key(:name).ask('Name?')
+
+  key(:age).ask('Age?', convert: :int)
+
+  while prompt.yes?("continue?")
+    key(:addresses).values do
+      key(:street).ask('Street?', required: true)
+      key(:city).ask('City?')
+      key(:zip).ask('Zip?', validate: /\A\d{3}\Z/)
+    end
+  end
+end
+# =>
+# {
+#   :name => "Piotr",
+#   :age => 30,
+#   :addresses => [
+#     {:street => "Street", :city => "City", :zip => "123"},
+#     {:street => "Street", :city => "City", :zip => "234"}
+#   ]
+# }
+```
+
+### 2.9 suggest
+
+To suggest possible matches for the user input use `suggest` method like so:
+
+```ruby
+prompt.suggest('sta', ['stage', 'stash', 'commit', 'branch'])
+# =>
+# Did you mean one of these?
+#         stage
+#         stash
+```
+
+To customize query text presented pass `:single_text` and `:plural_text` options to respectively change the message when one match is found or many.
+
+```ruby
+possible = %w(status stage stash commit branch blame)
+prompt.suggest('b', possible, indent: 4, single_text: 'Perhaps you meant?')
+# =>
+# Perhaps you meant?
+#     blame
+```
+
+### 2.10 slider
+
+If you have constrained range of numbers for user to choose from you may consider using `slider`.
+
+The slider provides easy visual way of picking a value marked by `●` symbol. You can set `:min`(defaults to 0), `:max` and `:step`(defaults to 1) options to configure slider range:
+
+```ruby
+prompt.slider('Volume', max: 100, step: 5)
+# =>
+# Volume ──────────●────────── 50
+# (Use arrow keys, press Enter to select)
+```
+
+By default the slider is configured to pick middle of the range as a start value, you can change this by using the `:default` option:
+
+```ruby
+prompt.slider('Volume', max: 100, step: 5, default: 75)
+# =>
+# Volume ───────────────●────── 75
+# (Use arrow keys, press Enter to select)
+```
+
+You can also change the default slider formatting using the `:format`. The value must contain the `:slider` token to show current value and any `sprintf` compatible flag for number display, in our case `%d`:
+
+```ruby
+prompt.slider('Volume', max: 100, step: 5, default: 75, format: "|:slider| %d%")
+# =>
+# Volume |───────────────●──────| 75%
+# (Use arrow keys, press Enter to select)
+```
+
+You can also specify slider range with decimal numbers. For example, to have a step of `0.5` and display each value with a single decimal place use `%f` as format:
+
+```ruby
+prompt.slider("Volume", max: 10, step: 0.5, default: 5, format: "|:slider| %.1f")
+# =>
+# Volume |───────────────●──────| 7.5
+# (Use arrow keys, press Enter to select)
+```
+
+If you wish to change the slider handle and the slider range display use `:symbols` option:
+
+```ruby
+prompt.slider("Volume", max: 100, step: 5, default: 75, symbols: {bullet: 'x', line: '_'})
+# =>
+# Volume _______________x______ 75%
+# (Use arrow keys, press Enter to select)
+```
+
+Slider can be configured through DSL as well:
+
+```ruby
+prompt.slider('What size?') do |range|
+  range.max 100
+  range.step 5
+  range.default 75
+  range.format "|:slider| %d%"
+end
+# =>
+# Volume |───────────────●──────| 75%
+# (Use arrow keys, press Enter to select)
+```
+
+### 2.11 say
+
+To simply print message out to standard output use `say` like so:
+
+```ruby
+prompt.say(...)
+```
+
+The `say` method also accepts option `:color` which supports all the colors provided by [pastel](https://github.com/piotrmurach/pastel#3-supported-colors)
+
+**TTY::Prompt** provides more specific versions of `say` method to better express intention behind the message such as `ok`, `warn` and `error`.
+
+#### 2.11.1 ok
+
+Print message(s) in green do:
+
+```ruby
+prompt.ok(...)
+```
+
+#### 2.12.2 warn
+
+Print message(s) in yellow do:
+
+```ruby
+prompt.warn(...)
+```
+
+#### 2.11.3 error
+
+Print message(s) in red do:
+
+```ruby
+prompt.error(...)
+```
+
+#### 2.12 keyboard events
+
+All the prompt types, when a key is pressed, fire key press events. You can subscribe to listen to this events by calling `on` with type of event name.
+
+```ruby
+prompt.on(:keypress) { |event| ... }
+```
+
+The event object is yielded to a block whenever particular event fires. The event has `key` and `value` methods. Further, the `key` responds to following messages:
+
+* `name`  - the name of the event such as :up, :down, letter or digit
+* `meta`  - true if event is non-standard key associated
+* `shift` - true if shift has been pressed with the key
+* `ctrl`  - true if ctrl has been pressed with the key
+
+For example, to add vim like key navigation to `select` prompt one would do the following:
+
+```ruby
+prompt.on(:keypress) do |event|
+  if event.value == 'j'
+    prompt.trigger(:keydown)
+  end
+
+  if event.value == 'k'
+    prompt.trigger(:keyup)
+  end
+end
+```
+
+You can subscribe to more than one event:
+
+```ruby
+prompt.on(:keypress) { |key| ... }
+      .on(:keydown)  { |key| ... }
+```
+
+The available events are:
+
+* `:keypress`
+* `:keydown`
+* `:keyup`
+* `:keyleft`
+* `:keyright`
+* `:keynum`
+* `:keytab`
+* `:keyenter`
+* `:keyreturn`
+* `:keyspace`
+* `:keyescape`
+* `:keydelete`
+* `:keybackspace`
+
+## 3 settings
+
+### 3.1. `:symbols`
+
+Many prompts use symbols to display information. You can overwrite the default symbols for all the prompts using the `:symbols` key and hash of symbol names as value:
+
+```ruby
+prompt = TTY::Prompt.new(symbols: {marker: '>'})
+```
+
+The following symbols can be overwritten:
+
+| Symbols     | Unicode | ASCII |
+| ----------- |:-------:|:-----:|
+|  tick       | `✓`     | `√`   |
+|  cross      | `✘`     | `x`   |
+|  marker     | `‣`     | `>`   |
+|  dot        | `•`     | `.`   |
+|  bullet     | `●`     | `O`   |
+|  line       | `─`     | `-`   |
+|  radio_on   | `⬢`     | `(*)` |
+|  radio_off  | `⬡`     | `( )` |
+|  arrow_up   | `↑`     | `↑`   |
+|  arrow_down | `↓`     | `↓`   |
+|  arrow_left | `←`     | `←`   |
+|  arrow_right| `→`     | `→`   |
+
+### 3.2 `:active_color`
+
+All prompt types support `:active_color` option. In case of `select`, `multi_select`, `enum_select` or `expand` this color is used to highlight the currently selected choice. All the resulted inputs provided by user that are read in by the prompt as answer are highlighted with this color. This option can be applied either globally for all prompts or individually.
+
+```ruby
+prompt = TTY::Prompt.new(active_color: :cyan)
+```
+
+or per individual input do:
+
+```ruby
+prompt.select('What size?', %w(Large Medium Small), active_color: :cyan)
+```
+
+Please [see pastel](https://github.com/piotrmurach/pastel#3-supported-colors) for all supported colors.
+
+### 3.3 `:enable_color`
+
+If you wish to disable coloring for a prompt simply pass `:enable_color` option
+
+```ruby
+prompt = TTY::Prompt.new(enable_color: true)
+```
+
+### 3.4 `:help_color`
+
+Prompts such as `select`, `multi_select`, `expand` support `:help_color` which is used to customize the help text. This option can be applied either globally for all prompts or individually.
+
+```ruby
+prompt = TTY::Prompt.new(help_color: :cyan)
+```
+
+or per individual input do:
+
+```ruby
+prompt.select('What size?', %w(Large Medium Small), help_color: :cyan)
+```
+
+### 3.5 `:interrupt`
+
+By default `InputInterrupt` error will be raised when the user hits the interrupt key(Control-C). However, you can customise this behaviour by passing the `:interrupt` option. The available options are:
+
+* `:signal` - sends interrupt signal
+* `:exit` - exists with status code
+* `:noop` - skips handler
+* custom proc
+
+For example, to send interrupt signal do:
+
+```ruby
+prompt = TTY::Prompt.new(interrupt: :signal)
+```
+
+### 3.6 `:prefix`
+
+You can prefix each question asked using the `:prefix` option. This option can be applied either globally for all prompts or individual for each one:
+
+```ruby
+prompt = TTY::Prompt.new(prefix: '[?] ')
+```
+
+### 3.7 `:track_history`
+
+The prompts that accept line input such as `multiline` or `ask` provide history buffer that tracks all the lines entered during `TTY::Prompt.new` interactions. The history buffer provides previous or next lines when user presses up/down arrows respectively. However, if you wish to disable this behaviour use `:track_history` option like so:
+
+```ruby
+prompt = TTY::Prompt.new(track_history: false)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/piotrmurach/tty-prompt/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Copyright
+
+Copyright (c) 2015 Piotr Murach. See LICENSE for further details.