tty-prompt 0.18.1 → 0.23.0

data/lib/tty/prompt/answers_collector.rb

@@ -6,7 +6,7 @@ module TTY
       # Initialize answer collector
       #
       # @api public
-      def initialize(prompt, options = {})
+      def initialize(prompt, **options)
         @prompt  = prompt
         @answers = options.fetch(:answers) { {} }
       end
@@ -25,7 +25,7 @@ module TTY
       # Create answer entry
       #
       # @example
-      #   key(:name).ask('Name?')
+      #   key(:name).ask("Name?")
       #
       # @api public
       def key(name, &block)
@@ -40,7 +40,7 @@ module TTY
       # Change to collect all values for a key
       #
       # @example
-      #   key(:colors).values.ask('Color?')
+      #   key(:colors).values.ask("Color?")
       #
       # @api public
       def values(&block)
@@ -69,8 +69,8 @@ module TTY
       private
 
       # @api private
-      def method_missing(method, *args, &block)
-        answer = @prompt.public_send(method, *args, &block)
+      def method_missing(method, *args, **options, &block)
+        answer = @prompt.public_send(method, *args, **options, &block)
         add_answer(answer)
       end
     end # AnswersCollector

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'paginator'
+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

@@ -15,7 +15,7 @@ module TTY
       #   Choice.from([:foo, 1])
       #   # => <TTY::Prompt::Choice @key=nil @name="foo" @value=1 @disabled=false>
       #
-      #   Choice.from({name: :foo, value: 1, key: 'f'}
+      #   Choice.from({name: :foo, value: 1, key: "f"}
       #   # => <TTY::Prompt::Choice @key="f" @name="foo" @value=1 @disabled=false>
       #
       # @param [Object] val
@@ -30,19 +30,17 @@ module TTY
         case val
         when Choice
           val
-        when String, Symbol
-          new(val, val)
         when Array
           name, value, options = *val
           if name.is_a?(Hash)
             convert_hash(name)
           else
-            new(name.to_s, value || name.to_s, options || {})
+            new(name.to_s, (value.nil? ? name.to_s : value), **(options || {}))
           end
         when Hash
           convert_hash(val)
         else
-          raise ArgumentError, "#{val} cannot be coerced into Choice"
+          new(val, val)
         end
       end
 
@@ -51,9 +49,9 @@ module TTY
       # @api public
       def self.convert_hash(val)
         if val.key?(:name) && val.key?(:value)
-          new(val[:name].to_s, val[:value], val)
+          new(val[:name].to_s, val[:value], **val)
         elsif val.key?(:name)
-          new(val[:name].to_s, val[:name].to_s, val)
+          new(val[:name].to_s, val[:name].to_s, **val)
         else
           new(val.keys.first.to_s, val.values.first)
         end
@@ -113,9 +111,10 @@ module TTY
       # @api public
       def ==(other)
         return false unless other.is_a?(self.class)
+
         name == other.name &&
-        value == other.value &&
-        key == other.key
+          value == other.value &&
+          key == other.key
       end
 
       # Object string representation
@@ -124,7 +123,7 @@ module TTY
       #
       # @api public
       def to_s
-        "#{name}"
+        name.to_s
       end
     end # Choice
   end # Prompt

data/lib/tty/prompt/choices.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
-require_relative 'choice'
+require_relative "choice"
 
 module TTY
   class Prompt
@@ -13,15 +13,8 @@ module TTY
       include Enumerable
       extend Forwardable
 
-      # The actual collection choices
-      #
-      # @return [Array[Choice]]
-      #
-      # @api public
-      attr_reader :choices
-
       def_delegators :choices, :length, :size, :to_ary, :empty?,
-                               :values_at, :index
+                     :values_at, :index, :==
 
       # Convenience for creating choices
       #
@@ -48,6 +41,20 @@ module TTY
         end
       end
 
+      # Scope of choices which are not disabled
+      #
+      # @api public
+      def enabled
+        reject(&:disabled?)
+      end
+
+      def enabled_indexes
+        each_with_index.reduce([]) do |acc, (choice, idx)|
+          acc << idx unless choice.disabled?
+          acc
+        end
+      end
+
       # Iterate over all choices in the collection
       #
       # @yield [Choice]
@@ -55,6 +62,7 @@ module TTY
       # @api public
       def each(&block)
         return to_enum unless block_given?
+
         choices.each(&block)
       end
 
@@ -93,8 +101,8 @@ module TTY
 
       # Find a matching choice
       #
-      # @exmaple
-      #   choices.find_by(:name, 'small')
+      # @example
+      #   choices.find_by(:name, "small")
       #
       # @param [Symbol] attr
       #   the attribute name
@@ -106,6 +114,16 @@ module TTY
       def find_by(attr, value)
         find { |choice| choice.public_send(attr) == value }
       end
+
+      protected
+
+      # The actual collection choices
+      #
+      # @return [Array[Choice]]
+      #
+      # @api private
+
+      attr_reader :choices
     end # Choices
   end # Prompt
 end # TTY

data/lib/tty/prompt/confirm_question.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'question'
-require_relative 'utils'
+require_relative "question"
+require_relative "utils"
 
 module TTY
   class Prompt
@@ -14,7 +14,7 @@ module TTY
       # @option options [String] :negative
       #
       # @api public
-      def initialize(prompt, options = {})
+      def initialize(prompt, **options)
         super
         @suffix   = options.fetch(:suffix)   { UndefinedSetting }
         @positive = options.fetch(:positive) { UndefinedSetting }
@@ -38,6 +38,7 @@ module TTY
       # @api public
       def suffix(value = (not_set = true))
         return @negative if not_set
+
         @suffix = value
       end
 
@@ -46,6 +47,7 @@ module TTY
       # @api public
       def positive(value = (not_set = true))
         return @positive if not_set
+
         @positive = value
       end
 
@@ -54,11 +56,13 @@ module TTY
       # @api public
       def negative(value = (not_set = true))
         return @negative if not_set
+
         @negative = value
       end
 
       def call(message, &block)
         return if Utils.blank?(message)
+
         @message = message
         block.call(self) if block
         setup_defaults
@@ -73,9 +77,9 @@ module TTY
       def render_question
         header = "#{@prefix}#{message} "
         if !@done
-          header += @prompt.decorate("(#{@suffix})", @help_color) + ' '
+          header += @prompt.decorate("(#{@suffix})", @help_color) + " "
         else
-          answer = convert_result(@input)
+          answer = conversion.call(@input)
           label  = answer ? @positive : @negative
           header += @prompt.decorate(label, @active_color)
         end
@@ -85,34 +89,56 @@ module TTY
 
       protected
 
+      # Decide how to handle input from user
+      #
+      # @api private
+      def process_input(question)
+        @input = read_input(question)
+        if Utils.blank?(@input)
+          @input = default ? positive : negative
+        end
+        @evaluator.call(@input)
+      end
+
       # @api private
       def setup_defaults
+        infer_default
+        @convert = conversion
         return if suffix? && positive?
 
         if suffix? && (!positive? || !negative?)
-          parts = @suffix.split('/')
+          parts = @suffix.split("/")
           @positive = parts[0]
           @negative = parts[1]
-          @convert = conversion
         elsif !suffix? && positive?
           @suffix = create_suffix
-          @convert = conversion
         else
           create_default_labels
-          @convert = :bool
+        end
+      end
+
+      # @api private
+      def infer_default
+        converted = Converters.convert(:bool, default.to_s)
+        if converted == Const::Undefined
+          raise InvalidArgument, "default needs to be `true` or `false`"
+        else
+          default(converted)
         end
       end
 
       # @api private
       def create_default_labels
-        @suffix   = default ? 'Y/n' : 'y/N'
-        @positive = default ? 'Yes' : 'yes'
-        @negative = default ? 'no' : 'No'
+        @suffix   = default ? "Y/n" : "y/N"
+        @positive = default ? "Yes" : "yes"
+        @negative = default ? "no" : "No"
+        @validation = /^(y(es)?|no?)$/i
+        @messages[:valid?] = "Invalid input."
       end
 
       # @api private
       def create_suffix
-        (default ? positive.capitalize : positive.downcase) + '/' +
+        (default ? positive.capitalize : positive.downcase) + "/" +
           (default ? negative.downcase : negative.capitalize)
       end
 
@@ -120,12 +146,12 @@ module TTY
       #
       # @api private
       def conversion
-        proc { |input|
+        ->(input) do
           positive_word   = Regexp.escape(positive)
           positive_letter = Regexp.escape(positive[0])
-          pattern = Regexp.new("^#{positive_word}|#{positive_letter}$", true)
+          pattern = Regexp.new("^(#{positive_word}|#{positive_letter})$", true)
           !input.match(pattern).nil?
-        }
+        end
       end
     end # ConfirmQuestion
   end # Prompt

data/lib/tty/prompt/const.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TTY
+  class Prompt
+    module Const
+      Undefined = Object.new.tap do |obj|
+        def obj.to_s
+          "undefined"
+        end
+
+        def obj.inspect
+          "undefined".inspect
+        end
+      end
+    end # Const
+  end # Prompt
+end # TTY

data/lib/tty/prompt/converter_dsl.rb

@@ -1,21 +1,20 @@
 # frozen_string_literal: true
 
-require_relative 'converter_registry'
+require_relative "converter_registry"
 
 module TTY
   class Prompt
     module ConverterDSL
       def converter_registry
-        @converter_registry ||= ConverterRegistry.new
+        @__converter_registry ||= ConverterRegistry.new
       end
 
-      def converter(name, &block)
-        @converter_registry = converter_registry.register(name, &block)
-        self
+      def converter(*names, &block)
+        converter_registry.register(*names, &block)
       end
 
-      def convert(name, data)
-        @converter_registry[name, data]
+      def convert(name, input)
+        converter_registry[name].call(input)
       end
     end # ConverterDSL
   end # Prompt

data/lib/tty/prompt/converter_registry.rb

@@ -1,60 +1,65 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module TTY
   class Prompt
     # Immutable collection of converters for type transformation
     #
     # @api private
     class ConverterRegistry
+      extend Forwardable
+
+      def_delegators "@__registry", :keys
+
       # Create a registry of conversions
       #
       # @param [Hash] registry
       #
       # @api private
       def initialize(registry = {})
-        @_registry = registry.dup.freeze
-        freeze
+        @__registry = registry.dup
       end
 
-      # Register converter
+      # Check if conversion is available
       #
-      # @param [Symbol] name
-      #   the converter name
+      # @param [String] name
+      #
+      # @return [Boolean]
       #
       # @api public
-      def register(name, contents = nil, &block)
-        item = block_given? ? block : contents
-
-        if key?(name)
-          raise ArgumentError,
-                "Converter for #{name.inspect} already registered"
-        end
-        self.class.new(@_registry.merge(name => item))
+      def contain?(name)
+        conv_name = name.to_s.downcase.to_sym
+        @__registry.key?(conv_name)
       end
 
-      # Check if converter is registered
+      # Register a conversion
       #
-      # @return [Boolean]
+      # @param [Symbol] name
+      #   the converter name
       #
       # @api public
-      def key?(key)
-        @_registry.key?(key)
+      def register(*names, &block)
+        names.each do |name|
+          if contain?(name)
+            raise ConversionAlreadyDefined,
+                  "converter for #{name.inspect} is already registered"
+          end
+          @__registry[name] = block
+        end
       end
 
       # Execute converter
       #
       # @api public
-      def call(name, input)
-        if name.respond_to?(:call)
-          converter = name
-        else
-          converter = @_registry.fetch(name) do
-            raise ArgumentError, "#{name.inspect} is not registered"
-          end
+      def [](name)
+        conv_name = name.to_s.downcase.to_sym
+        @__registry.fetch(conv_name) do
+          raise UnsupportedConversion,
+                "converter #{conv_name.inspect} is not registered"
         end
-        converter[input]
       end
-      alias [] call
+      alias fetch []
 
       def inspect
         @_registry.inspect