tty 0.0.1 → 0.0.2

data/.gitignore

@@ -1,4 +1,5 @@
 *.swp
+*.swo
 *.gem
 *.rbc
 .bundle

data/README.md

@@ -1,11 +1,10 @@
 # TTY
-[![Build Status](https://secure.travis-ci.org/peter-murach/tty.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/peter-murach/tty.png?travis)][gemnasium] [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
+[![Build Status](https://secure.travis-ci.org/peter-murach/tty.png?branch=master)][travis] [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
 
 [travis]: http://travis-ci.org/peter-murach/tty
-[gemnasium]: https://gemnasium.com/peter-murach/tty
 [codeclimate]: https://codeclimate.com/github/peter-murach/tty
 
-Toolbox for developing CLI clients.
+Toolbox for developing CLI clients in Ruby.
 
 ## Features
 
@@ -14,9 +13,11 @@ Jump-start development of your command line app:
 * Fully customizable table rendering with an easy-to-use API.
   (status: In Progress)
 * Terminal output colorization. (status: TODO)
-* Terminal & System detection utilities. (status: TODO)
+* Terminal & System detection utilities. (status: In Progress)
 * Text alignment/padding and diffs. (status: TODO)
 * Shell user interface. (status: TODO)
+* Progress bar. (status: TODO)
+* Fully tested with major ruby interpreters.
 * No dependencies to allow for easy gem vendoring.
 
 ## Installation
@@ -37,14 +38,22 @@ Or install it yourself as:
 
 ### Table
 
-Creating tables
+To instantiate table
+
+```ruby
+  table = TTY::Table.new :rows => [['a1', 'a2'], ['b1', 'b2']]
+  table = TTY::Table[['a1', 'a2'], ['b1', 'b2']]
+```
+
+Table behaves like an array so `<<` and similar methods can be used
 
 ```ruby
-  table = TTY::Table.new ['Header 1', 'Header 2']
   table << ['a1', 'a2', 'a3']
   table << ['b1', 'b2', 'b3']
 ```
 
+or pass your rows in a block
+
 ```ruby
   table = TTY::Table.new header: ['Header 1', 'Header 2'] do |t|
     t << ['a1', 'a2', 'a3']
@@ -52,6 +61,36 @@ Creating tables
   end
 ```
 
+And then to print do
+
+```ruby
+  table.to_s   #  =>  a1  a2  a3
+               #      b1  b2  b3
+```
+
+To print `unicode` table
+
+```ruby
+  table = TTY::Table.new renderer: 'unicode'
+  table.to_s
+```
+
+### Terminal
+
+```ruby
+  term = TTY::Terminal.new
+  term.width    # => 140
+  term.height   # =>  60
+  term.color?   # => true or false
+```
+
+### System
+
+```ruby
+  TTY::System.unix?      # => true
+  TTY::System.windows?   # => false
+```
+
 ## Contributing
 
 1. Fork it

data/lib/tty.rb

@@ -1,11 +1,32 @@
 # -*- encoding: utf-8 -*-
 
 require 'tty/version'
-require 'tty/table'
-require 'tty/color'
 
 require 'tty/support/utils'
+require 'tty/support/delegatable'
+require 'tty/support/conversion'
+
+require 'tty/color'
+require 'tty/terminal'
+require 'tty/system'
+require 'tty/table'
 
 module TTY
 
+  # Raised when the argument type is different from expected
+  class TypeError < ArgumentError; end
+
+  class << self
+
+    # Return terminal instance
+    #
+    # @return [TTY::Terminal]
+    #
+    # @api public
+    def terminal
+      @terminal ||= Terminal.new
+    end
+
+  end
+
 end # TTY

data/lib/tty/color.rb

@@ -10,9 +10,5 @@ module TTY
 
     attr_reader :enabled
 
-    def self.color?
-      %x{tput colors 2>/dev/null}.to_i > 2
-    end
-
   end # Color
 end # TTY

data/lib/tty/support/conversion.rb

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  # A mixin to allow instances conversion to different types
+  module Conversion
+
+    # Converts the object into an Array. If copy is set to true
+    # a copy of object will be made.
+    #
+    # @param [Object] object
+    #
+    # @param [Boolean] copy
+    #
+    # @return [Array]
+    #
+    # @api private
+    def convert_to_array(object, copy=false)
+      case object
+      when Array
+        copy ? object.dup : object
+      when Hash
+        Array(object)
+      else
+        begin
+          converted = object.to_ary
+        rescue Exception => e
+          raise TTY::TypeError, "Cannot convert #{object.class} into an Array (#{e.message})"
+        end
+        converted
+      end
+    end
+
+  end # Conversion
+end # TTY

data/lib/tty/support/delegatable.rb

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  # A mixin to allow delegetable methods to be added
+  module Delegatable
+
+    # Create delegator for each specified method
+    #
+    # @example
+    #   delegatable_method :source, :method
+    #
+    # @param [Symbol] source
+    #
+    # @param [Array] methods
+    #
+    # @return [self]
+    #
+    # @api public
+    def delegatable_method(source, *methods)
+      methods.each { |method| define_delegatable_method(source, method)}
+      self
+    end
+
+  private
+
+    # Create a delegator method for the method name
+    #
+    # @param [Symbol] source
+    #
+    # @param [Symbol] method name
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def define_delegatable_method(source, method)
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{method}(*args, &block)
+          #{source}.#{method}(*args, &block)
+        end
+      RUBY
+    end
+
+  end # Delegatable
+end # TTY

data/lib/tty/support/utils.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module TTY
   module Utils
     extend self

data/lib/tty/system.rb

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+require 'rbconfig'
+
+module TTY
+  class System
+
+    class << self
+
+      # Check if windows platform.
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def windows?
+        RbConfig::CONFIG['host_os'] =~ /msdos|mswin|djgpp|mingw|windows/
+      end
+
+      # Check if unix platform
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def unix?
+        RbConfig::CONFIG['host_os'] =~ /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
+      end
+
+    end
+
+  end # System
+end # TTY

data/lib/tty/table.rb

@@ -2,10 +2,13 @@
 
 require 'forwardable'
 require 'tty/table/renderer'
+require 'tty/table/error'
+require 'tty/table/validatable'
 
 module TTY
   class Table
-    include Comparable, Enumerable, Renderer
+    include Comparable, Enumerable, Renderer, Conversion
+    include Validatable
     extend Forwardable
 
     # The table header
@@ -34,6 +37,16 @@ module TTY
       # TODO implement table orientation
     end
 
+    # Create a new Table where each argument is a row
+    #
+    # @example
+    #   table = TTY::Table.new[['a1', 'a2'], ['b1', 'b2']]
+    #
+    # @api public
+    def self.[](*rows)
+      self.new(:rows => rows)
+    end
+
     # Instantiate a new Table
     #
     # @example of direct parameters
@@ -44,6 +57,8 @@ module TTY
     #   rows  = [ ['a1', 'a2'], ['b1', 'b2'] ]
     #   table = Table.new :header => ['Header 1', 'Header 2'], :rows => rows
     #
+    # @param [Array[Symbol], Hash] *args
+    #
     # @api public
     def self.new(*args, &block)
       options = Utils.extract_options!(args)
@@ -58,28 +73,105 @@ module TTY
     # Initialize a Table
     #
     # @param [Hash] options
+    #   the options to create the table with
+    # @option options [String] :header
+    #   column names to be displayed
+    # @option options [String] :rows
+    #   Array of Arrays expressin the rows
+    # @option options [String] :renderer
+    #   used to format table output
+    #
     # @return [Table]
     #
     # @api private
     def initialize(options={}, &block)
       @header   = options.fetch :header, []
-      @rows     = options.fetch :rows, []
+      @rows     = coerce(options.fetch :rows, [])
       @renderer = pick_renderer options[:renderer]
+      assert_row_sizes @rows
       yield_or_eval &block if block_given?
     end
 
-    # Lookup an attribute value given an attribute name
+    # Lookup element of the table given a row(i) and column(j)
     #
-    def [](index)
-      if index >= 0
-        rows.map { |row| row[0] }.compact
+    # @api public
+    def [](i, j)
+      if i >= 0 && j >= 0
+        rows.fetch(i){return nil}[j]
       else
         raise IndexError.new("index #{index} not found")
       end
     end
+    alias element   []
+    alias component []
+
+    # Set table value at row(i) and column(j)
+    #
+    # @api private
+    def []=(i, j, val)
+      @rows[i][j] = val
+    end
+    private :[]=
+
+    # Return a row number at the index of the table as an Array.
+    # When a block is given, the elements of that Array are iterated over.
+    #
+    # @example
+    #   rows  = [ ['a1', 'a2'], ['b1', 'b2'] ]
+    #   table = TTY::Table.new :rows => rows
+    #   table.row(1) { |element| ... }
+    #
+    # @param [Integer] index
+    #
+    # @yield []
+    #   optional block to execute in the iteration operation
+    #
+    # @return [self]
+    #
+    # @api public
+    def row(index, &block)
+      if block_given?
+        rows.fetch(index){return self}.each(&block)
+        self
+      else
+        rows.fetch(index){return nil}
+      end
+    end
 
+    # Return a column number at the index of the table as an Array.
+    # When a block is given, the elements of that Array are iterated over.
+    #
+    # @example
+    #   rows  = [ ['a1', 'a2'], ['b1', 'b2'] ]
+    #   table = TTY::Table.new :rows => rows
+    #   table.column(1) { |element| ... }
+    #
+    # @param [Integer] index
+    #
+    # @yield []
+    #   optional block to execute in the iteration operation
+    #
+    # @return [self]
+    #
+    # @api public
+    def column(index)
+      if block_given?
+        return self if index >= column_size || index < 0
+        rows.map { |row| yield row[index].compact }
+      else
+        return nil if index >= column_size || index < 0
+        rows.map { |row| row[index] }.compact
+      end
+    end
+
+    # Add row to table
+    #
+    # @param [Array] row
+    #
     # @api public
     def <<(row)
+      rows_copy = rows.dup
+      assert_row_sizes rows_copy << row
       rows << row
     end
 
@@ -87,11 +179,12 @@ module TTY
     #
     # @example
     #   table = TTY::Table.new(header, tuples)
-    #   table.each { |tuple| ... }
+    #   table.each { |row| ... }
     #
-    # @yield [tuple]
+    # @yield [Array[Array]]
     #
     # @return [self]
+    #
     # @api public
     def each
       return to_enum unless block_given?
@@ -101,22 +194,62 @@ module TTY
       self
     end
 
+    # Return the number of columns
+    #
+    # @example
+    #   table.column_size # => 5
+    #
+    # @return [Integer]
+    #
+    # @api public
+    def column_size
+      return rows[0].size if (rows.size > 0)
+      return 0
+    end
+
     # Return the number of rows
     #
     # @example
-    #   table.size # => 5
+    #   table.row_size # => 5
     #
     # @return [Integer]
+    #
+    # @api public
+    def row_size
+      rows.size
+    end
+
+    # Return the number of rows and columns
+    #
+    # @example
+    #   table.size # => [3,5]
+    #
+    # @return [Array] row x columns
+    #
+    # @api public
     def size
-      return rows[0].length if (rows.length > 0)
-      return 0
+      [row_size, column_size]
     end
 
     # Check table width
     #
     # @return [Integer] width
+    #
+    # @api public
     def width
-      
+      extract_column_widths(rows)
+      total_width
+    end
+
+    # Compare this table with other table for equality
+    #
+    # @param [TTY::Table] other
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def eql?(other)
+      instance_of?(other.class)
     end
 
     # Compare the table with other table for equivalency
@@ -135,23 +268,25 @@ module TTY
 
     # Return string representation of table
     #
+    # @return [String]
+    #
     # @api public
     def to_s
-      renderer.render(rows)
+      render(rows)
     end
 
     # Coerce an Enumerable into a Table
+    # This coercion mechanism is used by Table to handle Enumerable types
+    # and force them into array type.
     #
     # @param [Enumerable] object
     #    the object to coerce
     #
-    def self.coerce(object)
-      if object.kind_of?(TTY::Table)
-        object
-      elsif object.kind_of?(Hash)
-        array = [object.keys]
-        array << object.values
-      end
+    # @return [Array]
+    #
+    # @api public
+    def coerce(rows)
+      convert_to_array(rows)
     end
 
   private