terminal-table 1.7.1 → 3.0.0

data/lib/terminal-table/table.rb

@@ -1,4 +1,4 @@
-require 'unicode/display_width'
+require 'unicode/display_width/no_string_ext'
 
 module Terminal
   class Table
@@ -7,15 +7,20 @@ 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 = []
       self.style = options.fetch :style, {}
       self.headings = options.fetch :headings, []
       self.rows = options.fetch :rows, []
       self.title = options.fetch :title, nil
       yield_or_eval(&block) if block
+
+      style.on_change(:width) { require_column_widths_recalc }
     end
 
     ##
@@ -25,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
@@ -35,19 +41,19 @@ module Terminal
     def add_row array
       row = array == :separator ? Separator.new(self) : Row.new(self, array)
       @rows << row
-      recalc_column_widths row
+      require_column_widths_recalc unless row.is_a?(Separator)
     end
     alias :<< :add_row
 
     ##
     # 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
@@ -90,8 +96,7 @@ module Terminal
     # Return length of column _n_.
 
     def column_width n
-      width = @column_widths[n] || 0
-      width + additional_column_widths[n].to_i
+      column_widths[n] || 0
     end
     alias length_of_column column_width # for legacy support
 
@@ -99,7 +104,7 @@ module Terminal
     # Return total number of columns available.
 
     def number_of_columns
-      headings_with_rows.map { |r| r.cells.size }.max
+      headings_with_rows.map { |r| r.number_of_columns }.max || 0
     end
 
     ##
@@ -109,34 +114,63 @@ module Terminal
       arrays = [arrays] unless arrays.first.is_a?(Array)
       @headings = arrays.map do |array|
         row = Row.new(self, array)
-        recalc_column_widths row
+        require_column_widths_recalc
         row
       end
     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
-      buffer.map { |r| style.margin_left + r.render.rstrip }.join("\n")
+
+      # 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
+      
+      @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
 
@@ -162,7 +196,7 @@ module Terminal
 
     def title=(title)
       @title = title
-      recalc_column_widths Row.new(self, [title_cell_options])
+      require_column_widths_recalc
     end
 
     ##
@@ -178,42 +212,134 @@ 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 additional_column_widths
-      return [] if style.width.nil?
-      spacing = style.width - columns_width
-      if spacing < 0
-        raise "Table width exceeds wanted width of #{style.width} characters."
-      else
-        per_col = spacing / number_of_columns
-        arr = (1...number_of_columns).to_a.map { |i| per_col }
-        other_cols = arr.inject(0) { |s, i| s + i }
-        arr << spacing - other_cols
-        arr
+    def recalc_column_widths
+      @require_column_widths_recalc = false
+      n_cols = number_of_columns
+      space_width = cell_spacing
+      return if n_cols == 0
+
+      # prepare rows
+      all_rows = headings_with_rows
+      all_rows << Row.new(self, [title_cell_options]) unless @title.nil?
+
+      # DP states, dp[colspan][index][split_offset] => column_width.
+      dp = []
+
+      # prepare initial value for DP.
+      all_rows.each do |row|
+        index = 0
+        row.cells.each do |cell|
+          cell_value = cell.value_for_column_width_recalc
+          cell_width = Unicode::DisplayWidth.of(cell_value.to_s)
+          colspan = cell.colspan
+
+          # find column width from each single cell.
+          dp[colspan] ||= []
+          dp[colspan][index] ||= [0]        # add a fake cell with length 0.
+          dp[colspan][index][colspan] ||= 0 # initialize column length to 0.
+
+          # the last index `colspan` means width of the single column (split
+          # at end of each column), not a width made up of multiple columns.
+          single_column_length = [cell_width, dp[colspan][index][colspan]].max
+          dp[colspan][index][colspan] = single_column_length
+
+          index += colspan
+        end
       end
-    end
 
-    def recalc_column_widths row
-      return if row.is_a? Separator
-      i = 0
-      row.cells.each do |cell|
-        colspan = cell.colspan
-        cell_value = cell.value_for_column_width_recalc
-        colspan.downto(1) do |j|
-          cell_length = Unicode::DisplayWidth.of(cell_value.to_s)
-          if colspan > 1
-            spacing_length = cell_spacing * (colspan - 1)
-            length_in_columns = (cell_length - spacing_length)
-            cell_length = (length_in_columns.to_f / colspan).ceil
+      # run DP.
+      (1..n_cols).each do |colspan|
+        dp[colspan] ||= []
+        (0..n_cols-colspan).each do |index|
+          dp[colspan][index] ||= [1]
+          (1...colspan).each do |offset|
+            # processed level became reverse map from width => [offset, ...].
+            left_colspan = offset
+            left_index = index
+            left_width = dp[left_colspan][left_index].keys.first
+
+            right_colspan = colspan - left_colspan
+            right_index = index + offset
+            right_width = dp[right_colspan][right_index].keys.first
+
+            dp[colspan][index][offset] = left_width + right_width + space_width
           end
-          if @column_widths[i].to_i < cell_length
-            @column_widths[i] = cell_length
+
+          # reverse map it for resolution (max width and short offset first).
+          rmap = {}
+          dp[colspan][index].each_with_index do |width, offset|
+            rmap[width] ||= []
+            rmap[width] << offset
+          end
+
+          # sort reversely and store it back.
+          dp[colspan][index] = Hash[rmap.sort.reverse]
+        end
+      end
+
+      resolve = lambda do |colspan, full_width, index = 0|
+        # stop if reaches the bottom level.
+        return @column_widths[index] = full_width if colspan == 1
+
+        # choose best split offset for partition, or second best result
+        # if first one is not dividable.
+        candidate_offsets = dp[colspan][index].collect(&:last).flatten
+        offset = candidate_offsets[0]
+        offset = candidate_offsets[1] if offset == colspan
+
+        # prepare for next round.
+        left_colspan = offset
+        left_index = index
+        left_width = dp[left_colspan][left_index].keys.first
+
+        right_colspan = colspan - left_colspan
+        right_index = index + offset
+        right_width = dp[right_colspan][right_index].keys.first
+
+        # calculate reference column width, give remaining spaces to left.
+        total_non_space_width = full_width - (colspan - 1) * space_width
+        ref_column_width = total_non_space_width / colspan
+        remainder = total_non_space_width % colspan
+        rem_left_width = [remainder, left_colspan].min
+        rem_right_width = remainder - rem_left_width
+        ref_left_width = ref_column_width * left_colspan +
+                         (left_colspan - 1) * space_width + rem_left_width
+        ref_right_width = ref_column_width * right_colspan +
+                          (right_colspan - 1) * space_width + rem_right_width
+
+        # at most one width can be greater than the reference width.
+        if left_width <= ref_left_width and right_width <= ref_right_width
+          # use refernce width (evenly partition).
+          left_width = ref_left_width
+          right_width = ref_right_width
+        else
+          # the wider one takes its value, shorter one takes the rest.
+          if left_width > ref_left_width
+            right_width = full_width - left_width - space_width
+          else
+            left_width = full_width - right_width - space_width
           end
-          i = i + 1
         end
+
+        # run next round.
+        resolve.call(left_colspan, left_width, left_index)
+        resolve.call(right_colspan, right_width, right_index)
+      end
+
+      full_width = dp[n_cols][0].keys.first
+      unless style.width.nil?
+        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."
+        end
+        full_width = new_width
       end
+
+      resolve.call(n_cols, full_width)
     end
 
     ##
@@ -235,5 +361,14 @@ module Terminal
     def title_cell_options
       {:value => @title, :alignment => :center, :colspan => number_of_columns}
     end
+
+    def require_column_widths_recalc
+      @require_column_widths_recalc = true
+    end
+
+    def column_widths
+      recalc_column_widths if @require_column_widths_recalc
+      @column_widths
+    end
   end
 end

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.1'
+    VERSION = '3.0.0'
   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.1.1"]
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: terminal-table
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 3.0.0
 platform: ruby
 authors:
 - TJ Holowaychuk
 - Scott J. Goldman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.1
   type: :runtime
@@ -93,23 +96,34 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.1
-description: 
+description:
 email:
 - tj@vision-media.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - Gemfile
+- Gemfile.lock
 - 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
@@ -118,13 +132,14 @@ 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
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,9 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Simple, feature rich ascii table generation library
 test_files: []