tty-prompt 0.1.0 → 0.2.0

data/lib/tty/prompt/question.rb

@@ -2,7 +2,6 @@
 
 require 'tty/prompt/question/modifier'
 require 'tty/prompt/question/validation'
-
 require 'tty/prompt/response_delegation'
 
 module TTY
@@ -12,23 +11,15 @@ module TTY
     class Question
       include ResponseDelegation
 
-      PREFIX          = ' + '
-      MULTIPLE_PREFIX = '   * '
-      ERROR_PREFIX    = '  ERROR:'
-
-      # Store statement.
-      #
-      # @api private
-      attr_accessor :statement
+      # Store question message
+      # @api public
+      attr_reader :message
 
       # Store default value.
       #
       # @api private
       attr_reader :default_value
 
-      attr_reader :required
-      private :required
-
       attr_reader :validation
 
       # Controls character processing of the answer
@@ -36,11 +27,6 @@ module TTY
       # @api public
       attr_reader :modifier
 
-      # Returns valid answers
-      #
-      # @api public
-      attr_reader :valid_values
-
       attr_reader :error
 
       # Returns character mode
@@ -49,14 +35,13 @@ module TTY
       attr_reader :character
 
       # @api private
-      attr_reader :shell
-      private :shell
+      attr_reader :prompt
 
       # Initialize a Question
       #
       # @api public
-      def initialize(shell, options = {})
-        @shell         = shell || Prompt.new
+      def initialize(prompt, options = {})
+        @prompt        = prompt || Prompt.new
         @required      = options.fetch(:required) { false }
         @echo          = options.fetch(:echo) { true }
         @raw           = options.fetch(:raw) { false }
@@ -64,33 +49,40 @@ module TTY
         @character     = options.fetch(:character) { false }
         @in            = options.fetch(:in) { false }
         @modifier      = Modifier.new options.fetch(:modifier) { [] }
-        @valid_values  = options.fetch(:valid) { [] }
-        @validation    = Validation.new options.fetch(:validation) { nil }
-        @default_value = nil
+        @validation    = Validation.new(options.fetch(:validation) { nil })
+        @default       = options.fetch(:default) { nil }
         @error         = false
         @converter     = Necromancer.new
+        @read          = options.fetch(:read) { nil }
       end
 
-      # Set a new prompt
+      # Call the quesiton
       #
       # @param [String] message
       #
       # @return [self]
       #
       # @api public
-      def prompt(message)
-        self.statement = message
-        shell.say shell.prefix + statement
-        self
+      def call(message, &block)
+        @message = message
+        block.call(self) if block
+        prompt.output.print("#{prompt.prefix}#{message}")
+        render
+      end
+
+      # Reader answer and convert to type
+      #
+      # @api private
+      def render
+        dispatch.read_type(@read)
       end
 
       # Set default value.
       #
       # @api public
       def default(value)
-        return self if value == ''
-        @default_value = value
-        self
+        return @default unless value
+        @default = value
       end
 
       # Check if default value is set
@@ -99,31 +91,16 @@ module TTY
       #
       # @api public
       def default?
-        !!@default_value
+        !!@default
       end
 
-      # Ensure that passed argument is present if required option
-      #
-      # @return [Question]
-      #
-      # @api public
-      def argument(value)
-        case value
-        when :required
-          @required = true
-        when :optional
-          @required = false
-        end
-        self
-      end
-
-      # Check if required argument present.
+      # Ensure that passed argument is present or not
       #
       # @return [Boolean]
       #
-      # @api private
-      def required?
-        required
+      # @api public
+      def required(value)
+        @required = value
       end
 
       # Set validation rule for an argument
@@ -135,29 +112,6 @@ module TTY
       # @api public
       def validate(value = nil, &block)
         @validation = Validation.new(value || block)
-        self
-      end
-
-      # Set expected values
-      #
-      # @param [Array] values
-      #
-      # @return [self]
-      #
-      # @api public
-      def valid(values)
-        @valid_values = values
-        self
-      end
-
-      # Reset question object.
-      #
-      # @api public
-      def clean
-        @statement     = nil
-        @default_value = nil
-        @required      = false
-        @modifier      = nil
       end
 
       # Modify string according to the rule given.
@@ -167,7 +121,6 @@ module TTY
       # @api public
       def modify(*rules)
         @modifier = Modifier.new(*rules)
-        self
       end
 
       # Setup behaviour when error(s) occur
@@ -175,7 +128,6 @@ module TTY
       # @api public
       def on_error(action = nil)
         @error = action
-        self
       end
 
       # Check if error behaviour is set
@@ -192,7 +144,6 @@ module TTY
       def echo(value = nil)
         return @echo if value.nil?
         @echo = value
-        self
       end
 
       # Chec if echo is set
@@ -208,7 +159,6 @@ module TTY
       def raw(value = nil)
         return @raw if value.nil?
         @raw = value
-        self
       end
 
       # Check if raw mode is set
@@ -228,7 +178,6 @@ module TTY
       def mask(char = nil)
         return @mask if char.nil?
         @mask = char
-        self
       end
 
       # Check if character mask is set
@@ -250,7 +199,6 @@ module TTY
       def char(value = nil)
         return @character if value.nil?
         @character = value
-        self
       end
 
       # Check if character intput is set
@@ -270,7 +218,6 @@ module TTY
       def in(value = nil)
         return @in if value.nil?
         @in = @converter.convert(value).to(:range, strict: true)
-        self
       end
 
       # Check if range is set
@@ -289,15 +236,32 @@ module TTY
       # @return [Object]
       #
       # @api private
-      def evaluate_response(value)
-        return default_value if !value && default?
-        check_required(value)
-        return if value.nil?
-
-        check_valid(value) unless valid_values.empty?
-        within?(value)
-        validation.valid_value?(value)
-        modifier.apply_to(value)
+      def evaluate_response(input)
+        return @default if !input && default?
+        check_required(input)
+        return if input.nil?
+
+        within?(input)
+        validation.(input)
+        modifier.apply_to(input)
+      end
+
+      # Reset question object.
+      #
+      # @api public
+      def clean
+        @message  = nil
+        @default  = nil
+        @required = false
+        @modifier = nil
+      end
+
+      def to_s
+        "#{message}"
+      end
+
+      def inspect
+        "#<Question @message=#{message}>"
       end
 
       private
@@ -306,31 +270,18 @@ module TTY
       #
       # @api private
       def check_required(value)
-        if required? && !default? && value.nil?
+        if @required && !default? && value.nil?
           fail ArgumentRequired, 'No value provided for required'
         end
       end
 
-      # Check if value matches any of the expected values
-      #
-      # @api private
-      def check_valid(value)
-        if Array(value).all? { |val| valid_values.include? val }
-          return value
-        else
-          fail InvalidArgument, "Valid values are: #{valid_values.join(', ')}"
-        end
-      end
-
       # Check if value is within expected range
       #
       # @api private
       def within?(value)
         if in? && value
-          if @in.include?(value)
-          else
-            fail InvalidArgument, "Value #{value} is not included in the range #{@in}"
-          end
+          @in.include?(value) || fail(InvalidArgument,
+            "Value #{value} is not included in the range #{@in}")
         end
       end
     end # Question

data/lib/tty/prompt/reader.rb

@@ -6,8 +6,8 @@ module TTY
     # A class responsible for reading character input from STDIN
     class Reader
       # @api private
-      attr_reader :shell
-      private :shell
+      attr_reader :prompt
+      private :prompt
 
       attr_reader :mode
 
@@ -20,8 +20,8 @@ module TTY
       # Initialize a Reader
       #
       # @api public
-      def initialize(shell = Prompt.new)
-        @shell = shell
+      def initialize(prompt = Prompt.new)
+        @prompt = prompt
         @mode  = Mode.new
       end
 
@@ -36,16 +36,49 @@ module TTY
       #
       # @api public
       def buffer(&block)
-        bufferring = shell.output.sync
+        bufferring = prompt.output.sync
         # Immediately flush output
-        shell.output.sync = true
+        prompt.output.sync = true
 
         value = block.call if block_given?
 
-        shell.output.sync = bufferring
+        prompt.output.sync = bufferring
         value
       end
 
+      # Read a single keypress that may include
+      # 2 or 3 escape characters.
+      #
+      # @return [String]
+      #
+      # @api public
+      def read_keypress
+        buffer do
+          mode.echo(false) do
+            mode.raw(true) do
+              read_char
+            end
+          end
+        end
+      end
+
+      # Reads single character including invisible multibyte codes
+      #
+      # @return [String]
+      #
+      # @api public
+      def read_char
+        chars = prompt.input.getc.chr
+        if chars == "\e"
+          chars = prompt.input.read_nonblock(3) rescue chars
+          chars = prompt.input.read_nonblock(2) rescue chars
+          chars = "\e" + chars
+        end
+        chars
+      rescue
+        chars
+      end
+
       # Get a value from STDIN one key at a time. Each key press is echoed back
       # to the shell masked with character(if given). The input finishes when
       # enter key is pressed.
@@ -60,7 +93,7 @@ module TTY
         value = ''
         buffer do
           begin
-            while (char = shell.input.getbyte) &&
+            while (char = prompt.input.getbyte) &&
                 !(char == CARRIAGE_RETURN || char == NEWLINE)
               value = handle_char value, char, not_set, mask
             end
@@ -75,7 +108,7 @@ module TTY
       #
       # @api public
       def gets
-        shell.input.gets
+        prompt.input.gets
       end
 
       # Reads at maximum +maxlen+ characters.
@@ -84,7 +117,7 @@ module TTY
       #
       # @api public
       def readpartial(maxlen)
-        shell.input.readpartial(maxlen)
+        prompt.input.readpartial(maxlen)
       end
 
       private
@@ -106,7 +139,7 @@ module TTY
       #
       # @api private
       def print_char(char, not_set, mask)
-        shell.output.putc((not_set || !mask) ? char : mask)
+        prompt.output.putc((not_set || !mask) ? char : mask)
       end
     end # Reader
   end # Prompt

data/lib/tty/prompt/response.rb

@@ -5,16 +5,6 @@ module TTY
   class Prompt
     # A class representing a shell response
     class Response
-      VALID_TYPES = [
-        :boolean,
-        :string,
-        :symbol,
-        :integer,
-        :float,
-        :date,
-        :datetime
-      ]
-
       attr_reader :reader
       private :reader
 
@@ -24,11 +14,11 @@ module TTY
       # Initialize a Response
       #
       # @api public
-      def initialize(question, shell = Shell.new)
+      def initialize(question, prompt)
         @question  = question
-        @shell     = shell
+        @prompt    = prompt
         @converter = Necromancer.new
-        @reader    = Reader.new(@shell)
+        @reader    = Reader.new(@prompt)
       end
 
       # Read input from STDIN either character or line
@@ -109,14 +99,6 @@ module TTY
         evaluate_response { |input| input.to_sym }
       end
 
-      # Read answer from predifined choicse
-      #
-      # @api public
-      def read_choice(type = nil)
-        question.argument(:required) unless question.default?
-        evaluate_response
-      end
-
       # Read integer value
       #
       # @api public
@@ -180,14 +162,14 @@ module TTY
       # @api public
       def read_email
         question.validate(/^[a-z0-9._%+-]+@([a-z0-9-]+\.)+[a-z]{2,6}$/i)
-        question.prompt(question.statement) if question.error
+        question.call("\n" + question.statement) if question.error?
         with_exception { read_string }
       end
 
       # Read answer provided on multiple lines
       #
       # @api public
-      def read_multiple
+      def read_multiline
         response = ''
         loop do
           value = evaluate_response
@@ -217,8 +199,6 @@ module TTY
         end
       end
 
-      private
-
       # Ignore exception
       #
       # @api private
@@ -232,21 +212,36 @@ module TTY
       #   :boolean, :string, :numeric, :array
       #
       # @api private
-      def read_type(class_or_name)
-        raise TypeError, "Type #{type} is not valid" if type && !valid_type?(type)
-        case type
-        when :string, ::String
+      def read_type(class_or_name = nil)
+        case class_or_name
+        when :bool
+          read_bool
+        when :email
+          read_email
+        when :char
+          read_char
+        when :date
+          read_date
+        when :int
+          read_int
+        when :range
+          read_range
+        when :multiline
+          read_multiline
+        when :float
+          read_float
+        when :file
+          read_file
+        when :string
           read_string
-        when :symbol, ::Symbol
+        when :symbol
           read_symbol
-        when :float, ::Float
-          read_float
+        when :keypress
+          read_keypress
+        else
+          read
         end
       end
-
-      def valid_type?(type)
-        self.class::VALID_TYPES.include? type.to_sym
-      end
     end # Response
   end # Prompt
 end # TTY

data/lib/tty/prompt/response_delegation.rb

@@ -25,14 +25,15 @@ module TTY
                                 :read_regex,
                                 :read_string,
                                 :read_symbol,
-                                :read_text
+                                :read_text,
+                                :read_type
 
       # Create response instance when question readed is invoked
       #
       # @param [Response] response
       #
       # @api private
-      def dispatch(response = Response.new(self, shell))
+      def dispatch(response = Response.new(self, prompt))
         @response ||= response
       end
 

data/lib/tty/prompt/statement.rb

@@ -3,11 +3,11 @@
 module TTY
   # A class responsible for shell prompt interactions.
   class Prompt
-    # A class representing a statement output to shell.
+    # A class representing a statement output to prompt.
     class Statement
       # @api private
-      attr_reader :shell
-      private :shell
+      attr_reader :prompt
+      private :prompt
 
       # Flag to display newline
       #
@@ -21,7 +21,7 @@ module TTY
 
       # Initialize a Statement
       #
-      # @param [TTY::Shell] shell
+      # @param [TTY::Prompt] prompt
       #
       # @param [Hash] options
       #
@@ -32,14 +32,14 @@ module TTY
       #   change the message display to color
       #
       # @api public
-      def initialize(shell = Prompt.new, options = {})
-        @shell   = shell
+      def initialize(prompt = Prompt.new, options = {})
+        @prompt   = prompt
         @pastel  = Pastel.new
         @newline = options.fetch(:newline, true)
         @color   = options.fetch(:color, false)
       end
 
-      # Output the message to the shell
+      # Output the message to the prompt
       #
       # @param [String] message
       #   the message to be printed to stdout
@@ -49,10 +49,10 @@ module TTY
         message = @pastel.decorate message, *color if color
 
         if newline && /( |\t)(\e\[\d+(;\d+)*m)?\Z/ !~ message
-          shell.output.puts message
+          prompt.output.puts message
         else
-          shell.output.print message
-          shell.output.flush
+          prompt.output.print message
+          prompt.output.flush
         end
       end
     end # Statement

data/lib/tty/prompt/test.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'tty/prompt'
+
+module TTY
+  # Used for initializing test cases
+  class TestPrompt < Prompt
+    def initialize(options = {})
+      @input  = StringIO.new
+      @output = StringIO.new
+
+      super(@input, @output, options)
+    end
+  end # TestPrompt
+end # TTY

data/lib/tty/prompt/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Prompt
-    VERSION = "0.1.0"
-  end
-end
+    VERSION = "0.2.0"
+  end # Prompt
+end # TTY