tty-prompt 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea89e6284f92e7de76bdd3457f6345912e11b7dc6c8c0249798aa0c88eb80759
-  data.tar.gz: 4620f5a0473bf600646066a8e0f970993d310ef7a85ab0e5abd928b846c2765e
+  metadata.gz: 3dcdfb83f0945b162d19c5a068386009fbc5cc2f90969374018ee9aad72bd116
+  data.tar.gz: 004ebca9f017ea58bca8d4400e61d4817394b55343c0ecc3a3727f8818103d8f
 SHA512:
-  metadata.gz: fd45c4a0690e88647f28762bdab648f1a71e85203691548e5e9a1a0a1775a02e670a512c52187f12720aadd17cdbba16f0fa4b302a5d1c9421c978224f9c6002
-  data.tar.gz: 5d7c1b924060658c808ccb5358bed6d9b7deda6a4a6a13f3fb14382344ce502f68bc2c327d6234a59a6abf23c42c1da8c587b4da481dbd4403d66d1d955bf804
+  metadata.gz: e9fe7560e4dd4aca6e47d6ca67dca40079b4350ac97834d9bdca8c21254048097b338092177bebe5a1a2da1609fce1e155ee4a373c3d16c6979fc261a02dcc52
+  data.tar.gz: eff0e563cde0179831056cf107f61e17681269b705f7d499a657d84f365197500c5ea0220aad8b3959ef3d82bd0ac1db49d8beb4566881cb257112b2f69beafa

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change log
 
+## [v0.23.0] - 2020-12-14
+
+### Added
+* Add the ability to provide an arbitrary array of values to Prompt::Slider by Katelyn Schiesser (@slowbro)
+
+### Changed
+* Change to allow default option to be choice name as well as index in select, multi_select and enum_select prompts
+
+### Fixed
+* Fix left and right key navigation while filtering choices in the #select and #multi_select prompts
+
 ## [v0.22.0] - 2020-07-20
 
 ### Added
@@ -43,7 +54,7 @@
 * Change gemspec to remove test artifacts
 
 ### Fixed
-* Fix :help_color option for multi_selct prompt by @robbystk
+* Fix :help_color option for multi_select prompt by @robbystk
 
 ## [v0.20.0] - 2019-11-24
 
@@ -383,6 +394,7 @@
 
 * Initial implementation and release
 
+[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
 [v0.20.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.19.0...v0.20.0

data/README.md

@@ -1,11 +1,11 @@
 <div align="center">
-  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="tty logo" /></a>
+  <a href="https://ttytoolkit.org"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="TTY Toolkit 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]
+[![Actions CI](https://github.com/piotrmurach/tty-prompt/workflows/CI/badge.svg?branch=master)][gh_actions_ci]
 [![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]
@@ -13,6 +13,7 @@
 
 [gitter]: https://gitter.im/piotrmurach/tty
 [gem]: http://badge.fury.io/rb/tty-prompt
+[gh_actions_ci]: https://github.com/piotrmurach/tty-prompt/actions?query=workflow%3ACI
 [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
@@ -23,10 +24,6 @@
 
 **TTY::Prompt** provides independent prompt component for [TTY](https://github.com/piotrmurach/tty) toolkit.
 
-<div align="center">
-  <img alt="Available prompts demo" src="assets/demo.gif" width="562" height="226">
-</div>
-
 ## Features
 
 * Number of prompt types for gathering user input
@@ -118,7 +115,7 @@ Or install it yourself as:
 * [3. settings](#3-settings)
   * [3.1 :symbols](#31-symbols)
   * [3.2 :active_color](#32-active_color)
-  * [3.3 :enable_color](#33-enable-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)
@@ -304,7 +301,7 @@ prompt.ask("Provide keys and values:", convert: :int_map)
 If a user provides a wrong type for conversion an error message will be printed in the console:
 
 ```ruby
-prompt.ask("Provide digit:", convert: float)
+prompt.ask("Provide digit:", convert: :float)
 # Provide digit: x
 # >> Cannot convert `x` into 'float' type
 ```
@@ -312,8 +309,8 @@ prompt.ask("Provide digit:", convert: float)
 You can further customize error message:
 
 ```ruby
-prompt.ask("Provide digit:", convert: float) do |q|
-  q.convert(:float, "Wrong value of %{value} for %{type} conversion"
+prompt.ask("Provide digit:", convert: :float) do |q|
+  q.convert(:float, "Wrong value of %{value} for %{type} conversion")
   # or
   q.convert :float
   q.messages[:convert?] = "Wrong value of %{value} for %{type} conversion"
@@ -384,7 +381,7 @@ 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}"
+  q.messages[:range?] = "%{value} out of expected range %{in}"
 end
 ```
 
@@ -393,7 +390,7 @@ end
 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") }
+prompt.ask("Provide number in range: 0-9?") { |q| q.in("0-9") }
 ```
 
 #### 2.1.7 `:modify`
@@ -439,13 +436,13 @@ In order to validate that input matches a given pattern you can pass the `valida
 
 ```ruby
 prompt.ask("What is your username?") do |q|
-  q.validate /^[^\.]+\.[^\.]+/
+  q.validate(/\A[^.]+\.[^.]+\Z/)
 end
 ```
 
 ```ruby
 prompt.ask("What is your username?") do |q|
-  q.validate { |input| input =~ /^[^\.]+\.[^\.]+/ }
+  q.validate ->(input) { input =~ /\A[^.]+\.[^.]+\Z/ }
 end
 ```
 
@@ -495,7 +492,8 @@ prompt.multiline("Description?")
 # 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"]
+# =>
+# ["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:
@@ -522,11 +520,11 @@ prompt.mask("What is your secret?")
 # => What is your secret? ••••
 ```
 
-The masking character can be changed by passing `:symbols` option with `:mask` key:
+The masking character can be changed by passing the `:mask` key:
 
 ```ruby
 heart = prompt.decorate(prompt.symbols[:heart] + " ", :magenta)
-prompt.mask("What is your secret?", symbols: {mask: heart})
+prompt.mask("What is your secret?", mask: heart)
 # => What is your secret? ❤  ❤  ❤  ❤  ❤
 ```
 
@@ -615,6 +613,12 @@ By default the choice name is also the value the prompt will return when selecte
 
 ```ruby
 choices = {small: 1, medium: 2, large: 3}
+prompt.select("What size?", choices)
+# =>
+# What size? (Press ↑/↓ arrow to move and Enter to select)
+# ‣ small
+#   medium
+#   large
 ```
 
 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:
@@ -637,6 +641,11 @@ prompt.select("What size?") do |menu|
   menu.choice name: "medium", value: 2, disabled: "(out of stock)"
   menu.choice name: "large",  value: 3
 end
+# =>
+# What size? (Press ↑/↓ arrow to move and Enter to select)
+# ‣ small
+# ✘ medium (out of stock)
+#   large
 ```
 
 or in a more compact way:
@@ -711,11 +720,12 @@ 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`:
+To mark particular answer as selected use `default` with either an index of the choice starting from `1` or a choice's name:
 
 ```ruby
 prompt.select("Choose your destiny?") do |menu|
   menu.default 3
+  # or menu.default "Jax"
 
   menu.choice "Scorpion", 1
   menu.choice "Kano", 2
@@ -728,7 +738,6 @@ end
 # ‣ Jax
 ```
 
-
 #### 2.6.2.1 `:cycle`
 
 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`:
@@ -924,11 +933,12 @@ prompt.multi_select("Select drinks?") do |menu|
 end
 ```
 
-To mark choice(s) as selected use the `default` option with index(s) of the option(s) starting from `1`:
+To mark choice(s) as selected use the `default` option with either index(s) of the choice(s) starting from `1` or choice name(s):
 
 ```ruby
 prompt.multi_select("Select drinks?") do |menu|
   menu.default 2, 5
+  # or menu.default :beer, :whisky
 
   menu.choice :vodka,   {score: 10}
   menu.choice :beer,    {score: 20}
@@ -1158,12 +1168,13 @@ end
 # Select an editor? /bin/nano
 ```
 
-You can change the indexed numbers by passing `enum` option and the default option by using `default` like so
+You can change the indexed numbers formatting by passing `enum` option. The `default` option lets you specify which choice to mark as selected by default. It accepts an index of the choice starting from `1` or a choice name:
 
 ```ruby
 choices = %w(nano vim emacs)
 prompt.enum_select("Select an editor?") do |menu|
   menu.default 2
+  # or menu.defualt "/usr/bin/vim"
   menu.enum "."
 
   menu.choice :nano,  "/bin/nano"
@@ -1377,17 +1388,26 @@ prompt.suggest("b", possible, indent: 4, single_text: "Perhaps you meant?")
 
 ### 2.10 slider
 
-If you have constrained range of numbers for user to choose from you may consider using `slider`.
+If you'd rather not display all possible values in a vertical list, you may consider using `slider`. The slider provides easy visual way of picking a value marked by `●` symbol.
 
-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:
+For integers, 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)
+prompt.slider("Volume", min: 0, max: 100, step: 5)
 # =>
 # Volume ──────────●────────── 50
 # (Use ←/→ arrow keys, press Enter to select)
 ```
 
+For everything else, you can provide an array of your desired choices:
+
+```ruby
+prompt.slider("Letter", ('a'..'z').to_a)
+# =>
+# Letter ────────────●───────────── m
+# (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
@@ -1397,6 +1417,15 @@ prompt.slider("Volume", max: 100, step: 5, default: 75)
 # (Use ←/→ arrow keys, press Enter to select)
 ```
 
+You can also select the default value by name:
+
+```ruby
+prompt.slider("Letter", ('a'..'z').to_a, default: 'q')
+# =>
+# Letter ──────────────────●─────── q
+# (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
@@ -1450,13 +1479,25 @@ prompt.slider("What size?") do |range|
   range.max 100
   range.step 5
   range.default 75
-  range.format "|:slider| %d%"
+  range.format "|:slider| %d%%"
 end
 # =>
 # Volume |───────────────●──────| 75%
 # (Use ←/→ arrow keys, press Enter to select)
 ```
 
+```ruby
+prompt.slider("What letter?") do |range|
+  range.choices ('a'..'z').to_a
+  range.format "|:slider| %s"
+  range.default 'q'
+end
+# =>
+# What letter? |──────────────────●───────| q
+# (Use ←/→ arrow keys, press Enter to select)
+```
+
+
 ### 2.11 say
 
 To simply print message out to standard output use `say` like so:
@@ -1640,7 +1681,7 @@ prompt = TTY::Prompt.new(help_color: notice)
 
 Or use coloring of your own choice:
 
-```
+```ruby
 prompt = TTY::Prompt.new(help_color: ->(str) { my-color-gem(str) })
 ```
 
@@ -1657,7 +1698,7 @@ Please [see pastel](https://github.com/piotrmurach/pastel#3-supported-colors) fo
 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
+* `:exit` - exits with status code
 * `:noop` - skips handler
 * custom proc
 

data/lib/tty/prompt.rb

@@ -388,16 +388,20 @@ module TTY
     # @example
     #   prompt = TTY::Prompt.new
     #   prompt.slider("What size?", min: 32, max: 54, step: 2)
+    #   prompt.slider("What size?", [ 'xs', 's', 'm', 'l', 'xl' ])
     #
     # @param [String] question
     #   the question to ask
     #
+    # @param [Array] choices
+    #   the choices to display
+    #
     # @return [String]
     #
     # @api public
-    def slider(question, **options, &block)
+    def slider(question, choices = nil, **options, &block)
       slider = Slider.new(self, **options)
-      slider.call(question, &block)
+      slider.call(question, choices, &block)
     end
 
     # Print statement out. If the supplied message ends with a space or

data/lib/tty/prompt/choice.rb

@@ -111,9 +111,10 @@ module TTY
       # @api public
       def ==(other)
         return false unless other.is_a?(self.class)
+
         name == other.name &&
-        value == other.value &&
-        key == other.key
+          value == other.value &&
+          key == other.key
       end
 
       # Object string representation
@@ -122,7 +123,7 @@ module TTY
       #
       # @api public
       def to_s
-        "#{name}"
+        name.to_s
       end
     end # Choice
   end # Prompt

data/lib/tty/prompt/choices.rb

@@ -62,6 +62,7 @@ module TTY
       # @api public
       def each(&block)
         return to_enum unless block_given?
+
         choices.each(&block)
       end
 
@@ -100,7 +101,7 @@ module TTY
 
       # Find a matching choice
       #
-      # @exmaple
+      # @example
       #   choices.find_by(:name, "small")
       #
       # @param [Symbol] attr

data/lib/tty/prompt/confirm_question.rb

@@ -38,6 +38,7 @@ module TTY
       # @api public
       def suffix(value = (not_set = true))
         return @negative if not_set
+
         @suffix = value
       end
 
@@ -46,6 +47,7 @@ module TTY
       # @api public
       def positive(value = (not_set = true))
         return @positive if not_set
+
         @positive = value
       end
 
@@ -54,11 +56,13 @@ module TTY
       # @api public
       def negative(value = (not_set = true))
         return @negative if not_set
+
         @negative = value
       end
 
       def call(message, &block)
         return if Utils.blank?(message)
+
         @message = message
         block.call(self) if block
         setup_defaults

data/lib/tty/prompt/enum_list.rb

@@ -15,6 +15,9 @@ module TTY
     class EnumList
       PAGE_HELP = "(Press tab/right or left to reveal more choices)"
 
+      # Checks type of default parameter to be integer
+      INTEGER_MATCHER = /\A[-+]?\d+\Z/.freeze
+
       # Create instance of EnumList menu.
       #
       # @api public
@@ -22,11 +25,11 @@ module TTY
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
         @enum         = options.fetch(:enum) { ")" }
-        @default      = options.fetch(:default) { -1 }
+        @default      = options.fetch(:default, nil)
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color)   { @prompt.help_color }
         @error_color  = options.fetch(:error_color)  { @prompt.error_color }
-        @cycle        = options.fetch(:cycle) { false }
+        @cycle        = options.fetch(:cycle, false)
         @quiet        = options.fetch(:quiet) { @prompt.quiet }
         @symbols      = @prompt.symbols.merge(options.fetch(:symbols, {}))
         @input        = nil
@@ -49,6 +52,7 @@ module TTY
       # @api public
       def symbols(new_symbols = (not_set = true))
         return @symbols if not_set
+
         @symbols.merge!(new_symbols)
       end
 
@@ -65,7 +69,7 @@ module TTY
       #
       # @api public
       def default?
-        @default > 0
+        !@default.to_s.empty?
       end
 
       # Set number of items per page
@@ -153,6 +157,7 @@ module TTY
       def keypress(event)
         if %i[backspace delete].include?(event.key.name)
           return if @input.empty?
+
           @input.chop!
           mark_choice_as_active
         elsif event.value =~ /^\d+$/
@@ -195,7 +200,6 @@ module TTY
 
       private
 
-
       # Find active choice or set to default
       #
       # @return [nil]
@@ -220,6 +224,8 @@ module TTY
       def validate_defaults
         msg = if @default.nil? || @default.to_s.empty?
                 "default index must be an integer in range (1 - #{choices.size})"
+              elsif @default.to_s !~ INTEGER_MATCHER
+                validate_default_name
               elsif @default < 1 || @default > @choices.size
                 "default index #{@default} out of range (1 - #{@choices.size})"
               elsif choices[@default - 1] && choices[@default - 1].disabled?
@@ -229,14 +235,31 @@ module TTY
         raise(ConfigurationError, msg) if msg
       end
 
+      # Validate default choice name
+      #
+      # @return [String]
+      #
+      # @api private
+      def validate_default_name
+        default_choice = choices.find_by(:name, @default.to_s)
+        if default_choice.nil?
+          "no choice found for the default name: #{@default.inspect}"
+        elsif default_choice.disabled?
+          "default name #{@default.inspect} matches disabled choice"
+        end
+      end
+
       # Setup default option and active selection
       #
       # @api private
       def setup_defaults
-        if !default?
-          @default = (0..choices.length).find {|i| !choices[i].disabled? } + 1
+        if @default.to_s.empty?
+          @default = (0..choices.length).find { |i| !choices[i].disabled? } + 1
         end
         validate_defaults
+        if default_choice = choices.find_by(:name, @default)
+          @default = choices.index(default_choice) + 1
+        end
         mark_choice_as_active
       end
 
@@ -342,6 +365,7 @@ module TTY
       def render_header
         return "" unless @done
         return "" unless @active
+
         selected_item = @choices[@active - 1].name.to_s
         @prompt.decorate(selected_item, @active_color)
       end
@@ -362,6 +386,7 @@ module TTY
       # @api private
       def page_help_message
         return "" unless paginated?
+
         "\n" + @prompt.decorate(@page_help, @help_color)
       end
 

data/lib/tty/prompt/evaluator.rb

@@ -23,7 +23,7 @@ module TTY
       def check(proc = nil, &block)
         results << (proc || block)
       end
-      alias_method :<<, :check
+      alias << check
     end # Evaluator
   end # Prompt
 end # TTY

data/lib/tty/prompt/expander.rb

@@ -15,14 +15,17 @@ module TTY
         value: :help
       }.freeze
 
+      # Names for delete keys
+      DELETE_KEYS = %i[backspace delete].freeze
+
       # Create instance of Expander
       #
       # @api public
       def initialize(prompt, options = {})
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
-        @default      = options.fetch(:default) { 1 }
-        @auto_hint    = options.fetch(:auto_hint) { false }
+        @default      = options.fetch(:default, 1)
+        @auto_hint    = options.fetch(:auto_hint, false)
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
         @quiet        = options.fetch(:quiet) { @prompt.quiet }
@@ -75,7 +78,7 @@ module TTY
       #
       # @api public
       def keypress(event)
-        if [:backspace, :delete].include?(event.key.name)
+        if DELETE_KEYS.include?(event.key.name)
           @input.chop! unless @input.empty?
         elsif event.value =~ /^[^\e\n\r]/
           @input += event.value
@@ -101,6 +104,7 @@ module TTY
       # @api public
       def default(value = (not_set = true))
         return @default if not_set
+
         @default = value
       end
 

data/lib/tty/prompt/keypress.rb

@@ -30,6 +30,7 @@ module TTY
 
       def countdown(value = (not_set = true))
         return @countdown if not_set
+
         @countdown = value
       end
 
@@ -81,6 +82,7 @@ module TTY
 
         @timer.while_remaining do |remaining|
           break if @done
+
           @input = @prompt.read_keypress(nonblock: true)
         end
         countdown(0) unless @done

data/lib/tty/prompt/list.rb

@@ -16,6 +16,9 @@ module TTY
       # Allowed keys for filter, along with backspace and canc.
       FILTER_KEYS_MATCHER = /\A([[:alnum:]]|[[:punct:]])\Z/.freeze
 
+      # Checks type of default parameter to be integer
+      INTEGER_MATCHER = /\A\d+\Z/.freeze
+
       # Create instance of TTY::Prompt::List menu.
       #
       # @param Hash options
@@ -65,6 +68,7 @@ module TTY
       # @api public
       def symbols(new_symbols = (not_set = true))
         return @symbols if not_set
+
         @symbols.merge!(new_symbols)
       end
 
@@ -255,6 +259,7 @@ module TTY
         value = event.value.to_i
         return unless (1..choices.count).cover?(value)
         return if choices[value - 1].disabled?
+
         @active = value
       end
 
@@ -308,17 +313,19 @@ module TTY
       # When the choice on a page is outside of next page range then
       # adjust it to the last item, otherwise leave unchanged.
       def keyright(*)
-        if (@active + page_size) <= @choices.size
-          searchable = ((@active + page_size)..choices.length)
+        choices_size = choices.size
+        if (@active + page_size) <= choices_size
+          searchable = ((@active + page_size)..choices_size)
           @active = search_choice_in(searchable)
-        elsif @active <= @choices.size # last page shorter
+        elsif @active <= choices_size # last page shorter
           current   = @active % page_size
-          remaining = @choices.size % page_size
+          remaining = choices_size % page_size
+
           if current.zero? || (remaining > 0 && current > remaining)
-            searchable = @choices.size.downto(0).to_a
+            searchable = choices_size.downto(0).to_a
             @active = search_choice_in(searchable)
           elsif @cycle
-            searchable = ((current.zero? ? page_size : current)..choices.length)
+            searchable = ((current.zero? ? page_size : current)..choices_size)
             @active = search_choice_in(searchable)
           end
         end
@@ -330,10 +337,10 @@ module TTY
 
       def keyleft(*)
         if (@active - page_size) > 0
-          searchable = ((@active - page_size)..choices.length)
+          searchable = ((@active - page_size)..choices.size)
           @active = search_choice_in(searchable)
         elsif @cycle
-          searchable = @choices.size.downto(1).to_a
+          searchable = choices.size.downto(1).to_a
           @active = search_choice_in(searchable)
         end
         @paging_changed = !@by_page
@@ -375,14 +382,19 @@ module TTY
 
       # Setup default option and active selection
       #
+      # @return [Integer]
+      #
       # @api private
       def setup_defaults
         validate_defaults
 
-        if !@default.empty?
+        if @default.empty?
+          # no default, pick the first non-disabled choice
+          @active = choices.index { |choice| !choice.disabled? } + 1
+        elsif @default.first.to_s =~ INTEGER_MATCHER
           @active = @default.first
-        else
-          @active = @choices.index { |choice| !choice.disabled? } + 1
+        elsif default_choice = choices.find_by(:name, @default.first)
+          @active = choices.index(default_choice) + 1
         end
       end
 
@@ -397,16 +409,35 @@ module TTY
         @default.each do |d|
           msg = if d.nil? || d.to_s.empty?
                   "default index must be an integer in range (1 - #{choices.size})"
+                elsif d.to_s !~ INTEGER_MATCHER
+                  validate_default_name(d)
                 elsif d < 1 || d > choices.size
                   "default index `#{d}` out of range (1 - #{choices.size})"
-                elsif choices[d - 1] && choices[d - 1].disabled?
-                  "default index `#{d}` matches disabled choice item"
+                elsif (dflt_choice = choices[d - 1]) && dflt_choice.disabled?
+                  "default index `#{d}` matches disabled choice"
                 end
 
           raise(ConfigurationError, msg) if msg
         end
       end
 
+      # Validate default choice name
+      #
+      # @param [String] name
+      #   the name to verify
+      #
+      # @return [String]
+      #
+      # @api private
+      def validate_default_name(name)
+        default_choice = choices.find_by(:name, name.to_s)
+        if default_choice.nil?
+          "no choice found for the default name: #{name.inspect}"
+        elsif default_choice.disabled?
+          "default name #{name.inspect} matches disabled choice"
+        end
+      end
+
       # Render a selection list.
       #
       # By default the result is printed out.

data/lib/tty/prompt/mask_question.rb

@@ -5,6 +5,9 @@ require_relative "question"
 module TTY
   class Prompt
     class MaskQuestion < Question
+      # Names for delete keys
+      DELETE_KEYS = %i[backspace delete].freeze
+
       # Create masked question
       #
       # @param [Hash] options
@@ -27,19 +30,20 @@ module TTY
       # @api public
       def mask(char = (not_set = true))
         return @mask if not_set
+
         @mask = char
       end
 
-      def keyreturn(event)
+      def keyreturn(_event)
         @done_masked = true
       end
 
-      def keyenter(event)
+      def keyenter(_event)
         @done_masked = true
       end
 
       def keypress(event)
-        if [:backspace, :delete].include?(event.key.name)
+        if DELETE_KEYS.include?(event.key.name)
           @input.chop! unless @input.empty?
         elsif event.value =~ /^[^\e\n\r]/
           @input += event.value

data/lib/tty/prompt/multi_list.rb

@@ -60,6 +60,7 @@ module TTY
           @selected.delete_at(@active - 1)
         else
           return if @max && @selected.size >= @max
+
           @selected.insert(@active - 1, active_choice)
         end
       end
@@ -69,6 +70,7 @@ module TTY
       # @api private
       def keyctrl_a(*)
         return if @max && @max < choices.size
+
         @selected = SelectedChoices.new(choices.enabled, choices.enabled_indexes)
       end
 
@@ -77,6 +79,7 @@ module TTY
       # @api private
       def keyctrl_r(*)
         return if @max && @max < choices.size
+
         indexes = choices.each_with_index.reduce([]) do |acc, (choice, idx)|
                     acc << idx if !choice.disabled? && !@selected.include?(choice)
                     acc
@@ -92,14 +95,23 @@ module TTY
       def setup_defaults
         validate_defaults
         # At this stage, @choices matches all the visible choices.
-        default_indexes = @default.map { |d| d - 1 }
+        default_indexes = @default.map do |d|
+          if d.to_s =~ INTEGER_MATCHER
+            d - 1
+          else
+            choices.index(choices.find_by(:name, d.to_s))
+          end
+        end
         @selected = SelectedChoices.new(@choices.values_at(*default_indexes),
                                         default_indexes)
 
-        if !@default.empty?
+        if @default.empty?
+          # no default, pick the first non-disabled choice
+          @active = choices.index { |choice| !choice.disabled? } + 1
+        elsif @default.last.to_s =~ INTEGER_MATCHER
           @active = @default.last
-        else
-          @active = @choices.index { |choice| !choice.disabled? } + 1
+        elsif default_choice = choices.find_by(:name, @default.last.to_s)
+          @active = choices.index(default_choice) + 1
         end
       end
 

data/lib/tty/prompt/multiline.rb

@@ -25,6 +25,7 @@ module TTY
       # @api public
       def help(value = (not_set = true))
         return @help if not_set
+
         @help = value
       end
 
@@ -42,7 +43,7 @@ module TTY
         if !echo?
           header
         elsif @done
-          header << @prompt.decorate("#{@input}", @active_color)
+          header << @prompt.decorate(@input.to_s, @active_color)
         elsif @first_render
           header << @prompt.decorate(help, @help_color)
           @first_render = false

data/lib/tty/prompt/question.rb

@@ -55,7 +55,7 @@ module TTY
         @error_color  = options.fetch(:error_color) { :red }
         @value        = options.fetch(:value) { UndefinedSetting }
         @quiet        = options.fetch(:quiet) { @prompt.quiet }
-        @messages     = Utils.deep_copy(options.fetch(:messages) { { } })
+        @messages     = Utils.deep_copy(options.fetch(:messages) { {} })
         @done         = false
         @first_render = true
         @input        = nil
@@ -170,7 +170,7 @@ module TTY
       #
       # @api private
       def read_input(question)
-        options = {echo: echo}
+        options = { echo: echo }
         if value? && @first_render
           options[:value] = @value
           @first_render = false
@@ -257,6 +257,7 @@ module TTY
       # @api public
       def default(value = (not_set = true))
         return @default if not_set
+
         @default = value
       end
 
@@ -277,9 +278,10 @@ module TTY
       def required(value = (not_set = true), message = nil)
         messages[:required?] = message if message
         return @required if not_set
+
         @required = value
       end
-      alias_method :required?, :required
+      alias required? required
 
       # Set validation rule for an argument
       #
@@ -298,6 +300,7 @@ module TTY
       # @api public
       def value(val)
         return @value if val.nil?
+
         @value = val
       end
 
@@ -327,18 +330,20 @@ module TTY
       # @api public
       def echo(value = nil)
         return @echo if value.nil?
+
         @echo = value
       end
-      alias_method :echo?, :echo
+      alias echo? echo
 
       # Turn raw mode on or off. This enables character-based input.
       #
       # @api public
       def raw(value = nil)
         return @raw if value.nil?
+
         @raw = value
       end
-      alias_method :raw?, :raw
+      alias raw? raw
 
       # Set expected range of values
       #
@@ -351,6 +356,7 @@ module TTY
           @in = Converters.convert(:range, @in)
         end
         return @in if not_set
+
         @in = Converters.convert(:range, value)
       end
 

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

@@ -42,7 +42,7 @@ module TTY
               (question.in? && question.in.include?(cast(value)))
               [value]
             else
-              tokens = {value: value, in: question.in}
+              tokens = { value: value, in: question.in }
               [value, question.message_for(:range?, tokens)]
             end
           end
@@ -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, question.message_for(:valid?, tokens)]
             end
           end
@@ -89,7 +89,7 @@ module TTY
             if question.convert? && !Utils.blank?(value)
               result = question.convert_result(value)
               if result == Const::Undefined
-                tokens = {value: value, type: question.convert}
+                tokens = { value: value, type: question.convert }
                 [value, question.message_for(:convert?, tokens)]
               else
                 [result]

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

@@ -49,6 +49,7 @@ module TTY
         # @api public
         def self.letter_case(mod, value)
           return value unless value.is_a?(String)
+
           case mod
           when :up, :upcase, :uppercase
             value.upcase
@@ -75,15 +76,16 @@ module TTY
         # @api public
         def self.whitespace(mod, value)
           return value unless value.is_a?(String)
+
           case mod
           when :trim, :strip
             value.strip
           when :chomp
             value.chomp
           when :collapse
-            value.gsub(/\s+/, ' ')
+            value.gsub(/\s+/, " ")
           when :remove
-            value.gsub(/\s+/, '')
+            value.gsub(/\s+/, "")
           else
             value
           end

data/lib/tty/prompt/selected_choices.rb

@@ -34,6 +34,7 @@ module TTY
       # @api public
       def each(&block)
         return to_enum unless block_given?
+
         @selected.each(&block)
       end
 

data/lib/tty/prompt/slider.rb

@@ -9,7 +9,7 @@ module TTY
     class Slider
       HELP = "(Use %s arrow keys, press Enter to select)"
 
-      FORMAT = ":slider %d"
+      FORMAT = ":slider %s"
 
       # Initailize a Slider
       #
@@ -26,9 +26,10 @@ module TTY
       def initialize(prompt, **options)
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
-        @min          = options.fetch(:min) { 0 }
-        @max          = options.fetch(:max) { 10 }
-        @step         = options.fetch(:step) { 1 }
+        @choices      = Choices.new
+        @min          = options.fetch(:min, 0)
+        @max          = options.fetch(:max, 10)
+        @step         = options.fetch(:step, 1)
         @default      = options[:default]
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
@@ -60,9 +61,14 @@ module TTY
       # @api private
       def initial
         if @default.nil?
-          range.size / 2
+          # no default - choose the middle option
+          choices.size / 2
+        elsif default_choice = choices.find_by(:name, @default)
+          # found a Choice by name - use it
+          choices.index(default_choice)
         else
-          range.index(@default)
+          # default is the index number
+          @default - 1
         end
       end
 
@@ -94,15 +100,6 @@ module TTY
         @show_help = value
       end
 
-      # Range of numbers to render
-      #
-      # @return [Array[Integer]]
-      #
-      # @api private
-      def range
-        (@min..@max).step(@step).to_a
-      end
-
       # @api public
       def default(value)
         @default = value
@@ -123,6 +120,32 @@ module TTY
         @step = value
       end
 
+      # Add a single choice
+      #
+      # @api public
+      def choice(*value, &block)
+        if block
+          @choices << (value << block)
+        else
+          @choices << value
+        end
+      end
+
+      # Add multiple choices
+      #
+      # @param [Array[Object]] values
+      #   the values to add as choices
+      #
+      # @api public
+      def choices(values = (not_set = true))
+        if not_set
+          @choices
+        else
+          values.each { |val| @choices << val }
+        end
+      end
+
+      # @api public
       def format(value)
         @format = value
       end
@@ -140,9 +163,14 @@ module TTY
       #   the question to ask
       #
       # @apu public
-      def call(question, &block)
+      def call(question, possibilities = nil, &block)
         @question = question
+        choices(possibilities) if possibilities
         block.call(self) if block
+        # set up a Choices collection for min, max, step
+        # if no possibilities were supplied
+        choices((@min..@max).step(@step).to_a) if @choices.empty?
+
         @active = initial
         @prompt.subscribe(self) do
           render
@@ -155,7 +183,7 @@ module TTY
       alias keydown keyleft
 
       def keyright(*)
-        @active += 1 if (@active + 1) < range.size
+        @active += 1 if (@active + 1) < choices.size
       end
       alias keyup keyright
 
@@ -208,11 +236,11 @@ module TTY
         @prompt.print(@prompt.clear_lines(lines))
       end
 
-      # @return [Integer]
+      # @return [Integer, String]
       #
       # @api private
       def answer
-        range[@active]
+        choices[@active].value
       end
 
       # Render question with the slider
@@ -223,7 +251,7 @@ module TTY
       def render_question
         header = ["#{@prefix}#{@question} "]
         if @done
-          header << @prompt.decorate(answer.to_s, @active_color)
+          header << @prompt.decorate(choices[@active].to_s, @active_color)
           header << "\n"
         else
           header << render_slider
@@ -244,8 +272,8 @@ module TTY
       def render_slider
         slider = (@symbols[:line] * @active) +
                  @prompt.decorate(@symbols[:bullet], @active_color) +
-                 (@symbols[:line] * (range.size - @active - 1))
-        value = range[@active]
+                 (@symbols[:line] * (choices.size - @active - 1))
+        value = choices[@active].name
         case @format
         when Proc
           @format.call(slider, value)

data/lib/tty/prompt/suggestion.rb

@@ -88,6 +88,7 @@ module TTY
       # @api private
       def evaluate
         return @suggestions if @suggestions.empty?
+
         if @suggestions.one?
           build_single_suggestion
         else

data/lib/tty/prompt/test.rb

@@ -19,7 +19,7 @@ module TTY
 
     class Test < TTY::Prompt
       def initialize(**options)
-        @input  = StringIO.new
+        @input = StringIO.new
         @input.extend(StringIOExtensions)
         @output = StringIO.new
 
@@ -27,7 +27,7 @@ module TTY
           input: @input,
           output: @output,
           env: { "TTY_TEST" => true },
-          enable_color: options.fetch(:enable_color) { true }
+          enable_color: options.fetch(:enable_color, true)
         })
         super(**options)
       end

data/lib/tty/prompt/version.rb

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

metadata

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