terminal-table 1.7.2 → 3.0.1

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,23 +244,30 @@ 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
@@ -71,6 +278,7 @@ module Terminal
           yield attr.to_sym, value
         end
       end
+          
     end
   end
 end

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 = []
@@ -29,6 +30,7 @@ module Terminal
       r = rows
       column(n).each_with_index do |col, i|
         cell = r[i][n]
+        next unless cell
         cell.alignment = alignment unless cell.alignment?
       end
     end
@@ -46,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
@@ -94,7 +96,7 @@ module Terminal
     # Return length of column _n_.
 
     def column_width n
-      width = column_widths[n] || 0
+      column_widths[n] || 0
     end
     alias length_of_column column_width # for legacy support
 
@@ -118,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 = [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
+        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
 
@@ -181,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
@@ -245,11 +276,11 @@ module Terminal
           end
 
           # sort reversely and store it back.
-          dp[colspan][index] = rmap.sort.reverse.to_h
+          dp[colspan][index] = Hash[rmap.sort.reverse]
         end
       end
 
-      resolve = -> (colspan, full_width, index = 0) do
+      resolve = lambda do |colspan, full_width, index = 0|
         # stop if reaches the bottom level.
         return @column_widths[index] = full_width if colspan == 1
 
@@ -300,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 = '1.7.2'
+    VERSION = '3.0.1'
   end
 end

data/terminal-table.gemspec

@@ -16,11 +16,11 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", ">= 3.0"
   spec.add_development_dependency "term-ansicolor"
   spec.add_development_dependency "pry"
 
-  spec.add_runtime_dependency "unicode-display_width", "~> 1.1.1"
+  spec.add_runtime_dependency "unicode-display_width", [">= 1.1.1", "< 3"]
 end