tty-prompt 0.2.0 → 0.3.0

data/lib/tty/prompt/reader/key_event.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+require 'tty/prompt/reader/codes'
+
+module TTY
+  class Prompt
+    class Reader
+      # Responsible for meta-data information about key pressed
+      #
+      # @api private
+      class Key < Struct.new(:name, :ctrl, :meta, :shift)
+        def initialize(*)
+          super
+          @ctrl = false
+          @meta = false
+          @shift = false
+        end
+      end
+
+      # Represents key event emitted during keyboard press
+      #
+      # @api public
+      class KeyEvent < Struct.new(:value, :key)
+        META_KEY_CODE_RE = /^(?:\x1b+)(O|N|\[|\[\[)(?:(\d+)(?:;(\d+))?([~^$])|(?:1;)?(\d+)?([a-zA-Z]))/
+
+        def self.from(char)
+          key = Key.new
+          case char
+          when Codes::RETURN
+            key.name = :return
+          when Codes::LINEFEED
+            key.name = :enter
+          when Codes::TAB
+            key.name = :tab
+          when Codes::BACKSPACE
+            key.name = :backspace
+          when Codes::DELETE
+            key.name = :delete
+          when Codes::SPACE
+            key.name = :space
+          when Codes::CTRL_C, Codes::ESCAPE
+            key.name = :escape
+          when proc { |c| c <= "\x1a" }
+            codes = char.each_codepoint.to_a
+            key.name = "#{codes}"
+            key.ctrl = true
+          when /\d/
+            key.name = :num
+          when META_KEY_CODE_RE
+            key.meta = true
+            case char
+            when Codes::KEY_UP, Codes::CTRL_K, Codes::CTRL_P
+              key.name = :up
+            when Codes::KEY_DOWN, Codes::CTRL_J, Codes::CTRL_N
+              key.name = :down
+            when Codes::KEY_RIGHT, Codes::CTRL_L
+              key.name = :right
+            when Codes::KEY_LEFT, Codes::CTRL_H
+              key.name = :left
+            end
+          end
+          new(char, key)
+        end
+      end # KeyEvent
+    end # Reader
+  end # Prompt
+end # TTY

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

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+require 'tty/prompt/reader/mode/echo'
+require 'tty/prompt/reader/mode/raw'
+
+module TTY
+  class Prompt
+    class Reader
+      class Mode
+        # Initialize a Terminal
+        #
+        # @api public
+        def initialize(options = {})
+          @echo = Echo.new
+          @raw  = 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 # Reader
+  end # Prompt
+end # TTY

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

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    class Reader
+      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
+            off unless is_on
+            value = block.call if block_given?
+          rescue NoMethodError, Interrupt => error
+            puts "#{error.class} #{error.message}"
+            puts error.backtrace
+            on
+            exit
+          ensure
+            on
+            value
+          end
+        end # Echo
+      end # Mode
+    end # Reader
+  end # Prompt
+end # TTY

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

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    class Reader
+      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
+            on if is_on
+            value = block.call if block_given?
+          rescue NoMethodError, Interrupt => error
+            puts "#{error.class} #{error.message}"
+            puts error.backtrace
+            off
+            exit
+          ensure
+            off
+            value
+          end
+        end # Raw
+      end # Mode
+    end # Reader
+  end # Prompt
+end # TTY

data/lib/tty/prompt/result.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    # Accumulates errors
+    class Result
+      attr_reader :question, :value, :errors
+
+      def initialize(question, value, errors = [])
+        @question = question
+        @value  = value
+        @errors = errors
+      end
+
+      def with(condition = nil, &block)
+        validator = (condition || block)
+        (new_value, validation_error) = validator.call(question, value)
+        accumulated_errors = errors + Array(validation_error)
+
+        if accumulated_errors.empty?
+          Success.new(question, new_value)
+        else
+          Failure.new(question, new_value, accumulated_errors)
+        end
+      end
+
+      def success?
+        is_a?(Success)
+      end
+
+      def failure?
+        is_a?(Failure)
+      end
+
+      class Success < Result
+      end
+
+      class Failure < Result
+      end
+    end
+  end # Prompt
+end # TTY

data/lib/tty/prompt/statement.rb

@@ -5,10 +5,6 @@ module TTY
   class Prompt
     # A class representing a statement output to prompt.
     class Statement
-      # @api private
-      attr_reader :prompt
-      private :prompt
-
       # Flag to display newline
       #
       # @api public
@@ -32,11 +28,10 @@ module TTY
       #   change the message display to color
       #
       # @api public
-      def initialize(prompt = Prompt.new, options = {})
-        @prompt   = prompt
-        @pastel  = Pastel.new
-        @newline = options.fetch(:newline, true)
-        @color   = options.fetch(:color, false)
+      def initialize(prompt, options = {})
+        @prompt  = prompt
+        @newline = options.fetch(:newline) { true }
+        @color   = options.fetch(:color) { false }
       end
 
       # Output the message to the prompt
@@ -45,14 +40,14 @@ module TTY
       #   the message to be printed to stdout
       #
       # @api public
-      def declare(message)
-        message = @pastel.decorate message, *color if color
+      def call(message)
+        message = @prompt.decorate(message, *color) if color
 
         if newline && /( |\t)(\e\[\d+(;\d+)*m)?\Z/ !~ message
-          prompt.output.puts message
+          @prompt.puts message
         else
-          prompt.output.print message
-          prompt.output.flush
+          @prompt.print message
+          @prompt.flush
         end
       end
     end # Statement

data/lib/tty/prompt/suggestion.rb

@@ -3,9 +3,11 @@
 require 'tty/prompt/distance'
 
 module TTY
-  # A class responsible for shell prompt interactions.
+  # A class responsible for terminal prompt interactions.
   class Prompt
-    # A class representing a suggestion
+    # A class representing a suggestion out of possible choices
+    #
+    # @api public
     class Suggestion
       DEFAULT_INDENT = 8
 

data/lib/tty/prompt/symbols.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    module Symbols
+      SPACE = " "
+      ITEM_SECURE     = "•"
+      ITEM_SELECTED   = "‣"
+      RADIO_CHECKED   = "⬢"
+      RADIO_UNCHECKED = "⬡"
+    end # Symbols
+  end # Prompt
+end # TTY

data/lib/tty/prompt/test.rb

@@ -8,8 +8,9 @@ module TTY
     def initialize(options = {})
       @input  = StringIO.new
       @output = StringIO.new
-
-      super(@input, @output, options)
+      options.merge!({input: @input, output: @output})
+      super(options)
+      @pastel = Pastel.new(enabled: true)
     end
   end # TestPrompt
 end # TTY

data/lib/tty/prompt/utils.rb

@@ -2,7 +2,7 @@
 
 module TTY
   module Utils
-    extend self
+    module_function
 
     def extract_options!(args)
       args.last.respond_to?(:to_hash) ? args.pop : {}

data/lib/tty/prompt/version.rb

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

data/spec/unit/ask_spec.rb

@@ -1,74 +1,57 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
 RSpec.describe TTY::Prompt, '#ask' do
-
   subject(:prompt) { TTY::TestPrompt.new }
 
-  it 'prints message' do
-    prompt.ask("What is your name?")
-    expect(prompt.output.string).to eql("What is your name?")
+  it 'asks question' do
+    prompt.ask('What is your name?')
+    expect(prompt.output.string).to eq([
+      "What is your name? ",
+      "\e[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      "What is your name? \n"
+    ].join)
   end
 
-  it 'prints an empty message ' do
+  it 'asks an empty question ' do
     prompt.ask('')
     expect(prompt.output.string).to eql('')
   end
 
-  it 'prints an empty message and returns nil if EOF is sent to stdin' do
+  it 'asks an empty question and returns nil if EOF is sent to stdin' do
     prompt.input << nil
     prompt.input.rewind
-    response = prompt.ask("")
-    expect(response).to eql(nil)
+    answer = prompt.ask('')
+    expect(answer).to eql(nil)
     expect(prompt.output.string).to eq('')
   end
 
-  it "asks a question with a prefix '>'" do
-    prompt = TTY::TestPrompt.new(prefix: ' > ')
-    prompt.input << ''
+  it "asks a question with a prefix [?]" do
+    prompt = TTY::TestPrompt.new(prefix: "[?] ")
+    prompt.input << "\r"
     prompt.input.rewind
-    response = prompt.ask "Are you Polish?"
-    expect(response).to eq(nil)
-    expect(prompt.output.string).to eql " > Are you Polish?"
+    answer = prompt.ask 'Are you Polish?'
+    expect(answer).to eq(nil)
+    expect(prompt.output.string).to eq([
+      "[?] Are you Polish? ",
+      "\e[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      "[?] Are you Polish? \n"
+    ].join)
   end
 
   it 'asks a question with block' do
     prompt.input << ''
     prompt.input.rewind
-    value = prompt.ask "What is your name?" do |q|
+    answer = prompt.ask "What is your name?" do |q|
       q.default 'Piotr'
     end
-    expect(value).to eql "Piotr"
-    expect(prompt.output.string).to eq('What is your name?')
-  end
-
-  context 'yes?' do
-    it 'agrees' do
-      prompt.input << 'yes'
-      prompt.input.rewind
-      expect(prompt.yes?("Are you a human?")).to eq(true)
-      expect(prompt.output.string).to eq('Are you a human?')
-    end
-
-    it 'disagrees' do
-      prompt.input << 'no'
-      prompt.input.rewind
-      expect(prompt.yes?("Are you a human?")).to eq(false)
-    end
-  end
-
-  context 'no?' do
-    it 'agrees' do
-      prompt.input << 'no'
-      prompt.input.rewind
-      expect(prompt.no?("Are you a human?")).to eq(true)
-    end
-
-    it 'disagrees' do
-      prompt.input << 'yes'
-      prompt.input.rewind
-      expect(prompt.no?("Are you a human?")).to eq(false)
-    end
+    expect(answer).to eq('Piotr')
+    expect(prompt.output.string).to eq([
+      "What is your name? \e[90m(Piotr)\e[0m ",
+      "\e[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      "What is your name? \e[32mPiotr\e[0m\n"
+    ].join)
   end
 end