tty 0.0.4 → 0.0.5

data/.travis.yml

@@ -17,4 +17,4 @@ matrix:
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: jruby-19mode
-    - rvm: rbx-18mode
+    - rvm: rbx-19mode

data/README.md

@@ -10,8 +10,7 @@ Toolbox for developing CLI clients in Ruby.
 
 Jump-start development of your command line app:
 
-* Fully customizable table rendering with an easy-to-use API.
-  (status: In Progress)
+* Fully customizable table rendering with an easy-to-use API. (status: In Progress)
 * Terminal output colorization. (status: TODO)
 * Terminal & System detection utilities. (status: In Progress)
 * Text alignment/padding and diffs. (status: TODO)
@@ -85,15 +84,24 @@ or pass your rows in a block
 And then to print do
 
 ```ruby
-  table.to_s   #  =>  a1  a2  a3
-               #      b1  b2  b3
+  table.to_s
+
+  a1  a2  a3
+  b1  b2  b3
 ```
 
-To print `unicode` table
+To print border around data table you need to specify `renderer` type out of `basic`, `ascii`, `unicode`. For instance to output unicode border:
 
-```ruby
-  table = TTY::Table.new renderer: 'unicode'
+```
+  table = TTY::Table.new ['header1', 'header2'], [['a1', 'a2'], ['b1', 'b2'], renderer: 'unicode'
   table.to_s
+
+  ┌───────┬───────┐
+  │header1│header2│
+  ├───────┼───────┤
+  │a1     │a2     │
+  │b1     │b2     │
+  └───────┴───────┘
 ```
 
 ### Terminal
@@ -105,6 +113,10 @@ To print `unicode` table
   term.color?   # => true or false
 ```
 
+### Shell
+
+Main responsibility is to interact with the prompt and provide convenience methods.
+
 ### System
 
 ```ruby

data/lib/tty.rb

@@ -7,15 +7,25 @@ require 'tty/support/delegatable'
 require 'tty/support/conversion'
 require 'tty/support/coercion'
 require 'tty/support/equatable'
+require 'tty/support/unicode'
 
 require 'tty/color'
 require 'tty/terminal'
 require 'tty/system'
 require 'tty/table'
+require 'tty/vector'
+
+require 'tty/table/border'
+require 'tty/table/border/unicode'
+require 'tty/table/border/ascii'
+require 'tty/table/border/null'
+
+require 'tty/table/column_set'
 
 require 'tty/table/operation/alignment_set'
 require 'tty/table/operation/alignment'
 require 'tty/table/operation/truncation'
+require 'tty/table/operation/wrapped'
 
 module TTY
 

data/lib/tty/support/equatable.rb

@@ -8,6 +8,7 @@ module TTY
     # Hook into module inclusion.
     #
     # @param [Module] base
+    #   the module or class including Equatable
     #
     # @return [self]
     #

data/lib/tty/support/unicode.rb

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  # A mixin to provide unicode support.
+  module Unicode
+
+    def utf8?(string)
+      string.unpack('U*') rescue return false
+      true
+    end
+
+    def clean_utf8(string)
+      require 'iconv'
+      if defined? ::Iconv
+        converter = Iconv.new('UTF-8//IGNORE', 'UTF-8')
+        converter.iconv(string)
+      end
+    rescue Exception
+      string
+    end
+
+    if "".respond_to?(:encode)
+      def as_unicode
+        yield
+      end
+    else
+      def as_unicode
+        old, $KCODE = $KCODE, "U"
+        yield
+      ensure
+        $KCODE = old
+      end
+    end
+
+  end # Unicode
+end # TTY

data/lib/tty/table.rb

@@ -111,8 +111,9 @@ module TTY
       @rows          = coerce(options.fetch :rows, [])
       @renderer      = pick_renderer options[:renderer]
       # TODO: assert that row_size is the same as column widths & aligns
+      # TODO: this is where column extraction should happen!
       @column_widths = options.fetch :column_widths, []
-      @alignments    = Operation::AlignmentSet.new options[:column_aligns]
+      @alignments    = Operation::AlignmentSet.new options[:column_aligns] || []
 
       assert_row_sizes @rows
       yield_or_eval &block if block_given?
@@ -267,8 +268,7 @@ module TTY
     #
     # @api public
     def width
-      render(self)
-      total_width
+      ColumnSet.new(self).extract_widths!.total_width
     end
 
     # Return true if this is an empty table, i.e. if the number of

data/lib/tty/table/border.rb

@@ -0,0 +1,104 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Table
+
+    # Abstract base class that is responsible for building the table border.
+    class Border
+      include Unicode
+
+      NEWLINE = "\n"
+
+      # The row cell widths
+      #
+      # @api private
+      attr_reader :widths
+      private :widths
+
+      # The table row
+      #
+      # @api private
+      attr_reader :row
+      private :row
+
+      # Instantiate a new object
+      #
+      # @return [Object]
+      #
+      # @api private
+      def initialize(*)
+        if self.class == Border
+          raise NotImplementedError, "#{self} is an abstract class"
+        else
+          super
+        end
+      end
+
+      # A line spanning all columns marking top of a table.
+      #
+      # @return [String]
+      #
+      # @api private
+      def top_line
+        render :top
+      end
+
+      # A line spanning all columns delemeting rows in a table.
+      #
+      # @return [String]
+      #
+      # @api private
+      def separator
+        render :mid
+      end
+
+      # A line spanning all columns delemeting cells in a row.
+      #
+      # @return [String]
+      #
+      # @api private
+      def row_line
+        self['left'] + row.join(self['right']) + self['right']
+      end
+
+      # A line spannig all columns marking bottom of a table.
+      #
+      # @return [String]
+      #
+      # @api private
+      def bottom_line
+        render :bottom
+      end
+
+      protected
+
+      # Generate particular border type
+      #
+      # @param [String] type
+      #  border type one of [:top, :bottom, :mid]
+      #
+      # @api private
+      def render(type)
+        type = type.to_s
+        render_line self[type],
+          self["#{type}_left"]  || self[type],
+          self["#{type}_right"] || self[type],
+          self["#{type}_mid"]
+      end
+
+      # Generate a border string
+      #
+      # @param [String] line
+      #
+      # @return [String]
+      #
+      # @api private
+      def render_line(line, left, right, intersection)
+        as_unicode do
+          left + widths.map { |width| line * width }.join(intersection) + right
+        end
+      end
+
+    end # Border
+  end # Table
+end # TTY

data/lib/tty/table/border/ascii.rb

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Table
+    class Border
+
+      # A class that represents an ascii border.
+      class ASCII < Border
+
+        BORDER_TYPE = {
+        'top'          => '-',
+        'top_mid'      => '+',
+        'top_left'     => '+',
+        'top_right'    => '+',
+        'bottom'       => '-',
+        'bottom_mid'   => '+',
+        'bottom_left'  => '+',
+        'bottom_right' => '+',
+        'mid'          => '-',
+        'mid_mid'      => '+',
+        'mid_left'     => '+',
+        'mid_right'    => '+',
+        'left'         => '|',
+        'right'        => '|'
+        }
+
+        # @api private
+        def [](type)
+          BORDER_TYPE[type]
+        end
+
+        # @api private
+        def initialize(row)
+          @row = row
+          @widths = row.map { |cell| cell.chars.to_a.size }
+        end
+
+      end # ASCII
+    end # Border
+  end # Table
+end # TTY

data/lib/tty/table/border/null.rb

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Table
+    class Border
+
+      # A class that represents no border.
+      class Null < Border
+
+        # @api private
+        def initialize(row)
+          @row = row
+          @widths = row.map { |cell| cell.chars.to_a.size }
+        end
+
+        # A stub top line
+        #
+        # @api private
+        def top_line
+          nil
+        end
+
+        # A stub separator line
+        #
+        # @api private
+        def separator
+          nil
+        end
+
+        # A line spanning all columns delemited by space character.
+        #
+        # @return [String]
+        #
+        # @api private
+        def row_line
+          row.join(' ')
+        end
+
+        # A stub bottom line
+        #
+        # @api private
+        def bottom_line
+          nil
+        end
+
+      end # Null
+    end # Border
+  end # Table
+end # TTY

data/lib/tty/table/border/unicode.rb

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Table
+    class Border
+
+      # A class that represents a unicode border.
+      class Unicode < Border
+
+        BORDER_TYPE = {
+        'top'          => '─',
+        'top_mid'      => '┬',
+        'top_left'     => '┌',
+        'top_right'    => '┐',
+        'bottom'       => '─',
+        'bottom_mid'   => '┴',
+        'bottom_left'  => '└',
+        'bottom_right' => '┘',
+        'mid'          => '─',
+        'mid_mid'      => '┼',
+        'mid_left'     => '├',
+        'mid_right'    => '┤',
+        'left'         => '│',
+        'right'        => '│'
+        }
+
+        # @api private
+        def [](type)
+          BORDER_TYPE[type]
+        end
+
+        # @api private
+        def initialize(row)
+          @row = row
+          @widths = row.map { |cell| cell.chars.to_a.size }
+        end
+
+      end # Unicode
+    end # Border
+  end # Table
+end # TTY

data/lib/tty/table/column_set.rb

@@ -0,0 +1,77 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Table
+
+    # A class that represents table columns properties.
+    class ColumnSet
+      include Equatable
+      extend Delegatable
+
+      attr_reader :table
+
+      delegatable_method :table, :column_widths
+
+      def initialize(table)
+        @table = table
+      end
+
+      # Calculate total table width
+      #
+      # @return [Integer]
+      #
+      # @api public
+      def total_width
+        column_widths.reduce(:+)
+      end
+
+      # Calcualte maximum column widths
+      #
+      # @return [Array] column widths
+      #
+      # @api private
+      def extract_widths!
+        return column_widths unless column_widths.empty?
+
+        rows     = table.to_a
+        data     = table.header ? rows + [table.header] : rows
+        colcount = data.max { |row_a, row_b| row_a.size <=> row_b.size }.size
+
+        table.column_widths = find_maximas colcount, data
+        self
+      end
+
+      private
+
+      # Find maximum widths for each row and header if present.
+      #
+      # @param [Integer] colcount
+      #   number of columns
+      # @param [Array[Array]] data
+      #   the table's header and rows
+      #
+      # @api private
+      def find_maximas(colcount, data)
+        maximas = []
+        start   = 0
+
+        start.upto(colcount - 1) do |index|
+          maximas << find_maximum(data, index)
+        end
+        maximas
+      end
+
+      # Find a maximum column width.
+      #
+      # @param [Array] data
+      #
+      # @param [Integer] index
+      #
+      # @api private
+      def find_maximum(data, index)
+        data.map { |row| row[index] ? (row[index].to_s.size) : 0 }.max
+      end
+
+    end # ColumnSet
+  end # Table
+end # TTY