tty-prompt 0.18.1 → 0.23.0

data/lib/tty/prompt/converters.rb

@@ -1,74 +1,181 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require 'necromancer'
-
-require_relative 'converter_dsl'
+require_relative "const"
+require_relative "converter_dsl"
 
 module TTY
   class Prompt
     module Converters
       extend ConverterDSL
 
-      # Delegate Necromancer errors
-      #
-      # @api private
-      def self.on_error
-        if block_given?
-          yield
-        else
-          raise ArgumentError, 'You need to provide a block argument.'
+      TRUE_VALUES = /^(t(rue)?|y(es)?|on|1)$/i.freeze
+      FALSE_VALUES = /^(f(alse)?|n(o)?|off|0)$/i.freeze
+
+      SINGLE_DIGIT_MATCHER = /^(?<digit>\-?\d+(\.\d+)?)$/.freeze
+      DIGIT_MATCHER = /^(?<open>-?\d+(\.\d+)?)
+                       \s*(?<sep>(\.\s*){2,3}|-|,)\s*
+                       (?<close>-?\d+(\.\d+)?)$
+                      /x.freeze
+      LETTER_MATCHER = /^(?<open>\w)
+                        \s*(?<sep>(\.\s*){2,3}|-|,)\s*
+                        (?<close>\w)$
+                       /x.freeze
+
+      converter(:boolean, :bool) do |input|
+        case input.to_s
+        when TRUE_VALUES then true
+        when FALSE_VALUES then false
+        else Const::Undefined
         end
-      rescue Necromancer::ConversionTypeError => e
-        raise ConversionError, e.message
-      end
-
-      converter(:bool) do |input|
-        on_error { Necromancer.convert(input).to(:boolean, strict: true) }
       end
 
-      converter(:string) do |input|
+      converter(:string, :str) do |input|
         String(input).chomp
       end
 
-      converter(:symbol) do |input|
+      converter(:symbol, :sym) do |input|
         input.to_sym
       end
 
+      converter(:char) do |input|
+        String(input).chars.to_a[0]
+      end
+
       converter(:date) do |input|
-        on_error { Necromancer.convert(input).to(:date, strict: true) }
+        begin
+          require "date" unless defined?(::Date)
+          ::Date.parse(input)
+        rescue ArgumentError
+          Const::Undefined
+        end
       end
 
       converter(:datetime) do |input|
-        on_error { Necromancer.convert(input).to(:datetime, strict: true) }
+        begin
+          require "date" unless defined?(::Date)
+          ::DateTime.parse(input.to_s)
+        rescue ArgumentError
+          Const::Undefined
+        end
       end
 
-      converter(:int) do |input|
-        on_error { Necromancer.convert(input).to(:integer, strict: true) }
+      converter(:time) do |input|
+        begin
+          require "time"
+          ::Time.parse(input.to_s)
+        rescue ArgumentError
+          Const::Undefined
+        end
+      end
+
+      converter(:integer, :int) do |input|
+        begin
+          Integer(input)
+        rescue ArgumentError
+          Const::Undefined
+        end
       end
 
       converter(:float) do |input|
-        on_error { Necromancer.convert(input).to(:float, strict: true) }
+        begin
+          Float(input)
+        rescue TypeError, ArgumentError
+          Const::Undefined
+        end
       end
 
+      # Convert string number to integer or float
+      #
+      # @return [Integer,Float,Const::Undefined]
+      #
+      # @api private
+      def cast_to_num(num)
+        ([convert(:int, num), convert(:float, num)] - [Const::Undefined]).first ||
+          Const::Undefined
+      end
+      module_function :cast_to_num
+
       converter(:range) do |input|
-        on_error { Necromancer.convert(input).to(:range, strict: true) }
+        if input.is_a?(::Range)
+          input
+        elsif match = input.to_s.match(SINGLE_DIGIT_MATCHER)
+          digit = cast_to_num(match[:digit])
+          ::Range.new(digit, digit)
+        elsif match = input.to_s.match(DIGIT_MATCHER)
+          open = cast_to_num(match[:open])
+          close = cast_to_num(match[:close])
+          ::Range.new(open, close, match[:sep].gsub(/\s*/, "") == "...")
+        elsif match = input.to_s.match(LETTER_MATCHER)
+          ::Range.new(match[:open], match[:close],
+                      match[:sep].gsub(/\s*/, "") == "...")
+        else Const::Undefined
+        end
       end
 
       converter(:regexp) do |input|
         Regexp.new(input)
       end
 
-      converter(:file) do |input|
-        ::File.open(::File.join(Dir.pwd, input))
+      converter(:filepath, :file) do |input|
+        ::File.expand_path(input)
       end
 
-      converter(:path) do |input|
-        Pathname.new(::File.join(Dir.pwd, input))
+      converter(:pathname, :path) do |input|
+        require "pathname" unless defined?(::Pathname)
+        ::Pathname.new(input)
       end
 
-      converter(:char) do |input|
-        String(input).chars.to_a[0]
+      converter(:uri) do |input|
+        require "uri" unless defined?(::URI)
+        ::URI.parse(input)
+      end
+
+      converter(:list, :array) do |val|
+        (val.respond_to?(:to_a) ? val : val.split(/(?<!\\),/))
+          .map { |v| v.strip.gsub(/\\,/, ",") }
+          .reject(&:empty?)
+      end
+
+      converter(:hash, :map) do |val|
+        values = val.respond_to?(:to_a) ? val : val.split(/[& ]/)
+        values.each_with_object({}) do |pair, pairs|
+          key, value = pair.split(/[=:]/, 2)
+          if (current = pairs[key.to_sym])
+            pairs[key.to_sym] = Array(current) << value
+          else
+            pairs[key.to_sym] = value
+          end
+          pairs
+        end
+      end
+
+      converter_registry.keys.each do |type|
+        next if type =~ /list|array|map|hash/
+
+        [:"#{type}_list", :"#{type}_array", :"#{type}s"].each do |new_type|
+          converter(new_type) do |val|
+            converter_registry[:array].(val).map do |obj|
+              converter_registry[type].(obj)
+            end
+          end
+        end
+
+        [:"#{type}_map", :"#{type}_hash"].each do |new_type|
+          converter(new_type) do |val|
+            converter_registry[:hash].(val).each_with_object({}) do |(k, v), h|
+              h[k] = converter_registry[type].(v)
+            end
+          end
+        end
+
+        [:"string_#{type}_map", :"str_#{type}_map",
+         :"string_#{type}_hash", :"str_#{type}_hash"].each do |new_type|
+          converter(new_type) do |val|
+            converter_registry[:hash].(val).each_with_object({}) do |(k, v), h|
+              h[converter_registry[:string].(k)] = converter_registry[type].(v)
+            end
+          end
+        end
       end
     end # Converters
   end # Prompt

data/lib/tty/prompt/enum_list.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require 'English'
+require "English"
 
-require_relative 'choices'
-require_relative 'enum_paginator'
-require_relative 'paginator'
-require_relative 'symbols'
+require_relative "choices"
+require_relative "block_paginator"
+require_relative "paginator"
 
 module TTY
   class Prompt
@@ -14,22 +13,25 @@ module TTY
     #
     # @api private
     class EnumList
-      include Symbols
+      PAGE_HELP = "(Press tab/right or left to reveal more choices)"
 
-      PAGE_HELP = '(Press tab/right or left to reveal more choices)'
+      # Checks type of default parameter to be integer
+      INTEGER_MATCHER = /\A[-+]?\d+\Z/.freeze
 
       # 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 }
+        @enum         = options.fetch(:enum) { ")" }
+        @default      = options.fetch(:default, nil)
         @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 }
+        @cycle        = options.fetch(:cycle, false)
+        @quiet        = options.fetch(:quiet) { @prompt.quiet }
+        @symbols      = @prompt.symbols.merge(options.fetch(:symbols, {}))
         @input        = nil
         @done         = false
         @first_render = true
@@ -38,10 +40,22 @@ 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 +63,15 @@ module TTY
         @default = default
       end
 
+      # Check if default value is set
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def default?
+        !@default.to_s.empty?
+      end
+
       # Set number of items per page
       #
       # @api public
@@ -83,6 +106,13 @@ module TTY
         @enum = value
       end
 
+      # Set quiet mode
+      #
+      # @api public
+      def quiet(value)
+        @quiet = value
+      end
+
       # Add a single choice
       #
       # @api public
@@ -125,8 +155,9 @@ 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
         elsif event.value =~ /^\d+$/
@@ -144,7 +175,7 @@ module TTY
         if choice_in_range && !choice_disabled || @input.empty?
           @done = true
         else
-          @input = ''
+          @input = ""
           @failure = true
         end
       end
@@ -193,6 +224,8 @@ module TTY
       def validate_defaults
         msg = if @default.nil? || @default.to_s.empty?
                 "default index must be an integer in range (1 - #{choices.size})"
+              elsif @default.to_s !~ INTEGER_MATCHER
+                validate_default_name
               elsif @default < 1 || @default > @choices.size
                 "default index #{@default} out of range (1 - #{@choices.size})"
               elsif choices[@default - 1] && choices[@default - 1].disabled?
@@ -202,11 +235,31 @@ module TTY
         raise(ConfigurationError, msg) if msg
       end
 
+      # Validate default choice name
+      #
+      # @return [String]
+      #
+      # @api private
+      def validate_default_name
+        default_choice = choices.find_by(:name, @default.to_s)
+        if default_choice.nil?
+          "no choice found for the default name: #{@default.inspect}"
+        elsif default_choice.disabled?
+          "default name #{@default.inspect} matches disabled choice"
+        end
+      end
+
       # Setup default option and active selection
       #
       # @api private
       def setup_defaults
+        if @default.to_s.empty?
+          @default = (0..choices.length).find { |i| !choices[i].disabled? } + 1
+        end
         validate_defaults
+        if default_choice = choices.find_by(:name, @default)
+          @default = choices.index(default_choice) + 1
+        end
         mark_choice_as_active
       end
 
@@ -219,7 +272,7 @@ module TTY
       #
       # @api private
       def render
-        @input = ''
+        @input = ""
         until @done
           question = render_question
           @prompt.print(question)
@@ -231,7 +284,7 @@ module TTY
           question_lines = question.split($INPUT_RECORD_SEPARATOR, -1)
           @prompt.print(refresh(question_lines_count(question_lines)))
         end
-        @prompt.print(render_question)
+        @prompt.print(render_question) unless @quiet
         answer
       end
 
@@ -286,8 +339,8 @@ module TTY
       #
       # @api private
       def error_message
-        error = 'Please enter a valid number'
-        "\n" + @prompt.decorate('>>', @error_color) + ' ' + error
+        error = "Please enter a valid number"
+        "\n" + @prompt.decorate(">>", @error_color) + " " + error
       end
 
       # Render error message and return cursor to position of input
@@ -310,8 +363,9 @@ module TTY
       #
       # @api private
       def render_header
-        return '' unless @done
-        return '' unless @active
+        return "" unless @done
+        return "" unless @active
+
         selected_item = @choices[@active - 1].name.to_s
         @prompt.decorate(selected_item, @active_color)
       end
@@ -331,7 +385,8 @@ module TTY
       #
       # @api private
       def page_help_message
-        return '' unless paginated?
+        return "" unless paginated?
+
         "\n" + @prompt.decorate(@page_help, @help_color)
       end
 
@@ -358,15 +413,15 @@ module TTY
         output = []
 
         @paginator.paginate(@choices, @page_active, @per_page) do |choice, index|
-          num = (index + 1).to_s + @enum + ' '
+          num = (index + 1).to_s + @enum + " "
           selected = num.to_s + choice.name.to_s
           output << if index + 1 == @active && !choice.disabled?
-                      (' ' * 2) + @prompt.decorate(selected, @active_color)
+                      (" " * 2) + @prompt.decorate(selected, @active_color)
                     elsif choice.disabled?
-                      @prompt.decorate(symbols[:cross], :red) + ' ' +
-                      selected + ' ' + choice.disabled.to_s
+                      @prompt.decorate(@symbols[:cross], :red) + " " +
+                      selected + " " + choice.disabled.to_s
                     else
-                      (' ' * 2) + selected
+                      (" " * 2) + selected
                     end
           output << "\n"
         end

data/lib/tty/prompt/errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module TTY
+  class Prompt
+    Error = Class.new(StandardError)
+
+    # Raised when wrong parameter is used to configure prompt
+    ConfigurationError = Class.new(Error)
+
+    # Raised when type conversion cannot be performed
+    ConversionError = Class.new(Error)
+
+    # Raised when the passed in validation argument is of wrong type
+    ValidationCoercion = Class.new(Error)
+
+    # Raised when the required argument is not supplied
+    ArgumentRequired = Class.new(Error)
+
+    # Raised when the argument validation fails
+    ArgumentValidation = Class.new(Error)
+
+    # Raised when the argument is not expected
+    InvalidArgument = Class.new(Error)
+
+    # Raised when overriding already defined conversion
+    ConversionAlreadyDefined = Class.new(Error)
+
+    # Raised when conversion type isn't registered
+    UnsupportedConversion = Class.new(Error)
+  end # Prompt
+end # TTY