tty-table 0.1.0 → 0.2.0

data/lib/tty-table.rb

@@ -6,6 +6,7 @@ require 'necromancer'
 require 'verse'
 require 'tty-screen'
 require 'pastel'
+require 'unicode_utils'
 
 require 'tty/table/header'
 require 'tty/table/row'
@@ -22,23 +23,22 @@ require 'tty/table/border/ascii'
 require 'tty/table/border/null'
 require 'tty/table/border/row_line'
 
-require 'tty/table/renderer'
-require 'tty/table/renderer/ascii'
 require 'tty/table/renderer/basic'
-require 'tty/table/renderer/color'
+require 'tty/table/renderer/ascii'
 require 'tty/table/renderer/unicode'
+require 'tty/table/renderer'
 
+require 'tty/table/alignment_set'
 require 'tty/table/column_set'
-require 'tty/table/columns'
+require 'tty/table/column_constraint'
 require 'tty/table/orientation'
 require 'tty/table/orientation/horizontal'
 require 'tty/table/orientation/vertical'
 require 'tty/table/transformation'
 require 'tty/table/indentation'
-require 'tty/table/padder'
 
 require 'tty/table/operations'
-require 'tty/table/operation/alignment_set'
+require 'tty/table/operation/alignment'
 require 'tty/table/operation/truncation'
 require 'tty/table/operation/wrapped'
 require 'tty/table/operation/filter'

data/lib/tty/table.rb

@@ -61,19 +61,18 @@ module TTY
     # Instantiate a new Table
     #
     # @example of no header
-    #   rows  = [ ['a1', 'a2'], ['b1', 'b2'] ]
-    #   table = Table.new rows
+    #   table = Table.new [['a1', 'a2'], ['b1', 'b2']]
     #
     # @example of direct parameters
-    #   rows  = [ ['a1', 'a2'], ['b1', 'b2'] ]
+    #   rows  = [['a1', 'a2'], ['b1', 'b2']]
     #   table = Table.new ['Header 1', 'Header 2'], rows
     #
     # @example of parameters passed as options
-    #   rows  = [ ['a1', 'a2'], ['b1', 'b2'] ]
+    #   rows  = [['a1', 'a2'], ['b1', 'b2']]
     #   table = Table.new header: ['Header 1', 'Header 2'], rows: rows
     #
     # @example of parameters passed as hash
-    #   Table.new [ {'Header1' => ['a1','a2'], 'Header2' => ['b1', 'b2'] }] }
+    #   Table.new [{'Header1' => ['a1','a2'], 'Header2' => ['b1', 'b2'] }]}
     #
     # @param [Array[Symbol], Hash] *args
     #
@@ -156,8 +155,8 @@ module TTY
     #
     # @api private
     def rotate_vertical
-      @original_columns = column_size
-      @original_rows    = row_size
+      @original_columns = columns_size
+      @original_rows    = rows_size
       @rows             = orientation.slice(self)
       @header           = [] if header
       @rotated          = true
@@ -179,6 +178,15 @@ module TTY
 
     # Lookup element of the table given a row(i) and column(j)
     #
+    # @param [Integer] row_index
+    # @param [Integer] column_index
+    #
+    # @example
+    #   table = TTY::Table.new [['a1','a2'], ['b1','b2']]
+    #   table[0]    # => ['a1','a2']
+    #   table[0,0]  # => 'a1'
+    #   table[-1]   # => ['b1','b2']
+    #
     # @api public
     def [](row_index, column_index = false)
       return row(row_index) unless column_index
@@ -188,9 +196,9 @@ module TTY
         fail TTY::Table::TupleMissing.new(row_index, column_index)
       end
     end
-    alias at        []
-    alias element   []
-    alias component []
+    alias_method :at, :[]
+    alias_method :element, :[]
+    alias_method :component, :[]
 
     # Set table value at row(i) and column(j)
     #
@@ -204,9 +212,9 @@ module TTY
     # 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| ... }
+    #   rows  = [['a1', 'a2'], ['b1', 'b2']]
+    #   table = TTY::Table.new rows: rows
+    #   table.row(1) { |row| ... }
     #
     # @param [Integer] index
     #
@@ -247,7 +255,7 @@ module TTY
     #
     # @api public
     def column(index)
-      index_unknown = index.is_a?(Integer) && (index >= column_size || index < 0)
+      index_unknown = index.is_a?(Integer) && (index >= columns_size || index < 0)
       if block_given?
         return self if index_unknown
         rows.map { |row| yield row[index] }
@@ -288,29 +296,22 @@ module TTY
       self
     end
 
-    # Iterate over each element yielding in addition row and column index
+    # Same as #each but passes the index of the row with the row itself
     #
     # @example
     #   table = TTY::Table.new(header, tuples)
-    #   table.each_with_index { |el, row, col| puts "#{el} at #{row},#{col}" }
+    #   table.each_with_index { |row, index|
+    #     puts "#{row} at #{index}"
+    #   }
     #
     # @return self
     #
     # @api public
     def each_with_index
       return to_enum unless block_given?
-      start_index = 0
-      if header && !header.empty?
-        header.attributes.each_with_index do |el, col_index|
-          yield el, 0, col_index
-        end
-        start_index = 1
-      end
-
-      rows.each_with_index do |row, row_index|
-        row.fields.each_with_index do |el, col_index|
-          yield el, row_index + start_index, col_index
-        end
+      start_index = -1
+      data.each do |row|
+        yield row.to_a, start_index += 1
       end
       self
     end
@@ -318,13 +319,12 @@ module TTY
     # Return the number of columns
     #
     # @example
-    #   table.column_size # => 5
+    #   table.columns_size # => 5
     #
     # @return [Integer]
     #
     # @api public
-    # TODO: renmae to columns_size
-    def column_size
+    def columns_size
       rows.size > 0 ? rows[0].size : 0
     end
 
@@ -336,7 +336,7 @@ module TTY
     # @return [Integer]
     #
     # @api public
-    def row_size
+    def rows_size
       rows.size
     end
 
@@ -349,7 +349,7 @@ module TTY
     #
     # @api public
     def size
-      [row_size, column_size]
+      [rows_size, columns_size]
     end
 
     # Check table width
@@ -368,7 +368,7 @@ module TTY
     #
     # @api public
     def empty?
-      column_size == 0 || row_size == 0
+      columns_size == 0 || rows_size == 0
     end
 
     # Return string representation of table using basic renderer.

data/lib/tty/table/alignment_set.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+module TTY
+  class Table
+    # A class responsible for column alignments
+    #
+    # Used internally by {TTY::Table::Operation::Alignment}
+    class AlignmentSet
+      include Enumerable
+
+      DEFAULT = :left
+
+      # Initialize an AlignmentSet
+      #
+      # @param [AlignmentSet, Array] alignments
+      #   the alignments for the renderer
+      #
+      # @api private
+      def initialize(alignments)
+        @converter = Necromancer.new
+        @alignments = @converter.convert(alignments).to(:array).map(&:to_sym)
+      end
+
+      # Iterate over each element in the alignment set
+      #
+      # @example
+      #   alignment = AlignmentSet.new [1,2,3]
+      #   alignment.each { |element| ... }
+      #
+      # @return [self]
+      #
+      # @api public
+      def each
+        return to_enum unless block_given?
+        to_ary.each { |element| yield element }
+        self
+      end
+
+      # Lookup an alignment by index
+      #
+      # @param [Integer]
+      #
+      # @return [Symbol] alignment
+      #
+      # @api public
+      def [](index)
+        alignments.fetch(index, DEFAULT)
+      end
+
+      # Convert to array
+      #
+      # @return [Array]
+      #
+      # @api public
+      def to_ary
+        alignments.to_a
+      end
+
+      # String representation of aligments
+      #
+      # @return [String]
+      #
+      # @api public
+      def to_s
+        to_ary
+      end
+
+      private
+
+      attr_reader :alignments
+    end # AlignmentSet
+  end # Table
+end # TTY

data/lib/tty/table/border.rb

@@ -13,17 +13,6 @@ module TTY
       # Represent a separtor on each row
       EACH_ROW = :each_row
 
-      # The row field widths
-      #
-      # @api private
-      attr_reader :widths
-      private :widths
-
-      # The table custom border characters
-      attr_reader :border
-
-      # The table
-
       class << self
         # Store characters for border
         #
@@ -41,12 +30,13 @@ module TTY
       # @return [Object]
       #
       # @api private
-      def initialize(column_widths, options = nil)
+      def initialize(column_widths, padding, options = nil)
         if self.class == Border
           fail NotImplementedError, "#{self} is an abstract class"
         else
           @widths = column_widths
-          @border = TTY::Table::BorderOptions.from options
+          @padding = Verse::Padder.parse(padding)
+          @border_options = TTY::Table::BorderOptions.from options
           @color  = Pastel.new
         end
       end
@@ -66,7 +56,7 @@ module TTY
         self.characters = dsl.characters
       end
 
-      # Retrive individula character by type
+      # Retrive individual character by type
       #
       # @param [String] type
       #   the character type
@@ -76,7 +66,11 @@ module TTY
       # @api private
       def [](type)
         characters = self.class.characters
-        chars = border.nil? ? characters : characters.merge(border.characters)
+        chars = if border_options.nil?
+                  characters
+                else
+                  characters.merge(border_options.characters)
+                end
         chars[type] || EMPTY_CHAR
       end
 
@@ -86,20 +80,7 @@ module TTY
       #
       # @api public
       def color?
-        border && border.style
-      end
-
-      # Set color on characters
-      #
-      # @param [Symbol] color
-      #
-      # @param [Array[String]] array of strings
-      #
-      # @return [Array[String]]
-      #
-      # @api public
-      def set_color(color, *strings)
-        strings.map { |string| @color.decorate(string, color) }
+        border_options && border_options.style
       end
 
       # A line spanning all columns marking top of a table.
@@ -139,14 +120,48 @@ module TTY
       # @api public
       def row_line(row)
         line = RowLine.new(self['left'], self['center'], self['right'])
-        line.colorize(self, border.style) if color?
+        line.colorize(self, border_options.style) if color?
 
         result = row_heights(row, line)
         result.empty? ? EMPTY_CHAR : result
       end
 
+      # Set color on characters
+      #
+      # @param [Symbol] color
+      #
+      # @param [Array[String]] array of strings
+      #
+      # @return [Array[String]]
+      #
+      # @api public
+      def set_color(color, *strings)
+        strings.map do |string|
+          if string.gsub(/\s+/, '').empty?
+            string
+          else
+            @color.decorate(string, color)
+          end
+        end
+      end
+
       protected
 
+      # The row field widths
+      #
+      # @api private
+      attr_reader :widths
+
+      # The table custom border options including styling
+      #
+      # @api private
+      attr_reader :border_options
+
+      # The padding to apply to each field
+      #
+      # @api private
+      attr_reader :padding
+
       # Separate multiline string into individual rows with border.
       #
       # @param [TTY::Table::Row] row
@@ -180,7 +195,9 @@ module TTY
       # @api private
       def row_height_line(row, line_index, line)
         line.left + row.fields.each_with_index.map do |field, index|
-          (field.lines[line_index] || EMPTY_CHAR).ljust(widths[index])
+          direction     = field.alignment || :left
+          field_content = field.lines[line_index] || SPACE_CHAR * field.length
+          Verse.align(field_content, widths[index], direction)
         end.join(line.center) + line.right
       end
 
@@ -198,21 +215,22 @@ module TTY
                            self["#{type}_right"] || border_char,
                            self["#{type}_mid"])
 
-        if color? && !line.empty?
-          line = set_color(border.style, line)
-        end
-        line
+        return line unless color?
+        set_color(border_options.style, line).join
       end
 
       # Generate a border string
       #
       # @param [String] line
+      #   the line character
       #
       # @return [String]
       #
       # @api private
       def render_line(line, left, right, intersection)
-        left + widths.map { |width| line * width }.join(intersection) + right
+        left + widths.map do |width|
+          line * (padding.left + width + padding.right)
+        end.join(intersection) + right
       end
     end # Border
   end # Table

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

@@ -14,22 +14,22 @@ module TTY
         #
         # @api private
         def top_line
-          border ? super : nil
+          border_options ? super : nil
         end
 
         # A stub separator line
         #
         # @api private
         def separator
-          return [] if border.separator == EACH_ROW
-          border ? super : nil
+          return [] if border_options.separator == EACH_ROW
+          border_options ? super : nil
         end
 
         # A stub bottom line
         #
         # @api private
         def bottom_line
-          border ? super : nil
+          border_options ? super : nil
         end
       end # Null
     end # Border