terminal-table 1.7.2 → 3.0.1

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

@@ -0,0 +1,4 @@
+First Name,Last Name,Email
+TJ,Holowaychuk,tj@vision-media.ca
+Bob,Someone,bob@vision-media.ca
+Joe,Whatever,joe@vision-media.ca

data/examples/examples_unicode.rb

@@ -0,0 +1,89 @@
+#!/usr/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/issue118.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/terminal-table'
+
+puts Terminal::Table.new(headings: ['a', 'b', 'c', 'd'], style: { border: :unicode })
+
+puts
+
+tbl = Terminal::Table.new do |t|
+  t.style = { border: :unicode }
+  t.add_separator
+  t.add_separator
+  t.add_row ['x','y','z']
+  t.add_separator
+  t.add_separator
+end
+puts tbl
+
+puts
+
+puts Terminal::Table.new(headings: [['a', 'b', 'c', 'd'], ['cat','dog','frog','mouse']], style: { border: :unicode })
+
+puts
+
+puts Terminal::Table.new(headings: ['a', 'b', 'c', 'd'])
+
+puts
+
+tbl = Terminal::Table.new do |t|
+  t.add_separator
+  t.add_separator
+  t.add_row ['x','y','z']
+  t.add_separator
+  t.add_separator
+end
+puts tbl

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

@@ -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