tty-table 0.7.0 → 0.12.0

data/lib/tty-table.rb

@@ -1,5 +1 @@
-# encoding: utf-8
-
-require 'tty/table/error'
-require 'tty/table/version'
-require 'tty/table'
+require_relative "tty/table"

data/lib/tty/table.rb

@@ -1,23 +1,22 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-require 'equatable'
-require 'forwardable'
-require 'necromancer'
+require "forwardable"
 
-require 'tty/table/column_set'
-require 'tty/table/header'
-require 'tty/table/orientation'
-require 'tty/table/row'
-require 'tty/table/renderer'
-require 'tty/table/transformation'
-require 'tty/table/validatable'
+require_relative "table/columns"
+require_relative "table/header"
+require_relative "table/orientation"
+require_relative "table/row"
+require_relative "table/renderer"
+require_relative "table/transformation"
+require_relative "table/validatable"
+require_relative "table/version"
 
 module TTY
   # A core class intended for storing data in a structured, tabular form.
   # Once the data is stored in a TTY::Table various operations can be performed
   # before the information is dumped into a stdout.
   class Table
-    include Comparable, Enumerable, Validatable, Equatable
+    include Comparable, Enumerable, Validatable
     extend Forwardable
 
     # The table header
@@ -37,21 +36,21 @@ module TTY
 
     # The table orientation out of :horizontal and :vertical
     #
-    # @reutrn [TTY::Table::Orientation]
+    # @return [TTY::Table::Orientation]
     #
     # @api public
     attr_reader :orientation
 
     # The table original row count
     #
-    # @reutrn [Integer]
+    # @return [Integer]
     #
     # @api public
     attr_reader :original_rows
 
     # The table original column count
     #
-    # @reutrn [Integer]
+    # @return [Integer]
     #
     # @api public
     attr_reader :original_columns
@@ -63,7 +62,7 @@ module TTY
     # Create a new Table where each argument is a row
     #
     # @example
-    #   table = TTY::Table[['a1', 'a2'], ['b1', 'b2']]
+    #   table = TTY::Table[["a1", "a2"], ["b1", "b2"]]
     #
     # @api public
     def self.[](*rows)
@@ -73,20 +72,20 @@ module TTY
     # Instantiate a new Table
     #
     # @example of no header
-    #   table = Table.new [['a1', 'a2'], ['b1', 'b2']]
+    #   table = Table.new [["a1", "a2"], ["b1", "b2"]]
     #
     # @example of direct parameters
-    #   rows  = [['a1', 'a2'], ['b1', 'b2']]
-    #   table = Table.new ['Header 1', 'Header 2'], rows
+    #   rows  = [["a1", "a2"], ["b1", "b2"]]
+    #   table = Table.new ["Header 1", "Header 2"], rows
     #
     # @example of parameters passed as options
-    #   rows  = [['a1', 'a2'], ['b1', 'b2']]
-    #   table = Table.new header: ['Header 1', 'Header 2'], rows: rows
+    #   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
+    # @param [Array[Symbol], Hash] args
     #
     # @api public
     def self.new(*args, &block)
@@ -114,7 +113,6 @@ module TTY
     # @api private
     def initialize(options = {}, &block)
       validate_options! options
-      @converter     = Necromancer.new
       @header        = (value = options[:header]) ? Header.new(value) : nil
       @rows          = coerce(options.fetch(:rows) { Row.new([]) })
       @rotated       = false
@@ -126,6 +124,15 @@ module TTY
       yield_or_eval(&block) if block_given?
     end
 
+    # Provides a list of rows to have separations applied
+    #
+    # @return [Array]
+    #
+    # @api public
+    def separators
+      @separators ||= []
+    end
+
     # Provides access to all table data
     #
     # @return [Array]
@@ -194,10 +201,10 @@ module TTY
     # @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']
+    #   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)
@@ -205,12 +212,12 @@ module TTY
       if row_index >= 0 && column_index >= 0
         rows.fetch(row_index) { return nil }[column_index]
       else
-        fail TTY::Table::TupleMissing.new(row_index, column_index)
+        raise TTY::Table::TupleMissing.new(row_index, column_index)
       end
     end
-    alias_method :at, :[]
-    alias_method :element, :[]
-    alias_method :component, :[]
+    alias at []
+    alias element []
+    alias component []
 
     # Set table value at row(i) and column(j)
     #
@@ -224,7 +231,7 @@ module TTY
     # When a block is given, the elements of that Array are iterated over.
     #
     # @example
-    #   rows  = [['a1', 'a2'], ['b1', 'b2']]
+    #   rows  = [["a1", "a2"], ["b1", "b2"]]
     #   table = TTY::Table.new rows: rows
     #   table.row(1) { |row| ... }
     #
@@ -251,7 +258,7 @@ module TTY
     #
     # @example
     #   header = [:h1, :h2]
-    #   rows  = [ ['a1', 'a2'], ['b1', 'b2'] ]
+    #   rows  = [ ["a1", "a2"], ["b1", "b2"] ]
     #   table = TTY::Table.new :rows => rows, :header => header
     #   table.column(1)
     #   table.column(1)   { |element| ... }
@@ -285,9 +292,12 @@ module TTY
     #
     # @api public
     def <<(row)
-      rows_copy = rows.dup
-      assert_row_sizes rows_copy << row
-      rows << to_row(row)
+      if row == Border::SEPARATOR
+        separators << columns_size - (header ? 0 : 2)
+      else
+        assert_row_size(row, rows)
+        rows << to_row(row)
+      end
       self
     end
 
@@ -339,6 +349,7 @@ module TTY
     def columns_size
       rows.size > 0 ? rows[0].size : 0
     end
+    alias columns_count columns_size
 
     # Return the number of rows
     #
@@ -370,7 +381,7 @@ module TTY
     #
     # @api public
     def width
-      ColumnSet.new(self).total_width
+      Columns.total_width(data)
     end
 
     # Return true if this is an empty table, i.e. if the number of
@@ -427,10 +438,12 @@ module TTY
 
     # Render a given table using custom border class.
     #
-    # @param [TTY::Table::Border]
+    # @param [TTY::Table::Border] border_class
     #
     # @param [Symbol] renderer_type
     #
+    # @param [Hash] options
+    #
     # @yield [renderer]
     #
     # @yieldparam [TTY::Table::Renderer] renderer
@@ -455,15 +468,62 @@ module TTY
     # This coercion mechanism is used by Table to handle Enumerable types
     # and force them into array type.
     #
-    # @param [Enumerable] object
+    # @param [Enumerable] rows
     #    the object to coerce
     #
     # @return [Array]
     #
     # @api public
     def coerce(rows)
-      rows = @converter.convert(rows).to(:array)
-      rows.map { |row| to_row(row, header) }
+      coerced_rows = []
+      Array(rows).each do |row|
+        if row == Border::SEPARATOR
+          separators << coerced_rows.length - (header ? 0 : 1)
+        else
+          coerced_rows << to_row(row, header)
+        end
+      end
+      coerced_rows
+    end
+
+    # Compare table for equality of header and rows attributes
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def eql?(other)
+      instance_of?(other.class) &&
+        header.eql?(other.header) && rows.eql?(other.rows)
+    end
+
+    # Compare table for equivalence of header and rows attributes
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def ==(other)
+      other.is_a?(self.class) &&
+        header == other.header && rows == other.rows
+    end
+
+    # Inspect this instance attributes
+    #
+    # @return [String]
+    #
+    # @api public
+    def inspect
+      "#<#{self.class.name} header=#{header.inspect} rows=#{rows.inspect} " \
+        "original_rows=#{original_rows.inspect} " \
+        "original_columns=#{original_columns.inspect}>"
+    end
+
+    # Hash for this instance and its attributes
+    #
+    # @return [Numeric]
+    #
+    # @api public
+    def hash
+      [self.class, header, rows].hash
     end
 
     private

data/lib/tty/table/alignment_set.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'necromancer'
+# frozen_string_literal: true
 
 module TTY
   class Table
@@ -19,8 +17,7 @@ module TTY
       #
       # @api private
       def initialize(alignments)
-        @converter = Necromancer.new
-        @alignments = @converter.convert(alignments).to(:array).map(&:to_sym)
+        @alignments = Array(alignments).map(&:to_sym)
       end
 
       # Iterate over each element in the alignment set
@@ -40,7 +37,7 @@ module TTY
 
       # Lookup an alignment by index
       #
-      # @param [Integer]
+      # @param [Integer] index
       #
       # @return [Symbol] alignment
       #

data/lib/tty/table/border.rb

@@ -1,26 +1,26 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'equatable'
-require 'pastel'
-require 'verse'
+require "pastel"
+require "strings"
 
-require 'tty/table/border_options'
-require 'tty/table/border_dsl'
-require 'tty/table/border/row_line'
+require_relative "border_dsl"
+require_relative "border/row_line"
+require_relative "error"
 
 module TTY
   class Table
     # Abstract base class that is responsible for building the table border.
     class Border
-      include Equatable
+      EMPTY_CHAR = ""
 
-      EMPTY_CHAR = ''.freeze
-
-      SPACE_CHAR = ' '.freeze
+      SPACE_CHAR = " "
 
       # Represent a separtor on each row
       EACH_ROW = :each_row
 
+      # specify a separator as a row
+      SEPARATOR = :separator
+
       class << self
         # Store characters for border
         #
@@ -28,40 +28,40 @@ module TTY
         attr_accessor :characters
       end
 
+      # Define border characters
+      #
+      # @param [Hash] characters
+      #   the border characters
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def self.def_border(characters = (not_set = true), &block)
+        return self.characters = characters unless not_set
+
+        dsl = BorderDSL.new(&block)
+        self.characters = dsl.characters
+      end
+
       # Instantiate a new object
       #
       # @param [Array] column_widths
       #   the table column widths
       #
-      # @param [BorderOptions] options
+      # @param [BorderOptions] border_opts
       #
       # @return [Object]
       #
       # @api private
-      def initialize(column_widths, padding, options = nil)
+      def initialize(column_widths, border_opts = nil)
         if self.class == Border
-          fail NotImplementedError, "#{self} is an abstract class"
-        else
-          @widths = column_widths
-          @padding = Verse::Padder.parse(padding)
-          @border_options = TTY::Table::BorderOptions.from options
-          @color  = Pastel.new
+          raise NotImplementedError, "#{self} is an abstract class"
         end
-      end
-
-      # Define border characters
-      #
-      # @param [Hash] characters
-      #   the border characters
-      #
-      # @return [Hash]
-      #
-      # @api public
-      def self.def_border(characters=(not_set=true), &block)
-        return self.characters = characters unless not_set
 
-        dsl = TTY::Table::BorderDSL.new(&block)
-        self.characters = dsl.characters
+        @widths = column_widths
+        @dsl = BorderDSL.new(border_opts)
+        @characters = self.class.characters.merge(@dsl.characters)
+        @color = Pastel.new
       end
 
       # Retrive individual character by type
@@ -73,13 +73,7 @@ module TTY
       #
       # @api private
       def [](type)
-        characters = self.class.characters
-        chars = if border_options.nil?
-                  characters
-                else
-                  characters.merge(border_options.characters)
-                end
-        chars[type] || EMPTY_CHAR
+        @characters[type] || EMPTY_CHAR
       end
 
       # Check if border color is set
@@ -88,7 +82,7 @@ module TTY
       #
       # @api public
       def color?
-        border_options && border_options.style
+        !!@dsl.style
       end
 
       # A line spanning all columns marking top of a table.
@@ -114,7 +108,7 @@ module TTY
       # @return [String]
       #
       # @api private
-      def separator
+      def middle_line
         (result = render(:mid)).empty? ? nil : result
       end
 
@@ -127,30 +121,27 @@ module TTY
       #
       # @api public
       def row_line(row)
-        line = RowLine.new(self['left'], self['center'], self['right'])
-        line.colorize(self, border_options.style) if color?
+        line = RowLine.new(self["left"], self["center"], self["right"])
+        line.colorize(self, @dsl.style) if color?
 
         result = row_heights(row, line)
         result.empty? ? EMPTY_CHAR : result
       end
 
-      # Set color on characters
+      # Set color for a string
       #
       # @param [Symbol] color
       #
-      # @param [Array[String]] array of strings
+      # @param [String] string
+      #   the string to color
       #
-      # @return [Array[String]]
+      # @return [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
+      def set_color(color, string)
+        return string if string.gsub(/\s+/, EMPTY_CHAR).empty?
+
+        @color.decorate(string, color)
       end
 
       protected
@@ -163,12 +154,9 @@ module TTY
       # 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
+      def border_options
+        @dsl.options
+      end
 
       # Separate multiline string into individual rows with border.
       #
@@ -193,7 +181,7 @@ module TTY
       # @param [TTY::Table::Row] row
       #   the table row
       #
-      # @param [Integer] line
+      # @param [Integer] line_index
       #  the index for current line inside multiline
       #
       # @param [TTY::Table::Border::RowLine] line
@@ -205,14 +193,16 @@ module TTY
         line.left + row.fields.each_with_index.map do |field, index|
           direction     = field.alignment || :left
           field_content = field.lines[line_index] || SPACE_CHAR * field.length
-          Verse.align(field_content, widths[index], direction)
+          Strings.align(field_content, widths[index], direction: direction)
         end.join(line.center) + line.right
       end
 
       # Generate particular border type
       #
       # @param [String] type
-      #  border type one of [:top, :bottom, :mid]
+      #  border type one of :top, :bottom and :mid
+      #
+      # @return [String]
       #
       # @api private
       def render(type)
@@ -224,7 +214,8 @@ module TTY
                            self["#{type}_mid"])
 
         return line unless color?
-        set_color(border_options.style, line).join
+
+        set_color(@dsl.style, line)
       end
 
       # Generate a border string
@@ -236,9 +227,7 @@ module TTY
       #
       # @api private
       def render_line(line, left, right, intersection)
-        left + widths.map do |width|
-          line * (padding.left + width + padding.right)
-        end.join(intersection) + right
+        left + widths.map { |width| line * width }.join(intersection) + right
       end
     end # Border
   end # Table