tty-prompt 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6c43cfd17fb7fe5d5f256f124571fb904a3d6b3
-  data.tar.gz: 0cc290a7c31157fe9d953133ce2f7a3df5042142
+  metadata.gz: b2e80fd1b397f9aae2abb3195844a6d1d3dc2dea
+  data.tar.gz: 266c5ccc26bcbe7ea0a9634e7f702e3387a2bce4
 SHA512:
-  metadata.gz: b20f2aa8fab1798c62b8e5a9770351ab58fcf6de0afbbf7a60eba88c31e0b551273cd706944a3e17e3b6e1f6f1366d5e0d60f8c61b638c28dc6e9f0b657b9aac
-  data.tar.gz: 6f2be862205c779ba31d2651b4e9d7874d5df4a4566218e0793224215db197900dc930022940418f04fb7427948036928897e7384f65570f5d741f05b7f405e8
+  metadata.gz: d249d03ac3dd16fc49b784e5d11983f31c15d30991c524fe6dbc1fd135c7509fef3476f1ef3b1ad4c5e1dd9bcf19ec938743771c4f121fcf96977b3913220ab2
+  data.tar.gz: eacb6d537e03baaf4219304af247d0baaf24f0d22efd2e49eec368d5f19a4f5449ec10af4ca9009eba2dc468b91d22580b5df47333c519b759ba010e8505d394

data/.travis.yml

@@ -2,13 +2,14 @@
 language: ruby
 sudo: false
 cache: bundler
-bundler_args: --without yard benchmarks
+bundler_args: --without tools
 script: "bundle exec rake ci"
 rvm:
   - 1.9.3
   - 2.0
   - 2.1
   - 2.2
+  - 2.3.0
   - ruby-head
   - jruby-19mode
   - jruby
@@ -23,3 +24,5 @@ matrix:
   fast_finish: true
 branches:
   only: master
+notifications:
+  email: false

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change log
 
+## [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
@@ -44,6 +58,7 @@
 
 * Initial implementation and release
 
+[v0.4.0]: https://github.com/peter-murach/tty-prompt/compare/v0.3.0...v0.4.0
 [v0.3.0]: https://github.com/peter-murach/tty-prompt/compare/v0.2.0...v0.3.0
 [v0.2.0]: https://github.com/peter-murach/tty-prompt/compare/v0.1.0...v0.2.0
 [v0.1.0]: https://github.com/peter-murach/tty-prompt/compare/v0.1.0

data/Gemfile

@@ -2,10 +2,10 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :development do
-  gem 'rspec', '~> 3.3.0'
+group :tools do
   gem 'yard',  '~> 0.8.7'
   gem 'benchmark-ips', '~> 2.0.0'
+  gem 'byebug', platform: :mri
 end
 
 group :metrics do

data/README.md

@@ -18,7 +18,8 @@
 ## Features
 
 * Number of prompt types for gathering user input
-* A robust API for getting and validating complex inputs
+* A robust API for validating complex inputs
+* User friendly error feedback
 
 ## Installation
 
@@ -49,17 +50,20 @@ 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.3 keypress](#23-keypress)
   * [2.4 multiline](#24-multiline)
   * [2.5 mask](#25-mask)
   * [2.6 yes?/no?](#26-yesno)
   * [2.7 select](#27-select)
   * [2.8 multi_select](#28-multi_select)
-  * [2.9 suggest](#29-suggest)
-  * [2.10 say](#210-say)
-  * [2.11 ok](#211-ok)
-  * [2.12 warn](#212-warn)
-  * [2.13 error](#213-warn)
+  * [2.9 enum_select](#29-enum_select)
+  * [2.10 suggest](#210-suggest)
+  * [2.11 slider](#211-slider)
+  * [2.12 say](#212-say)
+  * [2.13 ok](#213-ok)
+  * [2.14 warn](#214-warn)
+  * [2.15 error](#215-warn)
 
 ## 1. Usage
 
@@ -105,7 +109,7 @@ Also, asking multiple choice questions is a breeze with `multi_select`:
 
 ```ruby
 choices = %w(vodka beer wine whisky bourbon)
-prompt.select("Select drinks?", choices)
+prompt.multi_select("Select drinks?", choices)
 # =>
 #
 # Select drinks? (Use arrow keys, press Space to select and Enter to finish)"
@@ -116,6 +120,20 @@ prompt.select("Select drinks?", choices)
 #   ⬡ 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?")
+# =>
+#
+# Select an editor?
+#   1) /bin/nano
+#   2) /usr/bin/vim.basic
+#   3) /usr/bin/vim.tiny
+#   Choose 1-3 [2]:
+```
+
 ## 2. Interface
 
 ### 2.1 ask
@@ -214,7 +232,7 @@ ask("Provide number in range: 0-9?") { |q| q.in('0-9') }
 
 #### 2.2.5 modify
 
-Set the `:modify` option if you want to handle whitespace or letter capitalization. 
+Set the `:modify` option if you want to handle whitespace or letter capitalization.
 
 ```ruby
 prompt.ask('Enter text:') do |q|
@@ -224,8 +242,8 @@ end
 
 Available letter casing settings are:
 ```ruby
-:up         # change to small case
-:down       # change to upper case
+:up         # change to upper case
+:down       # change to small case
 :capitalize # capitalize each word
 ```
 
@@ -244,7 +262,7 @@ To ensure that input is provided use `:required` option:
 ```ruby
 prompt.ask("What's your phone number?", required: true)
 # What's your phone number?
-# >> No value provided for required
+# >> Value must be provided
 ```
 
 #### 2.2.7 validate
@@ -263,25 +281,43 @@ 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
+
+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:
+
+```ruby
+prompt.ask('What is your email?') do |q|
+  question.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|
+  question.validate(/\A\w+@\w+\.\w+\Z/)
+  question.messages[:valid?] = 'Invalid email address'
+end
+```
+
 ### 2.3 keypress
 
-In order to ask question with a single character or keypress answer use `ask_keypress`:
+In order to ask question with a single character or keypress answer use `keypress`:
 
 ```ruby
-prompt.ask_keypress("Which one do you prefer a, b, c or d ?")
+prompt.keypress("Which one do you prefer a, b, c or d ?")
 ```
 
 ### 2.4 multiline
 
-Asking for multiline input can be done with `ask_multiline` method.
+Asking for multiline input can be done with `multiline` method.
 
 ```ruby
-prompt.ask_multiline("Provide description?")
+prompt.multiline("Provide description?")
 ```
 
 The reading of input will terminate when empty line is submitted.
 
-
 ### 2.5 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.
@@ -325,7 +361,7 @@ There is also the opposite for asking confirmation of negative option:
 ```ruby
 prompt.no?('Do you hate Ruby?')
 # =>
-# Do you like Ruby? (y/N)
+# Do you hate Ruby? (y/N)
 ```
 
 ### 2.7 select
@@ -341,7 +377,7 @@ prompt.select("Choose your destiny?", %w(Scorpion Kano Jax))
 #   Jax
 ```
 
-You can also provide options through DSL using the `choice` method for single entry and/or `choices` call for more than one choice:
+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|
@@ -395,6 +431,23 @@ end
 # ‣ 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, marker like so
 
 ```ruby
@@ -466,6 +519,27 @@ end
 # ‣ ⬢ 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
@@ -473,7 +547,66 @@ And when you press enter you will see the following selected:
 # => [{score: 20}, {score: 50}]
 ```
 
-### 2.9 suggest
+### 2.9 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.10 suggest
 
 To suggest possible matches for the user input use `suggest` method like so:
 
@@ -485,7 +618,7 @@ prompt.suggest('sta', ['stage', 'stash', 'commit', 'branch'])
 #         stash
 ```
 
-To cusomize query text presented pass `:single_text` and `:plural_text` options to respectively change the message when one match is found or many.
+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)
@@ -495,7 +628,34 @@ prompt.suggest('b', possible, indent: 4, single_text: 'Perhaps you meant?')
 #     blame
 ```
 
-### 2.10 say
+### 2.11 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 `O` marker.
+
+```ruby
+prompt.slider('What size?', min: 32, max: 54, step: 2)
+# =>
+#
+# What size? (User arrow keys, press Enter to select)
+# |------O-----| 44
+```
+
+Slider can be configured through DSL as well:
+
+```ruby
+prompt.slider('What size?') do |range|
+  range.default 4
+  range.min 0
+  range.max 20
+  range.step 2
+end
+# =>
+#
+# What size? (User arrow keys, press Enter to select)
+# |--O-------| 4
+```
+
+### 2.12 say
 
 To simply print message out to stdout use `say` like so:
 
@@ -507,7 +667,7 @@ The `say` method also accepts option `:color` which supports all the colors prov
 
 **TTY::Prompt** provides more specific versions of `say` method to better express intenation behind the message such as `ok`, `warn` and `error`.
 
-### 2.11 ok
+### 2.13 ok
 
 Print message(s) in green do:
 
@@ -515,7 +675,7 @@ Print message(s) in green do:
 prompt.ok(...)
 ```
 
-### 2.12 warn
+### 2.14 warn
 
 Print message(s) in yellow do:
 
@@ -523,7 +683,7 @@ Print message(s) in yellow do:
 prompt.warn(...)
 ```
 
-### 2.13 error
+### 2.15 error
 
 Print message(s) in red do:
 
@@ -541,4 +701,4 @@ prompt.error(...)
 
 ## Copyright
 
-Copyright (c) 2015 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2015-2016 Piotr Murach. See LICENSE for further details.

data/examples/enum.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+warriors = %w(Scorpion Kano Jax)
+prompt.select('Choose your destiny?', warriors, enum: ')')

data/examples/enum_select.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+choices = %w(/bin/nano /usr/bin/vim.basic /usr/bin/vim.tiny)
+prompt.enum_select('Select an editor', choices, default: 2)

data/examples/in.rb

@@ -4,4 +4,6 @@ require 'tty-prompt'
 
 prompt = TTY::Prompt.new
 
-prompt.ask('How do you like it on scale 1 - 10?', in: '1-10')
+prompt.ask('How do you like it on scale 1 - 10?', in: '1-10') do |q|
+  q.messages[:range?] = "Sorry wrong one!"
+end