terminal-table 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b60d520a9834db6cc69515928da37ecbe590ca52b25a1b309ee33eb8c0b1bb78
-  data.tar.gz: b7958982dfdffcd93bdb1df97cfcb9ad154f81b1ba8553787e4e388f2d78e0bb
+  metadata.gz: beedfc15a1d047a36f3086b433e525c3b02d49e34922c76853bd2d16c006be31
+  data.tar.gz: 844ec9d624be42cd0dfaa5f33a930e4d1353cd48c1f24a36bc47173c3809d38a
 SHA512:
-  metadata.gz: d45e247eb8e5c3713fa273da5b7a2a6cf656a953bf2fd5f23932cbbb3bada619155a9dccacd87bd0eb84c50ce2f51989b59c0400650b62f3002ff5b4d51d38de
-  data.tar.gz: e1d3dbd179da62d871e3dd577580d2350a5ab0554f0f4b8acb043bb855560f6dd2c0dd698c499a38650f17863be6a5a9b41024ce80c1b6deccd0cfe7c93534c3
+  metadata.gz: 0e649b65e3692f51cdefd96d1b472cce78df675e57ed02cb96bf5444211fb99778e911d6a2e80cab30b419941f7541a93f86376bb8eaaa6726d38bc1b93f6866
+  data.tar.gz: e2982cd89c3255ac8d95b0ad2009ed35cd102c38c8c49fc6e8a01022a8f3c4a747eaa3918dd7ca0acf389c0748ac6fd5590d0c5b5d7d84bc2e4d70d134dfdd43

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    terminal-table (3.0.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
+    terminal-table (3.0.1)
+      unicode-display_width (>= 1.1.1, < 3)
 
 GEM
   remote: https://rubygems.org/
@@ -30,7 +30,7 @@ GEM
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     tins (1.0.1)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
@@ -46,4 +46,4 @@ DEPENDENCIES
   tins (~> 1.0.0)
 
 BUNDLED WITH
-   2.2.0
+   2.2.3

data/History.rdoc

@@ -1,4 +1,11 @@
+3.0.1 / 2021-05-10
+==================
+
+- Support for unicode-display_width 2.0
+- Fix issue where last row of an empty table changed format
+
 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.
 

data/README.md

@@ -1,4 +1,5 @@
-[<img src="https://github.com/tj/terminal-table/workflows/CI/badge.svg"/>](https://github.com/tj/terminal-table/actions)
+[![CI status](https://github.com/tj/terminal-table/workflows/CI/badge.svg)](https://github.com/tj/terminal-table/actions)
+[![Gem Version](https://badge.fury.io/rb/terminal-table.svg)](https://badge.fury.io/rb/terminal-table)
 
 # Terminal Table
 
@@ -63,10 +64,10 @@ To add separators between rows:
 
 ```ruby
 table = Terminal::Table.new do |t|
-  t << ['One', 1]
-  t << :separator
+  t << ['One', 1]          # Using << (push) as an alias for add_row
+  t << :separator          # Using << with :separator as an alias for add_separator
   t.add_row ['Two', 2]
-  t.add_separator
+  t.add_separator          # Note - this version allows setting the separator's border_type
   t.add_row ['Three', 3]
 end
 
@@ -128,7 +129,7 @@ table = Terminal::Table.new :title => "Cheatsheet", :headings => ['Word', 'Numbe
 
 # > puts table
 #
-# +------------+--------+
+# +---------------------+
 # |     Cheatsheet      |
 # +------------+--------+
 # | Word       | Number |
@@ -196,7 +197,7 @@ table.style = {:width => 40, :padding_left => 3, :border_x => "=", :border_i =>
 
 # > puts table
 #
-# x====================x=================x
+# x======================================x
 # |               Cheatsheet             |
 # x====================x=================x
 # |   Word             |   Number        |
@@ -286,9 +287,9 @@ 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.
+Support for Unicode 'box art' borders presented a challenge, as the original 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.
+For the sake of backward compatiblity, the previous interface is still supported, as this gem has been around a long time and making breaking changes would have been 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:
 ```
@@ -307,7 +308,7 @@ 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:
+Per popular request, Markdown formatted tables can be generated by using the following border style:
 
 ```
 table.style = { :border => :markdown }
@@ -320,37 +321,40 @@ table.style = { :border => :ascii }
 ```
 
 ### Customizing Borders
-Inside the `UnicodeBorder` class, there are definitions for a variety of corner/intersection types.
+Inside the `UnicodeBorder` class, there are definitions for a variety of corner/intersection and divider types.
 
-```
+```ruby
 @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: "┘",
+  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: '╍',
 }
 ```
 
 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.
+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:
+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 elements can be these can be overridden by poking setting the Hash, should the need arise:
 
 ```
 table.style = {border: :unicode}
-table.style.border[:nw] = '*'  # override the north-west corner of the table
+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).
+Row-separators can now be customized in a variety of ways.  The default separator's border_type is referred to as `:div`.  Additional separator border types (e.g. `:double`, `:heavy`, `:dash` - see full list below) can be applied to separate the 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.
+The separator's `border_type`  may be specified when a user-defined separator is 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:
 
@@ -360,13 +364,12 @@ Separator `border_type`s can be adjusted to be heavy, use double-lines, and diff
     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.
+Alternatively, if `style: :all_separators` is used at the table level, it may be necessary to elaborate the implicit Separator rows prior to rendering.
 ```ruby
 table = Terminal::Table.new do |t|
   t.add_row [1, 'One']
@@ -379,6 +382,29 @@ rows[2].border_type = :heavy # modify separator row: emphasize below title
 puts table.render
 ```
 
+## Example: Displaying a small CSV spreadsheet
+
+This example code demonstrates using Terminal-table and CSV to display a small spreadsheet.
+
+```ruby
+#!/usr/bin/env ruby
+require "csv"
+require "terminal-table"
+use_stdin = ARGV[0].nil? || (ARGV[0] == '-')
+io_object = use_stdin ? $stdin : File.open(ARGV[0], 'r')
+csv = CSV.new(io_object)
+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
+```
+
+See also `examples/show_csv_table.rb` in the source distribution.
+
 ## More examples
 
 For more examples, please see the `examples` directory included in the

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

@@ -1,4 +1,4 @@
-#!/bin/env ruby
+#!/usr/bin/env ruby
 
 $:.unshift File.dirname(__FILE__) + '/../lib'
 require 'terminal-table/import'

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/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/lib/terminal-table/cell.rb

@@ -1,4 +1,4 @@
-require 'unicode/display_width/no_string_ext'
+require 'unicode/display_width'
 
 module Terminal
   class Table
@@ -81,6 +81,14 @@ module Terminal
         end
         inner_width + padding
       end
+
+      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
 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 = []

data/lib/terminal-table/table.rb

@@ -1,4 +1,4 @@
-require 'unicode/display_width/no_string_ext'
+require 'unicode/display_width'
 
 module Terminal
   class Table

data/lib/terminal-table/version.rb

@@ -1,5 +1,5 @@
 module Terminal
   class Table
-    VERSION = '3.0.0'
+    VERSION = '3.0.1'
   end
 end

data/terminal-table.gemspec

@@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "term-ansicolor"
   spec.add_development_dependency "pry"
 
-  spec.add_runtime_dependency "unicode-display_width", ["~> 1.1", ">= 1.1.1"]
+  spec.add_runtime_dependency "unicode-display_width", [">= 1.1.1", "< 3"]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal-table
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,22 +85,22 @@ dependencies:
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 description:
 email:
 - tj@vision-media.ca
@@ -118,11 +118,14 @@ files:
 - README.md
 - Rakefile
 - Todo.rdoc
+- examples/data.csv
 - examples/examples.rb
 - examples/examples_unicode.rb
 - examples/issue100.rb
 - examples/issue111.rb
+- examples/issue118.rb
 - examples/issue95.rb
+- examples/show_csv_table.rb
 - examples/strong_separator.rb
 - lib/terminal-table.rb
 - lib/terminal-table/cell.rb
@@ -154,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Simple, feature rich ascii table generation library