tty-prompt 0.2.0 → 0.3.0

data/examples/ask.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+prompt.ask('What is your name?', default: ENV['USER'])

data/examples/echo.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+puts prompt.ask('Password?', echo: false)

data/examples/in.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+prompt.ask('How do you like it on scale 1 - 10?', in: '1-10')

data/examples/mask.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+prompt.mask('What is your secret?') do |q|
+  q.validate /[a-z]{5,8}/
+end

data/examples/multi_select.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+drinks = %w(vodka beer wine whisky bourbon)
+prompt.multi_select('Choose your favourite drink?', drinks)

data/examples/select.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+warriors = %w(Scorpion Kano Jax)
+prompt.select('Choose your destiny?', warriors)

data/examples/validation.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+prompt.ask('What is your username?') do |q|
+  q.validate(/^[^\.]+\.[^\.]+/)
+end

data/examples/yes_no.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'tty-prompt'
+
+prompt = TTY::Prompt.new
+
+prompt.yes?('Do you like Ruby?')

data/lib/tty-prompt.rb

@@ -2,25 +2,27 @@
 
 require 'necromancer'
 require 'pastel'
+require 'tty-cursor'
 require 'tty-platform'
 
 require 'tty/prompt'
 require 'tty/prompt/choice'
 require 'tty/prompt/choices'
-require 'tty/prompt/codes'
-require 'tty/prompt/cursor'
+require 'tty/prompt/evaluator'
 require 'tty/prompt/list'
 require 'tty/prompt/multi_list'
-require 'tty/prompt/mode'
 require 'tty/prompt/question'
+require 'tty/prompt/mask_question'
 require 'tty/prompt/reader'
-require 'tty/prompt/response'
 require 'tty/prompt/statement'
 require 'tty/prompt/suggestion'
+require 'tty/prompt/symbols'
 require 'tty/prompt/test'
 require 'tty/prompt/utils'
 require 'tty/prompt/version'
 
+# A collection of small libraries for building CLI apps,
+# each following unix philosophy of focused task
 module TTY
   PromptConfigurationError = Class.new(StandardError)
 end

data/lib/tty/prompt.rb

@@ -1,7 +1,12 @@
 # encoding: utf-8
 
+require 'forwardable'
+
 module TTY
+  # A main entry for asking prompt questions.
   class Prompt
+    extend Forwardable
+
     # Raised when the passed in validation argument is of wrong type
     class ValidationCoercion < TypeError; end
 
@@ -20,35 +25,54 @@ module TTY
     # @api private
     attr_reader :output
 
+    attr_reader :reader
+
+    attr_reader :cursor
+
     # Prompt prefix
     #
     # @api private
     attr_reader :prefix
 
+    def_delegators :@pastel, :decorate
+
+    def_delegators :@cursor, :clear_lines, :clear_line,
+                   :show, :hide
+
+    def_delegators :@reader, :read_line, :read_keypress,
+                   :read_multiline, :on, :subscribe
+
+    def_delegators :@output, :print, :puts, :flush
+
     # Initialize a Prompt
     #
     # @api public
-    def initialize(input = stdin, output = stdout, options = {})
-      @input  = input
-      @output = output
+    def initialize(*args)
+      options = Utils.extract_options!(args)
+      @input  = options.fetch(:input) { $stdin }
+      @output = options.fetch(:output) { $stdout }
       @prefix = options.fetch(:prefix) { '' }
+
+      @cursor = TTY::Cursor
+      @pastel = Pastel.new
+      @reader = Reader.new(@input, @output)
     end
 
     # Ask a question.
     #
     # @example
-    #   shell = TTY::Prompt.new
-    #   shell.ask("What is your name?")
+    #   propmt = TTY::Prompt.new
+    #   prompt.ask("What is your name?")
     #
-    # @param [String] statement
-    #   string question to be asked
+    # @param [String] message
+    #   the question to be asked
     #
-    # @yieldparam [TTY::Question] question
+    # @yieldparam [TTY::Prompt::Question] question
     #   further configure the question
     #
     # @yield [question]
     #
-    # @return [TTY::Question]
+    # @return [TTY::Prompt::Question]
     #
     # @api public
     def ask(message, *args, &block)
@@ -58,6 +82,46 @@ module TTY
       question.call(message, &block)
     end
 
+    # Ask a question with a keypress answer
+    #
+    # @see #ask
+    #
+    # @api public
+    def keypress(message, *args, &block)
+      options = Utils.extract_options!(args)
+      options.merge!(read: :keypress)
+      args << options
+      ask(message, *args, &block)
+    end
+
+    # Ask a question with a multiline answer
+    #
+    # @see @ask
+    #
+    # @api public
+    def multiline(message, *args, &block)
+      options = Utils.extract_options!(args)
+      options.merge!(read: :multiline)
+      args << options
+      ask(message, *args, &block)
+    end
+
+    # Ask masked question
+    #
+    # @example
+    #   propmt = TTY::Prompt.new
+    #   prompt.mask("What is your secret?")
+    #
+    # @return [TTY::Prompt::MaskQuestion]
+    #
+    # @api public
+    def mask(message, *args, &block)
+      options = Utils.extract_options!(args)
+
+      question = MaskQuestion.new(self, options)
+      question.call(message, &block)
+    end
+
     # Ask a question with a list of options
     #
     # @example
@@ -125,28 +189,39 @@ module TTY
     # A shortcut method to ask the user positive question and return
     # true for 'yes' reply, false for 'no'.
     #
+    # @example
+    #   prompt = TTY::Prompt.new
+    #   prompt.yes?('Are you human? (Y/n)') # => true
+    #
     # @return [Boolean]
     #
     # @api public
-    def yes?(statement, *args, &block)
-      ask(statement, {read: :bool}, &block)
+    def yes?(question, *args, &block)
+      options = Utils.extract_options!(args)
+      options.merge!(convert: :bool)
+      args << options
+      ask(question, *args, &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?(statement, *args, &block)
-      !yes?(statement, *args, &block)
+    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.
     #
     # @example
-    #   say("Simple things.")
+    #   say("Simple things.", color: :red)
     #
     # @param [String] message
     #
@@ -154,25 +229,25 @@ module TTY
     #
     # @api public
     def say(message = '', options = {})
-      message = message.to_str
+      message = message.to_s
       return unless message.length > 0
 
       statement = Statement.new(self, options)
-      statement.declare message
+      statement.call(message)
     end
 
     # Print statement(s) out in red green.
     #
     # @example
-    #   shell.confirm "Are you sure?"
-    #   shell.confirm "All is fine!", "This is fine too."
+    #   prompt.ok "Are you sure?"
+    #   prompt.ok "All is fine!", "This is fine too."
     #
     # @param [Array] messages
     #
     # @return [Array] messages
     #
     # @api public
-    def confirm(*args)
+    def ok(*args)
       options = Utils.extract_options!(args)
       args.each { |message| say message, options.merge(color: :green) }
     end
@@ -180,8 +255,8 @@ module TTY
     # Print statement(s) out in yellow color.
     #
     # @example
-    #   shell.warn "This action can have dire consequences"
-    #   shell.warn "Carefull young apprentice", "This is potentially dangerous"
+    #   prompt.warn "This action can have dire consequences"
+    #   prompt.warn "Carefull young apprentice", "This is potentially dangerous"
     #
     # @param [Array] messages
     #
@@ -196,8 +271,8 @@ module TTY
     # Print statement(s) out in red color.
     #
     # @example
-    #   shell.error "Shutting down all systems!"
-    #   shell.error "Nothing is fine!", "All is broken!"
+    #   prompt.error "Shutting down all systems!"
+    #   prompt.error "Nothing is fine!", "All is broken!"
     #
     # @param [Array] messages
     #
@@ -213,7 +288,7 @@ module TTY
     # matches to suggest an unambigous string
     #
     # @example
-    #   shell.suggest('sta', ['status', 'stage', 'commit', 'branch'])
+    #   prompt.suggest('sta', ['status', 'stage', 'commit', 'branch'])
     #   # => "status, stage"
     #
     # @param [String] message
@@ -236,7 +311,7 @@ module TTY
       say(suggestion.suggest(message, possibilities))
     end
 
-    # Check if outputing to shell
+    # Check if outputing to terminal
     #
     # @return [Boolean]
     #

data/lib/tty/prompt/choice.rb

@@ -36,7 +36,7 @@ module TTY
       def self.from(val)
         case val
         when Choice
-          return val
+          val
         when String, Symbol
           new(val, val)
         when Array

data/lib/tty/prompt/converter_dsl.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'tty/prompt/converter_registry'
+
+module TTY
+  class Prompt
+    module ConverterDSL
+      def self.extended(base)
+        attr_reader :converter_registry
+
+        base.instance_variable_set(:@converter_registry, ConverterRegistry.new)
+      end
+
+      def converter(name, &block)
+        converter_registry.register(name, &block)
+      end
+    end # ConverterDSL
+  end # Prompt
+end # TTY

data/lib/tty/prompt/converter_registry.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    class ConverterRegistry
+      def initialize
+        @_registry = {}
+      end
+
+      # Register converter
+      #
+      # @api public
+      def register(key, contents = nil, &block)
+        if block_given?
+          item = block
+        else
+          item = contents
+        end
+
+        if key?(key)
+          fail ArgumentError, "Converter for #{key.inspect} already registered"
+        else
+          @_registry[key] = item
+        end
+        self
+      end
+
+      # Check if converter is registered
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def key?(key)
+        @_registry.key?(key)
+      end
+
+      # Execute converter
+      #
+      # @api public
+      def call(key, input)
+        if key.respond_to?(:call)
+          converter = key
+        else
+          converter = @_registry.fetch(key) do
+            fail ArgumentError, "#{key.inspect} is not registered"
+          end
+        end
+        converter.call(input)
+      end
+
+      def inspect
+        @_registry.inspect
+      end
+    end # ConverterRegistry
+  end # Prompt
+end # TTY

data/lib/tty/prompt/converters.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+require 'pathname'
+require 'necromancer'
+require 'tty/prompt/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
+
+      converter(:bool) do |input|
+        converter = Necromancer.new
+        converter.convert(input).to(:boolean, strict: true)
+      end
+
+      converter(:string) do |input|
+        String(input).chomp
+      end
+
+      converter(:symbol) do |input|
+        input.to_sym
+      end
+
+      converter(:date) do |input|
+        converter = Necromancer.new
+        converter.convert(input).to(:date)
+      end
+
+      converter(:datetime) do |input|
+        converter = Necromancer.new
+        converter.convert(input).to(:datetime)
+      end
+
+      converter(:int) do |input|
+        converter = Necromancer.new
+        converter.convert(input).to(:integer)
+      end
+
+      converter(:float) do |input|
+        converter = Necromancer.new
+        converter.convert(input).to(:float)
+      end
+
+      converter(:range) do |input|
+        converter = Necromancer.new
+        converter.convert(input).to(:range, strict: true)
+      end
+
+      converter(:regexp) do |input|
+        Regexp.new(input)
+      end
+
+      converter(:file) do |input|
+        directory = File.expand_path(File.dirname($0))
+        File.open(File.join(directory, input))
+      end
+
+      converter(:path) do |input|
+        directory = File.expand_path(File.dirname($0))
+        Pathname.new(File.join(directory, input))
+      end
+
+      converter(:char) do |input|
+        String(input).chars.to_a[0]
+      end
+    end # Converters
+  end # Prompt
+end # TTY