tty-prompt 0.8.0 → 0.9.0

data/lib/tty/prompt/enum_paginator.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    class EnumPaginator < Paginator
+      # Paginate list of choices based on current active choice.
+      # Move entire pages.
+      #
+      # @api public
+      def paginate(list, active, per_page = nil, &block)
+        default_size = (list.size <= DEFAULT_PAGE_SIZE ? list.size : DEFAULT_PAGE_SIZE)
+        @per_page = @per_page || per_page || default_size
+
+        # Don't paginate short lists
+        if list.size <= @per_page
+          @lower_index = 0
+          @upper_index = list.size - 1
+          if block
+            return list.each_with_index(&block)
+          else
+            return list.each_with_index.to_enum
+          end
+        end
+
+        unless active.nil? # User may input index out of range
+          @last_index = active
+        end
+        page  = (@last_index / @per_page.to_f).ceil
+        pages = (list.size / @per_page.to_f).ceil
+        if page == 0
+          @lower_index = 0
+          @upper_index = @lower_index + @per_page - 1
+        elsif page > 0 && page <= pages
+          @lower_index = (page - 1) * @per_page
+          @upper_index = @lower_index + @per_page - 1
+        else
+          @upper_index = list.size - 1
+          @lower_index = @upper_index - @per_page + 1
+        end
+
+        sliced_list = list[@lower_index..@upper_index]
+        indices = (@lower_index..@upper_index)
+
+        if block
+          sliced_list.each_with_index do |item, index|
+            block[item, @lower_index + index]
+          end
+        else
+          sliced_list.zip(indices).to_enum unless block_given?
+        end
+      end
+    end # EnumPaginator
+  end # Prompt
+end # TTY

data/lib/tty/prompt/list.rb

@@ -7,7 +7,9 @@ module TTY
     #
     # @api private
     class List
-      HELP = '(Use arrow%s keys, press Enter to select)'.freeze
+      HELP = '(Use arrow%s keys, press Enter to select)'
+
+      PAGE_HELP = '(Move up or down to reveal more choices)'
 
       # Create instance of TTY::Prompt::List menu.
       #
@@ -36,6 +38,9 @@ module TTY
         @help         = options[:help]
         @first_render = true
         @done         = false
+        @per_page     = options[:per_page]
+        @page_help    = options[:page_help] || PAGE_HELP
+        @paginator    = Paginator.new
 
         @prompt.subscribe(self)
       end
@@ -54,6 +59,29 @@ module TTY
         @default = default_values
       end
 
+      # Set number of items per page
+      #
+      # @api public
+      def per_page(value)
+        @per_page = value
+      end
+
+      # Check if list is paginated
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def paginated?
+        @choices.size >= (@per_page || Paginator::DEFAULT_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
@@ -125,6 +153,7 @@ module TTY
       def keydown(*)
         @active = (@active == @choices.length) ? 1 : @active + 1
       end
+      alias keytab keydown
 
       private
 
@@ -163,9 +192,9 @@ module TTY
       def render
         @prompt.print(@prompt.hide)
         until @done
-          render_question
+          lines = render_question
           @prompt.read_keypress
-          refresh
+          refresh(lines)
         end
         render_question
         answer = render_answer
@@ -183,22 +212,30 @@ module TTY
         @choices[@active - 1].value
       end
 
-      # Determine area of the screen to clear
+      # Clear screen lines
+      #
+      # @param [Integer] lines
+      #   the lines to clear
       #
       # @api private
-      def refresh
-        lines = @question.scan("\n").length + @choices.length + 1
+      def refresh(lines)
         @prompt.print(@prompt.clear_lines(lines))
       end
 
       # Render question with instructions and menu
       #
+      # @return [Integer] The number of lines for menu
+      #
       # @api private
       def render_question
         header = "#{@prefix}#{@question} #{render_header}"
         @prompt.puts(header)
         @first_render = false
-        @prompt.print(render_menu) unless @done
+        rendered_menu = render_menu
+        rendered_menu << render_footer
+        @prompt.print(rendered_menu) unless @done
+
+        header.lines.count + rendered_menu.lines.count
       end
 
       # Provide help information
@@ -228,7 +265,7 @@ module TTY
       # @api private
       def render_menu
         output = ''
-        @choices.each_with_index do |choice, index|
+        @paginator.paginate(@choices, @active, @per_page) do |choice, index|
           num = enumerate? ? (index + 1).to_s + @enum + Symbols::SPACE : ''
           message = if index + 1 == @active
                       selected = @marker + Symbols::SPACE + num + choice.name
@@ -236,11 +273,20 @@ module TTY
                     else
                       Symbols::SPACE * 2 + num + choice.name
                     end
-          newline = (index == @choices.length - 1) ? '' : "\n"
+          newline = (index == @paginator.max_index) ? '' : "\n"
           output << (message + newline)
         end
         output
       end
+
+      # Render page info footer
+      #
+      # @api private
+      def render_footer
+        return '' unless paginated?
+        colored_footer = @prompt.decorate(@page_help, @help_color)
+        "\n" << colored_footer
+      end
     end # List
   end # Prompt
 end # TTY

data/lib/tty/prompt/multi_list.rb

@@ -21,7 +21,7 @@ module TTY
         super
         @selected = []
         @help    = options[:help]
-        @default = options.fetch(:default) { [] }
+        @default = Array(options[:default])
       end
 
       # Callback fired when space key is pressed
@@ -84,7 +84,7 @@ module TTY
       # @api private
       def render_menu
         output = ''
-        @choices.each_with_index do |choice, index|
+        @paginator.paginate(@choices, @active, @per_page) do |choice, index|
           num = enumerate? ? (index + 1).to_s + @enum + Symbols::SPACE : ''
           indicator = (index + 1 == @active) ?  @marker : Symbols::SPACE
           indicator += Symbols::SPACE
@@ -94,7 +94,7 @@ module TTY
                     else
                       Symbols::RADIO_UNCHECKED + Symbols::SPACE + num + choice.name
                     end
-          newline = (index == @choices.length - 1) ? '' : "\n"
+          newline = (index == @paginator.max_index) ? '' : "\n"
           output << indicator + message + newline
         end
         output

data/lib/tty/prompt/paginator.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    class Paginator
+      DEFAULT_PAGE_SIZE = 6
+
+      # Create a Paginator
+      #
+      # @api private
+      def initialize(options = {})
+        @last_index  = Array(options[:default]).flatten.first || 0
+        @per_page    = options[:per_page]
+        @lower_index = Array(options[:default]).flatten.first
+      end
+
+      # Maximum index for current pagination
+      #
+      # @return [Integer]
+      #
+      # @api public
+      def max_index
+        raise ArgumentError, 'no max index' unless @per_page
+        @lower_index + @per_page - 1
+      end
+
+      # Paginate collection given an active index
+      #
+      # @param [Array[Choice]] list
+      #   a collection of choice items
+      # @param [Integer] active
+      #   current choice active index
+      # @param [Integer] per_page
+      #   number of choice items per page
+      #
+      # @return [Enumerable]
+      #
+      # @api public
+      def paginate(list, active, per_page = nil, &block)
+        current_index = active - 1
+        default_size = (list.size <= DEFAULT_PAGE_SIZE ? list.size : DEFAULT_PAGE_SIZE)
+        @per_page = @per_page || per_page || default_size
+        @lower_index ||= current_index
+        @upper_index ||= max_index
+
+        # Don't paginate short lists
+        if list.size <= @per_page
+          @lower_index = 0
+          @upper_index = list.size - 1
+          if block
+            return list.each_with_index(&block)
+          else
+            return list.each_with_index.to_enum
+          end
+        end
+
+        if current_index > @last_index # going up
+          if current_index > @upper_index && current_index < list.size - 1
+            @lower_index += 1
+          end
+        elsif current_index < @last_index # going down
+          if current_index < @lower_index && current_index > 0
+            @lower_index -= 1
+          end
+        end
+
+        # Cycle list
+        if current_index.zero?
+          @lower_index = 0
+        elsif current_index == list.size - 1
+          @lower_index = list.size - 1 - (@per_page - 1)
+        end
+
+        @upper_index = @lower_index + (@per_page - 1)
+        @last_index = current_index
+
+        sliced_list = list[@lower_index..@upper_index]
+        indices = (@lower_index..@upper_index)
+
+        return sliced_list.zip(indices).to_enum unless block_given?
+
+        sliced_list.each_with_index do |item, index|
+          block[item, @lower_index + index]
+        end
+      end
+    end # Paginator
+  end # Prompt
+end # TTY

data/lib/tty/prompt/reader.rb

@@ -93,22 +93,18 @@ module TTY
       #
       # @api public
       def read_char(bytes = 1)
-        chars = input.readpartial(bytes)
-        while CSI.start_with?(chars) ||
-              chars.start_with?(CSI) &&
+        chars = input.getc
+        return if chars.nil?
+        while CSI.start_with?(chars) || chars.start_with?(CSI) &&
               !(64..126).include?(chars.each_codepoint.to_a.last)
-          next_char = read_char(bytes + 1)
-          chars << next_char
+          chars << read_char(bytes + 1)
         end
         chars
-      rescue EOFError
-        # Finished processing
-        chars
       end
 
-      # Get a single line from STDIN
-      # Each key pressed is echoed back  to the shell.
-      # The input terminates when enter or return key is pressed.
+      # Get a single line from STDIN. Each key pressed is echoed
+      # back to the shell. The input terminates when enter or
+      # return key is pressed.
       #
       # @param [Boolean] echo
       #   if true echo back characters, output nothing otherwise
@@ -120,10 +116,14 @@ module TTY
         line = ''
         buffer do
           mode.echo(echo) do
-            while (char = input.getbyte) &&
-                !(char == CARRIAGE_RETURN || char == NEWLINE)
-              emit_key_event(convert_byte(char))
-              line = handle_char(line, char)
+            while (char = read_char) && (char_byte = char.unpack('c*')[0]) &&
+                !(char_byte == CARRIAGE_RETURN || char_byte == NEWLINE)
+              emit_key_event(char)
+              if char_byte == BACKSPACE || char_byte == DELETE
+                line = line.slice(-1, 1) unless line.empty?
+              else
+                line << char
+              end
             end
           end
         end
@@ -168,26 +168,6 @@ module TTY
 
       private
 
-      # Convert byte to unicode character
-      #
-      # @return [String]
-      #
-      # @api private
-      def convert_byte(byte)
-        Array(byte).pack('U*')
-      end
-
-      # Handle single character by appending to or removing from output
-      #
-      # @api private
-      def handle_char(line, char)
-        if char == BACKSPACE || char == DELETE
-          line.empty? ? line : line.slice(-1, 1)
-        else
-          line << char
-        end
-      end
-
       # Handle input interrupt based on provided value
       #
       # @api private

data/lib/tty/prompt/version.rb

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

data/spec/unit/enum_paginator_spec.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::EnumPaginator, '#paginate' do
+  it "paginates items matching per_page count" do
+    list = %w(a b c d e f)
+    paginator = described_class.new({per_page: 3})
+
+    expect(paginator.paginate(list, 1).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 2).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 3).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 4).to_a).to eq([['d',3], ['e',4], ['f',5]])
+    expect(paginator.paginate(list, 5).to_a).to eq([['d',3], ['e',4], ['f',5]])
+    expect(paginator.paginate(list, 6).to_a).to eq([['d',3], ['e',4], ['f',5]])
+    expect(paginator.paginate(list, 7).to_a).to eq([['d',3], ['e',4], ['f',5]])
+  end
+
+  it "paginates items not matching per_page count" do
+    list = %w(a b c d e f g)
+    paginator = described_class.new({per_page: 3})
+
+    expect(paginator.paginate(list, 1).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 2).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 3).to_a).to eq([['a',0], ['b',1], ['c',2]])
+    expect(paginator.paginate(list, 4).to_a).to eq([['d',3], ['e',4], ['f',5]])
+    expect(paginator.paginate(list, 5).to_a).to eq([['d',3], ['e',4], ['f',5]])
+    expect(paginator.paginate(list, 6).to_a).to eq([['d',3], ['e',4], ['f',5]])
+    expect(paginator.paginate(list, 7).to_a).to eq([['g',6]])
+    expect(paginator.paginate(list, 8).to_a).to eq([['g',6]])
+  end
+
+  it "finds maximum index for current selection" do
+    list = %w(a b c d e f g)
+    paginator = described_class.new({per_page: 3, default: 0})
+
+    paginator.paginate(list, 4)
+    expect(paginator.max_index).to eq(5)
+    paginator.paginate(list, 5)
+    expect(paginator.max_index).to eq(5)
+    paginator.paginate(list, 7)
+    expect(paginator.max_index).to eq(8)
+  end
+
+  it "starts with default selection" do
+    list = %w(a b c d e f g)
+    paginator = described_class.new({per_page: 3, default: 3})
+
+    expect(paginator.paginate(list, 4).to_a).to eq([['d',3], ['e',4], ['f',5]])
+  end
+end

data/spec/unit/enum_select_spec.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
 
 RSpec.describe TTY::Prompt do
-
-  subject(:prompt) { TTY::TestPrompt.new }
-
+  let(:page_help) {
+  }
   it "selects default option when return pressed immediately" do
+    prompt = TTY::TestPrompt.new
     choices = %w(/bin/nano /usr/bin/vim.basic /usr/bin/vim.tiny)
     prompt.input << "\n"
     prompt.input.rewind
@@ -16,13 +16,13 @@ RSpec.describe TTY::Prompt do
       "  2) /usr/bin/vim.basic\n",
       "  3) /usr/bin/vim.tiny\n",
       "  Choose 1-3 [1]: ",
-      "\e[1000D\e[K\e[1A" * 4,
-      "\e[1000D\e[K\e[J",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
       "Select an editor? \e[32m/bin/nano\e[0m\n"
     ].join)
   end
 
   it "selects option by index from the list" do
+    prompt = TTY::TestPrompt.new
     choices = %w(/bin/nano /usr/bin/vim.basic /usr/bin/vim.tiny)
     prompt.input << "3\n"
     prompt.input.rewind
@@ -34,18 +34,19 @@ RSpec.describe TTY::Prompt do
       "\e[32m  2) /usr/bin/vim.basic\e[0m\n",
       "  3) /usr/bin/vim.tiny\n",
       "  Choose 1-3 [2]: ",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[J",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
       "Select an editor? \n",
       "  1) /bin/nano\n",
       "  2) /usr/bin/vim.basic\n",
       "\e[32m  3) /usr/bin/vim.tiny\e[0m\n",
       "  Choose 1-3 [2]: 3",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[J",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
       "Select an editor? \e[32m/usr/bin/vim.tiny\e[0m\n"
     ].join)
   end
 
   it "selects option through DSL" do
+    prompt = TTY::TestPrompt.new
     prompt.input << "\n"
     prompt.input.rewind
     value = prompt.enum_select("Select an editor?") do |menu|
@@ -70,6 +71,7 @@ RSpec.describe TTY::Prompt do
   end
 
   it "selects option through DSL with key and value" do
+    prompt = TTY::TestPrompt.new
     prompt.input << "\n"
     prompt.input.rewind
     value = prompt.enum_select("Select an editor?") do |menu|
@@ -93,6 +95,7 @@ RSpec.describe TTY::Prompt do
   end
 
   it "changes colors for selection, hint and error" do
+    prompt = TTY::TestPrompt.new
     choices = %w(/bin/nano /usr/bin/vim.basic /usr/bin/vim.tiny)
     prompt.input << "\n"
     prompt.input.rewind
@@ -109,4 +112,155 @@ RSpec.describe TTY::Prompt do
       "Select an editor? \e[31m/bin/nano\e[0m\n"
     ].join)
   end
+
+  it "displays error with unrecognized input" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(/bin/nano /usr/bin/vim.basic /usr/bin/vim.tiny)
+    prompt.input << "11\n2\n"
+    prompt.input.rewind
+    value = prompt.enum_select("Select an editor?", choices)
+    expect(value).to eq('/usr/bin/vim.basic')
+    expect(prompt.output.string).to eq([
+      "Select an editor? \n",
+      "\e[32m  1) /bin/nano\e[0m\n",
+      "  2) /usr/bin/vim.basic\n",
+      "  3) /usr/bin/vim.tiny\n",
+      "  Choose 1-3 [1]: ",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "Select an editor? \n",
+      "\e[32m  1) /bin/nano\e[0m\n",
+      "  2) /usr/bin/vim.basic\n",
+      "  3) /usr/bin/vim.tiny\n",
+      "  Choose 1-3 [1]: 1",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "Select an editor? \n",
+      "\e[32m  1) /bin/nano\e[0m\n",
+      "  2) /usr/bin/vim.basic\n",
+      "  3) /usr/bin/vim.tiny\n",
+      "  Choose 1-3 [1]: 11",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "Select an editor? \n",
+      "\e[32m  1) /bin/nano\e[0m\n",
+      "  2) /usr/bin/vim.basic\n",
+      "  3) /usr/bin/vim.tiny\n",
+      "  Choose 1-3 [1]: \n",
+      "\e[31m>>\e[0m Please enter a valid number",
+      "\e[A\e[1G\e[18C",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "Select an editor? \n",
+      "  1) /bin/nano\n",
+      "\e[32m  2) /usr/bin/vim.basic\e[0m\n",
+      "  3) /usr/bin/vim.tiny\n",
+      "  Choose 1-3 [1]: 2\n",
+      "\e[31m>>\e[0m Please enter a valid number",
+      "\e[A\e[1G\e[19C",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "Select an editor? \e[32m/usr/bin/vim.basic\e[0m\n"
+    ].join)
+  end
+
+  it "paginates long selections" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(A B C D E F G H)
+    prompt.input << "\n"
+    prompt.input.rewind
+    value = prompt.enum_select("What letter?", choices, per_page: 3, default: 4)
+    expect(value).to eq('D')
+    expect(prompt.output.string).to eq([
+      "What letter? \n",
+      "\e[32m  4) D\e[0m\n",
+      "  5) E\n",
+      "  6) F\n",
+      "  Choose 1-8 [4]: ",
+      "\n\e[90m(Press tab/right or left to reveal more choices)\e[0m",
+      "\e[A\e[1G\e[18C",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "What letter? \e[32mD\e[0m\n"
+    ].join)
+  end
+
+  it "shows pages matching input" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(A B C D E F G H)
+    prompt.input << "11\n\b\n"
+    prompt.input.rewind
+    value = prompt.enum_select("What letter?", choices, per_page: 3)
+    expect(value).to eq('A')
+    expect(prompt.output.string).to eq([
+      "What letter? \n",
+      "\e[32m  1) A\e[0m\n",
+      "  2) B\n",
+      "  3) C\n",
+      "  Choose 1-8 [1]: ",
+      "\n\e[90m(Press tab/right or left to reveal more choices)\e[0m",
+      "\e[A\e[1G\e[18C",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "What letter? \n",
+      "\e[32m  1) A\e[0m\n",
+      "  2) B\n",
+      "  3) C\n",
+      "  Choose 1-8 [1]: 1",
+      "\n\e[90m(Press tab/right or left to reveal more choices)\e[0m",
+      "\e[A\e[1G\e[19C",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "What letter? \n",
+      "\e[32m  1) A\e[0m\n",
+      "  2) B\n",
+      "  3) C\n",
+      "  Choose 1-8 [1]: 11",
+      "\n\e[90m(Press tab/right or left to reveal more choices)\e[0m",
+      "\e[A\e[1G\e[20C",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "What letter? \n",
+      "\e[32m  1) A\e[0m\n",
+      "  2) B\n",
+      "  3) C\n",
+      "  Choose 1-8 [1]: \n",
+      "\e[31m>>\e[0m Please enter a valid number",
+      "\n\e[90m(Press tab/right or left to reveal more choices)\e[0m",
+      "\e[A\e[1G\e[A\e[1G\e[18C",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "What letter? \n",
+      "\e[32m  1) A\e[0m\n",
+      "  2) B\n",
+      "  3) C\n",
+      "  Choose 1-8 [1]: \n",
+      "\e[31m>>\e[0m Please enter a valid number",
+      "\n\e[90m(Press tab/right or left to reveal more choices)\e[0m",
+      "\e[A\e[1G\e[A\e[1G\e[18C",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "What letter? \e[32mA\e[0m\n"
+    ].join)
+  end
+
+  it "switches through pages with tab key" do
+    prompt = TTY::TestPrompt.new
+    choices = %w(A B C D E F G H)
+    prompt.input << "\t\n"
+    prompt.input.rewind
+    value = prompt.enum_select("What letter?") do |menu|
+              menu.default 4
+              menu.per_page 3
+              menu.choices choices
+            end
+    expect(value).to eq('D')
+    expect(prompt.output.string).to eq([
+      "What letter? \n",
+      "\e[32m  4) D\e[0m\n",
+      "  5) E\n",
+      "  6) F\n",
+      "  Choose 1-8 [4]: ",
+      "\n\e[90m(Press tab/right or left to reveal more choices)\e[0m",
+      "\e[A\e[1G\e[18C",
+      "\e[1000D\e[K\e[1A" * 4 + "\e[1000D\e[K\e[J",
+      "What letter? \n",
+      "  7) G\n",
+      "  8) H\n",
+      "  Choose 1-8 [4]: ",
+      "\n\e[90m(Press tab/right or left to reveal more choices)\e[0m",
+      "\e[A\e[1G\e[18C",
+      "\e[1000D\e[K\e[1A" * 3 + "\e[1000D\e[K\e[J",
+      "What letter? \e[32mD\e[0m\n"
+    ].join)
+  end
 end