tty-prompt 0.4.0 → 0.5.0

data/benchmarks/speed.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require 'tty-prompt'
+require 'benchmark/ips'
+require 'stringio'
+
+input  = ::StringIO.new
+output = ::StringIO.new
+prompt  = TTY::Prompt.new(input: input, output: output)
+
+Benchmark.ips do |r|
+
+  r.report("Ruby #puts") do
+    output.puts "What is your name?"
+  end
+
+  r.report("TTY::Prompt #ask") do
+    prompt.ask("What is your name?")
+  end
+end
+
+# Calculating -------------------------------------
+#           Ruby #puts     34601 i/100ms
+#     TTY::Prompt #ask        12 i/100ms
+# -------------------------------------------------
+#           Ruby #puts   758640.5 (±14.9%) i/s -    3736908 in   5.028562s
+#     TTY::Prompt #ask       63.1 (±7.9%) i/s -        324 in   5.176857s

data/examples/collect.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new(prefix: '[?] ')
+
+result = prompt.collect do
+  key(:name).ask('Name?')
+
+  key(:age).ask('Age?', convert: :int)
+
+  key(:address) do
+    key(:street).ask('Street?', required: true)
+    key(:city).ask('City?')
+    key(:zip).ask('Zip?', validate: /\A\d{3}\Z/)
+  end
+end
+
+puts result

data/examples/expand.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require '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, default: 3)

data/lib/tty-prompt.rb

@@ -9,15 +9,18 @@ require 'tty/prompt'
 require 'tty/prompt/choice'
 require 'tty/prompt/choices'
 require 'tty/prompt/enum_list'
+require 'tty/prompt/expander'
 require 'tty/prompt/evaluator'
 require 'tty/prompt/list'
 require 'tty/prompt/multi_list'
 require 'tty/prompt/question'
 require 'tty/prompt/mask_question'
+require 'tty/prompt/confirm_question'
 require 'tty/prompt/reader'
 require 'tty/prompt/slider'
 require 'tty/prompt/statement'
 require 'tty/prompt/suggestion'
+require 'tty/prompt/answers_collector'
 require 'tty/prompt/symbols'
 require 'tty/prompt/test'
 require 'tty/prompt/utils'

data/lib/tty/prompt.rb

@@ -31,10 +31,20 @@ module TTY
 
     # Prompt prefix
     #
+    # @example
+    #   prompt = TTY::Prompt.new(prefix: [?])
+    #
+    # @return [String]
+    #
     # @api private
     attr_reader :prefix
 
-    def_delegators :@pastel, :decorate
+    # Theme colors
+    #
+    # @api private
+    attr_reader :active_color, :help_color, :error_color
+
+    def_delegators :@pastel, :decorate, :strip
 
     def_delegators :@cursor, :clear_lines, :clear_line,
                    :show, :hide
@@ -60,6 +70,9 @@ module TTY
       @input  = options.fetch(:input) { $stdin }
       @output = options.fetch(:output) { $stdout }
       @prefix = options.fetch(:prefix) { '' }
+      @active_color = options.fetch(:active_color) { :green }
+      @help_color   = options.fetch(:help_color)   { :bright_black }
+      @error_color  = options.fetch(:error_color)  { :red }
 
       @cursor = TTY::Cursor
       @pastel = Pastel.new
@@ -223,16 +236,62 @@ module TTY
     #
     # @example
     #   prompt = TTY::Prompt.new
-    #   prompt.yes?('Are you human? (Y/n)') # => true
+    #   prompt.yes?('Are you human?')
+    #   # => Are you human? (Y/n)
     #
     # @return [Boolean]
     #
     # @api public
-    def yes?(question, *args, &block)
-      options = Utils.extract_options!(args)
-      options.merge!(convert: :bool)
-      args << options
-      ask(question, *args, &block)
+    def yes?(message, *args, &block)
+      defaults = { default: true }
+      options  = Utils.extract_options!(args)
+      options.merge!(defaults.reject { |k, _| options.key?(k) })
+
+      question = ConfirmQuestion.new(self, options)
+      question.call(message, &block)
+    end
+
+    # A shortcut method to ask the user negative question and return
+    # true for 'no' reply.
+    #
+    # @example
+    #   prompt = TTY::Prompt.new
+    #   prompt.no?('Are you alien?') # => true
+    #   # => Are you human? (y/N)
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def no?(message, *args, &block)
+      defaults = { default: false, type: :no }
+      options  = Utils.extract_options!(args)
+      options.merge!(defaults.reject { |k, _| options.key?(k) })
+
+      question = ConfirmQuestion.new(self, options)
+      !question.call(message, &block)
+    end
+
+    # Expand available options
+    #
+    # @example
+    #   prompt = TTY::Prompt.new
+    #   choices = [{
+    #     key: 'Y',
+    #     name: 'Overwrite',
+    #     value: :yes
+    #   }, {
+    #     key: 'n',
+    #     name: 'Skip',
+    #     value: :no
+    #   }]
+    #   prompt.expand('Overwirte Gemfile?', choices)
+    #
+    # @return [Object]
+    #   the user specified value
+    #
+    # @api public
+    def expand(message, *args, &block)
+      invoke_select(Expander, message, *args, &block)
     end
 
     # Ask a question with a range slider
@@ -253,20 +312,6 @@ module TTY
       slider.call(question, &block)
     end
 
-    # A shortcut method to ask the user negative question and return
-    # true for 'no' reply.
-    #
-    # @example
-    #   prompt = TTY::Prompt.new
-    #   prompt.no?('Are you alien? (y/N)') # => true
-    #
-    # @return [Boolean]
-    #
-    # @api public
-    def no?(question, *args, &block)
-      !yes?(question, *args, &block)
-    end
-
     # Print statement out. If the supplied message ends with a space or
     # tab character, a new line will not be appended.
     #
@@ -361,6 +406,22 @@ module TTY
       say(suggestion.suggest(message, possibilities))
     end
 
+    # Gathers more than one aswer
+    #
+    # @example
+    #   prompt.collect do
+    #     key(:name).ask('Name?')
+    #   end
+    #
+    # @return [Hash]
+    #   the collection of answers
+    #
+    # @api public
+    def collect(options = {}, &block)
+      collector = AnswersCollector.new(self, options)
+      collector.call(&block)
+    end
+
     # Check if outputing to terminal
     #
     # @return [Boolean]

data/lib/tty/prompt/answers_collector.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    class AnswersCollector
+      # Initialize answer collector
+      #
+      # @api public
+      def initialize(prompt, options = {})
+        @prompt  = prompt
+        @answers = options.fetch(:answers) { {} }
+      end
+
+      # Start gathering answers
+      #
+      # @return [Hash]
+      #   the collection of all answers
+      #
+      # @api public
+      def call(&block)
+        instance_eval(&block)
+        @answers
+      end
+
+      # Create answer entry
+      #
+      # @example
+      #   key(:name).ask('Name?')
+      #
+      # @api public
+      def key(name, &block)
+        @name = name
+        if block
+          answer = create_collector.(&block)
+          add_answer(answer)
+        end
+        self
+      end
+
+      # @api public
+      def create_collector
+        self.class.new(@prompt)
+      end
+
+      # @api public
+      def add_answer(answer)
+        @answers[@name] = answer
+      end
+
+      private
+
+      # @api private
+      def method_missing(method, *args, &block)
+        answer = @prompt.public_send(method, *args, &block)
+        add_answer(answer)
+      end
+    end # AnswersCollector
+  end # Prompt
+end # TTY

data/lib/tty/prompt/choice.rb

@@ -11,12 +11,15 @@ module TTY
       # @api public
       attr_reader :name
 
+      attr_reader :key
+
       # Create a Choice instance
       #
       # @api public
-      def initialize(name, value)
+      def initialize(name, value, key = nil)
         @name  = name
         @value = value
+        @key   = key
       end
 
       # Create choice from value
@@ -42,7 +45,11 @@ module TTY
         when Array
           new("#{val.first}", val.last)
         when Hash
-          new("#{val.keys.first}", val.values.first)
+          if val.key?(:name)
+            new("#{val[:name]}", val[:value], val[:key])
+          else
+            new("#{val.keys.first}", val.values.first)
+          end
         else
           raise ArgumentError, "#{val} cannot be coerced into Choice"
         end

data/lib/tty/prompt/choices.rb

@@ -85,7 +85,23 @@ module TTY
       #
       # @api public
       def pluck(name)
-        find { |choice| choice.name == name }
+        map { |choice| choice.public_send(name) }
+      end
+
+      # Find a matching choice
+      #
+      # @exmaple
+      #   choices.find_by(:name, 'small')
+      #
+      # @param [Symbol] attr
+      #   the attribute name
+      # @param [Object] value
+      #
+      # @return [Choice]
+      #
+      # @api public
+      def find_by(attr, value)
+        find { |choice| choice.public_send(attr) == value }
       end
     end # Choices
   end # Prompt

data/lib/tty/prompt/confirm_question.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    class ConfirmQuestion < Question
+      # Create confirmation question
+      #
+      # @param [Hash] options
+      # @option options [String] :suffix
+      # @option options [String] :positive
+      # @option options [String] :negative
+      #
+      # @api public
+      def initialize(prompt, options = {})
+        super
+
+        @suffix   = options.fetch(:suffix)   { UndefinedSetting }
+        @positive = options.fetch(:positive) { UndefinedSetting }
+        @negative = options.fetch(:negative) { UndefinedSetting }
+        @type     = options.fetch(:type)     { :yes }
+      end
+
+      def positive?
+        @positive != UndefinedSetting
+      end
+
+      def negative?
+        @negative != UndefinedSetting
+      end
+
+      def suffix?
+        @suffix != UndefinedSetting
+      end
+
+      # Set question suffix
+      #
+      # @api public
+      def suffix(value)
+        @suffix = value
+      end
+
+      # Set value for matching positive choice
+      #
+      # @api public
+      def positive(value)
+        @positive = value
+      end
+
+      # Set value for matching negative choice
+      #
+      # @api public
+      def negative(value)
+        @negative = value
+      end
+
+      def call(message, &block)
+        return if Utils.blank?(message)
+        @message = message
+        block.call(self) if block
+        setup_defaults
+        render
+      end
+
+      # Render confirmation question
+      #
+      # @api private
+      def render_question
+        header = "#{@prefix}#{message} "
+
+        if !@done
+          header += @prompt.decorate("(#{@suffix})", @help_color) + ' '
+        else
+          answer = convert_result(@input)
+          label  = answer ? @positive : @negative
+          header += @prompt.decorate(label, @active_color)
+        end
+        @prompt.print(header)
+        @prompt.print("\n") if @done
+      end
+
+      protected
+
+      # @api private
+      def is?(type)
+        @type == type
+      end
+
+      # @api private
+      def setup_defaults
+        return if suffix? && positive?
+
+        if suffix? && !positive?
+          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
+
+      def create_default_labels
+        if is?(:yes)
+          @suffix   = default? ? 'Y/n' : 'y/N'
+          @positive = default? ? 'Yes' : 'yes'
+          @negative = default? ? 'no' : 'No'
+        else
+          @suffix   = default? ? 'y/N' : 'Y/n'
+          @positive = default? ? 'Yes' : 'yes'
+          @negative = default? ? 'No'  : 'no'
+        end
+      end
+
+      # @api private
+      def create_suffix
+        result = ''
+        if is?(:yes)
+          result << "#{default? ? @positive.capitalize : @positive.downcase}"
+          result << '/'
+          result << "#{default? ? @negative.downcase : @negative.capitalize}"
+        else
+          result << "#{default? ? @positive.downcase : @positive.capitalize}"
+          result << '/'
+          result << "#{default? ? @negative.capitalize : @negative.downcase}"
+        end
+      end
+
+      # Create custom conversion
+      #
+      # @api private
+      def conversion
+        proc { |input| !input.match(/^#{@positive}|#{@positive[0]}$/i).nil? }
+      end
+    end # ConfirmQuestion
+  end # Prompt
+end # TTY