terminal-table 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e955f9096ab89f2568bd233c53dcb58d38172fceff26123d1ff60a8af951e71
-  data.tar.gz: 5c46d6e5cdeb4d233901374a5a5671768731e01ba246ee87ebc04788ea48de11
+  metadata.gz: b60d520a9834db6cc69515928da37ecbe590ca52b25a1b309ee33eb8c0b1bb78
+  data.tar.gz: b7958982dfdffcd93bdb1df97cfcb9ad154f81b1ba8553787e4e388f2d78e0bb
 SHA512:
-  metadata.gz: d11bc2fbcfec5b822035e97b0c6e2e5393c06b54770b53dd0067f7120fd55a2382f9027186bd0ac2633c926788347df794a0672cdfd476c14754e310f2d1608b
-  data.tar.gz: 7f69a5f7c6282defa0e2d9aebec91ab549a6d577520d8cc2d1d32116831234e36d9def50ee9d5995c900e0c8a82057f2a13e943164f259e85d09e7797008c599
+  metadata.gz: d45e247eb8e5c3713fa273da5b7a2a6cf656a953bf2fd5f23932cbbb3bada619155a9dccacd87bd0eb84c50ce2f51989b59c0400650b62f3002ff5b4d51d38de
+  data.tar.gz: e1d3dbd179da62d871e3dd577580d2350a5ab0554f0f4b8acb043bb855560f6dd2c0dd698c499a38650f17863be6a5a9b41024ce80c1b6deccd0cfe7c93534c3

data/.gitignore

@@ -5,3 +5,6 @@ tmp
 doc
 vendor
 /.bundle
+
+# tempfiles
+*~

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    terminal-table (2.0.0)
+    terminal-table (3.0.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
 
 GEM
@@ -14,19 +14,19 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     tins (1.0.1)
@@ -34,6 +34,7 @@ GEM
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2)
@@ -45,4 +46,4 @@ DEPENDENCIES
   tins (~> 1.0.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.0

data/History.rdoc

@@ -1,3 +1,39 @@
+3.0.0 / 2020-01-27
+
+- Support for (optional) Unicode border styles on tables.  In order to support decent looking Unicode borders, different types of intersections get different types of intersection characters.  This has the side effect of subtle formatting differences even for the ASCII table border case due to removal of certain intersections near colspans.
+
+For example, previously the output of a table may be:
+        +------+-----+
+        |   Title    |
+        +------+-----+
+        | Char | Num |
+        +------+-----+
+        | a    | 1   |
+        | b    | 2   |
+        | c    | 3   |
+        +------+-----+
+
+And now the `+` character above the word Title is removed, as it is no longer considered an intersection:
+
+        +------------+
+        |   Title    |
+        +------+-----+
+        | Char | Num |
+        +------+-----+
+        | a    | 1   |
+        | b    | 2   |
+        +------+-----+
+
+- The default border remains an ASCII border for backwards compatibility, however multiple border classes are included / documented, and user defined border types can be applied as needed.
+
+In support of this update, the following issues were addressed:
+- colspan creates conflict with colorize (#95)
+- Use nice UTF box-drawing characters by default (#99)
+    - Note that `AsciiBorder` is stll the default
+- Border-left and border-right style (#100)
+- Helper function to style as Markdown (#111)
+    - Achieved using `MarkdownBorder`
+
 2.0.0 / 2020-10-28
 ==================
 

data/README.md

@@ -0,0 +1,391 @@
+[<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 table generator
+written in Ruby.  It supports ASCII and Unicode formatted tables.
+
+## Installation
+
+```
+$ gem install terminal-table
+```
+## Usage
+
+### Basics
+
+To use Terminal Table:
+
+```ruby
+require 'terminal-table'
+```
+To generate a table, provide an array of arrays (which are interpreted as
+rows):
+
+```ruby
+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:
+
+```ruby
+table = Terminal::Table.new do |t|
+  t.rows = rows
+end
+
+table = Terminal::Table.new do
+  self.rows = rows
+end
+```
+Adding rows one by one:
+
+```ruby
+table = Terminal::Table.new do |t|
+  t << ['One', 1]
+  t.add_row ['Two', 2]
+end
+```
+To add separators between rows:
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+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.
+
+```ruby
+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 |
+```
+
+And also to disable left and right borders of the table.
+
+```ruby
+table = Terminal::Table.new do |t|
+  t.headings = ['id', 'name']
+  t.rows = [[1, 'One'], [2, 'Two'], [3, 'Three']]
+  t.style = { :border_left => false, :border_right => false }
+end
+
+# > puts table
+# ----+-------
+#  id | name
+# ----+-------
+#  1  | One
+#  2  | Two
+#  3  | Three
+# ----+-------
+```
+
+To change the default style options:
+
+```ruby
+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:
+
+```ruby
+table = Terminal::Table.new
+table.title = "Cheatsheet"
+table.headings = ['Word', 'Number']
+table.rows = rows
+table.style = {:width => 40}
+```
+
+## New Formatting
+
+### Unicode Table Borders
+A support for Unicode 'box art' borders presented a challenge, as the basics of terminal-table only handled three border types:  horizontal (x), vertical (y), and intersection (i).  For proper box-art, it became necessary to enable different types of corners/edges for multiple intersection types.
+
+For the sake of backward compatiblity, the previous interface is still supported, this gem has been around a long time and making breaking changes would be inconvenient.  The new interface is required for any complex and/or unicode style bordering. A few variations on border style are supported via some new classes and creation of additional classes (or modification of characters used in existing ones) will allow for customized border types.
+
+The simplest way to use an alternate border is one of the following:
+```
+table.style = { :border => :unicode }
+table.style = { :border => :unicode_round }
+table.style = { :border => :unicode_thick_edge }
+```
+
+These are a convenience wrapper around setting border using an instance of a class that inherits from Table::Terminal::Border
+```
+table.style = { :border => Terminal::Table::UnicodeBorder.new() }
+table.style = { :border => Terminal::Table::UnicodeRoundBorder.new() }
+table.style = { :border => Terminal::Table::UnicodeThickEdgeBorder.new() }
+```
+
+If you define a custom class and wish to use the symbol shortcut, you must namespace within `Terminal::Table` and end your class name with `Border`.
+
+### Markdown Compatiblity
+Per popular request, markdown formatted tables can be generated by using the following border style:
+
+```
+table.style = { :border => :markdown }
+```
+
+### Ascii Borders
+Ascii borders are default, but can be explicitly set with:
+```
+table.style = { :border => :ascii }
+```
+
+### Customizing Borders
+Inside the `UnicodeBorder` class, there are definitions for a variety of corner/intersection types.
+
+```
+@data = {
+nil => nil,
+nw: "┌", nx: "─", n:  "┬", ne: "┐",
+yw: "│",          y:  "│", ye: "│", 
+aw: "╞", ax: "═", ai: "╪", ae: "╡", ad: '╤', au: "╧",
+bw: "┝", bx: "━", bi: "┿", be: "┥", bd: '┯', bu: "┷",
+w:  "├", x:  "─", i:  "┼", e:  "┤", dn: "┬", up: "┴",
+sw: "└", sx: "─", s:  "┴", se: "┘",
+}
+```
+
+Note that many are defined as directional (:nw == north-west), others defined in terms of 'x' or 'y'.
+The border that separates headings (below each heading) is of type `:double` and is defined with 'a*' entries.
+Alternate `:heavy` types that can be applied to separators can be defined with 'b*' entries.
+
+When defining a new set of borders, it's probably easiest to define a new class that inherits from UnicodeBorder and replaces the @data Hash.
+However, these corners can be these can be overridden with:
+
+```
+table.style = {border: :unicode}
+table.style.border[:nw] = '*'  # override the north-west corner of the table
+```
+
+### Customizing row separators
+
+Row-separators can now be customized in a variety of ways.  The default separator's border_type is referred to as `:mid`.  Additional `:strong` / `:strong_a` and `:strong_b` separator styles can be applied to separate sections (e.g. header/footer/title).
+
+The separator border_type may be specified when a user-defined separator added.  Alternatively, borders may be adjusted after the table's rows are elaborated, but before the table is rendered.
+
+Separator `border_type`s can be adjusted to be heavy, use double-lines, and different dash/dot styles.  The border type should be one of:
+
+    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
+
+
+To manually set the separator border_type, the `add_separator` method may be called.
+```ruby
+add_separator(border_type: :heavy_dash)
+```
+
+Alternatively, if `style: :all_separators` is used, it may be necessary to elaborate the Rows prior to rendering.
+```ruby
+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
+rows = table.elaborate_rows
+rows[2].border_type = :heavy # modify separator row: emphasize below title
+puts table.render
+```
+
+## More examples
+
+For more examples, please see the `examples` directory included in the
+source distribution.
+
+## Author
+
+TJ Holowaychuk <tj@vision-media.ca>
+
+Unicode table support by Ben Bowers https://github.com/nanobowers