console_table 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '081cb85b432de9117e06bb17afc4a3c6f0afb71a7fcb257ac302a325e10c7b8e'
-  data.tar.gz: 393d21ad15fea24048ef1028009be13ebee75de31b169f84c7324e78b6195315
+  metadata.gz: 53523d0566e09dc3e87c3957c4c34380109d1e4e23d939e37737491028f48b44
+  data.tar.gz: bfd6f961dcace666cf928610aa5c27a744677d6f7cc2143b297c68283c103206
 SHA512:
-  metadata.gz: fe3e9f9db0acf800f90388cf70a1408e5b6e2e4a8234894e26479ec651047c258e5cd1df6577a48a569260d7c193fbee83f38a763bccbaa92b392ecbe7fa1678
-  data.tar.gz: 0cffbb1101518a5147ba0e14e6a6d29304d7fe033f26b843329b2206cebacde91bbd1e763fc191398207d49e98cb26e939564c71fb34df44e5621f832e3dd8ee
+  metadata.gz: 3ca15f89a5284c001383cadede2f99d27aa06a4a7f65caab961ba7453d7dd825bdd15004fc95bd7b486266c13c6ea82fe8e28224ef2d7a2c70bd5350255e7e12
+  data.tar.gz: a3a48e2f7165b8858ff37f4f09a4c3d6d8db2bcf18110804cdb93697cd7a2009d9475775d05cb5e2f4889352d562b6283294a97a7079353d491f6cdbb1ac30c5

data/README.md

@@ -106,6 +106,34 @@ Rod             04-14-80 Chainsaw         It works on my machine
 ===============================================================================
 ```
 
+By default, line breaks in cell values are treated as whitespace to preserve the historical behavior.  If you pass `:multiline=>true` when defining the table, values can contain line breaks, and ConsoleTable will keep the following lines in the correct columns.  Each line is still padded, justified, truncated, or ellipsized according to the column settings.
+
+```ruby
+table_config = [
+   {:title=>"Test", :size=>6},
+   {:title=>"This", :size=>8},
+   {:title=>"Thing", :size=>"*", :ellipsize=>true},
+]
+
+ConsoleTable.define(table_config, :title=>"Test Table", :width=>60, :multiline=>true) do |table|
+	table << ["short", "longer", "longer text\nwith line wraps"]
+	table << ["short", "longer", "longer text without line wraps but with enough text to kinda need them"]
+end
+```
+
+which yields:
+
+```
+============================================================
+                         Test Table
+Test   This     Thing
+------------------------------------------------------------
+short  longer   longer text
+                with line wraps
+short  longer   longer text without line wraps but with e...
+============================================================
+```
+
 We can specify justification options for columns as well, and even overwrite them when we supply row data, simply by using `Hash`es instead of `String`s for the values.  For example:
 
 ```ruby

data/console_table.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "console_table"
-  spec.version       = "0.3.1"
+  spec.version       = "0.4.0"
   spec.authors       = ["Rod Hilton"]
   spec.email         = ["consoletable@rodhilton.com"]
   spec.summary       = %q{Simplifies printing tables of information to commandline consoles}

data/lib/console_table.rb

@@ -67,6 +67,7 @@ module ConsoleTable
       @right_margin = options[:right_margin] || 0
       @headings = options[:headings].nil? ? true : options[:headings]
       @ellipse = options[:ellipse] || "..."
+      @multiline = options[:multiline] || false
 
       #Set outline, just the upper and lower lines
       if @borders
@@ -207,6 +208,18 @@ module ConsoleTable
 
       print_line if @borders unless not @headings and @count == 0
 
+      if @multiline
+        multiline_rows(options).each do |row|
+          print_cells(row)
+        end
+      else
+        print_cells(options)
+      end
+
+      @count = @count + 1
+    end
+
+    def print_cells(options)
       @out.print " "*@left_margin
       if @borders
         @out.print "|"
@@ -245,8 +258,42 @@ module ConsoleTable
         end
       end
       @out.print "\n"
+    end
 
-      @count = @count + 1
+    def multiline_rows(options)
+      lines_by_key = {}
+      @column_widths.each do |column|
+        lines_by_key[column[:key]] = cell_lines(options[column[:key]] || "")
+      end
+
+      row_height = lines_by_key.values.collect { |lines| lines.length }.max || 1
+
+      (0...row_height).collect do |line_index|
+        row = {}
+        @column_widths.each do |column|
+          row[column[:key]] = lines_by_key[column[:key]][line_index] || ""
+        end
+        row
+      end
+    end
+
+    def cell_lines(to_print)
+      if to_print.is_a? Hash
+        split_lines(to_print[:text]).collect do |line|
+          to_print.merge({:text => line})
+        end
+      else
+        split_lines(to_print)
+      end
+    end
+
+    def split_lines(string)
+      return [""] if string.nil?
+
+      string = string.to_s
+      return [""] if string == ""
+
+      string.split("\n", -1)
     end
 
     def infer_justify_from_string(to_print, justify)
@@ -402,4 +449,4 @@ module ConsoleTable
       @out.print "\n"
     end
   end
-end
+end

data/test/test_console_table.rb

@@ -116,7 +116,7 @@ Column 1             Column 2             Column 3
     assert_output_equal expected, @mock_out.string
   end
 
-  def test_newlines_converted_to_spaces_in_middle_stripped_at_ends
+  def test_newlines_converted_to_spaces_in_middle_stripped_at_ends_by_default
     table_config = [
         {:key => :col1, :size => 20, :title => "Column 1"},
         {:key => :col2, :size => 20, :title => "Column 2"},
@@ -142,6 +142,118 @@ Bl ah                Stuff                                Junk
     assert_output_equal expected, @mock_out.string
   end
 
+  def test_newlines_render_as_multiple_cell_lines_when_multiline_is_enabled
+    table_config = [
+        {:key => :col1, :size => 20, :title => "Column 1"},
+        {:key => :col2, :size => 20, :title => "Column 2"},
+        {:key => :col3, :size => 20, :title => "Column 3"},
+    ]
+
+    ConsoleTable.define(table_config, :width => 62, :multiline => true, :output => @mock_out) do |table|
+      table << [
+          {:text => "Bl\nah", :justify => :left},
+          {:text => "\nStuff", :justify => :left},
+          {:text => "Junk\n", :justify => :right}
+      ]
+    end
+
+    expected=<<-END
+==============================================================
+Column 1             Column 2             Column 3
+--------------------------------------------------------------
+Bl                                                        Junk
+ah                   Stuff
+==============================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_multiline_cells_in_multiple_columns_share_continuation_lines
+    table_config = [
+        {:key => :first, :size => 10, :title => "First"},
+        {:key => :second, :size => 10, :title => "Second"},
+        {:key => :third, :size => 10, :title => "Third"},
+    ]
+
+    ConsoleTable.define(table_config, :width => 40, :multiline => true, :output => @mock_out) do |table|
+      table << {
+          :first => "A1\nA2",
+          :second => "B1\nB2",
+          :third => "C1"
+      }
+    end
+
+    expected=<<-END
+================================
+First      Second     Third
+--------------------------------
+A1         B1         C1
+A2         B2
+================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_explicit_newlines_render_as_continuation_lines
+    table_config = [
+        {:title => "Test", :size => 6},
+        {:title => "This", :size => 8},
+        {:title => "Thing", :size => "*"},
+    ]
+
+    ConsoleTable.define(table_config, :title => "Test Table", :width => 60, :multiline => true, :output => @mock_out) do |table|
+      table << ["short", "longer", "longer text\nwith line wraps"]
+      table << ["short", "longer", "longer text without line wraps but with enough text to kinda need them"]
+    end
+
+    expected=<<-END
+============================================================
+                         Test Table
+Test   This     Thing
+------------------------------------------------------------
+short  longer   longer text
+                with line wraps
+short  longer   longer text without line wraps but with enou
+============================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_multiline_cells_ellipsize_each_line_independently
+    table_config = [
+        {:key => :first, :size => 10, :title => "First", :ellipsize => true},
+        {:key => :second, :size => 10, :title => "Second", :ellipsize => true},
+    ]
+
+    ConsoleTable.define(table_config, :width => 40, :multiline => true, :output => @mock_out) do |table|
+      table << {
+          :first => "short\nthis line is very long",
+          :second => "this line is very long\nshort"
+      }
+
+      table << {
+          :first => {:text => "tiny\nanother line is too long", :ellipsize => true},
+          :second => {:text => "another line is too long\ntiny", :ellipsize => true}
+      }
+    end
+
+    expected=<<-END
+=====================
+First      Second
+---------------------
+short      this li...
+this li... short
+tiny       another...
+another... tiny
+=====================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
   def test_linebreak_inside_colorcode_still_resets
     table_config = [
         {:key => :col1, :size => 20, :title => "Column 1"},
@@ -1160,6 +1272,66 @@ Row 2, Column 1      Row 2, Column 1
     assert_output_equal expected, @mock_out.string
   end
 
+  def test_newlines_render_inside_bordered_table_cells
+    table_config = [
+        {:key => :col1, :size => 6, :title => "Column 1"},
+        {:key => :col2, :size => 8, :title => "Column 2"},
+    ]
+
+    ConsoleTable.define(table_config, :width => 100, :headings => false, :borders => true, :multiline => true, :output => @mock_out) do |table|
+      table << ["A\nB", "C"]
+      table << ["D", "E\nF"]
+    end
+
+    expected=<<-END
+*======*========*
+|A     |C       |
+|B     |        |
++------+--------+
+|D     |E       |
+|      |F       |
+*======*========*
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_multiline_bordered_cells_mix_padding_justification_and_ellipses
+    table_config = [
+        {:key => :left, :size => 10, :title => "Left", :ellipsize => true},
+        {:key => :center, :size => 12, :title => "Center", :justify => :center, :ellipsize => true},
+        {:key => :right, :size => 10, :title => "Right", :justify => :right, :ellipsize => true},
+    ]
+
+    ConsoleTable.define(table_config, :width => 80, :borders => true, :multiline => true, :output => @mock_out) do |table|
+      table << {
+          :left => "Short\nThis line is too long",
+          :center => "This center line is too long\nMid",
+          :right => "Tiny"
+      }
+
+      table << {
+          :left => "This starts too long\nOK",
+          :center => {:text => "Small\nThis override line is too long", :justify => :left, :ellipsize => true},
+          :right => "This right line is too long\nEnd"
+      }
+    end
+
+    expected=<<-END
+*==========*============*==========*
+|Left      |   Center   |     Right|
++----------+------------+----------+
+|Short     |This cent...|      Tiny|
+|This li...|    Mid     |          |
++----------+------------+----------+
+|This st...|Small       |This ri...|
+|OK        |This over...|       End|
+*==========*============*==========*
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
   def test_can_define_a_table_with_just_numbers_for_size
     table_config = [
         {:key => :col1, :size => 20, :title => "Column 1"},
@@ -1608,4 +1780,4 @@ Row 2, Col Row 2, Col
     end
 
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console_table
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Rod Hilton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-24 00:00:00.000000000 Z
+date: 2026-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov