tty 0.2.1 → 0.3.0

data/lib/tty/shell/distance.rb

@@ -1,49 +0,0 @@
-# encoding: utf-8
-
-module TTY
-  class Shell
-    # 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 # Text
-end # TTY

data/lib/tty/shell/question.rb

@@ -1,335 +0,0 @@
-# encoding: utf-8
-
-require 'date'
-
-module TTY
-  # A class responsible for shell prompt interactions.
-  class Shell
-    # A class representing a command line question
-    class Question
-      include TTY::Shell::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 || Shell.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 # Shell
-end # TTY

data/lib/tty/shell/question/modifier.rb

@@ -1,93 +0,0 @@
-# encoding: utf-8
-
-module TTY
-  class Shell
-    class Question
-      # A class representing String modifications.
-      class Modifier
-        attr_reader :modifiers
-        private :modifiers
-
-        # Initialize a Modifier
-        #
-        # @api public
-        def initialize(*modifiers)
-          @modifiers = Array(modifiers)
-        end
-
-        # Change supplied value according to the given string transformation.
-        # Valid settings are:
-        #
-        # @param [String] value
-        #   the string to be modified
-        #
-        # @return [String]
-        #
-        # @api private
-        def apply_to(value)
-          modifiers.reduce(value) do |result, mod|
-            result = Modifier.letter_case mod, result
-            Modifier.whitespace mod, result
-          end
-        end
-
-        # Changes letter casing in a string according to valid modifications.
-        # For invalid modification option the string is preserved.
-        #
-        # @param [Symbol] mod
-        #  the modification to change the string
-        #
-        # @option mod [Symbol] :up        change to upper case
-        # @option mod [Symbol] :upcase    change to upper case
-        # @option mod [Symbol] :uppercase change to upper case
-        # @option mod [Symbol] :down      change to lower case
-        # @option mod [Symbol] :downcase  change to lower case
-        # @option mod [Symbol] :capitalize change all words to start
-        #                                  with uppercase case letter
-        #
-        # @return [String]
-        #
-        # @api public
-        def self.letter_case(mod, value)
-          case mod
-          when :up, :upcase, :uppercase
-            value.upcase
-          when :down, :downcase, :lowercase
-            value.downcase
-          when :capitalize
-            value.capitalize
-          else
-            value
-          end
-        end
-
-        # Changes whitespace in a string according to valid modifications.
-        #
-        # @param [Symbol] mod
-        #   the modification to change the string
-        #
-        # @option mod [String] :trim, :strip
-        #   remove whitespace for the start and end
-        # @option mod [String] :chomp     remove record separator from the end
-        # @option mod [String] :collapse  remove any duplicate whitespace
-        # @option mod [String] :remove    remove all whitespace
-        #
-        # @api public
-        def self.whitespace(mod, value)
-          case mod
-          when :trim, :strip
-            value.strip
-          when :chomp
-            value.chomp
-          when :collapse
-            value.gsub(/\s+/, ' ')
-          when :remove
-            value.gsub(/\s+/, '')
-          else
-            value
-          end
-        end
-      end # Modifier
-    end # Question
-  end # Shell
-end # TTY