tty-prompt 0.10.1 → 0.11.0

data/lib/tty/prompt/converter_registry.rb

@@ -2,27 +2,34 @@
 
 module TTY
   class Prompt
+    # Immutable collection of converters for type transformation
+    #
+    # @api private
     class ConverterRegistry
-      def initialize
-        @_registry = {}
+      # Create a registry of conversions
+      #
+      # @param [Hash] registry
+      #
+      # @api private
+      def initialize(registry = {})
+        @_registry = registry.dup.freeze
+        freeze
       end
 
       # Register converter
       #
+      # @param [Symbol] name
+      #   the converter name
+      #
       # @api public
-      def register(key, contents = nil, &block)
-        if block_given?
-          item = block
-        else
-          item = contents
-        end
+      def register(name, contents = nil, &block)
+        item = block_given? ? block : contents
 
-        if key?(key)
-          fail ArgumentError, "Converter for #{key.inspect} already registered"
-        else
-          @_registry[key] = item
+        if key?(name)
+          raise ArgumentError,
+                "Converter for #{name.inspect} already registered"
         end
-        self
+        self.class.new(@_registry.merge(name => item))
       end
 
       # Check if converter is registered
@@ -37,16 +44,17 @@ module TTY
       # Execute converter
       #
       # @api public
-      def call(key, input)
-        if key.respond_to?(:call)
-          converter = key
+      def call(name, input)
+        if name.respond_to?(:call)
+          converter = name
         else
-          converter = @_registry.fetch(key) do
-            fail ArgumentError, "#{key.inspect} is not registered"
+          converter = @_registry.fetch(name) do
+            raise ArgumentError, "#{name.inspect} is not registered"
           end
         end
-        converter.call(input)
+        converter[input]
       end
+      alias [] call
 
       def inspect
         @_registry.inspect

data/lib/tty/prompt/converters.rb

@@ -2,30 +2,29 @@
 
 require 'pathname'
 require 'necromancer'
-require 'tty/prompt/converter_dsl'
+
+require_relative 'converter_dsl'
 
 module TTY
   class Prompt
     module Converters
       extend ConverterDSL
 
-      def self.included(base)
-        base.class_eval do
-          def converter_registry
-            Converters.converter_registry
-          end
-        end
-      end
-
+      # Delegate Necromancer errors
+      #
+      # @api private
       def self.on_error
-        yield
+        if block_given?
+          yield
+        else
+          raise ArgumentError, 'You need to provide a block argument.'
+        end
       rescue Necromancer::ConversionTypeError => e
         raise ConversionError, e.message
       end
 
       converter(:bool) do |input|
-        converter = Necromancer.new
-        on_error { converter.convert(input).to(:boolean, strict: true) }
+        on_error { Necromancer.convert(input).to(:boolean, strict: true) }
       end
 
       converter(:string) do |input|
@@ -37,28 +36,23 @@ module TTY
       end
 
       converter(:date) do |input|
-        converter = Necromancer.new
-        on_error { converter.convert(input).to(:date, strict: true) }
+        on_error { Necromancer.convert(input).to(:date, strict: true) }
       end
 
       converter(:datetime) do |input|
-        converter = Necromancer.new
-        on_error { converter.convert(input).to(:datetime, strict: true) }
+        on_error { Necromancer.convert(input).to(:datetime, strict: true) }
       end
 
       converter(:int) do |input|
-        converter = Necromancer.new
-        on_error { converter.convert(input).to(:integer, strict: true) }
+        on_error { Necromancer.convert(input).to(:integer, strict: true) }
       end
 
       converter(:float) do |input|
-        converter = Necromancer.new
-        on_error { converter.convert(input).to(:float, strict: true) }
+        on_error { Necromancer.convert(input).to(:float, strict: true) }
       end
 
       converter(:range) do |input|
-        converter = Necromancer.new
-        on_error { converter.convert(input).to(:range, strict: true) }
+        on_error { Necromancer.convert(input).to(:range, strict: true) }
       end
 
       converter(:regexp) do |input|

data/lib/tty/prompt/enum_list.rb

@@ -1,5 +1,9 @@
 # encoding: utf-8
 
+require_relative 'choices'
+require_relative 'enum_paginator'
+require_relative 'paginator'
+
 module TTY
   class Prompt
     # A class reponsible for rendering enumerated list menu.
@@ -58,7 +62,7 @@ module TTY
       #
       # @api private
       def paginated?
-        @choices.size >= page_size
+        @choices.size > page_size
       end
 
       # @param [String] text
@@ -157,7 +161,7 @@ module TTY
       #
       # @api private
       def mark_choice_as_active
-        if (@input.to_i > 1) && !@choices[@input.to_i - 1].nil?
+        if (@input.to_i > 0) && !@choices[@input.to_i - 1].nil?
           @active = @input.to_i
         else
           @active = @default
@@ -308,8 +312,8 @@ module TTY
       def render_menu
         output = ''
         @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
+          num = (index + 1).to_s + @enum + ' '
+          selected = ' ' * 2 + num + choice.name
           output << if index + 1 == @active
                       @prompt.decorate(selected.to_s, @active_color)
                     else

data/lib/tty/prompt/enum_paginator.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative 'paginator'
+
 module TTY
   class Prompt
     class EnumPaginator < Paginator

data/lib/tty/prompt/evaluator.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'tty/prompt/result'
+require_relative 'result'
 
 module TTY
   class Prompt

data/lib/tty/prompt/expander.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'tty/prompt/question'
+require_relative 'choices'
 
 module TTY
   class Prompt

data/lib/tty/prompt/list.rb

@@ -1,5 +1,9 @@
 # encoding: utf-8
 
+require_relative 'choices'
+require_relative 'paginator'
+require_relative 'symbols'
+
 module TTY
   class Prompt
     # A class responsible for rendering select list menu
@@ -7,6 +11,8 @@ module TTY
     #
     # @api private
     class List
+      include Symbols
+
       HELP = '(Use arrow%s keys, press Enter to select)'
 
       PAGE_HELP = '(Move up or down to reveal more choices)'
@@ -34,7 +40,7 @@ module TTY
         @choices      = Choices.new
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
-        @marker       = options.fetch(:marker) { Symbols::ITEM_SELECTED }
+        @marker       = options.fetch(:marker) { symbols[:pointer] }
         @help         = options[:help]
         @first_render = true
         @done         = false
@@ -66,13 +72,17 @@ module TTY
         @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 >= (@per_page || Paginator::DEFAULT_PAGE_SIZE)
+        @choices.size > page_size
       end
 
       # @param [String] text
@@ -134,7 +144,7 @@ module TTY
       def keynum(event)
         return unless enumerate?
         value = event.value.to_i
-        return unless (1..@choices.count).include?(value)
+        return unless (1..@choices.count).cover?(value)
         @active = value
       end
 
@@ -171,11 +181,11 @@ module TTY
       def validate_defaults
         @default.each do |d|
           if d.nil? || d.to_s.empty?
-            fail ConfigurationError,
+            raise ConfigurationError,
                  "default index must be an integer in range (1 - #{@choices.size})"
           end
           if d < 1 || d > @choices.size
-            fail ConfigurationError,
+            raise ConfigurationError,
                  "default index `#{d}` out of range (1 - #{@choices.size})"
           end
         end
@@ -197,10 +207,9 @@ module TTY
           refresh(lines)
         end
         render_question
-        answer = render_answer
+        render_answer
       ensure
         @prompt.print(@prompt.show)
-        answer
       end
 
       # Find value for the choice selected
@@ -266,14 +275,15 @@ module TTY
       def render_menu
         output = ''
         @paginator.paginate(@choices, @active, @per_page) do |choice, index|
-          num = enumerate? ? (index + 1).to_s + @enum + Symbols::SPACE : ''
+          num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
           message = if index + 1 == @active
-                      selected = @marker + Symbols::SPACE + num + choice.name
+                      selected = @marker + ' ' + num + choice.name
                       @prompt.decorate("#{selected}", @active_color)
                     else
-                      Symbols::SPACE * 2 + num + choice.name
+                      ' ' * 2 + num + choice.name
                     end
-          newline = (index == @paginator.max_index) ? '' : "\n"
+          max_index = paginated? ? @paginator.max_index : @choices.size - 1
+          newline = (index == max_index) ? '' : "\n"
           output << (message + newline)
         end
         output

data/lib/tty/prompt/mask_question.rb

@@ -1,5 +1,8 @@
 # encoding: utf-8
 
+require_relative 'question'
+require_relative 'symbols'
+
 module TTY
   class Prompt
     class MaskQuestion < Question
@@ -11,7 +14,7 @@ module TTY
       # @api public
       def initialize(prompt, options = {})
         super
-        @mask        = options.fetch(:mask) { Symbols::ITEM_SECURE }
+        @mask        = options.fetch(:mask) { Symbols.symbols[:dot] }
         @done_masked = false
         @failure     = false
         @prompt.subscribe(self)
@@ -54,15 +57,19 @@ module TTY
           masked = "#{@mask * "#{@input}".length}"
           if @done_masked && !@failure
             masked = @prompt.decorate(masked, @active_color)
+          elsif @done_masked && @failure
+            masked = @prompt.decorate(masked, @error_color)
           end
           header += masked
         end
         @prompt.print(header)
-        @prompt.print("\n") if @done
+        @prompt.puts if @done
+
+        header.lines.count + (@done ? 1 : 0)
       end
 
-      def render_error_or_finish(result)
-        @failure = result.failure?
+      def render_error(errors)
+        @failure = !errors.empty?
         super
       end
 
@@ -71,13 +78,15 @@ module TTY
       # @private
       def read_input
         @done_masked = false
+        @failure = false
         @input = ''
+
         until @done_masked
-          @prompt.read_keypress(echo?)
+          @prompt.read_keypress
           @prompt.print(@prompt.clear_line)
           render_question
         end
-        @prompt.print("\n")
+        @prompt.puts
         @input
       end
     end # MaskQuestion

data/lib/tty/prompt/multi_list.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'tty/prompt/list'
+require_relative 'list'
 
 module TTY
   class Prompt
@@ -22,6 +22,7 @@ module TTY
         @selected = []
         @help    = options[:help]
         @default = Array(options[:default])
+        @echo = options.fetch(:echo, true)
       end
 
       # Callback fired when space key is pressed
@@ -61,9 +62,9 @@ module TTY
       # @api private
       def render_header
         instructions = @prompt.decorate(help, :bright_black)
-        if @done
+        if @done && @echo
           @prompt.decorate(selected_names, @active_color)
-        elsif @selected.size.nonzero?
+        elsif @selected.size.nonzero? && @echo
           selected_names + (@first_render ? " #{instructions}" : '')
         elsif @first_render
           instructions
@@ -85,16 +86,17 @@ module TTY
       def render_menu
         output = ''
         @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
+          num = enumerate? ? (index + 1).to_s + @enum + ' ' : ''
+          indicator = (index + 1 == @active) ?  @marker : ' '
+          indicator += ' '
           message = if @selected.include?(choice)
-                      selected = @prompt.decorate(Symbols::RADIO_CHECKED, @active_color)
-                      selected + Symbols::SPACE + num + choice.name
+                      selected = @prompt.decorate(symbols[:radio_on], @active_color)
+                      selected + ' ' + num + choice.name
                     else
-                      Symbols::RADIO_UNCHECKED + Symbols::SPACE + num + choice.name
+                      symbols[:radio_off] + ' ' + num + choice.name
                     end
-          newline = (index == @paginator.max_index) ? '' : "\n"
+          max_index = paginated? ? @paginator.max_index : @choices.size - 1
+          newline = (index == max_index) ? '' : "\n"
           output << indicator + message + newline
         end
         output

data/lib/tty/prompt/question.rb

@@ -1,10 +1,11 @@
 # encoding: utf-8
 
-require 'tty/prompt/question/modifier'
-require 'tty/prompt/question/validation'
-require 'tty/prompt/question/checks'
-require 'tty/prompt/converter_dsl'
-require 'tty/prompt/converters'
+require_relative 'converters'
+require_relative 'evaluator'
+require_relative 'question/modifier'
+require_relative 'question/validation'
+require_relative 'question/checks'
+require_relative 'utils'
 
 module TTY
   # A class responsible for shell prompt interactions.
@@ -14,7 +15,6 @@ module TTY
     # @api public
     class Question
       include Checks
-      include Converters
 
       UndefinedSetting = Module.new
 
@@ -42,6 +42,7 @@ module TTY
         @convert    = options.fetch(:convert) { UndefinedSetting }
         @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 }
         @messages   = Utils.deep_copy(options.fetch(:messages) { { } })
         @done       = false
         @input      = nil
@@ -100,12 +101,17 @@ module TTY
       #
       # @api private
       def render
+        @errors = []
         until @done
-          render_question
+          lines = render_question
           result = process_input
-          errors = result.errors
-          render_error_or_finish(result)
-          refresh(errors.count)
+          if result.failure?
+            @errors = result.errors
+            render_error(result.errors)
+          else
+            @done = true
+          end
+          refresh(lines)
         end
         render_question
         convert_result(result.value)
@@ -124,7 +130,9 @@ module TTY
           header += @prompt.decorate("(#{default})", @help_color) + ' '
         end
         @prompt.print(header)
-        @prompt.print("\n") if @done
+        @prompt.puts if @done
+
+        header.lines.count + (@done ? 1 : 0)
       end
 
       # Decide how to handle input from user
@@ -146,43 +154,37 @@ module TTY
         when :keypress
           @prompt.read_keypress
         when :multiline
-          @prompt.read_multiline
+          @prompt.read_multiline.each(&:chomp!)
         else
-          @prompt.read_line(echo)
+          @prompt.read_line(echo: echo).chomp
         end
       end
 
       # Handle error condition
       #
       # @api private
-      def render_error_or_finish(result)
-        if result.failure?
-          result.errors.each do |err|
-            @prompt.print(@prompt.clear_line)
-            @prompt.print(@prompt.decorate('>>', :red) + ' ' + err)
-          end
-          @prompt.print(@prompt.cursor.up(result.errors.count))
-        else
-          @done = true
-          if result.errors.count.nonzero?
-            @prompt.print(@prompt.cursor.down(result.errors.count))
-          end
+      def render_error(errors)
+        errors.each do |err|
+          newline = (@echo ? '' : "\n")
+          @prompt.print(newline + @prompt.decorate('>>', :red) + ' ' + err)
         end
       end
 
       # Determine area of the screen to clear
       #
-      # @param [Integer] errors
+      # @param [Array[String]] errors
       #
       # @api private
-      def refresh(errors = nil)
-        lines = @message.scan("\n").length
-        lines += ((!echo? || errors.nonzero?) ? 1 : 2) # clear user enter
-
-        if errors.nonzero? && @done
-          lines += errors
+      def refresh(lines)
+        if @done
+          if @errors.count.zero? && @echo
+            @prompt.print(@prompt.cursor.up(lines))
+          else
+            lines += @errors.count
+          end
+        else
+          @prompt.print(@prompt.cursor.up(lines))
         end
-
         @prompt.print(@prompt.clear_lines(lines))
       end
 
@@ -193,7 +195,7 @@ module TTY
       # @api private
       def convert_result(value)
         if convert? & !Utils.blank?(value)
-          converter_registry.(@convert, value)
+          Converters.convert(@convert, value)
         else
           value
         end
@@ -303,10 +305,10 @@ module TTY
       def in(value = (not_set = true), message = nil)
         messages[:range?] = message if message
         if in? && !@in.is_a?(Range)
-          @in = converter_registry.(:range, @in)
+          @in = Converters.convert(:range, @in)
         end
         return @in if not_set
-        @in = converter_registry.(:range, value)
+        @in = Converters.convert(:range, value)
       end
 
       # Check if range is set