tty-prompt 0.18.1 → 0.19.0

data/Rakefile

@@ -1,8 +1,8 @@
-# encoding: utf-8
-
 require "bundler/gem_tasks"
 
 FileList['tasks/**/*.rake'].each(&method(:import))
 
 desc 'Run all specs'
 task ci: %w[ spec ]
+
+task default: :spec

data/examples/ask_blank.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "../lib/tty-prompt"
+
+prompt = TTY::Prompt.new(prefix: ">")
+
+answer= prompt.ask
+
+puts "Answer: \"#{answer}\""

data/examples/enum_select_disabled.rb

@@ -5,8 +5,8 @@ require_relative "../lib/tty-prompt"
 prompt = TTY::Prompt.new
 
 choices = [
-  "Atom",
   {name: "Emacs", disabled: '(not installed)'},
+  "Atom",
   "GNU nano",
   {name: "Notepad++", disabled: '(not installed)'},
   "Sublime",

data/examples/enum_select_paged.rb

@@ -6,4 +6,4 @@ prompt = TTY::Prompt.new
 
 alfabet = ('A'..'Z').to_a
 
-prompt.enum_select('Which letter?', alfabet, per_page: 4)
+prompt.enum_select('Which letter?', alfabet, per_page: 4, cycle: true, default: 2)

data/examples/expand_auto.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../lib/tty-prompt"
+
+choices = [{
+  key: 'y',
+  name: 'overwrite this file',
+  value: :yes
+}, {
+  key: 'n',
+  name: 'do not overwrite this file',
+  value: :no
+}, {
+  key: 'a',
+  name: 'overwrite this file and all later files',
+  value: :all
+}, {
+  key: 'd',
+  name: 'show diff',
+  value: :diff
+}, {
+  key: 'q',
+  name: 'quit; do not overwrite this file ',
+  value: :quit
+}]
+
+prompt = TTY::Prompt.new
+
+prompt.expand('Overwrite Gemfile?', choices, auto_hint: true)

data/examples/mask.rb

@@ -4,7 +4,7 @@ require_relative "../lib/tty-prompt"
 require 'pastel'
 
 prompt = TTY::Prompt.new
-heart = prompt.decorate('❤ ', :magenta)
+heart = prompt.decorate(prompt.symbols[:heart] + ' ', :magenta)
 
 res = prompt.mask('What is your secret?', mask: heart) do |q|
   q.validate(/[a-z\ ]{5,15}/)

data/examples/multi_select.rb

@@ -5,4 +5,4 @@ require_relative "../lib/tty-prompt"
 prompt = TTY::Prompt.new
 
 drinks = %w(vodka beer wine whisky bourbon)
-prompt.multi_select('Choose your favourite drink?', drinks, help: '(Use arrow keys and Enter to finish)')
+prompt.multi_select('Choose your favourite drink?', drinks)

data/examples/multi_select_disabled_paged.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../lib/tty-prompt"
+
+prompt = TTY::Prompt.new
+
+numbers = [
+  {name: '1', disabled: 'out'},
+  '2',
+  {name: '3', disabled: 'out'},
+  '4',
+  '5',
+  {name: '6', disabled: 'out'},
+  '7',
+  '8',
+  '9',
+  {name: '10', disabled: 'out'}
+]
+
+answer = prompt.multi_select('Which letter?', numbers, per_page: 4, cycle: true)
+
+puts answer.inspect

data/examples/multi_select_paged.rb

@@ -6,4 +6,4 @@ prompt = TTY::Prompt.new
 
 alfabet = ('A'..'Z').to_a
 
-prompt.multi_select('Which letter?', alfabet, per_page: 5)
+prompt.multi_select('Which letter?', alfabet, per_page: 7, max: 3)

data/examples/select_disabled_paged.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../lib/tty-prompt"
+
+prompt = TTY::Prompt.new
+
+numbers = [
+  {name: '1', disabled: 'out'},
+  '2',
+  {name: '3', disabled: 'out'},
+  '4',
+  '5',
+  {name: '6', disabled: 'out'},
+  '7',
+  '8',
+  '9',
+  {name: '10', disabled: 'out'}
+]
+
+answer = prompt.select('Which letter?', numbers, per_page: 4, cycle: true)
+
+puts answer.inspect

data/examples/select_paginated.rb

@@ -6,6 +6,6 @@ prompt = TTY::Prompt.new
 
 alfabet = ('A'..'Z').to_a
 
-answer = prompt.select('Which letter?', alfabet, per_page: 8)
+answer = prompt.select('Which letter?', alfabet, per_page: 7, cycle: true, default: 5)
 
 puts answer.inspect

data/lib/tty/prompt.rb

@@ -4,6 +4,7 @@ require 'forwardable'
 require 'pastel'
 require 'tty-cursor'
 require 'tty-reader'
+require 'tty-screen'
 
 require_relative 'prompt/answers_collector'
 require_relative 'prompt/confirm_question'
@@ -18,6 +19,7 @@ require_relative 'prompt/question'
 require_relative 'prompt/slider'
 require_relative 'prompt/statement'
 require_relative 'prompt/suggestion'
+require_relative 'prompt/symbols'
 require_relative 'prompt/utils'
 require_relative 'prompt/version'
 
@@ -69,6 +71,16 @@ module TTY
     # @api private
     attr_reader :active_color, :help_color, :error_color, :enabled_color
 
+    # The collection of display symbols
+    #
+    # @example
+    #   prompt = TTY::Prompt.new(symbols: {marker: '>'})
+    #
+    # @return [Hash]
+    #
+    # @api private
+    attr_reader :symbols
+
     def_delegators :@pastel, :decorate, :strip
 
     def_delegators :@cursor, :clear_lines, :clear_line,
@@ -111,6 +123,8 @@ module TTY
     #   handling of Ctrl+C key out of :signal, :exit, :noop
     # @option options [Boolean] :track_history
     #   disable line history tracking, true by default
+    # @option options [Hash] :symbols
+    #   the symbols displayed in prompts such as :marker, :cross
     #
     # @api public
     def initialize(*args)
@@ -125,6 +139,7 @@ module TTY
       @error_color   = options.fetch(:error_color)  { :red }
       @interrupt     = options.fetch(:interrupt)    { :error }
       @track_history = options.fetch(:track_history) { true }
+      @symbols       = Symbols.symbols.merge(options.fetch(:symbols, {}))
 
       @cursor = TTY::Cursor
       @pastel = Pastel.new(@enabled_color.nil? ? {} : { enabled: @enabled_color })
@@ -146,8 +161,7 @@ module TTY
     # @return [String]
     #
     # @api public
-    def invoke_question(object, message, *args, &block)
-      options = Utils.extract_options!(args)
+    def invoke_question(object, message, **options, &block)
       options[:messages] = self.class.messages
       question = object.new(self, options)
       question.(message, &block)
@@ -170,8 +184,8 @@ module TTY
     # @return [TTY::Prompt::Question]
     #
     # @api public
-    def ask(message, *args, &block)
-      invoke_question(Question, message, *args, &block)
+    def ask(message = '', **options, &block)
+      invoke_question(Question, message, **options, &block)
     end
 
     # Ask a question with a keypress answer
@@ -179,8 +193,8 @@ module TTY
     # @see #ask
     #
     # @api public
-    def keypress(message, *args, &block)
-      invoke_question(Keypress, message, *args, &block)
+    def keypress(message = '', **options, &block)
+      invoke_question(Keypress, message, **options, &block)
     end
 
     # Ask a question with a multiline answer
@@ -191,8 +205,8 @@ module TTY
     # @return [Array[String]]
     #
     # @api public
-    def multiline(message, *args, &block)
-      invoke_question(Multiline, message, *args, &block)
+    def multiline(message = '', **options, &block)
+      invoke_question(Multiline, message, **options, &block)
     end
 
     # Invoke a list type of prompt
@@ -232,8 +246,8 @@ module TTY
     # @return [TTY::Prompt::MaskQuestion]
     #
     # @api public
-    def mask(message, *args, &block)
-      invoke_question(MaskQuestion, message, *args, &block)
+    def mask(message = '', **options, &block)
+      invoke_question(MaskQuestion, message, **options, &block)
     end
 
     # Ask a question with a list of options
@@ -448,6 +462,28 @@ module TTY
       args.each { |message| say message, options.merge(color: :red) }
     end
 
+    # Print debug information in terminal top right corner
+    #
+    # @example
+    #   prompt.debug "info1", "info2"
+    #
+    # @param [Array] messages
+    #
+    # @retrun [nil]
+    #
+    # @api public
+    def debug(*messages)
+      longest = messages.max_by(&:length).size
+      width = TTY::Screen.width - longest
+      print cursor.save
+      messages.each_with_index do |msg, i|
+        print cursor.move_to(width, i)
+        print cursor.clear_line_after
+        print msg
+      end
+      print cursor.restore
+    end
+
     # Takes the string provided by the user and compare it with other possible
     # matches to suggest an unambigous string
     #

data/lib/tty/prompt/{enum_paginator.rb → block_paginator.rb}

@@ -4,7 +4,7 @@ require_relative 'paginator'
 
 module TTY
   class Prompt
-    class EnumPaginator < Paginator
+    class BlockPaginator < Paginator
       # Paginate list of choices based on current active choice.
       # Move entire pages.
       #
@@ -17,8 +17,8 @@ module TTY
 
         # 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
@@ -32,25 +32,26 @@ module TTY
         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
+          @start_index = 0
+          @end_index = @start_index + @per_page - 1
+        elsif page > 0 && page < pages
+          @start_index = (page - 1) * @per_page
+          @end_index = @start_index + @per_page - 1
+        elsif page == pages
+          @start_index = (page - 1) * @per_page
+          @end_index = list.size - 1
         else
-          @upper_index = list.size - 1
-          @lower_index = @upper_index - @per_page + 1
+          @end_index = list.size - 1
+          @start_index = @end_index - @per_page + 1
         end
 
-        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)
 
-        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?
+        return sliced_list.zip(page_range).to_enum unless block_given?
+
+        sliced_list.each_with_index do |item, index|
+          block[item, @start_index + index]
         end
       end
     end # EnumPaginator

data/lib/tty/prompt/choice.rb

@@ -30,8 +30,6 @@ module TTY
         case val
         when Choice
           val
-        when String, Symbol
-          new(val, val)
         when Array
           name, value, options = *val
           if name.is_a?(Hash)
@@ -42,7 +40,7 @@ module TTY
         when Hash
           convert_hash(val)
         else
-          raise ArgumentError, "#{val} cannot be coerced into Choice"
+          new(val, val)
         end
       end
 

data/lib/tty/prompt/enum_list.rb

@@ -3,9 +3,8 @@
 require 'English'
 
 require_relative 'choices'
-require_relative 'enum_paginator'
+require_relative 'block_paginator'
 require_relative 'paginator'
-require_relative 'symbols'
 
 module TTY
   class Prompt
@@ -14,22 +13,21 @@ module TTY
     #
     # @api private
     class EnumList
-      include Symbols
-
       PAGE_HELP = '(Press tab/right or left to reveal more choices)'
 
       # Create instance of EnumList menu.
       #
       # @api public
-      def initialize(prompt, options = {})
+      def initialize(prompt, **options)
         @prompt       = prompt
         @prefix       = options.fetch(:prefix) { @prompt.prefix }
         @enum         = options.fetch(:enum) { ')' }
-        @default      = options.fetch(:default) { 1 }
+        @default      = options.fetch(:default) { -1 }
         @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 }
+        @symbols      = @prompt.symbols.merge(options.fetch(:symbols, {}))
         @input        = nil
         @done         = false
         @first_render = true
@@ -38,10 +36,21 @@ module TTY
         @choices      = Choices.new
         @per_page     = options[:per_page]
         @page_help    = options[:page_help] || PAGE_HELP
-        @paginator    = EnumPaginator.new
+        @paginator    = BlockPaginator.new
         @page_active  = @default
       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
+
       # Set default option selected
       #
       # @api public
@@ -49,6 +58,15 @@ module TTY
         @default = default
       end
 
+      # Check if default value is set
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def default?
+        @default > 0
+      end
+
       # Set number of items per page
       #
       # @api public
@@ -125,7 +143,7 @@ module TTY
       end
 
       def keypress(event)
-        if [:backspace, :delete].include?(event.key.name)
+        if %i[backspace delete].include?(event.key.name)
           return if @input.empty?
           @input.chop!
           mark_choice_as_active
@@ -169,6 +187,7 @@ module TTY
 
       private
 
+
       # Find active choice or set to default
       #
       # @return [nil]
@@ -206,6 +225,9 @@ module TTY
       #
       # @api private
       def setup_defaults
+        if !default?
+          @default = (0..choices.length).find {|i| !choices[i].disabled? } + 1
+        end
         validate_defaults
         mark_choice_as_active
       end
@@ -363,7 +385,7 @@ module TTY
           output << if index + 1 == @active && !choice.disabled?
                       (' ' * 2) + @prompt.decorate(selected, @active_color)
                     elsif choice.disabled?
-                      @prompt.decorate(symbols[:cross], :red) + ' ' +
+                      @prompt.decorate(@symbols[:cross], :red) + ' ' +
                       selected + ' ' + choice.disabled.to_s
                     else
                       (' ' * 2) + selected