tty-prompt 0.1.0

data/lib/tty/prompt/distance.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    # A class responsible for string comparison
+    class Distance
+      # Calculate the optimal string alignment distance
+      #
+      # @api public
+      def distance(first, second)
+        distances = []
+        rows      = first.to_s.length
+        cols      = second.to_s.length
+
+        0.upto(rows) do |index|
+          distances << [index] + [0] * cols
+        end
+        distances[0] = 0.upto(cols).to_a
+
+        1.upto(rows) do |first_index|
+          1.upto(cols) do |second_index|
+            first_char  = first[first_index - 1]
+            second_char = second[second_index - 1]
+            cost        = first_char == second_char ? 0 : 1
+
+            distances[first_index][second_index] = [
+              distances[first_index - 1][second_index], # deletion
+              distances[first_index][second_index - 1],     # insertion
+              distances[first_index - 1][second_index - 1]  # substitution
+            ].min + cost
+
+            if first_index > 1 && second_index > 1
+              first_previous_char = first[first_index - 2]
+              second_previous_char = second[second_index - 2]
+              if first_char == second_previous_char && second_char == first_previous_char
+                distances[first_index][second_index] = [
+                  distances[first_index][second_index],
+                  distances[first_index - 2][second_index - 2] + 1 # transposition
+                ].min
+              end
+            end
+
+          end
+        end
+        distances[rows][cols]
+      end
+    end # Distance
+  end # Prompt
+end # TTY

data/lib/tty/prompt/error.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+class Error
+
+  attr_reader :errors
+
+  def initialize(question, errors=[])
+    @question = question
+    @errors = errors
+  end
+
+  def <<(type, message)
+    @errors << [type, message]
+  end
+
+
+  # Handle exception
+  #
+  # @api private
+  def error_wrapping(&block)
+    yield
+  rescue
+    question.error? ? block.call : raise
+  end
+
+end # Error

data/lib/tty/prompt/history.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+     # A class responsible for storing shell interactions
+     class History
+
+       attr_reader :max_size
+
+       def initialize(max_size=nil)
+         @max_size = max_size
+       end
+
+    end # History
+  end # Prompt
+end # TTY

data/lib/tty/prompt/mode.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+require 'tty/prompt/mode/echo'
+require 'tty/prompt/mode/raw'
+
+module TTY
+  class Prompt
+    class Mode
+      # Initialize a Terminal
+      #
+      # @api public
+      def initialize(options = {})
+        @echo  = TTY::Prompt::Mode::Echo.new
+        @raw   = TTY::Prompt::Mode::Raw.new
+      end
+
+      # Switch echo on
+      #
+      # @api public
+      def echo_on
+        @echo.on
+      end
+
+      # Switch echo off
+      #
+      # @api public
+      def echo_off
+        @echo.off
+      end
+
+      # Echo given block
+      #
+      # @param [Boolean] is_on
+      #
+      # @api public
+      def echo(is_on = true, &block)
+        @echo.echo(is_on, &block)
+      end
+
+      # Switch raw mode on
+      #
+      # @api public
+      def raw_on
+        @raw.on
+      end
+
+      # Switch raw mode off
+      #
+      # @api public
+      def raw_off
+        @raw.off
+      end
+
+      # Use raw mode in the given block
+      #
+      # @param [Boolean] is_on
+      #
+      # @api public
+      def raw(is_on = true, &block)
+        @raw.raw(is_on, &block)
+      end
+    end # Mode
+  end # Prompt
+end # TTY

data/lib/tty/prompt/mode/echo.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    class Mode
+      # A class responsible for toggling echo.
+      class Echo
+        # Turn echo on
+        #
+        # @api public
+        def on
+          %x{stty echo} if TTY::Platform.unix?
+        end
+
+        # Turn echo off
+        #
+        # @api public
+        def off
+          %x{stty -echo} if TTY::Platform.unix?
+        end
+
+        # Wrap code block inside echo
+        #
+        # @api public
+        def echo(is_on=true, &block)
+          value = nil
+          begin
+            off unless is_on
+            value = block.call if block_given?
+            on
+            return value
+          rescue NoMethodError, Interrupt
+            on
+            exit
+          end
+        end
+      end # Echo
+    end # Mode
+  end # Prompt
+end # TTY

data/lib/tty/prompt/mode/raw.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    class Mode
+      # A class responsible for toggling raw mode.
+      class Raw
+        # Turn raw mode on
+        #
+        # @api public
+        def on
+          %x{stty raw} if TTY::Platform.unix?
+        end
+
+        # Turn raw mode off
+        #
+        # @api public
+        def off
+          %x{stty -raw} if TTY::Platform.unix?
+        end
+
+        # Wrap code block inside raw mode
+        #
+        # @api public
+        def raw(is_on=true, &block)
+          value = nil
+          begin
+            on if is_on
+            value = block.call if block_given?
+            off
+            return value
+          rescue NoMethodError, Interrupt
+            off
+            exit
+          end
+        end
+      end # Raw
+    end # Mode
+  end # Prompt
+end # TTY

data/lib/tty/prompt/question.rb

@@ -0,0 +1,338 @@
+# encoding: utf-8
+
+require 'tty/prompt/question/modifier'
+require 'tty/prompt/question/validation'
+
+require 'tty/prompt/response_delegation'
+
+module TTY
+  # A class responsible for shell prompt interactions.
+  class Prompt
+    # A class representing a command line question
+    class Question
+      include ResponseDelegation
+
+      PREFIX          = ' + '
+      MULTIPLE_PREFIX = '   * '
+      ERROR_PREFIX    = '  ERROR:'
+
+      # Store statement.
+      #
+      # @api private
+      attr_accessor :statement
+
+      # Store default value.
+      #
+      # @api private
+      attr_reader :default_value
+
+      attr_reader :required
+      private :required
+
+      attr_reader :validation
+
+      # Controls character processing of the answer
+      #
+      # @api public
+      attr_reader :modifier
+
+      # Returns valid answers
+      #
+      # @api public
+      attr_reader :valid_values
+
+      attr_reader :error
+
+      # Returns character mode
+      #
+      # @api public
+      attr_reader :character
+
+      # @api private
+      attr_reader :shell
+      private :shell
+
+      # Initialize a Question
+      #
+      # @api public
+      def initialize(shell, options = {})
+        @shell         = shell || Prompt.new
+        @required      = options.fetch(:required) { false }
+        @echo          = options.fetch(:echo) { true }
+        @raw           = options.fetch(:raw) { false }
+        @mask          = options.fetch(:mask) { false  }
+        @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
+        @error         = false
+        @converter     = Necromancer.new
+      end
+
+      # Set a new prompt
+      #
+      # @param [String] message
+      #
+      # @return [self]
+      #
+      # @api public
+      def prompt(message)
+        self.statement = message
+        shell.say shell.prefix + statement
+        self
+      end
+
+      # Set default value.
+      #
+      # @api public
+      def default(value)
+        return self if value == ''
+        @default_value = value
+        self
+      end
+
+      # Check if default value is set
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def default?
+        !!@default_value
+      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.
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def required?
+        required
+      end
+
+      # Set validation rule for an argument
+      #
+      # @param [Object] value
+      #
+      # @return [Question]
+      #
+      # @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.
+      #
+      # @param [Symbol] rule
+      #
+      # @api public
+      def modify(*rules)
+        @modifier = Modifier.new(*rules)
+        self
+      end
+
+      # Setup behaviour when error(s) occur
+      #
+      # @api public
+      def on_error(action = nil)
+        @error = action
+        self
+      end
+
+      # Check if error behaviour is set
+      #
+      # @api public
+      def error?
+        !!@error
+      end
+
+      # Turn terminal echo on or off. This is used to secure the display so
+      # that the entered characters are not echoed back to the screen.
+      #
+      # @api public
+      def echo(value = nil)
+        return @echo if value.nil?
+        @echo = value
+        self
+      end
+
+      # Chec if echo is set
+      #
+      # @api public
+      def echo?
+        !!@echo
+      end
+
+      # Turn raw mode on or off. This enables character-based input.
+      #
+      # @api public
+      def raw(value = nil)
+        return @raw if value.nil?
+        @raw = value
+        self
+      end
+
+      # Check if raw mode is set
+      #
+      # @api public
+      def raw?
+        !!@raw
+      end
+
+      # Set character for masking the STDIN input
+      #
+      # @param [String] character
+      #
+      # @return [self]
+      #
+      # @api public
+      def mask(char = nil)
+        return @mask if char.nil?
+        @mask = char
+        self
+      end
+
+      # Check if character mask is set
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def mask?
+        !!@mask
+      end
+
+      # Set if the input is character based or not
+      #
+      # @param [Boolean] value
+      #
+      # @return [self]
+      #
+      # @api public
+      def char(value = nil)
+        return @character if value.nil?
+        @character = value
+        self
+      end
+
+      # Check if character intput is set
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def character?
+        !!@character
+      end
+
+      # Set expect range of values
+      #
+      # @param [String] value
+      #
+      # @api public
+      def in(value = nil)
+        return @in if value.nil?
+        @in = @converter.convert(value).to(:range, strict: true)
+        self
+      end
+
+      # Check if range is set
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def in?
+        !!@in
+      end
+
+      # Check if response matches all the requirements set by the question
+      #
+      # @param [Object] value
+      #
+      # @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)
+      end
+
+      private
+
+      # Check if value is present
+      #
+      # @api private
+      def check_required(value)
+        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
+        end
+      end
+    end # Question
+  end # Prompt
+end # TTY