tty-prompt 0.15.0 → 0.16.0

data/lib/tty/prompt/choices.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'forwardable'
 

data/lib/tty/prompt/confirm_question.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'question'
 require_relative 'utils'
@@ -112,10 +113,8 @@ module TTY
 
       # @api private
       def create_suffix
-        result = ''
-        result << "#{default ? positive.capitalize : positive.downcase}"
-        result << '/'
-        result << "#{default ? negative.downcase : negative.capitalize}"
+        (default ? positive.capitalize : positive.downcase) + '/' +
+          (default ? negative.downcase : negative.capitalize)
       end
 
       # Create custom conversion

data/lib/tty/prompt/converter_dsl.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'converter_registry'
 

data/lib/tty/prompt/converter_registry.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Prompt

data/lib/tty/prompt/converters.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'pathname'
 require 'necromancer'

data/lib/tty/prompt/distance.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Prompt

data/lib/tty/prompt/enum_list.rb

@@ -1,8 +1,12 @@
 # encoding: utf-8
+# frozen_string_literal: true
+
+require 'English'
 
 require_relative 'choices'
 require_relative 'enum_paginator'
 require_relative 'paginator'
+require_relative 'symbols'
 
 module TTY
   class Prompt
@@ -11,7 +15,9 @@ module TTY
     #
     # @api private
     class EnumList
-      PAGE_HELP = '(Press tab/right or left to reveal more choices)'.freeze
+      include Symbols
+
+      PAGE_HELP = '(Press tab/right or left to reveal more choices)'
 
       # Create instance of EnumList menu.
       #
@@ -97,8 +103,12 @@ module TTY
       #   the values to add as choices
       #
       # @api public
-      def choices(values)
-        values.each { |val| choice(*val) }
+      def choices(values = (not_set = true))
+        if not_set
+          @choices
+        else
+          values.each { |val| @choices << val }
+        end
       end
 
       # Call the list menu by passing question and choices
@@ -128,7 +138,11 @@ module TTY
 
       def keyreturn(*)
         @failure = false
-        if (@input.to_i > 0 && @input.to_i <= @choices.size) || @input.empty?
+        num = @input.to_i
+        choice_disabled = choices[num - 1] && choices[num - 1].disabled?
+        choice_in_range = num > 0 && num <= @choices.size
+
+        if choice_in_range && !choice_disabled || @input.empty?
           @done = true
         else
           @input = ''
@@ -162,7 +176,11 @@ module TTY
       #
       # @api private
       def mark_choice_as_active
-        if (@input.to_i > 0) && !@choices[@input.to_i - 1].nil?
+        next_active = @choices[@input.to_i - 1]
+
+        if next_active && next_active.disabled?
+          # noop
+        elsif (@input.to_i > 0) && next_active
           @active = @input.to_i
         else
           @active = @default
@@ -174,9 +192,15 @@ module TTY
       #
       # @api private
       def validate_defaults
-        return if @default >= 1 && @default <= @choices.size
-        raise ConfigurationError,
-              "default index `#{@default}` out of range (1 - #{@choices.size})"
+        msg = if @default.nil? || @default.to_s.empty?
+                "default index must be an integer in range (1 - #{choices.size})"
+              elsif @default < 1 || @default > @choices.size
+                "default index #{@default} out of range (1 - #{@choices.size})"
+              elsif choices[@default - 1] && choices[@default - 1].disabled?
+                "default index #{@default} matches disabled choice item"
+              end
+
+        raise(ConfigurationError, msg) if msg
       end
 
       # Setup default option and active selection
@@ -205,12 +229,24 @@ module TTY
             @prompt.print(render_page_help)
           end
           @prompt.read_keypress
-          @prompt.print(refresh(question.lines.count))
+          question_lines = question.split($INPUT_RECORD_SEPARATOR, -1)
+          @prompt.print(refresh(question_lines_count(question_lines)))
         end
         @prompt.print(render_question)
         answer
       end
 
+      # Count how many screen lines the question spans
+      #
+      # @return [Integer]
+      #
+      # @api private
+      def question_lines_count(question_lines)
+        question_lines.reduce(0) do |acc, line|
+          acc + @prompt.count_screen_lines(line)
+        end
+      end
+
       # Find value for the choice selected
       #
       # @return [nil, Object]
@@ -239,12 +275,12 @@ module TTY
       #
       # @api private
       def render_question
-        header = "#{@prefix}#{@question} #{render_header}\n"
+        header = ["#{@prefix}#{@question} #{render_header}\n"]
         unless @done
           header << render_menu
           header << render_footer
         end
-        header
+        header.join
       end
 
       # Error message when incorrect index chosen
@@ -320,18 +356,23 @@ module TTY
       #
       # @api private
       def render_menu
-        output = ''
+        output = []
+
         @paginator.paginate(@choices, @page_active, @per_page) do |choice, index|
           num = (index + 1).to_s + @enum + ' '
-          selected = ' ' * 2 + num + choice.name
-          output << if index + 1 == @active
-                      @prompt.decorate(selected.to_s, @active_color)
+          selected = num + choice.name
+          output << if index + 1 == @active && !choice.disabled?
+                      (' ' * 2) + @prompt.decorate(selected, @active_color)
+                    elsif choice.disabled?
+                      @prompt.decorate(symbols[:cross], :red) + ' ' +
+                      selected + ' ' + choice.disabled.to_s
                     else
-                      selected
+                      (' ' * 2) + selected
                     end
           output << "\n"
         end
-        output
+
+        output.join
       end
     end # EnumList
   end # Prompt

data/lib/tty/prompt/enum_paginator.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'paginator'
 

data/lib/tty/prompt/evaluator.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'result'
 

data/lib/tty/prompt/expander.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'choices'
 
@@ -13,7 +14,7 @@ module TTY
         key: 'h',
         name: 'print help',
         value: :help
-      }
+      }.freeze
 
       # Create instance of Expander
       #
@@ -68,7 +69,7 @@ module TTY
           @input = ''
         end
       end
-      alias_method :keyreturn, :keyenter
+      alias keyreturn keyenter
 
       # Respond to key press event
       #
@@ -178,16 +179,16 @@ module TTY
       #
       # @api private
       def render_header
-        header = "#{@prefix}#{@message} "
+        header = ["#{@prefix}#{@message} "]
         if @done
-          selected_item = "#{@selected.name}"
+          selected_item = @selected.name.to_s
           header << @prompt.decorate(selected_item, @active_color)
         elsif collapsed?
           header << %[(enter "h" for help) ]
           header << "[#{possible_keys}] "
           header << @input
         end
-        header
+        header.join
       end
 
       # Show hint for selected option key
@@ -196,11 +197,10 @@ module TTY
       #
       # @api private
       def render_hint
-        hint = "\n"
-        hint << @prompt.decorate('>> ', @active_color)
-        hint << @hint
-        hint << @prompt.cursor.prev_line
-        hint << @prompt.cursor.forward(@prompt.strip(render_header).size)
+        "\n" + @prompt.decorate('>> ', @active_color) +
+          @hint +
+          @prompt.cursor.prev_line +
+          @prompt.cursor.forward(@prompt.strip(render_header).size)
       end
 
       # Render question with menu
@@ -251,7 +251,7 @@ module TTY
       #
       # @api private
       def render_menu
-        output = "\n"
+        output = ["\n"]
         @choices.each do |choice|
           chosen = %(#{choice.key} - #{choice.name})
           if @selected && @selected.key == choice.key
@@ -259,7 +259,7 @@ module TTY
           end
           output << '  ' + chosen + "\n"
         end
-        output
+        output.join
       end
 
       def setup_defaults
@@ -271,7 +271,7 @@ module TTY
         keys = []
         @choices.each do |choice|
           if choice.key.nil?
-            errors <<  "Choice #{choice.name} is missing a :key attribute"
+            errors << "Choice #{choice.name} is missing a :key attribute"
             next
           end
           if choice.key.length != 1
@@ -285,7 +285,7 @@ module TTY
           end
           keys << choice.key if choice.key
         end
-        errors.each { |err| fail ConfigurationError, err }
+        errors.each { |err| raise ConfigurationError, err }
       end
     end # Expander
   end # Prompt

data/lib/tty/prompt/keypress.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'question'
 require_relative 'symbols'
@@ -95,7 +96,6 @@ module TTY
         else
           job.()
         end
-      rescue Timeout::Error
       end
     end # Keypress
   end # Prompt

data/lib/tty/prompt/list.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
-require "English"
+require 'English'
 
 require_relative 'choices'
 require_relative 'paginator'
@@ -15,9 +16,9 @@ module TTY
     class List
       include Symbols
 
-      HELP = '(Use arrow%s keys, press Enter to select%s)'
+      HELP = '(Use arrow%s keys, press Enter to select%s)'.freeze
 
-      PAGE_HELP = '(Move up or down to reveal more choices)'
+      PAGE_HELP = '(Move up or down to reveal more choices)'.freeze
 
       # Allowed keys for filter, along with backspace and canc.
       FILTER_KEYS_MATCHER = /\A\w\Z/
@@ -49,7 +50,7 @@ module TTY
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
         @marker       = options.fetch(:marker) { symbols[:pointer] }
         @cycle        = options.fetch(:cycle) { false }
-        @filter       = options.fetch(:filter) { false } ? "" : nil
+        @filter       = options.fetch(:filter) { false } ? '' : nil
         @help         = options[:help]
         @first_render = true
         @done         = false
@@ -121,11 +122,11 @@ module TTY
       def default_help
         # Note that enumeration and filter are mutually exclusive
         tokens = if enumerate?
-                   [" or number (1-#{choices.size})", ""]
+                   [" or number (1-#{choices.size})", '']
                  elsif @filter
-                   ["", ", and letter keys to filter"]
+                   ['', ", and letter keys to filter"]
                  else
-                   ["", ""]
+                   ['', '']
                  end
 
         format(self.class::HELP, *tokens)
@@ -162,11 +163,12 @@ module TTY
             @choices
           else
             @choices.select do |_choice|
-              _choice.name.downcase.include?(@filter.downcase)
+              !_choice.disabled? &&
+                _choice.name.downcase.include?(@filter.downcase)
             end
           end
         else
-          Array(values).each { |val| choice(*val) }
+          values.each { |val| @choices << val }
         end
       end
 
@@ -195,6 +197,7 @@ module TTY
         return unless enumerate?
         value = event.value.to_i
         return unless (1..choices.count).cover?(value)
+        return if choices[value - 1].disabled?
         @active = value
       end
 
@@ -204,19 +207,35 @@ module TTY
       alias keyreturn keyenter
       alias keyspace keyenter
 
+      def search_choice_in(searchable)
+        searchable.find { |i| !choices[i - 1].disabled? }
+      end
+
       def keyup(*)
-        if @active == 1
-          @active = choices.length if @cycle
-        else
-          @active -= 1
+        searchable  = (@active - 1).downto(1).to_a
+        prev_active = search_choice_in(searchable)
+
+        if prev_active
+          @active = prev_active
+        elsif @cycle
+          searchable  = (choices.length).downto(1).to_a
+          prev_active = search_choice_in(searchable)
+
+          @active = prev_active if prev_active
         end
       end
 
       def keydown(*)
-        if @active == choices.length
-          @active = 1 if @cycle
-        else
-          @active += 1
+        searchable  = ((@active + 1)..choices.length)
+        next_active = search_choice_in(searchable)
+
+        if next_active
+          @active = next_active
+        elsif @cycle
+          searchable = (1..choices.length)
+          next_active = search_choice_in(searchable)
+
+          @active = next_active if next_active
         end
       end
       alias keytab keydown
@@ -233,7 +252,7 @@ module TTY
       def keydelete(*)
         return unless @filter
 
-        @filter = ""
+        @filter = ''
         @active = 1
       end
 
@@ -263,17 +282,22 @@ module TTY
 
       # Validate default indexes to be within range
       #
+      # @raise [ConfigurationError]
+      #   raised when the default index is either non-integer,
+      #   out of range or clashes with disabled choice item.
+      #
       # @api private
       def validate_defaults
         @default.each do |d|
-          if d.nil? || d.to_s.empty?
-            raise ConfigurationError,
-                 "default index must be an integer in range (1 - #{choices.size})"
-          end
-          if d < 1 || d > choices.size
-            raise ConfigurationError,
-                 "default index `#{d}` out of range (1 - #{choices.size})"
-          end
+          msg = if d.nil? || d.to_s.empty?
+                  "default index must be an integer in range (1 - #{choices.size})"
+                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"
+                end
+
+          raise(ConfigurationError, msg) if msg
         end
       end
 
@@ -296,7 +320,7 @@ module TTY
           # matching lines), it won't be included by using String#lines.
           question_lines = question.split($INPUT_RECORD_SEPARATOR, -1)
 
-          @prompt.print(refresh(question_lines.count))
+          @prompt.print(refresh(question_lines_count(question_lines)))
         end
         @prompt.print(render_question)
         answer
@@ -304,6 +328,17 @@ module TTY
         @prompt.print(@prompt.show)
       end
 
+      # Count how many screen lines the question spans
+      #
+      # @return [Integer]
+      #
+      # @api private
+      def question_lines_count(question_lines)
+        question_lines.reduce(0) do |acc, line|
+          acc + @prompt.count_screen_lines(line)
+        end
+      end
+
       # Find value for the choice selected
       #
       # @return [nil, Object]
@@ -328,12 +363,13 @@ module TTY
       #
       # @api private
       def render_question
-        header = "#{@prefix}#{@question} #{render_header}\n"
+        header = ["#{@prefix}#{@question} #{render_header}\n"]
         @first_render = false
-        rendered_menu = render_menu
-        rendered_menu << render_footer
-        header << rendered_menu unless @done
-        header
+        unless @done
+          header << render_menu
+          header << render_footer
+        end
+        header.join
       end
 
       # Header part showing the current filter
@@ -352,11 +388,11 @@ module TTY
       # @api private
       def render_header
         if @done
-          selected_item = "#{choices[@active - 1].name}"
+          selected_item = choices[@active - 1].name
           @prompt.decorate(selected_item, @active_color)
         elsif @first_render
           @prompt.decorate(help, @help_color)
-        elsif @filter.to_s != ""
+        elsif @filter.to_s != ''
           @prompt.decorate(filter_help, @help_color)
         end
       end
@@ -367,13 +403,16 @@ module TTY
       #
       # @api private
       def render_menu
-        output = ''
+        output = []
 
         @paginator.paginate(choices, @active, @per_page) do |choice, index|
           num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
-          message = if index + 1 == @active
+          message = if index + 1 == @active && !choice.disabled?
                       selected = @marker + ' ' + num + choice.name
-                      @prompt.decorate("#{selected}", @active_color)
+                      @prompt.decorate(selected.to_s, @active_color)
+                    elsif choice.disabled?
+                      @prompt.decorate(symbols[:cross], :red) +
+                        ' ' + num + choice.name + ' ' + choice.disabled.to_s
                     else
                       ' ' * 2 + num + choice.name
                     end
@@ -382,7 +421,7 @@ module TTY
           output << (message + newline)
         end
 
-        output
+        output.join
       end
 
       # Render page info footer
@@ -393,7 +432,7 @@ module TTY
       def render_footer
         return '' unless paginated?
         colored_footer = @prompt.decorate(@page_help, @help_color)
-        "\n" << colored_footer
+        "\n" + colored_footer
       end
     end # List
   end # Prompt