terminal-table 2.0.0 → 3.0.0

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 = []
@@ -47,12 +48,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
@@ -119,28 +120,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
 
@@ -182,7 +212,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
@@ -301,7 +331,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 = '2.0.0'
+    VERSION = '3.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal-table
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-01 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,10 +115,15 @@ files:
 - History.rdoc
 - LICENSE.txt
 - Manifest
-- README.rdoc
+- README.md
 - Rakefile
 - Todo.rdoc
 - examples/examples.rb
+- examples/examples_unicode.rb
+- examples/issue100.rb
+- examples/issue111.rb
+- examples/issue95.rb
+- examples/strong_separator.rb
 - lib/terminal-table.rb
 - lib/terminal-table/cell.rb
 - lib/terminal-table/import.rb
@@ -127,6 +132,7 @@ files:
 - lib/terminal-table/style.rb
 - lib/terminal-table/table.rb
 - lib/terminal-table/table_helper.rb
+- lib/terminal-table/util.rb
 - lib/terminal-table/version.rb
 - terminal-table.gemspec
 homepage: https://github.com/tj/terminal-table

data/README.rdoc

@@ -1,249 +0,0 @@
-{<img src="https://github.com/tj/terminal-table/workflows/CI/badge.svg" />}[https://github.com/tj/terminal-table/actions]
-
-= Terminal Table
-
-== Description
-
-Terminal Table is a fast and simple, yet feature rich ASCII table generator written in Ruby.
-
-== Installation
-
-  $ gem install terminal-table
-
-== Usage
-
-=== Basics
-
-To use Terminal Table:
-
-  require 'terminal-table'
-
-To generate a table, provide an array of arrays (which are interpreted as rows):
-
-  rows = []
-  rows << ['One', 1]
-  rows << ['Two', 2]
-  rows << ['Three', 3]
-  table = Terminal::Table.new :rows => rows
-
-  # > puts table
-  #
-  # +-------+---+
-  # | One   | 1 |
-  # | Two   | 2 |
-  # | Three | 3 |
-  # +-------+---+
-
-
-The constructor can also be given a block which is either yielded the Table object or instance evaluated:
-
-  table = Terminal::Table.new do |t|
-    t.rows = rows
-  end
-
-  table = Terminal::Table.new do
-    self.rows = rows
-  end
-
-Adding rows one by one:
-
-  table = Terminal::Table.new do |t|
-    t << ['One', 1]
-    t.add_row ['Two', 2]
-  end
-
-To add separators between rows:
-
-  table = Terminal::Table.new do |t|
-    t << ['One', 1]
-    t << :separator
-    t.add_row ['Two', 2]
-    t.add_separator
-    t.add_row ['Three', 3]
-  end
-
-  # > puts table
-  #
-  # +-------+---+
-  # | One   | 1 |
-  # +-------+---+
-  # | Two   | 2 |
-  # +-------+---+
-  # | Three | 3 |
-  # +-------+---+
-
-Cells can handle multiline content:
-
-  table = Terminal::Table.new do |t|
-    t << ['One', 1]
-    t << :separator
-    t.add_row ["Two\nDouble", 2]
-    t.add_separator
-    t.add_row ['Three', 3]
-  end
-
-  # > puts table
-  #
-  # +--------+---+
-  # | One    | 1 |
-  # +--------+---+
-  # | Two    | 2 |
-  # | Double |   |
-  # +--------+---+
-  # | Three  | 3 |
-  # +--------+---+
-
-=== Head
-
-To add a head to the table:
-
-  table = Terminal::Table.new :headings => ['Word', 'Number'], :rows => rows
-
-  # > puts table
-  #
-  # +-------+--------+
-  # | Word  | Number |
-  # +-------+--------+
-  # | One   | 1      |
-  # | Two   | 2      |
-  # | Three | 3      |
-  # +-------+--------+
-
-=== Title
-
-To add a title to the table:
-
-  table = Terminal::Table.new :title => "Cheatsheet", :headings => ['Word', 'Number'], :rows => rows
-
-  # > puts table
-  #
-  # +------------+--------+
-  # |     Cheatsheet      |
-  # +------------+--------+
-  # | Word       | Number |
-  # +------------+--------+
-  # | One        | 1      |
-  # | Two        | 2      |
-  # | Three      | 3      |
-  # +------------+--------+
-
-=== Alignment
-
-To align the second column to the right:
-
-  table.align_column(1, :right)
-
-  # > puts table
-  #
-  # +-------+--------+
-  # | Word  | Number |
-  # +-------+--------+
-  # | One   |      1 |
-  # | Two   |      2 |
-  # | Three |      3 |
-  # +-------+--------+
-
-To align an individual cell, you specify the cell value in a hash along the alignment:
-
-  table << ["Four", {:value => 4.0, :alignment => :center}]
-
-  # > puts table
-  #
-  # +-------+--------+
-  # | Word  | Number |
-  # +-------+--------+
-  # | One   |      1 |
-  # | Two   |      2 |
-  # | Three |      3 |
-  # | Four  |  4.0   |
-  # +-------+--------+
-
-=== Style
-
-To specify style options:
-
-  table = Terminal::Table.new :headings => ['Word', 'Number'], :rows => rows, :style => {:width => 80}
-
-  # > puts table
-  #
-  # +--------------------------------------+---------------------------------------+
-  # | Word                                 | Number                                |
-  # +--------------------------------------+---------------------------------------+
-  # | One                                  | 1                                     |
-  # | Two                                  | 2                                     |
-  # | Three                                | 3                                     |
-  # +--------------------------------------+---------------------------------------+
-
-And change styles on the fly:
-
-  table.style = {:width => 40, :padding_left => 3, :border_x => "=", :border_i => "x"}
-
-  # > puts table
-  #
-  # x====================x=================x
-  # |               Cheatsheet             |
-  # x====================x=================x
-  # |   Word             |   Number        |
-  # x====================x=================x
-  # |   One              |   1             |
-  # |   Two              |   2             |
-  # |   Three            |   3             |
-  # x====================x=================x
-
-You can also use styles to add a separator after every row:
-
-  table = Terminal::Table.new do |t|
-    t.add_row [1, 'One']
-    t.add_row [2, 'Two']
-    t.add_row [3, 'Three']
-    t.style = {:all_separators => true}
-  end
-
-  # > puts table
-  #
-  # +---+-------+
-  # | 1 | One   |
-  # +---+-------+
-  # | 2 | Two   |
-  # +---+-------+
-  # | 3 | Three |
-  # +---+-------+
-
-You can also use styles to disable top and bottom borders of the table
-
-  table = Terminal::Table.new do |t|
-    t.headings = ['id', 'name']
-    t.rows = [[1, 'One'], [2, 'Two'], [3, 'Three']]
-    t.style = { :border_top => false, :border_bottom => false }
-  end
-
-  # > puts table
-  # | id | name  |
-  # +----+-------+
-  # | 1  | One   |
-  # | 2  | Two   |
-  # | 3  | Three |
-
-To change the default style options:
-
-  Terminal::Table::Style.defaults = {:width => 80}
-
-All Table objects created afterwards will inherit these defaults.
-
-=== Constructor options and setter methods
-
-Valid options for the constructor are :rows, :headings, :style and :title - and all options can also be set on the created table object by their setter method:
-
-  table = Terminal::Table.new
-  table.title = "Cheatsheet"
-  table.headings = ['Word', 'Number']
-  table.rows = rows
-  table.style = {:width => 40}
-
-== More examples
-
-For more examples, please see the examples/examples.rb file included in the source distribution.
-
-== Author
-
-TJ Holowaychuk <tj@vision-media.ca>