terminal-table 1.8.0 → 3.0.2

data/examples/issue95.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'colorize'
+require_relative '../lib/terminal-table.rb'
+
+original_sample_data = [
+["Sep 2016", 33, [-38, -53.52], 46, [-25, -35.21]],
+["Oct 2016", 35, [2, 6.06], 50, [4, 8.69]]
+]
+
+table = Terminal::Table.new headings: ["Month".cyan,"Monthly IT".cyan,"IT Difference OPM".cyan,
+"Monthly OOT".cyan,"OOT Difference OPM".cyan], rows: original_sample_data
+
+table.style = { padding_left: 2, padding_right: 2, border_x: "-".blue, border_y: "|".blue, border_i: "+".blue }
+
+puts table
+
+puts ""
+puts "^ good table"
+puts "v wonky table"
+puts ""
+
+split_column_sample_data = [
+["Sep 2016", 33, -38, -53.52, 46, -25, -35.21],
+["Oct 2016", 35, 2, 6.06, 50, 4, 8.69]
+]
+
+table = Terminal::Table.new headings: ["Month".cyan,"Monthly IT".cyan,
+{value: "IT Difference OPM".cyan, colspan: 2}, "Monthly OOT".cyan,
+{value: "OOT Difference OPM".cyan, colspan: 2}], rows: split_column_sample_data
+
+table.style = { padding_left: 2, padding_right: 2, border_x: "-".blue, border_y: "|".blue, border_i: "+".blue }
+
+puts table
+
+
+table = Terminal::Table.new headings: ["Month","Monthly IT",
+{value: "IT Difference OPM", colspan: 2}, "Monthly OOT",
+{value: "OOT Difference OPM", colspan: 2}], rows: split_column_sample_data
+
+table.style = { padding_left: 2, padding_right: 2, border_x: "-".blue, border_y: "|".cyan, border_i: "+" }
+
+puts table

data/examples/show_csv_table.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require "csv"
+$LOAD_PATH << "#{__dir__}/../lib"
+require "terminal-table"
+
+#
+# Usage:
+#   ./show_csv_table.rb data.csv
+#   cat data.csv | ./show_csv_table.rb
+#   cat data.csv | ./show_csv_table.rb -
+#
+#
+# Reads a CSV from $stdin if no argument given, or argument is '-'
+# otherwise interprets first cmdline argument as the CSV filename
+#
+use_stdin = ARGV[0].nil? || (ARGV[0] == '-')
+io_object = use_stdin ? $stdin : File.open(ARGV[0], 'r')
+csv = CSV.new(io_object)
+
+#
+# Convert to an array for use w/ terminal-table
+# The assumption is that this is a pretty small spreadsheet.
+#
+csv_array = csv.to_a
+
+user_table = Terminal::Table.new do |v|
+  v.style = { :border => :unicode_round } # >= v3.0.0
+  v.title = "Some Title"
+  v.headings = csv_array[0]
+  v.rows = csv_array[1..-1]
+end
+
+puts user_table

data/examples/strong_separator.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require_relative "../lib/terminal-table"
+
+#
+# An example of how to manually add separators with non-default
+# border_type to enable a footer row.
+#
+table = Terminal::Table.new do |t|
+  # set the style
+  t.style = { border: :unicode_thick_edge }
+  
+  # header row
+  t.headings = ['fruit', 'count']
+
+  # some row data
+  t.add_row ['apples', 7]
+  t.add_row ['bananas', 19]
+  t.add_separator border_type: :strong
+  # footer row
+  t.add_row ['total', 26] 
+end
+
+puts table.render

data/lib/terminal-table/cell.rb

@@ -57,7 +57,7 @@ module Terminal
       def render(line = 0)
         left = " " * @table.style.padding_left
         right = " " * @table.style.padding_right
-        display_width = Unicode::DisplayWidth.of(escape(lines[line]))
+        display_width = Unicode::DisplayWidth.of(Util::ansi_escape(lines[line]))
         render_width = lines[line].to_s.size - display_width + width
         align("#{left}#{lines[line]}#{right}", alignment, render_width + @table.cell_padding)
       end
@@ -68,7 +68,7 @@ module Terminal
       # removes all ANSI escape sequences (e.g. color)
 
       def value_for_column_width_recalc
-        lines.map{ |s| escape(s) }.max_by{ |s| Unicode::DisplayWidth.of(s) }
+        lines.map{ |s| Util::ansi_escape(s) }.max_by{ |s| Unicode::DisplayWidth.of(s) }
       end
 
       ##
@@ -82,12 +82,12 @@ module Terminal
         inner_width + padding
       end
 
-      ##
-      # removes all ANSI escape sequences (e.g. color)
-      def escape(line)
-        line.to_s.gsub(/\x1b(\[|\(|\))[;?0-9]*[0-9A-Za-z]/, '').
-          gsub(/\x1b(\[|\(|\))[;?0-9]*[0-9A-Za-z]/, '').
-          gsub(/(\x03|\x1a)/, '')
+      def inspect
+        fields = %i[alignment colspan index value width].map do |name|
+          val = self.instance_variable_get('@'+name.to_s)
+          "@#{name}=#{val.inspect}"
+        end.join(', ')
+        return "#<#{self.class} #{fields}>"
       end
     end
   end

data/lib/terminal-table/row.rb

@@ -12,7 +12,7 @@ module Terminal
       ##
       # Initialize with _width_ and _options_.
 
-      def initialize table, array = []
+      def initialize table, array = [], **_kwargs
         @cell_index = 0
         @table = table
         @cells = []
@@ -36,17 +36,31 @@ module Terminal
       end
 
       def render
-        y = @table.style.border_y
+        vleft, vcenter, vright = @table.style.vertical
         (0...height).to_a.map do |line|
-          y + cells.map do |cell|
+          vleft + cells.map do |cell|
             cell.render(line)
-          end.join(y) + y
+          end.join(vcenter) + vright
         end.join("\n")
       end
 
       def number_of_columns
         @cells.collect(&:colspan).inject(0, &:+)
       end
+
+      # used to find indices where we have table '+' crossings.
+      # in cases where the colspan > 1, then we will skip over some numbers
+      # if colspan is always 1, then the list should be incrementing by 1.
+      #
+      # skip 0 entry, because it's the left side.
+      # skip last entry, because it's the right side.
+      # we only care about "+/T" style crossings.
+      def crossings
+        idx = 0
+        @cells[0...-1].map { |c| idx += c.colspan } 
+      end
+      
     end
+
   end
 end

data/lib/terminal-table/separator.rb

@@ -2,13 +2,65 @@ module Terminal
   class Table
     class Separator < Row
 
+      ##
+      # `prevrow`, `nextrow` contain references to adjacent rows.
+      #
+      # `border_type` is a symbol used to control which type of border is used
+      # on the separator (:top for top-edge, :bot for bottom-edge,
+      # :div for interior, and :strong for emphasized-interior)
+      #
+      # `implicit` is false for user-added separators, and true for
+      # implicit/auto-generated separators.
+      
+      def initialize(*args, border_type: :div, implicit: false)
+        super
+        @prevrow, @nextrow = nil, nil
+        @border_type = border_type
+        @implicit = implicit
+      end
+
+      attr_accessor :border_type
+      attr_reader :implicit
+      
       def render
-        arr_x = (0...@table.number_of_columns).to_a.map do |i|
-          @table.style.border_x * (@table.column_width(i) + @table.cell_padding)
+        left_edge, ctrflat, ctrud, right_edge, ctrdn, ctrup = @table.style.horizontal(border_type)
+        
+        prev_crossings = @prevrow.respond_to?(:crossings) ? @prevrow.crossings : []
+        next_crossings = @nextrow.respond_to?(:crossings) ? @nextrow.crossings : []
+        rval = [left_edge]
+        numcols = @table.number_of_columns
+        (0...numcols).each do |idx|
+          rval << ctrflat * (@table.column_width(idx) + @table.cell_padding)
+          pcinc = prev_crossings.include?(idx+1)
+          ncinc = next_crossings.include?(idx+1)
+          border_center = if pcinc && ncinc
+                            ctrud
+                          elsif pcinc
+                            ctrup
+                          elsif ncinc
+                            ctrdn
+                          elsif !ctrud.empty?
+                            # special case if the center-up-down intersection is empty
+                            # which happens when verticals/intersections are removed. in that case
+                            # we do not want to replace with a flat element so return empty-string in else block
+                            ctrflat
+                          else
+                            ''
+                          end
+          rval << border_center if idx < numcols-1
         end
-        border_i = @table.style.border_i
-        border_i + arr_x.join(border_i) + border_i
+          
+        rval << right_edge
+        rval.join
+      end
+
+      # Save off neighboring rows, so that we can use them later in determining
+      # which types of table edges to use.
+      def save_adjacent_rows(prevrow, nextrow)
+        @prevrow = prevrow
+        @nextrow = nextrow
       end
+      
     end
   end
 end

data/lib/terminal-table/style.rb

@@ -1,5 +1,171 @@
+# coding: utf-8
+require 'forwardable'
+
 module Terminal
   class Table
+
+    class Border
+
+      attr_accessor :data, :top, :bottom, :left, :right
+      def initialize
+        @top, @bottom, @left, @right = true, true, true, true
+      end
+      def []=(key, val)
+        @data[key] = val
+      end
+      def [](key)
+        @data[key]
+      end
+      def initialize_dup(other)
+        super
+        @data = other.data.dup
+      end
+      def remove_verticals 
+        self.class.const_get("VERTICALS").each { |key| @data[key] = "" }
+        self.class.const_get("INTERSECTIONS").each { |key| @data[key] = "" }
+      end
+      def remove_horizontals 
+        self.class.const_get("HORIZONTALS").each { |key| @data[key] = "" }
+      end
+      
+      # If @left, return the edge else empty-string.
+      def maybeleft(key) ; @left ? @data[key] : '' ; end
+      
+      # If @right, return the edge else empty-string.
+      def mayberight(key) ; @right ? @data[key] : '' ; end
+
+    end
+    
+    class AsciiBorder < Border
+      HORIZONTALS = %i[x]
+      VERTICALS = %i[y]
+      INTERSECTIONS = %i[i]
+      
+      def initialize
+        super
+        @data = { x: "-", y: "|", i:  "+" }
+      end
+      
+      # Get vertical border elements
+      # @return [Array] 3-element list of [left, center, right]
+      def vertical
+        [maybeleft(:y), @data[:y], mayberight(:y)] # left, center, right
+      end
+      
+      # Get horizontal border elements
+      # @return [Array] a 6 element list of: [i-left, horizontal-bar, i-up/down, i-right, i-down, i-up]
+      def horizontal(_type)
+        x, i = @data[:x], @data[:i]
+        [maybeleft(:i), x, i, mayberight(:i), i, i]
+      end
+    end
+
+    class MarkdownBorder < AsciiBorder
+      def initialize
+        super
+        @top, @bottom = false, false
+        @data = { x: "-", y: "|", i:  "|" }
+      end
+    end
+    
+    class UnicodeBorder < Border
+
+      ALLOWED_SEPARATOR_BORDER_STYLES = %i[
+      top bot 
+      div dash dot3 dot4 
+      thick thick_dash thick_dot3 thick_dot4
+      heavy heavy_dash heavy_dot3 heavy_dot4
+      bold bold_dash bold_dot3 bold_dot4
+      double
+      ]  
+
+      HORIZONTALS = %i[x sx ax bx nx bx_dot3 bx_dot4 bx_dash x_dot3 x_dot4 x_dash]
+      VERTICALS = %i[y yw ye]
+      INTERSECTIONS = %i[nw n ne nd 
+                         aw ai ae ad au
+                         bw bi be bd bu
+                         w i e dn up 
+                         sw s se su]
+      def initialize
+        super
+        @data = {
+          nil => nil,
+          nw: "┌", nx: "─", n:  "┬", ne: "┐",
+          yw: "│",          y:  "│", ye: "│", 
+          aw: "╞", ax: "═", ai: "╪", ae: "╡", ad: '╤', au: "╧", # double
+          bw: "┝", bx: "━", bi: "┿", be: "┥", bd: '┯', bu: "┷", # heavy/bold/thick
+          w:  "├", x:  "─", i:  "┼", e:  "┤", dn: "┬", up: "┴", # normal div
+          sw: "└", sx: "─", s:  "┴", se: "┘",
+          # alternative dots/dashes
+          x_dot4:  '┈', x_dot3:  '┄', x_dash:  '╌',
+          bx_dot4: '┉', bx_dot3: '┅', bx_dash: '╍',
+        }
+      end
+      # Get vertical border elements
+      # @return [Array] 3-element list of [left, center, right]
+      def vertical
+        [maybeleft(:yw), @data[:y], mayberight(:ye)] 
+      end
+
+      # Get horizontal border elements
+      # @return [Array] a 6 element list of: [i-left, horizontal-bar, i-up/down, i-right, i-down, i-up]
+      def horizontal(type)
+        raise ArgumentError, "Border type is #{type.inspect}, must be one of #{ALLOWED_SEPARATOR_BORDER_STYLES.inspect}" unless ALLOWED_SEPARATOR_BORDER_STYLES.include?(type)
+        lookup = case type
+                 when :top
+                   [:nw, :nx, :n, :ne, :n, nil]
+                 when :bot
+                   [:sw, :sx, :s, :se, nil, :s]
+                 when :double
+                   # typically used for the separator below the heading row or above a footer row)
+                   [:aw, :ax, :ai, :ae, :ad, :au]
+                 when :thick, :thick_dash, :thick_dot3, :thick_dot4,
+                      :heavy, :heavy_dash, :heavy_dot3, :heavy_dot4,
+                      :bold, :bold_dash, :bold_dot3, :bold_dot4
+                   # alternate thick/bold border
+                   xref = type.to_s.sub(/^(thick|heavy|bold)/,'bx').to_sym
+                   [:bw, xref, :bi, :be, :bd, :bu]
+                 when :dash, :dot3, :dot4
+                   # alternate thin dividers
+                   xref = "x_#{type}".to_sym
+                   [:w, xref, :i, :e, :dn, :up]
+                 else  # :div (center, non-emphasized)
+                   [:w, :x, :i, :e, :dn, :up]
+                 end
+        rval = lookup.map { |key| @data.fetch(key) }
+        rval[0] = '' unless @left
+        rval[3] = '' unless @right
+        rval
+      end
+    end
+
+    # Unicode Border With rounded edges
+    class UnicodeRoundBorder < UnicodeBorder
+      def initialize
+        super
+        @data.merge!({nw: '╭', ne: '╮', sw: '╰', se: '╯'})
+      end
+    end
+
+    # Unicode Border with thick outer edges
+    class UnicodeThickEdgeBorder < UnicodeBorder
+      def initialize
+        super
+        @data = {
+          nil => nil,
+          nw: "┏", nx: "━", n:  "┯", ne: "┓", nd: nil,
+          yw: "┃",          y:  "│", ye: "┃", 
+          aw: "┣", ax: "═", ai: "╪", ae: "┫", ad: '╤', au: "╧", # double
+          bw: "┣", bx: "━", bi: "┿", be: "┫", bd: '┯', bu: "┷", # heavy/bold/thick
+          w:  "┠", x:  "─", i:  "┼", e:  "┨", dn: "┬", up: "┴", # normal div
+          sw: "┗", sx: "━", s:  "┷", se: "┛", su:  nil,
+          # alternative dots/dashes
+          x_dot4:  '┈', x_dot3:  '┄', x_dash:  '╌',
+          bx_dot4: '┉', bx_dot3: '┅', bx_dash: '╍',
+        }
+      end
+    end
+    
     # A Style object holds all the formatting information for a Table object
     #
     # To create a table with a certain style, use either the constructor
@@ -22,20 +188,51 @@ module Terminal
     #     Terminal::Table::Style.defaults = {:width => 80}
     #
     class Style
+      extend Forwardable
+      def_delegators :@border, :vertical, :horizontal, :remove_verticals, :remove_horizontals
+      
       @@defaults = {
-        :border_x => "-", :border_y => "|", :border_i => "+",
-        :border_top => true, :border_bottom => true,
+        :border => AsciiBorder.new,
         :padding_left => 1, :padding_right => 1,
         :margin_left => '',
         :width => nil, :alignment => nil,
-        :all_separators => false
+        :all_separators => false,
       }
 
-      attr_accessor :border_x
-      attr_accessor :border_y
-      attr_accessor :border_i
-      attr_accessor :border_top
-      attr_accessor :border_bottom
+      ## settors/gettor for legacy ascii borders
+      def border_x=(val) ; @border[:x] = val ; end
+      def border_y=(val) ; @border[:y] = val ; end
+      def border_i=(val) ; @border[:i] = val ; end
+      def border_y ; @border[:y] ; end
+      def border_y_width ; Util::ansi_escape(@border[:y]).length ; end
+
+      # Accessor for instance of Border
+      attr_reader :border
+      def border=(val)
+        if val.is_a? Symbol
+          # convert symbol name like :foo_bar to get class FooBarBorder
+          klass_str = val.to_s.split('_').collect(&:capitalize).join + "Border"
+          begin
+            klass = Terminal::Table::const_get(klass_str)
+            @border = klass.new
+          rescue NameError
+            raise "Cannot lookup class Terminal::Table::#{klass_str} from symbol #{val.inspect}"
+          end
+        else
+          @border = val
+        end
+      end
+
+      def border_top=(val) ; @border.top = val ; end
+      def border_bottom=(val) ; @border.bottom = val ; end
+      def border_left=(val) ; @border.left = val ; end
+      def border_right=(val) ; @border.right = val ; end
+
+      def border_top ; @border.top ; end
+      def border_bottom ; @border.bottom ; end
+      def border_left ; @border.left ; end
+      def border_right ; @border.right ; end
+
 
       attr_accessor :padding_left
       attr_accessor :padding_right
@@ -47,23 +244,30 @@ module Terminal
 
       attr_accessor :all_separators
 
-
+      
       def initialize options = {}
         apply self.class.defaults.merge(options)
       end
 
       def apply options
-        options.each { |m, v| __send__ "#{m}=", v }
+        options.each do |m, v|
+          __send__ "#{m}=", v
+        end
       end
-
+      
       class << self
         def defaults
-          @@defaults
+          klass_defaults = @@defaults.dup
+          # border is an object that needs to be duplicated on instantiation,
+          # otherwise everything will be referencing the same object-id.
+          klass_defaults[:border] = klass_defaults[:border].dup
+          klass_defaults
         end
-
+        
         def defaults= options
           @@defaults = defaults.merge(options)
         end
+
       end
 
       def on_change attr
@@ -74,6 +278,7 @@ module Terminal
           yield attr.to_sym, value
         end
       end
+          
     end
   end
 end

data/lib/terminal-table/table.rb

@@ -7,9 +7,10 @@ module Terminal
     attr_reader :headings
 
     ##
-    # Generates a ASCII table with the given _options_.
+    # Generates a ASCII/Unicode table with the given _options_.
 
     def initialize options = {}, &block
+      @elaborated = false
       @headings = []
       @rows = []
       @column_widths = []
@@ -26,9 +27,8 @@ module Terminal
     # Align column _n_ to the given _alignment_ of :center, :left, or :right.
 
     def align_column n, alignment
-      r = rows
-      column(n).each_with_index do |col, i|
-        cell = r[i][n]
+      # nil forces the column method to return the cell itself
+      column(n, nil).each do |cell|
         cell.alignment = alignment unless cell.alignment?
       end
     end
@@ -46,12 +46,12 @@ module Terminal
     ##
     # Add a separator.
 
-    def add_separator
-      self << :separator
+    def add_separator(border_type: :div)
+      @rows << Separator.new(self, border_type: border_type)
     end
 
     def cell_spacing
-      cell_padding + style.border_y.length
+      cell_padding + style.border_y_width
     end
 
     def cell_padding
@@ -118,28 +118,57 @@ module Terminal
     end
 
     ##
-    # Render the table.
+    # Elaborate rows to form an Array of Rows and Separators with adjacency properties added.
+    #
+    # This is separated from the String rendering so that certain features may be tweaked
+    # before the String is built.
 
-    def render
-      separator = Separator.new(self)
-      buffer = style.border_top ? [separator] : []
+    def elaborate_rows
+
+      buffer = style.border_top ? [Separator.new(self, border_type: :top, implicit: true)] : []
       unless @title.nil?
         buffer << Row.new(self, [title_cell_options])
-        buffer << separator
+        buffer << Separator.new(self, implicit: true)
       end
       @headings.each do |row|
         unless row.cells.empty?
           buffer << row
-          buffer << separator
+          buffer << Separator.new(self, border_type: :double, implicit: true)
         end
       end
       if style.all_separators
-        buffer += @rows.product([separator]).flatten
+        @rows.each_with_index do |row, idx|
+          # last separator is bottom, others are :div
+          border_type = (idx == @rows.size - 1) ? :bot : :div
+          buffer << row
+          buffer << Separator.new(self, border_type: border_type, implicit: true)
+        end
       else
         buffer += @rows
-        buffer << separator if style.border_bottom
+        buffer << Separator.new(self, border_type: :bot, implicit: true) if style.border_bottom
+      end
+
+      # After all implicit Separators are inserted we need to save off the
+      # adjacent rows so that we can decide what type of intersections to use
+      # based on column spans in the adjacent row(s).
+      buffer.each_with_index do |r, idx|
+        if r.is_a?(Separator)
+          prev_row = idx > 0 ? buffer[idx - 1] : nil
+          next_row = buffer.fetch(idx + 1, nil)
+          r.save_adjacent_rows(prev_row, next_row)
+        end
       end
-      buffer.map { |r| style.margin_left + r.render.rstrip }.join("\n")
+      
+      @elaborated = true
+      @rows = buffer
+    end
+
+    ##
+    # Render the table.
+
+    def render
+      elaborate_rows unless @elaborated
+      @rows.map { |r| style.margin_left + r.render.rstrip }.join("\n")
     end
     alias :to_s :render
 
@@ -181,7 +210,7 @@ module Terminal
     private
 
     def columns_width
-      column_widths.inject(0) { |s, i| s + i + cell_spacing } + style.border_y.length
+      column_widths.inject(0) { |s, i| s + i + cell_spacing } + style.border_y_width
     end
 
     def recalc_column_widths
@@ -300,7 +329,7 @@ module Terminal
 
       full_width = dp[n_cols][0].keys.first
       unless style.width.nil?
-        new_width = style.width - space_width - style.border_y.length
+        new_width = style.width - space_width - style.border_y_width
         if new_width < full_width
           raise "Table width exceeds wanted width " +
                 "of #{style.width} characters."

data/lib/terminal-table/util.rb

@@ -0,0 +1,13 @@
+module Terminal
+  class Table
+    module Util
+      # removes all ANSI escape sequences (e.g. color)
+      def ansi_escape(line)
+        line.to_s.gsub(/\x1b(\[|\(|\))[;?0-9]*[0-9A-Za-z]/, '').
+          gsub(/\x1b(\[|\(|\))[;?0-9]*[0-9A-Za-z]/, '').
+          gsub(/(\x03|\x1a)/, '')
+      end
+      module_function :ansi_escape
+    end
+  end
+end

data/lib/terminal-table/version.rb

@@ -1,5 +1,5 @@
 module Terminal
   class Table
-    VERSION = '1.8.0'
+    VERSION = '3.0.2'
   end
 end

data/lib/terminal-table.rb

@@ -21,6 +21,6 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-%w(cell row separator style table table_helper version).each do |file|
-  require "terminal-table/#{file}"
+%w(cell row separator style table table_helper util version).each do |file|
+  require_relative "./terminal-table/#{file}"
 end