tty-prompt 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9a360c4b3a7cd670868b20f7b220223274f555b
-  data.tar.gz: 17667527540e13b4e91eca3c042c9fcc5cb24b86
+  metadata.gz: 2ef2f5ff49f413f853a8cb33f8894189fb36f728
+  data.tar.gz: cbcd8a42cfefbfbaad8d2028fc5847ce55a20443
 SHA512:
-  metadata.gz: e7489d7dcde47bad702c66740391db047b17d94eedb9c110de0b77ffc59ba6c4cca83f95d2e5dc85417b6e1e5f409d0bd88c5a00367e260b29ea48f3efe7c798
-  data.tar.gz: ef5bec91d62387297bbc29b947bb39d014e3a2239d5679a9175e6944520d490caca7f327abf695c3b27f42055169c89cd7b924522dec1a55e61e94ed2e9e379b
+  metadata.gz: b6e8c1ef4460ce0e6ac1ce17d018bd737d98290163293b5d229b7d65cc38c8656784ffbd2b3e13c275f672f145ba22cbe31e74302de0dc0f757d7605f6d22971
+  data.tar.gz: 029244b6acd770bc6ba0836bf85f01f12d3ec80523bd43a5532826516a80ee44937292408f5e12a7657058db8466a0ec29aed9c5054adf9afd65d09e63816dd5

data/CHANGELOG.md

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

data/README.md

@@ -1,6 +1,7 @@
 # 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]
@@ -8,6 +9,7 @@
 [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
@@ -21,6 +23,8 @@
 * 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
 
 ## Installation
 
@@ -60,9 +64,10 @@ Or install it yourself as:
   * [2.4 multiline](#24-multiline)
   * [2.5 mask](#25-mask)
   * [2.6 yes?/no?](#26-yesno)
-  * [2.7 select](#27-select)
-    * [2.7.1 multi_select](#271-multi_select)
-    * [2.7.2 enum_select](#272-enum_select)
+  * [2.7 menu](#27-menu)
+    * [2.7.1 select](#271-select)
+    * [2.7.2 multi_select](#272-multi_select)
+    * [2.7.3 enum_select](#273-enum_select)
   * [2.8 expand](#28-expand)
   * [2.9 collect](#29-collect)
   * [2.10 suggest](#210-suggest)
@@ -488,7 +493,9 @@ prompt.no?('Do you hate Ruby?')
 
 Similarly to `yes?` method, you can supply the same options to customize the question.
 
-### 2.7 select
+### 2.7 menu
+
+### 2.7.1 select
 
 For asking questions involving list of options use `select` method by passing the question and possible choices:
 
@@ -584,7 +591,31 @@ prompt.select("Choose your destiny?", choices, help: "(Bash keyboard)", marker:
 #   Jax
 ```
 
-### 2.7.1 multi_select
+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 arrow keys, press Enter to select)
+# ‣ A
+#   B
+#   C
+#   D
+# (Move up or down to reveal more choices)
+```
+
+You can also customise page navigation text using `:page_help` option:
+```ruby
+letters = ('A'..'Z').to_a
+prompt.select("Choose your letter?") do |menu|
+  menu.per_page 4
+  menu.page_help '(Wiggle thy finger up or down to see more)'
+  menu.choices letters, per_page: 4)
+end
+```
+
+### 2.7.2 multi_select
 
 For asking questions involving multiple selection list use `multi_select` method by passing the question and possible choices:
 
@@ -685,7 +716,21 @@ prompt.multi_select("Select drinks?", choices, help: 'Press beer can against key
 #   ⬡ bourbon
 ```
 
-### 2.7.2 enum_select
+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 arrow keys, press Space to select and Enter to finish)
+# ‣ ⬡ A
+#   ⬡ B
+#   ⬡ C
+#   ⬡ D
+# (Move up or down to reveal more choices)
+```
+
+### 2.7.3 enum_select
 
 In order to ask for standard selection from indexed list you can use `enum_select` and pass question together with possible choices:
 
@@ -744,6 +789,21 @@ end
 # Select an editor? /usr/bin/vim
 ```
 
+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.8 expand
 
 The `expand` provides a compact way to ask a question with many options.

data/appveyor.yml

@@ -0,0 +1,23 @@
+---
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - ruby --version
+  - gem --version
+  - bundle install
+build: off
+test_script:
+  - bundle exec rake ci
+environment:
+  matrix:
+    - ruby_version: "193"
+    - ruby_version: "200"
+    - ruby_version: "200-x64"
+    - ruby_version: "21"
+    - ruby_version: "21-x64"
+    - ruby_version: "22"
+    - ruby_version: "22-x64"
+    - ruby_version: "23"
+    - ruby_version: "23-x64"
+matrix:
+  allow_failures:
+    - ruby_version: "193"

data/examples/enum_paged.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+alfabet = ('A'..'Z').to_a
+
+prompt.enum_select('Which letter?', alfabet, per_page: 4)

data/examples/select_paginated.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+alfabet = ('A'..'Z').to_a
+
+prompt.select('Which letter?', alfabet, per_page: 8)

data/lib/tty-prompt.rb

@@ -20,6 +20,8 @@ require 'tty/prompt/slider'
 require 'tty/prompt/statement'
 require 'tty/prompt/suggestion'
 require 'tty/prompt/answers_collector'
+require 'tty/prompt/paginator'
+require 'tty/prompt/enum_paginator'
 require 'tty/prompt/symbols'
 require 'tty/prompt/test'
 require 'tty/prompt/utils'

data/lib/tty/prompt/enum_list.rb

@@ -7,6 +7,8 @@ module TTY
     #
     # @api private
     class EnumList
+      PAGE_HELP = '(Press tab/right or left to reveal more choices)'.freeze
+
       # Create instance of EnumList menu.
       #
       # @api public
@@ -18,10 +20,16 @@ module TTY
         @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 }
+        @input        = nil
         @done         = false
+        @first_render = true
         @failure      = false
         @active       = @default
         @choices      = Choices.new
+        @per_page     = options[:per_page]
+        @page_help    = options[:page_help] || PAGE_HELP
+        @paginator    = EnumPaginator.new
+        @page_active  = @default
 
         @prompt.subscribe(self)
       end
@@ -33,6 +41,33 @@ module TTY
         @default = default
       end
 
+      # Set number of items per page
+      #
+      # @api public
+      def per_page(value)
+        @per_page = value
+      end
+
+      def page_size
+        (@per_page || Paginator::DEFAULT_PAGE_SIZE)
+      end
+
+      # Check if list is paginated
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def paginated?
+        @choices.size >= page_size
+      end
+
+      # @param [String] text
+      #   the help text to display per page
+      # @api pbulic
+      def page_help(text)
+        @page_help = text
+      end
+
       # Set selecting active index using number pad
       #
       # @api public
@@ -70,14 +105,15 @@ module TTY
       def call(question, possibilities, &block)
         choices(possibilities)
         @question = question
-        block.call(self) if block
+        block[self] if block
         setup_defaults
         render
       end
 
       def keypress(event)
         if [:backspace, :delete].include?(event.key.name)
-          @input.chop! unless @input.empty?
+          return if @input.empty?
+          @input.chop!
           mark_choice_as_active
         elsif event.value =~ /^\d+$/
           @input += event.value
@@ -94,24 +130,39 @@ module TTY
           @failure = true
         end
       end
-      alias_method :keyenter, :keyreturn
+      alias keyenter keyreturn
 
-      private
+      def keyright(*)
+        if (@page_active + page_size) <= @choices.size
+          @page_active += page_size
+        else
+          @page_active = 1
+        end
+      end
+      alias keytab keyright
 
-      def mark_choice_as_active
-        if !@choices[@input.to_i - 1].nil?
-          @active = @input.to_i
+      def keyleft(*)
+        if (@page_active - page_size) >= 0
+          @page_active -= page_size
         else
-          @active = nil
+          @page_active = @choices.size - 1
         end
       end
 
-      # Setup default option and active selection
+      private
+
+      # Find active choice or set to default
+      #
+      # @return [nil]
       #
       # @api private
-      def setup_defaults
-        validate_defaults
-        @active = @default
+      def mark_choice_as_active
+        if (@input.to_i > 1) && !@choices[@input.to_i - 1].nil?
+          @active = @input.to_i
+        else
+          @active = @default
+        end
+        @page_active = @active
       end
 
       # Validate default indexes to be within range
@@ -119,8 +170,16 @@ module TTY
       # @api private
       def validate_defaults
         return if @default >= 1 && @default <= @choices.size
-        fail PromptConfigurationError,
-             "default index `#{d}` out of range (1 - #{@choices.size})"
+        raise PromptConfigurationError,
+              "default index `#{d}` out of range (1 - #{@choices.size})"
+      end
+
+      # Setup default option and active selection
+      #
+      # @api private
+      def setup_defaults
+        validate_defaults
+        mark_choice_as_active
       end
 
       # Render a selection list.
@@ -134,9 +193,9 @@ module TTY
       def render
         @input = ''
         until @done
-          render_question
+          lines = render_question
           @prompt.read_keypress
-          refresh
+          refresh(lines)
         end
         render_question
         render_answer
@@ -153,9 +212,11 @@ module TTY
 
       # Determine area of the screen to clear
       #
+      # @param [Integer] lines
+      #   the lines to clear
+      #
       # @api private
-      def refresh
-        lines = @question.scan("\n").length + @choices.length + 2
+      def refresh(lines)
         @prompt.print(@prompt.clear_lines(lines))
         @prompt.print(@prompt.cursor.clear_screen_down)
       end
@@ -166,18 +227,34 @@ module TTY
       def render_question
         header = "#{@prefix}#{@question} #{render_header}"
         @prompt.puts(header)
-        return if @done
-        @prompt.print(render_menu)
-        @prompt.print(render_footer)
+        lines = header.lines.count
+        unless @done
+          menu = render_menu + render_footer
+          lines += menu.lines.count
+          @prompt.print(menu)
+        end
         render_error if @failure
+        render_page_help if paginated? && !@done
+        lines
       end
 
+      # Error message when incorrect index chosen
+      #
+      # @api private
+      def error_message
+        error = 'Please enter a valid number'
+        "\n" + @prompt.decorate('>>', @error_color) + ' ' + error
+      end
+
+      # Render error message and return cursor to position of input
+      #
       # @api private
       def render_error
-        error = 'Please enter a valid index'
-        @prompt.print("\n" + @prompt.decorate('>>', @error_color) + ' ' + error)
-        @prompt.print(@prompt.cursor.prev_line)
-        @prompt.print(@prompt.cursor.forward(render_footer.size))
+        @prompt.print(error_message)
+        if !paginated?
+          @prompt.print(@prompt.cursor.prev_line)
+          @prompt.print(@prompt.cursor.forward(render_footer.size))
+        end
       end
 
       # Render chosen option
@@ -188,7 +265,7 @@ module TTY
       def render_header
         return '' unless @done
         return '' unless @active
-        selected_item = "#{@choices[@active - 1].name}"
+        selected_item = @choices[@active - 1].name.to_s
         @prompt.decorate(selected_item, @active_color)
       end
 
@@ -201,6 +278,28 @@ module TTY
         "  Choose 1-#{@choices.size} [#{@default}]: #{@input}"
       end
 
+      # Pagination help message
+      #
+      # @return [String]
+      #
+      # @api private
+      def page_help_message
+        return '' unless paginated?
+        "\n" + @prompt.decorate(@page_help, @help_color)
+      end
+
+      # Render page help
+      #
+      # @api private
+      def render_page_help
+        @prompt.print(page_help_message)
+        if @failure
+          @prompt.print(@prompt.cursor.prev_line)
+        end
+        @prompt.print(@prompt.cursor.prev_line)
+        @prompt.print(@prompt.cursor.forward(render_footer.size))
+      end
+
       # Render menu with indexed choices to select from
       #
       # @return [String]
@@ -208,11 +307,11 @@ module TTY
       # @api private
       def render_menu
         output = ''
-        @choices.each_with_index do |choice, index|
+        @paginator.paginate(@choices, @page_active, @per_page) do |choice, index|
           num = (index + 1).to_s + @enum + Symbols::SPACE
           selected = Symbols::SPACE * 2 + num + choice.name
           output << if index + 1 == @active
-                      @prompt.decorate("#{selected}", @active_color)
+                      @prompt.decorate(selected.to_s, @active_color)
                     else
                       selected
                     end