tty-prompt 0.23.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dcdfb83f0945b162d19c5a068386009fbc5cc2f90969374018ee9aad72bd116
-  data.tar.gz: 004ebca9f017ea58bca8d4400e61d4817394b55343c0ecc3a3727f8818103d8f
+  metadata.gz: 69ced9f6a4234a7234fc2dbce1bc17a982afd2922d7a5c30e0f57030c0970e01
+  data.tar.gz: 26835914ed361e5617660f8bbd9106c101d2963a6e7ae335c4c57ed910658773
 SHA512:
-  metadata.gz: e9fe7560e4dd4aca6e47d6ca67dca40079b4350ac97834d9bdca8c21254048097b338092177bebe5a1a2da1609fce1e155ee4a373c3d16c6979fc261a02dcc52
-  data.tar.gz: eff0e563cde0179831056cf107f61e17681269b705f7d499a657d84f365197500c5ea0220aad8b3959ef3d82bd0ac1db49d8beb4566881cb257112b2f69beafa
+  metadata.gz: 767a3e943e5740eddbcf14fe9d25fd1d14054402c45d7020762b2cc78842720699223ec27fd229ea70cfb47ab6879b5fd144a76073e44092ed4b8eca1a56e357
+  data.tar.gz: 65b4c4d5ec2d06b900ef4bbd2012eb12c1c1952fe2b7c8ba1865714393da5c34f232a13a35bbefeee870b57d2cb741c77586725bd00a3a1e6a7a61521dfb8c13

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## [v0.23.1] - 2021-04-17
+
+### Changed
+* Change validate to allow access to invalid input inside the message
+
+### Fixed
+* Fix Choice#from to differentiate between no value being set and nil value
+
 ## [v0.23.0] - 2020-12-14
 
 ### Added
@@ -394,6 +402,7 @@
 
 * Initial implementation and release
 
+[v0.23.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.23.0...v0.23.1
 [v0.23.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.22.0...v0.23.0
 [v0.22.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.21.0...v0.22.0
 [v0.21.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.20.0...v0.21.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Piotr Murach
+Copyright (c) 2015 Piotr Murach (piotrmurach.com)
 
 MIT License
 

data/README.md

@@ -357,7 +357,7 @@ prompt.ask("password:", echo: false)
 
 #### 2.1.5 error messages
 
-By default `tty-prompt` comes with predefined error messages for `required`, `in`, `validate` options.
+By default `tty-prompt` comes with predefined error messages for `convert`, `required`, `in`, `validate` options.
 
 You can change these and configure to your liking either by passing message as second argument with the option:
 
@@ -367,7 +367,7 @@ prompt.ask("What is your email?") do |q|
 end
 ```
 
-Or change the `messages` key entry out of `:required?`, `:valid?`, `:range?`:
+Or change the `messages` key entry out of `:convert?`, `:range?`, `:required?` and `:valid?`:
 
 ```ruby
 prompt.ask("What is your email?") do |q|
@@ -432,7 +432,9 @@ prompt.ask("What's your phone number?", required: true)
 
 #### 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`.
+In order to validate that input matches a given pattern you can pass the `validate` option/method.
+
+Validate accepts `Regex`, `Proc` or `Symbol`.
 
 ```ruby
 prompt.ask("What is your username?") do |q|
@@ -440,18 +442,37 @@ prompt.ask("What is your username?") do |q|
 end
 ```
 
+The above can also be expressed as a `Proc`:
+
 ```ruby
 prompt.ask("What is your username?") do |q|
   q.validate ->(input) { input =~ /\A[^.]+\.[^.]+\Z/ }
 end
 ```
 
-The **TTY::Prompt** comes with built-in validations for `:email` and you can use them directly like so:
+There is a built-in validation for `:email` and you can use it directly like so:
 
 ```ruby
 prompt.ask("What is your email?") { |q| q.validate :email }
 ```
 
+The default validation message is `"Your answer is invalid (must match %{valid})"` and you can customise it by passing in a second argument:
+
+```ruby
+prompt.ask("What is your username?") do |q|
+  q.validate(/\A[^.]+\.[^.]+\Z/, "Invalid username: %{value}, must match %{valid}")
+end
+```
+
+The default message can also be set using `messages` and the `:valid?` key:
+
+```ruby
+prompt.ask("What is your username?") do |q|
+  q.validate(/\A[^.]+\.[^.]+\Z/)
+  q.messages[:valid?] = "Invalid username: %{value}, must match %{valid}")
+end
+```
+
 ### 2.2. keypress
 
 In order to ask question that awaits a single character answer use `keypress` prompt like so:

data/lib/tty/prompt/choice.rb

@@ -31,12 +31,7 @@ module TTY
         when Choice
           val
         when Array
-          name, value, options = *val
-          if name.is_a?(Hash)
-            convert_hash(name)
-          else
-            new(name.to_s, (value.nil? ? name.to_s : value), **(options || {}))
-          end
+          convert_array(val)
         when Hash
           convert_hash(val)
         else
@@ -44,7 +39,29 @@ module TTY
         end
       end
 
-      # Convert hash into choice
+      # Convert an array into choice
+      #
+      # @param [Array<Object>]
+      #
+      # @return [Choice]
+      #
+      # @api public
+      def self.convert_array(val)
+        name, value, options = *val
+        if name.is_a?(Hash)
+          convert_hash(name)
+        elsif val.size == 1
+          new(name.to_s, name.to_s)
+        else
+          new(name.to_s, value, **(options || {}))
+        end
+      end
+
+      # Convert a hash into choice
+      #
+      # @param [Hash<Symbol,Object>]
+      #
+      # @return [Choice]
       #
       # @api public
       def self.convert_hash(val)

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

@@ -56,7 +56,7 @@ module TTY
                 Validation.new(question.validation).call(value))
               [value]
             else
-              tokens = { valid: question.validation.inspect }
+              tokens = { valid: question.validation.inspect, value: value }
               [value, question.message_for(:valid?, tokens)]
             end
           end

data/lib/tty/prompt/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Prompt
-    VERSION = "0.23.0"
+    VERSION = "0.23.1"
   end # Prompt
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-prompt
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.23.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-14 00:00:00.000000000 Z
+date: 2021-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel