tty-prompt 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da6d9da4a55660577a3f5c65c4058c666defd1d7
-  data.tar.gz: 7d647c6c08f2d3271b4660e3da777885001cc772
+  metadata.gz: f9a360c4b3a7cd670868b20f7b220223274f555b
+  data.tar.gz: 17667527540e13b4e91eca3c042c9fcc5cb24b86
 SHA512:
-  metadata.gz: 876eea0fd3fea3da77b4c2730247807022fc2553fa7475ca089d099c961824818ee59370129f10520b9a29402bbecc3b912b1ed5e5e9fb9c583643561d6aeab1
-  data.tar.gz: 9b3a34ab5221a8305a6608b48cb1b6567cb6bfbd77e562dfd3dda540e63816978212380228570ba290e98c2e5a70f7b67a2877bb560482082040bf07cf2f4d18
+  metadata.gz: e7489d7dcde47bad702c66740391db047b17d94eedb9c110de0b77ffc59ba6c4cca83f95d2e5dc85417b6e1e5f409d0bd88c5a00367e260b29ea48f3efe7c798
+  data.tar.gz: ef5bec91d62387297bbc29b947bb39d014e3a2239d5679a9175e6944520d490caca7f327abf695c3b27f42055169c89cd7b924522dec1a55e61e94ed2e9e379b

data/.travis.yml

@@ -6,10 +6,10 @@ bundler_args: --without tools
 script: "bundle exec rake ci"
 rvm:
   - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.0
+  - 2.0.0
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
   - ruby-head
   - jruby-9000
   - jruby-head
@@ -18,6 +18,7 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: rbx-2
   fast_finish: true
 branches:
   only: master

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change log
 
+## [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
@@ -98,6 +114,7 @@
 
 * Initial implementation and release
 
+[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

data/Gemfile

@@ -6,6 +6,7 @@ group :test do
   gem 'benchmark-ips', '~> 2.0.0'
   gem 'simplecov', '~> 0.10.0'
   gem 'coveralls', '~> 0.8.2'
+  gem 'term-ansicolor', '=1.3.2'
 end
 
 group :tools do

data/README.md

@@ -51,7 +51,7 @@ Or install it yourself as:
     * [2.2.5 modify](#225-modify)
     * [2.2.6 required](#226-required)
     * [2.2.7 validate](#227-validate)
-    * [2.2.8 messages](#228-messages)
+    * [2.2.8 error messages](#228-error-messages)
     * [2.2.9 prefix](#229-prefix)
     * [2.2.10 active_color](#2210-active_color)
     * [2.2.11 help_color](#2211-help_color)
@@ -71,7 +71,7 @@ Or install it yourself as:
     * [2.12.1 ok](#2121-ok)
     * [2.12.2 warn](#2122-warn)
     * [2.12.3 error](#2123-error)
-
+  * [2.13 keyboard events](#213-keyboard-events)
 
 ## 1. Usage
 
@@ -322,7 +322,7 @@ The **TTY::Prompt** comes with bult-in validations for `:email` and you can use
 prompt.ask('What is your email?') { |q| q.validate :email }
 ```
 
-#### 2.2.8 messages
+#### 2.2.8 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 inling them with the option:
 
@@ -341,6 +341,15 @@ prompt.ask('What is your email?') do |q|
 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.2.9 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:
@@ -906,6 +915,58 @@ Print message(s) in red do:
 prompt.error(...)
 ```
 
+#### 2.13 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.key.name == 'j'
+    prompt.publish(:keydown)
+  end
+
+  if event.key.name == 'k'
+    prompt.publish(: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`
+
 ## Contributing
 
 1. Fork it ( https://github.com/piotrmurach/tty-prompt/fork )

data/examples/ask.rb

@@ -5,3 +5,11 @@ require 'tty-prompt'
 prompt = TTY::Prompt.new
 
 prompt.ask('What is your name?', default: ENV['USER'])
+
+prompt.ask('Folder name?') do |q|
+  q.required(true)
+  q.validate ->(v) { return !Dir.exist?(v) }
+  q.messages[:valid?] = 'Folder already exists?'
+  q.messages[:required?] = 'Folder name must not be empty'
+end
+

data/examples/keypress.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt::new(interrupt: :exit)
+
+prompt.on(:keypress) do |event|
+  puts "name: #{event.key.name}, value: #{event.value.dump}"
+end
+
+prompt.read_keypress

data/examples/select.rb

@@ -5,4 +5,14 @@ require 'tty-prompt'
 prompt = TTY::Prompt.new
 
 warriors = %w(Scorpion Kano Jax)
+
+prompt.on(:keypress) do |event|
+  if event.key.name == 'j'
+    prompt.publish(:keydown)
+  end
+  if event.key.name == 'k'
+    prompt.publish(:keyup)
+  end
+end
+
 prompt.select('Choose your destiny?', warriors)

data/lib/tty/prompt.rb

@@ -49,8 +49,8 @@ module TTY
     def_delegators :@cursor, :clear_lines, :clear_line,
                    :show, :hide
 
-    def_delegators :@reader, :read_line, :read_keypress,
-                   :read_multiline, :on, :subscribe
+    def_delegators :@reader, :read_char, :read_line, :read_keypress,
+                   :read_multiline, :on, :subscribe, :publish
 
     def_delegators :@output, :print, :puts, :flush
 
@@ -98,7 +98,7 @@ module TTY
     # @api public
     def ask(message, *args, &block)
       options = Utils.extract_options!(args)
-      options.merge!(self.class.messages)
+      options.merge!({messages: self.class.messages})
       question = Question.new(self, options)
       question.call(message, &block)
     end

data/lib/tty/prompt/question/checks.rb

@@ -49,7 +49,7 @@ module TTY
         # Check if input requires validation
         class CheckValidation
           def self.call(question, value)
-            if !question.validation? ||
+            if !question.validation? || (question.required? && value.nil?) ||
               (question.validation? &&
                 Validation.new(question.validation).call(value))
               [value]

data/lib/tty/prompt/reader.rb

@@ -86,15 +86,18 @@ module TTY
 
       # Reads single character including invisible multibyte codes
       #
+      # @params [Integer] bytes
+      #   the number of bytes to read
+      #
       # @return [String]
       #
       # @api public
-      def read_char
-        chars = input.sysread(1)
+      def read_char(bytes = 1)
+        chars = input.readpartial(bytes)
         while CSI.start_with?(chars) ||
               chars.start_with?(CSI) &&
               !(64..126).include?(chars.each_codepoint.to_a.last)
-          next_char = read_char
+          next_char = read_char(bytes + 1)
           chars << next_char
         end
         chars

data/lib/tty/prompt/reader/codes.rb

@@ -4,7 +4,7 @@ module TTY
   class Prompt
     class Reader
       module Codes
-        BACKSPACE = "\177"
+        BACKSPACE = "\x7f"
         DELETE   = "\004"
         ESCAPE   = "\e"
         LINEFEED = "\n"
@@ -12,23 +12,35 @@ module TTY
         SPACE    = " "
         TAB      = "\t"
 
-        KEY_UP     = "\e[A"
-        KEY_DOWN   = "\e[B"
-        KEY_RIGHT  = "\e[C"
-        KEY_LEFT   = "\e[D"
-        KEY_CLEAR  = "\e[E"
-        KEY_END    = "\e[F"
-        KEY_HOME   = "\e[H"
-        KEY_DELETE = "\e[3"
+        KEY_UP     = "[A"
+        KEY_DOWN   = "[B"
+        KEY_RIGHT  = "[C"
+        KEY_LEFT   = "[D"
+        KEY_CLEAR  = "[E"
+        KEY_END    = "[F"
+        KEY_HOME   = "[H"
+        KEY_DELETE = "[3"
 
-        KEY_UP_ALT     = "\eOA"
-        KEY_DOWN_ALT   = "\eOB"
-        KEY_RIGHT_ALT  = "\eOC"
-        KEY_LEFT_ALT   = "\eOD"
-        KEY_CLEAR_ALT  = "\eOE"
-        KEY_END_ALT    = "\eOF"
-        KEY_HOME_ALT   = "\eOH"
-        KEY_DELETE_ALT = "\eO3"
+        KEY_UP_XTERM     = "OA"
+        KEY_DOWN_XTERM   = "OB"
+        KEY_RIGHT_XTERM  = "OC"
+        KEY_LEFT_XTERM   = "OD"
+        KEY_CLEAR_XTERM  = "OE"
+        KEY_END_XTERM    = "OF"
+        KEY_HOME_XTERM   = "OH"
+        KEY_DELETE_XTERM = "O3"
+
+        KEY_UP_SHIFT    = "[a"
+        KEY_DOWN_SHIFT  = "[b"
+        KEY_RIGHT_SHIFT = "[c"
+        KEY_LEFT_SHIFT  = "[d"
+        KEY_CLEAR_SHIFT = "[e"
+
+        KEY_UP_CTRL    = "0a"
+        KEY_DOWN_CTRL  = "0b"
+        KEY_RIGHT_CTRL = "0c"
+        KEY_LEFT_CTRL  = "0d"
+        KEY_CLEAR_CTRL = "0e"
 
         CTRL_J = "\x0A"
         CTRL_N = "\x0E"
@@ -39,30 +51,30 @@ module TTY
         CTRL_H = "\b"
         CTRL_L = "\f"
 
-        F1_XTERM = "\eOP"
-        F2_XTERM = "\eOQ"
-        F3_XTERM = "\eOR"
-        F4_XTERM = "\eOS"
+        F1_XTERM = "OP"
+        F2_XTERM = "OQ"
+        F3_XTERM = "OR"
+        F4_XTERM = "OS"
 
-        F1_GNOME = "\e[11~"
-        F2_GNOME = "\e[12~"
-        F3_GNOME = "\e[13~"
-        F4_GNOME = "\e[14~"
+        F1_GNOME = "[11~"
+        F2_GNOME = "[12~"
+        F3_GNOME = "[13~"
+        F4_GNOME = "[14~"
 
-        F1_WIN = "\e[[A"
-        F2_WIN = "\e[[B"
-        F3_WIN = "\e[[C"
-        F4_WIN = "\e[[D"
-        F5_WIN = "\e[[E"
+        F1_WIN = "[[A"
+        F2_WIN = "[[B"
+        F3_WIN = "[[C"
+        F4_WIN = "[[D"
+        F5_WIN = "[[E"
 
-        F5 =  "\e[15~"
-        F6 =  "\e[17~"
-        F7 =  "\e[18~"
-        F8 =  "\e[19~"
-        F9 =  "\e[20~"
-        F10 = "\e[21~"
-        F11 = "\e[23~"
-        F12 = "\e[24~"
+        F5 =  "[15~"
+        F6 =  "[17~"
+        F7 =  "[18~"
+        F8 =  "[19~"
+        F9 =  "[20~"
+        F10 = "[21~"
+        F11 = "[23~"
+        F12 = "[24~"
       end # Codes
     end # Reader
   end # Prompt

data/lib/tty/prompt/reader/key_event.rb

@@ -21,10 +21,11 @@ module TTY
       #
       # @api public
       class KeyEvent < Struct.new(:value, :key)
-        META_KEY_CODE_RE = /^(?:\e)(O|N|\[|\[\[)(?:(\d+)(?:;(\d+))?([~^$])|(?:1;)?(\d+)?([a-zA-Z]))/
+        META_KEY_CODE_RE = /^(?:\e+)(O|N|\[|\[\[)(?:(\d+)(?:;(\d+))?([~^$])|(?:1;)?(\d+)?([a-zA-Z]))/
 
         def self.from(char)
           key = Key.new
+
           case char
           when Codes::RETURN   then key.name = :return
           when Codes::LINEFEED then key.name = :enter
@@ -33,9 +34,14 @@ module TTY
               "#{Codes::ESCAPE}#{Codes::BACKSPACE}",
               "#{Codes::ESCAPE}#{Codes::CTRL_H}"
             key.name = :backspace
+            key.meta = (char.chars.to_a[0] == Codes::ESCAPE)
           when Codes::DELETE   then key.name = :delete
-          when Codes::SPACE    then key.name = :space
-          when Codes::CTRL_C, Codes::ESCAPE then key.name = :escape
+          when Codes::SPACE, "#{Codes::ESCAPE}#{Codes::SPACE}"
+            key.name = :space
+            key.meta = (char.size == 2)
+          when Codes::ESCAPE, "#{Codes::ESCAPE}#{Codes::ESCAPE}"
+            key.name = :escape
+            key.meta = (char.size == 2)
           when proc { |c| c.length == 1 && c =~ /[a-z]/ }
             key.name = char
           when proc { |c| c.length == 1 && c =~ /[A-Z]/ }
@@ -44,15 +50,21 @@ module TTY
           when /^\d+$/
             key.name = :num
           when META_KEY_CODE_RE # ansi escape
-            key.meta = true
+            parts = META_KEY_CODE_RE.match(char)
+            code = "#{parts[1]}#{parts[2]}#{parts[4]}#{parts[6]}"
+            modifier = (parts[3] || parts[5] || 1) - 1
+
+            key.ctrl = (modifier & 4) != 0
+            key.meta = (modifier & 10) != 0
+            key.shift = (modifier & 1) != 0
 
-            case char
+            case code
             # f1 - f12
             when Codes::F1_XTERM, Codes::F1_GNOME, Codes::F1_WIN then key.name = :f1
             when Codes::F2_XTERM, Codes::F2_GNOME, Codes::F2_WIN then key.name = :f2
             when Codes::F3_XTERM, Codes::F3_GNOME, Codes::F3_WIN then key.name = :f3
             when Codes::F4_XTERM, Codes::F4_GNOME, Codes::F4_WIN then key.name = :f4
-            when Codes::F5 then key.name = :f5
+            when Codes::F5, Codes::F5_WIN then key.name = :f5
             when Codes::F6 then key.name = :f6
             when Codes::F7 then key.name = :f7
             when Codes::F8 then key.name = :f8
@@ -61,19 +73,37 @@ module TTY
             when Codes::F11 then key.name = :f11
             when Codes::F12 then key.name = :f12
             # navigation
-            when Codes::KEY_UP, Codes::KEY_UP_ALT, Codes::CTRL_K, Codes::CTRL_P
+            when Codes::KEY_UP, Codes::KEY_UP_XTERM,
+                 Codes::CTRL_K, Codes::CTRL_P
               key.name = :up
-            when Codes::KEY_DOWN, Codes::KEY_DOWN_ALT, Codes::CTRL_J, Codes::CTRL_N
+            when Codes::KEY_UP_SHIFT then key.name = :up; key.shift = true
+            when Codes::KEY_UP_CTRL  then key.name = :up; key.ctrl  = true
+
+            when Codes::KEY_DOWN, Codes::KEY_DOWN_XTERM,
+                 Codes::CTRL_J, Codes::CTRL_N
               key.name = :down
-            when Codes::KEY_RIGHT, Codes::KEY_RIGHT_ALT, Codes::CTRL_L
+            when Codes::KEY_DOWN_SHIFT then key.name = :down; key.shift = true
+            when Codes::KEY_DOWN_CTRL  then key.name = :down; key.ctrl = true
+
+            when Codes::KEY_RIGHT, Codes::KEY_RIGHT_XTERM, Codes::CTRL_L
               key.name = :right
-            when Codes::KEY_LEFT, Codes::KEY_LEFT_ALT, Codes::CTRL_H
+            when Codes::KEY_RIGHT_SHIFT then key.name = :right; key.shift = true
+            when Codes::KEY_RIGHT_CTRL  then key.name = :right; key.ctrl = true
+
+            when Codes::KEY_LEFT, Codes::KEY_LEFT_XTERM, Codes::CTRL_H
               key.name = :left
-            when Codes::KEY_CLEAR, Codes::KEY_CLEAR_ALT
+            when Codes::KEY_LEFT_SHIFT then key.name = :left; key.shift = true
+            when Codes::KEY_LEFT_CTRL  then key.name = :left; key.ctrl = true
+
+            when Codes::KEY_CLEAR, Codes::KEY_CLEAR_XTERM
               key.name = :clear
-            when Codes::KEY_END, Codes::KEY_END_ALT
+            when Codes::KEY_CLEAR_SHIFT then key.name = :clear; key.shift = true
+            when Codes::KEY_CLEAR_CTRL  then key.name = :clear; key.ctrl = true
+
+            when Codes::KEY_END, Codes::KEY_END_XTERM
               key.name = :end
-            when Codes::KEY_HOME, Codes::KEY_HOME_ALT
+
+            when Codes::KEY_HOME, Codes::KEY_HOME_XTERM
               key.name = :home
             end
           end

data/lib/tty/prompt/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Prompt
-    VERSION = "0.7.1"
+    VERSION = "0.8.0"
   end # Prompt
 end # TTY

data/spec/unit/question/in_spec.rb

@@ -7,16 +7,20 @@ RSpec.describe TTY::Prompt::Question, '#in' do
   it "reads range from option" do
     prompt.input << '8'
     prompt.input.rewind
+
     answer = prompt.ask("How do you like it on scale 1-10?", in: '1-10')
+
     expect(answer).to eq('8')
   end
 
   it 'reads number within string range' do
     prompt.input << '8'
     prompt.input.rewind
+
     answer = prompt.ask("How do you like it on scale 1-10?") do |q|
       q.in('1-10')
     end
+
     expect(answer).to eq('8')
     expect(prompt.output.string).to eq([
       "How do you like it on scale 1-10? ",
@@ -29,9 +33,11 @@ RSpec.describe TTY::Prompt::Question, '#in' do
   it 'reads number within digit range' do
     prompt.input << '8.1'
     prompt.input.rewind
+
     answer = prompt.ask("How do you like it on scale 1-10?") do |q|
       q.in(1.0..11.5)
     end
+
     expect(answer).to eq('8.1')
     expect(prompt.output.string).to eq([
       "How do you like it on scale 1-10? ",
@@ -44,9 +50,11 @@ RSpec.describe TTY::Prompt::Question, '#in' do
   it 'reads letters within range' do
     prompt.input << 'E'
     prompt.input.rewind
+
     answer = prompt.ask("Your favourite vitamin? (A-K)") do |q|
       q.in('A-K')
     end
+
     expect(answer).to eq('E')
     expect(prompt.output.string).to eq([
       "Your favourite vitamin? (A-K) ",
@@ -55,4 +63,45 @@ RSpec.describe TTY::Prompt::Question, '#in' do
       "Your favourite vitamin? (A-K) \e[32mE\e[0m\n"
     ].join)
   end
+
+  it "provides default error message when wrong input" do
+    prompt.input << "A\n2\n"
+    prompt.input.rewind
+
+    answer = prompt.ask("How spicy on scale? (1-5)", in: '1-5')
+
+    expect(answer).to eq('2')
+    expect(prompt.output.string).to eq([
+      "How spicy on scale? (1-5) ",
+      "\e[1000D\e[K",
+      "\e[31m>>\e[0m Value A must be within the range 1..5\e[1A",
+      "\e[1000D\e[K",
+      "How spicy on scale? (1-5) ",
+      "\e[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      "How spicy on scale? (1-5) \e[32m2\e[0m\n"
+    ].join)
+  end
+
+  it "overwrites default error message when wrong input" do
+    prompt.input << "A\n2\n"
+    prompt.input.rewind
+
+    answer = prompt.ask("How spicy on scale? (1-5)") do |q|
+      q.in '1-5'
+      q.messages[:range?] = 'Ohh dear what is this %{value} doing in %{in}?'
+    end
+
+    expect(answer).to eq('2')
+    expect(prompt.output.string).to eq([
+      "How spicy on scale? (1-5) ",
+      "\e[1000D\e[K",
+      "\e[31m>>\e[0m Ohh dear what is this A doing in 1..5?\e[1A",
+      "\e[1000D\e[K",
+      "How spicy on scale? (1-5) ",
+      "\e[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      "How spicy on scale? (1-5) \e[32m2\e[0m\n"
+    ].join)
+  end
 end

data/spec/unit/question/required_spec.rb

@@ -17,10 +17,14 @@ RSpec.describe TTY::Prompt::Question, '#required' do
   end
 
   it 'requires value to be present with option' do
-    prompt.input << "Piotr"
+    prompt.input << "  \nPiotr"
     prompt.input.rewind
-    prompt.ask('What is your name?') { |q| q.required(true) }
+    prompt.ask('What is your name?', required: true)
     expect(prompt.output.string).to eq([
+      "What is your name? ",
+      "\e[1000D\e[K",
+      "\e[31m>>\e[0m Value must be provided\e[1A",
+      "\e[1000D\e[K",
       "What is your name? ",
       "\e[1000D\e[K\e[1A",
       "\e[1000D\e[K",
@@ -34,4 +38,30 @@ RSpec.describe TTY::Prompt::Question, '#required' do
     answer = prompt.ask('What is your name?') { |q| q.required(false) }
     expect(answer).to be_nil
   end
+
+  it "uses required in validation check" do
+    prompt.input << "  \n#{__FILE__}\ntest\n"
+    prompt.input.rewind
+    answer = prompt.ask('File name?') do |q|
+      q.required(true)
+      q.validate { |v| !File.exist?(v) }
+      q.messages[:required?] = 'File name must not be empty!'
+      q.messages[:valid?]   = 'File already exists!'
+    end
+    expect(prompt.output.string).to eq([
+      "File name? ",
+       "\e[1000D\e[K",
+       "\e[31m>>\e[0m File name must not be empty!",
+       "\e[1A\e[1000D\e[K",
+      "File name? ",
+      "\e[1000D\e[K",
+      "\e[31m>>\e[0m File already exists!",
+      "\e[1A\e[1000D\e[K",
+      "File name? ",
+      "\e[1000D\e[K",
+      "\e[1A\e[1000D\e[K",
+      "File name? \e[32mtest\e[0m\n",
+    ].join)
+    expect(answer).to eq('test')
+  end
 end

data/spec/unit/question/validate_spec.rb

@@ -7,9 +7,11 @@ RSpec.describe TTY::Prompt::Question, '#validate' do
   it 'validates input with regex' do
     prompt.input << 'piotr.murach'
     prompt.input.rewind
+
     answer = prompt.ask('What is your username?') do |q|
       q.validate(/^[^\.]+\.[^\.]+/)
     end
+
     expect(answer).to eq('piotr.murach')
     expect(prompt.output.string).to eq([
       "What is your username? ",
@@ -22,18 +24,65 @@ RSpec.describe TTY::Prompt::Question, '#validate' do
   it 'validates input with proc' do
     prompt.input << 'piotr.murach'
     prompt.input.rewind
+
     answer = prompt.ask('What is your username?') do |q|
       q.validate { |input| input =~ /^[^\.]+\.[^\.]+/ }
     end
+
     expect(answer).to eq('piotr.murach')
   end
 
   it 'understands custom validation like :email' do
     prompt.input << 'piotr@example.com'
     prompt.input.rewind
+
+    answer = prompt.ask('What is your email?') do |q|
+      q.validate :email
+    end
+
+    expect(answer).to eq('piotr@example.com')
+  end
+
+  it "provides default error message for wrong input" do
+    prompt.input << "invalid\npiotr@example.com"
+    prompt.input.rewind
+
+    answer = prompt.ask('What is your email?') do |q|
+      q.validate :email
+    end
+
+    expect(answer).to eq('piotr@example.com')
+    expect(prompt.output.string).to eq([
+      "What is your email? ",
+      "\e[1000D\e[K",
+      "\e[31m>>\e[0m Your answer is invalid (must match :email)\e[1A",
+      "\e[1000D\e[K",
+      "What is your email? ",
+      "\e[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      "What is your email? \e[32mpiotr@example.com\e[0m\n"
+    ].join)
+  end
+
+  it "provides custom error message for wrong input" do
+    prompt.input << "invalid\npiotr@example.com"
+    prompt.input.rewind
+
     answer = prompt.ask('What is your email?') do |q|
       q.validate :email
+      q.messages[:valid?] = 'Not an email!'
     end
+
     expect(answer).to eq('piotr@example.com')
+    expect(prompt.output.string).to eq([
+      "What is your email? ",
+      "\e[1000D\e[K",
+      "\e[31m>>\e[0m Not an email!\e[1A",
+      "\e[1000D\e[K",
+      "What is your email? ",
+      "\e[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      "What is your email? \e[32mpiotr@example.com\e[0m\n"
+    ].join)
   end
 end

data/spec/unit/reader/key_event_spec.rb

@@ -1,13 +1,21 @@
 # encoding: utf-8
 
-RSpec.describe TTY::Prompt::Reader::KeyEvent, '::from' do
+require 'shellwords'
 
+RSpec.describe TTY::Prompt::Reader::KeyEvent, '#from' do
   it "parses ctrl+h" do
     event = described_class.from("\b")
     expect(event.key.name).to eq(:backspace)
     expect(event.value).to eq("\b")
   end
 
+  it "parses backspace" do
+    event = described_class.from("\e\x7f")
+    expect(event.key.name).to eq(:backspace)
+    expect(event.key.meta).to eq(true)
+    expect(event.value).to eq("\e\x7f")
+  end
+
   it "parses lowercase char" do
     event = described_class.from('a')
     expect(event.key.name).to eq('a')
@@ -20,48 +28,69 @@ RSpec.describe TTY::Prompt::Reader::KeyEvent, '::from' do
     expect(event.value).to eq('A')
   end
 
-  it "parses f5 key" do
-    event = described_class.from("\e[15~")
-    expect(event.key.name).to eq(:f5)
-  end
-
-  it "parses up key" do
-    event = described_class.from("\e[A")
-    expect(event.key.name).to eq(:up)
-  end
-
-  it "parses up key on gnome" do
-    event = described_class.from("\eOA")
-    expect(event.key.name).to eq(:up)
-  end
-
-  it "parses down key" do
-    event = described_class.from("\e[B")
-    expect(event.key.name).to eq(:down)
-  end
-
-  it "parses right key" do
-    event = described_class.from("\e[C")
-    expect(event.key.name).to eq(:right)
-  end
-
-  it "parses left key" do
-    event = described_class.from("\e[D")
-    expect(event.key.name).to eq(:left)
-  end
-
-  it "parses clear key" do
-    event = described_class.from("\e[E")
-    expect(event.key.name).to eq(:clear)
+  # F1-F12 keys
+  {
+    f1:  ["\eOP", "\e[11~", "\e[[A"],
+    f2:  ["\eOQ", "\e[12~", "\e[[B"],
+    f3:  ["\eOR", "\e[13~", "\e[[C"],
+    f4:  ["\eOS", "\e[14~", "\e[[D"],
+    f5:  [        "\e[15~", "\e[[E"],
+    f6:  [        "\e[17~"         ],
+    f7:  [        "\e[18~"         ],
+    f8:  [        "\e[19~"         ],
+    f9:  [        "\e[20~"         ],
+    f10: [        "\e[21~"         ],
+    f11: [        "\e[23~"         ],
+    f12: [        "\e[24~"         ]
+  }.each do |name, codes|
+    codes.each do |code|
+      it "parses #{Shellwords.escape(code)} as #{name} key" do
+        event = described_class.from(code)
+        expect(event.key.name).to eq(name)
+        expect(event.key.meta).to eq(false)
+        expect(event.key.ctrl).to eq(false)
+        expect(event.key.shift).to eq(false)
+      end
+    end
   end
 
-  it "parses end key" do
-    event = described_class.from("\e[F")
-    expect(event.key.name).to eq(:end)
+  # arrow keys & page navigation
+  #
+  {
+    up:    ["\e[A", "\eOA"],
+    down:  ["\e[B", "\eOB"],
+    right: ["\e[C", "\eOC"],
+    left:  ["\e[D", "\eOD"],
+    clear: ["\e[E", "\eOE"],
+    end:   ["\e[F"],
+    home:  ["\e[H"]
+  }.each do |name, codes|
+    codes.each do |code|
+      it "parses #{Shellwords.escape(code)} as #{name} key" do
+        event = described_class.from(code)
+        expect(event.key.name).to eq(name)
+        expect(event.key.meta).to eq(false)
+        expect(event.key.ctrl).to eq(false)
+        expect(event.key.shift).to eq(false)
+      end
+    end
   end
 
-  it "parses home key" do
-    event = described_class.from("\e[H")
-    expect(event.key.name).to eq(:home)
+  {
+    up:    ["\e[a"],
+    down:  ["\e[b"],
+    right: ["\e[c"],
+    left:  ["\e[d"],
+    clear: ["\e[e"],
+  }.each do |name, codes|
+    codes.each do |code|
+      it "parses #{Shellwords.escape(code)} as SHIFT + #{name} key" do
+        event = described_class.from(code)
+        expect(event.key.name).to eq(name)
+        expect(event.key.meta).to eq(false)
+        expect(event.key.ctrl).to eq(false)
+        expect(event.key.shift).to eq(true)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-prompt
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-07 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: necromancer
@@ -139,6 +139,7 @@ files:
 - examples/enum_select.rb
 - examples/expand.rb
 - examples/in.rb
+- examples/keypress.rb
 - examples/mask.rb
 - examples/multi_select.rb
 - examples/select.rb