tty 0.0.5 → 0.0.6

data/lib/tty/shell.rb

@@ -0,0 +1,159 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+
+  # A class responsible for shell prompt interactions.
+  class Shell
+
+    # @api private
+    attr_reader :input
+
+    # @api private
+    attr_reader :output
+
+    # Initialize a Shell
+    #
+    # @api public
+    def initialize(input=stdin, output=stdout)
+      @input  = input
+      @output = output
+    end
+
+    # Ask a question.
+    #
+    # @example
+    #   shell = TTY::Shell.new
+    #   shell.ask("What is your name?")
+    #
+    # @param [String] statement
+    #   string question to be asked
+    #
+    # @yieldparam [TTY::Question] question
+    #   further configure the question
+    #
+    # @yield [question]
+    #
+    # @return [TTY::Question]
+    #
+    # @api public
+    def ask(statement, *args, &block)
+      options = Utils.extract_options!(args)
+
+      question = Question.new self, statement, options
+      question.instance_eval(&block) if block_given?
+      question.prompt(statement)
+    end
+
+    # A shortcut method to ask the user positive question and return 
+    # true for 'yes' reply.
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def yes?(statement, *args, &block)
+      ask(statement, *args, &block).read_bool
+    end
+
+    # A shortcut method to ask the user negative question and return
+    # true for 'no' reply.
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def no?(statement, *args, &block)
+      !yes?(statement, *args, &block)
+    end
+
+    # Print statement out. If the supplied message ends with a space or
+    # tab character, a new line will not be appended.
+    #
+    # @example
+    #   say("Simple things.")
+    #
+    # @param [String] message
+    #
+    # @return [String]
+    #
+    # @api public
+    def say(message="", options={})
+      message = message.to_str
+      return unless message.length > 0
+
+      statement = Statement.new(self, options)
+      statement.declare message
+    end
+
+    # Print statement(s) out in red green.
+    #
+    # @example
+    #   shell.confirm "Are you sure?"
+    #   shell.confirm "All is fine!", "This is fine too."
+    #
+    # @param [Array] messages
+    #
+    # @return [Array] messages
+    #
+    # @api public
+    def confirm(*args)
+      options = Utils.extract_options!(args)
+      args.each { |message| say message, options.merge(:color => :green) }
+    end
+
+    # Print statement(s) out in yellow color.
+    #
+    # @example
+    #   shell.warn "This action can have dire consequences"
+    #   shell.warn "Carefull young apprentice", "This is potentially dangerous."
+    #
+    # @param [Array] messages
+    #
+    # @return [Array] messages
+    #
+    # @api public
+    def warn(*args)
+      options = Utils.extract_options!(args)
+      args.each { |message| say message, options.merge(:color => :yellow) }
+    end
+
+    # Print statement(s) out in red color.
+    #
+    # @example
+    #   shell.error "Shutting down all systems!"
+    #   shell.error "Nothing is fine!", "All is broken!"
+    #
+    # @param [Array] messages
+    #
+    # @return [Array] messages
+    #
+    # @api public
+    def error(*args)
+      options = Utils.extract_options!(args)
+      args.each { |message| say message, options.merge(:color => :red) }
+    end
+
+    # Print a table to shell.
+    #
+    # @return [undefined]
+    #
+    # @api public
+    def print_table(*args, &block)
+      table = TTY::Table.new *args, &block
+      say table.to_s
+    end
+
+    protected
+
+    def stdin
+      $stdin
+    end
+
+    def stdout
+      $stdout
+    end
+
+    def stderr
+      $stderr
+    end
+
+  end # Shell
+end # TTY

data/lib/tty/table/operation/wrapped.rb

@@ -27,6 +27,12 @@ module TTY
           end
         end
 
+        private
+
+        def actual_length(string)
+          string.to_s.gsub(/\e\[\d{1,2}m/, '').length
+        end
+
       end # Wrapped
     end # Operation
   end # Table

data/lib/tty/terminal/color.rb

@@ -0,0 +1,143 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Terminal
+
+    # A class responsible for coloring strings.
+    class Color
+
+      # Embed in a String to clear all previous ANSI sequences.
+      CLEAR      = "\e[0m"
+      # The start of an ANSI bold sequence.
+      BOLD       = "\e[1m"
+      # The start of an ANSI underlined sequence.
+      UNDERLINE  = "\e[4m"
+
+      STYLES = %w[ BOLD CLEAR UNDERLINE ].freeze
+
+      # Escape codes for text color.
+      BLACK      = "\e[30m"
+      RED        = "\e[31m"
+      GREEN      = "\e[32m"
+      YELLOW     = "\e[33m"
+      BLUE       = "\e[34m"
+      MAGENTA    = "\e[35m"
+      CYAN       = "\e[36m"
+      WHITE      = "\e[37m"
+
+      TEXT_COLORS = %w[ BLACK RED GREEN YELLOW BLUE MAGENTA CYAN WHITE ].freeze
+
+      # Escape codes for background color.
+      ON_BLACK   = "\e[40m"
+      ON_RED     = "\e[41m"
+      ON_GREEN   = "\e[42m"
+      ON_YELLOW  = "\e[43m"
+      ON_BLUE    = "\e[44m"
+      ON_MAGENTA = "\e[45m"
+      ON_CYAN    = "\e[46m"
+      ON_WHITE   = "\e[47m"
+
+      BACKGROUND_COLORS = %w[ ON_BLACK ON_RED ON_GREEN ON_YELLOW ON_BLUE ON_MAGENTA ON_CYAN  ON_WHITE ].freeze
+
+      attr_reader :enabled
+
+      # Initialize a Terminal Color
+      #
+      # @api public
+      def initialize(enabled=false)
+        @enabled = enabled
+      end
+
+      # Disable coloring of this terminal session
+      #
+      # @api public
+      def disable!
+        @enabled = false
+      end
+
+      # Check if coloring is on
+      #
+      # @api public
+      def enabled?
+        @enabled
+      end
+
+      # Apply ANSI color to the given string.
+      #
+      # @param [String] string
+      #   text to add ANSI strings
+      #
+      # @param [Array[Symbol]] colors
+      #
+      # @example
+      #   apply "text", :yellow, :on_green, :underline
+      #
+      # @return [String]
+      #
+      # @api public
+      def set(string, *colors)
+        validate *colors
+        ansi_colors = colors.map { |color| lookup(color) }
+        "#{ansi_colors.join}#{string}#{CLEAR}"
+      end
+
+      # Same as instance method.
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def self.set(string, *colors)
+        new.set(string, *colors)
+      end
+
+      # Remove color codes from a string.
+      #
+      # @param [String] string
+      #
+      # @return [String]
+      #
+      # @api public
+      def remove(string)
+        string.gsub(/\e\[\d+(;\d+)*m/, '')
+      end
+
+      # Return raw color code without embeding it into a string.
+      #
+      # @return [Array[String]]
+      #   ANSI escape codes
+      #
+      # @api public
+      def code(*colors)
+        validate *colors
+        colors.map { |color| lookup(color) }
+      end
+
+      # All ANSI color names as strings.
+      #
+      # @return [Array[String]]
+      #
+      # @api public
+      def names
+        (STYLES + BACKGROUND_COLORS + TEXT_COLORS).map { |color| color.to_s.downcase }
+      end
+
+      protected
+
+      # Find color representation.
+      #
+      # @api private
+      def lookup(color)
+        self.class.const_get(color.to_s.upcase)
+      end
+
+      # @api private
+      def validate(*colors)
+        unless colors.all? { |color| names.include?(color.to_s) }
+          raise ArgumentError, "Bad color or unintialized constant, valid colors are: #{names.join(', ')}."
+        end
+      end
+
+    end # Color
+
+  end
+end # TTY

data/lib/tty/terminal.rb

@@ -3,10 +3,6 @@
 module TTY
   class Terminal
 
-    @@default_width  = 80
-
-    @@default_height = 24
-
     # Return default width of terminal
     #
     # @example
@@ -15,31 +11,36 @@ module TTY
     # @return [Integer]
     #
     # @api public
-    def default_width
-      @@default_width
-    end
+    attr_reader :default_width
 
-    # Set default width of terminal
+    # Return default height of terminal
     #
-    # @param [Integer] width
+    # @example
+    #   default_height = TTY::Terminal.default_height
     #
     # @return [Integer]
     #
     # @api public
-    def default_width=(width)
-      @@default_width = width
+    attr_reader :default_height
+
+    # @api public
+    attr_reader :color
+
+    def initialize
+      @color = TTY::Terminal::Color.new(self.color?)
+      @default_width  = 80
+      @default_height = 24
     end
 
-    # Return default height of terminal
+    # Set default width of terminal
     #
-    # @example
-    #   default_height = TTY::Terminal.default_height
+    # @param [Integer] width
     #
     # @return [Integer]
     #
     # @api public
-    def default_height
-      @@default_height
+    def default_width=(width)
+      @default_width = width
     end
 
     # Set default height of terminal
@@ -51,7 +52,7 @@ module TTY
     #
     # @api public
     def default_height=(height)
-      @@default_height = height
+      @default_height = height
     end
 
     # Determine current width
@@ -60,8 +61,9 @@ module TTY
     #
     # @api width
     def width
-      if ENV['TTY_COLUMNS'] =~ /^\d+$/
-        result = ENV['TTY_COLUMNS'].to_i
+      env_tty_columns = ENV['TTY_COLUMNS']
+      if env_tty_columns =~ /^\d+$/
+        result = env_tty_columns.to_i
       else
         result = TTY::System.unix? ? dynamic_width : default_width
       end
@@ -73,8 +75,9 @@ module TTY
     #
     # @api public
     def height
-      if ENV['TTY_LINES'] =~ /^\d+$/
-        result = ENV['TTY_LINES'].to_i
+      env_tty_lines = ENV['TTY_LINES']
+      if env_tty_lines =~ /^\d+$/
+        result = env_tty_lines.to_i
       else
         result = TTY::System.unix? ? dynamic_height : self.default_height
       end
@@ -145,5 +148,27 @@ module TTY
       %x{tput colors 2>/dev/null}.to_i > 2
     end
 
+    # Find user home directory
+    #
+    # @return [String]
+    #
+    # @api public
+    def home
+      @home ||= if (env_home = ENV['HOME'])
+        env_home
+      else
+        begin
+          require 'etc'
+          File.expand_path("~#{Etc.getlogin}")
+        rescue
+          if TTY::System.windows?
+            "C:/"
+          else
+            "/"
+          end
+        end
+      end
+    end
+
   end # Terminal
 end # TTY

data/lib/tty/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module TTY
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/tty.rb

@@ -9,11 +9,17 @@ require 'tty/support/coercion'
 require 'tty/support/equatable'
 require 'tty/support/unicode'
 
-require 'tty/color'
 require 'tty/terminal'
+require 'tty/terminal/color'
 require 'tty/system'
 require 'tty/table'
 require 'tty/vector'
+require 'tty/shell'
+
+require 'tty/shell/question'
+require 'tty/shell/question/validation'
+require 'tty/shell/question/modifier'
+require 'tty/shell/statement'
 
 require 'tty/table/border'
 require 'tty/table/border/unicode'
@@ -32,6 +38,18 @@ module TTY
   # Raised when the argument type is different from expected
   class TypeError < ArgumentError; end
 
+  # Raised when the required argument is not supplied
+  class ArgumentRequired < ArgumentError; end
+
+  # Raised when the argument validation fails
+  class ArgumentValidation < ArgumentError; end
+
+  # Raised when the argument is not expected
+  class InvalidArgument < ArgumentError; end
+
+  # Raised when the passed in validation argument is of wrong type
+  class ValidationCoercion < TypeError; end
+
   class << self
 
     # Return terminal instance

data/spec/tty/shell/ask_spec.rb

@@ -0,0 +1,65 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Shell, '#ask' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+
+  subject(:shell) { TTY::Shell.new(input, output) }
+
+  it 'prints message' do
+    shell.ask "What is your name?"
+    expect(output.string).to eql "What is your name?\n"
+  end
+
+  it 'prints an empty message ' do
+    shell.ask ""
+    expect(output.string).to eql ""
+  end
+
+  it 'prints an empty message and returns nil if EOF is sent to stdin' do
+    input << nil
+    input.rewind
+    q = shell.ask ""
+    expect(q.read).to eql nil
+  end
+
+  it 'asks a question with block' do
+    input << ''
+    input.rewind
+    q = shell.ask "What is your name?" do
+      default 'Piotr'
+    end
+    expect(q.read).to eql "Piotr"
+  end
+
+  context 'yes?' do
+    it 'agrees' do
+      input << 'yes'
+      input.rewind
+      expect(shell.yes?("Are you a human?")).to be_true
+    end
+
+    it 'disagrees' do
+      input << 'no'
+      input.rewind
+      expect(shell.yes?("Are you a human?")).to be_false
+    end
+  end
+
+  context 'no?' do
+    it 'agrees' do
+      input << 'no'
+      input.rewind
+      expect(shell.no?("Are you a human?")).to be_true
+    end
+
+    it 'disagrees' do
+      input << 'yes'
+      input.rewind
+      expect(shell.no?("Are you a human?")).to be_false
+    end
+  end
+
+end

data/spec/tty/shell/error_spec.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Shell, '#error' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+
+  subject(:shell) { TTY::Shell.new(input, output) }
+
+  after { output.rewind }
+
+  it 'displays one message' do
+    shell.error "Nothing is fine!"
+    expect(output.string).to eql "\e[31mNothing is fine!\e[0m\n"
+  end
+
+  it 'displays many messages' do
+    shell.error "Nothing is fine!", "All is broken!"
+    expect(output.string).to eql "\e[31mNothing is fine!\e[0m\n\e[31mAll is broken!\e[0m\n"
+  end
+
+  it 'displays message with option' do
+    shell.error "Nothing is fine!", :newline => false
+    expect(output.string).to eql "\e[31mNothing is fine!\e[0m"
+  end
+
+end # error

data/spec/tty/shell/print_table_spec.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe TTY::Shell, '#print_table' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:header) { ['h1', 'h2'] }
+  let(:rows) { [['a1', 'a2'], ['b1', 'b2']] }
+
+  subject(:shell) { TTY::Shell.new(input, output) }
+
+  it 'prints a table' do
+    shell.print_table header, rows, :renderer => :ascii
+    expect(output.string).to eql <<-EOS.normalize
+        +--+--+
+        |h1|h2|
+        +--+--+
+        |a1|a2|
+        |b1|b2|
+        +--+--+\n
+    EOS
+  end
+
+end # print_table