tty 0.0.11 → 0.1.0

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

@@ -1,12 +1,10 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Shell
     class Question
-
       # A class representing String modifications.
       class Modifier
-
         attr_reader :modifiers
         private :modifiers
 
@@ -27,9 +25,9 @@ module TTY
         #
         # @api private
         def apply_to(value)
-          modifiers.inject(value) do |result, mod|
+          modifiers.reduce(value) do |result, mod|
             result = Modifier.letter_case mod, result
-            result = Modifier.whitespace mod, result
+            Modifier.whitespace mod, result
           end
         end
 
@@ -44,7 +42,8 @@ module TTY
         # @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
+        # @option mod [Symbol] :capitalize change all words to start
+        #                                  with uppercase case letter
         #
         # @return [String]
         #
@@ -88,9 +87,7 @@ module TTY
             value
           end
         end
-
       end # Modifier
-
     end # Question
   end # Shell
 end # TTY

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

@@ -1,12 +1,10 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Shell
     class Question
-
       # A class representing question validation.
       class Validation
-
         # @api private
         attr_reader :validation
         private :validation
@@ -18,7 +16,7 @@ module TTY
         # @return [undefined]
         #
         # @api private
-        def initialize(validation=nil)
+        def initialize(validation = nil)
           @validation = validation ? coerce(validation) : validation
         end
 
@@ -36,7 +34,7 @@ module TTY
           when Regexp, String
             Regexp.new(validation.to_s)
           else
-            raise TTY::ValidationCoercion, "Wrong type, got #{validation.class}"
+            fail TTY::ValidationCoercion, "Wrong type, got #{validation.class}"
           end
         end
 
@@ -80,11 +78,14 @@ module TTY
             value = value.to_s
             if validation.is_a?(Regexp) && validation =~ value
             elsif validation.is_a?(Proc) && validation.call(value)
-            else raise TTY::InvalidArgument, "Invalid input for #{value}"
+            else
+              fail TTY::InvalidArgument, "Invalid input for #{value}"
             end
+            true
+          else
+            false
           end
         end
-
       end # Validation
     end # Question
   end # Shell

data/lib/tty/shell/reader.rb

@@ -1,11 +1,10 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
+  # A class responsible for shell prompt interactions.
   class Shell
-
     # A class responsible for reading character input from STDIN
     class Reader
-
       # @api private
       attr_reader :shell
       private :shell
@@ -19,14 +18,20 @@ module TTY
       # Initialize a Reader
       #
       # @api public
-      def initialize(shell=nil)
-        @shell = shell || Shell.new
+      def initialize(shell = Shell.new)
+        @shell = shell
       end
 
       # Get input in unbuffered mode.
       #
+      # @example
+      #   buffer do
+      #     ...
+      #   end
+      #
+      # @return [String]
       #
-      # @api bublic
+      # @api public
       def buffer(&block)
         bufferring = shell.output.sync
         # Immediately flush output
@@ -48,26 +53,18 @@ module TTY
       # @return [String]
       #
       # @api public
-      def getc(mask=(not_set=true))
-        value = ""
-
+      def getc(mask = (not_set = true))
+        value = ''
         buffer do
           begin
-            while (char = shell.input.getbyte) and
+            while (char = shell.input.getbyte) &&
                 !(char == CARRIAGE_RETURN || char == NEWLINE)
-
-              if (char == BACKSPACE || char == DELETE)
-                value.slice!(-1, 1) unless value.empty?
-              else
-                print_char char, not_set, mask
-                value << char
-              end
+              value = handle_char value, char, not_set, mask
             end
           ensure
             TTY.terminal.echo_on
           end
         end
-
         value
       end
 
@@ -80,13 +77,25 @@ module TTY
 
       private
 
+      # Handle single character by appending to or removing from output
+      #
+      # @api private
+      def handle_char(value, char, not_set, mask)
+        if char == BACKSPACE || char == DELETE
+          value.slice!(-1, 1) unless value.empty?
+        else
+          print_char char, not_set, mask
+          value << char
+        end
+        value
+      end
+
       # Print out character back to shell STDOUT
       #
       # @api private
       def print_char(char, not_set, mask)
         shell.output.putc((not_set || !mask) ? char : mask)
       end
-
     end # Reader
   end # Shell
 end # TTY

data/lib/tty/shell/response.rb

@@ -1,15 +1,22 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 require 'date'
 
 module TTY
-  # A class responsible for shell prompt interactions.
+  # A class responsible for shell prompt interactions
   class Shell
-
-    # A class representing a question.
+    # A class representing a shell response
     class Response
+      VALID_TYPES = [
+        :boolean,
+        :string,
+        :symbol,
+        :integer,
+        :float,
+        :date,
+        :datetime
+      ]
 
-      VALID_TYPES = [:boolean, :string, :symbol, :integer, :float, :date, :datetime]
       attr_reader :reader
       private :reader
 
@@ -22,9 +29,9 @@ module TTY
       # Initialize a Response
       #
       # @api public
-      def initialize(question, shell=nil)
+      def initialize(question, shell = Shell.new)
         @question = question
-        @shell    = shell || Shell.new
+        @shell    = shell
         @reader   = Reader.new(shell)
       end
 
@@ -35,7 +42,7 @@ module TTY
       # @return [undefined]
       #
       # @api public
-      def read(type=nil)
+      def read(type = nil)
         question.evaluate_response read_input
       end
 
@@ -58,7 +65,7 @@ module TTY
       #   error to display on failed conversion to string type
       #
       # @api public
-      def read_string(error=nil)
+      def read_string(error = nil)
         question.evaluate_response(String(read_input).strip)
       end
 
@@ -66,7 +73,7 @@ module TTY
       #
       # @api public
       def read_char
-        question.character true
+        question.char(true)
         question.evaluate_response String(read_input).chars.to_a[0]
       end
 
@@ -80,14 +87,14 @@ module TTY
       # Read ansewr and cast to Symbol type
       #
       # @api public
-      def read_symbol(error=nil)
-       question.evaluate_response read_input.to_sym
+      def read_symbol(error = nil)
+        question.evaluate_response read_input.to_sym
       end
 
       # Read answer from predifined choicse
       #
       # @api public
-      def read_choice(type=nil)
+      def read_choice(type = nil)
         question.argument(:required) unless question.default?
         question.evaluate_response read_input
       end
@@ -95,21 +102,21 @@ module TTY
       # Read integer value
       #
       # @api public
-      def read_int(error=nil)
+      def read_int(error = nil)
         question.evaluate_response TTY::Coercer::Integer.coerce(read_input)
       end
 
       # Read float value
       #
       # @api public
-      def read_float(error=nil)
+      def read_float(error = nil)
         question.evaluate_response TTY::Coercer::Float.coerce(read_input)
       end
 
       # Read regular expression
       #
       # @api public
-      def read_regex(error=nil)
+      def read_regex(error = nil)
         question.evaluate_response Kernel.send(:Regex, read_input)
       end
 
@@ -137,14 +144,14 @@ module TTY
       # Read boolean
       #
       # @api public
-      def read_bool(error=nil)
+      def read_bool(error = nil)
         question.evaluate_response TTY::Coercer::Boolean.coerce read_input
       end
 
       # Read file contents
       #
       # @api public
-      def read_file(error=nil)
+      def read_file(error = nil)
         question.evaluate_response File.open(File.join(directory, read_input))
       end
 
@@ -155,9 +162,7 @@ module TTY
       # @api public
       def read_email
         question.validate(/^[a-z0-9._%+-]+@([a-z0-9-]+\.)+[a-z]{2,6}$/i)
-        if question.error
-          question.prompt question.statement
-        end
+        question.prompt(question.statement) if question.error
         with_exception { read_string }
       end
 
@@ -213,7 +218,6 @@ module TTY
       def valid_type?(type)
         self.class::VALID_TYPES.include? type.to_sym
       end
-
     end # Response
   end # Shell
 end # TTY

data/lib/tty/shell/statement.rb

@@ -1,17 +1,22 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
+  # A class responsible for shell prompt interactions.
   class Shell
-
     # A class representing a statement output to shell.
     class Statement
-
       # @api private
       attr_reader :shell
       private :shell
 
+      # Flag to display newline
+      #
+      # @api public
       attr_reader :newline
 
+      # Color used to display statement
+      #
+      # @api public
       attr_reader :color
 
       # Initialize a Statement
@@ -27,10 +32,10 @@ module TTY
       #   change the message display to color
       #
       # @api public
-      def initialize(shell=nil, options={})
-        @shell = shell || Shell.new
-        @newline = options.fetch :newline, true
-        @color   = options.fetch :color, nil
+      def initialize(shell = Shell.new, options = {})
+        @shell   = shell
+        @newline = options.fetch(:newline, true)
+        @color   = options.fetch(:color, nil)
       end
 
       # Output the message to the shell
@@ -40,7 +45,7 @@ module TTY
       #
       # @api public
       def declare(message)
-        message = TTY::terminal.color.set message, *color if color
+        message = TTY.terminal.color.set message, *color if color
 
         if newline && /( |\t)(\e\[\d+(;\d+)*m)?\Z/ !~ message
           shell.output.puts message
@@ -49,7 +54,6 @@ module TTY
           shell.output.flush
         end
       end
-
     end # Statement
   end # Shell
 end # TTY

data/lib/tty/shell/suggestion.rb

@@ -1,12 +1,10 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   # A class responsible for shell prompt interactions.
   class Shell
-
     # A class representing a suggestion
     class Suggestion
-
       # @api private
       attr_reader :shell
       private :shell
@@ -26,6 +24,11 @@ module TTY
       # @api public
       attr_reader :plural_text
 
+      # Possible suggestions
+      #
+      # @api public
+      attr_reader :suggestions
+
       DEFAULT_INDENT = 8
 
       SINGLE_TEXT    = 'Did you mean this?'
@@ -35,10 +38,11 @@ module TTY
       # Initialize a Suggestion
       #
       # @api public
-      def initialize(options={})
+      def initialize(options = {})
         @indent      = options.fetch(:indent) { DEFAULT_INDENT }
         @single_text = options.fetch(:single_text) { SINGLE_TEXT }
         @plural_text = options.fetch(:plural_text) { PLURAL_TEXT }
+        @suggestions = []
       end
 
       # Suggest matches out of possibile strings
@@ -54,11 +58,9 @@ module TTY
         max_distance     = distances.keys.max
 
         if minimum_distance < max_distance
-          suggestions = distances[minimum_distance].sort
-          evaluate(suggestions)
-        else
-          nil
+          @suggestions = distances[minimum_distance].sort
         end
+        evaluate
       end
 
       # Measure distances between messag and possibilities
@@ -86,17 +88,19 @@ module TTY
       # @return [String]
       #
       # @api private
-      def evaluate(suggestions)
-        suggestion = ""
+      def evaluate
+        return suggestions if suggestions.empty?
+        suggestion = ''
         if suggestions.one?
           suggestion << single_text + "\n"
-          suggestion << (" " * indent + suggestions.first)
+          suggestion << (' ' * indent + @suggestions.first)
         else
           suggestion << plural_text + "\n"
-          suggestion << suggestions.map { |suggestion| " " * indent + suggestion }.join("\n")
+          suggestion << suggestions.map do |sugest|
+            ' ' * indent + sugest
+          end.join("\n")
         end
       end
-
     end # Suggestion
   end # Shell
 end # TTY