tty-prompt 0.18.1 → 0.19.0

data/lib/tty/prompt/multi_list.rb

@@ -9,7 +9,7 @@ module TTY
     #
     # @api private
     class MultiList < List
-      HELP = '(Use arrow%s keys, press Space to select and Enter to finish%s)'
+      HELP = '(Use %s arrow%s keys, press Space to select and Enter to finish%s)'
 
       # Create instance of TTY::Prompt::MultiList menu.
       #
@@ -17,11 +17,19 @@ module TTY
       # @param [Hash] options
       #
       # @api public
-      def initialize(prompt, options)
+      def initialize(prompt, **options)
         super
         @selected = []
         @help = options[:help]
         @echo = options.fetch(:echo, true)
+        @max  = options[:max]
+      end
+
+      # Set a maximum number of choices
+      #
+      # @api public
+      def max(value)
+        @max = value
       end
 
       # Callback fired when space key is pressed
@@ -32,6 +40,7 @@ module TTY
         if @selected.include?(active_choice)
           @selected.delete(active_choice)
         else
+          return if @max && @selected.size >= @max
           @selected << active_choice
         end
       end
@@ -62,20 +71,34 @@ module TTY
         @selected.map(&:name).join(', ')
       end
 
+      # Header part showing the maximum number of choices
+      #
+      # @return [String]
+      #
+      # @api private
+      def max_help
+        "(max. #{@max}) "
+      end
+
       # Render initial help text and then currently selected choices
       #
       # @api private
       def render_header
         instructions = @prompt.decorate(help, :bright_black)
+        max_suffix = @max ? max_help : ""
+
         if @done && @echo
           @prompt.decorate(selected_names, @active_color)
         elsif @selected.size.nonzero? && @echo
           help_suffix = filterable? && @filter.any? ? " #{filter_help}" : ""
-          selected_names + (@first_render ? " #{instructions}" : help_suffix)
+          max_suffix + selected_names +
+            (@first_render ? " #{instructions}" : help_suffix)
         elsif @first_render
-          instructions
+          max_suffix + instructions
         elsif filterable? && @filter.any?
-          filter_help
+          max_suffix + filter_help
+        elsif @max
+          max_help
         end
       end
 
@@ -96,21 +119,22 @@ module TTY
       def render_menu
         output = []
 
-        @paginator.paginate(choices, @active, @per_page) do |choice, index|
+        sync_paginators if @paging_changed
+        paginator.paginate(choices, @active, @per_page) do |choice, index|
           num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
-          indicator = (index + 1 == @active) ?  @marker : ' '
+          indicator = (index + 1 == @active) ?  @symbols[:marker] : ' '
           indicator += ' '
           message = if @selected.include?(choice) && !choice.disabled?
-                      selected = @prompt.decorate(symbols[:radio_on], @active_color)
+                      selected = @prompt.decorate(@symbols[:radio_on], @active_color)
                       "#{selected} #{num}#{choice.name}"
                     elsif choice.disabled?
-                      @prompt.decorate(symbols[:cross], :red) +
+                      @prompt.decorate(@symbols[:cross], :red) +
                         " #{num}#{choice.name} #{choice.disabled}"
                     else
-                      "#{symbols[:radio_off]} #{num}#{choice.name}"
+                      "#{@symbols[:radio_off]} #{num}#{choice.name}"
                     end
-          max_index = paginated? ? @paginator.max_index : choices.size - 1
-          newline = (index == max_index) ? '' : "\n"
+          end_index = paginated? ? paginator.end_index : choices.size - 1
+          newline = (index == end_index) ? '' : "\n"
           output << indicator + message + newline
         end
 

data/lib/tty/prompt/paginator.rb

@@ -5,23 +5,33 @@ module TTY
     class Paginator
       DEFAULT_PAGE_SIZE = 6
 
+      # The 0-based index of the first item on this page
+      attr_accessor :start_index
+
+      # The 0-based index of the last item on this page
+      attr_reader :end_index
+
+      # The 0-based index of the active item on this page
+      attr_reader :current_index
+
+      # The 0-based index of the previously active item on this page
+      attr_reader :last_index
+
       # Create a Paginator
       #
       # @api private
-      def initialize(options = {})
+      def initialize(**options)
         @last_index  = Array(options[:default]).flatten.first || 0
         @per_page    = options[:per_page]
-        @lower_index = Array(options[:default]).flatten.first
+        @start_index = Array(options[:default]).flatten.first
       end
 
-      # Maximum index for current pagination
+      # Reset current page indexes
       #
-      # @return [Integer]
-      #
-      # @api public
-      def max_index
-        raise ArgumentError, 'no max index' unless @per_page
-        @lower_index + @per_page - 1
+      # @api private
+      def reset!
+        @start_index = nil
+        @end_index   = nil
       end
 
       # Check if page size is valid
@@ -43,21 +53,21 @@ module TTY
       #   number of choice items per page
       #
       # @return [Enumerable]
+      #   the list between start and end index
       #
       # @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
-
         check_page_size!
+        @start_index ||= (current_index / @per_page) * @per_page
+        @end_index ||= @start_index + @per_page - 1
 
         # Don't paginate short lists
         if list.size <= @per_page
-          @lower_index = 0
-          @upper_index = list.size - 1
+          @start_index = 0
+          @end_index = list.size - 1
           if block
             return list.each_with_index(&block)
           else
@@ -65,33 +75,35 @@ module TTY
           end
         end
 
+        step = (current_index - @last_index).abs
         if current_index > @last_index # going up
-          if current_index > @upper_index && current_index < list.size - 1
-            @lower_index += 1
+          if current_index >= @end_index && current_index < list.size - 1
+            last_page = list.size - @per_page
+            @start_index = [@start_index + step, last_page].min
           end
         elsif current_index < @last_index # going down
-          if current_index < @lower_index && current_index > 0
-            @lower_index -= 1
+          if current_index <= @start_index && current_index > 0
+            @start_index = [@start_index - step, 0].max
           end
         end
 
         # Cycle list
         if current_index.zero?
-          @lower_index = 0
+          @start_index = 0
         elsif current_index == list.size - 1
-          @lower_index = list.size - 1 - (@per_page - 1)
+          @start_index = list.size - 1 - (@per_page - 1)
         end
 
-        @upper_index = @lower_index + (@per_page - 1)
+        @end_index = @start_index + (@per_page - 1)
         @last_index = current_index
 
-        sliced_list = list[@lower_index..@upper_index]
-        indices = (@lower_index..@upper_index)
+        sliced_list = list[@start_index..@end_index]
+        page_range = (@start_index..@end_index)
 
-        return sliced_list.zip(indices).to_enum unless block_given?
+        return sliced_list.zip(page_range).to_enum unless block_given?
 
         sliced_list.each_with_index do |item, index|
-          block[item, @lower_index + index]
+          block[item, @start_index + index]
         end
       end
     end # Paginator

data/lib/tty/prompt/question.rb

@@ -34,7 +34,7 @@ module TTY
       # Initialize a Question
       #
       # @api public
-      def initialize(prompt, options = {})
+      def initialize(prompt, **options)
         @prompt     = prompt
         @prefix     = options.fetch(:prefix) { @prompt.prefix }
         @default    = options.fetch(:default) { UndefinedSetting }
@@ -47,8 +47,10 @@ 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) { :red }
+        @value      = options.fetch(:value) { UndefinedSetting }
         @messages   = Utils.deep_copy(options.fetch(:messages) { { } })
         @done       = false
+        @first_render = true
         @input      = nil
 
         @evaluator = Evaluator.new(self)
@@ -94,8 +96,7 @@ module TTY
       # @return [self]
       #
       # @api public
-      def call(message, &block)
-        return if Utils.blank?(message)
+      def call(message = '', &block)
         @message = message
         block.call(self) if block
         @prompt.subscribe(self) do
@@ -131,7 +132,10 @@ module TTY
       #
       # @api private
       def render_question
-        header = ["#{@prefix}#{message} "]
+        header = []
+        if !Utils.blank?(@prefix) || !Utils.blank?(message)
+          header << "#{@prefix}#{message} "
+        end
         if !echo?
           header
         elsif @done
@@ -158,7 +162,12 @@ module TTY
       #
       # @api private
       def read_input(question)
-        @prompt.read_line(question, echo: echo).chomp
+        options = {echo: echo}
+        if value? && @first_render
+          options[:value] = @value
+          @first_render = false
+        end
+        @prompt.read_line(question, options).chomp
       end
 
       # Handle error condition
@@ -266,6 +275,21 @@ module TTY
         @validation = (value || block)
       end
 
+      # Prepopulate input with custom content
+      #
+      # @api public
+      def value(val)
+        return @value if val.nil?
+        @value = val
+      end
+
+      # Check if custom value is present
+      #
+      # @api private
+      def value?
+        @value != UndefinedSetting
+      end
+
       def validation?
         @validation != UndefinedSetting
       end

data/lib/tty/prompt/slider.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'symbols'
-
 module TTY
   # A class responsible for shell prompt interactions.
   class Prompt
@@ -9,8 +7,6 @@ module TTY
     #
     # @api public
     class Slider
-      include Symbols
-
       HELP = '(Use arrow keys, press Enter to select)'.freeze
 
       FORMAT = ':slider %d'.freeze
@@ -27,7 +23,7 @@ module TTY
       # @option options [String] :format The display format
       #
       # @api public
-      def initialize(prompt, options = {})
+      def initialize(prompt, **options)
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
         @min          = options.fetch(:min) { 0 }
@@ -37,10 +33,22 @@ module TTY
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
         @format       = options.fetch(:format) { FORMAT }
+        @symbols      = @prompt.symbols.merge(options.fetch(:symbols, {}))
         @first_render = true
         @done         = false
       end
 
+      # Change symbols used by this prompt
+      #
+      # @param [Hash] new_symbols
+      #   the new symbols to use
+      #
+      # @api public
+      def symbols(new_symbols = (not_set = true))
+        return @symbols if not_set
+        @symbols.merge!(new_symbols)
+      end
+
       # Setup initial active position
       #
       # @return [Integer]
@@ -180,9 +188,9 @@ module TTY
       #
       # @api private
       def render_slider
-        slider = (symbols[:line] * @active) +
-                 @prompt.decorate(symbols[:handle], @active_color) +
-                 (symbols[:line] * (range.size - @active - 1))
+        slider = (@symbols[:line] * @active) +
+                 @prompt.decorate(@symbols[:bullet], @active_color) +
+                 (@symbols[:line] * (range.size - @active - 1))
         value = " #{range[@active]}"
         @format.gsub(':slider', slider) % [value]
       end

data/lib/tty/prompt/symbols.rb

@@ -13,17 +13,29 @@ module TTY
         square: '◼',
         square_empty: '◻',
         dot: '•',
-        pointer: '‣',
+        bullet: '●',
+        bullet_empty: '○',
+        marker: '‣',
         line: '─',
         pipe: '|',
-        handle: 'O',
         ellipsis: '…',
         radio_on: '⬢',
         radio_off: '⬡',
         checkbox_on: '☒',
         checkbox_off: '☐',
+        circle: '◯',
         circle_on: 'ⓧ',
-        circle_off: 'Ⓘ'
+        circle_off: 'Ⓘ',
+        arrow_up: '↑',
+        arrow_down: '↓',
+        arrow_up_down: '↕',
+        arrow_left: '←',
+        arrow_right: '→',
+        arrow_left_right: '↔',
+        heart: '♥',
+        diamond: '♦',
+        club: '♣',
+        spade: '♠'
       }.freeze
 
       WIN_KEYS = {
@@ -33,17 +45,29 @@ module TTY
         square: '[█]',
         square_empty: '[ ]',
         dot: '.',
-        pointer: '>',
+        bullet: 'O',
+        bullet_empty: '○',
+        marker: '>',
         line: '-',
         pipe: '|',
-        handle: 'O',
         ellipsis: '...',
         radio_on: '(*)',
         radio_off: '( )',
         checkbox_on: '[×]',
         checkbox_off: '[ ]',
+        circle: '( )',
         circle_on: '(x)',
-        circle_off: '( )'
+        circle_off: '( )',
+        arrow_up: '↑',
+        arrow_down: '↓',
+        arrow_up_down: '↕',
+        arrow_left: '←',
+        arrow_right: '→',
+        arrow_left_right: '↔',
+        heart: '♥',
+        diamond: '♦',
+        club: '♣',
+        spade: '♠'
       }.freeze
 
       def symbols

data/lib/tty/prompt/timer.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module TTY
+  class Prompt
+    class Timer
+      attr_reader :duration
+
+      attr_reader :total
+
+      attr_reader :interval
+
+      def initialize(duration, interval)
+        @duration = duration
+        @interval = interval
+        @total = 0.0
+        @current = nil
+        @events = []
+      end
+
+      def start
+        return if @current
+
+        @current = time_now
+      end
+
+      def stop
+        return unless @current
+
+        @current = nil
+      end
+
+      def runtime
+        time_now - @current
+      end
+
+      def on_tick(&block)
+        @events << block
+      end
+
+      def while_remaining
+        start
+        remaining = duration
+
+        if @duration
+          while remaining >= 0.0
+            if runtime >= total
+              tick = duration - @total
+              @events.each { |block| block.(tick) }
+              @total += @interval
+            end
+
+            yield(remaining)
+            remaining = duration - runtime
+          end
+        else
+          loop { yield }
+        end
+      ensure
+        stop
+      end
+
+      if defined?(Process::CLOCK_MONOTONIC)
+        # Object representing current time
+        def time_now
+          ::Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        end
+      else
+        # Object represeting current time
+        def time_now
+          ::Time.now
+        end
+      end
+    end # Timer
+  end # Prompt
+end # TTY