terminal-table 1.7.1 → 3.0.0

data/Rakefile

@@ -1,8 +1,14 @@
-require "bundler/gem_tasks"
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
 
-desc "Run specs"
-task :spec do
-  sh "bundle exec rspec -f progress"
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = %w[-w]
+  t.rspec_opts = %w[--color]
 end
 
 desc "Default: Run specs"

data/examples/examples_unicode.rb

@@ -0,0 +1,89 @@
+#!/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'terminal-table/import'
+
+Terminal::Table::Style.defaults = { :border => :unicode_round }
+# Terminal::Table::UnicodeThickEdgeBorder.new()
+
+puts
+puts table(['a', 'b'], [1, 2], [3, 4])
+
+puts
+puts table(['name', 'content'], ['ftp.example.com', '1.1.1.1'], ['www.example.com', '|lalalala|lalala|'])
+
+puts
+t = table ['a', 'b']
+t.style = {:padding_left => 2, :width => 80}
+t << [1, 2]
+t << [3, 4]
+t << :separator
+t << [4, 6]
+puts t
+
+puts
+user_table = table do |v|
+  v.title = "Contact Information"
+  v.headings = 'First Name', 'Last Name', 'Email'
+  v << %w( TJ Holowaychuk tj@vision-media.ca )
+  v << %w( Bob Someone bob@vision-media.ca )
+  v << %w( Joe Whatever bob@vision-media.ca )
+end
+puts user_table
+
+puts
+user_table = table do |v|
+  v.style.width = 80
+  v.headings = 'First Name', 'Last Name', 'Email'
+  v << %w( TJ Holowaychuk tj@vision-media.ca )
+  v << %w( Bob Someone bob@vision-media.ca )
+  v << %w( Joe Whatever bob@vision-media.ca )
+end
+puts user_table
+
+puts
+user_table = table do
+  self.headings = 'First Name', 'Last Name', 'Email'
+  add_row ['TJ',  'Holowaychuk', 'tj@vision-media.ca']
+  add_row ['Bob', 'Someone',     'bob@vision-media.ca']
+  add_row ['Joe', 'Whatever',    'joe@vision-media.ca']
+  add_separator
+  add_row ['Total', { :value => '3', :colspan => 2, :alignment => :right }]
+  align_column 1, :center
+end
+puts user_table
+
+puts
+user_table = table do
+  self.headings = ['First Name', 'Last Name', {:value => 'Phones', :colspan => 2, :alignment => :center}]
+  #add_row ['Bob', 'Someone',     '123', '456']
+  add_row [{:value => "Bob Someone", :colspan => 3, :alignment => :center}, '123456']
+  add_row :separator
+  add_row ['TJ',  'Holowaychuk', {:value => "No phones\navaiable", :colspan => 2, :alignment => :center}]
+  add_row :separator
+  add_row ['Joe', 'Whatever',    '4324', '343242']
+end
+puts user_table
+
+rows = []
+rows << ['Lines',      100]
+rows << ['Comments',   20]
+rows << ['Ruby',       70]
+rows << ['JavaScript', 30]
+puts table([nil, 'Lines'], *rows)
+
+rows = []
+rows << ['Lines',      100]
+rows << ['Comments',   20]
+rows << ['Ruby',       70]
+rows << ['JavaScript', 30]
+puts table(nil, *rows)
+
+rows = []
+rows << ['Lines',      100]
+rows << ['Comments',   20]
+rows << ['Ruby',       70]
+rows << ['JavaScript', 30]
+table = table([{ :value => 'Stats', :colspan => 2, :alignment => :center }], *rows)
+table.align_column 1, :right
+puts table

data/examples/issue100.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+# Methods to suppress left/right borders using border_left & border_right
+
+require_relative "../lib/terminal-table"
+table = Terminal::Table.new do |t|
+  t.headings = ['id', 'name']
+  t.rows = [[1, 'One'], [2, 'Two'], [3, 'Three']]
+  t.style = { :border_left => false, :border_top => false, :border_bottom => false }
+end
+
+puts table
+puts
+
+# no right
+table.style = {:border_right => false }
+puts table
+puts
+
+# no right
+table.style = {:border_left => true }
+puts table
+puts
+
+table.style.border = Terminal::Table::UnicodeBorder.new
+puts table
+
+
+table.style = {:border_right => false, :border_left => true }
+puts table
+
+table.style = {:border_right => true, :border_left => false }
+puts table
+

data/examples/issue111.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../lib/terminal-table"
+puts Terminal::Table.new(headings: ['heading A', 'heading B'], rows: [['a', 'b'], ['a', 'b']], style: {border: Terminal::Table::MarkdownBorder.new})
+

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/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.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

data/lib/terminal-table/cell.rb

@@ -1,4 +1,4 @@
-require 'unicode/display_width'
+require 'unicode/display_width/no_string_ext'
 
 module Terminal
   class Table
@@ -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
 
       ##
@@ -81,14 +81,6 @@ module Terminal
         end
         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)/, '')
-      end
     end
   end
 end

data/lib/terminal-table/row.rb

@@ -36,13 +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,17 +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 => 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
+      ## 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
@@ -44,24 +244,41 @@ 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
+        method_name = :"#{attr}="
+        old_method = method method_name
+        define_singleton_method(method_name) do |value|
+          old_method.call value
+          yield attr.to_sym, value
+        end
       end
+          
     end
   end
 end